@vue-pdf-viewer/shared 1.5.0 → 1.6.0-rc.1

package/dist/const.d.ts

@@ -1,6 +1,6 @@
 import { type InjectionKey, type Reactive, type ComputedRef } from "vue";
 import type { LocaleKey, Localization, PluginContext } from "./index";
-import { EventAnnotation, EventCore } from "./enumerators";
+import { EventAnnotation, EventCore, AnnotationType } from "./enumerators";
 export declare const PLUGIN_ID: {
     ANNOTATIONS: string;
 };
@@ -64,3 +64,5 @@ export declare const DEFAULT_UNDERLINE_COLOR: Record<(typeof UNDERLINE_COLOR)[ke
 export declare const DEFAULT_STRIKETHROUGH_COLOR: Record<(typeof UNDERLINE_COLOR)[keyof typeof UNDERLINE_COLOR], string>;
 export declare const DEFAULT_FREE_TEXT_FONT_COLOR: Record<(typeof FREE_TEXT_FONT_COLOR)[keyof typeof FREE_TEXT_FONT_COLOR], string>;
 export declare const EDITOR_PREFIX: "pdfjs_internal_editor_";
+export declare const XFDF_ELEMENT_TO_ANNOTATION_TYPE: Record<string, AnnotationType>;
+export declare const ANNOTATION_TYPE_TO_XFDF_ELEMENT: Record<number, string>;

package/dist/const.js

@@ -10,7 +10,7 @@
  *
  * For commercial licensing inquiries, contact: support@vue-pdf-viewer.dev
  */
-import { EventAnnotation, EventCore } from "./enumerators";
+import { EventAnnotation, EventCore, AnnotationType } from "./enumerators";
 import en from "./locales/en_US.json";
 import cn from "./locales/zh_CN.json";
 import it from "./locales/it_IT.json";
@@ -124,3 +124,21 @@ export const DEFAULT_FREE_TEXT_FONT_COLOR = {
     [FREE_TEXT_FONT_COLOR.Green]: "Green",
 };
 export const EDITOR_PREFIX = "pdfjs_internal_editor_";
+export const XFDF_ELEMENT_TO_ANNOTATION_TYPE = {
+    highlight: AnnotationType.Highlight,
+    underline: AnnotationType.Underline,
+    strikeout: AnnotationType.StrikeOut,
+    freetext: AnnotationType.FreeText,
+    stamp: AnnotationType.Stamp,
+    ink: AnnotationType.Ink,
+    text: AnnotationType.Popup,
+};
+export const ANNOTATION_TYPE_TO_XFDF_ELEMENT = {
+    [AnnotationType.Highlight]: "highlight",
+    [AnnotationType.Underline]: "underline",
+    [AnnotationType.StrikeOut]: "strikeout",
+    [AnnotationType.FreeText]: "freetext",
+    [AnnotationType.Stamp]: "stamp",
+    [AnnotationType.Ink]: "ink",
+    [AnnotationType.Popup]: "text",
+};

package/dist/types.d.ts

@@ -286,6 +286,7 @@ export interface Annotation {
     noPrint?: boolean;
     fontSize?: number;
     contents?: string;
+    imageDataUrl?: string;
 }
 export type AnnotationCallback<T = Annotation> = (data: T) => void;
 export interface AnnotationEventCallback {
@@ -305,8 +306,20 @@ export interface DeletedAnnotationData {
     rect?: number[];
     quadPoints?: number[];
 }
+export interface XfdfSkippedEntry {
+    elementName: string;
+    page: number;
+    reason: string;
+}
+export interface XfdfImportResult {
+    annotations: Annotation[];
+    skipped: XfdfSkippedEntry[];
+    errors: string[];
+}
 export interface AnnotationPluginApi {
     exportToPdf: (annotations: Annotation[], deletedAnnotations?: DeletedAnnotationData[] | string[]) => Promise<Uint8Array | null>;
+    exportToXfdf: (annotations: Annotation[], pdfFilename?: string) => string;
+    importFromXfdf: (xfdfString: string, pageCount: number) => XfdfImportResult;
 }
 /**
  * Programmatic API for text selection annotation tools (highlight, underline, strikethrough).

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@vue-pdf-viewer/shared",
 	"private": false,
-	"version": "1.5.0",
+	"version": "1.6.0-rc.1",
 	"type": "module",
 	"main": "./dist/index.js",
 	"module": "./dist/index.js",