reamkit 1.25.1 → 1.27.0

package/dist/esm/pdf-reader/glyph-names.js

@@ -0,0 +1,408 @@
+//#region src/pdf-reader/glyph-names.ts
+/** Glyph name → the text it stands for. */
+var GLYPHS = {
+	AE: "Æ",
+	Aacute: "Á",
+	Abreve: "Ă",
+	Acaron: "Ǎ",
+	Acircumflex: "Â",
+	Adieresis: "Ä",
+	Adotaccent: "Ȧ",
+	Agrave: "À",
+	Amacron: "Ā",
+	Aogonek: "Ą",
+	Aring: "Å",
+	Atilde: "Ã",
+	Bdotaccent: "Ḃ",
+	Cacute: "Ć",
+	Ccaron: "Č",
+	Ccedilla: "Ç",
+	Ccircumflex: "Ĉ",
+	Cdotaccent: "Ċ",
+	Dcaron: "Ď",
+	Dcedilla: "Ḑ",
+	Ddotaccent: "Ḋ",
+	Eacute: "É",
+	Ebreve: "Ĕ",
+	Ecaron: "Ě",
+	Ecedilla: "Ȩ",
+	Ecircumflex: "Ê",
+	Edieresis: "Ë",
+	Edotaccent: "Ė",
+	Egrave: "È",
+	Emacron: "Ē",
+	Eogonek: "Ę",
+	Eth: "Ð",
+	Etilde: "Ẽ",
+	Euro: "€",
+	Fdotaccent: "Ḟ",
+	Gacute: "Ǵ",
+	Gbreve: "Ğ",
+	Gcaron: "Ǧ",
+	Gcedilla: "Ģ",
+	Gcircumflex: "Ĝ",
+	Gdotaccent: "Ġ",
+	Gmacron: "Ḡ",
+	Hcaron: "Ȟ",
+	Hcedilla: "Ḩ",
+	Hcircumflex: "Ĥ",
+	Hdieresis: "Ḧ",
+	Hdotaccent: "Ḣ",
+	Iacute: "Í",
+	Ibreve: "Ĭ",
+	Icaron: "Ǐ",
+	Icircumflex: "Î",
+	Idieresis: "Ï",
+	Idotaccent: "İ",
+	Igrave: "Ì",
+	Imacron: "Ī",
+	Iogonek: "Į",
+	Itilde: "Ĩ",
+	Jcircumflex: "Ĵ",
+	Kacute: "Ḱ",
+	Kcaron: "Ǩ",
+	Kcedilla: "Ķ",
+	Lacute: "Ĺ",
+	Lcaron: "Ľ",
+	Lcedilla: "Ļ",
+	Macute: "Ḿ",
+	Mdotaccent: "Ṁ",
+	Nacute: "Ń",
+	Ncaron: "Ň",
+	Ncedilla: "Ņ",
+	Ndotaccent: "Ṅ",
+	Ngrave: "Ǹ",
+	Ntilde: "Ñ",
+	OE: "Œ",
+	Oacute: "Ó",
+	Obreve: "Ŏ",
+	Ocaron: "Ǒ",
+	Ocircumflex: "Ô",
+	Odieresis: "Ö",
+	Odotaccent: "Ȯ",
+	Ograve: "Ò",
+	Ohungarumlaut: "Ő",
+	Omacron: "Ō",
+	Oogonek: "Ǫ",
+	Oslash: "Ø",
+	Otilde: "Õ",
+	Pacute: "Ṕ",
+	Pdotaccent: "Ṗ",
+	Racute: "Ŕ",
+	Rcaron: "Ř",
+	Rcedilla: "Ŗ",
+	Rdotaccent: "Ṙ",
+	Sacute: "Ś",
+	Scaron: "Š",
+	Scedilla: "Ş",
+	Scircumflex: "Ŝ",
+	Sdotaccent: "Ṡ",
+	Tcaron: "Ť",
+	Tcedilla: "Ţ",
+	Tdotaccent: "Ṫ",
+	Thorn: "Þ",
+	Uacute: "Ú",
+	Ubreve: "Ŭ",
+	Ucaron: "Ǔ",
+	Ucircumflex: "Û",
+	Udieresis: "Ü",
+	Ugrave: "Ù",
+	Uhungarumlaut: "Ű",
+	Umacron: "Ū",
+	Uogonek: "Ų",
+	Uring: "Ů",
+	Utilde: "Ũ",
+	Vtilde: "Ṽ",
+	Wacute: "Ẃ",
+	Wcircumflex: "Ŵ",
+	Wdieresis: "Ẅ",
+	Wdotaccent: "Ẇ",
+	Wgrave: "Ẁ",
+	Xdieresis: "Ẍ",
+	Xdotaccent: "Ẋ",
+	Yacute: "Ý",
+	Ycircumflex: "Ŷ",
+	Ydieresis: "Ÿ",
+	Ydotaccent: "Ẏ",
+	Ygrave: "Ỳ",
+	Ymacron: "Ȳ",
+	Ytilde: "Ỹ",
+	Zacute: "Ź",
+	Zcaron: "Ž",
+	Zcircumflex: "Ẑ",
+	Zdotaccent: "Ż",
+	aacute: "á",
+	abreve: "ă",
+	acaron: "ǎ",
+	acircumflex: "â",
+	acute: "´",
+	adieresis: "ä",
+	adotaccent: "ȧ",
+	ae: "æ",
+	agrave: "à",
+	amacron: "ā",
+	ampersand: "&",
+	aogonek: "ą",
+	aring: "å",
+	asciicircum: "^",
+	asciitilde: "~",
+	asterisk: "*",
+	at: "@",
+	atilde: "ã",
+	backslash: "\\",
+	bar: "|",
+	bdotaccent: "ḃ",
+	braceleft: "{",
+	braceright: "}",
+	bracketleft: "[",
+	bracketright: "]",
+	breve: "˘",
+	brokenbar: "¦",
+	bullet: "•",
+	cacute: "ć",
+	caron: "ˇ",
+	ccaron: "č",
+	ccedilla: "ç",
+	ccircumflex: "ĉ",
+	cdotaccent: "ċ",
+	cedilla: "¸",
+	cent: "¢",
+	circumflex: "ˆ",
+	colon: ":",
+	comma: ",",
+	copyright: "©",
+	currency: "¤",
+	dagger: "†",
+	daggerdbl: "‡",
+	dcaron: "ď",
+	dcedilla: "ḑ",
+	ddotaccent: "ḋ",
+	degree: "°",
+	dieresis: "¨",
+	divide: "÷",
+	dollar: "$",
+	dotaccent: "˙",
+	dotlessi: "ı",
+	eacute: "é",
+	ebreve: "ĕ",
+	ecaron: "ě",
+	ecedilla: "ȩ",
+	ecircumflex: "ê",
+	edieresis: "ë",
+	edotaccent: "ė",
+	egrave: "è",
+	eight: "8",
+	ellipsis: "…",
+	emacron: "ē",
+	emdash: "—",
+	endash: "–",
+	eogonek: "ę",
+	equal: "=",
+	eth: "ð",
+	etilde: "ẽ",
+	euro: "€",
+	exclam: "!",
+	exclamdown: "¡",
+	fdotaccent: "ḟ",
+	ff: "ff",
+	ffi: "ffi",
+	ffl: "ffl",
+	fi: "fi",
+	five: "5",
+	fl: "fl",
+	florin: "ƒ",
+	four: "4",
+	fraction: "⁄",
+	gacute: "ǵ",
+	gbreve: "ğ",
+	gcaron: "ǧ",
+	gcedilla: "ģ",
+	gcircumflex: "ĝ",
+	gdotaccent: "ġ",
+	germandbls: "ß",
+	gmacron: "ḡ",
+	grave: "`",
+	greater: ">",
+	guillemotleft: "«",
+	guillemotright: "»",
+	guilsinglleft: "‹",
+	guilsinglright: "›",
+	hcaron: "ȟ",
+	hcedilla: "ḩ",
+	hcircumflex: "ĥ",
+	hdieresis: "ḧ",
+	hdotaccent: "ḣ",
+	hungarumlaut: "˝",
+	hyphen: "-",
+	iacute: "í",
+	ibreve: "ĭ",
+	icaron: "ǐ",
+	icircumflex: "î",
+	idieresis: "ï",
+	igrave: "ì",
+	imacron: "ī",
+	iogonek: "į",
+	itilde: "ĩ",
+	jcaron: "ǰ",
+	jcircumflex: "ĵ",
+	kacute: "ḱ",
+	kcaron: "ǩ",
+	kcedilla: "ķ",
+	lacute: "ĺ",
+	lcaron: "ľ",
+	lcedilla: "ļ",
+	less: "<",
+	logicalnot: "¬",
+	macron: "¯",
+	macute: "ḿ",
+	mdotaccent: "ṁ",
+	minus: "−",
+	mu: "µ",
+	multiply: "×",
+	nacute: "ń",
+	nbspace: "\xA0",
+	ncaron: "ň",
+	ncedilla: "ņ",
+	ndotaccent: "ṅ",
+	ngrave: "ǹ",
+	nine: "9",
+	ntilde: "ñ",
+	numbersign: "#",
+	oacute: "ó",
+	obreve: "ŏ",
+	ocaron: "ǒ",
+	ocircumflex: "ô",
+	odieresis: "ö",
+	odotaccent: "ȯ",
+	oe: "œ",
+	ogonek: "˛",
+	ograve: "ò",
+	ohungarumlaut: "ő",
+	omacron: "ō",
+	one: "1",
+	onehalf: "½",
+	onequarter: "¼",
+	onesuperior: "¹",
+	oogonek: "ǫ",
+	ordfeminine: "ª",
+	ordmasculine: "º",
+	oslash: "ø",
+	otilde: "õ",
+	pacute: "ṕ",
+	paragraph: "¶",
+	parenleft: "(",
+	parenright: ")",
+	pdotaccent: "ṗ",
+	percent: "%",
+	period: ".",
+	perthousand: "‰",
+	plus: "+",
+	plusminus: "±",
+	question: "?",
+	questiondown: "¿",
+	quotedbl: "\"",
+	quotedblbase: "„",
+	quotedblleft: "“",
+	quotedblright: "”",
+	quoteleft: "‘",
+	quoteright: "’",
+	quotesinglbase: "‚",
+	quotesingle: "'",
+	racute: "ŕ",
+	rcaron: "ř",
+	rcedilla: "ŗ",
+	rdotaccent: "ṙ",
+	registered: "®",
+	ring: "˚",
+	sacute: "ś",
+	scaron: "š",
+	scedilla: "ş",
+	scircumflex: "ŝ",
+	sdotaccent: "ṡ",
+	section: "§",
+	semicolon: ";",
+	seven: "7",
+	sfthyphen: "­",
+	six: "6",
+	slash: "/",
+	softhyphen: "­",
+	space: " ",
+	sterling: "£",
+	tcaron: "ť",
+	tcedilla: "ţ",
+	tdieresis: "ẗ",
+	tdotaccent: "ṫ",
+	thorn: "þ",
+	three: "3",
+	threequarters: "¾",
+	threesuperior: "³",
+	tilde: "˜",
+	trademark: "™",
+	two: "2",
+	twosuperior: "²",
+	uacute: "ú",
+	ubreve: "ŭ",
+	ucaron: "ǔ",
+	ucircumflex: "û",
+	udieresis: "ü",
+	ugrave: "ù",
+	uhungarumlaut: "ű",
+	umacron: "ū",
+	underscore: "_",
+	uogonek: "ų",
+	uring: "ů",
+	utilde: "ũ",
+	vtilde: "ṽ",
+	wacute: "ẃ",
+	wcircumflex: "ŵ",
+	wdieresis: "ẅ",
+	wdotaccent: "ẇ",
+	wgrave: "ẁ",
+	wring: "ẘ",
+	xdieresis: "ẍ",
+	xdotaccent: "ẋ",
+	yacute: "ý",
+	ycircumflex: "ŷ",
+	ydieresis: "ÿ",
+	ydotaccent: "ẏ",
+	yen: "¥",
+	ygrave: "ỳ",
+	ymacron: "ȳ",
+	yring: "ẙ",
+	ytilde: "ỹ",
+	zacute: "ź",
+	zcaron: "ž",
+	zcircumflex: "ẑ",
+	zdotaccent: "ż",
+	zero: "0"
+};
+/**
+* The text a glyph name stands for, or `undefined` when the name says nothing.
+*
+* @param name The name as `/Differences` (or a font program's charset) gives it.
+*/
+function textForGlyphName(name) {
+	const base = name.includes(".") ? name.split(".")[0] ?? name : name;
+	if (base === "") return void 0;
+	if (base.includes("_")) {
+		const parts = base.split("_").map((p) => textForGlyphName(p));
+		return parts.every((p) => p !== void 0) ? parts.join("") : void 0;
+	}
+	const known = GLYPHS[base];
+	if (known !== void 0) return known;
+	if (base.length === 1) return base;
+	const uni = /^uni((?:[0-9A-Fa-f]{4})+)$/u.exec(base);
+	if (uni) {
+		const hex = uni[1];
+		let out = "";
+		for (let i = 0; i < hex.length; i += 4) out += String.fromCodePoint(parseInt(hex.slice(i, i + 4), 16));
+		return out;
+	}
+	const u = /^u([0-9A-Fa-f]{4,6})$/u.exec(base);
+	if (u) {
+		const cp = parseInt(u[1], 16);
+		return cp <= 1114111 ? String.fromCodePoint(cp) : void 0;
+	}
+}
+//#endregion
+export { textForGlyphName };

