node-poppler 9.1.1 → 10.0.0

package/src/options/pdfattach.js

@@ -0,0 +1,13 @@
+"use strict";
+
+/**
+ * @typedef PdfAttachOptions
+ * @property {boolean} [printVersionInfo] Print copyright and version info.
+ * @property {boolean} [replace] Replace embedded file with same name (if it exists).
+ */
+
+/** @type {Record<keyof PdfAttachOptions, import("../index").OptionDetails>} */
+module.exports = {
+	printVersionInfo: { arg: "-v", type: "boolean" },
+	replace: { arg: "-replace", type: "boolean" },
+};

package/src/options/pdfdetach.js

@@ -0,0 +1,41 @@
+"use strict";
+
+/**
+ * @typedef PdfDetachOptions
+ * @property {boolean} [listEmbedded] List all of the embedded files in the PDF file.
+ * File names are converted to the text encoding specified by `options.outputEncoding`.
+ * @property {string} [outputEncoding] Sets the encoding to use for text output.
+ * This defaults to `UTF-8`.
+ * @property {string} [ownerPassword] Owner password (for encrypted files).
+ * @property {string} [outputPath] Set the file name used when saving an embedded file with
+ * the save option enabled, or the directory if `options.saveAllFiles` is used.
+ * @property {boolean} [printVersionInfo] Print copyright and version info.
+ * @property {boolean} [saveAllFiles] 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`.
+ * @property {string} [saveFile] 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`.
+ * @property {number} [saveSpecificFile] 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`.
+ * @property {string} [userPassword] User password (for encrypted files).
+ */
+
+/** @type {Record<keyof PdfDetachOptions, import("../index").OptionDetails>} */
+module.exports = {
+	listEmbedded: { arg: "-list", type: "boolean" },
+	outputEncoding: { arg: "-enc", type: "string" },
+	outputPath: { arg: "-o", type: "string" },
+	ownerPassword: { arg: "-opw", type: "string" },
+	printVersionInfo: { arg: "-v", type: "boolean" },
+	saveAllFiles: { arg: "-saveall", type: "boolean" },
+	saveFile: {
+		arg: "-savefile",
+		type: "string",
+		minVersion: "0.86.0",
+	},
+	saveSpecificFile: { arg: "-save", type: "number" },
+	userPassword: { arg: "-upw", type: "string" },
+};

package/src/options/pdffonts.js

@@ -0,0 +1,22 @@
+"use strict";
+
+/**
+ * @typedef PdfFontsOptions
+ * @property {number} [firstPageToExamine] Specifies the first page to examine.
+ * @property {number} [lastPageToExamine] Specifies the last page to examine.
+ * @property {boolean} [listSubstitutes] List the substitute fonts that Poppler
+ * will use for non-embedded fonts.
+ * @property {string} [ownerPassword] Owner password (for encrypted files).
+ * @property {boolean} [printVersionInfo] Print copyright and version info.
+ * @property {string} [userPassword] User password (for encrypted files).
+ */
+
+/** @type {Record<keyof PdfFontsOptions, import("../index").OptionDetails>} */
+module.exports = {
+	firstPageToExamine: { arg: "-f", type: "number" },
+	lastPageToExamine: { arg: "-l", type: "number" },
+	listSubstitutes: { arg: "-subst", type: "boolean", minVersion: "0.19.0" },
+	ownerPassword: { arg: "-opw", type: "string" },
+	printVersionInfo: { arg: "-v", type: "boolean" },
+	userPassword: { arg: "-upw", type: "string" },
+};

package/src/options/pdfimages.js

