@ironsoftware/ironpdf 2024.2.1 → 2024.4.2

package/src/public/pdfDocument.js

@@ -1,27 +1,4 @@
 "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 (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -38,36 +15,742 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PdfDocument = void 0;
 const buffer_1 = require("buffer");
 const types_1 = require("./types");
-const fs = __importStar(require("fs"));
+const typeSchema_1 = require("../internal/zod/typeSchema");
+const zod_1 = require("zod");
+const securitySchema_1 = require("../internal/zod/securitySchema");
+const pdfDocumentSchema_1 = require("../internal/zod/pdfDocumentSchema");
+const stampSchema_1 = require("../internal/zod/stampSchema");
+const affixSchema_1 = require("../internal/zod/affixSchema");
+const signatureSchema_1 = require("../internal/zod/signatureSchema");
+const imageSchema_1 = require("../internal/zod/imageSchema");
+const paperSchema_1 = require("../internal/zod/paperSchema");
+const pageSchema_1 = require("../internal/zod/pageSchema");
+const renderSchema_1 = require("../internal/zod/renderSchema");
 const util_1 = require("../internal/grpc_layer/util");
-const io_1 = require("../internal/grpc_layer/pdfium/io");
+const fs_1 = __importDefault(require("fs"));
 const render_1 = require("../internal/grpc_layer/chrome/render");
+const io_1 = require("../internal/grpc_layer/pdfium/io");
+const access_1 = require("../internal/access");
 const image_1 = require("../internal/grpc_layer/chrome/image");
+const compress_1 = require("../internal/grpc_layer/pdfium/compress");
+const page_1 = require("../internal/grpc_layer/pdfium/page");
 const image_2 = require("../internal/grpc_layer/pdfium/image");
 const jimp_1 = __importDefault(require("jimp"));
-const page_1 = require("../internal/grpc_layer/pdfium/page");
-const security_1 = require("../internal/grpc_layer/pdfium/security");
-const stamp_1 = require("../internal/grpc_layer/chrome/stamp");
+const text_1 = require("../internal/grpc_layer/pdfium/text");
 const pdfa_1 = require("../internal/grpc_layer/pdfium/pdfa");
-const compress_1 = require("../internal/grpc_layer/pdfium/compress");
+const metadata_1 = require("../internal/grpc_layer/pdfium/metadata");
 const signing_1 = require("../internal/grpc_layer/pdfium/signing");
 const headerFooter_1 = require("../internal/grpc_layer/pdfium/headerFooter");
+const stamp_1 = require("../internal/grpc_layer/chrome/stamp");
 const BackgroundForeground_1 = require("../internal/grpc_layer/pdfium/BackgroundForeground");
