@embedpdf/models 1.0.16 → 1.0.18

package/dist/pdf.d.ts

@@ -550,7 +550,7 @@ export declare enum PdfAnnotationState {
     /**
      * Annotation is complete
      */
-    Complete = "Complete",
+    Completed = "Completed",
     /**
      * Annotation is cancelled
      */
@@ -573,13 +573,130 @@ export declare enum PdfAnnotationStateModel {
     /**
      * Annotation is reviewed
      */
-    Reviewed = "Reviewed"
+    Review = "Review"
 }
 /**
- * Line ending of annotation
+ * Icon of pdf annotation
  *
  * @public
  */
+export declare enum PdfAnnotationIcon {
+    /**
+     * Unknown icon
+     */
+    Unknown = -1,
+    /**
+     * Comment icon
+     */
+    Comment = 0,
+    /**
+     * Key icon
+     */
+    Key = 1,
+    /**
+     * Note icon
+     */
+    Note = 2,
+    /**
+     * Help icon
+     */
+    Help = 3,
+    /**
+     * New paragraph icon
+     */
+    NewParagraph = 4,
+    /**
+     * Paragraph icon
+     */
+    Paragraph = 5,
+    /**
+     * Insert icon
+     */
+    Insert = 6,
+    /**
+     * Graph icon
+     */
+    Graph = 7,
+    /**
+     * Push pin icon
+     */
+    PushPin = 8,
+    /**
+     * Paperclip icon
+     */
+    Paperclip = 9,
+    /**
+     * Tag icon
+     */
+    Tag = 10,
+    /**
+     * Speaker icon
+     */
+    Speaker = 11,
+    /**
+     * Mic icon
+     */
+    Mic = 12,
+    /**
+     * Approved icon
+     */
+    Approved = 13,
+    /**
+     * Experimental icon
+     */
+    Experimental = 14,
+    /**
+     * Not approved icon
+     */
+    NotApproved = 15,
+    /**
+     * As is icon
+     */
+    AsIs = 16,
+    /**
+     * Expired icon
+     */
+    Expired = 17,
+    /**
+     * Not for public release icon
+     */
+    NotForPublicRelease = 18,
+    /**
+     * Confidential icon
+     */
+    Confidential = 19,
+    /**
+     * Final icon
+     */
+    Final = 20,
+    /**
+     * Sold icon
+     */
+    Sold = 21,
+    /**
+     * Departmental icon
+     */
+    Departmental = 22,
+    /**
+     * For comment icon
+     */
+    ForComment = 23,
+    /**
+     * Top secret icon
+     */
+    TopSecret = 24,
+    /**
+     * Draft icon
+     */
+    Draft = 25,
+    /**
+     * For public release icon
+     */
+    ForPublicRelease = 26
+}
+/**
+ * Line ending of annotation
+ */
 export declare enum PdfAnnotationLineEnding {
     /**
      * No line ending
@@ -640,6 +757,10 @@ export interface PdfAnnotationObjectBase {
      * Modified date of the annotation
      */
     modified?: Date;
+    /**
+     * Created date of the annotation
+     */
+    created?: Date;
     /**
      * blend mode of annotation
      */
@@ -660,14 +781,22 @@ export interface PdfAnnotationObjectBase {
      * The index of page that this annotation belong to
      */
     pageIndex: number;
+    /**
+     * contents of the annotation
+     */
+    contents?: string;
     /**
      * id of the annotation
      */
-    id: number;
+    id: string;
     /**
      * Rectangle of the annotation
      */
     rect: Rect;
+    /**
+     * Custom data of the annotation
+     */
+    custom?: any;
 }
 /**
  * Popup annotation
@@ -688,7 +817,7 @@ export interface PdfPopupAnnoObject extends PdfAnnotationObjectBase {
     /**
      * In reply to id
      */
-    inReplyToId?: number;
+    inReplyToId?: string;
 }
 /**
  * Pdf Link annotation
@@ -698,10 +827,6 @@ export interface PdfPopupAnnoObject extends PdfAnnotationObjectBase {
 export interface PdfLinkAnnoObject extends PdfAnnotationObjectBase {
     /** {@inheritDoc PdfAnnotationObjectBase.type} */
     type: PdfAnnotationSubtype.LINK;
-    /**
-     * Text of the link
-     */
-    text: string;
     /**
      * target of the link
      */
@@ -730,7 +855,7 @@ export interface PdfTextAnnoObject extends PdfAnnotationObjectBase {
     /**
      * In reply to id
      */
-    inReplyToId?: number;
+    inReplyToId?: string;
     /**
      * State of the text annotation
      */
@@ -739,6 +864,10 @@ export interface PdfTextAnnoObject extends PdfAnnotationObjectBase {
      * State model of the text annotation
      */
     stateModel?: PdfAnnotationStateModel;
+    /**
+     * Icon of the text annotation
+     */
+    icon?: PdfAnnotationIcon;
 }
 /**
  * Type of form field
@@ -1859,6 +1988,19 @@ export interface PdfFileLoader extends PdfFileWithoutContent {
      */
     callback: (offset: number, length: number) => Uint8Array;
 }
+export interface PdfPageWithAnnotations {
+    page: number;
+    annotations: PdfAnnotationObject[];
+}
+/**
+ * Progress of search all pages
+ *
+ * @public
+ */
+export type PdfPageSearchProgress = {
+    page: number;
+    results: SearchResult[];
+};
 /**
  * Pdf File
  *
@@ -1906,38 +2048,39 @@ export declare enum PdfErrorCode {
     CantFocusAnnot = 25,
     CantSelectText = 26,
     CantSelectOption = 27,
-    CantCheckField = 28
+    CantCheckField = 28,
+    CantSetAnnotString = 29
 }
 export interface PdfErrorReason {
     code: PdfErrorCode;
     message: string;
 }
 export type PdfEngineError = TaskError<PdfErrorReason>;
-export type PdfTask<R> = Task<R, PdfErrorReason>;
+export type PdfTask<R, P = unknown> = Task<R, PdfErrorReason, P>;
 export declare class PdfTaskHelper {
     /**
      * Create a task
      * @returns new task
      */
-    static create<R>(): Task<R, PdfErrorReason>;
+    static create<R, P = unknown>(): Task<R, PdfErrorReason, P>;
     /**
      * Create a task that has been resolved with value
      * @param result - resolved value
      * @returns resolved task
      */
-    static resolve<R>(result: R): Task<R, PdfErrorReason>;
+    static resolve<R, P = unknown>(result: R): Task<R, PdfErrorReason, P>;
     /**
      * Create a task that has been rejected with error
      * @param reason - rejected error
      * @returns rejected task
      */
-    static reject<T = any>(reason: PdfErrorReason): Task<T, PdfErrorReason>;
+    static reject<T = any, P = unknown>(reason: PdfErrorReason): Task<T, PdfErrorReason, P>;
     /**
      * Create a task that has been aborted with error
      * @param reason - aborted error
      * @returns aborted task
      */
-    static abort<T = any>(reason: PdfErrorReason): Task<T, PdfErrorReason>;
+    static abort<T = any, P = unknown>(reason: PdfErrorReason): Task<T, PdfErrorReason, P>;
 }
 /**
  * Pdf engine
@@ -2109,13 +2252,13 @@ export interface PdfEngine<T = Blob> {
      * @param flags - match flags for search
      * @returns Task contains all search results throughout the document
      */
