mindee 4.36.2 → 5.0.0-alpha1

package/src/input/urlInput.js

@@ -0,0 +1,95 @@
+import { InputSource } from "./inputSource.js";
+import { URL } from "url";
+import { basename, extname } from "path";
+import { randomBytes } from "crypto";
+import { writeFile } from "fs/promises";
+import { request, getGlobalDispatcher } from "undici";
+import { logger } from "../logger.js";
+import { MindeeInputSourceError } from "../errors/index.js";
+import { BytesInput } from "./bytesInput.js";
+export class UrlInput extends InputSource {
+    constructor({ url, dispatcher }) {
+        super();
+        this.url = url;
+        this.dispatcher = dispatcher ?? getGlobalDispatcher();
+        logger.debug("Initialized URL input source.");
+    }
+    async init() {
+        if (this.initialized) {
+            return;
+        }
+        logger.debug(`source URL: ${this.url}`);
+        if (!this.url.toLowerCase().startsWith("https")) {
+            throw new MindeeInputSourceError("URL must be HTTPS");
+        }
+        this.fileObject = this.url;
+        this.initialized = true;
+    }
+    async fetchFileContent(options) {
+        const { username, password, token, headers = {}, maxRedirects = 3 } = options;
+        if (token) {
+            headers["Authorization"] = `Bearer ${token}`;
+        }
+        const auth = username && password ? `${username}:${password}` : undefined;
+        return await this.makeRequest(this.url, auth, headers, 0, maxRedirects);
+    }
+    async saveToFile(options) {
+        const { filepath, filename, ...fetchOptions } = options;
+        const { content, finalUrl } = await this.fetchFileContent(fetchOptions);
+        const finalFilename = this.fillFilename(filename, finalUrl);
+        const fullPath = `${filepath}/${finalFilename}`;
+        await writeFile(fullPath, content);
+        return fullPath;
+    }
+    async asLocalInputSource(options = {}) {
+        const { filename, ...fetchOptions } = options;
+        const { content, finalUrl } = await this.fetchFileContent(fetchOptions);
+        const finalFilename = this.fillFilename(filename, finalUrl);
+        return new BytesInput({ inputBytes: content, filename: finalFilename });
+    }
+    static extractFilenameFromUrl(uri) {
+        return basename(new URL(uri).pathname || "");
+    }
+    static generateFileName(extension = ".tmp") {
+        const randomString = randomBytes(4).toString("hex");
+        const timestamp = new Date().toISOString().replace(/[-:]/g, "").split(".")[0];
+        return `mindee_temp_${timestamp}_${randomString}${extension}`;
+    }
+    static getFileExtension(filename) {
+        const ext = 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)) {
+            filename = UrlInput.generateFileName(UrlInput.getFileExtension(filename || "") || undefined);
+        }
+        return filename;
+    }
+    async makeRequest(url, auth, headers, redirects, maxRedirects) {
+        const parsedUrl = new URL(url);
+        const response = await request(parsedUrl, {
+            method: "GET",
+            headers: headers,
+            throwOnError: false,
+            dispatcher: this.dispatcher,
+        });
+        if (response.statusCode && response.statusCode >= 300 && response.statusCode < 400) {
+            logger.debug(`Redirecting to: ${response.headers.location}`);
+            if (redirects === maxRedirects) {
+                throw new MindeeInputSourceError(`Can't reach URL after ${redirects} out of ${maxRedirects} redirects, aborting operation.`);
+            }
+            if (response.headers.location) {
+                return await this.makeRequest(response.headers.location.toString(), auth, headers, redirects + 1, maxRedirects);
+            }
+            throw new MindeeInputSourceError("Redirect location not found");
+        }
+        if (!response.statusCode || response.statusCode >= 400 || response.statusCode < 200) {
+            throw new Error(`Couldn't retrieve file from server, error code ${response.statusCode}.`);
+        }
+        const arrayBuffer = await response.body.arrayBuffer();
+        return { content: Buffer.from(arrayBuffer), finalUrl: url };
+    }
+}

