@embedpdf/plugin-annotation 2.6.2 → 2.8.0

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

@@ -1,5 +1,5 @@
 import { CSSProperties } from 'vue';
-import { PdfAnnotationObject } from '@embedpdf/models';
+import { PdfAnnotationObject, AnnotationAppearances } from '@embedpdf/models';
 import { SelectionMenuPlacement } from '@embedpdf/utils/vue';
 import { TrackedAnnotation } from '../../lib';
 import { VertexConfig } from '../../shared-vue/types';
@@ -16,6 +16,8 @@ declare const __VLS_export: <T extends PdfAnnotationObject>(__VLS_props: NonNull
         pageHeight: number;
         trackedAnnotation: TrackedAnnotation<T>;
         isSelected: boolean;
+        /** Whether the annotation is in editing mode */
+        isEditing?: boolean;
         /** Whether multiple annotations are selected (container becomes passive) */
         isMultiSelected?: boolean;
         isDraggable: boolean;
@@ -27,7 +29,9 @@ declare const __VLS_export: <T extends PdfAnnotationObject>(__VLS_props: NonNull
         /** @deprecated Use `selectionOutline.offset` instead */
         outlineOffset?: number;
         onDoubleClick?: (event: PointerEvent | MouseEvent) => void;
-        onSelect: (event: TouchEvent | MouseEvent) => void;
+        onSelect: (event: PointerEvent | MouseEvent) => void;
+        /** Pre-rendered appearance stream images for AP mode rendering */
+        appearance?: AnnotationAppearances<Blob> | null;
         zIndex?: number;
         /** @deprecated Use `selectionOutline.color` instead */
         selectionOutlineColor?: string;
@@ -62,6 +66,7 @@ declare const __VLS_export: <T extends PdfAnnotationObject>(__VLS_props: NonNull
     } & {
         default?: (props: {
             annotation: T;
+            appearanceActive: boolean;
         }) => any;
     } & {
         'resize-handle'?: (props: {

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

@@ -42,32 +42,13 @@ declare var __VLS_8: {
             height: number;
         };
     };
-    placement: import('@embedpdf/utils/vue').SelectionMenuPlacement;
+    placement: import('@embedpdf/utils').SelectionMenuPlacement;
     menuWrapperProps: {
         style: import('vue').CSSProperties;
         onPointerdown: (e: PointerEvent) => void;
         onTouchstart: (e: TouchEvent) => void;
     };
-}, __VLS_11: {
-    context: import('..').GroupSelectionContext;
-    selected: boolean;
-    rect: {
-        origin: {
-            x: number;
-            y: number;
-        };
-        size: {
-            width: number;
-            height: number;
-        };
-    };
-    placement: import('@embedpdf/utils/vue').SelectionMenuPlacement;
-    menuWrapperProps: {
-        style: import('vue').CSSProperties;
-        onPointerdown: (e: PointerEvent) => void;
-        onTouchstart: (e: TouchEvent) => void;
-    };
-}, __VLS_14: {
+}, __VLS_11: any, __VLS_14: {
     backgroundColor: string;
     onPointerdown: (e: PointerEvent) => void;
     onPointermove: (e: PointerEvent) => void;

package/dist/vue/components/annotations/caret.vue.d.ts

@@ -0,0 +1,24 @@
+import { Rect } from '@embedpdf/models';
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
+    isSelected: boolean;
+    strokeColor?: string;
+    opacity?: number;
+    rect: Rect;
+    scale: number;
+    onClick?: (e: PointerEvent) => void;
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    isSelected: boolean;
+    strokeColor?: string;
+    opacity?: number;
+    rect: Rect;
+    scale: number;
+    onClick?: (e: PointerEvent) => void;
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
+    strokeColor: string;
+    opacity: number;
+    appearanceActive: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;

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

@@ -1,5 +1,7 @@
 import { PdfAnnotationBorderStyle, Rect } from '@embedpdf/models';
-interface CircleProps {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     isSelected: boolean;
     color?: string;
     strokeColor?: string;
@@ -9,12 +11,23 @@ interface CircleProps {
     strokeDashArray?: number[];
     rect: Rect;
     scale: number;
-    onClick?: (e: PointerEvent | TouchEvent) => void;
-}
-declare const __VLS_export: import('vue').DefineComponent<CircleProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<CircleProps> & Readonly<{}>, {
+    onClick?: (e: PointerEvent) => void;
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    isSelected: boolean;
+    color?: string;
+    strokeColor?: string;
+    opacity?: number;
+    strokeWidth: number;
+    strokeStyle?: PdfAnnotationBorderStyle;
+    strokeDashArray?: number[];
+    rect: Rect;
+    scale: number;
+    onClick?: (e: PointerEvent) => void;
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
     color: string;
     opacity: number;
     strokeStyle: PdfAnnotationBorderStyle;
+    appearanceActive: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

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

@@ -1,13 +1,25 @@
 import { PdfFreeTextAnnoObject } from '@embedpdf/models';
 import { TrackedAnnotation } from '../../../lib';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
+    documentId: string;
     isSelected: boolean;
     isEditing: boolean;
     annotation: TrackedAnnotation<PdfFreeTextAnnoObject>;
     pageIndex: number;
     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<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;
+    onClick?: (e: PointerEvent) => void;
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    documentId: string;
+    isSelected: boolean;
+    isEditing: boolean;
+    annotation: TrackedAnnotation<PdfFreeTextAnnoObject>;
+    pageIndex: number;
+    scale: number;
+    onClick?: (e: PointerEvent) => void;
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
+    appearanceActive: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;

package/dist/vue/components/annotations/index.d.ts

@@ -7,3 +7,4 @@ export { default as Polygon } from './polygon.vue';
 export { default as Polyline } from './polyline.vue';
 export { default as Square } from './square.vue';
 export { default as Stamp } from './stamp.vue';
+export { default as Text } from './text.vue';

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

@@ -1,17 +1,27 @@
 import { PdfInkListObject, Rect } from '@embedpdf/models';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     isSelected: boolean;
-    /** Stroke color */
     strokeColor?: string;
     opacity?: number;
     strokeWidth: number;
     inkList: PdfInkListObject[];
     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<{}>, {
+    onClick?: (e: PointerEvent) => void;
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    isSelected: boolean;
+    strokeColor?: string;
+    opacity?: number;
+    strokeWidth: number;
+    inkList: PdfInkListObject[];
+    rect: Rect;
+    scale: number;
+    onClick?: (e: PointerEvent) => void;
+    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/annotations/line.vue.d.ts

@@ -1,5 +1,7 @@
 import { Rect, LinePoints, LineEndings, PdfAnnotationBorderStyle } from '@embedpdf/models';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     color?: string;
     opacity?: number;
     strokeWidth: number;
@@ -10,14 +12,27 @@ type __VLS_Props = {
     linePoints: LinePoints;
     lineEndings?: LineEndings;
     scale: number;
-    onClick?: (e: PointerEvent | TouchEvent) => void;
+    onClick?: (e: PointerEvent) => void;
     isSelected: boolean;
-};
-declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    color?: string;
+    opacity?: number;
+    strokeWidth: number;
+    strokeColor?: string;
+    strokeStyle?: PdfAnnotationBorderStyle;
+    strokeDashArray?: number[];
+    rect: Rect;
+    linePoints: LinePoints;
+    lineEndings?: LineEndings;
+    scale: number;
+    onClick?: (e: PointerEvent) => void;
+    isSelected: boolean;
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
     strokeColor: string;
     color: string;
     opacity: number;
     strokeStyle: PdfAnnotationBorderStyle;
+    appearanceActive: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

package/dist/vue/components/annotations/link.vue.d.ts

@@ -1,5 +1,7 @@
 import { PdfAnnotationBorderStyle, Rect } from '@embedpdf/models';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     /** Whether the annotation is selected */
     isSelected: boolean;
     /** Stroke colour – defaults to blue when omitted */
@@ -15,15 +17,31 @@ type __VLS_Props = {
     /** Current page zoom factor */
     scale: number;
     /** Click handler (used for selection) */
-    onClick?: (e: MouseEvent | TouchEvent) => void;
+    onClick?: (e: PointerEvent | MouseEvent) => void;
     /** Whether this link has an IRT (In Reply To) reference - disables direct interaction */
     hasIRT?: boolean;
-};
-declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    /** Whether the annotation is selected */
+    isSelected: boolean;
+    /** Stroke colour – defaults to blue when omitted */
+    strokeColor?: string;
+    /** Stroke width in PDF units */
+    strokeWidth?: number;
+    /** Stroke type – defaults to underline when omitted */
+    strokeStyle?: PdfAnnotationBorderStyle;
+    /** Stroke dash array – for dashed style */
+    strokeDashArray?: number[];
+    /** Bounding box of the annotation (PDF units) */
+    rect: Rect;
+    /** Current page zoom factor */
+    scale: number;
+    /** Click handler (used for selection) */
+    onClick?: (e: PointerEvent | MouseEvent) => void;
+    /** Whether this link has an IRT (In Reply To) reference - disables direct interaction */
+    hasIRT?: boolean;
+}> & Readonly<{}>, {
     strokeColor: string;
     strokeWidth: number;
     strokeStyle: PdfAnnotationBorderStyle;
     hasIRT: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

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

@@ -1,5 +1,22 @@
 import { Rect, Position, PdfAnnotationBorderStyle } from '@embedpdf/models';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
+    rect: Rect;
+    vertices: Position[];
+    color?: string;
+    strokeColor?: string;
+    opacity?: number;
+    strokeWidth: number;
+    strokeStyle?: PdfAnnotationBorderStyle;
+    strokeDashArray?: number[];
+    scale: number;
+    isSelected: boolean;
+    onClick?: (e: PointerEvent) => void;
+    currentVertex?: Position;
+    handleSize?: number;
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
     rect: Rect;
     vertices: Position[];
     color?: string;
@@ -10,16 +27,15 @@ type __VLS_Props = {
     strokeDashArray?: number[];
     scale: number;
     isSelected: boolean;
-    onClick?: (e: PointerEvent | TouchEvent) => void;
+    onClick?: (e: PointerEvent) => void;
     currentVertex?: Position;
     handleSize?: number;
-};
-declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
     strokeColor: string;
     color: string;
     opacity: number;
     strokeStyle: PdfAnnotationBorderStyle;
     handleSize: number;
+    appearanceActive: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

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

@@ -1,20 +1,38 @@
-import { Rect, Position, LineEndings } from '@embedpdf/models';
-type __VLS_Props = {
+import { Rect, Position, LineEndings, PdfAnnotationBorderStyle } from '@embedpdf/models';
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     rect: Rect;
     vertices: Position[];
     color?: string;
     strokeColor?: string;
     opacity?: number;
     strokeWidth: number;
+    strokeStyle?: PdfAnnotationBorderStyle;
+    strokeDashArray?: number[];
     scale: number;
     isSelected: boolean;
-    onClick?: (e: PointerEvent | TouchEvent) => void;
+    onClick?: (e: PointerEvent) => void;
     lineEndings?: LineEndings;
-};
-declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    rect: Rect;
+    vertices: Position[];
+    color?: string;
+    strokeColor?: string;
+    opacity?: number;
+    strokeWidth: number;
+    strokeStyle?: PdfAnnotationBorderStyle;
+    strokeDashArray?: number[];
+    scale: number;
+    isSelected: boolean;
+    onClick?: (e: PointerEvent) => void;
+    lineEndings?: LineEndings;
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
     strokeColor: string;
     color: string;
     opacity: number;
+    strokeStyle: PdfAnnotationBorderStyle;
+    appearanceActive: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

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

@@ -1,5 +1,7 @@
 import { PdfAnnotationBorderStyle, Rect } from '@embedpdf/models';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     isSelected: boolean;
     color?: string;
     strokeColor?: string;
@@ -9,12 +11,23 @@ type __VLS_Props = {
     strokeDashArray?: number[];
     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<{}>, {
+    onClick?: (e: PointerEvent) => void;
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    isSelected: boolean;
+    color?: string;
+    strokeColor?: string;
+    opacity?: number;
+    strokeWidth: number;
+    strokeStyle?: PdfAnnotationBorderStyle;
+    strokeDashArray?: number[];
+    rect: Rect;
+    scale: number;
+    onClick?: (e: PointerEvent) => void;
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
     color: string;
     opacity: number;
     strokeStyle: PdfAnnotationBorderStyle;
+    appearanceActive: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

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

@@ -1,13 +1,19 @@
 import { PdfStampAnnoObject } from '@embedpdf/models';
 import { TrackedAnnotation } from '../../../lib';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     isSelected: boolean;
     annotation: TrackedAnnotation<PdfStampAnnoObject>;
     documentId: string;
     pageIndex: number;
     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<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;
+    onClick: (e: PointerEvent) => void;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    isSelected: boolean;
+    annotation: TrackedAnnotation<PdfStampAnnoObject>;
+    documentId: string;
+    pageIndex: number;
+    scale: number;
+    onClick: (e: PointerEvent) => void;
+}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;

package/dist/vue/components/annotations/text.vue.d.ts

@@ -0,0 +1,14 @@
+type __VLS_Props = {
+    isSelected: boolean;
+    color?: string;
+    opacity?: number;
+    onClick?: (e: PointerEvent) => void;
+    appearanceActive?: boolean;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    color: string;
+    opacity: number;
+    appearanceActive: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;