reamkit 1.29.0 → 1.31.0

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

@@ -1,6 +1,7 @@
 import { PdfDict } from '../pdf/objects.js';
 import { ContentFont } from './content.js';
-import { PdfFile } from './document.js';
+import { PdfFile, PdfPage } from './document.js';
+import { FaceFamily } from '../core/ir/flow.js';
 /**
  * Build a {@link ContentFont} (the interpreter's decode + advance hooks) from a
  * `/Font` dictionary (E-PDF EP2). Unicode comes from the `/ToUnicode` CMap;
@@ -14,3 +15,28 @@ import { PdfFile } from './document.js';
  * @returns The decode/advance hooks plus the code width (1 or 2 bytes per code).
  */
 export declare function buildContentFont(file: PdfFile, fontDict: PdfDict): ContentFont;
+/**
+ * For every face a run may name, the family a word processor knows it by —
+ * keyed by the name the run carries (see {@link FaceFamily}).
+ *
+ * A PDF names the FACE and a .docx names a family: written as the face,
+ * `inter-semibold` was a font no reader has, and LibreOffice set the whole of
+ * an invoice drawn in Inter in its default serif. The family is the one the
+ * descriptor states (§9.8.1 `/FontFamily`) or, where it states none, the one
+ * the PostScript name is made of.
+ *
+ * @param file  The document.
+ * @param pages The pages whose faces are wanted.
+ * @returns Run font name → its family.
+ */
+export declare function collectFaceFamilies(file: PdfFile, pages: ReadonlyArray<PdfPage>): Map<string, FaceFamily>;
+/**
+ * The family a PostScript face name is made of: `Inter-SemiBold` → `Inter`,
+ * `ArialMT` → `Arial`, `TimesNewRomanPS-BoldMT` → `Times New Roman`.
+ *
+ * §9.6.2.1 names a face `Family-Style` (Word writes `Family,Style`), with the
+ * family's words run together. What follows the separator is a style only if
+ * it is made of style words — `MS-Mincho` is a family of its own — and the
+ * words come apart where the capitals say they do.
+ */
+export declare function familyOfFace(baseFont: string): string;