@libresign/pdf-elements 0.3.1 → 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,30 @@
+export interface PDFElementObject {
+    id?: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    type?: string;
+    label?: string;
+    icon?: string;
+    resizable?: boolean;
+    [key: string]: unknown;
+}
+export interface PDFDocumentEntry {
+    name: string;
+    file: unknown;
+    pdfDoc: unknown;
+    numPages: number;
+    pages: Promise<unknown>[];
+    pageWidths: number[];
+    pagesScale: number[];
+    allObjects: PDFElementObject[][];
+}
+export interface PDFElementsPublicApi {
+    startAddingElement: (templateObject: PDFElementObject) => void;
+    addObjectToPage: (object: PDFElementObject, pageIndex?: number, docIndex?: number) => boolean;
+    getAllObjects: (docIndex?: number) => PDFElementObject[];
+    updateObject: (docIndex: number, objectId: string, payload: Partial<PDFElementObject>) => void;
+    deleteObject: (docIndex: number, objectId: string) => void;
+    duplicateObject: (docIndex: number, objectId: string) => void;
+}

package/dist/utils/asyncReader.d.ts

@@ -0,0 +1,10 @@
+import { PDFDocumentProxy } from 'pdfjs-dist';
+export declare function setWorkerPath(path: string): void;
+export declare function readAsArrayBuffer(file: Blob): Promise<ArrayBuffer>;
+type PdfInput = string | ArrayBuffer | ArrayBufferView | Blob | {
+    url?: string;
+    data?: ArrayBuffer | Uint8Array;
+    [key: string]: unknown;
+};
+export declare function readAsPDF(file: PdfInput, options?: Record<string, unknown>): Promise<PDFDocumentProxy>;
+export {};

package/dist/utils/geometry.d.ts

@@ -0,0 +1,5 @@
+export declare function clampPosition(x: number, y: number, width: number, height: number, pageWidth: number, pageHeight: number): {
+    x: number;
+    y: number;
+};
+export declare function getVisibleArea(newX: number, newY: number, objWidth: number, objHeight: number, pageWidth: number, pageHeight: number): number;

package/dist/utils/measurements.d.ts

@@ -0,0 +1,12 @@
+export interface CanvasMeasurement {
+    canvasWidth: number;
+    canvasHeight: number;
+}
+export interface PageMeasurement {
+    width: number;
+    height: number;
+}
+export interface PageMeasurementProvider {
+    getCanvasMeasurement: () => CanvasMeasurement;
+}
+export declare function getCachedMeasurement(cache: Record<string, PageMeasurement>, cacheKey: string, pageRef: PageMeasurementProvider, pagesScale: number): PageMeasurement;

package/dist/utils/objectStore.d.ts

@@ -0,0 +1,5 @@
+import { PDFDocumentEntry, PDFElementObject } from '../types';
+export declare function objectIdExistsInDoc(doc: PDFDocumentEntry | undefined, objectId: string): boolean;
+export declare function findObjectPageIndex(doc: PDFDocumentEntry | undefined, objectId: string): number;
+export declare function updateObjectInDoc(doc: PDFDocumentEntry | undefined, pageIndex: number, objectId: string, payload: Partial<PDFElementObject>): boolean;
+export declare function removeObjectFromDoc(doc: PDFDocumentEntry | undefined, pageIndex: number, objectId: string): boolean;

package/dist/utils/pageBounds.d.ts

@@ -0,0 +1,5 @@
+export declare function getViewportWindow(scrollTop: number, viewHeight: number, margin?: number): {
+    minY: number;
+    maxY: number;
+};
+export declare function isPageInViewport(offsetTop: number, offsetHeight: number, minY: number, maxY: number): boolean;

package/dist/utils/zoom.d.ts

@@ -0,0 +1,2 @@
+import { PDFDocumentEntry } from '../types';
+export declare function applyScaleToDocs(docs: PDFDocumentEntry[], scale: number): void;

package/package.json