-    searchAllPages: (doc: PdfDocumentObject, keyword: string, flags?: MatchFlag[]) => PdfTask<SearchAllPagesResult>;
+    searchAllPages: (doc: PdfDocumentObject, keyword: string, flags?: MatchFlag[]) => PdfTask<SearchAllPagesResult, PdfPageSearchProgress>;
     /**
      * Get all annotations in this file
      * @param doc - pdf document
      * @returns task that contains the annotations or error
      */
-    getAllAnnotations: (doc: PdfDocumentObject) => PdfTask<Record<number, PdfAnnotationObject[]>>;
+    getAllAnnotations: (doc: PdfDocumentObject) => PdfTask<Record<number, PdfAnnotationObject[]>, PdfPageWithAnnotations>;
     /**
      * Get all attachments in this file
      * @param doc - pdf document
@@ -2158,6 +2301,13 @@ export interface PdfEngine<T = Blob> {
      * @returns task contains the text
      */
     extractText: (doc: PdfDocumentObject, pageIndexes: number[]) => PdfTask<string>;
+    /**
+     * Redact text by run slices
+     * @param doc - pdf document
+     * @param perPage - per page run slices
+     * @returns task contains the result
+     */
+    redactTextInRects: (doc: PdfDocumentObject, page: PdfPageObject, rects: Rect[], recurseForms: boolean, drawBlackBoxes: boolean) => PdfTask<boolean>;
     /**
      * Extract text on specified pdf pages
      * @param doc - pdf document

package/dist/task.d.ts

@@ -43,6 +43,12 @@ export type ResolvedCallback<R> = (r: R) => void;
  * @public
  */
 export type RejectedCallback<D> = (e: TaskError<D>) => void;
