node-poppler 9.1.2 → 10.0.0

package/types/options/pdfattach.d.ts

@@ -0,0 +1,15 @@
+declare namespace _exports {
+    export { PdfAttachOptions };
+}
+declare const _exports: Record<keyof PdfAttachOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfAttachOptions = {
+    /**
+     * Print copyright and version info.
+     */
+    printVersionInfo?: boolean | undefined;
+    /**
+     * Replace embedded file with same name (if it exists).
+     */
+    replace?: boolean | undefined;
+};

package/types/options/pdfdetach.d.ts

@@ -0,0 +1,53 @@
+declare namespace _exports {
+    export { PdfDetachOptions };
+}
+declare const _exports: Record<keyof PdfDetachOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfDetachOptions = {
+    /**
+     * List all of the embedded files in the PDF file.
+     * File names are converted to the text encoding specified by `options.outputEncoding`.
+     */
+    listEmbedded?: boolean | undefined;
+    /**
+     * Sets the encoding to use for text output.
+     * This defaults to `UTF-8`.
+     */
+    outputEncoding?: string | undefined;
+    /**
+     * Owner password (for encrypted files).
+     */
+    ownerPassword?: string | undefined;
+    /**
+     * Set the file name used when saving an embedded file with
+     * the save option enabled, or the directory if `options.saveAllFiles` is used.
+     */
+    outputPath?: string | undefined;
+    /**
+     * Print copyright and version info.
+     */
+    printVersionInfo?: boolean | undefined;
+    /**
+     * Save all of the embedded files. This uses the file
+     * names associated with the embedded files (as printed by `options.listEmbedded`).
+     * By default, the files are saved in the current directory; this can be changed
+     * with `options.outputPath`.
+     */
+    saveAllFiles?: boolean | undefined;
+    /**
+     * Save the specified embedded file.
+     * By default, this uses the file name associated with the embedded file (as printed by
+     * `options.listEmbedded`); the file name can be changed with `options.outputPath`.
+     */
+    saveFile?: string | undefined;
+    /**
+     * Save the specified embedded file.
+     * By default, this uses the file name associated with the embedded file (as printed by
+     * `options.listEmbedded`); the file name can be changed with `options.outputPath`.
+     */
+    saveSpecificFile?: number | undefined;
+    /**
+     * User password (for encrypted files).
+     */
+    userPassword?: string | undefined;
+};

package/types/options/pdffonts.d.ts

@@ -0,0 +1,32 @@
+declare namespace _exports {
+    export { PdfFontsOptions };
+}
+declare const _exports: Record<keyof PdfFontsOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfFontsOptions = {
+    /**
+     * Specifies the first page to examine.
+     */
+    firstPageToExamine?: number | undefined;
+    /**
+     * Specifies the last page to examine.
+     */
+    lastPageToExamine?: number | undefined;
+    /**
+     * List the substitute fonts that Poppler
+     * will use for non-embedded fonts.
+     */
+    listSubstitutes?: boolean | undefined;
+    /**
+     * Owner password (for encrypted files).
+     */
+    ownerPassword?: string | undefined;
+    /**
+     * Print copyright and version info.
+     */
+    printVersionInfo?: boolean | undefined;
+    /**
+     * User password (for encrypted files).
+     */
+    userPassword?: string | undefined;
+};

package/types/options/pdfimages.d.ts

