reamkit 1.30.0 → 1.31.0

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

@@ -10,16 +10,19 @@ var GLYPHS = {
 	Adieresis: "Ä",
 	Adotaccent: "Ȧ",
 	Agrave: "À",
+	Alpha: "Α",
 	Amacron: "Ā",
 	Aogonek: "Ą",
 	Aring: "Å",
 	Atilde: "Ã",
 	Bdotaccent: "Ḃ",
+	Beta: "Β",
 	Cacute: "Ć",
 	Ccaron: "Č",
 	Ccedilla: "Ç",
 	Ccircumflex: "Ĉ",
 	Cdotaccent: "Ċ",
+	Chi: "Χ",
 	Dcaron: "Ď",
 	Dcedilla: "Ḑ",
 	Ddotaccent: "Ḋ",
@@ -34,11 +37,14 @@ var GLYPHS = {
 	Egrave: "È",
 	Emacron: "Ē",
 	Eogonek: "Ę",
+	Epsilon: "Ε",
+	Eta: "Η",
 	Eth: "Ð",
 	Etilde: "Ẽ",
 	Euro: "€",
 	Fdotaccent: "Ḟ",
 	Gacute: "Ǵ",
+	Gamma: "Γ",
 	Gbreve: "Ğ",
 	Gcaron: "Ǧ",
 	Gcedilla: "Ģ",
@@ -56,26 +62,32 @@ var GLYPHS = {
 	Icircumflex: "Î",
 	Idieresis: "Ï",
 	Idotaccent: "İ",
+	Ifractur: "ℑ",
 	Igrave: "Ì",
 	Imacron: "Ī",
 	Iogonek: "Į",
+	Iota: "Ι",
 	Itilde: "Ĩ",
 	Jcircumflex: "Ĵ",
 	Kacute: "Ḱ",
+	Kappa: "Κ",
 	Kcaron: "Ǩ",
 	Kcedilla: "Ķ",
 	Lacute: "Ĺ",
+	Lambda: "Λ",
 	Lcaron: "Ľ",
 	Lcedilla: "Ļ",
 	Lslash: "Ł",
 	Macute: "Ḿ",
 	Mdotaccent: "Ṁ",
+	Mu: "Μ",
 	Nacute: "Ń",
 	Ncaron: "Ň",
 	Ncedilla: "Ņ",
 	Ndotaccent: "Ṅ",
 	Ngrave: "Ǹ",
 	Ntilde: "Ñ",
+	Nu: "Ν",
 	OE: "Œ",
 	Oacute: "Ó",
 	Obreve: "Ŏ",
@@ -87,23 +99,32 @@ var GLYPHS = {
 	Ohungarumlaut: "Ő",
 	Omacron: "Ō",
 	Omega: "Ω",
+	Omicron: "Ο",
 	Oogonek: "Ǫ",
 	Oslash: "Ø",
 	Otilde: "Õ",
 	Pacute: "Ṕ",
 	Pdotaccent: "Ṗ",
+	Phi: "Φ",
+	Pi: "Π",
+	Psi: "Ψ",
 	Racute: "Ŕ",
 	Rcaron: "Ř",
 	Rcedilla: "Ŗ",
 	Rdotaccent: "Ṙ",
+	Rfractur: "ℜ",
+	Rho: "Ρ",
 	Sacute: "Ś",
 	Scaron: "Š",
 	Scedilla: "Ş",
 	Scircumflex: "Ŝ",
 	Sdotaccent: "Ṡ",
+	Sigma: "Σ",
+	Tau: "Τ",
 	Tcaron: "Ť",
 	Tcedilla: "Ţ",
 	Tdotaccent: "Ṫ",
+	Theta: "Θ",
 	Thorn: "Þ",
 	Uacute: "Ú",
 	Ubreve: "Ŭ",
@@ -114,6 +135,8 @@ var GLYPHS = {
 	Uhungarumlaut: "Ű",
 	Umacron: "Ū",
 	Uogonek: "Ų",
+	Upsilon: "Υ",
+	Upsilon1: "ϒ",
 	Uring: "Ů",
 	Utilde: "Ũ",
 	Vtilde: "Ṽ",
@@ -124,6 +147,7 @@ var GLYPHS = {
 	Wgrave: "Ẁ",
 	Xdieresis: "Ẍ",
 	Xdotaccent: "Ẋ",
+	Xi: "Ξ",
 	Yacute: "Ý",
 	Ycircumflex: "Ŷ",
 	Ydieresis: "Ÿ",
@@ -135,6 +159,7 @@ var GLYPHS = {
 	Zcaron: "Ž",
 	Zcircumflex: "Ẑ",
 	Zdotaccent: "Ż",
+	Zeta: "Ζ",
 	aacute: "á",
 	abreve: "ă",
 	acaron: "ǎ",
@@ -144,19 +169,46 @@ var GLYPHS = {
 	adotaccent: "ȧ",
 	ae: "æ",
 	agrave: "à",
+	aleph: "ℵ",
+	alpha: "α",
 	amacron: "ā",
 	ampersand: "&",
+	angbracketleft: "⟨",
+	angbracketright: "⟩",
+	angle: "∠",
+	angleleft: "〈",
+	angleright: "〉",
 	aogonek: "ą",
 	approxequal: "≈",
 	aring: "å",
+	arrowboth: "↔",
+	arrowbothv: "↕",
+	arrowdblboth: "⇔",
+	arrowdblbothv: "⇕",
+	arrowdbldown: "⇓",
+	arrowdblleft: "⇐",
+	arrowdblright: "⇒",
+	arrowdblup: "⇑",
+	arrowdown: "↓",
+	arrowleft: "←",
+	arrownortheast: "↗",
+	arrownorthwest: "↖",
+	arrowright: "→",
+	arrowsoutheast: "↘",
+	arrowsouthwest: "↙",
+	arrowup: "↑",
+	arrowupdn: "↕",
 	asciicircum: "^",
 	asciitilde: "~",
 	asterisk: "*",
+	asteriskmath: "∗",
 	at: "@",
 	atilde: "ã",
 	backslash: "\\",
 	bar: "|",
+	bardbl: "‖",
 	bdotaccent: "ḃ",
+	beta: "β",
 	braceleft: "{",
 	braceright: "}",
 	bracketleft: "[",
@@ -171,10 +223,22 @@ var GLYPHS = {
 	ccircumflex: "ĉ",
 	cdotaccent: "ċ",
 	cedilla: "¸",
+	ceilingleft: "⌈",
+	ceilingright: "⌉",
 	cent: "¢",
+	chi: "χ",
+	circlecopyrt: "◯",
+	circledivide: "⊘",
+	circledot: "⊙",
+	circleminus: "⊖",
+	circlemultiply: "⊗",
+	circleplus: "⊕",
 	circumflex: "ˆ",
+	club: "♣",
 	colon: ":",
 	comma: ",",
+	congruent: "≅",
+	coproduct: "⨿",
 	copyright: "©",
 	currency: "¤",
 	dagger: "†",
@@ -183,11 +247,16 @@ var GLYPHS = {
 	dcedilla: "ḑ",
 	ddotaccent: "ḋ",
 	degree: "°",
+	delta: "δ",
+	diamond: "♢",
+	diamondmath: "⋄",
 	dieresis: "¨",
 	divide: "÷",
 	dollar: "$",
 	dotaccent: "˙",
 	dotlessi: "ı",
+	dotlessj: "ȷ",
+	dotmath: "⋅",
 	eacute: "é",
 	ebreve: "ĕ",
 	ecaron: "ě",
@@ -197,17 +266,25 @@ var GLYPHS = {
 	edotaccent: "ė",
 	egrave: "è",
 	eight: "8",
+	element: "∈",
 	ellipsis: "…",
 	emacron: "ē",
 	emdash: "—",
+	emptyset: "∅",
 	endash: "–",
 	eogonek: "ę",
+	epsilon: "ε",
+	epsilon1: "ϵ",
 	equal: "=",
+	equivalence: "≡",
+	equivasymptotic: "≍",
+	eta: "η",
 	eth: "ð",
 	etilde: "ẽ",
 	euro: "€",
 	exclam: "!",
 	exclamdown: "¡",
+	existential: "∃",
 	fdotaccent: "ḟ",
 	ff: "ff",
 	ffi: "ffi",
@@ -215,10 +292,16 @@ var GLYPHS = {
 	fi: "fi",
 	five: "5",
 	fl: "fl",
+	flat: "♭",
+	floorleft: "⌊",
+	floorright: "⌋",
 	florin: "ƒ",
+	follows: "≻",
+	followsequal: "⪰",
 	four: "4",
 	fraction: "⁄",
 	gacute: "ǵ",
+	gamma: "γ",
 	gbreve: "ğ",
 	gcaron: "ǧ",
 	gcedilla: "ģ",
@@ -226,9 +309,11 @@ var GLYPHS = {
 	gdotaccent: "ġ",
 	germandbls: "ß",
 	gmacron: "ḡ",
+	gradient: "∇",
 	grave: "`",
 	greater: ">",
 	greaterequal: "≥",
+	greatermuch: "≫",
 	guillemotleft: "«",
 	guillemotright: "»",
 	guilsinglleft: "‹",
@@ -238,6 +323,7 @@ var GLYPHS = {
 	hcircumflex: "ĥ",
 	hdieresis: "ḧ",
 	hdotaccent: "ḣ",
+	heart: "♡",
 	hungarumlaut: "˝",
 	hyphen: "-",
 	iacute: "í",
@@ -249,36 +335,54 @@ var GLYPHS = {
 	infinity: "∞",
 	integral: "∫",
 	imacron: "ī",
+	intersection: "∩",
+	intersectionsq: "⊓",
 	iogonek: "į",
+	iota: "ι",
 	itilde: "ĩ",
 	jcaron: "ǰ",
 	jcircumflex: "ĵ",
 	kacute: "ḱ",
+	kappa: "κ",
 	kcaron: "ǩ",
 	kcedilla: "ķ",
 	lacute: "ĺ",
+	lambda: "λ",
+	latticetop: "⊤",
 	lcaron: "ľ",
 	lcedilla: "ļ",
 	less: "<",
 	lessequal: "≤",
+	lessmuch: "≪",
+	logicaland: "∧",
 	logicalnot: "¬",
+	logicalor: "∨",
 	lozenge: "◊",
+	lscript: "ℓ",
 	lslash: "ł",
 	macron: "¯",
 	macute: "ḿ",
+	mapsto: "↦",
 	mdotaccent: "ṁ",
 	minus: "−",
+	minusplus: "∓",
 	mu: "µ",
 	multiply: "×",
+	nabla: "∇",
 	nacute: "ń",
+	natural: "♮",
 	nbspace: "\xA0",
 	ncaron: "ň",
 	ncedilla: "ņ",
 	ndotaccent: "ṅ",
+	negationslash: "̸",
 	ngrave: "ǹ",
 	nine: "9",
+	notelement: "∉",
 	notequal: "≠",
+	notsubset: "⊄",
 	ntilde: "ñ",
+	nu: "ν",
 	numbersign: "#",
 	oacute: "ó",
 	obreve: "ŏ",
@@ -291,15 +395,20 @@ var GLYPHS = {
 	ograve: "ò",
 	ohungarumlaut: "ő",
 	omacron: "ō",
+	omega: "ω",
+	omega1: "ϖ",
+	omicron: "ο",
 	one: "1",
 	onehalf: "½",
 	onequarter: "¼",
 	onesuperior: "¹",
 	oogonek: "ǫ",
+	openbullet: "◦",
 	ordfeminine: "ª",
 	ordmasculine: "º",
 	oslash: "ø",
 	otilde: "õ",
+	owner: "∋",
 	pacute: "ṕ",
 	paragraph: "¶",
 	parenleft: "(",
@@ -309,11 +418,22 @@ var GLYPHS = {
 	percent: "%",
 	period: ".",
 	periodcentered: "·",
+	perpendicular: "⊥",
 	perthousand: "‰",
+	phi: "φ",
+	phi1: "ϕ",
 	pi: "π",
+	pi1: "ϖ",
 	plus: "+",
 	plusminus: "±",
+	precedes: "≺",
+	precedesequal: "⪯",
+	prime: "′",
 	product: "∏",
+	propersubset: "⊂",
+	propersuperset: "⊃",
+	proportional: "∝",
+	psi: "ψ",
 	question: "?",
 	questiondown: "¿",
 	quotedbl: "\"",
@@ -329,7 +449,11 @@ var GLYPHS = {
 	rcaron: "ř",
 	rcedilla: "ŗ",
 	rdotaccent: "ṙ",
+	reflexsubset: "⊆",
+	reflexsuperset: "⊇",
 	registered: "®",
+	rho: "ρ",
+	rho1: "ϱ",
 	ring: "˚",
 	sacute: "ś",
 	scaron: "š",
@@ -340,22 +464,42 @@ var GLYPHS = {
 	semicolon: ";",
 	seven: "7",
 	sfthyphen: "­",
+	sharp: "♯",
+	sigma: "σ",
+	sigma1: "ς",
+	similar: "∼",
+	similarequal: "≃",
 	six: "6",
 	slash: "/",
 	softhyphen: "­",
 	space: " ",
+	spade: "♠",
+	star: "⋆",
 	sterling: "£",
+	subsetsqequal: "⊑",
+	suchthat: "∋",
 	summation: "∑",
+	supersetsqequal: "⊒",
+	tau: "τ",
 	tcaron: "ť",
 	tcedilla: "ţ",
 	tdieresis: "ẗ",
 	tdotaccent: "ṫ",
+	therefore: "∴",
+	theta: "θ",
+	theta1: "ϑ",
 	thorn: "þ",
 	three: "3",
 	threequarters: "¾",
 	threesuperior: "³",
 	tilde: "˜",
 	trademark: "™",
+	triangle: "△",
+	triangleinv: "▽",
+	triangleleft: "◁",
+	triangleright: "▷",
+	turnstileleft: "⊢",
+	turnstileright: "⊣",
 	two: "2",
 	twosuperior: "²",
 	uacute: "ú",
@@ -367,7 +511,12 @@ var GLYPHS = {
 	uhungarumlaut: "ű",
 	umacron: "ū",
 	underscore: "_",
+	union: "∪",
+	unionmulti: "⊎",
+	unionsq: "⊔",
+	universal: "∀",
 	uogonek: "ų",
+	upsilon: "υ",
 	uring: "ů",
 	utilde: "ũ",
 	vtilde: "ṽ",
@@ -375,10 +524,13 @@ var GLYPHS = {
 	wcircumflex: "ŵ",
 	wdieresis: "ẅ",
 	wdotaccent: "ẇ",
+	weierstrass: "℘",
 	wgrave: "ẁ",
+	wreathproduct: "≀",
 	wring: "ẘ",
 	xdieresis: "ẍ",
 	xdotaccent: "ẋ",
+	xi: "ξ",
 	yacute: "ý",
 	ycircumflex: "ŷ",
 	ydieresis: "ÿ",
@@ -392,7 +544,8 @@ var GLYPHS = {
 	zcaron: "ž",
 	zcircumflex: "ẑ",
 	zdotaccent: "ż",
-	zero: "0"
+	zero: "0",
+	zeta: "ζ"
 };
 /**
 * The text a glyph name stands for, or `undefined` when the name says nothing.

package/dist/esm/pdf-reader/layout.d.ts

@@ -1,6 +1,14 @@
+import { PageNumbering } from './page-numbers.js';
 import { PdfVector } from './vector.js';
+import { BodyElement, SectionProperties } from '../core/document-model/index.js';
+import { TextRun } from './content.js';
 import { PdfFile } from './document.js';
 import { Reconstruction } from './flow-build.js';
+/** The relationships the reconstruction files its running head and foot under. */
+export declare const FOOTER_PART = "pdf-running-foot";
+/** The part the running foot of a book's even pages is written to (see `sidesOf`). */
+export declare const EVEN_FOOTER_PART = "pdf-running-foot-even";
+export declare const HEADER_PART = "pdf-running-head";
 /** §9.10.2 — a glyph the face maps to no character (see `./font`). */
 export declare const UNMAPPED = "\uFFFD";
 /**
@@ -19,6 +27,20 @@ export declare const UNMAPPED = "\uFFFD";
  * @returns The reconstructed {@link FlowDoc} plus any read-time losses.
  */
 export declare function reconstructByLayout(file: PdfFile, mode?: 'flow' | 'positional'): Reconstruction;
+/** Where the page's text starts and ends, ignoring what is only a space. */
+export declare function pageTextEdges(runs: ReadonlyArray<TextRun>): {
+    left: number;
+    right: number;
+} | undefined;
+/**
+ * Whether this page STEPS between its words rather than writing spaces.
+ *
+ * Counted rather than guessed: bigboundingbox.pdf writes a space in one run in
+ * a hundred, TAMReview.pdf in a third of them, and no page does a little of
+ * both. A page with almost no text says nothing either way and keeps the
+ * cautious reading.
+ */
+export declare function stepsBetweenWords(runs: ReadonlyArray<TextRun>): boolean;
 /**
  * Whether a line ENDED a paragraph, rather than wrapping into the next.
  *
@@ -57,6 +79,77 @@ export declare function endedParagraph(prev: {
     left: number;
     right: number;
 } | undefined): boolean;
+/**
+ * §17.6.13 — the running foot a document repeats at the bottom of its pages.
+ *
+ * A page number, a title, a URL: it stands below the text block, in the margin,
+ * and it is not part of what the page SAYS. Read as body it goes wherever the
+ * reflow puts it — bug1997343.pdf's "1" came out on a sheet of its own between
+ * the two the paper has, and TAMReview.pdf's "Sprouts — http://…" landed in the
+ * middle of the abstract.
+ *
+ * What makes it a running foot is that it RUNS: the same place, page after
+ * page, cut off from the text above it by more than a line of white. One page
+ * proves nothing, so two are asked for.
+ *
+ * @param pageRuns Each page's runs, placed.
+ * @param shown    Each page's shown geometry.
+ * @returns The runs to lift off each page and the band to put them in, or
+ *          `undefined` where the document repeats nothing.
+ */
+export declare function runningFoot(pageRuns: ReadonlyArray<ReadonlyArray<TextRun>>, shown: ReadonlyArray<{
+    height: number;
+}>, where: 'head' | 'foot'): {
+    lift: ReadonlyArray<ReadonlySet<TextRun>>;
+    band: ReadonlyArray<TextRun>;
+    /** Whether a number in it is the PAGE's number rather than part of the text. */
+    numbered: boolean;
+} | undefined;
+/** How many of a document's pages must carry the foot before it is running. */
+/**
+ * §17.6.12 — how a document's pages are numbered, read off the band that
+ * prints their numbers (see ./page-numbers).
+ *
+ * @param band The running head or foot whose numbers change from page to page.
+ * @returns The numbering, or undefined where no band numbers the pages.
+ */
+export declare function numberingOf(band: {
+    readonly lift: ReadonlyArray<ReadonlySet<TextRun>>;
+} | undefined): PageNumbering | undefined;
+/**
+ * The numbering a section opening at `page` states: the numerals of the
+ * sequence the page is counted in, and the number the sequence starts at where
+ * it starts there.
+ *
+ * @param numbering The document's numbering.
+ * @param page      The section's first page.
+ * @returns The section's `pageNumberFormat` and `pageNumberStart`, as needed.
+ */
+export declare function numberedFrom(numbering: PageNumbering | undefined, page: number): Pick<SectionProperties, 'pageNumberFormat' | 'pageNumberStart'>;
+/**
+ * The band itself: the foot's own line, with the number in it made a field.
+ *
+ * §17.16.5.35 — a page number is not the text "1"; it is the number of the page
+ * it is drawn on, which is why the same band serves every page.
+ *
+ * A foot is written in REGIONS, the way a spreadsheet's is: something at the
+ * left of the sheet, something at the middle, something against the far edge.
+ * ZapfDingbats.pdf signs each page "© RenderX 2000" at the left and "XSL
+ * Formatting Objects Test Suite" at the right, and the two hundred points
+ * between them came back as one word space, the two texts crowding each other
+ * at the left. They stand on TAB STOPS instead (§17.3.1.38), which is what the
+ * two hundred points are.
+ *
+ * @param runs     The foot's runs.
+ * @param stepped  Whether the page steps between its words.
+ * @param measure  The measure it was set across, for its alignment.
+ * @param numbered Whether a number in it is the page's own.
+ * @param numeral  That number as this band prints it, where it is known.
+ */
+export declare function footerBand(runs: ReadonlyArray<TextRun>, stepped: boolean, measure: {
+    left: number;
+    right: number;
+} | undefined, numbered: boolean, numeral?: string): Array<BodyElement>;
 /**
  * §9.6.6 — the glyphs a page draws for want of characters, gathered into the
  * WORDS they stand in: a traced glyph that stands against the one before it,