@@ -0,0 +1,48 @@
+"use strict";
+
+/**
+ * @typedef PdfImagesOptions
+ * @property {boolean} [allFiles] 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.
+ * @property {boolean} [ccittFile] Generate CCITT images as CCITT files.
+ * @property {number} [firstPageToConvert] Specifies the first page to convert.
+ * @property {number} [lastPageToConvert] Specifies the last page to convert.
+ * @property {boolean} [jbig2File] Generate JBIG2 images as JBIG2 files.
+ * @property {boolean} [jpeg2000File] Generate JPEG2000 images as JP2 files.
+ * @property {boolean} [jpegFile] Generate JPEG images as JPEG files.
+ * @property {boolean} [list] Instead of writing the images, list the
+ * images along with various information for each image.
+ * NOTE: Do not specify the `outputPrefix` with this option.
+ * @property {boolean} [outputPageNumbers] Include page numbers in output file names.
+ * @property {string} [ownerPassword] Owner password (for encrypted files).
+ * @property {boolean} [pngFile] Change the default output format to PNG.
+ * @property {boolean} [printFilenames] Print image filenames to stdout.
+ * @property {boolean} [printVersionInfo] Print copyright and version info.
+ * @property {boolean} [quiet] Do not print any messages or errors.
+ * @property {boolean} [tiffFile] Change the default output format to TIFF.
+ * @property {string} [userPassword] Specify the user password for the PDF file.
+ */
+
+/** @type {Record<keyof PdfImagesOptions, import("../index").OptionDetails>} */
+module.exports = {
+	allFiles: { arg: "-all", type: "boolean" },
+	ccittFile: { arg: "-ccitt", type: "boolean" },
+	firstPageToConvert: { arg: "-f", type: "number" },
+	lastPageToConvert: { arg: "-l", type: "number" },
+	jbig2File: { arg: "-jbig2", type: "boolean" },
+	jpeg2000File: { arg: "-jp2", type: "boolean" },
+	jpegFile: { arg: "-j", type: "boolean" },
+	list: { arg: "-list", type: "boolean", minVersion: "0.19.0" },
+	outputPageNumbers: { arg: "-p", type: "boolean", minVersion: "0.15.2" },
+	ownerPassword: { arg: "-opw", type: "string" },
+	pngFile: { arg: "-png", type: "boolean" },
+	printFilenames: {
+		arg: "-print-filenames",
+		type: "boolean",
+		minVersion: "24.03.0",
+	},
+	printVersionInfo: { arg: "-v", type: "boolean" },
+	quiet: { arg: "-q", type: "boolean" },
+	tiffFile: { arg: "-tiff", type: "boolean", minVersion: "0.53.0" },
+	userPassword: { arg: "-upw", type: "string" },
+};

package/src/options/pdfinfo.js

@@ -0,0 +1,65 @@
+"use strict";
+
+/**
+ * @typedef PdfInfoOptions
+ * @property {number} [firstPageToConvert] First page to print.
+ * @property {number} [lastPageToConvert] Last page to print.
+ * @property {boolean} [listEncodingOptions] List the available encodings.
+ * @property {string} [outputEncoding] Sets the encoding to use for text output.
+ * This defaults to `'UTF-8'`.
+ * @property {string} [ownerPassword] Owner password (for encrypted files).
+ * @property {boolean} [printAsJson] Print result as a JSON object.
+ * @property {boolean} [printBoundingBoxes] Prints the page box bounding boxes:
+ * MediaBox, CropBox, BleedBox, TrimBox, and ArtBox.
+ * @property {boolean} [printCustomMetadata] Print both custom and standard metadata.
+ * @property {boolean} [printDocStruct] Prints the logical document structure
+ * of a Tagged-PDF file.
+ * @property {boolean} [printDocStructText] 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.
+ * @property {boolean} [printIsoDates] Prints dates in ISO-8601 format (including the time zone).
+ * @property {boolean} [printJS] Prints all JavaScript in the PDF file.
+ * @property {boolean} [printMetadata] Prints document-level metadata. (This is the `Metadata`
+ * stream from the PDF file's Catalog object).
+ * @property {boolean} [printNamedDests] 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.
+ * @property {boolean} [printRawDates] Prints the raw (undecoded) date strings, directly from the PDF file.
+ * @property {boolean} [printUrls] 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.
+ * @property {boolean} [printVersionInfo] Print copyright and version info.
+ * @property {string} [userPassword] User password (for encrypted files).
+ */
+
+/** @type {Record<keyof PdfInfoOptions, import("../index").OptionDetails>} */
+module.exports = {
+	firstPageToConvert: { arg: "-f", type: "number" },
+	lastPageToConvert: { arg: "-l", type: "number" },
+	listEncodingOptions: {
+		arg: "-listenc",
+		type: "boolean",
+		minVersion: "0.9.0",
+	},
+	outputEncoding: { arg: "-enc", type: "string" },
+	ownerPassword: { arg: "-opw", type: "string" },
+	printAsJson: { arg: "", type: "boolean" },
+	printBoundingBoxes: { arg: "-box", type: "boolean" },
+	printCustomMetadata: {
+		arg: "-custom",
+		type: "boolean",
+		minVersion: "21.10.0",
+	},
+	printDocStruct: { arg: "-struct", type: "boolean" },
+	printDocStructText: {
+		arg: "-struct-text",
+		type: "boolean",
+	},
+	printIsoDates: { arg: "-isodates", type: "boolean", minVersion: "0.45.0" },
+	printJS: { arg: "-js", type: "boolean", minVersion: "0.25.0" },
+	printMetadata: { arg: "-meta", type: "boolean" },
+	printNamedDests: { arg: "-dests", type: "boolean", minVersion: "0.58.0" },
+	printRawDates: { arg: "-rawdates", type: "boolean" },
+	printUrls: { arg: "-url", type: "boolean", minVersion: "21.11.0" },
+	printVersionInfo: { arg: "-v", type: "boolean" },
+	userPassword: { arg: "-upw", type: "string" },
+};