@@ -0,0 +1,74 @@
+declare namespace _exports {
+    export { PdfImagesOptions };
+}
+declare const _exports: Record<keyof PdfImagesOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfImagesOptions = {
+    /**
+     * Write JPEG, JPEG2000, JBIG2, and CCITT images in their native format.
+     * CMYK files are written as TIFF files. All other images are written as PNG files.
+     */
+    allFiles?: boolean | undefined;
+    /**
+     * Generate CCITT images as CCITT files.
+     */
+    ccittFile?: boolean | undefined;
+    /**
+     * Specifies the first page to convert.
+     */
+    firstPageToConvert?: number | undefined;
+    /**
+     * Specifies the last page to convert.
+     */
+    lastPageToConvert?: number | undefined;
+    /**
+     * Generate JBIG2 images as JBIG2 files.
+     */
+    jbig2File?: boolean | undefined;
+    /**
+     * Generate JPEG2000 images as JP2 files.
+     */
+    jpeg2000File?: boolean | undefined;
+    /**
+     * Generate JPEG images as JPEG files.
+     */
+    jpegFile?: boolean | undefined;
+    /**
+     * Instead of writing the images, list the
+     * images along with various information for each image.
+     * NOTE: Do not specify the `outputPrefix` with this option.
+     */
+    list?: boolean | undefined;
+    /**
+     * Include page numbers in output file names.
+     */
+    outputPageNumbers?: boolean | undefined;
+    /**
+     * Owner password (for encrypted files).
+     */
+    ownerPassword?: string | undefined;
+    /**
+     * Change the default output format to PNG.
+     */
+    pngFile?: boolean | undefined;
+    /**
+     * Print image filenames to stdout.
+     */
+    printFilenames?: boolean | undefined;
+    /**
+     * Print copyright and version info.
+     */
+    printVersionInfo?: boolean | undefined;
+    /**
+     * Do not print any messages or errors.
+     */
+    quiet?: boolean | undefined;
+    /**
+     * Change the default output format to TIFF.
+     */
+    tiffFile?: boolean | undefined;
+    /**
+     * Specify the user password for the PDF file.
+     */
+    userPassword?: string | undefined;
+};

package/types/options/pdfinfo.d.ts

@@ -0,0 +1,88 @@
+declare namespace _exports {
+    export { PdfInfoOptions };
+}
+declare const _exports: Record<keyof PdfInfoOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfInfoOptions = {
+    /**
+     * First page to print.
+     */
+    firstPageToConvert?: number | undefined;
+    /**
+     * Last page to print.
+     */
+    lastPageToConvert?: number | undefined;
+    /**
+     * List the available encodings.
+     */
+    listEncodingOptions?: boolean | undefined;
+    /**
+     * Sets the encoding to use for text output.
+     * This defaults to `'UTF-8'`.
+     */
+    outputEncoding?: string | undefined;
+    /**
+     * Owner password (for encrypted files).
+     */
+    ownerPassword?: string | undefined;
+    /**
+     * Print result as a JSON object.
+     */
+    printAsJson?: boolean | undefined;
+    /**
+     * Prints the page box bounding boxes:
+     * MediaBox, CropBox, BleedBox, TrimBox, and ArtBox.
+     */
+    printBoundingBoxes?: boolean | undefined;
+    /**
+     * Print both custom and standard metadata.
+     */
+    printCustomMetadata?: boolean | undefined;
+    /**
+     * Prints the logical document structure
+     * of a Tagged-PDF file.
+     */
+    printDocStruct?: boolean | undefined;
+    /**
+     * Print the textual content along with the
+     * document structure of a Tagged-PDF file. Note that extracting text this way might be slow
+     * for big PDF files.
+     */
+    printDocStructText?: boolean | undefined;
+    /**
+     * Prints dates in ISO-8601 format (including the time zone).
+     */
+    printIsoDates?: boolean | undefined;
+    /**
+     * Prints all JavaScript in the PDF file.
+     */
+    printJS?: boolean | undefined;
+    /**
+     * Prints document-level metadata. (This is the `Metadata`
+     * stream from the PDF file's Catalog object).
+     */
+    printMetadata?: boolean | undefined;
+    /**
+     * Print a list of all named destinations. If a page range
+     * is specified using the `options.firstPageToConvert` and `options.lastPageToConvert` options, only destinations
+     * in the page range are listed.
+     */
+    printNamedDests?: boolean | undefined;
+    /**
+     * Prints the raw (undecoded) date strings, directly from the PDF file.
+     */
+    printRawDates?: boolean | undefined;
+    /**
+     * Print all URLs in the PDF; only URLs referenced by PDF objects
+     * such as Link Annotations are listed, not URL strings in the text content.
+     */
+    printUrls?: boolean | undefined;
+    /**
+     * Print copyright and version info.
+     */
+    printVersionInfo?: boolean | undefined;
+    /**
+     * User password (for encrypted files).
+     */
+    userPassword?: string | undefined;
+};

package/types/options/pdfseparate.d.ts

