@embedpdf/engines 2.0.0-next.2 → 2.0.0

package/README.md

@@ -10,7 +10,7 @@
 
 # @embedpdf/engines
 
-Pluggable rendering engines for EmbedPDF. Ships with **`PdfiumEngine`** – a high‑level, promise‑first wrapper built on top of `@embedpdf/pdfium`.
+Pluggable rendering engines for EmbedPDF. Ships with **`PdfiumNative`** (low-level executor) and **`PdfEngine`** (high-level orchestrator) – a promise‑first API built on top of `@embedpdf/pdfium`.
 
 ## Documentation
 
@@ -43,7 +43,8 @@ npm install @embedpdf/engines @embedpdf/pdfium
 
 ```typescript
 import { init } from '@embedpdf/pdfium';
-import { PdfiumEngine } from '@embedpdf/engines/pdfium';
+import { PdfiumNative, PdfEngine } from '@embedpdf/engines/pdfium';
+import { browserImageDataToBlobConverter } from '@embedpdf/engines/converters';
 
 const pdfiumWasm =
   'https://cdn.jsdelivr.net/npm/@embedpdf/pdfium/dist/pdfium.wasm';
@@ -51,15 +52,20 @@ const pdfiumWasm =
 (async () => {
   const response = await fetch(pdfiumWasm);
   const wasmBinary = await response.arrayBuffer();
-  // 1 – boot the low‑level WASM module
-  const pdfium = await init({ wasmBinary });
 
-  // 2 – create the high‑level engine
-  const engine = new PdfiumEngine(pdfium);
-  engine.initialize();
+  // 1 – boot the low‑level WASM module
+  const pdfiumModule = await init({ wasmBinary });
 
-  // 3 – open & render
-  const document = await engine
+  // 2 – create the native executor (initializes PDFium automatically)
+  const native = new PdfiumNative(pdfiumModule);
+
+  // 3 – create the orchestrator with image converter
+  const engine = new PdfEngine(native, {
+    imageConverter: browserImageDataToBlobConverter,
+  });
+
+  // 4 – open & render
+  const doc = await engine
     .openDocumentUrl({ id: 'demo', url: '/demo.pdf' })
     .toPromise();
   const page0 = doc.pages[0];

package/dist/browser-C6QEa8uk.cjs

@@ -0,0 +1,2 @@
+"use strict";class e extends Error{constructor(e){super(e),this.name="ImageConverterError"}}const t=(t,r="image/webp",n)=>{if("undefined"==typeof document)return Promise.reject(new e("document is not available. This converter requires a browser environment."));const a=t(),o=new ImageData(a.data,a.width,a.height);return new Promise((t,a)=>{const i=document.createElement("canvas");i.width=o.width,i.height=o.height,i.getContext("2d").putImageData(o,0,0),i.toBlob(r=>{r?t(r):a(new e("Canvas toBlob returned null"))},r,n)})};exports.ImageConverterError=e,exports.browserImageDataToBlobConverter=t,exports.createHybridImageConverter=function(e){return async(r,n="image/webp",a)=>{try{const t=r(),o=new Uint8ClampedArray(t.data);return await e.encode({data:o,width:t.width,height:t.height},n,a)}catch(o){return console.warn("Worker encoding failed, falling back to main-thread Canvas:",o),t(r,n,a)}}},exports.createWorkerPoolImageConverter=function(e){return(t,r="image/webp",n)=>{const a=t(),o=new Uint8ClampedArray(a.data);return e.encode({data:o,width:a.width,height:a.height},r,n)}};
+//# sourceMappingURL=browser-C6QEa8uk.cjs.map

package/dist/browser-C6QEa8uk.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-C6QEa8uk.cjs","sources":["../src/lib/converters/browser.ts"],"sourcesContent":["import type { ImageConversionTypes } from '@embedpdf/models';\nimport type { ImageDataConverter, LazyImageData } from './types';\nimport { ImageEncoderWorkerPool } from '../image-encoder';\n\n// ============================================================================\n// Error Classes\n// ============================================================================\n\nexport class ImageConverterError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = 'ImageConverterError';\n  }\n}\n\n// ============================================================================\n// Browser Converters\n// ============================================================================\n\n/**\n * Main-thread Canvas-based image converter\n * Simple and works everywhere, but blocks the main thread during encoding\n *\n * Use this as a fallback when worker-based encoding isn't available\n */\nexport const browserImageDataToBlobConverter: ImageDataConverter<Blob> = (\n  getImageData: LazyImageData,\n  imageType: ImageConversionTypes = 'image/webp',\n  quality?: number,\n): Promise<Blob> => {\n  if (typeof document === 'undefined') {\n    return Promise.reject(\n      new ImageConverterError(\n        'document is not available. This converter requires a browser environment.',\n      ),\n    );\n  }\n\n  const pdfImage = getImageData();\n  const imageData = new ImageData(pdfImage.data, pdfImage.width, pdfImage.height);\n\n  return new Promise((resolve, reject) => {\n    const canvas = document.createElement('canvas');\n    canvas.width = imageData.width;\n    canvas.height = imageData.height;\n    canvas.getContext('2d')!.putImageData(imageData, 0, 0);\n\n    canvas.toBlob(\n      (blob) => {\n        if (blob) {\n          resolve(blob);\n        } else {\n          reject(new ImageConverterError('Canvas toBlob returned null'));\n        }\n      },\n      imageType,\n      quality,\n    );\n  });\n};\n\n/**\n * Worker pool image converter using OffscreenCanvas in dedicated workers\n * Non-blocking - encoding happens off the main thread\n *\n * This is the preferred approach for performance\n *\n * @param workerPool - Instance of ImageEncoderWorkerPool\n * @returns ImageDataConverter function\n */\nexport function createWorkerPoolImageConverter(\n  workerPool: ImageEncoderWorkerPool,\n): ImageDataConverter<Blob> {\n  return (\n    getImageData: LazyImageData,\n    imageType: ImageConversionTypes = 'image/webp',\n    quality?: number,\n  ): Promise<Blob> => {\n    const pdfImage = getImageData();\n\n    // Copy the data since we'll transfer it to another worker\n    const dataCopy = new Uint8ClampedArray(pdfImage.data);\n\n    return workerPool.encode(\n      {\n        data: dataCopy,\n        width: pdfImage.width,\n        height: pdfImage.height,\n      },\n      imageType,\n      quality,\n    );\n  };\n}\n\n/**\n * Hybrid converter: Worker pool (OffscreenCanvas) → Main thread Canvas fallback\n *\n * Best of both worlds:\n * - Primary: Non-blocking worker-based encoding with OffscreenCanvas\n * - Fallback: Main-thread Canvas for older browsers without OffscreenCanvas in workers\n *\n * @param workerPool - Instance of ImageEncoderWorkerPool\n * @returns ImageDataConverter function\n */\nexport function createHybridImageConverter(\n  workerPool: ImageEncoderWorkerPool,\n): ImageDataConverter<Blob> {\n  return async (\n    getImageData: LazyImageData,\n    imageType: ImageConversionTypes = 'image/webp',\n    quality?: number,\n  ): Promise<Blob> => {\n    try {\n      // Try worker pool encoding first (OffscreenCanvas in worker)\n      const pdfImage = getImageData();\n      const dataCopy = new Uint8ClampedArray(pdfImage.data);\n\n      return await workerPool.encode(\n        {\n          data: dataCopy,\n          width: pdfImage.width,\n          height: pdfImage.height,\n        },\n        imageType,\n        quality,\n      );\n    } catch (error) {\n      // Fallback to main-thread Canvas\n      console.warn('Worker encoding failed, falling back to main-thread Canvas:', error);\n      return browserImageDataToBlobConverter(getImageData, imageType, quality);\n    }\n  };\n}\n"],"names":["ImageConverterError","Error","constructor","message","super","this","name","browserImageDataToBlobConverter","getImageData","imageType","quality","document","Promise","reject","pdfImage","imageData","ImageData","data","width","height","resolve","canvas","createElement","getContext","putImageData","toBlob","blob","workerPool","async","dataCopy","Uint8ClampedArray","encode","error","console","warn"],"mappings":"aAQO,MAAMA,UAA4BC,MACvC,WAAAC,CAAYC,GACVC,MAAMD,GACNE,KAAKC,KAAO,qBACd,EAaK,MAAMC,EAA4D,CACvEC,EACAC,EAAkC,aAClCC,KAEA,GAAwB,oBAAbC,SACT,OAAOC,QAAQC,OACb,IAAIb,EACF,8EAKN,MAAMc,EAAWN,IACXO,EAAY,IAAIC,UAAUF,EAASG,KAAMH,EAASI,MAAOJ,EAASK,QAExE,OAAO,IAAIP,QAAQ,CAACQ,EAASP,KAC3B,MAAMQ,EAASV,SAASW,cAAc,UACtCD,EAAOH,MAAQH,EAAUG,MACzBG,EAAOF,OAASJ,EAAUI,OAC1BE,EAAOE,WAAW,MAAOC,aAAaT,EAAW,EAAG,GAEpDM,EAAOI,OACJC,IACKA,EACFN,EAAQM,GAERb,EAAO,IAAIb,EAAoB,iCAGnCS,EACAC,iHAiDC,SACLiB,GAEA,OAAOC,MACLpB,EACAC,EAAkC,aAClCC,KAEA,IAEE,MAAMI,EAAWN,IACXqB,EAAW,IAAIC,kBAAkBhB,EAASG,MAEhD,aAAaU,EAAWI,OACtB,CACEd,KAAMY,EACNX,MAAOJ,EAASI,MAChBC,OAAQL,EAASK,QAEnBV,EACAC,EAEJ,OAASsB,GAGP,OADAC,QAAQC,KAAK,8DAA+DF,GACrEzB,EAAgCC,EAAcC,EAAWC,EAClE,EAEJ,yCA/DO,SACLiB,GAEA,MAAO,CACLnB,EACAC,EAAkC,aAClCC,KAEA,MAAMI,EAAWN,IAGXqB,EAAW,IAAIC,kBAAkBhB,EAASG,MAEhD,OAAOU,EAAWI,OAChB,CACEd,KAAMY,EACNX,MAAOJ,EAASI,MAChBC,OAAQL,EAASK,QAEnBV,EACAC,GAGN"}

package/dist/browser-awZxztMA.js

@@ -0,0 +1,76 @@
+class ImageConverterError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "ImageConverterError";
+  }
+}
+const browserImageDataToBlobConverter = (getImageData, imageType = "image/webp", quality) => {
+  if (typeof document === "undefined") {
+    return Promise.reject(
+      new ImageConverterError(
+        "document is not available. This converter requires a browser environment."
+      )
+    );
+  }
+  const pdfImage = getImageData();
+  const imageData = new ImageData(pdfImage.data, pdfImage.width, pdfImage.height);
+  return new Promise((resolve, reject) => {
+    const canvas = document.createElement("canvas");
+    canvas.width = imageData.width;
+    canvas.height = imageData.height;
+    canvas.getContext("2d").putImageData(imageData, 0, 0);
+    canvas.toBlob(
+      (blob) => {
+        if (blob) {
+          resolve(blob);
+        } else {
+          reject(new ImageConverterError("Canvas toBlob returned null"));
+        }
+      },
+      imageType,
+      quality
+    );
+  });
+};
+function createWorkerPoolImageConverter(workerPool) {
+  return (getImageData, imageType = "image/webp", quality) => {
+    const pdfImage = getImageData();
+    const dataCopy = new Uint8ClampedArray(pdfImage.data);
+    return workerPool.encode(
+      {
+        data: dataCopy,
+        width: pdfImage.width,
+        height: pdfImage.height
+      },
+      imageType,
+      quality
+    );
+  };
+}
+function createHybridImageConverter(workerPool) {
+  return async (getImageData, imageType = "image/webp", quality) => {
+    try {
+      const pdfImage = getImageData();
+      const dataCopy = new Uint8ClampedArray(pdfImage.data);
+      return await workerPool.encode(
+        {
+          data: dataCopy,
+          width: pdfImage.width,
+          height: pdfImage.height
+        },
+        imageType,
+        quality
+      );
+    } catch (error) {
+      console.warn("Worker encoding failed, falling back to main-thread Canvas:", error);
+      return browserImageDataToBlobConverter(getImageData, imageType, quality);
+    }
+  };
+}
+export {
+  ImageConverterError as I,
+  createHybridImageConverter as a,
+  browserImageDataToBlobConverter as b,
+  createWorkerPoolImageConverter as c
+};
+//# sourceMappingURL=browser-awZxztMA.js.map

package/dist/browser-awZxztMA.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-awZxztMA.js","sources":["../src/lib/converters/browser.ts"],"sourcesContent":["import type { ImageConversionTypes } from '@embedpdf/models';\nimport type { ImageDataConverter, LazyImageData } from './types';\nimport { ImageEncoderWorkerPool } from '../image-encoder';\n\n// ============================================================================\n// Error Classes\n// ============================================================================\n\nexport class ImageConverterError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = 'ImageConverterError';\n  }\n}\n\n// ============================================================================\n// Browser Converters\n// ============================================================================\n\n/**\n * Main-thread Canvas-based image converter\n * Simple and works everywhere, but blocks the main thread during encoding\n *\n * Use this as a fallback when worker-based encoding isn't available\n */\nexport const browserImageDataToBlobConverter: ImageDataConverter<Blob> = (\n  getImageData: LazyImageData,\n  imageType: ImageConversionTypes = 'image/webp',\n  quality?: number,\n): Promise<Blob> => {\n  if (typeof document === 'undefined') {\n    return Promise.reject(\n      new ImageConverterError(\n        'document is not available. This converter requires a browser environment.',\n      ),\n    );\n  }\n\n  const pdfImage = getImageData();\n  const imageData = new ImageData(pdfImage.data, pdfImage.width, pdfImage.height);\n\n  return new Promise((resolve, reject) => {\n    const canvas = document.createElement('canvas');\n    canvas.width = imageData.width;\n    canvas.height = imageData.height;\n    canvas.getContext('2d')!.putImageData(imageData, 0, 0);\n\n    canvas.toBlob(\n      (blob) => {\n        if (blob) {\n          resolve(blob);\n        } else {\n          reject(new ImageConverterError('Canvas toBlob returned null'));\n        }\n      },\n      imageType,\n      quality,\n    );\n  });\n};\n\n/**\n * Worker pool image converter using OffscreenCanvas in dedicated workers\n * Non-blocking - encoding happens off the main thread\n *\n * This is the preferred approach for performance\n *\n * @param workerPool - Instance of ImageEncoderWorkerPool\n * @returns ImageDataConverter function\n */\nexport function createWorkerPoolImageConverter(\n  workerPool: ImageEncoderWorkerPool,\n): ImageDataConverter<Blob> {\n  return (\n    getImageData: LazyImageData,\n    imageType: ImageConversionTypes = 'image/webp',\n    quality?: number,\n  ): Promise<Blob> => {\n    const pdfImage = getImageData();\n\n    // Copy the data since we'll transfer it to another worker\n    const dataCopy = new Uint8ClampedArray(pdfImage.data);\n\n    return workerPool.encode(\n      {\n        data: dataCopy,\n        width: pdfImage.width,\n        height: pdfImage.height,\n      },\n      imageType,\n      quality,\n    );\n  };\n}\n\n/**\n * Hybrid converter: Worker pool (OffscreenCanvas) → Main thread Canvas fallback\n *\n * Best of both worlds:\n * - Primary: Non-blocking worker-based encoding with OffscreenCanvas\n * - Fallback: Main-thread Canvas for older browsers without OffscreenCanvas in workers\n *\n * @param workerPool - Instance of ImageEncoderWorkerPool\n * @returns ImageDataConverter function\n */\nexport function createHybridImageConverter(\n  workerPool: ImageEncoderWorkerPool,\n): ImageDataConverter<Blob> {\n  return async (\n    getImageData: LazyImageData,\n    imageType: ImageConversionTypes = 'image/webp',\n    quality?: number,\n  ): Promise<Blob> => {\n    try {\n      // Try worker pool encoding first (OffscreenCanvas in worker)\n      const pdfImage = getImageData();\n      const dataCopy = new Uint8ClampedArray(pdfImage.data);\n\n      return await workerPool.encode(\n        {\n          data: dataCopy,\n          width: pdfImage.width,\n          height: pdfImage.height,\n        },\n        imageType,\n        quality,\n      );\n    } catch (error) {\n      // Fallback to main-thread Canvas\n      console.warn('Worker encoding failed, falling back to main-thread Canvas:', error);\n      return browserImageDataToBlobConverter(getImageData, imageType, quality);\n    }\n  };\n}\n"],"names":[],"mappings":"AAQO,MAAM,4BAA4B,MAAM;AAAA,EAC7C,YAAY,SAAiB;AAC3B,UAAM,OAAO;AACb,SAAK,OAAO;AAAA,EACd;AACF;AAYO,MAAM,kCAA4D,CACvE,cACA,YAAkC,cAClC,YACkB;AAClB,MAAI,OAAO,aAAa,aAAa;AACnC,WAAO,QAAQ;AAAA,MACb,IAAI;AAAA,QACF;AAAA,MAAA;AAAA,IACF;AAAA,EAEJ;AAEA,QAAM,WAAW,aAAA;AACjB,QAAM,YAAY,IAAI,UAAU,SAAS,MAAM,SAAS,OAAO,SAAS,MAAM;AAE9E,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAM,SAAS,SAAS,cAAc,QAAQ;AAC9C,WAAO,QAAQ,UAAU;AACzB,WAAO,SAAS,UAAU;AAC1B,WAAO,WAAW,IAAI,EAAG,aAAa,WAAW,GAAG,CAAC;AAErD,WAAO;AAAA,MACL,CAAC,SAAS;AACR,YAAI,MAAM;AACR,kBAAQ,IAAI;AAAA,QACd,OAAO;AACL,iBAAO,IAAI,oBAAoB,6BAA6B,CAAC;AAAA,QAC/D;AAAA,MACF;AAAA,MACA;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ,CAAC;AACH;AAWO,SAAS,+BACd,YAC0B;AAC1B,SAAO,CACL,cACA,YAAkC,cAClC,YACkB;AAClB,UAAM,WAAW,aAAA;AAGjB,UAAM,WAAW,IAAI,kBAAkB,SAAS,IAAI;AAEpD,WAAO,WAAW;AAAA,MAChB;AAAA,QACE,MAAM;AAAA,QACN,OAAO,SAAS;AAAA,QAChB,QAAQ,SAAS;AAAA,MAAA;AAAA,MAEnB;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ;AACF;AAYO,SAAS,2BACd,YAC0B;AAC1B,SAAO,OACL,cACA,YAAkC,cAClC,YACkB;AAClB,QAAI;AAEF,YAAM,WAAW,aAAA;AACjB,YAAM,WAAW,IAAI,kBAAkB,SAAS,IAAI;AAEpD,aAAO,MAAM,WAAW;AAAA,QACtB;AAAA,UACE,MAAM;AAAA,UACN,OAAO,SAAS;AAAA,UAChB,QAAQ,SAAS;AAAA,QAAA;AAAA,QAEnB;AAAA,QACA;AAAA,MAAA;AAAA,IAEJ,SAAS,OAAO;AAEd,cAAQ,KAAK,+DAA+D,KAAK;AACjF,aAAO,gCAAgC,cAAc,WAAW,OAAO;AAAA,IACzE;AAAA,EACF;AACF;"}