@embedpdf/plugin-annotation 2.9.0 → 2.10.0

package/dist/vue/components/annotation-navigation-handler.vue.d.ts

@@ -0,0 +1,3 @@
+declare const __VLS_export: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

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

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

@@ -0,0 +1,10 @@
+import { Rect } from '@embedpdf/models';
+import { LinkPreviewData } from '../../../lib';
+type __VLS_Props = {
+    data: LinkPreviewData;
+    bounds: Rect;
+    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/components/annotations/stamp.vue.d.ts

@@ -8,12 +8,12 @@ declare const __VLS_export: import('vue').DefineComponent<{
     documentId: string;
     pageIndex: number;
     scale: number;
-    onClick: (e: PointerEvent) => void;
+    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;
+    onClick?: (e: PointerEvent) => void;
 }> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;

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

@@ -1,6 +1,7 @@
-import { AnyPreviewState } from '../../lib';
+import { PreviewState } from '../../lib';
 type __VLS_Props = {
-    preview: AnyPreviewState;
+    toolId: string;
+    preview: PreviewState;
     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>;

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

@@ -22,5 +22,5 @@ export declare function useRegisterRenderers(entries: BoxedAnnotationRenderer[])
  * 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>(entry: AnnotationRendererEntry<T>): BoxedAnnotationRenderer;
+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,5 +1,5 @@
 import { Component, CSSProperties } from 'vue';
-import { PdfAnnotationObject, PdfBlendMode } from '@embedpdf/models';
+import { PdfAnnotationObject, PdfBlendMode, Rect } from '@embedpdf/models';
 import { TrackedAnnotation } from '../../lib';
 import { VertexConfig } from '../../shared-vue/types';
 /**
@@ -17,7 +17,7 @@ export interface AnnotationRendererProps<T extends PdfAnnotationObject = PdfAnno
     scale: number;
     pageIndex: number;
     documentId: string;
-    onClick: (e: AnnotationInteractionEvent) => void;
+    onClick?: (e: AnnotationInteractionEvent) => void;
     /** When true, AP canvas provides the visual; component should only render hit area */
     appearanceActive: boolean;
 }
@@ -35,7 +35,7 @@ export interface SelectOverrideHelpers {
  * Entry for defining a custom annotation renderer.
  * Type safety enforced at definition time via generic.
  */
-export interface AnnotationRendererEntry<T extends PdfAnnotationObject = PdfAnnotationObject> {
+export interface AnnotationRendererEntry<T extends PdfAnnotationObject = PdfAnnotationObject, P = never> {
     /** Unique identifier for this renderer */
     id: string;
     /** Returns true if this renderer handles the annotation */
@@ -69,6 +69,16 @@ export interface AnnotationRendererEntry<T extends PdfAnnotationObject = PdfAnno
     selectOverride?: (e: AnnotationInteractionEvent, annotation: TrackedAnnotation<T>, helpers: SelectOverrideHelpers) => void;
     /** Return true to hide the selection menu for this annotation */
     hideSelectionMenu?: (annotation: T) => boolean;
+    /** Render a preview during drag-to-create. P is the preview data type. */
+    renderPreview?: Component<{
+        data: P;
+        bounds: Rect;
+        scale: number;
+    }>;
+    /** 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)
@@ -95,4 +105,11 @@ export interface BoxedAnnotationRenderer {
     onDoubleClick?: (annotationId: string, setEditingId: (id: string) => void) => void;
     selectOverride?: (e: AnnotationInteractionEvent, annotation: TrackedAnnotation, helpers: SelectOverrideHelpers) => void;
     hideSelectionMenu?: (annotation: PdfAnnotationObject) => boolean;
+    renderPreview?: Component<{
+        data: unknown;
+        bounds: Rect;
+        scale: number;
+    }>;
+    hiddenWhenLocked?: boolean;
+    renderLocked?: Component<AnnotationRendererProps>;
 }

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

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

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

@@ -1,7 +1,7 @@
 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>>;
+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)
@@ -14,6 +14,17 @@ export declare const useAnnotation: (documentId: MaybeRefOrGetter<string>) => {
         selectedUid: string | null;
         activeToolId: string | null;
         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>;
@@ -21,6 +32,17 @@ export declare const useAnnotation: (documentId: MaybeRefOrGetter<string>) => {
         selectedUid: string | null;
         activeToolId: string | null;
         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 | null>;
+    provides: import('vue').ComputedRef<import('../../lib').AnnotationScope<import('../../lib').AnnotationToolMap> | null>;
 };

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

@@ -0,0 +1,7 @@
+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;
+}>;