@@ -0,0 +1,21 @@
+declare namespace _exports {
+    export { PdfSeparateOptions };
+}
+declare const _exports: Record<keyof PdfSeparateOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfSeparateOptions = {
+    /**
+     * Specifies the first page to extract.
+     * This defaults to page 1.
+     */
+    firstPageToExtract?: number | undefined;
+    /**
+     * Specifies the last page to extract.
+     * This defaults to the last page of the PDF file.
+     */
+    lastPageToExtract?: number | undefined;
+    /**
+     * Print copyright and version info.
+     */
+    printVersionInfo?: boolean | undefined;
+};

package/types/options/pdftocairo.d.ts

@@ -0,0 +1,241 @@
+declare namespace _exports {
+    export { PdfToCairoOptions };
+}
+declare const _exports: Record<keyof PdfToCairoOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfToCairoOptions = {
+    /**
+     * Set the cairo
+     * antialias option used for text and drawing in image files (or rasterized regions in vector output).
+     */
+    antialias?: "best" | "default" | "fast" | "good" | "gray" | "none" | "subpixel" | undefined;
+    /**
+     * Uses the crop box rather than media box when
+     * generating the files (PNG/JPEG/TIFF only).
+     */
+    cropBox?: boolean | undefined;
+    /**
+     * Specifies the height of crop area in pixels
+     * (image output) or points (vector output).
+     */
+    cropHeight?: number | undefined;
+    /**
+     * Specifies the size of crop square in pixels
+     * (image output) or points (vector output).
+     */
+    cropSize?: number | undefined;
+    /**
+     * Specifies the width of crop area in pixels
+     * (image output) or points (vector output).
+     */
+    cropWidth?: number | undefined;
+    /**
+     * Specifies the x-coordinate of the crop area top left
+     * corner in pixels (image output) or points (vector output).
+     */
+    cropXAxis?: number | undefined;
+    /**
+     * Specifies the y-coordinate of the crop area top left
+     * corner in pixels (image output) or points (vector output).
+     */
+    cropYAxis?: number | undefined;
+    /**
+     * Adds the %%IncludeFeature: *Duplex DuplexNoTumble DSC
+     * comment to the PostScript file (PS only). This tells the print manager to enable duplexing.
+     */
+    duplex?: boolean | undefined;
+    /**
+     * Generate an EPS file. An EPS file contains a single image,
+     * so if you use this option with a multi-page PDF file, you must use `options.firstPageToConvert` and
+     * `options.lastPageToConvert` to specify a single page.
+     * The page size options (originalPageSizes, paperSize, paperWidth, paperHeight) can not be used
+     * with this option.
+     */
+    epsFile?: boolean | undefined;
+    /**
+     * Generates only the even numbered pages.
+     */
+    evenPagesOnly?: boolean | undefined;
+    /**
+     * Expand PDF pages smaller than the paper to fill the
+     * paper (PS,PDF,SVG only). By default, these pages are not scaled.
+     */
+    fillPage?: boolean | undefined;
+    /**
+     * Specifies the first page to convert.
+     */
+    firstPageToConvert?: number | undefined;
+    /**
+     * Generate grayscale file (PNG, JPEG, and TIFF only).
+     */
+    grayscaleFile?: boolean | undefined;
+    /**
+     * Use the specified ICC file as the output profile
+     * (PNG only). The profile will be embedded in the PNG file.
+     */
+    iccFile?: string | undefined;
+    /**
+     * Generate JPEG file(s).
+     */
+    jpegFile?: boolean | undefined;
+    /**
+     * When used with `options.jpegFile`, this option can
+     * be used to control the JPEG compression parameters. It takes a string of the form
+     * `"<opt>=<val>[,<opt>=<val>]"`. Currently available options are:
+     * - `quality` Selects the JPEG quality value. The value must be an integer between 0 and 100
+     * - `progressive` Select progressive JPEG output. The possible values are `"y"`, `"n"`, indicating
+     * progressive (yes) or non-progressive (no), respectively
+     * - `optimize` Sets whether to compute optimal Huffman coding tables for the JPEG output, which
+     * will create smaller files but make an extra pass over the data. The value must be `"y"` or `"n"`,
+     * with `"y"` performing optimization, otherwise the default Huffman tables are used
+     *
+     * Example: `"quality=95,optimize=y"`.
+     */
+    jpegOptions?: string | undefined;
+    /**
+     * Specifies the last page to convert.
+     */
+    lastPageToConvert?: number | undefined;
+    /**
+     * Generate monochrome file (PNG and TIFF only).
+     */
+    monochromeFile?: boolean | undefined;
+    /**
+     * By default, PDF pages smaller than the paper
+     * (after any scaling) are centered on the paper. This option causes them to be aligned to
+     * the lower-left corner of the paper instead (PS, PDF, and SVG only).
+     */
+    noCenter?: boolean | undefined;
+    /**
+     * By default, printing output is cropped to the CropBox
+     * specified in the PDF file. This option disables cropping (PS, PDF, and SVG only).
+     */
+    noCrop?: boolean | undefined;
+    /**
+     * Do not scale PDF pages which are larger than the paper
+     * (PS, PDF, SVG only). By default, pages larger than the paper are shrunk to fit.
+     */
+    noShrink?: boolean | undefined;
+    /**
+     * Generates only the odd numbered pages.
+     */
+    oddPagesOnly?: boolean | undefined;
+    /**
+     * Set the paper size of each page to match
+     * the size specified in the PDF file.
+     */
+    originalPageSizes?: boolean | undefined;
+    /**
+     * Specify the owner password for the PDF file.
+     * Providing this will bypass all security restrictions.
+     */
+    ownerPassword?: string | undefined;
+    /**
+     * Set the paper height, in points (PS, PDF, and SVG only).
+     */
+    paperHeight?: number | undefined;
+    /**
+     * Set the paper size to one of `'A3'`, `'A4'`,
+     * `'legal'`, or `'letter'` (PS, PDF, and SVG only). This can also be set to `'match'`, which will set the
+     * paper size of each page to match the size specified in the PDF file. If none of `options.paperSize`,
+     * `options.paperWidth`, or `options.paperHeight` is specified the default is to match the paper size.
+     */
+    paperSize?: "A3" | "A4" | "legal" | "letter" | "match" | undefined;
+    /**
+     * Set the paper width, in points (PS, PDF, and SVG only).
+     */
+    paperWidth?: number | undefined;
+    /**
+     * Generate PDF file.
+     */
+    pdfFile?: boolean | undefined;
+    /**
+     * Generate PNG file(s).
+     */
+    pngFile?: boolean | undefined;
+    /**
+     * Print copyright and version information.
+     */
+    printVersionInfo?: boolean | undefined;
+    /**
+     * If the input file contains structural information
+     * about the document's content, write this information to the output file (PDF only).
+     */
+    printDocStruct?: boolean | undefined;
+    /**
+     * Generate PS file.
+     */
+    psFile?: boolean | undefined;
+    /**
+     * Generate Level 2 PostScript (PS only).
+     */
+    psLevel2?: boolean | undefined;
+    /**
+     * Generate Level 3 PostScript (PS only). This enables all
+     * Level 2 features plus shading patterns and masked images. This is the default setting.
+     */
+    psLevel3?: boolean | undefined;
+    /**
+     * Do not print any messages or errors.
+     */
+    quiet?: boolean | undefined;
+    /**
+     * Specifies the X resolution, in pixels per inch of
+     * image files (or rasterized regions in vector output). The default is `150` PPI.
+     */
+    resolutionXAxis?: number | undefined;
+    /**
+     * Specifies the X and Y resolution, in pixels per
+     * inch of image files (or rasterized regions in vector output). The default is `150` PPI.
+     */
+    resolutionXYAxis?: number | undefined;
+    /**
+     * Specifies the Y resolution, in pixels per inch of
+     * image files (or rasterized regions in vector output). The default is `150` PPI.
+     */
+    resolutionYAxis?: number | undefined;
+    /**
+     * Scales the long side of each page (width for landscape
+     * pages, height for portrait pages) to fit in scale-to pixels. The size of the short side will
+     * be determined by the aspect ratio of the page (PNG/JPEG/TIFF only).
+     */
+    scalePageTo?: number | undefined;
+    /**
+     * Scales each page horizontally to fit in scale-to-x
+     * pixels. If scale-to-y is set to `-1`, the vertical size will be determined by the aspect ratio of
+     * the page (PNG/JPEG/TIFF only).
+     */
+    scalePageToXAxis?: number | undefined;
+    /**
+     * Scales each page vertically to fit in scale-to-y
+     * pixels. If scale-to-x is set to `-1`, the horizontal size will be determined by the aspect ratio of
+     * the page (PNG/JPEG/TIFF only).
+     */
+    scalePageToYAxis?: number | undefined;
+    /**
+     * Writes only the first page and does not add digits.
+     * Can only be used with `options.jpegFile`, `options.pngFile`, and `options.tiffFile`.
+     */
+    singleFile?: boolean | undefined;
+    /**
+     * Generate SVG (Scalable Vector Graphics) file.
+     */
+    svgFile?: boolean | undefined;
+    /**
+     * Set TIFF compression.
+     */
+    tiffCompression?: "none" | "deflate" | "jpeg" | "lzw" | "packbits" | undefined;
+    /**
+     * Generate TIFF file(s).
+     */
+    tiffFile?: boolean | undefined;
+    /**
+     * Use a transparent page color
+     * instead of white (PNG and TIFF only).
+     */
+    transparentPageColor?: boolean | undefined;
+    /**
+     * Specify the user password for the PDF file.
+     */
+    userPassword?: string | undefined;
+};