@@ -1,11 +1,18 @@
 {
   "name": "@libresign/pdf-elements",
-  "description": "PDF viewer with draggable and resizable element overlays for Vue 2",
-  "version": "0.3.1",
+  "description": "PDF viewer with draggable and resizable element overlays for Vue 3",
+  "version": "1.0.0",
   "author": "LibreCode <contact@librecode.coop>",
   "private": false,
-  "main": "dist/pdf-elements.umd.js",
-  "module": "dist/pdf-elements.esm.js",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/LibreSign/pdf-elements"
@@ -21,40 +28,58 @@
     "draggable",
     "resizable",
     "libresign",
-    "vue2"
+    "vue3"
   ],
   "scripts": {
-    "serve": "vue-cli-service serve",
-    "build": "vue-cli-service build",
-    "build:lib": "vue-cli-service build --target lib --name pdf-elements src/index.js",
-    "lint": "vue-cli-service lint --no-fix",
-    "lint:fix": "vue-cli-service lint"
+    "dev": "vite",
+    "build": "vite build",
+    "build:report": "vite build --mode report",
+    "build:demo": "vite build --mode demo",
+    "preview:demo": "vite preview --outDir dist-demo",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint . --ext .vue,.ts,.js --max-warnings=0",
+    "lint:fix": "eslint . --ext .vue,.ts,.js --fix"
   },
   "dependencies": {
-    "pdfjs-dist": "^5.4.530",
-    "vue": "^2.7.16"
+    "pdfjs-dist": "^5.4.624",
+    "vue": "^3.5.28"
   },
   "devDependencies": {
-    "@babel/core": "^7.28.6",
-    "@babel/eslint-parser": "^7.28.6",
-    "@babel/plugin-transform-private-methods": "^7.28.6",
     "@nextcloud/browserslist-config": "^3.1.2",
-    "@vue/cli-plugin-babel": "^5.0.9",
-    "@vue/cli-plugin-eslint": "^5.0.9",
-    "@vue/cli-service": "^5.0.9",
-    "eslint": "^8.57.1",
-    "eslint-plugin-vue": "^9.24.0",
+    "@eslint/js": "^9.39.3",
+    "@typescript-eslint/eslint-plugin": "^8.56.0",
+    "@typescript-eslint/parser": "^8.56.0",
+    "@vitejs/plugin-vue": "^6.0.4",
+    "eslint": "^9.0.0",
+    "eslint-plugin-vue": "^10.8.0",
+    "eslint-plugin-vitest": "^0.5.4",
+    "globals": "^15.9.0",
+    "happy-dom": "^20.7.0",
     "postcss": "^8.5.6",
-    "vue-template-compiler": "^2.7.16"
+    "rollup-plugin-visualizer": "^7.0.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.0.18",
+    "@vue/test-utils": "^2.4.6",
+    "vue-eslint-parser": "^10.4.0",
+    "vue-tsc": "^3.2.4"
   },
   "browserslist": [
     "extends @nextcloud/browserslist-config"
   ],
+  "overrides": {
+    "eslint-plugin-vitest": {
+      "@typescript-eslint/utils": "^8.56.0"
+    }
+  },
   "files": [
     "dist",
     "src",
     "COPYING",
     "README.md"
   ],
+  "sideEffects": false,
   "license": "AGPL-3.0-or-later"
 }

package/src/components/DraggableElement.vue

@@ -54,12 +54,15 @@ SPDX-License-Identifier: AGPL-3.0-or-later
   </div>
 </template>
 
-<script>
-export default {
+<script lang="ts">
+import { defineComponent, type PropType, type CSSProperties } from 'vue'
+import type { PDFElementObject } from '../types'
+
+export default defineComponent({
   name: 'DraggableElement',
   props: {
     object: {
-      type: Object,
+      type: Object as PropType<PDFElementObject>,
       required: true,
     },
     pagesScale: {
@@ -75,27 +78,27 @@ export default {
       required: true,
     },
     onUpdate: {
-      type: Function,
+      type: Function as PropType<(...args: any[]) => void>,
       default: () => {},
     },
     onDelete: {
-      type: Function,
+      type: Function as PropType<(...args: any[]) => void>,
       default: () => {},
     },
     onDuplicate: {
-      type: Function,
+      type: Function as PropType<(...args: any[]) => void>,
       default: () => {},
     },
     onDragStart: {
-      type: Function,
+      type: Function as PropType<(...args: any[]) => void>,
       default: () => {},
     },
     onDragMove: {
-      type: Function,
+      type: Function as PropType<(...args: any[]) => void>,
       default: () => {},
     },
     onDragEnd: {
-      type: Function,
+      type: Function as PropType<(...args: any[]) => void>,
       default: () => {},
     },
     isBeingDraggedGlobally: {
@@ -103,7 +106,7 @@ export default {
       default: false,
     },
     draggingClientPos: {
-      type: Object,
+      type: Object as PropType<{ x: number; y: number }>,
       default: () => ({ x: 0, y: 0 }),
     },
     currentDocIndex: {
@@ -135,7 +138,7 @@ export default {
       default: false,
     },
     ignoreClickOutsideSelectors: {
-      type: Array,
+      type: Array as PropType<string[]>,
       default: () => [],
     },
   },
@@ -188,7 +191,7 @@ export default {
         width: `${currentWidth * scale}px`,
         height: `${currentHeight * scale}px`,
         pointerEvents: this.readOnly ? 'none' : 'auto',
-      }
+      } as CSSProperties
     },
     toolbarStyle() {
       const scale = this.pagesScale || 1
@@ -209,7 +212,7 @@ export default {
         left: `${(x + width / 2) * scale}px`,
         top: `${top * scale}px`,
         transform: 'translateX(-50%)',
-      }
+      } as CSSProperties
     },
     dragElementStyle() {
       if (!this.isBeingDraggedGlobally || !this.draggingClientPos) {
@@ -218,7 +221,7 @@ export default {
       return {
         opacity: 0,
         pointerEvents: 'none',
-      }
+      } as CSSProperties
     },
   },
   mounted() {
@@ -476,7 +479,7 @@ export default {
       this.currentPageRect = null
     },
   },
-}
+})
 </script>
 
 <style scoped>