package/dist/esm/pdf-reader/image-decode.d.ts

@@ -27,10 +27,14 @@ export type DecodedImage = {
  * Supports DeviceGray/RGB/CMYK, CalGray/CalRGB, ICCBased (by `/N`) and Indexed
  * colour spaces; Flate, LZW (EP12), RunLength, ASCII85, ASCIIHex and CCITT
  * Group 4 / Group 3 1-D fax (EP15) filters; PNG/TIFF predictors; bit depths
- * 1/2/4/8/16; and an `/SMask` folded in as the PNG alpha channel. Unsupported
- * inputs (stencil `/ImageMask`, Separation/DeviceN/Lab, JBIG2, CCITT Group 3
- * 2-D) return a typed failure so the caller records a loss.
+ * 1/2/4/8/16; an `/SMask` folded in as the PNG alpha channel; and a stencil
+ * `/ImageMask` (§8.9.6.2) given back as RGBA in `fillHex`. Unsupported inputs
+ * (Separation/DeviceN/Lab, CCITT Group 3 2-D) return a typed failure so the
+ * caller records a loss.
  *
+ * @param file    The owning file.
+ * @param stream  The image XObject, or an inline image wrapped as one.
+ * @param fillHex §8.9.6.2 — the non-stroking colour a stencil mask paints in.
  * @returns The decoded image, or `{ ok: false }` with the loss severity and reason.
  */
-export declare function decodePdfImage(file: PdfFile, stream: PdfStream): DecodedImage;
+export declare function decodePdfImage(file: PdfFile, stream: PdfStream, fillHex?: string): DecodedImage;