@embedpdf/plugin-annotation 2.15.0 → 3.0.0-next.1

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

@@ -1,6 +0,0 @@
-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/text-renderer.vue.d.ts

@@ -1,6 +0,0 @@
-import { PdfTextAnnoObject } from '@embedpdf/models';
-import { AnnotationRendererProps } from '../../context/types';
-type __VLS_Props = AnnotationRendererProps<PdfTextAnnoObject>;
-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

@@ -1,6 +0,0 @@
-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,27 +0,0 @@
-import { Rect } from '@embedpdf/models';
-declare const _default: typeof __VLS_export;
-export default _default;
-declare const __VLS_export: import('vue').DefineComponent<{
-    /** Stroke/markup color */
-    strokeColor?: string;
-    opacity?: number;
-    segmentRects: Rect[];
-    rect?: Rect;
-    scale: number;
-    onClick?: (e: PointerEvent) => void;
-    /** 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) => 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>;

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

@@ -1,4 +0,0 @@
-export { default as Highlight } from './highlight.vue';
-export { default as Squiggly } from './squiggly.vue';
-export { default as Strikeout } from './strikeout.vue';
-export { default as Underline } from './underline.vue';

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

@@ -1,27 +0,0 @@
-import { Rect } from '@embedpdf/models';
-declare const _default: typeof __VLS_export;
-export default _default;
-declare const __VLS_export: import('vue').DefineComponent<{
-    /** Stroke/markup color */
-    strokeColor?: string;
-    opacity?: number;
-    segmentRects: Rect[];
-    rect?: Rect;
-    scale: number;
-    onClick?: (e: PointerEvent) => void;
-    /** 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) => 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>;

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

@@ -1,27 +0,0 @@
-import { Rect } from '@embedpdf/models';
-declare const _default: typeof __VLS_export;
-export default _default;
-declare const __VLS_export: import('vue').DefineComponent<{
-    /** Stroke/markup color */
-    strokeColor?: string;
-    opacity?: number;
-    segmentRects: Rect[];
-    rect?: Rect;
-    scale: number;
-    onClick?: (e: PointerEvent) => void;
-    /** 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) => 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>;

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

@@ -1,27 +0,0 @@
-import { Rect } from '@embedpdf/models';
-declare const _default: typeof __VLS_export;
-export default _default;
-declare const __VLS_export: import('vue').DefineComponent<{
-    /** Stroke/markup color */
-    strokeColor?: string;
-    opacity?: number;
-    segmentRects: Rect[];
-    rect?: Rect;
-    scale: number;
-    onClick?: (e: PointerEvent) => void;
-    /** 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) => 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>;

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

@@ -1,8 +0,0 @@
-type __VLS_Props = {
-    documentId: string;
-    pageIndex: number;
-    scale: number;
-};
-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/context/index.d.ts

@@ -1,2 +0,0 @@
-export * from './renderer-registry';
-export * from './types';

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

@@ -1,26 +0,0 @@
-import { BoxedAnnotationRenderer, AnnotationRendererEntry, AnnotationRendererProps, AnnotationInteractionEvent, SelectOverrideHelpers } from './types';
-import { PdfAnnotationObject } from '@embedpdf/models';
-/**
- * Annotation Renderer Registry
- *
- * Allows external plugins to register custom annotation renderers
- * that integrate with the annotation layer.
- */
-export interface AnnotationRendererRegistry {
-    register(entries: BoxedAnnotationRenderer[]): () => void;
-    getAll(): BoxedAnnotationRenderer[];
-}
-export declare function createRendererRegistry(): AnnotationRendererRegistry;
-export declare function provideRendererRegistry(): AnnotationRendererRegistry;
-export declare function useRendererRegistry(): AnnotationRendererRegistry | null;
-/**
- * Composable for plugins to register renderers.
- * Automatically cleans up on unmount.
- */
-export declare function useRegisterRenderers(entries: BoxedAnnotationRenderer[]): void;
-/**
- * Factory to create a boxed renderer from a typed entry.
- * Wraps component in markRaw to prevent reactivity overhead.
- */
-export declare function createRenderer<T extends PdfAnnotationObject, P = never>(entry: AnnotationRendererEntry<T, P>): BoxedAnnotationRenderer;
-export type { AnnotationRendererProps, AnnotationRendererEntry, BoxedAnnotationRenderer, AnnotationInteractionEvent, SelectOverrideHelpers, };

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

@@ -1,129 +0,0 @@
-import { Component, CSSProperties } from 'vue';
-import { PdfAnnotationObject, PdfBlendMode, Rect } from '@embedpdf/models';
-import { TrackedAnnotation, PreviewState } from '../../lib';
-import { VertexConfig } from '../../shared-vue/types';
-/**
- * Properly typed event for annotation interactions (click, select, etc.)
- */
-export type AnnotationInteractionEvent = PointerEvent | MouseEvent;
-/**
- * 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;
-    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.
- * Type safety enforced at definition time via generic.
- */
-export interface AnnotationRendererEntry<T extends PdfAnnotationObject = PdfAnnotationObject, P = never> {
-    /** Unique identifier for this renderer */
-    id: string;
-    /** Returns true if this renderer handles the annotation. Optional for preview-only renderers. */
-    matches?: (annotation: PdfAnnotationObject) => annotation is T;
-    /** Vue component to render the annotation. Optional for preview-only renderers. */
-    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;
-    /** Default blend mode for this annotation type (used when the annotation object has no blendMode set) */
-    defaultBlendMode?: PdfBlendMode;
-    /** Style applied to the annotation container — overrides the default blend-mode 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;
-    /** Returns true if this renderer should handle the given preview state */
-    matchesPreview?: (preview: PreviewState) => boolean;
-    /** Render a preview during drag-to-create. P is the preview data type. */
-    renderPreview?: Component<{
-        data: P;
-        bounds: Rect;
-        scale: number;
-    }>;
-    /** Extra styles merged onto the preview container div (e.g. mixBlendMode for ink). */
-    previewContainerStyle?: (props: {
-        data: P;
-        bounds: Rect;
-        scale: number;
-    }) => CSSProperties;
-    /** When true, the annotation is completely hidden when locked (e.g., form widgets defer to the form-filling layer). */
-    hiddenWhenLocked?: boolean;
-    /** Optional locked-mode renderer. When the annotation is locked, this replaces `component` inside the container. */
-    renderLocked?: Component<AnnotationRendererProps<T>>;
-}
-/**
- * Boxed renderer stored in registry (generic erased for storage)
- */
-export interface BoxedAnnotationRenderer {
-    id: string;
-    matches: (annotation: PdfAnnotationObject) => boolean;
-    component: Component<AnnotationRendererProps>;
-    vertexConfig?: VertexConfig<PdfAnnotationObject>;
-    zIndex?: number;
-    defaultBlendMode?: PdfBlendMode;
-    /** Style applied to the annotation container — overrides the default blend-mode style. */
-    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;
-    matchesPreview?: (preview: PreviewState) => boolean;
-    renderPreview?: Component<{
-        data: unknown;
-        bounds: Rect;
-        scale: number;
-    }>;
-    previewContainerStyle?: (props: {
-        data: unknown;
-        bounds: Rect;
-        scale: number;
-    }) => CSSProperties;
-    hiddenWhenLocked?: boolean;
-    renderLocked?: Component<AnnotationRendererProps>;
-}

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

@@ -1,2 +0,0 @@
-export * from './use-annotation';
-export * from './use-ios-zoom-prevention';

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

@@ -1,50 +0,0 @@
-import { MaybeRefOrGetter } from 'vue';
-import { AnnotationPlugin, AnnotationDocumentState } from '../../lib';
-export declare const useAnnotationPlugin: () => import('@embedpdf/core/vue').PluginState<AnnotationPlugin>;
-export declare const useAnnotationCapability: () => import('@embedpdf/core/vue').CapabilityState<Readonly<import('../../lib').AnnotationCapability<import('../../lib').AnnotationToolMap>>>;
-/**
- * Hook for annotation state for a specific document
- * @param documentId Document ID (can be ref, computed, getter, or plain value)
- */
-export declare const useAnnotation: (documentId: MaybeRefOrGetter<string>) => {
-    state: import('vue').Ref<{
-        pages: Record<number, string[]>;
-        byUid: Record<string, import('../../lib').TrackedAnnotation>;
-        selectedUids: string[];
-        selectedUid: string | null;
-        activeToolId: string | null;
-        activeToolContext?: Record<string, unknown> | undefined;
-        hasPendingChanges: boolean;
-        locked: {
-            type: import("@embedpdf/plugin-annotation").LockModeType.None;
-        } | {
-            type: import("@embedpdf/plugin-annotation").LockModeType.All;
-        } | {
-            type: import("@embedpdf/plugin-annotation").LockModeType.Include;
-            categories: string[];
-        } | {
-            type: import("@embedpdf/plugin-annotation").LockModeType.Exclude;
-            categories: string[];
-        };
-    }, AnnotationDocumentState | {
-        pages: Record<number, string[]>;
-        byUid: Record<string, import('../../lib').TrackedAnnotation>;
-        selectedUids: string[];
-        selectedUid: string | null;
-        activeToolId: string | null;
-        activeToolContext?: Record<string, unknown> | undefined;
-        hasPendingChanges: boolean;
-        locked: {
-            type: import("@embedpdf/plugin-annotation").LockModeType.None;
-        } | {
-            type: import("@embedpdf/plugin-annotation").LockModeType.All;
-        } | {
-            type: import("@embedpdf/plugin-annotation").LockModeType.Include;
-            categories: string[];
-        } | {
-            type: import("@embedpdf/plugin-annotation").LockModeType.Exclude;
-            categories: string[];
-        };
-    }>;
-    provides: import('vue').ComputedRef<import('../../lib').AnnotationScope<import('../../lib').AnnotationToolMap> | null>;
-};

package/dist/vue/hooks/use-ios-zoom-prevention.d.ts

@@ -1,7 +0,0 @@
-import { CSSProperties, MaybeRefOrGetter } from 'vue';
-export declare function useIOSZoomPrevention(computedFontPx: MaybeRefOrGetter<number>, active: MaybeRefOrGetter<boolean>): import('vue').ComputedRef<{
-    needsComp: boolean;
-    adjustedFontPx: number;
-    scaleComp: number;
-    wrapperStyle: CSSProperties | undefined;
-}>;