mindee 5.8.0 → 5.10.0

package/src/image/imageExtractor.js

@@ -2,8 +2,8 @@ import { loadOptionalDependency } from "../dependency/index.js";
 import { MindeeImageError } from "../errors/index.js";
 import { getMinMaxX, getMinMaxY } from "../geometry/index.js";
 import { adjustForRotation } from "../geometry/polygonUtils.js";
-import { ExtractedImage } from "../image/extractedImage.js";
-import { ExtractedImages } from "../image/extractedImages.js";
+import { ExtractedImage } from "./extractedImage.js";
+import { ExtractedImages } from "./extractedImages.js";
 import { logger } from "../logger.js";
 import { createPdfFromInputSource } from "../pdf/pdfOperation.js";
 import { rasterizePage } from "../pdf/pdfUtils.js";
@@ -39,7 +39,7 @@ export async function extractImagesFromPolygon(inputSource, polygonsPerPage, qua
 /**
  * Helper function to handle the drawing math and orientation.
  */
-function drawOrientedPage(pdfLib, samplePage, cropped, orientation, finalWidth, finalHeight, scaledWidth, scaledHeight) {
+function drawOrientedPage(currentPdfLib, samplePage, cropped, orientation, finalWidth, finalHeight, scaledWidth, scaledHeight) {
     if (orientation === 0) {
         samplePage.drawPage(cropped, {
             width: scaledWidth,
@@ -52,7 +52,7 @@ function drawOrientedPage(pdfLib, samplePage, cropped, orientation, finalWidth,
             y: finalHeight,
             width: scaledWidth,
             height: scaledHeight,
-            rotate: pdfLib.degrees(270),
+            rotate: currentPdfLib.degrees(270),
         });
     }
     else if (orientation === 180) {
@@ -61,7 +61,7 @@ function drawOrientedPage(pdfLib, samplePage, cropped, orientation, finalWidth,
             y: finalHeight,
             width: scaledWidth,
             height: scaledHeight,
-            rotate: pdfLib.degrees(180),
+            rotate: currentPdfLib.degrees(180),
         });
     }
     else if (orientation === 270) {
@@ -70,7 +70,7 @@ function drawOrientedPage(pdfLib, samplePage, cropped, orientation, finalWidth,
             y: 0,
             width: scaledWidth,
             height: scaledHeight,
-            rotate: pdfLib.degrees(90),
+            rotate: currentPdfLib.degrees(90),
         });
     }
 }
@@ -82,7 +82,7 @@ function drawOrientedPage(pdfLib, samplePage, cropped, orientation, finalWidth,
  * @param quality The quality of the extracted images.
  */
 export async function extractFromPage(pdfPage, polygons, asImage = false, quality) {
-    const pdfLib = await getPdfLib();
+    const currentPdfLib = await getPdfLib();
     const { width, height } = pdfPage.getSize();
     const extractedElements = [];
     if (quality !== undefined) {
@@ -100,15 +100,15 @@ export async function extractFromPage(pdfPage, polygons, asImage = false, qualit
     const pageIndex = sourceDoc.getPages().indexOf(pdfPage);
     for (const origPolygon of polygons) {
         logger.debug(`Extracting image with polygon: ${origPolygon.toString()}`);
-        const tempPdf = await pdfLib.PDFDocument.create();
+        const tempPdf = await currentPdfLib.PDFDocument.create();
         const [copiedPage] = await tempPdf.copyPages(sourceDoc, [pageIndex]);
         const polygon = adjustForRotation(origPolygon, orientation);
         const minX = getMinMaxX(polygon).min;
         const maxX = getMinMaxX(polygon).max;
         const minY = getMinMaxY(polygon).min;
         const maxY = getMinMaxY(polygon).max;
-        const newWidth = width * (maxX - minX);
-        const newHeight = height * (maxY - minY);
+        const imgWidth = width * (maxX - minX);
+        const imgHeight = height * (maxY - minY);
         const cropped = await tempPdf.embedPage(copiedPage, {
             left: minX * width,
             right: maxX * width,
@@ -116,13 +116,13 @@ export async function extractFromPage(pdfPage, polygons, asImage = false, qualit
             bottom: height - (maxY * height),
         });
         const isVertical = orientation === 90 || orientation === 270;
-        const finalWidth = (isVertical ? newHeight : newWidth) * qualityScale;
-        const finalHeight = (isVertical ? newWidth : newHeight) * qualityScale;
+        const finalWidth = (isVertical ? imgHeight : imgWidth) * qualityScale;
+        const finalHeight = (isVertical ? imgWidth : imgHeight) * qualityScale;
         const samplePage = tempPdf.addPage([finalWidth, finalHeight]);
         samplePage.drawRectangle({
-            x: 0, y: 0, width: finalWidth, height: finalHeight, color: pdfLib.rgb(1, 1, 1),
+            x: 0, y: 0, width: finalWidth, height: finalHeight, color: currentPdfLib.rgb(1, 1, 1),
         });
-        drawOrientedPage(pdfLib, samplePage, cropped, orientation, finalWidth, finalHeight, newWidth * qualityScale, newHeight * qualityScale);
+        drawOrientedPage(currentPdfLib, samplePage, cropped, orientation, finalWidth, finalHeight, imgWidth * qualityScale, imgHeight * qualityScale);
         const pdfBuffer = Buffer.from(await tempPdf.save());
         extractedElements.push(asImage ? await rasterizePage(pdfBuffer, 0, 100) : pdfBuffer);
     }

package/src/input/base64Input.d.ts

@@ -3,13 +3,19 @@ interface Base64InputProps {
     inputString: string;
     filename: string;
 }
-/** Local input source backed by a base64-encoded payload. */
+/**
+ * Local input source backed by a base64-encoded payload.
+ */
 export declare class Base64Input extends LocalInputSource {
     private inputString;
-    /** Decoded binary payload built from the base64 input. */
+    /**
+     * Decoded binary payload built from the base64 input.
+     */
     fileObject: Buffer;
     constructor({ inputString, filename }: Base64InputProps);
-    /** Decodes and validates the provided base64 content. */
+    /**
+     * Decodes and validates the provided base64 content.
+     */
     init(): Promise<void>;
 }
 export {};

package/src/input/base64Input.js

@@ -1,18 +1,24 @@
 import { LocalInputSource } from "./localInputSource.js";
 import { INPUT_TYPE_BASE64 } from "./inputSource.js";
 import { logger } from "../logger.js";
-/** Local input source backed by a base64-encoded payload. */
+/**
+ * Local input source backed by a base64-encoded payload.
+ */
 export class Base64Input extends LocalInputSource {
     constructor({ inputString, filename }) {
         super({
             inputType: INPUT_TYPE_BASE64,
         });
-        /** Decoded binary payload built from the base64 input. */
+        /**
+         * Decoded binary payload built from the base64 input.
+         */
         this.fileObject = Buffer.alloc(0);
         this.filename = filename;
         this.inputString = inputString;
     }
-    /** Decodes and validates the provided base64 content. */
+    /**
+     * Decodes and validates the provided base64 content.
+     */
     async init() {
         if (this.initialized) {
             return;

package/src/input/bufferInput.d.ts

@@ -1,12 +1,17 @@
+import { Buffer } from "node:buffer";
 import { LocalInputSource } from "./localInputSource.js";
 interface BufferInputProps {
     buffer: Buffer;
     filename: string;
 }
-/** Local input source backed by an in-memory `Buffer`. */
+/**
+ * Local input source backed by an in-memory `Buffer`.
+ */
 export declare class BufferInput extends LocalInputSource {
     constructor({ buffer, filename }: BufferInputProps);
-    /** Validates and initializes the in-memory buffer input. */
+    /**
+     * Validates and initializes the in-memory buffer input.
+     */
     init(): Promise<void>;
 }
 export {};

package/src/input/bufferInput.js

@@ -1,7 +1,9 @@
 import { LocalInputSource } from "./localInputSource.js";
 import { INPUT_TYPE_BUFFER } from "./inputSource.js";
 import { logger } from "../logger.js";
-/** Local input source backed by an in-memory `Buffer`. */
+/**
+ * Local input source backed by an in-memory `Buffer`.
+ */
 export class BufferInput extends LocalInputSource {
     constructor({ buffer, filename }) {
         super({
@@ -10,7 +12,9 @@ export class BufferInput extends LocalInputSource {
         this.fileObject = buffer;
         this.filename = filename;
     }
-    /** Validates and initializes the in-memory buffer input. */
+    /**
+     * Validates and initializes the in-memory buffer input.
+     */
     async init() {
         if (this.initialized) {
             return;

package/src/input/bytesInput.d.ts

@@ -1,15 +1,22 @@
+import { Buffer } from "node:buffer";
 import { LocalInputSource } from "./localInputSource.js";
 interface BytesInputProps {
     inputBytes: Uint8Array;
     filename: string;
 }
-/** Local input source backed by a `Uint8Array`. */
+/**
+ * Local input source backed by a `Uint8Array`.
+ */
 export declare class BytesInput extends LocalInputSource {
     private inputBytes;
-    /** Binary payload built from the byte array. */
+    /**
+     * Binary payload built from the byte array.
+     */
     fileObject: Buffer;
     constructor({ inputBytes, filename }: BytesInputProps);
-    /** Converts bytes to a buffer and validates MIME type. */
+    /**
+     * Converts bytes to a buffer and validates MIME type.
+     */
     init(): Promise<void>;
 }
 export {};

package/src/input/bytesInput.js

@@ -1,18 +1,25 @@
+import { Buffer } from "node:buffer";
 import { INPUT_TYPE_BYTES } from "./inputSource.js";
 import { LocalInputSource } from "./localInputSource.js";
 import { logger } from "../logger.js";
-/** Local input source backed by a `Uint8Array`. */
+/**
+ * Local input source backed by a `Uint8Array`.
+ */
 export class BytesInput extends LocalInputSource {
     constructor({ inputBytes, filename }) {
         super({
             inputType: INPUT_TYPE_BYTES,
         });
-        /** Binary payload built from the byte array. */
+        /**
+         * Binary payload built from the byte array.
+         */
         this.fileObject = Buffer.alloc(0);
         this.filename = filename;
         this.inputBytes = inputBytes;
     }
-    /** Converts bytes to a buffer and validates MIME type. */
+    /**
+     * Converts bytes to a buffer and validates MIME type.
+     */
     async init() {
         if (this.initialized) {
             return;

package/src/input/inputSource.d.ts

@@ -1,3 +1,4 @@
+import { Buffer } from "node:buffer";
 /**
  * @param {string} inputType - the type of input used in file ("base64", "path", "dummy").
  *                             NB: dummy is only used for tests purposes
@@ -22,9 +23,10 @@ export declare abstract class InputSource {
      * Whether the input source has been initialized.
      * @protected
      */
-    /** Whether the source has already been initialized. */
     protected initialized: boolean;
-    /** Initializes the input source and populates its file object. */
+    /**
+     * Initializes the input source and populates its file object.
+     */
     init(): Promise<void>;
     /**
      * Returns whether the input source has been initialized.

package/src/input/inputSource.js

@@ -17,10 +17,11 @@ export class InputSource {
          * Whether the input source has been initialized.
          * @protected
          */
-        /** Whether the source has already been initialized. */
         this.initialized = false;
     }
-    /** Initializes the input source and populates its file object. */
+    /**
+     * Initializes the input source and populates its file object.
+     */
     async init() {
         throw new MindeeInputSourceError("not Implemented");
     }

package/src/input/localInputSource.d.ts

@@ -1,22 +1,35 @@
-import { PageOptions } from "../input/pageOptions.js";
+import { Buffer } from "node:buffer";
+import { PageOptions } from "./pageOptions.js";
 import { InputSource, InputConstructor } from "./inputSource.js";
 export declare const MIMETYPES: Map<string, string>;
 export declare abstract class LocalInputSource extends InputSource {
-    /** Type of local input source (path, stream, bytes, ...). */
+    /**
+     * Type of local input source (path, stream, bytes, ...).
+     */
     inputType: string;
-    /** Original filename associated with the input. */
+    /**
+     * Original filename associated with the input.
+     */
     filename: string;
-    /** Original filepath when available. */
+    /**
+     * Original filepath when available.
+     */
     filepath?: string;
-    /** MIME type detected for the source content. */
+    /**
+     * MIME type detected for the source content.
+     */
     mimeType: string;
-    /** Binary payload for local sources. */
+    /**
+     * Binary payload for local sources.
+     */
     fileObject: Buffer | string;
     /**
      * @param {InputConstructor} constructor Constructor parameters.
      */
     protected constructor({ inputType }: InputConstructor);
-    /** Detects and validates the MIME type from the current file object. */
+    /**
+     * Detects and validates the MIME type from the current file object.
+     */
     protected checkMimetype(): Promise<string>;
     /**
      * Returns the file object as a Buffer.

package/src/input/localInputSource.js

@@ -1,10 +1,11 @@
-import path from "path";
+import { Buffer } from "node:buffer";
+import path from "node:path";
+import { fileTypeFromBuffer } from "file-type";
 import { MindeeInputSourceError } from "../errors/index.js";
 import { errorHandler } from "../errors/handler.js";
 import { logger } from "../logger.js";
 import { compressImage } from "../image/index.js";
 import { compressPdf, countPages, extractPages, hasSourceText } from "../pdf/index.js";
-import { fileTypeFromBuffer } from "file-type";
 import { InputSource, INPUT_TYPE_STREAM, INPUT_TYPE_BASE64, INPUT_TYPE_BYTES, INPUT_TYPE_PATH, INPUT_TYPE_BUFFER } from "./inputSource.js";
 export const MIMETYPES = new Map([
     [".pdf", "application/pdf"],
@@ -29,9 +30,13 @@ export class LocalInputSource extends InputSource {
      */
     constructor({ inputType }) {
         super();
-        /** Original filename associated with the input. */
+        /**
+         * Original filename associated with the input.
+         */
         this.filename = "";
-        /** MIME type detected for the source content. */
+        /**
+         * MIME type detected for the source content.
+         */
         this.mimeType = "";
         // Check if inputType is valid
         if (!ALLOWED_INPUT_TYPES.includes(inputType)) {
@@ -41,7 +46,9 @@ export class LocalInputSource extends InputSource {
         this.inputType = inputType;
         logger.debug(`Initialized local input source of type: ${inputType}`);
     }
-    /** Detects and validates the MIME type from the current file object. */
+    /**
+     * Detects and validates the MIME type from the current file object.
+     */
     async checkMimetype() {
         if (!(this.fileObject instanceof Buffer)) {
             throw new MindeeInputSourceError(`MIME type cannot be verified on input source of type ${this.inputType}.`);

package/src/input/pageOptions.d.ts

@@ -10,7 +10,9 @@ export interface PageOptions {
      * [0, -1] represents the first and last pages of the document.
      */
     pageIndexes: number[];
-    /** Operation to apply on the document, given the `pageIndexes` specified. */
+    /**
+     * Operation to apply on the document, given the `pageIndexes` specified.
+     */
     operation: PageOptionsOperation;
     /**
      * Apply the operation only if the document has at least this many pages.
@@ -21,8 +23,12 @@ export interface PageOptions {
  * Operation to apply on the document, given the page indexes specified.
  */
 export declare enum PageOptionsOperation {
-    /** Only keep pages matching the provided indexes. */
+    /**
+     * Only keep pages matching the provided indexes.
+     */
     KeepOnly = "KEEP_ONLY",
-    /** Remove pages matching the provided indexes. */
+    /**
+     * Remove pages matching the provided indexes.
+     */
     Remove = "REMOVE"
 }

package/src/input/pageOptions.js

@@ -4,8 +4,12 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 export var PageOptionsOperation;
 (function (PageOptionsOperation) {
-    /** Only keep pages matching the provided indexes. */
+    /**
+     * Only keep pages matching the provided indexes.
+     */
     PageOptionsOperation["KeepOnly"] = "KEEP_ONLY";
-    /** Remove pages matching the provided indexes. */
+    /**
+     * Remove pages matching the provided indexes.
+     */
     PageOptionsOperation["Remove"] = "REMOVE";
 })(PageOptionsOperation || (PageOptionsOperation = {}));

package/src/input/pathInput.d.ts

@@ -2,14 +2,22 @@ import { LocalInputSource } from "./localInputSource.js";
 interface PathInputProps {
     inputPath: string;
 }
-/** Local input source that reads a file from disk by path. */
+/**
+ * Local input source that reads a file from disk by path.
+ */
 export declare class PathInput extends LocalInputSource {
-    /** Path used to read the local file. */
+    /**
+     * Path used to read the local file.
+     */
     readonly inputPath: string;
-    /** File content loaded from disk. */
+    /**
+     * File content loaded from disk.
+     */
     fileObject: Buffer;
     constructor({ inputPath }: PathInputProps);
-    /** Reads the file from disk and validates MIME type. */
+    /**
+     * Reads the file from disk and validates MIME type.
+     */
     init(): Promise<void>;
 }
 export {};

package/src/input/pathInput.js

@@ -1,20 +1,26 @@
+import path from "node:path";
+import { promises as fs } from "node:fs";
 import { INPUT_TYPE_PATH } from "./inputSource.js";
 import { LocalInputSource } from "./localInputSource.js";
-import path from "path";
 import { logger } from "../logger.js";
-import { promises as fs } from "fs";
-/** Local input source that reads a file from disk by path. */
+/**
+ * Local input source that reads a file from disk by path.
+ */
 export class PathInput extends LocalInputSource {
     constructor({ inputPath }) {
         super({
             inputType: INPUT_TYPE_PATH,
         });
-        /** File content loaded from disk. */
+        /**
+         * File content loaded from disk.
+         */
         this.fileObject = Buffer.alloc(0);
         this.inputPath = inputPath;
         this.filename = path.basename(this.inputPath);
     }
-    /** Reads the file from disk and validates MIME type. */
+    /**
+     * Reads the file from disk and validates MIME type.
+     */
     async init() {
         if (this.initialized) {
             return;

package/src/input/streamInput.d.ts

@@ -1,18 +1,27 @@
-import { Readable } from "stream";
+import { Buffer } from "node:buffer";
+import { Readable } from "node:stream";
 import { LocalInputSource } from "./localInputSource.js";
 interface StreamInputProps {
     inputStream: Readable;
     filename: string;
 }
-/** Local input source backed by a readable stream. */
+/**
+ * Local input source backed by a readable stream.
+ */
 export declare class StreamInput extends LocalInputSource {
     private readonly inputStream;
-    /** Buffered payload created from the stream. */
+    /**
+     * Buffered payload created from the stream.
+     */
     fileObject: Buffer;
     constructor({ inputStream, filename }: StreamInputProps);
-    /** Reads the stream to completion and validates MIME type. */
+    /**
+     * Reads the stream to completion and validates MIME type.
+     */
     init(): Promise<void>;
-    /** Converts a readable stream into a single buffer. */
+    /**
+     * Converts a readable stream into a single buffer.
+     */
     stream2buffer(stream: Readable, signal?: AbortSignal): Promise<Buffer>;
 }
 export {};

package/src/input/streamInput.js

@@ -1,19 +1,26 @@
+import { Buffer } from "node:buffer";
 import { LocalInputSource } from "./localInputSource.js";
 import { INPUT_TYPE_STREAM } from "./inputSource.js";
 import { logger } from "../logger.js";
 import { MindeeInputSourceError } from "../errors/index.js";
-/** Local input source backed by a readable stream. */
+/**
+ * Local input source backed by a readable stream.
+ */
 export class StreamInput extends LocalInputSource {
     constructor({ inputStream, filename }) {
         super({
             inputType: INPUT_TYPE_STREAM,
         });
-        /** Buffered payload created from the stream. */
+        /**
+         * Buffered payload created from the stream.
+         */
         this.fileObject = Buffer.alloc(0);
         this.filename = filename;
         this.inputStream = inputStream;
     }
-    /** Reads the stream to completion and validates MIME type. */
+    /**
+     * Reads the stream to completion and validates MIME type.
+     */
     async init() {
         if (this.initialized) {
             return;
@@ -23,7 +30,9 @@ export class StreamInput extends LocalInputSource {
         this.mimeType = await this.checkMimetype();
         this.initialized = true;
     }
-    /** Converts a readable stream into a single buffer. */
+    /**
+     * Converts a readable stream into a single buffer.
+     */
     async stream2buffer(stream, signal) {
         return new Promise((resolve, reject) => {
             if (stream.closed || stream.destroyed) {

package/src/input/urlInput.d.ts

@@ -1,24 +1,34 @@
-import { InputSource } from "./inputSource.js";
 import { Dispatcher } from "undici";
+import { InputSource } from "./inputSource.js";
 import { BytesInput } from "./bytesInput.js";
-/** Remote input source represented by a validated HTTPS URL. */
+/**
+ * Remote input source represented by a validated HTTPS URL.
+ */
 export declare class UrlInput extends InputSource {
-    /** HTTPS URL of the remote input file. */
+    /**
+     * HTTPS URL of the remote input file.
+     */
     readonly url: string;
-    /** Dispatcher used for HTTP requests. */
+    /**
+     * Dispatcher used for HTTP requests.
+     */
     readonly dispatcher: Dispatcher;
     constructor({ url, dispatcher }: {
         url: string;
         dispatcher?: Dispatcher;
     });
-    /** Initializes this source by validating and storing the URL. */
+    /**
+     * Initializes this source by validating and storing the URL.
+     */
     init(): Promise<void>;
     /**
      * Validates that a URL is safe to fetch: scheme must be https.
      */
     static validateUrl(url: string): void;
     private fetchFileContent;
-    /** Downloads the URL content and writes it to disk. */
+    /**
+     * Downloads the URL content and writes it to disk.
+     */
     saveToFile(options: {
         filepath: string;
         filename?: string;
@@ -28,7 +38,9 @@ export declare class UrlInput extends InputSource {
         headers?: Record<string, string>;
         maxRedirects?: number;
     }): Promise<string>;
-    /** Downloads the URL content and returns it as a local bytes source. */
+    /**
+     * Downloads the URL content and returns it as a local bytes source.
+     */
     asLocalInputSource(options?: {
         filename?: string;
         username?: string;