package/types/options/pdftohtml.d.ts

@@ -0,0 +1,104 @@
+declare namespace _exports {
+    export { PdfToHtmlOptions };
+}
+declare const _exports: Record<keyof PdfToHtmlOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfToHtmlOptions = {
+    /**
+     * Generate complex output.
+     */
+    complexOutput?: boolean | undefined;
+    /**
+     * Use data URLs instead of external images in HTML.
+     */
+    dataUrls?: boolean | undefined;
+    /**
+     * Exchange .pdf links with .html.
+     */
+    exchangePdfLinks?: boolean | undefined;
+    /**
+     * Force hidden text extraction.
+     */
+    extractHidden?: boolean | undefined;
+    /**
+     * First page to print.
+     */
+    firstPageToConvert?: number | undefined;
+    /**
+     * Outputs the font name without any substitutions.
+     */
+    fontFullName?: boolean | undefined;
+    /**
+     * Ignore images.
+     */
+    ignoreImages?: boolean | undefined;
+    /**
+     * Image file format for Splash output (JPG or PNG).
+     * If `options.complexOutput` is enabled, but `options.imageFormat` is not specified, PNG will be assumed.
+     */
+    imageFormat?: "JPG" | "PNG" | undefined;
+    /**
+     * Last page to print.
+     */
+    lastPageToConvert?: number | undefined;
+    /**
+     * Override document DRM settings.
+     */
+    noDrm?: boolean | undefined;
+    /**
+     * Generate no frames. Not supported in complex output mode.
+     */
+    noFrames?: boolean | undefined;
+    /**
+     * Do not merge paragraphs.
+     */
+    noMergeParagraph?: boolean | undefined;
+    /**
+     * Do not round coordinates
+     * (with XML output only).
+     */
+    noRoundedCoordinates?: boolean | undefined;
+    /**
+     * Sets the encoding to use for text output.
+     * This defaults to `'UTF-8'`.
+     */
+    outputEncoding?: string | undefined;
+    /**
+     * Owner password (for encrypted files).
+     */
+    ownerPassword?: string | undefined;
+    /**
+     * Print copyright and version info.
+     */
+    printVersionInfo?: boolean | undefined;
+    /**
+     * Do not print any messages or errors.
+     */
+    quiet?: boolean | undefined;
+    /**
+     * Generate single HTML that includes all pages.
+     */
+    singlePage?: boolean | undefined;
+    /**
+     * Use standard output.
+     */
+    stdout?: boolean | undefined;
+    /**
+     * User password (for encrypted files).
+     */
+    userPassword?: string | undefined;
+    /**
+     * Adjust the word break threshold percent.
+     * Default is `10`. Word break occurs when distance between two adjacent characters is greater
+     * than this percent of character height.
+     */
+    wordBreakThreshold?: number | undefined;
+    /**
+     * Output for XML post-processing.
+     */
+    xmlOutput?: boolean | undefined;
+    /**
+     * Zoom the PDF document (default `1.5`).
+     */
+    zoom?: number | undefined;
+};