package/src/options/pdfseparate.js

@@ -0,0 +1,17 @@
+"use strict";
+
+/**
+ * @typedef PdfSeparateOptions
+ * @property {number} [firstPageToExtract] Specifies the first page to extract.
+ * This defaults to page 1.
+ * @property {number} [lastPageToExtract] Specifies the last page to extract.
+ * This defaults to the last page of the PDF file.
+ * @property {boolean} [printVersionInfo] Print copyright and version info.
+ */
+
+/** @type {Record<keyof PdfSeparateOptions, import("../index").OptionDetails>} */
+module.exports = {
+	firstPageToExtract: { arg: "-f", type: "number", minVersion: "0.18.0" },
+	lastPageToExtract: { arg: "-l", type: "number", minVersion: "0.18.0" },
+	printVersionInfo: { arg: "-v", type: "boolean", minVersion: "0.18.0" },
+};

package/src/options/pdftocairo.js

@@ -0,0 +1,169 @@
+"use strict";
+
+/**
+ * @typedef PdfToCairoOptions
+ * @property {('best'|'default'|'fast'|'good'|'gray'|'none'|'subpixel')} [antialias] Set the cairo
+ * antialias option used for text and drawing in image files (or rasterized regions in vector output).
+ * @property {boolean} [cropBox] Uses the crop box rather than media box when
+ * generating the files (PNG/JPEG/TIFF only).
+ * @property {number} [cropHeight] Specifies the height of crop area in pixels
+ * (image output) or points (vector output).
+ * @property {number} [cropSize] Specifies the size of crop square in pixels
+ * (image output) or points (vector output).
+ * @property {number} [cropWidth] Specifies the width of crop area in pixels
+ * (image output) or points (vector output).
+ * @property {number} [cropXAxis] Specifies the x-coordinate of the crop area top left
+ * corner in pixels (image output) or points (vector output).
+ * @property {number} [cropYAxis] Specifies the y-coordinate of the crop area top left
+ * corner in pixels (image output) or points (vector output).
+ * @property {boolean} [duplex] Adds the %%IncludeFeature: *Duplex DuplexNoTumble DSC
+ * comment to the PostScript file (PS only). This tells the print manager to enable duplexing.
+ * @property {boolean} [epsFile] 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.
+ * @property {boolean} [evenPagesOnly] Generates only the even numbered pages.
+ * @property {boolean} [fillPage] Expand PDF pages smaller than the paper to fill the
+ * paper (PS,PDF,SVG only). By default, these pages are not scaled.
+ * @property {number} [firstPageToConvert] Specifies the first page to convert.
+ * @property {boolean} [grayscaleFile] Generate grayscale file (PNG, JPEG, and TIFF only).
+ * @property {string} [iccFile] Use the specified ICC file as the output profile
+ * (PNG only). The profile will be embedded in the PNG file.
+ * @property {boolean} [jpegFile] Generate JPEG file(s).
+ * @property {string} [jpegOptions] 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"`.
+ * @property {number} [lastPageToConvert] Specifies the last page to convert.
+ * @property {boolean} [monochromeFile] Generate monochrome file (PNG and TIFF only).
+ * @property {boolean} [noCenter] 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).
+ * @property {boolean} [noCrop] By default, printing output is cropped to the CropBox
+ * specified in the PDF file. This option disables cropping (PS, PDF, and SVG only).
+ * @property {boolean} [noShrink] 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.
+ * @property {boolean} [oddPagesOnly] Generates only the odd numbered pages.
+ * @property {boolean} [originalPageSizes] Set the paper size of each page to match
+ * the size specified in the PDF file.
+ * @property {string} [ownerPassword] Specify the owner password for the PDF file.
+ * Providing this will bypass all security restrictions.
+ * @property {number} [paperHeight] Set the paper height, in points (PS, PDF, and SVG only).
+ * @property {('A3'|'A4'|'legal'|'letter'|'match')} [paperSize] 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.
+ * @property {number} [paperWidth] Set the paper width, in points (PS, PDF, and SVG only).
+ * @property {boolean} [pdfFile] Generate PDF file.
+ * @property {boolean} [pngFile] Generate PNG file(s).
+ * @property {boolean} [printVersionInfo] Print copyright and version information.
+ * @property {boolean} [printDocStruct] If the input file contains structural information
+ * about the document's content, write this information to the output file (PDF only).
+ * @property {boolean} [psFile] Generate PS file.
+ * @property {boolean} [psLevel2] Generate Level 2 PostScript (PS only).
+ * @property {boolean} [psLevel3] Generate Level 3 PostScript (PS only). This enables all
+ * Level 2 features plus shading patterns and masked images. This is the default setting.
+ * @property {boolean} [quiet] Do not print any messages or errors.
+ * @property {number} [resolutionXAxis] Specifies the X resolution, in pixels per inch of
+ * image files (or rasterized regions in vector output). The default is `150` PPI.
+ * @property {number} [resolutionXYAxis] Specifies the X and Y resolution, in pixels per
+ * inch of image files (or rasterized regions in vector output). The default is `150` PPI.
+ * @property {number} [resolutionYAxis] Specifies the Y resolution, in pixels per inch of
+ * image files (or rasterized regions in vector output). The default is `150` PPI.
+ * @property {number} [scalePageTo] 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).
+ * @property {number} [scalePageToXAxis] 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).
+ * @property {number} [scalePageToYAxis] 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).
+ * @property {boolean} [singleFile] Writes only the first page and does not add digits.
+ * Can only be used with `options.jpegFile`, `options.pngFile`, and `options.tiffFile`.
+ * @property {boolean} [svgFile] Generate SVG (Scalable Vector Graphics) file.
+ * @property {('deflate'|'jpeg'|'lzw'|'none'|'packbits')} [tiffCompression] Set TIFF compression.
+ * @property {boolean} [tiffFile] Generate TIFF file(s).
+ * @property {boolean} [transparentPageColor] Use a transparent page color
+ * instead of white (PNG and TIFF only).
+ * @property {string} [userPassword] Specify the user password for the PDF file.
+ */
+
+/** @type {Record<keyof PdfToCairoOptions, import("../index").OptionDetails>} */
+module.exports = {
+	antialias: { arg: "-antialias", type: "string", minVersion: "0.44.0" },
+	cropBox: { arg: "-cropbox", type: "boolean", minVersion: "0.17.3" },
+	cropHeight: { arg: "-H", type: "number", minVersion: "0.17.3" },
+	cropSize: { arg: "-sz", type: "number", minVersion: "0.17.3" },
+	cropWidth: { arg: "-W", type: "number", minVersion: "0.17.3" },
+	cropXAxis: { arg: "-x", type: "number", minVersion: "0.17.3" },
+	cropYAxis: { arg: "-y", type: "number", minVersion: "0.17.3" },
+	duplex: { arg: "-duplex", type: "boolean", minVersion: "0.17.3" },
+	epsFile: { arg: "-eps", type: "boolean", minVersion: "0.17.3" },
+	evenPagesOnly: { arg: "-e", type: "boolean", minVersion: "0.17.3" },
+	fillPage: { arg: "-expand", type: "boolean", minVersion: "0.17.3" },
+	firstPageToConvert: { arg: "-f", type: "number", minVersion: "0.17.3" },
+	grayscaleFile: { arg: "-gray", type: "boolean", minVersion: "0.17.3" },
+	iccFile: { arg: "-icc", type: "string", minVersion: "0.17.3" },
+	jpegFile: { arg: "-jpeg", type: "boolean", minVersion: "0.17.3" },
+	jpegOptions: { arg: "-jpegopt", type: "string", minVersion: "0.58.0" },
+	lastPageToConvert: { arg: "-l", type: "number", minVersion: "0.17.3" },
+	monochromeFile: { arg: "-mono", type: "boolean", minVersion: "0.17.3" },
+	noCenter: { arg: "-nocenter", type: "boolean", minVersion: "0.17.3" },
+	noCrop: { arg: "-nocrop", type: "boolean", minVersion: "0.17.3" },
+	noShrink: { arg: "-noshrink", type: "boolean", minVersion: "0.17.3" },
+	oddPagesOnly: { arg: "-o", type: "boolean", minVersion: "0.17.3" },
+	originalPageSizes: {
+		arg: "-origpagesizes",
+		type: "boolean",
+		minVersion: "0.17.3",
+	},
+	ownerPassword: { arg: "-opw", type: "string", minVersion: "0.17.3" },
+	paperHeight: { arg: "-paperh", type: "number", minVersion: "0.17.3" },
+	paperSize: { arg: "-paper", type: "string", minVersion: "0.17.3" },
+	paperWidth: { arg: "-paperw", type: "number", minVersion: "0.17.3" },
+	pdfFile: { arg: "-pdf", type: "boolean", minVersion: "0.17.3" },
+	pngFile: { arg: "-png", type: "boolean", minVersion: "0.17.3" },
+	printDocStruct: { arg: "-struct", type: "boolean", minVersion: "23.11.0" },
+	printVersionInfo: { arg: "-v", type: "boolean", minVersion: "0.17.3" },
+	psFile: { arg: "-ps", type: "boolean", minVersion: "0.17.3" },
+	psLevel2: { arg: "-level2", type: "boolean", minVersion: "0.17.3" },
+	psLevel3: { arg: "-level3", type: "boolean", minVersion: "0.17.3" },
+	quiet: { arg: "-q", type: "boolean", minVersion: "0.17.3" },
+	resolutionXAxis: { arg: "-rx", type: "number", minVersion: "0.17.3" },
+	resolutionXYAxis: { arg: "-r", type: "number", minVersion: "0.17.3" },
+	resolutionYAxis: { arg: "-ry", type: "number", minVersion: "0.17.3" },
+	scalePageTo: { arg: "-scale-to", type: "number", minVersion: "0.17.3" },
+	scalePageToXAxis: {
+		arg: "-scale-to-x",
+		type: "number",
+		minVersion: "0.17.3",
+	},
+	scalePageToYAxis: {
+		arg: "-scale-to-y",
+		type: "number",
+		minVersion: "0.17.3",
+	},
+	singleFile: { arg: "-singlefile", type: "boolean", minVersion: "0.17.3" },
+	svgFile: { arg: "-svg", type: "boolean", minVersion: "0.17.3" },
+	tiffCompression: {
+		arg: "-tiffcompression",
+		type: "string",
+		minVersion: "0.21.2",
+	},
+	tiffFile: { arg: "-tiff", type: "boolean", minVersion: "0.21.2" },
+	transparentPageColor: {
+		arg: "-transp",
+		type: "boolean",
+		minVersion: "0.17.3",
+	},
+	userPassword: { arg: "-upw", type: "string", minVersion: "0.17.3" },
+};