-const text_1 = require("../internal/grpc_layer/pdfium/text");
-const metadata_1 = require("../internal/grpc_layer/pdfium/metadata");
-const access_1 = require("../internal/access");
+const security_1 = require("../internal/grpc_layer/pdfium/security");
 /**
  * Represents a PDF document. Allows: loading, editing, manipulating, merging, signing printing and saving PDFs.
  *
  * @remark Make sure that you call {@link PdfDocument.close} or {@link cleanUp} to free the memory, when you stop using the PdfDocument object.
  */
 class PdfDocument {
+    //#region io
+    /**
+     * Open or Create a PdfDocument from a {@link PdfInput}
+     * @param pdfInput {@link PdfInput}
+     * @param options including {@link PdfPassword} {@link ChromePdfRenderOptions} {@link HttpLoginCredentials} mainHtmlFile
+     */
+    static open(pdfInput, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.pdfInputSchema, zod_1.z.object({
+                password: typeSchema_1.pdfPasswordSchema.optional(),
+                renderOptions: renderSchema_1.chromePdfRenderOptionsSchema.optional(),
+                httpLoginCredentials: renderSchema_1.httpLoginCredentialsSchema.optional(),
+                mainHtmlFile: typeSchema_1.stringSchema.optional(),
+                trackChanges: typeSchema_1.changeTrackingModesSchema.optional(),
+            }).optional())
+                .returns(zod_1.z.promise(pdfDocumentSchema_1.pdfDocumentSchema))
+                .implement(this.internal_open.bind(this))(pdfInput, options);
+        });
+    }
+    /**
+     * Open a PdfDocument from .pdf file
+     * @param pdfFilePath A path to .pdf file
+     * @param Optionally track changes to the document (for use with incremental saves)
+     */
+    static fromFile(pdfFilePath, trackChanges) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.pdfFilePathSchema, typeSchema_1.changeTrackingModesSchema.optional())
+                .returns(zod_1.z.promise(pdfDocumentSchema_1.pdfDocumentSchema))
+                .implement(this.internal_fromFile.bind(this))(pdfFilePath, trackChanges);
+        });
+    }
+    /**
+     * Create a PdfDocument from an Url
+     * @param url A website Url
+     * @param options including {@link ChromePdfRenderOptions}
+     */
+    static fromUrl(url, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.union([typeSchema_1.urlSchema, typeSchema_1.stringSchema]), zod_1.z.object({
+                renderOptions: renderSchema_1.chromePdfRenderOptionsSchema.optional(),
+            }).optional())
+                .returns(zod_1.z.promise(pdfDocumentSchema_1.pdfDocumentSchema))
+                .implement(this.internal_fromUrl.bind(this))(url, options);
+        });
+    }
+    /**
+     * Creates a PDF file from a local Zip file, and returns it as a {@link PdfDocument}.
+     * IronPDF is a W3C standards compliant HTML rendering based on Google's Chromium browser.
+     * If your output PDF does not look as expected:
+     *
+     * - Validate your HTML file using  https://validator.w3.org/ & CSS https://jigsaw.w3.org/css-validator/
+     *
+     * - To debug HTML, view the file in Chrome web browser's print preview which will work almost exactly as IronPDF.
+     *
+     * - Read our detailed documentation on pixel perfect HTML to PDF: https://ironpdf.com/tutorials/pixel-perfect-html-to-pdf/
+     *
+     * @param zipFilePath Path to a Zip to be rendered as a PDF.
+     * @param options including {@link ChromePdfRenderOptions} and `mainHtmlFile` a main .html file default: `index.html`
+     */
+    static fromZip(zipFilePath, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.stringSchema, zod_1.z.object({
+                renderOptions: renderSchema_1.chromePdfRenderOptionsSchema.optional(),
+                mainHtmlFile: typeSchema_1.stringSchema.optional()
+            }).optional())
+                .returns(zod_1.z.promise(pdfDocumentSchema_1.pdfDocumentSchema))
+                .implement(this.internal_fromZip.bind(this))(zipFilePath, options);
+        });
+    }
+    /**
+     * Creates a PDF file from a Html string, and returns it as an {@link PdfDocument} object which can be edited and saved to disk or served on a website.
+     * @param htmlStringOrHtmlFilePath The Html to be rendered as a PDF.
+     * @param options including {@link ChromePdfRenderOptions}
+     */
+    static fromHtml(htmlStringOrHtmlFilePath, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.stringSchema, zod_1.z.object({
+                renderOptions: renderSchema_1.chromePdfRenderOptionsSchema.optional(),
+            }).optional())
+                .returns(zod_1.z.promise(pdfDocumentSchema_1.pdfDocumentSchema))
+                .implement(this.internal_fromHtml.bind(this))(htmlStringOrHtmlFilePath, options);
+        });
+    }
+    /**
+     *  Converts multiple image files to a PDF document.  Each image creates 1 page which matches the image
+     *  dimensions. The default PaperSize is A4. You can set it via ImageToPdfConverter.PaperSize.
+     *  Note: Imaging.ImageBehavior.CropPage will set PaperSize equal to ImageSize.
+     * @param images The image file path name(s) or {@link ImageBuffer} object(s)
+     * @param options including {@link ImageToPdfOptions}
+     */
+    static fromImage(images, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.union([typeSchema_1.imageFilePathSchema, zod_1.z.array(typeSchema_1.imageFilePathSchema), typeSchema_1.imageBufferSchema, zod_1.z.array(typeSchema_1.imageBufferSchema)]), zod_1.z.object({
+                imageToPdfOptions: imageSchema_1.imageToPdfOptionsSchema.optional(),
+            }).optional())
+                .returns(zod_1.z.promise(pdfDocumentSchema_1.pdfDocumentSchema))
+                .implement(this.internal_fromImage.bind(this))(images, options);
+        });
+    }
+    /**
+     * Static method that joins (concatenates) multiple PDF documents together into one compiled PDF document.
+     * If the PDF contains form fields the form field in the resulting PDF's name will be appended with '_{index}' e.g. 'Name' will be 'Name_0'
+     * @param pdfs array of PDF
+     */
+    static mergePdf(pdfs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.array(typeSchema_1.pdfInputSchema))
+                .returns(zod_1.z.promise(pdfDocumentSchema_1.pdfDocumentSchema))
+                .implement(this.internal_mergePdf.bind(this))(pdfs);
+        });
+    }
+    /**
+     * Saves the PdfDocument to a file.
+     * @param filePath Target file path
+     * @param saveOptions see {@link SaveOptions}
+     */
+    saveAs(filePath, saveOptions) {
+        return zod_1.z.function()
+            .args(typeSchema_1.stringSchema, typeSchema_1.saveOptionsSchema.optional())
+            .returns(zod_1.z.promise(zod_1.z.void()))
+            .implement(this.internal_saveAs.bind(this))(filePath, saveOptions);
+    }
+    /**
+     * Saves the PdfDocument to a binary (Buffer)
+     * @param saveOptions see {@link SaveOptions}
+     */
+    saveAsBuffer(saveOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.saveOptionsSchema.optional())
+                .returns(zod_1.z.promise(typeSchema_1.bufferSchema))
+                .implement(this.internal_saveAsBuffer.bind(this))(saveOptions);
+        });
+    }
+    //#endregion
+    //#region compress
+    /**
+     * Compress existing PDF images using JPG encoding and the specified settings
+     * @param imageQuality Quality (1 - 100) to use during compression
+     * @param scaleToVisibleSize Scale down the image resolution according to its visible size in the PDF document
+     */
+    compressSize(imageQuality, scaleToVisibleSize = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield zod_1.z.function()
+                .args(typeSchema_1.numberSchema, typeSchema_1.booleanSchema.optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_compressSize.bind(this))(imageQuality, scaleToVisibleSize);
+        });
+    }
+    /**
+     *  Remove document struct tree information which describes the logical layout of the document.
+     *  Removing the "structure tree" can significantly reduce the disk space used by the document.
+     *  Removing the "structure tree" of a complicated document can negatively impact text selection.
+     */
+    compressStructTree() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_compressStructTree();
+        });
+    }
+    //#endregion
+    //#region page
+    /**
+     * Gets information of all pages in the PdfDocument
+     */
+    getPagesInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_getPagesInfo();
+        });
+    }
+    /**
+     * Gets the number of pages in the PdfDocument.
+     */
+    getPageCount() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_getPageCount();
+        });
+    }
+    /**
+     * Set the page orientation.
+     * @param pageRotation see {@link PageRotation}
+     * @param options including {@link PdfPageSelection}
+     */
+    setRotation(pageRotation, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(pageSchema_1.pageRotationSchema, zod_1.z.object({ pdfPageSelection: typeSchema_1.pdfPageSelectionSchema.optional() }).optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_setRotation.bind(this))(pageRotation, options);
+        });
+    }
+    /**
+     * Resize a page to the specified dimensions
+     * @param newSize {@link PdfPaperSize}
+     * @param options including {@link PdfPageSelection}
+     */
+    resize(newSize, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(paperSchema_1.pdfPaperSizeSchema, zod_1.z.object({ pdfPageSelection: typeSchema_1.pdfPageSelectionSchema.optional() }).optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_resize.bind(this))(newSize, options);
+        });
+    }
+    /**
+     * Adds another PDF to the beginning of the current PdfDocument
+     * If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'
+     * @param fromPdfDocument PdfDocument to prepend
+     */
+    prependAnotherPdf(fromPdfDocument) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(pdfDocumentSchema_1.pdfDocumentSchema)
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_prependAnotherPdf.bind(this))(fromPdfDocument);
+        });
+    }
+    /**
+     * Appends another PDF to the end of the current <see cref="PdfDocument"/>
+     * If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'
+     * @param fromPdfDocument PdfDocument to Append
+     */
+    appendAnotherPdf(fromPdfDocument) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(pdfDocumentSchema_1.pdfDocumentSchema)
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_appendAnotherPdf.bind(this))(fromPdfDocument);
+        });
+    }
+    /**
+     * Inserts another PDF into the current PdfDocument, starting at a given Page Index.
+     * If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'
+     * @param fromPdfDocument Another PdfDocument
+     * @param insertAtPageIndex Index at which to insert the new content.  Note: Page 1 has index 0...
+     */
+    insertPagesFromAnotherPdf(fromPdfDocument, insertAtPageIndex) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(pdfDocumentSchema_1.pdfDocumentSchema, typeSchema_1.numberSchema.describe("insertAtPageIndex: number"))
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_insertPagesFromAnotherPdf.bind(this))(fromPdfDocument, insertAtPageIndex);
+        });
+    }
+    /**
+     * Removes a range of pages from the PDF
+     * @param pages pages to remove
+     */
+    removePage(pages) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.pdfPageSelectionSchema)
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_removePage.bind(this))(pages);
+        });
+    }
+    /**
+     * Creates a new PDF by copying a range of pages from this {@link PdfDocument}.
+     * @param pages pages to copy (default "all")
+     */
+    duplicate(pages = "all") {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.pdfPageSelectionSchema)
+                .returns(zod_1.z.promise(pdfDocumentSchema_1.pdfDocumentSchema))
+                .implement(this.internal_duplicate.bind(this))(pages);
+        });
+    }
+    //#endregion
+    //#region image
+    /**
+     * Finds all embedded Images from within a specified pages in the PDF and returns them as Buffer
+     * @param options including {@link PdfPageSelection}
+     */
+    extractRawImages(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.object({ fromPages: typeSchema_1.pdfPageSelectionSchema.optional() }).optional())
+                .returns(zod_1.z.promise(typeSchema_1.bufferArraySchema))
+                .implement(this.internal_extractRawImages.bind(this))(options);
+        });
+    }
+    /**
+     * Renders the PDF and exports image Files in convenient formats. 1 image file is created for each
+     * page.
+     *
+     * @param options including {@link PdfPageSelection} {@link ImageType}
+     *
+     * @return array of images as Buffer[]
+     */
+    rasterizeToImageBuffers(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.object({
+                fromPages: typeSchema_1.pdfPageSelectionSchema.optional(),
+                imageType: imageSchema_1.imageTypeSchema.optional()
+            }).optional())
+                .returns(zod_1.z.promise(typeSchema_1.bufferArraySchema))
+                .implement(this.internal_rasterizeToImageBuffers.bind(this))(options);
+        });
+    }
+    /**
+     * Renders the PDF and exports image Files in convenient formats. 1 image file is created for each
+     * page. Running number will append output file path.
+     *
+     * @param filePath output file path.
+     * @param options including {@link PdfPageSelection} {@link ImageType}
+     *
+     * @return array of images file name as string[]
+     */
+    rasterizeToImageFiles(filePath, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.filePathSchema, zod_1.z.object({
+                fromPages: typeSchema_1.pdfPageSelectionSchema.optional(),
+                type: imageSchema_1.imageTypeSchema.optional()
+            }).optional())
+                .returns(zod_1.z.promise(typeSchema_1.stringArraySchema))
+                .implement(this.internal_rasterizeToImageFiles.bind(this))(filePath, options);
+        });
+    }
+    //#endregion
+    //#region text
+    /**
+     * Replace the specified old text with new text on a given page
+     * @param oldText Old text to remove
+     * @param newText New text to add
+     * @param onPages Page index to search for old text to replace (default "all")
+     */
+    replaceText(oldText, newText, onPages) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.string({ description: "oldText: string" }), zod_1.z.string({ description: "newText: string" }), typeSchema_1.pdfPageSelectionSchema.optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_replaceText.bind(this))(oldText, newText, onPages);
+        });
+    }
+    extractText(onPages) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.pdfPageSelectionSchema.optional())
+                .returns(zod_1.z.promise(zod_1.z.string()))
+                .implement(this.internal_extractText.bind(this))(onPages);
+        });
+    }
+    //#endregion
+    //#region pdfA
+    /**
+     * Convert the current document into the specified PDF-A standard format
+     * @param customICC (Optional) Custom color profile file path
+     */
+    convertToPdfA(customICC) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.string({ description: "customICC: string" }).optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_convertToPdfA.bind(this))(customICC);
+        });
+    }
+    /**
+     * Convert the current document into the specified PDF/UA standard format
+     */
+    convertToPdfUA() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_convertToPdfUA();
+        });
+    }
+    //#endregion
+    //#region metadata
+    /**
+     * Gets a Map<string, string> of metadata properties
+     */
+    getMetadata() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_getMetadata();
+        });
+    }
+    /**
+     * Add or Update a single metadata property
+     * @param key
+     * @param value
+     */
+    addOrUpdateMetadata(key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.string({ description: "key: string" }), zod_1.z.string({ description: "value: string" }))
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_addOrUpdateMetadata.bind(this))(key, value);
+        });
+    }
+    /**
+     * Remove a single metadata property
+     * @param key
+     */
+    removeMetadata(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.string({ description: "key: string" }))
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_removeMetadata.bind(this))(key);
+        });
+    }
+    /**
+     * Sets a whole metadata properties Map<string, string> (override all the metadata property)
+     * @param newMetadataDictionary new metadata properties Map<string, string>
+     */
+    overrideMetadata(newMetadataDictionary) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.mapStringSchema)
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_overrideMetadata.bind(this))(newMetadataDictionary);
+        });
+    }
+    //#endregion
+    //#region signing
+    /**
+     * Sign PDF with digital signature certificate.
+     * Note that the PDF will not be fully signed until Saved
+     * using {@link saveAs} or {@link saveAsBuffer}
+     *
+     * Multiple certificates may be used.
+     * @param signature see {@link DigitalSignature}
+     */
+    signDigitalSignature(signature) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(signatureSchema_1.digitalSignatureSchema)
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_signDigitalSignature.bind(this))(signature);
+        });
+    }
+    /**
+     * Check if PdfDocument was signed or not
+     */
+    isSigned() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_isSigned();
+        });
+    }
+    /**
+     * Count the number signature that signed to this PdfDocument
+     */
+    signatureCount() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_signatureCount();
+        });
+    }
+    //#endregion
+    //#region header/footer (affix)
+    /**
+     * Apply page header on top of an existing Pdf.
+     * @param header {@link TextAffix}
+     * @param toPages {@link PdfPageSelection}
+     */
+    addTextHeader(header, toPages) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(affixSchema_1.textAffixSchema, typeSchema_1.pdfPageSelectionSchema.optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_addTextHeader.bind(this))(header, toPages);
+        });
+    }
+    /**
+     * Apply page footer on top of an existing Pdf.
+     * @param footer {@link TextAffix}
+     * @param toPages {@link PdfPageSelection}
+     */
+    addTextFooter(footer, toPages) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(affixSchema_1.textAffixSchema, typeSchema_1.pdfPageSelectionSchema.optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_addTextFooter.bind(this))(footer, toPages);
+        });
+    }
+    /**
+     * Apply HTML header on top of an existing Pdf.
+     * @param header {@link HtmlAffix}
+     * @param toPages {@link PdfPageSelection}
+     */
+    addHtmlHeader(header, toPages) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(affixSchema_1.htmlAffixSchema, typeSchema_1.pdfPageSelectionSchema.optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_addHtmlHeader.bind(this))(header, toPages);
+        });
+    }
+    /**
+     * Apply HTML footer on top of an existing Pdf.
+     * @param footer {@link HtmlAffix}
+     * @param toPages {@link PdfPageSelection}
+     */
+    addHtmlFooter(footer, toPages) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(affixSchema_1.htmlAffixSchema, typeSchema_1.pdfPageSelectionSchema.optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_addHtmlFooter.bind(this))(footer, toPages);
+        });
+    }
+    //#endregion
+    //#region stamp
+    /**
+     * Edits the PDF by applying the HTML's rendered to only selected page(s).
+     * @param htmlStringOrHtmlFilePath
+     * @param options including {@link HtmlStampOptions} {@link PdfPageSelection}
+     */
+    stampHtml(htmlStringOrHtmlFilePath, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.union([typeSchema_1.htmlFilePathSchema, typeSchema_1.htmlStringSchema]), zod_1.z.object({
+                htmlStampOptions: stampSchema_1.htmlStampOptionsSchema.optional(),
+                toPages: typeSchema_1.pdfPageSelectionSchema.optional()
+            }).optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_stampHtml.bind(this))(htmlStringOrHtmlFilePath, options);
+        });
+    }
+    /**
+     * Edits the PDF by applying the image to only selected page(s).
+     * @param image image file path or image buffer
+     * @param options including {@link ImageStampOptions} {@link PdfPageSelection}
+     */
+    stampImage(image, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.union([typeSchema_1.imageFilePathSchema, typeSchema_1.imageBufferSchema]), zod_1.z.object({
+                imageStampOptions: stampSchema_1.imageStampOptionsSchema.optional(),
+                toPages: typeSchema_1.pdfPageSelectionSchema.optional()
+            }).optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_stampImage.bind(this))(image, options);
+        });
+    }
+    /**
+     * Edits the PDF by applying the text to only selected page(s).
+     * @param text text to stamp
+     * @param options including {@link TextStampOptions} {@link PdfPageSelection}
+     */
+    stampText(text, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.stringSchema, zod_1.z.object({
+                textStampOptions: stampSchema_1.textStampOptionsSchema.optional(),
+                toPages: typeSchema_1.pdfPageSelectionSchema.optional()
+            }).optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_stampText.bind(this))(text, options);
+        });
+    }
+    /**
+     * Edits the PDF by applying the barcode to only selected page(s).
+     * @param barcodeValue barcode
+     * @param options including {@link BarcodeType} {@link BarcodeStampOptions} {@link PdfPageSelection}
+     */
+    stampBarcode(barcodeValue, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(typeSchema_1.stringSchema, zod_1.z.object({
+                barcodeEncoding: typeSchema_1.barcodeTypeSchema,
+                barcodeStampOptions: stampSchema_1.barcodeStampOptionsSchema.optional(),
+                toPages: typeSchema_1.pdfPageSelectionSchema.optional()
+            }).optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_stampBarcode.bind(this))(barcodeValue, options);
+        });
+    }
+    //#endregion
+    //#region background/foreground
+    /**
+     * Adds a background to each page of this PDF. The background is copied from a first page in the
+     * backgroundPdf document.
+     *
+     * @param fromPdf background PDF document
+     * @param sourcePageIndex Index (zero-based page number) of the page to copy from the Background/Foreground PDF. Default is 0.
+     * @param applyToPages  PageSelection to which the background/foreground will be added. Default is "all"
+     */
+    addBackgroundFromAnotherPdf(fromPdf, sourcePageIndex = 0, applyToPages) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(pdfDocumentSchema_1.pdfDocumentSchema, typeSchema_1.numberSchema, typeSchema_1.pdfPageSelectionSchema.optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_addBackgroundFromAnotherPdf.bind(this))(fromPdf, sourcePageIndex, applyToPages);
+        });
+    }
+    /**
+     * Adds a foreground to each page of this PDF. The background is copied from a first page in the
+     * backgroundPdf document.
+     *
+     * @param fromPdf foreground PDF document
+     * @param sourcePageIndex Index (zero-based page number) of the page to copy from the Background/Foreground PDF. Default is 0.
+     * @param applyToPages  PageSelection to which the background/foreground will be added. Default is "all"
+     */
+    addForegroundFromAnotherPdf(fromPdf, sourcePageIndex = 0, applyToPages) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(pdfDocumentSchema_1.pdfDocumentSchema, typeSchema_1.numberSchema, typeSchema_1.pdfPageSelectionSchema.optional())
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_addForegroundFromAnotherPdf.bind(this))(fromPdf, sourcePageIndex, applyToPages);
+        });
+    }
+    //#endregion
+    //#region security
+    /**
+     * Removes all user and owner password security for a PDF document.  Also disables content
+     * encryption.
+     * If content is encrypted at 128 bit, copy and paste of content, annotations and form editing may be disabled.
+     */
+    removePasswordsAndEncryption() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_removePasswordsAndEncryption();
+        });
+    }
+    /**
+     * Sets the user password and enables 128Bit encryption of PDF content.
+     * A user password is a password that each user must enter to open or print the PDF document.
+     */
+    setUserPassword(userPassword) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.string({ description: "userPassword: string" }))
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_setUserPassword.bind(this))(userPassword);
+        });
+    }
+    /**
+     * Sets the owner password and enables 128Bit encryption of PDF content. An owner password is one used to
+     * enable and disable all other security settings. <para>OwnerPassword must be set to a non-empty string
+     * value for {@link PdfPermission.AllowAccessibilityExtractContent} ,  {@link PdfPermission.AllowAnnotations} ,
+     * {@link PdfPermission.AllowFillForms},  {@link PdfPermission.AllowPrint},  {@link PdfPermission.AllowModify} to be
+     * restricted.
+     */
+    setOwnerPassword(ownerPassword) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.string({ description: "ownerPassword: string" }))
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_setOwnerPassword.bind(this))(ownerPassword);
+        });
+    }
+    /**
+     * Sets the permissions of this PdfDocument
+     * @param permissions see {@link PdfPermission}
+     */
+    setPermission(permissions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(securitySchema_1.pdfPermissionSchema)
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_setPermission.bind(this))(permissions);
+        });
+    }
+    /**
+     * Gets the current permissions of this PdfDocument
+     * @return {@link PdfPermission}
+     */
+    getPermission() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_getPermission();
+        });
+    }
+    /**
+     * Makes this PDF document read only such that: Content is encrypted at 128 bit. Copy and paste of
+     * content is disallowed. Annotations and form editing are disabled.
+     * @param ownerPassword The owner password for the PDF. A string for owner password is required to enable PDF encryption and
+     * all document security options.
+     */
+    makePdfDocumentReadOnly(ownerPassword) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return zod_1.z.function()
+                .args(zod_1.z.string({ description: "ownerPassword: string" }))
+                .returns(zod_1.z.promise(zod_1.z.void()))
+                .implement(this.internal_makePdfDocumentReadOnly.bind(this))(ownerPassword);
+        });
+    }
+    //#endregion
+    //#region close
+    /**
+     * Dispose this PdfDocument object (clean up the resource)
+     * This is necessary to free the memory used by PdfDocument. See {@link cleanUp}
+     * Once this method was called this PdfDocument object no longer usable.
+     */
+    close() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_close();
+        });
+    }
     /**
      * Create a PdfDocument object from a {@link PdfInput}
-     * For more specific way to create/open PdfDocment see {@link fromUrl} {@link fromZip} {@link fromHtml} {@link fromImage}  {@link open}
+     * For more specific way to create/open PdfDocument see {@link fromUrl} {@link fromZip} {@link fromHtml} {@link fromImage}  {@link open}
      *
      * @param pdfInput see {@link PdfInput} (required)
-     * @param password a password to open the PDF required if PDF file was protected (pdfInput is {@link PdfFilePath} or {@link Buffer})
+     * @param password a password to open the PDF required if PDF file was private (pdfInput is {@link PdfFilePath} or {@link Buffer})
      * @param trackChanges Optionally track changes to the document (for use with incremental saves)
      */
     constructor(pdfInput, password, trackChanges) {
@@ -77,7 +760,7 @@ class PdfDocument {
             const input = (0, util_1.separatePdfInput)(pdfInput);
             switch (input.type) {
                 case "htmlFile":
-                    const htmlString = fs
+                    const htmlString = fs_1.default
                         .readFileSync(input.htmlFile)
                         .toString();
                     this.promiseDocumentId = (0, render_1.renderHtmlToPdf)(htmlString);
@@ -93,7 +776,7 @@ class PdfDocument {
                     break;
                 case "pdfFile":
                     this.pdfPassword = password;
-                    this.promiseDocumentId = (0, io_1.openPdfFileBuffer)(fs.readFileSync(input.pdfFile), password);
+                    this.promiseDocumentId = (0, io_1.openPdfFileBuffer)(fs_1.default.readFileSync(input.pdfFile), password);
                     break;
                 case "url":
                     this.promiseDocumentId = (0, render_1.renderUrlToPdf)(input.url);
@@ -115,22 +798,22 @@ class PdfDocument {
      * This is necessary to free the memory used by PdfDocument. See {@link cleanUp}
      * Once this method was called this PdfDocument object no longer usable.
      */
-    close() {
+    internal_close() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, io_1.disposePdf)(yield this.getId());
+            yield (0, io_1.disposePdf)(yield this.internal_getId());
         });
     }
     /**
      * @private
      */
-    getId() {
+    internal_getId() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.pdfDocumentId) {
-                return this.pdfDocumentId;
+                return Promise.resolve(this.pdfDocumentId);
             }
             else if (this.promiseDocumentId) {
                 this.pdfDocumentId = yield this.promiseDocumentId;
-                return this.pdfDocumentId;
+                return Promise.resolve(this.pdfDocumentId);
             }
             else {
                 throw new Error("Cannot Get PdfDocumentId");
@@ -143,14 +826,14 @@ class PdfDocument {
      * @param pdfInput {@link PdfInput}
      * @param options including {@link PdfPassword} {@link ChromePdfRenderOptions} {@link HttpLoginCredentials} mainHtmlFile
      */
-    static open(pdfInput, options) {
+    static internal_open(pdfInput, options) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
             if (pdfInput) {
                 const input = (0, util_1.separatePdfInput)(pdfInput);
                 switch (input.type) {
                     case "htmlFile":
-                        const htmlString = fs
+                        const htmlString = fs_1.default
                             .readFileSync(input.htmlFile)
                             .toString();
                         const newHtmlFilePdf = new PdfDocument();
@@ -174,7 +857,7 @@ class PdfDocument {
                         return newBufferPdf;
                     case "pdfFile":
                         const newPdfFilePdf = new PdfDocument(undefined, options === null || options === void 0 ? void 0 : options.password);
-                        newPdfFilePdf.pdfDocumentId = yield (0, io_1.openPdfFileBuffer)(fs.readFileSync(input.pdfFile), {
+                        newPdfFilePdf.pdfDocumentId = yield (0, io_1.openPdfFileBuffer)(fs_1.default.readFileSync(input.pdfFile), {
                             userPassword: (_c = options === null || options === void 0 ? void 0 : options.password) === null || _c === void 0 ? void 0 : _c.userPassword,
                             ownerPassword: (_d = options === null || options === void 0 ? void 0 : options.password) === null || _d === void 0 ? void 0 : _d.ownerPassword,
                             trackChanges: options === null || options === void 0 ? void 0 : options.trackChanges
@@ -199,9 +882,9 @@ class PdfDocument {
      * @param pdfFilePath A path to .pdf file
      * @param Optionally track changes to the document (for use with incremental saves)
      */
-    static fromFile(pdfFilePath, trackChanges) {
+    static internal_fromFile(pdfFilePath, trackChanges) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.open(pdfFilePath, { trackChanges: trackChanges });
+            return this.internal_open(pdfFilePath, { trackChanges: trackChanges });
         });
     }
     /**
@@ -209,9 +892,9 @@ class PdfDocument {
      * @param url A website Url
      * @param options including {@link ChromePdfRenderOptions}
      */
-    static fromUrl(url, options) {
+    static internal_fromUrl(url, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.open(url, options);
+            return this.internal_open(url, options);
         });
     }
     /**
@@ -228,9 +911,9 @@ class PdfDocument {
      * @param zipFilePath Path to a Zip to be rendered as a PDF.
      * @param options including {@link ChromePdfRenderOptions} and `mainHtmlFile` a main .html file default: `index.html`
      */
-    static fromZip(zipFilePath, options) {
+    static internal_fromZip(zipFilePath, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.open(zipFilePath, options);
+            return this.internal_open(zipFilePath, options);
         });
     }
     /**
@@ -238,9 +921,9 @@ class PdfDocument {
      * @param htmlStringOrHtmlFilePath The Html to be rendered as a PDF.
      * @param options including {@link ChromePdfRenderOptions}
      */
-    static fromHtml(htmlStringOrHtmlFilePath, options) {
+    static internal_fromHtml(htmlStringOrHtmlFilePath, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.open(htmlStringOrHtmlFilePath, options);
+            return this.internal_open(htmlStringOrHtmlFilePath, options);
         });
     }
     /**
@@ -250,7 +933,7 @@ class PdfDocument {
      * @param images The image file path name(s) or {@link ImageBuffer} object(s)
      * @param options including {@link ImageToPdfOptions}
      */
-    static fromImage(images, options) {
+    static internal_fromImage(images, options) {
         return __awaiter(this, void 0, void 0, function* () {
             let temp;
             if (Array.isArray(images)) {
@@ -292,9 +975,9 @@ class PdfDocument {
      * If the PDF contains form fields the form field in the resulting PDF's name will be appended with '_{index}' e.g. 'Name' will be 'Name_0'
      * @param pdfs array of PDF
      */
-    static mergePdf(pdfs) {
+    static internal_mergePdf(pdfs) {
         return __awaiter(this, void 0, void 0, function* () {
-            const ids = yield Promise.all(pdfs.map((x) => __awaiter(this, void 0, void 0, function* () { return (yield PdfDocument.open(x)).getId(); })));
+            const ids = yield Promise.all(pdfs.map((x) => __awaiter(this, void 0, void 0, function* () { return (yield PdfDocument.open(x)).internal_getId(); })));
             const newDocId = (0, render_1.mergePdfs)(ids);
             const newUrlPdf = new PdfDocument();
             newUrlPdf.pdfDocumentId = yield newDocId;
@@ -306,11 +989,13 @@ class PdfDocument {
      * @param filePath Target file path
      * @param saveOptions see {@link SaveOptions}
      */
-    saveAs(filePath, saveOptions) {
-        return this.saveAsBuffer(saveOptions).then((pdfFileBuffer) => {
-            fs.writeFile(filePath, pdfFileBuffer, "binary", (err) => {
-                if (err)
-                    throw err;
+    internal_saveAs(filePath, saveOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.internal_saveAsBuffer(saveOptions).then((pdfFileBuffer) => {
+                fs_1.default.writeFile(filePath, pdfFileBuffer, "binary", (err) => {
+                    if (err)
+                        throw err;
+                });
             });
         });
     }
@@ -318,9 +1003,9 @@ class PdfDocument {
      * Saves the PdfDocument to a binary (Buffer)
      * @param saveOptions see {@link SaveOptions}
      */
-    saveAsBuffer(saveOptions) {
+    internal_saveAsBuffer(saveOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, io_1.getBinaryData)(yield this.getId(), saveOptions);
+            return (0, io_1.getBinaryData)(yield this.internal_getId(), saveOptions);
         });
     }
     //#endregion
@@ -330,11 +1015,11 @@ class PdfDocument {
      * @param imageQuality Quality (1 - 100) to use during compression
      * @param scaleToVisibleSize Scale down the image resolution according to its visible size in the PDF document
      */
-    compressSize(imageQuality, scaleToVisibleSize = false) {
+    internal_compressSize(imageQuality, scaleToVisibleSize = false) {
         return __awaiter(this, void 0, void 0, function* () {
             if (imageQuality < 1 || imageQuality > 100)
                 throw new Error(`Invalid quality specifier (${imageQuality}) when compressing images. Quality must be between 1 and 100.`);
-            return yield (0, compress_1.compressImage)(yield this.getId(), imageQuality, scaleToVisibleSize);
+            return yield (0, compress_1.compressImage)(yield this.internal_getId(), imageQuality, scaleToVisibleSize);
         });
     }
     /**
@@ -342,9 +1027,9 @@ class PdfDocument {
      *  Removing the "structure tree" can significantly reduce the disk space used by the document.
      *  Removing the "structure tree" of a complicated document can negatively impact text selection.
      */
-    compressStructTree() {
+    internal_compressStructTree() {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, compress_1.compressStructTree)(yield this.getId());
+            return yield (0, compress_1.compressStructTree)(yield this.internal_getId());
         });
     }
     //#endregion
@@ -352,17 +1037,17 @@ class PdfDocument {
     /**
      * Gets information of all pages in the PdfDocument
      */
-    getPagesInfo() {
+    internal_getPagesInfo() {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, page_1.getPageInfo)(yield this.getId());
+            return yield (0, page_1.getPageInfo)(yield this.internal_getId());
         });
     }
     /**
      * Gets the number of pages in the PdfDocument.
      */
-    getPageCount() {
+    internal_getPageCount() {
         return __awaiter(this, void 0, void 0, function* () {
-            return (yield this.getPagesInfo()).length;
+            return (yield this.internal_getPagesInfo()).length;
         });
     }
     /**
@@ -370,9 +1055,9 @@ class PdfDocument {
      * @param pageRotation see {@link PageRotation}
      * @param options including {@link PdfPageSelection}
      */
-    setRotation(pageRotation, options) {
+    internal_setRotation(pageRotation, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, page_1.setPageRotation)(yield this.getId(), pageRotation, options);
+            return yield (0, page_1.setPageRotation)(yield this.internal_getId(), pageRotation, options);
         });
     }
     /**
@@ -380,9 +1065,9 @@ class PdfDocument {
      * @param newSize {@link PdfPaperSize}
      * @param options including {@link PdfPageSelection}
      */
-    resize(newSize, options) {
+    internal_resize(newSize, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, page_1.resizePage)(yield this.getId(), newSize, options);
+            return yield (0, page_1.resizePage)(yield this.internal_getId(), newSize, options);
         });
     }
     /**
@@ -390,9 +1075,9 @@ class PdfDocument {
      * If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'
      * @param fromPdfDocument PdfDocument to prepend
      */
-    prependAnotherPdf(fromPdfDocument) {
+    internal_prependAnotherPdf(fromPdfDocument) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.insertPagesFromAnotherPdf(fromPdfDocument, 0);
+            yield this.internal_insertPagesFromAnotherPdf(fromPdfDocument, 0);
         });
     }
     /**
@@ -400,9 +1085,9 @@ class PdfDocument {
      * If AnotherPdfFile contains form fields, those fields will be appended with '_' in the resulting PDF. e.g. 'Name' will be 'Name_'
      * @param fromPdfDocument PdfDocument to Append
      */
-    appendAnotherPdf(fromPdfDocument) {
+    internal_appendAnotherPdf(fromPdfDocument) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.insertPagesFromAnotherPdf(fromPdfDocument, (yield this.getPageCount()) - 1);
+            yield this.internal_insertPagesFromAnotherPdf(fromPdfDocument, (yield this.internal_getPageCount()) - 1);
         });
     }
     /**
@@ -411,28 +1096,28 @@ class PdfDocument {
      * @param fromPdfDocument Another PdfDocument
      * @param insertAtPageIndex Index at which to insert the new content.  Note: Page 1 has index 0...
      */
-    insertPagesFromAnotherPdf(fromPdfDocument, insertAtPageIndex) {
+    internal_insertPagesFromAnotherPdf(fromPdfDocument, insertAtPageIndex) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, page_1.insertPdf)(yield this.getId(), yield fromPdfDocument.getId(), insertAtPageIndex);
+            yield (0, page_1.insertPdf)(yield this.internal_getId(), yield fromPdfDocument.internal_getId(), insertAtPageIndex);
         });
     }
     /**
      * Removes a range of pages from the PDF
      * @param pages pages to remove
      */
-    removePage(pages) {
+    internal_removePage(pages) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, page_1.removePage)(yield this.getId(), { PdfPageSelection: pages });
+            yield (0, page_1.removePage)(yield this.internal_getId(), { PdfPageSelection: pages });
         });
     }
     /**
      * Creates a new PDF by copying a range of pages from this {@link PdfDocument}.
      * @param pages pages to copy (default "all")
      */
-    duplicate(pages = "all") {
+    internal_duplicate(pages = "all") {
         return __awaiter(this, void 0, void 0, function* () {
             const newPdf = new PdfDocument();
-            newPdf.pdfDocumentId = yield (0, page_1.duplicate)(yield this.getId(), {
+            newPdf.pdfDocumentId = yield (0, page_1.duplicate)(yield this.internal_getId(), {
                 PdfPageSelection: pages,
             });
             return newPdf;
@@ -444,10 +1129,10 @@ class PdfDocument {
      * Finds all embedded Images from within a specified pages in the PDF and returns them as Buffer
      * @param options including {@link PdfPageSelection}
      */
-    extractRawImages(options) {
+    internal_extractRawImages(options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, image_2.extractRawImages)(yield this.getId(), (_a = options === null || options === void 0 ? void 0 : options.fromPages) !== null && _a !== void 0 ? _a : "all");
+            return (0, image_2.extractRawImages)(yield this.internal_getId(), (_a = options === null || options === void 0 ? void 0 : options.fromPages) !== null && _a !== void 0 ? _a : "all");
         });
     }
     /**
@@ -458,10 +1143,10 @@ class PdfDocument {
      *
      * @return array of images as Buffer[]
      */
-    rasterizeToImageBuffers(options) {
+    internal_rasterizeToImageBuffers(options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const images = yield (0, image_2.rasterizeToImageBuffers)(yield this.getId(), (_a = options === null || options === void 0 ? void 0 : options.fromPages) !== null && _a !== void 0 ? _a : "all");
+            const images = yield (0, image_2.rasterizeToImageBuffers)(yield this.internal_getId(), (_a = options === null || options === void 0 ? void 0 : options.fromPages) !== null && _a !== void 0 ? _a : "all");
             const jimpImageType = (() => {
                 switch (options === null || options === void 0 ? void 0 : options.imageType) {
                     case types_1.ImageType.BMP:
@@ -490,10 +1175,10 @@ class PdfDocument {
      *
      * @return array of images file name as string[]
      */
-    rasterizeToImageFiles(filePath, options) {
+    internal_rasterizeToImageFiles(filePath, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const images = yield (0, image_2.rasterizeToImageBuffers)(yield this.getId(), (_a = options === null || options === void 0 ? void 0 : options.fromPages) !== null && _a !== void 0 ? _a : "all");
+            const images = yield (0, image_2.rasterizeToImageBuffers)(yield this.internal_getId(), (_a = options === null || options === void 0 ? void 0 : options.fromPages) !== null && _a !== void 0 ? _a : "all");
             const filesName = (0, util_1.getFileNames)(filePath, images.length, (0, util_1.getImageExtType)(options === null || options === void 0 ? void 0 : options.type), "image");
             const promises = images.map((imageBuffer, index) => __awaiter(this, void 0, void 0, function* () {
                 yield jimp_1.default.read(imageBuffer).then((value) => value.write(filesName[index]));
@@ -510,14 +1195,14 @@ class PdfDocument {
      * @param newText New text to add
      * @param onPages Page index to search for old text to replace (default "all")
      */
-    replaceText(oldText, newText, onPages) {
+    internal_replaceText(oldText, newText, onPages) {
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, text_1.replaceText)(yield this.getId(), oldText, newText, onPages);
+            return (0, text_1.replaceText)(yield this.internal_getId(), oldText, newText, onPages);
         });
     }
-    extractText(onPages) {
+    internal_extractText(onPages) {
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, text_1.extractAllText)(yield this.getId(), onPages);
+            return (0, text_1.extractAllText)(yield this.internal_getId(), onPages);
         });
     }
     //#endregion
@@ -526,17 +1211,17 @@ class PdfDocument {
      * Convert the current document into the specified PDF-A standard format
      * @param customICC (Optional) Custom color profile file path
      */
-    convertToPdfA(customICC) {
+    internal_convertToPdfA(customICC) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, pdfa_1.toPdfA)(yield this.getId(), customICC);
+            return yield (0, pdfa_1.toPdfA)(yield this.internal_getId(), customICC);
         });
     }
     /**
      * Convert the current document into the specified PDF/UA standard format
      */
-    convertToPdfUA() {
+    internal_convertToPdfUA() {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, pdfa_1.toPdfUA)(yield this.getId());
+            return yield (0, pdfa_1.toPdfUA)(yield this.internal_getId());
         });
     }
     //#endregion
@@ -544,9 +1229,9 @@ class PdfDocument {
     /**
      * Gets a Map<string, string> of metadata properties
      */
-    getMetadata() {
+    internal_getMetadata() {
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, metadata_1.getMetadataDict)(yield this.getId());
+            return (0, metadata_1.getMetadataDict)(yield this.internal_getId());
         });
     }
     /**
@@ -554,27 +1239,27 @@ class PdfDocument {
      * @param key
      * @param value
      */
-    addOrUpdateMetadata(key, value) {
+    internal_addOrUpdateMetadata(key, value) {
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, metadata_1.setMetadata)(yield this.getId(), key, value);
+            return (0, metadata_1.setMetadata)(yield this.internal_getId(), key, value);
         });
     }
     /**
      * Remove a single metadata property
      * @param key
      */
-    removeMetadata(key) {
+    internal_removeMetadata(key) {
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, metadata_1.removeMetadata)(yield this.getId(), key);
+            return (0, metadata_1.removeMetadata)(yield this.internal_getId(), key);
         });
     }
     /**
      * Sets a whole metadata properties Map<string, string> (override all the metadata property)
      * @param newMetadataDictionary new metadata properties Map<string, string>
      */
-    overrideMetadata(newMetadataDictionary) {
+    internal_overrideMetadata(newMetadataDictionary) {
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, metadata_1.setMetadataDict)(yield this.getId(), newMetadataDictionary);
+            return (0, metadata_1.setMetadataDict)(yield this.internal_getId(), newMetadataDictionary);
         });
     }
     //#endregion
@@ -587,26 +1272,26 @@ class PdfDocument {
      * Multiple certificates may be used.
      * @param signature see {@link DigitalSignature}
      */
-    signDigitalSignature(signature) {
+    internal_signDigitalSignature(signature) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, signing_1.signPdf)(yield this.getId(), signature);
+            return yield (0, signing_1.signPdf)(yield this.internal_getId(), signature);
         });
     }
     /**
      * Check if PdfDocument was signed or not
      */
-    isSigned() {
+    internal_isSigned() {
         return __awaiter(this, void 0, void 0, function* () {
-            const signatureCount = yield (0, signing_1.getSignatureCount)(yield this.getId());
+            const signatureCount = yield (0, signing_1.getSignatureCount)(yield this.internal_getId());
             return signatureCount > 0;
         });
     }
     /**
      * Count the number signature that signed to this PdfDocument
      */
-    signatureCount() {
+    internal_signatureCount() {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, signing_1.getSignatureCount)(yield this.getId());
+            return yield (0, signing_1.getSignatureCount)(yield this.internal_getId());
         });
     }
     //#endregion
@@ -616,9 +1301,9 @@ class PdfDocument {
      * @param header {@link TextAffix}
      * @param toPages {@link PdfPageSelection}
      */
-    addTextHeader(header, toPages) {
+    internal_addTextHeader(header, toPages) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, headerFooter_1.addTextAffix)(yield this.getId(), toPages, header, true);
+            yield (0, headerFooter_1.addTextAffix)(yield this.internal_getId(), toPages, header, true);
         });
     }
     /**
@@ -626,9 +1311,9 @@ class PdfDocument {
      * @param footer {@link TextAffix}
      * @param toPages {@link PdfPageSelection}
      */
-    addTextFooter(footer, toPages) {
+    internal_addTextFooter(footer, toPages) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, headerFooter_1.addTextAffix)(yield this.getId(), toPages, footer, false);
+            yield (0, headerFooter_1.addTextAffix)(yield this.internal_getId(), toPages, footer, false);
         });
     }
     /**
@@ -636,9 +1321,9 @@ class PdfDocument {
      * @param header {@link HtmlAffix}
      * @param toPages {@link PdfPageSelection}
      */
-    addHtmlHeader(header, toPages) {
+    internal_addHtmlHeader(header, toPages) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, headerFooter_1.addHtmlAffix)(yield this.getId(), toPages, header, true);
+            yield (0, headerFooter_1.addHtmlAffix)(yield this.internal_getId(), toPages, header, true);
         });
     }
     /**
@@ -646,9 +1331,9 @@ class PdfDocument {
      * @param footer {@link HtmlAffix}
      * @param toPages {@link PdfPageSelection}
      */
