pdfcedar 0.1.0-beta.0 → 0.1.1-beta.0

package/dist/viewer.d.cts

@@ -0,0 +1,96 @@
+import { type AnnotationInput, type AnnotationJSON, type AnnotationPatch, type ImportOptions, type ListFilter, type FitMode, type FormValues, type Handler, type Rect, type Rotation, type SearchResult, type ViewerEvents, type ViewerOptions } from './types/core/index.cjs';
+export declare const VERSION = "0.1.1-beta.0";
+export interface AnnotationsApi {
+    /** Validates, fills defaults (id, author from `user`, timestamps, colors) and returns the stored annotation. */
+    add(annotation: AnnotationInput): AnnotationJSON;
+    update(id: string, patch: AnnotationPatch): AnnotationJSON;
+    /** Also removes the annotation's reply thread. */
+    remove(id: string): void;
+    /** In z-order (last is on top). Optionally only one page and/or type. */
+    list(filter?: ListFilter): AnnotationJSON[];
+    export(): AnnotationJSON[];
+    /** All-or-nothing: if any entry is invalid, nothing changes. One undo step. */
+    import(json: AnnotationJSON[], options?: ImportOptions): void;
+}
+export interface PagesApi {
+    /** Rotates a page clockwise. Annotations on it turn with it. One undo step. */
+    rotate(page: number, degrees: Rotation): void;
+    /** Deletes a page and its annotations; later annotations move up a page. The last page can't be deleted. */
+    delete(page: number): void;
+    /** Moves page `from` so it becomes page `to` (1-based); annotations move with it. */
+    move(from: number, to: number): void;
+    /** Appends every page of another PDF. */
+    merge(file: ViewerOptions['document']): Promise<void>;
+}
+export interface FormsApi {
+    /**
+     * Every field's value by fully qualified name: text → string, checkbox → boolean, radio group → the chosen
+     * button's export value ('' for none), dropdown → string, list box → string (string[] if multi-select).
+     * Empty until `documentLoaded`, and after flatten().
+     */
+    getValues(): FormValues;
+    /** Validates every entry first (throws FormValueError, changing nothing), then applies them as one undo step. */
+    setValues(values: FormValues): void;
+    /** On save, draws every field into its page and removes the form. Undoable until saved. */
+    flatten(): void;
+}
+export interface SignaturesApi {
+    /**
+     * Places a signature image (data URL, image URL or Blob; PNG, JPEG, WebP, SVG…) in `rect` on `page`.
+     * Resolves once the image is read and converted. It's an annotation of type 'signature' until saved,
+     * when it's drawn into the page. Fires `signatureAdded` (and `annotationAdded`).
+     */
+    add(signature: {
+        page: number;
+        rect: Rect;
+        image: string | Blob;
+    }): Promise<AnnotationJSON>;
+}
+export interface RedactionApi {
+    /** Marks an area for redaction: an editable, undoable annotation of type 'redaction' until applied. */
+    mark(region: {
+        page: number;
+        rect: Rect;
+    }): AnnotationJSON;
+    /**
+     * Applies every mark. This is final: the marks turn black, what's under them can no longer be selected,
+     * copied or found, annotations and form fields under them are deleted, and the undo history is cleared.
+     * Saving (save, download, print) removes the content itself from the file.
+     */
+    apply(): Promise<void>;
+}
+export interface Viewer {
+    on<K extends keyof ViewerEvents>(event: K, handler: Handler<ViewerEvents[K]>): void;
+    off<K extends keyof ViewerEvents>(event: K, handler: Handler<ViewerEvents[K]>): void;
+    goToPage(page: number): void;
+    setZoom(zoom: number): void;
+    fit(mode: FitMode): void;
+    search(text: string): Promise<SearchResult[]>;
+    readonly annotations: AnnotationsApi;
+    undo(): void;
+    redo(): void;
+    readonly pages: PagesApi;
+    readonly forms: FormsApi;
+    readonly signatures: SignaturesApi;
+    readonly redaction: RedactionApi;
+    /** The PDF with all annotations written as standard PDF annotations. Fires `saved`. */
+    save(): Promise<Uint8Array>;
+    /** Saves and offers the file as a download; the name defaults to the original file's. Fires `saved`. */
+    download(fileName?: string): Promise<void>;
+    /** Prints the document with its annotations. Resolves when the print dialog closes. */
+    print(): Promise<void>;
+    destroy(): void;
+}
+/** A sensible download name from the original source: the File's name or the URL's last segment. */
+export declare function defaultFileName(source: ViewerOptions['document']): string;
+/**
+ * Mounts a viewer and resolves once the document has opened and its first pages are laid out,
+ * so navigation methods work right after `await`. Rejects (and unmounts) if the document can't be opened.
+ * `documentLoaded` fires later, once the file's own annotations have been loaded as editable annotations,
+ * so handlers attached right after `await` still receive it and see the complete annotation list.
+ *
+ * A container holds one viewer. Calling createViewer again on the same container destroys the previous
+ * viewer; if that one was still loading, its promise rejects with an `AbortError` DOMException. This makes
+ * framework remounts (React StrictMode, a changed file) safe without any bookkeeping in the app.
+ */
+export declare function createViewer(options: ViewerOptions): Promise<Viewer>;

package/dist/viewer.d.ts

@@ -1,5 +1,5 @@
 import { type AnnotationInput, type AnnotationJSON, type AnnotationPatch, type ImportOptions, type ListFilter, type FitMode, type FormValues, type Handler, type Rect, type Rotation, type SearchResult, type ViewerEvents, type ViewerOptions } from './types/core/index.js';
-export declare const VERSION = "0.1.0-beta.0";
+export declare const VERSION = "0.1.1-beta.0";
 export interface AnnotationsApi {
     /** Validates, fills defaults (id, author from `user`, timestamps, colors) and returns the stored annotation. */
     add(annotation: AnnotationInput): AnnotationJSON;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdfcedar",
-  "version": "0.1.0-beta.0",
+  "version": "0.1.1-beta.0",
   "description": "Embeddable PDF viewer SDK for the web: view, annotate, edit pages and save PDFs in React, Vue, Angular or plain HTML",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Waseem Ahmad Dar",
@@ -11,12 +11,19 @@
   "keywords": [
     "pdf",
     "pdf-viewer",
+    "pdf-editor",
+    "pdf-sdk",
     "pdf-annotation",
+    "pdf-signature",
+    "e-signature",
+    "pdf-form",
+    "redaction",
     "pdfjs",
     "web-components",
     "react",
     "vue",
-    "angular"
+    "angular",
+    "typescript"
   ],
   "type": "module",
   "main": "./dist/index.umd.cjs",
@@ -24,12 +31,19 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.umd.cjs"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.umd.cjs"
+      }
     },
     "./package.json": "./package.json"
   },
+  "unpkg": "./dist/pdfcedar.umd.js",
+  "jsdelivr": "./dist/pdfcedar.umd.js",
   "bin": {
     "pdfcedar-assets": "./bin/pdfcedar-assets.mjs"
   },
@@ -39,15 +53,5 @@
     "bin",
     "LICENSE",
     "README.md"
-  ],
-  "devDependencies": {
-    "@pdfcedar/core": "0.0.0",
-    "@pdfcedar/writer": "0.0.0",
-    "@pdfcedar/renderer": "0.0.0",
-    "@pdfcedar/ui": "0.0.0",
-    "@pdfcedar/collab": "0.0.0"
-  },
-  "scripts": {
-    "build": "vite build && vite build --mode umd && node ../../scripts/build-types.mjs && node ../../scripts/third-party-notices.mjs"
-  }
-}
+  ]
+}