package/src/options/pdftohtml.js

@@ -0,0 +1,71 @@
+"use strict";
+
+/**
+ * @typedef PdfToHtmlOptions
+ * @property {boolean} [complexOutput] Generate complex output.
+ * @property {boolean} [dataUrls] Use data URLs instead of external images in HTML.
+ * @property {boolean} [exchangePdfLinks] Exchange .pdf links with .html.
+ * @property {boolean} [extractHidden] Force hidden text extraction.
+ * @property {number} [firstPageToConvert] First page to print.
+ * @property {boolean} [fontFullName] Outputs the font name without any substitutions.
+ * @property {boolean} [ignoreImages] Ignore images.
+ * @property {('JPG'|'PNG')} [imageFormat] Image file format for Splash output (JPG or PNG).
+ * If `options.complexOutput` is enabled, but `options.imageFormat` is not specified, PNG will be assumed.
+ * @property {number} [lastPageToConvert] Last page to print.
+ * @property {boolean} [noDrm] Override document DRM settings.
+ * @property {boolean} [noFrames] Generate no frames. Not supported in complex output mode.
+ * @property {boolean} [noMergeParagraph] Do not merge paragraphs.
+ * @property {boolean} [noRoundedCoordinates] Do not round coordinates
+ * (with XML output only).
+ * @property {string} [outputEncoding] Sets the encoding to use for text output.
+ * This defaults to `'UTF-8'`.
+ * @property {string} [ownerPassword] Owner password (for encrypted files).
+ * @property {boolean} [printVersionInfo] Print copyright and version info.
+ * @property {boolean} [quiet] Do not print any messages or errors.
+ * @property {boolean} [singlePage] Generate single HTML that includes all pages.
+ * @property {boolean} [stdout] Use standard output.
+ * @property {string} [userPassword] User password (for encrypted files).
+ * @property {number} [wordBreakThreshold] 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.
+ * @property {boolean} [xmlOutput] Output for XML post-processing.
+ * @property {number} [zoom] Zoom the PDF document (default `1.5`).
+ */
+
+/** @type {Record<keyof PdfToHtmlOptions, import("../index").OptionDetails>} */
+module.exports = {
+	complexOutput: { arg: "-c", type: "boolean" },
+	dataUrls: { arg: "-dataurls", type: "boolean", minVersion: "0.75.0" },
+	exchangePdfLinks: { arg: "-p", type: "boolean" },
+	extractHidden: { arg: "-hidden", type: "boolean" },
+	firstPageToConvert: { arg: "-f", type: "number" },
+	fontFullName: {
+		arg: "-fontfullname",
+		type: "boolean",
+		minVersion: "0.21.0",
+	},
+	ignoreImages: { arg: "-i", type: "boolean" },
+	imageFormat: { arg: "-fmt", type: "string" },
+	lastPageToConvert: { arg: "-l", type: "number" },
+	noDrm: { arg: "-nodrm", type: "boolean" },
+	noFrames: { arg: "-noframes", type: "boolean" },
+	noMergeParagraph: {
+		arg: "-nomerge",
+		type: "boolean",
+	},
+	noRoundedCoordinates: {
+		arg: "-noroundcoord",
+		type: "boolean",
+		minVersion: "0.68.0",
+	},
+	outputEncoding: { arg: "-enc", type: "string" },
+	ownerPassword: { arg: "-opw", type: "string" },
+	printVersionInfo: { arg: "-v", type: "boolean" },
+	quiet: { arg: "-q", type: "boolean" },
+	singlePage: { arg: "-s", type: "boolean", minVersion: "0.15.1" },
+	stdout: { arg: "-stdout", type: "boolean" },
+	userPassword: { arg: "-upw", type: "string" },
+	wordBreakThreshold: { arg: "-wbt", type: "number" },
+	xmlOutput: { arg: "-xml", type: "boolean" },
+	zoom: { arg: "-zoom", type: "number" },
+};