-    addHtmlFooter(footer, toPages) {
+    internal_addHtmlFooter(footer, toPages) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, headerFooter_1.addHtmlAffix)(yield this.getId(), toPages, footer, false);
+            yield (0, headerFooter_1.addHtmlAffix)(yield this.internal_getId(), toPages, footer, false);
         });
     }
     //#endregion
@@ -658,13 +1343,13 @@ class PdfDocument {
      * @param htmlStringOrHtmlFilePath
      * @param options including {@link HtmlStampOptions} {@link PdfPageSelection}
      */
-    stampHtml(htmlStringOrHtmlFilePath, options) {
+    internal_stampHtml(htmlStringOrHtmlFilePath, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const html = htmlStringOrHtmlFilePath.endsWith(".html") ||
                 htmlStringOrHtmlFilePath.endsWith(".htm")
-                ? fs.readFileSync(htmlStringOrHtmlFilePath).toString()
+                ? fs_1.default.readFileSync(htmlStringOrHtmlFilePath).toString()
                 : htmlStringOrHtmlFilePath;
-            yield (0, stamp_1.stampHtml)(yield this.getId(), html, {
+            yield (0, stamp_1.stampHtml)(yield this.internal_getId(), html, {
                 password: this.pdfPassword,
                 htmlStampOptions: options === null || options === void 0 ? void 0 : options.htmlStampOptions,
                 pageSelection: options === null || options === void 0 ? void 0 : options.toPages,
@@ -676,12 +1361,12 @@ class PdfDocument {
      * @param image image file path or image buffer
      * @param options including {@link ImageStampOptions} {@link PdfPageSelection}
      */
-    stampImage(image, options) {
+    internal_stampImage(image, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const imageBuffer = image instanceof buffer_1.Buffer ? image : fs.readFileSync(image);
-            yield (0, stamp_1.stampImage)(yield this.getId(), imageBuffer, {
+            const imageBuffer = image instanceof buffer_1.Buffer ? image : fs_1.default.readFileSync(image);
+            yield (0, stamp_1.stampImage)(yield this.internal_getId(), imageBuffer, {
                 password: this.pdfPassword,
-                options: options === null || options === void 0 ? void 0 : options.imageStampOptions,
+                imageStampOptions: options === null || options === void 0 ? void 0 : options.imageStampOptions,
                 pageSelection: options === null || options === void 0 ? void 0 : options.toPages,
             });
         });
@@ -691,11 +1376,11 @@ class PdfDocument {
      * @param text text to stamp
      * @param options including {@link TextStampOptions} {@link PdfPageSelection}
      */
-    stampText(text, options) {
+    internal_stampText(text, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, stamp_1.stampText)(yield this.getId(), text, {
+            yield (0, stamp_1.stampText)(yield this.internal_getId(), text, {
                 password: this.pdfPassword,
-                options: options === null || options === void 0 ? void 0 : options.textStampOptions,
+                textStampOptions: options === null || options === void 0 ? void 0 : options.textStampOptions,
                 pageSelection: options === null || options === void 0 ? void 0 : options.toPages,
             });
         });
@@ -705,11 +1390,11 @@ class PdfDocument {
      * @param barcodeValue barcode
      * @param options including {@link BarcodeType} {@link BarcodeStampOptions} {@link PdfPageSelection}
      */
-    stampBarcode(barcodeValue, options) {
+    internal_stampBarcode(barcodeValue, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, stamp_1.stampBarcode)(yield this.getId(), barcodeValue, {
+            yield (0, stamp_1.stampBarcode)(yield this.internal_getId(), barcodeValue, {
                 password: this.pdfPassword,
-                options: options === null || options === void 0 ? void 0 : options.barcodeStampOptions,
+                barcodeStampOptions: options === null || options === void 0 ? void 0 : options.barcodeStampOptions,
                 pageSelection: options === null || options === void 0 ? void 0 : options.toPages,
             });
         });
@@ -724,9 +1409,9 @@ class PdfDocument {
      * @param sourcePageIndex Index (zero-based page number) of the page to copy from the Background/Foreground PDF. Default is 0.
      * @param applyToPages  PageSelection to which the background/foreground will be added. Default is "all"
      */
-    addBackgroundFromAnotherPdf(fromPdf, sourcePageIndex = 0, applyToPages) {
+    internal_addBackgroundFromAnotherPdf(fromPdf, sourcePageIndex = 0, applyToPages) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, BackgroundForeground_1.addBackgroundForeground)(yield this.getId(), yield fromPdf.getId(), sourcePageIndex, true, applyToPages);
+            return yield (0, BackgroundForeground_1.addBackgroundForeground)(yield this.internal_getId(), yield fromPdf.internal_getId(), sourcePageIndex, true, applyToPages);
         });
     }
     /**
@@ -737,9 +1422,9 @@ class PdfDocument {
      * @param sourcePageIndex Index (zero-based page number) of the page to copy from the Background/Foreground PDF. Default is 0.
      * @param applyToPages  PageSelection to which the background/foreground will be added. Default is "all"
      */
-    addForegroundFromAnotherPdf(fromPdf, sourcePageIndex = 0, applyToPages) {
+    internal_addForegroundFromAnotherPdf(fromPdf, sourcePageIndex = 0, applyToPages) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, BackgroundForeground_1.addBackgroundForeground)(yield this.getId(), yield fromPdf.getId(), sourcePageIndex, false, applyToPages);
+            return yield (0, BackgroundForeground_1.addBackgroundForeground)(yield this.internal_getId(), yield fromPdf.internal_getId(), sourcePageIndex, false, applyToPages);
         });
     }
     //#endregion
@@ -749,22 +1434,22 @@ class PdfDocument {
      * encryption.
      * If content is encrypted at 128 bit, copy and paste of content, annotations and form editing may be disabled.
      */
-    removePasswordsAndEncryption() {
+    internal_removePasswordsAndEncryption() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield (0, security_1.removePasswordsAndEncryption)(yield this.getId());
+            yield (0, security_1.removePasswordsAndEncryption)(yield this.internal_getId());
         });
     }
     /**
      * Sets the user password and enables 128Bit encryption of PDF content.
      * A user password is a password that each user must enter to open or print the PDF document.
      */
-    setUserPassword(userPassword) {
+    internal_setUserPassword(userPassword) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.pdfPassword)
                 this.pdfPassword = { userPassword: userPassword };
             else
                 this.pdfPassword.userPassword = userPassword;
-            this.pdfDocumentId = yield (0, security_1.setUserPasswords)(yield this.getId(), userPassword);
+            this.pdfDocumentId = yield (0, security_1.setUserPasswords)(yield this.internal_getId(), userPassword);
         });
     }
     /**
@@ -774,31 +1459,31 @@ class PdfDocument {
      * {@link PdfPermission.AllowFillForms},  {@link PdfPermission.AllowPrint},  {@link PdfPermission.AllowModify} to be
      * restricted.
      */
-    setOwnerPassword(ownerPassword) {
+    internal_setOwnerPassword(ownerPassword) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.pdfPassword)
                 this.pdfPassword = { ownerPassword: ownerPassword };
             else
                 this.pdfPassword.ownerPassword = ownerPassword;
-            this.pdfDocumentId = yield (0, security_1.setOwnerPasswords)(yield this.getId(), ownerPassword);
+            this.pdfDocumentId = yield (0, security_1.setOwnerPasswords)(yield this.internal_getId(), ownerPassword);
         });
     }
     /**
      * Sets the permissions of this PdfDocument
      * @param permissions see {@link PdfPermission}
      */
-    setPermission(permissions) {
+    internal_setPermission(permissions) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.pdfDocumentId = yield (0, security_1.setSecurity)(yield this.getId(), permissions);
+            this.pdfDocumentId = yield (0, security_1.setSecurity)(yield this.internal_getId(), permissions);
         });
     }
     /**
      * Gets the current permissions of this PdfDocument
      * @return {@link PdfPermission}
      */
-    getPermission() {
+    internal_getPermission() {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, security_1.getPermission)(yield this.getId());
+            return yield (0, security_1.getPermission)(yield this.internal_getId());
         });
     }
     /**
@@ -807,10 +1492,10 @@ class PdfDocument {
      * @param ownerPassword The owner password for the PDF. A string for owner password is required to enable PDF encryption and
      * all document security options.
      */
-    makePdfDocumentReadOnly(ownerPassword) {
+    internal_makePdfDocumentReadOnly(ownerPassword) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.setOwnerPassword(ownerPassword);
-            yield this.setPermission({
+            yield this.internal_setOwnerPassword(ownerPassword);
+            yield this.internal_setPermission({
                 AllowExtractContent: false,
                 AllowAccessibilityExtractContent: false,
                 AllowAnnotations: false,