package/src/logger.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = exports.LOG_LEVELS = void 0;
-exports.LOG_LEVELS = {
+export const LOG_LEVELS = {
     debug: 0,
     info: 1,
     warn: 2,
@@ -10,26 +7,26 @@ exports.LOG_LEVELS = {
 class Logger {
     constructor(levelToSet = "warn") {
         this.levelToSet = levelToSet;
-        if (!(levelToSet in exports.LOG_LEVELS)) {
-            this.level = exports.LOG_LEVELS["debug"];
+        if (!(levelToSet in LOG_LEVELS)) {
+            this.level = LOG_LEVELS["debug"];
         }
-        this.level = exports.LOG_LEVELS[levelToSet];
+        this.level = LOG_LEVELS[levelToSet];
     }
     debug(...args) {
-        if (this.level <= exports.LOG_LEVELS["debug"])
+        if (this.level <= LOG_LEVELS["debug"])
             console.debug(args);
     }
     info(...args) {
-        if (this.level <= exports.LOG_LEVELS["info"])
+        if (this.level <= LOG_LEVELS["info"])
             console.info(args);
     }
     warn(...args) {
-        if (this.level <= exports.LOG_LEVELS["warn"])
+        if (this.level <= LOG_LEVELS["warn"])
             console.warn(args);
     }
     error(...args) {
-        if (this.level <= exports.LOG_LEVELS["error"])
+        if (this.level <= LOG_LEVELS["error"])
             console.error(args);
     }
 }
-exports.logger = new Logger();
+export const logger = new Logger();

package/src/parsing/dateParser.js

@@ -0,0 +1,9 @@
+export function parseDate(dateString) {
+    if (!dateString) {
+        return null;
+    }
+    if (!/Z$/.test(dateString) && !/[+-][0-9]{2}:[0-9]{2}$/.test(dateString)) {
+        dateString += "Z";
+    }
+    return new Date(dateString);
+}

package/src/parsing/index.d.ts

@@ -1,5 +1,2 @@
-export * as common from "./common";
-export * as custom from "./custom";
-export * as standard from "./standard";
-export * as generated from "./generated";
-export * as v2 from "./v2";
+export type { StringDict } from "./stringDict.js";
+export { parseDate } from "./dateParser.js";

package/src/parsing/index.js

@@ -1,41 +1 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.v2 = exports.generated = exports.standard = exports.custom = exports.common = void 0;
-exports.common = __importStar(require("./common"));
-exports.custom = __importStar(require("./custom"));
-exports.standard = __importStar(require("./standard"));
-exports.generated = __importStar(require("./generated"));
-exports.v2 = __importStar(require("./v2"));
+export { parseDate } from "./dateParser.js";

package/src/parsing/localResponseBase.d.ts

@@ -0,0 +1,34 @@
+import { StringDict } from "../parsing/stringDict.js";
+import { Buffer } from "buffer";
+/**
+ * Local response loaded from a file.
+ * Note: Has to be initialized through init() before use.
+ */
+export declare abstract class LocalResponseBase {
+    private file;
+    private readonly inputHandle;
+    protected initialized: boolean;
+    /**
+     * Creates an instance of LocalResponse.
+     */
+    constructor(inputFile: Buffer | string);
+    init(): Promise<void>;
+    /**
+     * Returns the dictionary representation of the file.
+     * @returns A JSON-like object.
+     */
+    asDict(): Promise<StringDict>;
+    /**
+     * Returns the HMAC signature of the local response from the secret key provided.
+     * @param secretKey - Secret key, either a string or a byte/byte array.
+     * @returns The HMAC signature of the local response.
+     */
+    getHmacSignature(secretKey: string | Buffer | Uint8Array): string;
+    /**
+     * Checks if the HMAC signature of the local response is valid.
+     * @param secretKey - Secret key, either a string or a byte/byte array.
+     * @param signature - The signature to be compared with.
+     * @returns True if the HMAC signature is valid.
+     */
+    isValidHmacSignature(secretKey: string | Buffer | Uint8Array, signature: string): boolean;
+}

package/src/parsing/localResponseBase.js

@@ -0,0 +1,91 @@
+import * as crypto from "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.
+ */
+export class LocalResponseBase {
+    /**
+     * Creates an instance of LocalResponse.
+     */
+    constructor(inputFile) {
+        this.initialized = false;
+        this.file = Buffer.alloc(0);
+        this.inputHandle = inputFile;
+    }
+    async init() {
+        /**
+         * @param inputFile - The input file, which can be a Buffer, string, or PathLike.
+         */
+        if (this.initialized) {
+            return;
+        }
+        if (Buffer.isBuffer(this.inputHandle)) {
+            this.file = this.inputHandle;
+        }
+        else if (typeof this.inputHandle === "string") {
+            let fileContents;
+            try {
+                await fs.access(this.inputHandle);
+                fileContents = await fs.readFile(this.inputHandle, { encoding: "utf-8" });
+            }
+            catch {
+                fileContents = this.inputHandle;
+            }
+            this.file = Buffer.from(fileContents.replace(/\r/g, "").replace(/\n/g, ""), "utf-8");
+        }
+        else {
+            throw new MindeeError("Incompatible type for input.");
+        }
+        this.initialized = true;
+    }
+    /**
+     * Returns the dictionary representation of the file.
+     * @returns A JSON-like object.
+     */
+    async asDict() {
+        if (!this.initialized) {
+            await this.init();
+        }
+        try {
+            const content = this.file.toString("utf-8");
+            return JSON.parse(content);
+        }
+        catch {
+            throw new MindeeError("File is not a valid dictionary.");
+        }
+    }
+    /**
+     * Returns the HMAC signature of the local response from the secret key provided.
+     * @param secretKey - Secret key, either a string or a byte/byte array.
+     * @returns The HMAC signature of the local response.
+     */
+    getHmacSignature(secretKey) {
+        if (!this.initialized) {
+            throw new Error("The `init()` method must be called before calling `getHmacSignature()`.");
+        }
+        const algorithm = "sha256";
+        try {
+            const hmac = crypto.createHmac(algorithm, secretKey);
+            hmac.update(this.file);
+            return hmac.digest("hex");
+        }
+        catch {
+            throw new MindeeError("Could not get HMAC signature from payload.");
+        }
+    }
+    /**
+     * Checks if the HMAC signature of the local response is valid.
+     * @param secretKey - Secret key, either a string or a byte/byte array.
+     * @param signature - The signature to be compared with.
+     * @returns True if the HMAC signature is valid.
+     */
+    isValidHmacSignature(secretKey, signature) {
+        if (!this.initialized) {
+            throw new Error("The `init()` method must be called before calling `isValidHmacSignature()`.");
+        }
+        return signature === this.getHmacSignature(secretKey);
+    }
+}

package/src/parsing/stringDict.js

@@ -0,0 +1 @@
+export {};

package/src/pdf/index.d.ts

@@ -1,3 +1,4 @@
-export { extractPages, countPages, SplitPdf } from "./pdfOperation";
-export { compressPdf } from "./pdfCompressor";
-export { hasSourceText } from "./pdfUtils";
+export { extractPages, countPages } from "./pdfOperation.js";
+export type { SplitPdf } from "./pdfOperation.js";
+export { compressPdf } from "./pdfCompressor.js";
+export { hasSourceText } from "./pdfUtils.js";

package/src/pdf/index.js

@@ -1,10 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasSourceText = exports.compressPdf = exports.countPages = exports.extractPages = void 0;
-var pdfOperation_1 = require("./pdfOperation");
-Object.defineProperty(exports, "extractPages", { enumerable: true, get: function () { return pdfOperation_1.extractPages; } });
-Object.defineProperty(exports, "countPages", { enumerable: true, get: function () { return pdfOperation_1.countPages; } });
-var pdfCompressor_1 = require("./pdfCompressor");
-Object.defineProperty(exports, "compressPdf", { enumerable: true, get: function () { return pdfCompressor_1.compressPdf; } });
-var pdfUtils_1 = require("./pdfUtils");
-Object.defineProperty(exports, "hasSourceText", { enumerable: true, get: function () { return pdfUtils_1.hasSourceText; } });
+export { extractPages, countPages } from "./pdfOperation.js";
+export { compressPdf } from "./pdfCompressor.js";
+export { hasSourceText } from "./pdfUtils.js";

package/src/pdf/pdfCompressor.js

@@ -1,49 +1,17 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
+import { logger } from "../logger.js";
+import tmp from "tmp";
+import { extractTextFromPdf, hasSourceText } from "./pdfUtils.js";
+import * as fs from "node:fs";
+import { compressImage } from "../image/index.js";
+import { loadOptionalDependency } from "../dependency/index.js";
+let pdfLib = null;
+async function getPdfLib() {
+    if (!pdfLib) {
+        const pdfLibImport = await loadOptionalDependency("@cantoo/pdf-lib", "Text Embedding");
+        pdfLib = pdfLibImport.default || pdfLibImport;
     }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compressPdf = compressPdf;
-const logger_1 = require("../logger");
-const tmp_1 = __importDefault(require("tmp"));
-const pdfUtils_1 = require("./pdfUtils");
-const fs = __importStar(require("node:fs"));
-const node_poppler_1 = require("node-poppler");
-const pdf_lib_1 = require("@cantoo/pdf-lib");
-const imageOperations_1 = require("../imageOperations");
+    return pdfLib;
+}
 /**
  * Compresses each page of a provided PDF buffer.
  * @param pdfData The input PDF as a Buffer.
@@ -52,29 +20,29 @@ const imageOperations_1 = require("../imageOperations");
  * @param disableSourceText If true, doesn't re-apply source text to the output PDF.
  * @returns A Promise resolving to the compressed PDF as a Buffer.
  */
-async function compressPdf(pdfData, imageQuality = 85, forceSourceTextCompression = false, disableSourceText = true) {
+export async function compressPdf(pdfData, imageQuality = 85, forceSourceTextCompression = false, disableSourceText = true) {
     handleCompressionWarnings(forceSourceTextCompression, disableSourceText);
-    if (await (0, pdfUtils_1.hasSourceText)(pdfData)) {
+    if (await hasSourceText(pdfData)) {
         if (forceSourceTextCompression) {
             if (!disableSourceText) {
-                logger_1.logger.warn("Re-writing PDF source-text is an EXPERIMENTAL feature.");
+                logger.warn("Re-writing PDF source-text is an EXPERIMENTAL feature.");
             }
             else {
-                logger_1.logger.warn("Source file contains text, but disable_source_text flag. " +
+                logger.warn("Source file contains text, but disable_source_text flag. " +
                     "is set to false. Resulting file will not contain any embedded text.");
             }
         }
         else {
-            logger_1.logger.warn("Found text inside of the provided PDF file. Compression operation aborted since disableSourceText "
+            logger.warn("Found text inside of the provided PDF file. Compression operation aborted since disableSourceText "
                 + "is set to 'true'.");
             return pdfData;
         }
     }
-    const extractedText = disableSourceText ? await (0, pdfUtils_1.extractTextFromPdf)(pdfData) : null;
-    const extractedPdfInfo = await (0, pdfUtils_1.extractTextFromPdf)(pdfData);
+    const extractedText = disableSourceText ? await extractTextFromPdf(pdfData) : null;
+    const extractedPdfInfo = await extractTextFromPdf(pdfData);
     const compressedPages = await compressPdfPages(pdfData, extractedPdfInfo, imageQuality, disableSourceText, extractedText);
     if (!compressedPages) {
-        logger_1.logger.warn("Could not compress PDF to a smaller size. Returning original PDF.");
+        logger.warn("Could not compress PDF to a smaller size. Returning original PDF.");
         return pdfData;
     }
     return createNewPdfFromCompressedPages(compressedPages);
@@ -87,10 +55,10 @@ async function compressPdf(pdfData, imageQuality = 85, forceSourceTextCompressio
 function handleCompressionWarnings(forceSourceTextCompression, disableSourceText) {
     if (forceSourceTextCompression) {
         if (!disableSourceText) {
-            logger_1.logger.warn("Re-writing PDF source-text is an EXPERIMENTAL feature.");
+            logger.warn("Re-writing PDF source-text is an EXPERIMENTAL feature.");
         }
         else {
-            logger_1.logger.warn("Source file contains text, but the disable_source_text is set to false. "
+            logger.warn("Source file contains text, but the disable_source_text is set to false. "
                 + "Resulting file will not contain any embedded text.");
         }
     }
@@ -128,7 +96,8 @@ async function compressPdfPages(pdfData, extractedPdfInfo, imageQuality, disable
  * @returns A Promise resolving to an array of compressed page buffers.
  */
 async function compressPagesWithQuality(pdfData, extractedPdfInfo, imageQuality, disableSourceText, extractedText) {
-    const pdfDoc = await pdf_lib_1.PDFDocument.load(pdfData, {
+    const pdfLib = await getPdfLib();
+    const pdfDoc = await pdfLib.PDFDocument.load(pdfData, {
         ignoreEncryption: true,
         password: ""
     });
@@ -136,7 +105,7 @@ async function compressPagesWithQuality(pdfData, extractedPdfInfo, imageQuality,
     for (let i = 0; i < extractedPdfInfo.pages.length; i++) {
         const page = pdfDoc.getPages()[i];
         const rasterizedPage = await rasterizePage(pdfData, i + 1, imageQuality);
-        const compressedImage = await (0, imageOperations_1.compressImage)(Buffer.from(rasterizedPage, "binary"), imageQuality);
+        const compressedImage = await compressImage(Buffer.from(rasterizedPage, "binary"), imageQuality);
         if (!disableSourceText) {
             await addTextToPdfPage(page, extractedText);
         }
@@ -173,7 +142,8 @@ function isCompressionSuccessful(totalCompressedSize, originalSize, imageQuality
  * @returns A Promise resolving to the new PDF as a Buffer.
  */
 async function createNewPdfFromCompressedPages(compressedPages) {
-    const newPdfDoc = await pdf_lib_1.PDFDocument.create();
+    const pdfLib = await getPdfLib();
+    const newPdfDoc = await pdfLib.PDFDocument.create();
     for (const compressedPage of compressedPages) {
         const image = await newPdfDoc.embedJpg(compressedPage);
         const newPage = newPdfDoc.addPage([image.width, image.height]);
@@ -191,26 +161,29 @@ async function addTextToPdfPage(page, textInfo) {
     if (textInfo === null) {
         return;
     }
+    const pdfLib = await getPdfLib();
     for (const textPages of textInfo.pages) {
         for (const textPage of textPages.content) {
             page.drawText(textPage.str, {
                 x: textPage.x,
                 y: textPage.y,
                 size: textPage.height,
-                color: (0, pdf_lib_1.rgb)(0, 0, 0),
+                color: pdfLib.rgb(0, 0, 0),
                 font: await getFontFromName(textPage.fontName)
             });
         }
     }
 }
 async function getFontFromName(fontName) {
-    const pdfDoc = await pdf_lib_1.PDFDocument.create();
+    const pdfLib = await getPdfLib();
+    const pdfDoc = await pdfLib.PDFDocument.create();
     let font;
-    if (Object.values(pdf_lib_1.StandardFonts).map(value => value.toString()).includes(fontName)) {
+    const standardFontValues = Object.values(pdfLib.StandardFonts);
+    if (standardFontValues.includes(fontName)) {
         font = await pdfDoc.embedFont(fontName);
     }
     else {
-        font = await pdfDoc.embedFont(pdf_lib_1.StandardFonts.Helvetica);
+        font = await pdfDoc.embedFont(pdfLib.StandardFonts.Helvetica);
     }
     return font;
 }
@@ -222,8 +195,10 @@ async function getFontFromName(fontName) {
  * @param quality Quality to apply during rasterization.
  */
 async function rasterizePage(pdfData, index, quality = 85) {
-    const poppler = new node_poppler_1.Poppler();
-    const tmpPdf = tmp_1.default.fileSync();
+    const popplerImport = await loadOptionalDependency("node-poppler", "Image Processing");
+    const poppler = popplerImport.default || popplerImport;
+    const popplerInstance = new poppler.Poppler();
+    const tmpPdf = tmp.fileSync();
     const tempPdfPath = tmpPdf.name;
     const antialiasOption = "best";
     try {
@@ -236,12 +211,12 @@ async function rasterizePage(pdfData, index, quality = 85) {
             jpegOptions: `quality=${quality}`,
             singleFile: true
         };
-        const jpegBuffer = await poppler.pdfToCairo(tempPdfPath, undefined, options);
+        const jpegBuffer = await popplerInstance.pdfToCairo(tempPdfPath, undefined, options);
         await fs.promises.unlink(tempPdfPath);
         return jpegBuffer;
     }
     catch (error) {
-        logger_1.logger.error("Error rasterizing PDF:", error);
+        logger.error("Error rasterizing PDF:", error);
         throw error;
     }
     finally {

package/src/pdf/pdfOperation.d.ts

@@ -1,17 +1,17 @@
-import { PageOptions } from "../input";
+import { PageOptions } from "../input/pageOptions.js";
 export interface SplitPdf {
     file: Buffer;
     totalPagesRemoved: number;
 }
 /**
- * Cut pages from a pdf file. If pages index are out of bound, it will throw an error.
+ * Cut pages from a PDF file. If pages indexes are out of bounds, it will throw an error.
  * @param file
  * @param pageOptions
- * @returns the new cut pdf file.
+ * @returns the new cut PDF file.
  */
 export declare function extractPages(file: Buffer, pageOptions: PageOptions): Promise<SplitPdf>;
 /**
- * Count the number of pages in a pdf file.
+ * Count the number of pages in a PDF file.
  * @param file
  * @returns the number of pages in the file.
  */