package/src/options/pdftoppm.js

@@ -0,0 +1,171 @@
+"use strict";
+
+/**
+ * @typedef PdfToPpmOptions
+ * @property {('no'|'yes')} [antialiasFonts] Enable or disable font anti-aliasing.
+ * This defaults to `'yes'`.
+ * @property {('no'|'yes')} [antialiasVectors] Enable or disable vector anti-aliasing.
+ * This defaults to `'yes'`.
+ * @property {boolean} [cropBox] Uses the crop box rather than media box when
+ * generating the files (PNG/JPEG/TIFF only).
+ * @property {number} [cropHeight] Specifies the height of crop area in pixels
+ * (image output) or points (vector output).
+ * @property {number} [cropSize] Specifies the size of crop square in pixels
+ * (image output) or points (vector output).
+ * @property {number} [cropWidth] Specifies the width of crop area in pixels
+ * (image output) or points (vector output).
+ * @property {number} [cropXAxis] Specifies the x-coordinate of the crop area top left
+ * corner in pixels (image output) or points (vector output).
+ * @property {number} [cropYAxis] Specifies the y-coordinate of the crop area top left
+ * corner in pixels (image output) or points (vector output).
+ * @property {string} [defaultCmykProfile] 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.
+ * @property {string} [defaultGrayProfile] 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.
+ * @property {string} [defaultRgbProfile] 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.
+ * @property {string} [displayProfile] 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.
+ * @property {boolean} [evenPagesOnly] Generates only the even numbered pages.
+ * @property {number} [firstPageToConvert] Specifies the first page to convert.
+ * @property {('no'|'yes')} [freetype] Enable or disable FreeType (a TrueType / Type 1 font rasterizer).
+ * This defaults to `'yes'`.
+ * @property {boolean} [forcePageNumber] Force page number even if there is only one page.
+ * @property {boolean} [grayscaleFile] Generate grayscale PGM file (instead of a color PPM file).
+ * @property {boolean} [hideAnnotations] Hide annotations.
+ * @property {boolean} [jpegCmyk] Generate a CMYK JPEG file.
+ * @property {boolean} [jpegFile] Generate JPEG file instead of a PPM file.
+ * @property {string} [jpegOptions] 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
+ * @property {number} [lastPageToConvert] Specifies the last page to convert.
+ * @property {boolean} [monochromeFile] Generate monochrome PBM file (instead of a color PPM file).
+ * @property {boolean} [oddPagesOnly] Generates only the odd numbered pages.
+ * @property {string} [ownerPassword] Specify the owner password for the PDF file.
+ * Providing this will bypass all security restrictions.
+ * @property {boolean} [overprint] Enable overprint emulation during rasterization.
+ * @property {boolean} [pngFile] Generate PNG file instead of a PPM file.
+ * @property {boolean} [printProgress] 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.
+ * @property {boolean} [printVersionInfo] Print copyright and version information.
+ * @property {boolean} [quiet] Do not print any messages or errors.
+ * @property {number} [resolutionXAxis] Specifies the X resolution, in pixels per inch of
+ * image files (or rasterized regions in vector output). The default is `150` PPI.
+ * @property {number} [resolutionXYAxis] Specifies the X and Y resolution, in pixels per
+ * inch of image files (or rasterized regions in vector output). The default is `150` PPI.
+ * @property {number} [resolutionYAxis] Specifies the Y resolution, in pixels per inch of
+ * image files (or rasterized regions in vector output). The default is `150` PPI.
+ * @property {boolean} [scaleDimensionBeforeRotation] Swaps horizontal and vertical size for
+ * a rotated (landscape) PDF before scaling instead of after.
+ * @property {number} [scalePageTo] 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.
+ * @property {number} [scalePageToXAxis] 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.
+ * @property {number} [scalePageToYAxis] 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.
+ * @property {string} [separator] Specify single character separator between name and page number.
+ * @property {boolean} [singleFile] Writes only the first page and does not add digits.
+ * @property {('none'|'shape'|'solid')} [thinLineMode] Specifies the thin line mode. This defaults to `'none'`.
+ * @property {('deflate'|'jpeg'|'lzw'|'none'|'packbits')} [tiffCompression] Set TIFF compression.
+ * @property {boolean} [tiffFile] Generate TIFF file instead of a PPM file.
+ * @property {string} [userPassword] Specify the user password for the PDF file.
+ */
+
+/** @type {Record<keyof PdfToPpmOptions, import("../index").OptionDetails>} */
+module.exports = {
+	antialiasFonts: { arg: "-aa", type: "string" },
+	antialiasVectors: {
+		arg: "-aaVector",
+		type: "string",
+	},
+	cropBox: { arg: "-cropbox", type: "boolean", minVersion: "0.11.0" },
+	cropHeight: { arg: "-H", type: "number" },
+	cropSize: { arg: "-sz", type: "number" },
+	cropWidth: { arg: "-W", type: "number" },
+	cropXAxis: { arg: "-x", type: "number" },
+	cropYAxis: { arg: "-y", type: "number" },
+	defaultCmykProfile: {
+		arg: "-defaultcmykprofile",
+		type: "string",
+		minVersion: "21.01.0",
+	},
+	defaultGrayProfile: {
+		arg: "-defaultgrayprofile",
+		type: "string",
+		minVersion: "21.01.0",
+	},
+	defaultRgbProfile: {
+		arg: "-defaultrgbprofile",
+		type: "string",
+		minVersion: "21.01.0",
+	},
+	displayProfile: {
+		arg: "-displayprofile",
+		type: "string",
+		minVersion: "0.90.0",
+	},
+	evenPagesOnly: { arg: "-e", type: "boolean", minVersion: "0.13.3" },
+	firstPageToConvert: { arg: "-f", type: "number" },
+	forcePageNumber: {
+		arg: "-forcenum",
+		type: "boolean",
+		minVersion: "0.75.0",
+	},
+	freetype: { arg: "-freetype", type: "string" },
+	grayscaleFile: { arg: "-gray", type: "boolean" },
+	hideAnnotations: {
+		arg: "-hide-annotations",
+		type: "boolean",
+		minVersion: "0.84.0",
+	},
+	jpegCmyk: { arg: "-jpegcmyk", type: "boolean" },
+	jpegFile: { arg: "-jpeg", type: "boolean", minVersion: "0.13.0" },
+	jpegOptions: { arg: "-jpegopt", type: "string", minVersion: "0.58.0" },
+	lastPageToConvert: { arg: "-l", type: "number" },
+	monochromeFile: { arg: "-mono", type: "boolean" },
+	oddPagesOnly: { arg: "-o", type: "boolean", minVersion: "0.13.3" },
+	overprint: { arg: "-overprint", type: "boolean" },
+	ownerPassword: { arg: "-opw", type: "string" },
+	pngFile: { arg: "-png", type: "boolean", minVersion: "0.11.3" },
+	printProgress: { arg: "-progress", type: "boolean", minVersion: "21.03.0" },
+	printVersionInfo: { arg: "-v", type: "boolean" },
+	quiet: { arg: "-q", type: "boolean" },
+	resolutionXAxis: { arg: "-rx", type: "number" },
+	resolutionXYAxis: { arg: "-r", type: "number" },
+	resolutionYAxis: { arg: "-ry", type: "number" },
+	scaleDimensionBeforeRotation: {
+		arg: "-scale-dimension-before-rotation",
+		type: "boolean",
+		minVersion: "0.84.0",
+	},
+	scalePageTo: { arg: "-scale-to", type: "number" },
+	scalePageToXAxis: {
+		arg: "-scale-to-x",
+		type: "number",
+	},
+	scalePageToYAxis: {
+		arg: "-scale-to-y",
+		type: "number",
+	},
+	separator: { arg: "-sep", type: "string", minVersion: "0.75.0" },
+	singleFile: { arg: "-singlefile", type: "boolean", minVersion: "0.17.0" },
+	thinLineMode: {
+		arg: "-thinlinemode",
+		type: "string",
+		minVersion: "0.25.0",
+	},
+	tiffCompression: {
+		arg: "-tiffcompression",
+		type: "string",
+		minVersion: "0.17.0",
+	},
+	tiffFile: { arg: "-tiff", type: "boolean", minVersion: "0.17.0" },
+	userPassword: { arg: "-upw", type: "string" },
+};