node-poppler 9.1.1 → 10.0.0

package/types/options/pdftoppm.d.ts

@@ -0,0 +1,210 @@
+declare namespace _exports {
+    export { PdfToPpmOptions };
+}
+declare const _exports: Record<keyof PdfToPpmOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfToPpmOptions = {
+    /**
+     * Enable or disable font anti-aliasing.
+     * This defaults to `'yes'`.
+     */
+    antialiasFonts?: "no" | "yes" | undefined;
+    /**
+     * Enable or disable vector anti-aliasing.
+     * This defaults to `'yes'`.
+     */
+    antialiasVectors?: "no" | "yes" | 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;
+    /**
+     * If Poppler is compiled with colour management support, this option
+     * sets the DefaultCMYK color space to the ICC profile stored in the display profile file passed.
+     */
+    defaultCmykProfile?: string | undefined;
+    /**
+     * If Poppler is compiled with colour management support, this option
+     * sets the DefaultGray color space to the ICC profile stored in the display profile file passed.
+     */
+    defaultGrayProfile?: string | undefined;
+    /**
+     * If Poppler is compiled with colour management support, this option
+     * sets the DefaultRGB color space to the ICC profile stored in the display profile file passed.
+     */
+    defaultRgbProfile?: string | undefined;
+    /**
+     * If Poppler is compiled with colour management support, this option
+     * sets the display profile to the ICC profile stored in the display profile file passed.
+     */
+    displayProfile?: string | undefined;
+    /**
+     * Generates only the even numbered pages.
+     */
+    evenPagesOnly?: boolean | undefined;
+    /**
+     * Specifies the first page to convert.
+     */
+    firstPageToConvert?: number | undefined;
+    /**
+     * Enable or disable FreeType (a TrueType / Type 1 font rasterizer).
+     * This defaults to `'yes'`.
+     */
+    freetype?: "no" | "yes" | undefined;
+    /**
+     * Force page number even if there is only one page.
+     */
+    forcePageNumber?: boolean | undefined;
+    /**
+     * Generate grayscale PGM file (instead of a color PPM file).
+     */
+    grayscaleFile?: boolean | undefined;
+    /**
+     * Hide annotations.
+     */
+    hideAnnotations?: boolean | undefined;
+    /**
+     * Generate a CMYK JPEG file.
+     */
+    jpegCmyk?: boolean | undefined;
+    /**
+     * Generate JPEG file instead of a PPM file.
+     */
+    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
+     */
+    jpegOptions?: string | undefined;
+    /**
+     * Specifies the last page to convert.
+     */
+    lastPageToConvert?: number | undefined;
+    /**
+     * Generate monochrome PBM file (instead of a color PPM file).
+     */
+    monochromeFile?: boolean | undefined;
+    /**
+     * Generates only the odd numbered pages.
+     */
+    oddPagesOnly?: boolean | undefined;
+    /**
+     * Specify the owner password for the PDF file.
+     * Providing this will bypass all security restrictions.
+     */
+    ownerPassword?: string | undefined;
+    /**
+     * Enable overprint emulation during rasterization.
+     */
+    overprint?: boolean | undefined;
+    /**
+     * Generate PNG file instead of a PPM file.
+     */
+    pngFile?: boolean | undefined;
+    /**
+     * Print progress info as each page is generated.
+     * Three space-separated fields are printed to STDERR: the number of the current page, the number
+     * of the last page that will be generated, and the path to the file written to.
+     */
+    printProgress?: boolean | undefined;
+    /**
+     * Print copyright and version information.
+     */
+    printVersionInfo?: 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;
+    /**
+     * Swaps horizontal and vertical size for
+     * a rotated (landscape) PDF before scaling instead of after.
+     */
+    scaleDimensionBeforeRotation?: boolean | 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.
+     */
+    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.
+     */
+    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.
+     */
+    scalePageToYAxis?: number | undefined;
+    /**
+     * Specify single character separator between name and page number.
+     */
+    separator?: string | undefined;
+    /**
+     * Writes only the first page and does not add digits.
+     */
+    singleFile?: boolean | undefined;
+    /**
+     * Specifies the thin line mode. This defaults to `'none'`.
+     */
+    thinLineMode?: "none" | "shape" | "solid" | undefined;
+    /**
+     * Set TIFF compression.
+     */
+    tiffCompression?: "none" | "deflate" | "jpeg" | "lzw" | "packbits" | undefined;
+    /**
+     * Generate TIFF file instead of a PPM file.
+     */
+    tiffFile?: boolean | undefined;
+    /**
+     * Specify the user password for the PDF file.
+     */
+    userPassword?: string | undefined;
+};

