@embedpdf/models 2.1.1 → 2.2.0

package/dist/pdf.d.ts

@@ -48,6 +48,19 @@ export interface PdfDocumentObject {
      * Pages in this document
      */
     pages: PdfPageObject[];
+    /**
+     * Whether the document is encrypted
+     */
+    isEncrypted: boolean;
+    /**
+     * Whether owner permissions are currently unlocked
+     */
+    isOwnerUnlocked: boolean;
+    /**
+     * Raw permission flags from FPDF_GetDocPermissions.
+     * Use PdfPermissionFlag to check individual permissions.
+     */
+    permissions: number;
 }
 /**
  * metadata of pdf document
@@ -2054,15 +2067,53 @@ export interface PdfAnnotationTransformation {
  * @public
  */
 export type PdfFileContent = ArrayBuffer;
-export declare enum PdfPermission {
-    PrintDocument = 8,
-    ModifyContent = 16,
-    CopyOrExtract = 32,
-    AddOrModifyTextAnnot = 64,
-    FillInExistingForm = 512,
-    ExtractTextOrGraphics = 1024,
-    AssembleDocument = 2048,
-    PrintHighQuality = 4096
+/**
+ * PDF permission flags per ISO 32000-1 Table 22
+ * These are the flags to pass to setDocumentEncryption indicating what actions ARE ALLOWED.
+ * Use buildPermissions() helper to combine flags.
+ *
+ * @public
+ */
+export declare enum PdfPermissionFlag {
+    /** Bit 3: Print (possibly degraded quality) */
+    Print = 4,
+    /** Bit 4: Modify document contents */
+    ModifyContents = 8,
+    /** Bit 5: Copy/extract text and graphics */
+    CopyContents = 16,
+    /** Bit 6: Add/modify annotations, fill forms */
+    ModifyAnnotations = 32,
+    /** Bit 9: Fill in existing form fields */
+    FillForms = 256,
+    /** Bit 10: Extract for accessibility */
+    ExtractForAccessibility = 512,
+    /** Bit 11: Assemble document (insert, rotate, delete pages) */
+    AssembleDocument = 1024,
+    /** Bit 12: High quality print */
+    PrintHighQuality = 2048,
+    /** Common combination: Allow all permissions */
+    AllowAll = 3900
+}
+/**
+ * Helper function to combine permission flags for setDocumentEncryption.
+ * Note: PrintHighQuality automatically includes Print (enforced in C++ layer as well).
+ *
+ * @param flags - Permission flags to combine
+ * @returns Combined permission flags as a number
+ *
+ * @public
+ */
+export declare function buildPermissions(...flags: PdfPermissionFlag[]): number;
+/**
+ * Error thrown when a permission check fails.
+ *
+ * @public
+ */
+export declare class PermissionDeniedError extends Error {
+    readonly requiredFlags: PdfPermissionFlag[];
+    readonly currentPermissions: number;
+    readonly name = "PermissionDeniedError";
+    constructor(requiredFlags: PdfPermissionFlag[], currentPermissions: number);
 }
 export declare enum PdfPageFlattenFlag {
     Display = 0,
@@ -2634,6 +2685,43 @@ export interface PdfEngine<T = Blob> {
      * @returns task that all documents are closed or not
      */
     closeAllDocuments: () => PdfTask<boolean>;
+    /**
+     * Sets AES-256 encryption on a document.
+     * Must be called before saveAsCopy() for encryption to take effect.
+     * @param doc - pdf document
+     * @param userPassword - Password to open document (empty = no open password)
+     * @param ownerPassword - Password to change permissions (required)
+     * @param allowedFlags - OR'd PdfPermissionFlag values indicating allowed actions
+     * @returns task indicating success or failure
+     */
+    setDocumentEncryption: (doc: PdfDocumentObject, userPassword: string, ownerPassword: string, allowedFlags: number) => PdfTask<boolean>;
+    /**
+     * Marks document for encryption removal on save.
+     * Call this to remove password protection when saving.
+     * @param doc - pdf document
+     * @returns task indicating success
+     */
+    removeEncryption: (doc: PdfDocumentObject) => PdfTask<boolean>;
+    /**
+     * Attempt to unlock owner permissions on an encrypted document.
+     * Call this after opening a document with user-level access to gain full permissions.
+     * @param doc - pdf document
+     * @param ownerPassword - the owner password
+     * @returns task that indicates whether unlock succeeded
+     */
+    unlockOwnerPermissions: (doc: PdfDocumentObject, ownerPassword: string) => PdfTask<boolean>;
+    /**
+     * Check if a document is encrypted.
+     * @param doc - pdf document
+     * @returns task that resolves to true if the document is encrypted
+     */
+    isEncrypted: (doc: PdfDocumentObject) => PdfTask<boolean>;
+    /**
+     * Check if owner permissions are currently unlocked.
+     * @param doc - pdf document
+     * @returns task that resolves to true if owner permissions are unlocked
+     */
+    isOwnerUnlocked: (doc: PdfDocumentObject) => PdfTask<boolean>;
 }
 /**
  * Method name of PdfEngine interface
@@ -2708,6 +2796,11 @@ export interface IPdfiumExecutor {
     saveAsCopy(doc: PdfDocumentObject): PdfTask<ArrayBuffer>;
     closeDocument(doc: PdfDocumentObject): PdfTask<boolean>;
     closeAllDocuments(): PdfTask<boolean>;
+    setDocumentEncryption(doc: PdfDocumentObject, userPassword: string, ownerPassword: string, allowedFlags: number): PdfTask<boolean>;
+    removeEncryption(doc: PdfDocumentObject): PdfTask<boolean>;
+    unlockOwnerPermissions(doc: PdfDocumentObject, ownerPassword: string): PdfTask<boolean>;
+    isEncrypted(doc: PdfDocumentObject): PdfTask<boolean>;
+    isOwnerUnlocked(doc: PdfDocumentObject): PdfTask<boolean>;
 }
 /**
  * Arguments of PdfEngine method

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embedpdf/models",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "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",