mindee 5.9.0 → 5.10.0

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 { 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;

package/src/input/urlInput.js

@@ -1,14 +1,16 @@
-import { InputSource } from "./inputSource.js";
-import { URL } from "url";
-import { basename, extname } from "path";
-import { randomBytes } from "crypto";
-import { writeFile } from "fs/promises";
+import path from "node:path";
+import { randomBytes } from "node:crypto";
+import { writeFile } from "node:fs/promises";
 import { request } from "undici";
+import { URL } from "node:url";
+import { InputSource } from "./inputSource.js";
 import { logger } from "../logger.js";
 import { MindeeInputSourceError } from "../errors/index.js";
 import { resolveDefaultDispatcher } from "../http/dispatcher.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 class UrlInput extends InputSource {
     constructor({ url, dispatcher }) {
         super();
@@ -16,7 +18,9 @@ export class UrlInput extends InputSource {
         this.dispatcher = dispatcher ?? resolveDefaultDispatcher();
         logger.debug("Initialized URL input source.");
     }
-    /** Initializes this source by validating and storing the URL. */
+    /**
+     * Initializes this source by validating and storing the URL.
+     */
     async init() {
         if (this.initialized) {
             return;
@@ -52,7 +56,9 @@ export class UrlInput extends InputSource {
         }
         return await this.makeRequest(this.url, headers, 0, maxRedirects);
     }
-    /** Downloads the URL content and writes it to disk. */
+    /**
+     * Downloads the URL content and writes it to disk.
+     */
     async saveToFile(options) {
         const { filepath, filename, ...fetchOptions } = options;
         const { content, finalUrl } = await this.fetchFileContent(fetchOptions);
@@ -61,7 +67,9 @@ export class UrlInput extends InputSource {
         await writeFile(fullPath, content);
         return fullPath;
     }
-    /** Downloads the URL content and returns it as a local bytes source. */
+    /**
+     * Downloads the URL content and returns it as a local bytes source.
+     */
     async asLocalInputSource(options = {}) {
         const { filename, ...fetchOptions } = options;
         const { content, finalUrl } = await this.fetchFileContent(fetchOptions);
@@ -69,7 +77,7 @@ export class UrlInput extends InputSource {
         return new BytesInput({ inputBytes: content, filename: finalFilename });
     }
     static extractFilenameFromUrl(uri) {
-        return basename(new URL(uri).pathname || "");
+        return path.basename(new URL(uri).pathname || "");
     }
     static generateFileName(extension = ".tmp") {
         const randomString = randomBytes(4).toString("hex");
@@ -77,14 +85,14 @@ export class UrlInput extends InputSource {
         return `mindee_temp_${timestamp}_${randomString}${extension}`;
     }
     static getFileExtension(filename) {
-        const ext = extname(filename);
+        const ext = path.extname(filename);
         return ext ? ext.toLowerCase() : null;
     }
     fillFilename(filename, finalUrl) {
         if (!filename) {
             filename = finalUrl ? UrlInput.extractFilenameFromUrl(finalUrl) : UrlInput.extractFilenameFromUrl(this.url);
         }
-        if (!filename || !extname(filename)) {
+        if (!filename || !path.extname(filename)) {
             filename = UrlInput.generateFileName(UrlInput.getFileExtension(filename || "") || undefined);
         }
         return filename;

package/src/parsing/baseLocalResponse.d.ts

@@ -1,5 +1,5 @@
+import { Buffer } from "node:buffer";
 import { StringDict } from "./stringDict.js";
-import { Buffer } from "buffer";
 /**
  * Local response loaded from a file.
  * Note: Has to be initialized through init() before use.
@@ -7,13 +7,17 @@ import { Buffer } from "buffer";
 export declare abstract class BaseLocalResponse {
     private fileBytes;
     private readonly inputHandle;
-    /** Whether the local response payload has been loaded. */
+    /**
+     * Whether the local response payload has been loaded.
+     */
     protected initialized: boolean;
     /**
      * Creates an instance of LocalResponse.
      */
     constructor(inputFile: Buffer | string);
-    /** Loads the local payload from a string, buffer, or file path. */
+    /**
+     * Loads the local payload from a string, buffer, or file path.
+     */
     init(): Promise<void>;
     /**
      * Returns the dictionary representation of the file.

package/src/parsing/baseLocalResponse.js

@@ -1,7 +1,7 @@
-import * as crypto from "crypto";
+import { Buffer } from "node:buffer";
+import * as crypto from "node:crypto";
 import * as fs from "node:fs/promises";
 import { MindeeError } from "../errors/index.js";
-import { Buffer } from "buffer";
 /**
  * Local response loaded from a file.
  * Note: Has to be initialized through init() before use.
@@ -11,18 +11,22 @@ export class BaseLocalResponse {
      * Creates an instance of LocalResponse.
      */
     constructor(inputFile) {
-        /** Whether the local response payload has been loaded. */
+        /**
+         * Whether the local response payload has been loaded.
+         */
         this.initialized = false;
         if (inputFile === undefined || inputFile === null) {
             throw new TypeError("input cannot be null or undefined");
         }
-        if (typeof inputFile === "string" ? !inputFile.trim() : !inputFile.length) {
+        if (typeof inputFile === "string" ? !inputFile.trim() : inputFile.length === 0) {
             throw new TypeError("input cannot be empty");
         }
         this.fileBytes = Buffer.alloc(0);
         this.inputHandle = inputFile;
     }
-    /** Loads the local payload from a string, buffer, or file path. */
+    /**
+     * Loads the local payload from a string, buffer, or file path.
+     */
     async init() {
         /**
          * @param inputFile - The input file, which can be a Buffer, string, or PathLike.
@@ -37,12 +41,12 @@ export class BaseLocalResponse {
             let fileContents;
             try {
                 await fs.access(this.inputHandle);
-                fileContents = await fs.readFile(this.inputHandle, { encoding: "utf-8" });
+                fileContents = await fs.readFile(this.inputHandle, { encoding: "utf8" });
             }
             catch {
                 fileContents = this.inputHandle;
             }
-            this.fileBytes = Buffer.from(fileContents.replace(/\r/g, "").replace(/\n/g, ""), "utf-8");
+            this.fileBytes = Buffer.from(fileContents.replace(/\r/g, "").replace(/\n/g, ""), "utf8");
         }
         else {
             throw new MindeeError("Incompatible type for input.");
@@ -58,7 +62,7 @@ export class BaseLocalResponse {
             await this.init();
         }
         try {
-            const content = this.fileBytes.toString("utf-8");
+            const content = this.fileBytes.toString("utf8");
             return JSON.parse(content);
         }
         catch {
@@ -102,8 +106,8 @@ export class BaseLocalResponse {
         if (!expectedSignature?.trim()) {
             return false;
         }
-        const expectedBytes = Buffer.from(expectedSignature, "utf-8");
-        const actualBytes = Buffer.from(signature.toLowerCase(), "utf-8");
+        const expectedBytes = Buffer.from(expectedSignature, "utf8");
+        const actualBytes = Buffer.from(signature.toLowerCase(), "utf8");
         if (expectedBytes.length !== actualBytes.length) {
             return false;
         }
@@ -113,6 +117,6 @@ export class BaseLocalResponse {
      * Print the file as a UTF-8 string.
      */
     toString() {
-        return this.fileBytes.toString("utf-8");
+        return this.fileBytes.toString("utf8");
     }
 }

package/src/parsing/stringDict.d.ts

@@ -1,4 +1,6 @@
-/** Generic string-keyed dictionary used for raw API payloads. */
+/**
+ * Generic string-keyed dictionary used for raw API payloads.
+ */
 export type StringDict = {
     [index: string]: any;
 };

package/src/pdf/extractedPdf.d.ts

@@ -1,14 +1,24 @@
-import { BufferInput } from "../input/index.js";
 import { Buffer } from "node:buffer";
-/** Represents a PDF artifact produced by an extraction/splitting operation. */
+import { BufferInput } from "../input/index.js";
+/**
+ * Represents a PDF artifact produced by an extraction/splitting operation.
+ */
 export declare class ExtractedPdf {
-    /** Raw bytes of the extracted PDF segment. */
+    /**
+     * Raw bytes of the extracted PDF segment.
+     */
     readonly buffer: Buffer;
-    /** Filename suggested for export. */
+    /**
+     * Filename suggested for export.
+     */
     readonly filename: string;
-    /** Number of pages in this extracted PDF. */
+    /**
+     * Number of pages in this extracted PDF.
+     */
     readonly pageCount: number;
-    /** Zero-based indexes of pages included in this extracted PDF. */
+    /**
+     * Zero-based indexes of pages included in this extracted PDF.
+     */
     readonly pageIndexes: number[];
     constructor(pdfData: Buffer<ArrayBufferLike>, filename: string, pageIndexes: number[]);
     /**

package/src/pdf/extractedPdf.js

@@ -1,10 +1,12 @@
 import path from "node:path";
+import { writeFileSync } from "node:fs";
+import { writeFile } from "node:fs/promises";
 import { BufferInput, MIMETYPES } from "../input/index.js";
 import { MindeeError } from "../errors/index.js";
-import { writeFile } from "fs/promises";
 import { logger } from "../logger.js";
-import { writeFileSync } from "node:fs";
-/** Represents a PDF artifact produced by an extraction/splitting operation. */
+/**
+ * Represents a PDF artifact produced by an extraction/splitting operation.
+ */
 export class ExtractedPdf {
     constructor(pdfData, filename, pageIndexes) {
         this.buffer = pdfData;

package/src/pdf/extractedPdfs.d.ts

@@ -1,5 +1,7 @@
 import { ExtractedPdf } from "./extractedPdf.js";
-/** Collection of extracted PDF artifacts. */
+/**
+ * Collection of extracted PDF artifacts.
+ */
 export declare class ExtractedPdfs extends Array<ExtractedPdf> {
     constructor(...items: ExtractedPdf[]);
 }

package/src/pdf/extractedPdfs.js

@@ -1,4 +1,6 @@
-/** Collection of extracted PDF artifacts. */
+/**
+ * Collection of extracted PDF artifacts.
+ */
 export class ExtractedPdfs extends Array {
     constructor(...items) {
         super(...items);