package/types/options/pdftops.d.ts

@@ -0,0 +1,237 @@
+declare namespace _exports {
+    export { PdfToPsOptions };
+}
+declare const _exports: Record<keyof PdfToPsOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfToPsOptions = {
+    /**
+     * Enable anti-aliasing on rasterization, accepts `no` or `yes`.
+     */
+    antialias?: "no" | "yes" | undefined;
+    /**
+     * Write binary data in Level 1 PostScript. By default,
+     * pdftops writes hex-encoded data in Level 1 PostScript. Binary data is non-standard in Level 1
+     * PostScript but reduces the file size and can be useful when Level 1 PostScript is required
+     * only for its restricted use of PostScript operators.
+     */
+    binary?: boolean | undefined;
+    /**
+     * If Poppler is compiled with colour management support, this option
+     * sets the DefaultCMYK color space to the ICC profile stored in the display profile file passed.
+     */
+    defaultCmykProfile?: string | undefined;
+    /**
+     * If Poppler is compiled with colour management support, this option
+     * sets the DefaultGray color space to the ICC profile stored in the display profile file passed.
+     */
+    defaultGrayProfile?: string | undefined;
+    /**
+     * If Poppler is compiled with colour management support, this option
+     * sets the DefaultRGB color space to the ICC profile stored in the display profile file passed.
+     */
+    defaultRgbProfile?: string | undefined;
+    /**
+     * Set the Duplex pagedevice entry in the PostScript file.
+     * This tells duplex-capable printers 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;
+    /**
+     * Expand PDF pages smaller than the paper to fill the
+     * paper. By default, these pages are not scaled.
+     */
+    fillPage?: boolean | undefined;
+    /**
+     * Specifies the first page to convert.
+     */
+    firstPageToConvert?: number | undefined;
+    /**
+     * Generate PostScript form which can be imported by software
+     * that understands forms.
+     * A form contains a single page, 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 `options.level1` option cannot be used with `options.form`.
+     * No more than one of the mode options (`options.epsFile`, `options.form`) may be given.
+     */
+    form?: boolean | undefined;
+    /**
+     * Specifies the last page to convert.
+     */
+    lastPageToConvert?: number | undefined;
+    /**
+     * Generate Level 1 PostScript. The resulting PostScript
+     * files will be significantly larger (if they contain images), but will print on Level 1 printers.
+     * This also converts all images to black and white.
+     */
+    level1?: boolean | undefined;
+    /**
+     * Generate Level 1 separable PostScript.
+     * All colors are converted to CMYK. Images are written with separate stream data for the four components.
+     */
+    level1Sep?: boolean | undefined;
+    /**
+     * Generate Level 2 PostScript.
+     * Level 2 supports color images and image compression. This is the default setting.
+     */
+    level2?: boolean | undefined;
+    /**
+     * Generate Level 2 separable PostScript. All colors are
+     * converted to CMYK. The PostScript separation convention operators are used to handle custom (spot) colors.
+     */
+    level2Sep?: boolean | undefined;
+    /**
+     * Generate Level 3 PostScript.
+     * This enables all Level 2 features plus CID font embedding.
+     */
+    level3?: boolean | undefined;
+    /**
+     * Generate Level 3 separable PostScript.
+     * The separation handling is the same as for `options.level2Sep`.
+     */
+    level3Sep?: 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.
+     */
+    noCenter?: boolean | undefined;
+    /**
+     * By default, printing output is cropped to the CropBox
+     * specified in the PDF file. This option disables cropping.
+     */
+    noCrop?: boolean | undefined;
+    /**
+     * By default, any CID PostScript fonts which are
+     * embedded in the PDF file are copied into the PostScript file. This option disables that embedding.
+     * No attempt is made to substitute for non-embedded CID PostScript fonts.
+     */
+    noEmbedCIDFonts?: boolean | undefined;
+    /**
+     * By default, any CID TrueType fonts which are
+     * embedded in the PDF file are copied into the PostScript file. This option disables that embedding.
+     * No attempt is made to substitute for non-embedded CID TrueType fonts.
+     */
+    noEmbedCIDTrueTypeFonts?: boolean | undefined;
+    /**
+     * By default, any TrueType fonts which are embedded
+     * in the PDF file are copied into the PostScript file. This option causes pdfToPs to substitute base fonts instead.
+     * Embedded fonts make PostScript files larger, but may be necessary for readable output.
+     * Also, some PostScript interpreters do not have TrueType rasterizers.
+     */
+    noEmbedTrueTypeFonts?: boolean | undefined;
+    /**
+     * By default, any Type 1 fonts which are embedded in the PDF file
+     * are copied into the PostScript file. This option causes pdfToPs to substitute base fonts instead.
+     * Embedded fonts make PostScript files larger, but may be necessary for readable output.
+     */
+    noEmbedType1Fonts?: boolean | undefined;
+    /**
+     * Do not scale PDF pages which are larger than the paper.
+     * By default, pages larger than the paper are shrunk to fit.
+     */
+    noShrink?: boolean | undefined;
+    /**
+     * Generate OPI comments for all images and forms which have OPI information.
+     */
+    opi?: boolean | undefined;
+    /**
+     * By default, bitmap images in the PDF pass through to the
+     * output PostScript in their original color space, which produces predictable results.
+     * This option converts RGB and CMYK images into Gray images if every pixel of the image has equal components.
+     * This can fix problems when doing color separations of PDFs that contain embedded black and
+     * white images encoded as RGB.
+     */
+    optimizeColorSpace?: boolean | undefined;
+    /**
+     * Set the paper size of each page to match
+     * the size specified in the PDF file.
+     */
+    originalPageSizes?: boolean | undefined;
+    /**
+     * Enable overprint emulation during rasterization.
+     * This option requires `options.processColorFormat` to be CMYK8.
+     */
+    overprint?: boolean | undefined;
+    /**
+     * Owner password (for encrypted files).
+     */
+    ownerPassword?: string | undefined;
+    /**
+     * Set the paper height, in points.
+     */
+    paperHeight?: number | undefined;
+    /**
+     * Set the paper size to one of `'A3'`, `'A4'`,
+     * `'legal'`, or `'letter'`. 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 the paperSize,
+     * paperWidth, or paperHeight options are specified the default is to match the paper size.
+     */
+    paperSize?: "A3" | "A4" | "legal" | "letter" | "match" | undefined;
+    /**
+     * Set the paper width, in points.
+     */
+    paperWidth?: number | undefined;
+    /**
+     * By default, references to non-embedded 8-bit fonts
+     * in the PDF file are substituted with the closest Helvetica, Times-Roman, or Courier font.
+     * This option passes references to non-embedded fonts through to the PostScript file.
+     */
+    passFonts?: boolean | undefined;
+    /**
+     * When generating Level 1 separable PostScript,
+     * preserve custom colors instead of converting them to CMYK.
+     * Has no effect if `options.level1Sep` is not set.
+     */
+    passLevel1CustomColor?: boolean | undefined;
+    /**
+     * Preload images and forms.
+     */
+    preload?: boolean | undefined;
+    /**
+     * Print copyright and version information.
+     */
+    printVersionInfo?: boolean | undefined;
+    /**
+     * Sets the process color format as it is used
+     * during rasterization and transparency reduction.
+     *
+     * The default depends on the other settings: For `options.level1` the default is `'MONO8'`; for `options.level1Sep`,
+     * `options.level2Sep`, `options.level3Sep`, or `options.overprint` the default is `'CMYK8'`; in all other
+     * cases `'RGB8'` is the default.
+     * If `options.processColorProfile` is set then `options.processColorFormat` is inferred from the specified ICC profile.
+     */
+    processColorFormat?: "CMYK8" | "MONO8" | "RGB8" | undefined;
+    /**
+     * Sets the ICC profile that is assumed during
+     * rasterization and transparency reduction.
+     */
+    processColorProfile?: string | undefined;
+    /**
+     * Do not print any messages or errors.
+     */
+    quiet?: boolean | undefined;
+    /**
+     * By default, pdfToPs rasterizes pages as needed,
+     * for example, if they contain transparencies. To force rasterization, set `rasterize` to `'always'`.
+     * Use this to eliminate fonts.
+     * To prevent rasterization, set `rasterize` to `'never'`.
+     * This may produce files that display incorrectly.
+     */
+    rasterize?: "always" | "never" | "whenneeded" | undefined;
+    /**
+     * Specifies the X and Y resolution, in pixels per
+     * inch of image files (or rasterized regions in vector output). The default is `300` PPI.
+     */
+    resolutionXYAxis?: number | undefined;
+    /**
+     * User password (for encrypted files).
+     */
+    userPassword?: string | undefined;
+};