+/**
+ * callback that will be called when task is progressing
+ *
+ * @public
+ */
+export type ProgressCallback<P> = (p: P) => void;
 /**
  * Task state in different stage
  *
@@ -86,7 +92,7 @@ export declare class TaskRejectedError<D> extends Error {
  *
  * @public
  */
-export declare class Task<R, D> {
+export declare class Task<R, D, P = unknown> {
     state: TaskState<R, D>;
     /**
      * callbacks that will be executed when task is resolved
@@ -100,6 +106,10 @@ export declare class Task<R, D> {
      * Promise that will be resolved when task is settled
      */
     private _promise;
+    /**
+     * callbacks that will be executed when task is progressing
+     */
+    private progressCbs;
     /**
      * Convert task to promise
      * @returns promise that will be resolved when task is settled
@@ -133,6 +143,16 @@ export declare class Task<R, D> {
      * @param error - TaskError from another task
      */
     fail(error: TaskError<D>): void;
+    /**
+     * add a progress callback
+     * @param cb - progress callback
+     */
+    onProgress(cb: ProgressCallback<P>): void;
+    /**
+     * call progress callback
+     * @param p - progress value
+     */
+    progress(p: P): void;
     /**
      * Static method to wait for all tasks to resolve
      * Returns a new task that resolves with an array of all results

package/dist/uuid.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Check whether the supplied string is a **valid RFC‑4122 v4 UUID**.
+ * Works in every runtime (browser / Node / Deno) because it is just
+ * string validation – no crypto required.
+ */
+export declare function isUuidV4(str: string): boolean;
+/**
+ * Generate a **version‑4 UUID** (random).
+ *
+ * • Uses the native `crypto.randomUUID()` when available (all modern
+ *   browsers, Deno, Node ≥ 16.9).
+ * • Falls back to a tiny, standards‑compliant implementation that uses
+ *   `crypto.getRandomValues` / `crypto.randomBytes` for entropy.
+ *
+ * @example
+ * ```ts
+ * import { uuidV4 } from "@embedpdf/models";
+ * const id = uuidV4();
+ * // → "36b8f84d-df4e-4d49-b662-bcde71a8764f"
+ * ```
+ */
+export declare function uuidV4(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embedpdf/models",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "private": false,
   "description": "Shared type definitions, data models, and utility helpers (geometry, tasks, logging, PDF primitives) that underpin every package in the EmbedPDF ecosystem.",
   "type": "module",