package/types/options/pdftotext.d.ts

@@ -0,0 +1,137 @@
+declare namespace _exports {
+    export { PdfToTextOptions };
+}
+declare const _exports: Record<keyof PdfToTextOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfToTextOptions = {
+    /**
+     * Generate an XHTML file containing bounding
+     * box information for each word in the file.
+     */
+    boundingBoxXhtml?: boolean | undefined;
+    /**
+     * Generate an XHTML file containing
+     * bounding box information for each block, line, and word in the file.
+     */
+    boundingBoxXhtmlLayout?: boolean | undefined;
+    /**
+     * Specifies how much spacing to allow after a word
+     * before considering adjacent text to be a new column, measured as a fraction
+     * of the font size. Default is `0.7`.
+     */
+    columnSpacing?: number | undefined;
+    /**
+     * Use the crop box rather than the media box with
+     * `options.boundingBoxXhtml` and `options.boundingBoxXhtmlLayout`.
+     */
+    cropBox?: boolean | undefined;
+    /**
+     * Specifies the height of crop area in pixels
+     * (image output) or points (vector output).
+     */
+    cropHeight?: 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;
+    /**
+     * Sets the end-of-line convention to use for
+     * text output: dos; mac; unix.
+     */
+    eolConvention?: "dos" | "mac" | "unix" | undefined;
+    /**
+     * Specifies the first page to convert.
+     */
+    firstPageToConvert?: number | undefined;
+    /**
+     * Assume fixed-pitch (or tabular) text, with the
+     * specified character width (in points). This forces physical layout mode.
+     */
+    fixedWidthLayout?: number | undefined;
+    /**
+     * Generate simple HTML file, including the
+     * meta information. This simply wraps the text in `<pre>` and `</pre>` and prepends the meta headers.
+     */
+    generateHtmlMetaFile?: boolean | undefined;
+    /**
+     * Generate a TSV file containing the bounding box
+     * information for each block, line, and word in the file.
+     */
+    generateTsvFile?: boolean | undefined;
+    /**
+     * Specifies the last page to convert.
+     */
+    lastPageToConvert?: number | undefined;
+    /**
+     * List the available encodings.
+     */
+    listEncodingOptions?: boolean | undefined;
+    /**
+     * Maintain (as best as possible) the original physical
+     * layout of the text. The default is to undo physical layout (columns, hyphenation, etc.) and
+     * output the text in reading order.
+     */
+    maintainLayout?: boolean | undefined;
+    /**
+     * Discard diagonal text.
+     */
+    noDiagonalText?: boolean | undefined;
+    /**
+     * Do not insert page breaks (form feed characters)
+     * between pages.
+     */
+    noPageBreaks?: 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 information.
+     */
+    printVersionInfo?: boolean | undefined;
+    /**
+     * Do not print any messages or errors.
+     */
+    quiet?: boolean | undefined;
+    /**
+     * Keep the text in content stream order. This is a
+     * hack which often undoes column formatting, etc. Use of raw mode is no longer recommended.
+     */
+    rawLayout?: boolean | undefined;
+    /**
+     * Controls end-of-line hyphen handling:
+     * - `'all'` removes end-of-line hyphens (U+002D, U+2010, U+FE63, U+FF0D) and Unicode
+     * soft hyphens (U+00AD), merging words across lines (default)
+     * - `'none'` keeps all end-of-line hyphens and line breaks unchanged
+     * - `'soft'` removes only Unicode soft hyphens (U+00AD), merging words across lines.
+     * ASCII and other hyphen characters are preserved
+     *
+     * This option has no effect when `options.rawLayout` or `options.maintainLayout`
+     * are set to `true`.
+     */
+    removeHyphens?: "none" | "all" | "soft" | undefined;
+    /**
+     * Specifies the resolution in DPI. Default is `72`.
+     */
+    resolution?: number | undefined;
+    /**
+     * User password (for encrypted files).
+     */
+    userPassword?: string | undefined;
+};

package/types/options/pdfunite.d.ts

@@ -0,0 +1,11 @@
+declare namespace _exports {
+    export { PdfUniteOptions };
+}
+declare const _exports: Record<keyof PdfUniteOptions, import("../index").OptionDetails>;
+export = _exports;
+type PdfUniteOptions = {
+    /**
+     * Print copyright and version information.
+     */
+    printVersionInfo?: boolean | undefined;
+};