@docx4j/core-ts 0.1.0 → 0.1.1

package/dist/model/fonts/ThemeFonts.mjs

@@ -0,0 +1,76 @@
+import { getScriptForLanguageTag } from './LanguageTagToScriptMapping.mjs';
+function fontScheme(theme) {
+    var _a;
+    if (theme === undefined)
+        return undefined;
+    if ('majorFont' in theme)
+        return theme;
+    return (_a = theme.themeElements) === null || _a === void 0 ? void 0 : _a.fontScheme;
+}
+function isMajor(type) {
+    return type === 'majorAscii' || type === 'majorBidi' || type === 'majorEastAsia' || type === 'majorHAnsi';
+}
+/** `ThemePart.getLang`: which of `w:themeFontLang`'s three attributes this reference reads. */
+function langFor(themeFontLang, type) {
+    var _a, _b, _c;
+    if (type === 'majorAscii' || type === 'minorAscii' || type === 'majorHAnsi' || type === 'minorHAnsi') {
+        return (_a = themeFontLang.val) !== null && _a !== void 0 ? _a : undefined;
+    }
+    if (type === 'majorBidi' || type === 'minorBidi')
+        return (_b = themeFontLang.bidi) !== null && _b !== void 0 ? _b : undefined;
+    return (_c = themeFontLang.eastAsia) !== null && _c !== void 0 ? _c : undefined;
+}
+/** The collection's own `a:latin` / `a:ea` / `a:cs` for this reference. */
+function textFontFromTheme(scheme, type) {
+    const collection = isMajor(type) ? scheme.majorFont : scheme.minorFont;
+    if (collection === undefined)
+        return undefined;
+    switch (type) {
+        case 'majorEastAsia':
+        case 'minorEastAsia': return collection.ea;
+        case 'majorBidi':
+        case 'minorBidi': return collection.cs;
+        // majorAscii / minorAscii / majorHAnsi / minorHAnsi, and anything unknown: a:latin
+        default: return collection.latin;
+    }
+}
+/** The typeface of a collection's own face for this reference; undefined where it is absent or
+ *  empty (`<a:ea typeface=""/>`, which the Office theme writes). */
+function fontFromTheme(scheme, type) {
+    var _a;
+    const typeface = (_a = textFontFromTheme(scheme, type)) === null || _a === void 0 ? void 0 : _a.typeface;
+    if (typeface === undefined || typeface.trim().length === 0)
+        return undefined;
+    return typeface;
+}
+/**
+ * The face a theme reference names in this theme, for this `w:themeFontLang`.
+ *
+ * With no `w:themeFontLang` (or none that applies to this reference), the collection's own
+ * `a:latin` / `a:ea` / `a:cs`.  With one, the language's script (`Jpan`, `Hans`, `Geor` ...)
+ * picks from the collection's `a:font` list, falling back to the collection's own face where
+ * the language selects no script or the list has no entry for it.
+ *
+ * @returns the typeface, or undefined where the theme answers nothing.
+ */
+export function themeFontOf(theme, type, themeFontLang) {
+    var _a;
+    if (type === undefined || type === null)
+        return undefined;
+    const scheme = fontScheme(theme);
+    if (scheme === undefined)
+        return undefined;
+    if (themeFontLang === undefined || themeFontLang === null)
+        return fontFromTheme(scheme, type);
+    const lang = langFor(themeFontLang, type);
+    if (lang === undefined)
+        return fontFromTheme(scheme, type);
+    const script = getScriptForLanguageTag(lang);
+    if (script === undefined)
+        return fontFromTheme(scheme, type);
+    const collection = isMajor(type) ? scheme.majorFont : scheme.minorFont;
+    const entry = (_a = collection === null || collection === void 0 ? void 0 : collection.font) === null || _a === void 0 ? void 0 : _a.find((f) => f.script === script);
+    // as docx4j: only a script the list does not carry falls back; an entry with an empty
+    // typeface answers the empty string, and the caller's explicit attribute does not stand
+    return entry === undefined ? fontFromTheme(scheme, type) : entry.typeface;
+}

package/dist/model/fonts/defaultTheme.d.mts

@@ -0,0 +1,37 @@
+/** The values `docx4j.fonts.defaultTheme` takes. */
+export type DefaultThemeValue = '2023' | '2013' | '2007';
+/** A default theme: the Latin faces its font scheme names, and the theme part docx4j bundles. */
+export interface DefaultTheme {
+    readonly value: DefaultThemeValue;
+    /** The face its font scheme names for the major (heading) Latin slot. */
+    readonly majorLatin: string;
+    /** The face its font scheme names for the minor (body) Latin slot. */
+    readonly minorLatin: string;
+    /** That theme's own `theme1.xml`, as docx4j ships it. */
+    readonly xml: string;
+}
+/** Word 365's Office theme: Aptos Display / Aptos.  The default. */
+export declare const THEME_2023: DefaultTheme;
+/** Office 2013 to 2022: Calibri Light / Calibri. */
+export declare const THEME_2013: DefaultTheme;
+/** Office 2007 to 2010: Cambria / Calibri; docx4j's answer up to 17.1.0. */
+export declare const THEME_2007: DefaultTheme;
+export declare const DEFAULT_THEMES: readonly DefaultTheme[];
+/** The theme a value names; undefined where it names none. */
+export declare function defaultThemeOf(value: string | undefined): DefaultTheme | undefined;
+/**
+ * The package-level default, for a selector or a `createPackage()` that is not told otherwise.
+ * `'2023'` unless set; an unknown value throws rather than being silently ignored.
+ */
+export declare function defaultThemeSetting(): DefaultTheme;
+export declare function defaultThemeSetting(value: DefaultThemeValue | DefaultTheme): DefaultTheme;
+/** What a package carries: `pkg.fonts.defaultTheme`. */
+export interface FontSettings {
+    /** Which Office theme this package's themeless font references resolve against, and which
+     *  theme part `createPackage()` gives it.  Defaults to {@link defaultThemeSetting}. */
+    defaultTheme: DefaultThemeValue;
+}
+/** A package's font settings, defaulting to the process-wide setting when they are created. */
+export declare function newFontSettings(): FontSettings;
+/** The theme a package's settings name, falling back to the process-wide setting. */
+export declare function themeOfSettings(settings: FontSettings | undefined): DefaultTheme;

package/dist/model/fonts/defaultTheme.mjs

@@ -0,0 +1,57 @@
+// Which Office theme a package that has **no theme part** is read as having, and which theme
+// part `WordprocessingMLPackage.createPackage` puts in a new one.
+//
+// docx4j `org.docx4j.Docx4jProperties.DefaultTheme` and the property
+// `docx4j.fonts.defaultTheme` (docx4j CR-001 batch 49 item 6).  Word supplies its own default
+// theme to a themeless document, and which faces that names has changed twice: measured on a
+// Word 365 rendering of a package with no theme part (probe `theme-fonts-no-theme-part`), the
+// body face is **Aptos** and the heading face **Aptos Display**, where Office 2013 to 2022
+// answered Calibri and Calibri Light and Office 2007 to 2010 answered Calibri and Cambria.  So
+// this says which version of Word a themeless document is read as having come from - not a
+// preference - and the default is the current one.
+//
+// **The shape here.**  docx4j has one JVM-wide property; this package has no properties file,
+// and a browser or an add-in may hold several packages at once, so the setting lives on the
+// package: `pkg.fonts.defaultTheme = '2013'`.  {@link defaultThemeSetting} is the fallback for
+// a selector built without a package, and is what a caller changes to move every package at
+// once.
+import { THEME_2007_XML, THEME_2013_XML, THEME_2023_XML } from './themes.generated.mjs';
+/** Word 365's Office theme: Aptos Display / Aptos.  The default. */
+export const THEME_2023 = {
+    value: '2023', majorLatin: 'Aptos Display', minorLatin: 'Aptos', xml: THEME_2023_XML,
+};
+/** Office 2013 to 2022: Calibri Light / Calibri. */
+export const THEME_2013 = {
+    value: '2013', majorLatin: 'Calibri Light', minorLatin: 'Calibri', xml: THEME_2013_XML,
+};
+/** Office 2007 to 2010: Cambria / Calibri; docx4j's answer up to 17.1.0. */
+export const THEME_2007 = {
+    value: '2007', majorLatin: 'Cambria', minorLatin: 'Calibri', xml: THEME_2007_XML,
+};
+export const DEFAULT_THEMES = [THEME_2023, THEME_2013, THEME_2007];
+/** The theme a value names; undefined where it names none. */
+export function defaultThemeOf(value) {
+    if (value === undefined || value === null)
+        return undefined;
+    const v = value.trim();
+    return DEFAULT_THEMES.find((t) => t.value.toLowerCase() === v.toLowerCase());
+}
+let setting = THEME_2023;
+export function defaultThemeSetting(value) {
+    if (value !== undefined) {
+        const theme = typeof value === 'string' ? defaultThemeOf(value) : value;
+        if (!theme)
+            throw new Error(`docx4j.fonts.defaultTheme: not one of 2023, 2013, 2007: ${String(value)}`);
+        setting = theme;
+    }
+    return setting;
+}
+/** A package's font settings, defaulting to the process-wide setting when they are created. */
+export function newFontSettings() {
+    return { defaultTheme: defaultThemeSetting().value };
+}
+/** The theme a package's settings name, falling back to the process-wide setting. */
+export function themeOfSettings(settings) {
+    var _a;
+    return (_a = (settings === undefined ? undefined : defaultThemeOf(settings.defaultTheme))) !== null && _a !== void 0 ? _a : defaultThemeSetting();
+}

package/dist/model/fonts/families.generated.d.mts

@@ -0,0 +1,11 @@
+/** The families `MicrosoftFonts.xml` lists, as it writes them.  `MicrosoftFontsRegistry`
+ *  keys that map by the name exactly, so the lookup is case-sensitive here too. */
+export declare const MS_FONT_NAMES: readonly string[];
+/** Those of {@link MS_FONT_NAMES} whose entry has a `<bold>` element.  A family in the
+ *  registry without one has no bold face of its own (Franklin Gothic Book), which is what
+ *  `Mapper.hasBoldFace` answers on. */
+export declare const MS_FONTS_WITH_BOLD: readonly string[];
+/** The families `word-line-metrics.properties` holds, lower-cased. */
+export declare const LINE_METRIC_FAMILIES: readonly string[];
+/** Those of {@link LINE_METRIC_FAMILIES} the table's optional field 7 flags East Asian. */
+export declare const EAST_ASIAN_FAMILIES: readonly string[];

package/dist/model/fonts/families.generated.mjs

@@ -0,0 +1,17 @@
+// The font families docx4j's own tables know: which have a bold face of their own, and which have Word line metrics recorded.
+//
+// Generated by scripts/generate-substitutions.mjs from docx4j 7fba7a1507fc01fdd7f4dc2f79cdbd6988c044f7:
+//   org/docx4j/fonts/microsoft/MicrosoftFonts.xml (149 families)
+//   org/docx4j/fonts/word-line-metrics.properties (512 families)
+// Do not edit; run `npm run generate:fonts` instead.
+/** The families `MicrosoftFonts.xml` lists, as it writes them.  `MicrosoftFontsRegistry`
+ *  keys that map by the name exactly, so the lookup is case-sensitive here too. */
+export const MS_FONT_NAMES = ["Arial", "Arial Black", "Comic Sans MS", "Courier New", "Georgia", "Impact", "Times New Roman", "Trebuchet MS", "Verdana", "Webdings", "Microsoft Sans Serif", "Segoe UI", "Tahoma", "Calibri", "Cambria", "Candara", "Consolas", "Constantia", "Corbel", "Franklin Gothic Medium", "Lucida Console", "Palatino Linotype", "Marlett", "Symbol", "Wingdings", "Algerian", "Arial Narrow", "Arial Unicode MS", "Baskerville Old Face", "Batang", "BatangChe", "Gungsuh", "GungsuhChe", "Bauhaus 93", "Bell MT", "Berlin Sans FB", "Berlin Sans FB Demi", "Bernard MT Condensed", "Bodoni MT Poster Compressed", "Book Antiqua", "Bookman Old Style", "Bookshelf Symbol 7", "Britannic Bold", "Broadway", "Brush Script MT", "Californian FB", "Cambria Math", "Centaur", "Century", "Century Gothic", "Chiller", "Colonna MT", "Cooper Black", "Estrangelo Edessa", "Footlight MT Light", "Freestyle Script", "Garamond", "Gautami", "Gulim", "GulimChe", "Dotum", "DotumChe", "Harlow Solid Italic", "Harrington", "High Tower Text", "Informal Roman", "Jokerman", "Juice ITC", "Kristen ITC", "Kunstler Script", "Latha", "Lucida Bright", "Lucida Calligraphy", "Lucida Fax", "Lucida Handwriting", "Lucida Sans", "Lucida Sans Unicode", "Magneto", "Malgun Gothic", "Mangal", "Marlett", "Matura MT Script Capitals", "MingLiU", "PMingLiU", "Mistral", "Modern No. 20", "Monotype Corsiva", "MS Gothic", "MS PGothic", "MS UI Gothic", "MS Mincho", "MS PMincho", "MS Reference Sans Serif", "MS Reference Specialty", "MT Extra", "MV Boli", "Niagara Engraved", "Niagara Solid", "Nina", "Old English Text MT", "Onyx", "Parchment", "Playbill", "Poor Richard", "Raavi", "Ravie", "Showcard Gothic", "Shruti", "SimHei", "SimSun", "NSimSun", "Snap ITC", "Stencil", "Sylfaen", "Tempus Sans ITC", "Tunga", "Viner Hand ITC", "Vivaldi", "Vladimir Script", "Wide Latin", "Wingdings 2", "Wingdings 3", "Liberation Serif", "Liberation Sans", "Liberation Mono", "Noto Sans Symbols Regular", "Noto Sans Symbols 2 Regular", "DejaVu Serif", "Segoe UI Symbol", "Franklin Gothic Book", "Franklin Gothic Demi", "Rockwell", "Carlito Regular", "Caladea Regular", "Cousine Regular", "Arimo Regular", "Tinos Regular"];
+/** Those of {@link MS_FONT_NAMES} whose entry has a `<bold>` element.  A family in the
+ *  registry without one has no bold face of its own (Franklin Gothic Book), which is what
+ *  `Mapper.hasBoldFace` answers on. */
+export const MS_FONTS_WITH_BOLD = ["Arial", "Comic Sans MS", "Courier New", "Georgia", "Times New Roman", "Trebuchet MS", "Verdana", "Segoe UI", "Tahoma", "Calibri", "Cambria", "Candara", "Consolas", "Constantia", "Corbel", "Palatino Linotype", "Arial Narrow", "Bell MT", "Berlin Sans FB", "Bookman Old Style", "Californian FB", "Cambria Math", "Century Gothic", "Garamond", "Lucida Bright", "Lucida Fax", "Lucida Sans", "Malgun Gothic", "Nina", "Liberation Serif", "Liberation Sans", "Liberation Mono", "Noto Sans Symbols Regular", "DejaVu Serif", "Franklin Gothic Demi", "Rockwell", "Carlito Regular", "Caladea Regular", "Cousine Regular", "Arimo Regular", "Tinos Regular"];
+/** The families `word-line-metrics.properties` holds, lower-cased. */
+export const LINE_METRIC_FAMILIES = ["abhaya libre", "agency fb", "aharoni", "algerian", "aller", "aller light", "amasis mt pro", "amasis mt pro black", "amasis mt pro medium", "amienne", "angsana new", "aptos", "aptos display", "aptos light", "aptos narrow", "archivo narrow", "arial", "arial black", "arial narrow", "arial nova", "arial nova cond", "arial nova light", "arial rounded mt bold", "arial unicode ms", "arnprior", "avenir next lt pro", "avenir next lt pro light", "bahnschrift", "barlow", "barts and the london logo", "baskerville old face", "batang", "batangche", "bauhaus 93", "baveuse", "bell mt", "bella donna", "bembo", "berlin sans fb", "berlin sans fb demi", "bernard mt condensed", "berylium", "bierstadt", "biondi", "blackadder itc", "blue highway", "blue highway condensed", "blue highway d type", "blue highway linocut", "bodoni mt", "bodoni mt black", "bodoni mt condensed", "bodoni mt poster compressed", "book antiqua", "bookman old style", "bookshelf symbol 7", "boopee", "bradley hand itc", "britannic bold", "broadway", "brush script mt", "burnstown dam", "buxton sketch", "byington", "calibri", "calibri light", "californian fb", "calisto mt", "cambria", "cambria math", "candara", "candara light", "carbon block", "carlito", "castellar", "catholicschoolgirls intl bb", "catriel", "cavolini", "centaur", "century", "century gothic", "century schoolbook", "chiller", "colonna mt", "comic sans ms", "consolas", "constantia", "cooper black", "copperplate gothic bold", "copperplate gothic light", "corbel", "corbel light", "cordia new", "courier new", "credit valley", "curlz mt", "dante", "dejavu sans", "dengxian", "dengxian light", "dokchampa", "dotum", "dotumche", "dubai", "dubai light", "dubai medium", "earwig factory", "ebrima", "edwardian script itc", "elephant", "engravers mt", "eras bold itc", "eras demi itc", "eras light itc", "eras medium itc", "euclid", "euclid extra", "euclid fraktur", "euclid math one", "euclid math two", "euclid symbol", "euphorigenic s", "felix titling", "fences", "fira sans", "footlight mt light", "forte", "franklin gothic book", "franklin gothic demi", "franklin gothic demi cond", "franklin gothic heavy", "franklin gothic medium", "franklin gothic medium cond", "free 3 of 9", "free 3 of 9 extended", "freestyle script", "french script mt", "gabriola", "gadugi", "garamond", "gautami", "geeznewa", "georgia", "georgia pro", "georgia pro cond black", "georgia pro cond light", "georgia pro light", "georgia pro semibold", "gigi", "gill sans mt", "gill sans mt condensed", "gill sans mt ext condensed bold", "gill sans nova", "gill sans ultra bold", "gill sans ultra bold condensed", "gloucester mt extra condensed", "goudy old style", "goudy stout", "grad", "grandview", "grandview display", "gulim", "gulimche", "gungsuh", "gungsuhche", "haettenschweiler", "harlow solid italic", "harrington", "heavy heap", "hggothice", "hggothicm", "hggyoshotai", "hgkyokashotai", "hgmarugothicmpro", "hgminchob", "hgminchoe", "hgpgothice", "hgpgothicm", "hgpgyoshotai", "hgpkyokashotai", "hgpminchob", "hgpminchoe", "hgpsoeikakugothicub", "hgpsoeikakupoptai", "hgpsoeipresenceeb", "hgseikaishotaipro", "hgsgothice", "hgsgothicm", "hgsgyoshotai", "hgskyokashotai", "hgsminchob", "hgsminchoe", "hgsoeikakugothicub", "hgsoeikakupoptai", "hgsoeipresenceeb", "hgssoeikakugothicub", "hgssoeikakupoptai", "hgssoeipresenceeb", "high tower text", "hololens mdl2 assets", "hp simplified", "hp simplified light", "hurry up", "huxtable", "impact", "imprint mt shadow", "informal roman", "ink free", "iskoola pota", "javanese text", "jokerman", "juice itc", "kaiti", "kredit", "kristen itc", "kunstler script", "latha", "leelawadee ui", "leelawadee ui semilight", "liberation sans", "liberation serif", "ligurino", "ligurino condensed", "lucida bright", "lucida calligraphy", "lucida console", "lucida fax", "lucida handwriting", "lucida sans", "lucida sans typewriter", "lucida sans unicode", "magneto", "maiandra gd", "malgun gothic", "malgun gothic semilight", "mangal", "marlett", "matura mt script capitals", "meiryo", "merriweather", "microsoft gothicneo", "microsoft himalaya", "microsoft jhenghei", "microsoft jhenghei ui", "microsoft mhei", "microsoft neogothic", "microsoft new tai lue", "microsoft phagspa", "microsoft sans serif", "microsoft tai le", "microsoft yahei", "microsoft yahei ui", "microsoft yi baiti", "mingliu", "mingliu-extb", "mingliu_hkscs-extb", "minya nouvelle", "mistral", "modern love", "modern no. 20", "mongolian baiti", "monotype corsiva", "montserrat", "ms gothic", "ms mincho", "ms outlook", "ms pgothic", "ms pmincho", "ms reference sans serif", "ms reference specialty", "ms ui gothic", "mt extra", "mt extra tiger", "mufferaw", "mv boli", "myanmar text", "neue haas grotesk text pro", "neuropol", "niagara engraved", "niagara solid", "nimbus sans narrow", "nina", "nirmala ui", "nirmala ui semilight", "noto sans", "noto sans black", "noto sans condensed", "noto sans condensed black", "noto sans condensed extrabold", "noto sans condensed extralight", "noto sans condensed light", "noto sans condensed medium", "noto sans condensed semibold", "noto sans condensed thin", "noto sans extrabold", "noto sans extracondensed", "noto sans extracondensed black", "noto sans extracondensed extrabold", "noto sans extracondensed extralight", "noto sans extracondensed light", "noto sans extracondensed medium", "noto sans extracondensed semibold", "noto sans extracondensed thin", "noto sans extralight", "noto sans light", "noto sans medium", "noto sans semibold", "noto sans semicondensed", "noto sans semicondensed black", "noto sans semicondensed extrabold", "noto sans semicondensed extralight", "noto sans semicondensed light", "noto sans semicondensed medium", "noto sans semicondensed semibold", "noto sans semicondensed thin", "noto sans sinhala", "noto sans sinhala blk", "noto sans sinhala cond", "noto sans sinhala cond blk", "noto sans sinhala cond extbd", "noto sans sinhala cond extlt", "noto sans sinhala cond light", "noto sans sinhala cond med", "noto sans sinhala cond sembd", "noto sans sinhala cond thin", "noto sans sinhala extbd", "noto sans sinhala extcond", "noto sans sinhala extcond blk", "noto sans sinhala extcond extbd", "noto sans sinhala extcond extlt", "noto sans sinhala extcond light", "noto sans sinhala extcond med", "noto sans sinhala extcond sembd", "noto sans sinhala extcond thin", "noto sans sinhala extlt", "noto sans sinhala light", "noto sans sinhala med", "noto sans sinhala sembd", "noto sans sinhala semcond", "noto sans sinhala semcond blk", "noto sans sinhala semcond extbd", "noto sans sinhala semcond extlt", "noto sans sinhala semcond light", "noto sans sinhala semcond med", "noto sans sinhala semcond sembd", "noto sans sinhala semcond thin", "noto sans sinhala thin", "noto sans sinhala ui", "noto sans symbols", "noto sans thin", "noto serif sinhala", "noto serif sinhala black", "noto serif sinhala condensed", "noto serif sinhala condensed black", "noto serif sinhala condensed extrabold", "noto serif sinhala condensed extralight", "noto serif sinhala condensed light", "noto serif sinhala condensed medium", "noto serif sinhala condensed semibold", "noto serif sinhala condensed thin", "noto serif sinhala extrabold", "noto serif sinhala extracondensed", "noto serif sinhala extracondensed black", "noto serif sinhala extracondensed extrabold", "noto serif sinhala extracondensed extralight", "noto serif sinhala extracondensed light", "noto serif sinhala extracondensed medium", "noto serif sinhala extracondensed semibold", "noto serif sinhala extracondensed thin", "noto serif sinhala extralight", "noto serif sinhala light", "noto serif sinhala medium", "noto serif sinhala semibold", "noto serif sinhala semicondensed", "noto serif sinhala semicondensed black", "noto serif sinhala semicondensed extrabold", "noto serif sinhala semicondensed extralight", "noto serif sinhala semicondensed light", "noto serif sinhala semicondensed medium", "noto serif sinhala semicondensed semibold", "noto serif sinhala semicondensed thin", "noto serif sinhala thin", "nsimsun", "nunito sans", "ocr a extended", "ocrb", "old english text mt", "onyx", "open sans", "oswald", "pacifico", "palace script mt", "palatino linotype", "papyrus", "parchment", "perpetua", "perpetua titling mt", "planet benson 2", "playbill", "playfair display", "pmingliu", "pmingliu-extb", "poor richard", "posterama", "pristina", "pupcat", "raavi", "rage italic", "ravie", "roboto", "roboto condensed", "rockwell", "rockwell condensed", "rockwell extra bold", "rockwell nova", "rockwell nova light", "sabon next lt", "sagona", "sagona book", "sagona extralight", "sans serif collection", "script mt bold", "seaford", "seaford display", "segoe marker", "segoe mdl2 assets", "segoe print", "segoe script", "segoe ui", "segoe ui black", "segoe ui emoji", "segoe ui historic", "segoe ui light", "segoe ui semibold", "segoe ui semilight", "segoe ui symbol", "segoe wp", "segoe wp black", "segoe wp light", "segoe wp semibold", "segoe wp semilight", "shell", "showcard gothic", "shruti", "simhei", "simsun", "simsun-extb", "simsun-extg", "sitka", "sketchflow print", "snap itc", "source han serif cn", "source sans pro", "source sans pro semibold", "speak pro", "srisakdi", "stencil", "stereofidelic", "stzhongsong", "sybil green", "sylfaen", "symbol", "symbol tiger", "symbol tiger expert", "tahoma", "tandelle", "teen", "teen light", "tempus sans itc", "tenorite", "the hand", "the hand extrablack", "the serif hand", "the serif hand black", "think nothing", "tiger expert", "times new roman", "trade gothic next", "trade gothic next cond", "trade gothic next light", "trebuchet ms", "tunga", "tw cen mt", "tw cen mt condensed", "tw cen mt condensed extra bold", "ubuntu", "univers", "univers condensed", "univers condensed light", "univers light", "velvenda cooler", "verdana", "verdana pro", "verdana pro cond semibold", "vijaya", "viner hand itc", "vivaldi", "vladimir script", "waker", "walbaum", "walbaum display", "walbaum display light", "webdings", "wickenden cafe ndp", "wide latin", "wingdings", "wingdings 2", "wingdings 3", "yu gothic", "yu gothic ui", "yu mincho", "yu mincho demibold"];
+/** Those of {@link LINE_METRIC_FAMILIES} the table's optional field 7 flags East Asian. */
+export const EAST_ASIAN_FAMILIES = ["arial unicode ms", "batang", "batangche", "dengxian", "dengxian light", "dotum", "dotumche", "gulim", "gulimche", "gungsuh", "gungsuhche", "hggothice", "hggothicm", "hggyoshotai", "hgkyokashotai", "hgmarugothicmpro", "hgminchob", "hgminchoe", "hgseikaishotaipro", "hgsoeikakugothicub", "hgsoeikakupoptai", "hgsoeipresenceeb", "kaiti", "malgun gothic", "malgun gothic semilight", "meiryo", "microsoft gothicneo", "microsoft jhenghei", "microsoft mhei", "microsoft neogothic", "microsoft yahei", "mingliu", "mingliu-extb", "ms gothic", "ms mincho", "ms pmincho", "pmingliu", "simhei", "simsun", "simsun-extb", "simsun-extg", "source han serif cn", "stzhongsong", "yu gothic", "yu mincho", "yu mincho demibold"];

package/dist/model/fonts/fontsInUse.d.mts

@@ -0,0 +1,39 @@
+import type * as wml from '@docx4j/generated-objects-ts/modules/org_docx4j_wml';
+import type { RunFontSelector } from './RunFontSelector.mjs';
+/** The stories a walk covers, in docx4j's order: the body, then headers and footers, endnotes,
+ *  footnotes and comments.  Each value is whatever holds block-level content. */
+export type Stories = Iterable<unknown>;
+/** The styles part, as much of it as the walk needs. */
+export interface StyleSource {
+    styles?: wml.Styles | undefined;
+    /** The `w:default="1"` paragraph, character and table style ids. */
+    defaultParagraphStyleId?: string | undefined;
+    defaultCharacterStyleId?: string | undefined;
+    defaultTableStyleId?: string | undefined;
+}
+/** What one walk found. */
+export interface FontsAndStyles {
+    /** The document font names, theme references resolved, CJK names in English. */
+    fonts: Set<string>;
+    /** The style ids used directly (not those merely based on). */
+    styles: Set<string>;
+}
+/**
+ * One traversal of every story, collecting font names and the style ids used directly
+ * (docx4j's `FontAndStyleFinder`).  The default paragraph, character and table styles count as
+ * used where a paragraph, run or table names none of its own.
+ *
+ * @param selector resolves theme references; omit to collect styles only
+ */
+export declare function walkStories(stories: Stories, styleSource: StyleSource | undefined, selector: RunFontSelector | undefined, collectFonts: boolean): FontsAndStyles;
+/**
+ * The font names a document uses: the walk above, then the styles in use with their `w:basedOn`
+ * chains, the numbering levels, the document defaults, and the default font.
+ *
+ * @param stories the body and the other story parts' content
+ * @param styleSource the styles part
+ * @param numbering the numbering part's content, or undefined
+ * @param selector the package's selector (it resolves the theme references and answers the
+ *   default font)
+ */
+export declare function fontsInUse(stories: Stories, styleSource: StyleSource | undefined, numbering: wml.Numbering | undefined, selector: RunFontSelector): Set<string>;

package/dist/model/fonts/fontsInUse.mjs

@@ -0,0 +1,183 @@
+import { walk } from '@docx4j/generated-objects-ts/builders/wml';
+import { toEnglish } from './CJKToEnglish.mjs';
+function collector(selector, into) {
+    const add = (fontName) => {
+        var _a;
+        if (fontName === undefined || fontName === null)
+            return;
+        const name = fontName.trim();
+        if (name.length === 0)
+            return;
+        // where there is an English name, no point adding the original CJK name
+        into.add((_a = toEnglish(name)) !== null && _a !== void 0 ? _a : name);
+    };
+    return {
+        name: add,
+        rFonts(rFonts) {
+            if (rFonts === undefined || selector === undefined)
+                return;
+            for (const name of selector.documentFontsOf(rFonts))
+                add(name);
+        },
+    };
+}
+/** The `w:rPr` a content control's `w:sdtPr` carries, if any. */
+function sdtRPr(sdtPr) {
+    var _a;
+    for (const entry of (_a = sdtPr.rPrOrAliasOrLock) !== null && _a !== void 0 ? _a : []) {
+        const value = entry.value;
+        if ((value === null || value === void 0 ? void 0 : value.TYPE_NAME) === 'org_docx4j_wml.RPr')
+            return value;
+    }
+    return undefined;
+}
+/**
+ * One traversal of every story, collecting font names and the style ids used directly
+ * (docx4j's `FontAndStyleFinder`).  The default paragraph, character and table styles count as
+ * used where a paragraph, run or table names none of its own.
+ *
+ * @param selector resolves theme references; omit to collect styles only
+ */
+export function walkStories(stories, styleSource, selector, collectFonts) {
+    var _a, _b;
+    const fonts = new Set();
+    const styles = new Set();
+    const add = collector(selector, fonts);
+    let defaultParagraphStyleUsed = false;
+    let defaultCharacterStyleUsed = false;
+    let defaultTableStyleUsed = false;
+    for (const story of stories) {
+        walk(story, (value) => {
+            var _a, _b, _c, _d, _e, _f, _g;
+            switch (value.TYPE_NAME) {
+                case 'org_docx4j_wml.P': {
+                    const pPr = value.pPr;
+                    if (collectFonts && (pPr === null || pPr === void 0 ? void 0 : pPr.rPr) !== undefined)
+                        add.rFonts(pPr.rPr.rFonts); // the paragraph mark's
+                    let customPStyle = false;
+                    if (pPr !== undefined) {
+                        if (((_a = pPr.pStyle) === null || _a === void 0 ? void 0 : _a.val) !== undefined) {
+                            customPStyle = true;
+                            styles.add(pPr.pStyle.val);
+                        }
+                        if (((_c = (_b = pPr.rPr) === null || _b === void 0 ? void 0 : _b.rStyle) === null || _c === void 0 ? void 0 : _c.val) !== undefined)
+                            styles.add(pPr.rPr.rStyle.val);
+                    }
+                    defaultParagraphStyleUsed || (defaultParagraphStyleUsed = !customPStyle);
+                    break;
+                }
+                case 'org_docx4j_wml.R': {
+                    const rPr = value.rPr;
+                    if (collectFonts && rPr !== undefined)
+                        add.rFonts(rPr.rFonts);
+                    if (rPr !== undefined) {
+                        if (((_d = rPr.rStyle) === null || _d === void 0 ? void 0 : _d.val) === undefined)
+                            defaultCharacterStyleUsed = true;
+                        else
+                            styles.add(rPr.rStyle.val);
+                    }
+                    break;
+                }
+                case 'org_docx4j_wml.R.Sym':
+                    if (collectFonts)
+                        add.name(value.font);
+                    break;
+                case 'org_docx4j_wml.Tbl': {
+                    const tblStyle = (_f = (_e = value.tblPr) === null || _e === void 0 ? void 0 : _e.tblStyle) === null || _f === void 0 ? void 0 : _f.val;
+                    if (tblStyle !== undefined)
+                        styles.add(tblStyle);
+                    defaultTableStyleUsed || (defaultTableStyleUsed = tblStyle === undefined);
+                    break;
+                }
+                case 'org_docx4j_wml.SdtPr': {
+                    const rPr = sdtRPr(value);
+                    if (rPr === undefined)
+                        break;
+                    if (collectFonts)
+                        add.rFonts(rPr.rFonts);
+                    const rStyle = (_g = rPr.rStyle) === null || _g === void 0 ? void 0 : _g.val;
+                    if (rStyle !== undefined) {
+                        styles.add(rStyle);
+                        // and the linked paragraph style, if any
+                        const linked = linkedStyleOf(styleSource === null || styleSource === void 0 ? void 0 : styleSource.styles, rStyle);
+                        if (linked !== undefined)
+                            styles.add(linked);
+                    }
+                    break;
+                }
+                default:
+                    break;
+            }
+            return undefined;
+        });
+    }
+    if (defaultParagraphStyleUsed && (styleSource === null || styleSource === void 0 ? void 0 : styleSource.defaultParagraphStyleId) !== undefined) {
+        styles.add(styleSource.defaultParagraphStyleId);
+        const style = styleById(styleSource.styles, styleSource.defaultParagraphStyleId);
+        if (((_b = (_a = style === null || style === void 0 ? void 0 : style.rPr) === null || _a === void 0 ? void 0 : _a.rStyle) === null || _b === void 0 ? void 0 : _b.val) !== undefined)
+            styles.add(style.rPr.rStyle.val);
+    }
+    if (defaultCharacterStyleUsed && (styleSource === null || styleSource === void 0 ? void 0 : styleSource.defaultCharacterStyleId) !== undefined) {
+        styles.add(styleSource.defaultCharacterStyleId);
+    }
+    if (defaultTableStyleUsed && (styleSource === null || styleSource === void 0 ? void 0 : styleSource.defaultTableStyleId) !== undefined) {
+        styles.add(styleSource.defaultTableStyleId);
+    }
+    return { fonts, styles };
+}
+function styleById(styles, styleId) {
+    var _a;
+    return (_a = styles === null || styles === void 0 ? void 0 : styles.style) === null || _a === void 0 ? void 0 : _a.find((s) => s.styleId === styleId);
+}
+/** The paragraph style a character style is linked to (`w:link`), by style id. */
+function linkedStyleOf(styles, styleId) {
+    var _a, _b, _c;
+    const link = (_b = (_a = styleById(styles, styleId)) === null || _a === void 0 ? void 0 : _a.link) === null || _b === void 0 ? void 0 : _b.val;
+    if (link === undefined)
+        return undefined;
+    return (_c = styleById(styles, link)) === null || _c === void 0 ? void 0 : _c.styleId;
+}
+/**
+ * The font names a document uses: the walk above, then the styles in use with their `w:basedOn`
+ * chains, the numbering levels, the document defaults, and the default font.
+ *
+ * @param stories the body and the other story parts' content
+ * @param styleSource the styles part
+ * @param numbering the numbering part's content, or undefined
+ * @param selector the package's selector (it resolves the theme references and answers the
+ *   default font)
+ */
+export function fontsInUse(stories, styleSource, numbering, selector) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    const { fonts, styles } = walkStories(stories, styleSource, selector, true);
+    const add = collector(selector, fonts);
+    const allStyles = styleSource === null || styleSource === void 0 ? void 0 : styleSource.styles;
+    const docDefaultsRFonts = (_c = (_b = (_a = allStyles === null || allStyles === void 0 ? void 0 : allStyles.docDefaults) === null || _a === void 0 ? void 0 : _a.rPrDefault) === null || _b === void 0 ? void 0 : _b.rPr) === null || _c === void 0 ? void 0 : _c.rFonts;
+    if (allStyles !== undefined) {
+        add.rFonts(docDefaultsRFonts);
+        // the styles in use, each with the chain it is based on
+        for (const styleId of styles) {
+            let style = styleById(allStyles, styleId);
+            for (let guard = 0; style !== undefined && guard < 64; guard++) {
+                if (style.rPr !== undefined)
+                    add.rFonts(style.rPr.rFonts);
+                for (const tblStylePr of (_d = style.tblStylePr) !== null && _d !== void 0 ? _d : []) {
+                    if (tblStylePr.rPr !== undefined)
+                        add.rFonts(tblStylePr.rPr.rFonts);
+                }
+                const basedOn = (_e = style.basedOn) === null || _e === void 0 ? void 0 : _e.val;
+                style = basedOn === undefined ? undefined : styleById(allStyles, basedOn);
+            }
+        }
+    }
+    // Fonts can also be used in the numbering part.  For now, treat any font mentioned in that
+    // part as in use (docx4j's comment: ideally only the levels actually used).
+    for (const abstractNum of (_f = numbering === null || numbering === void 0 ? void 0 : numbering.abstractNum) !== null && _f !== void 0 ? _f : []) {
+        for (const lvl of (_g = abstractNum.lvl) !== null && _g !== void 0 ? _g : []) {
+            if (lvl.rPr !== undefined)
+                add.rFonts(lvl.rPr.rFonts);
+        }
+    }
+    fonts.add(selector.defaultFontOf(docDefaultsRFonts));
+    return fonts;
+}

package/dist/model/fonts/index.d.mts

@@ -0,0 +1,14 @@
+export { PhysicalFont, NOBOLD_SUFFIX, stripSuffixes } from './PhysicalFont.mjs';
+export { type FontRegistry, SimpleFontRegistry, DEFAULT_FONT_REGISTRY, EMPTY_FONT_REGISTRY, } from './registry.mjs';
+export { Mapper, type FontDecision, type FontDecisionSource, UNKNOWN_ERROR, FONT_FALLBACK, isKnownFamily, hasBoldFace, isEastAsianFamily, wordDefaultFor, fontTableOf, } from './Mapper.mjs';
+export { IdentityPlusMapper } from './IdentityPlusMapper.mjs';
+export { type FontClass, classOf, classFromName, substitutionClass, isCondensed, leftToTheDocumentDefault, selectByClass, shortKey, vclEntryFor, isSymbol, isEastAsianForm, coverageGroupOf, SYMBOL_GROUP, EMOJI_GROUP, } from './FontFallback.mjs';
+export { scriptOf } from './scripts.mjs';
+export { RunFontSelector, type RunFontSelectorSource, type FontSpan, type SpansOptions, BUILT_IN_DEFAULT_FONT, isOn, symbolFontName, isEmoji, spanScript, preambleRule, runLocale, } from './RunFontSelector.mjs';
+export { themeFontOf, type ThemeFontLang, type ThemeSource } from './ThemeFonts.mjs';
+export { getScriptForLanguageTag } from './LanguageTagToScriptMapping.mjs';
+export { toEnglish } from './CJKToEnglish.mjs';
+export { type DefaultTheme, type DefaultThemeValue, type FontSettings, THEME_2007, THEME_2013, THEME_2023, DEFAULT_THEMES, defaultThemeOf, defaultThemeSetting, newFontSettings, themeOfSettings, } from './defaultTheme.mjs';
+export { fontsInUse, walkStories, type FontsAndStyles, type StyleSource } from './fontsInUse.mjs';
+export { runFontSelectorOf } from './lookup.mjs';
+export { type Substitute, type SubstituteRow, type VclEntry, SUBSTITUTE_ROWS, VCL_ENTRIES, } from './substitutions.generated.mjs';

package/dist/model/fonts/index.mjs

@@ -0,0 +1,29 @@
+// CR-001 Phase B step 4: fonts (docx4j `org.docx4j.fonts`).
+//
+// Two halves, as in docx4j:
+//
+// - {@link RunFontSelector} decides which *document* font formats each character of a run: the
+//   effective `w:rFonts` with its theme references resolved, `w:cs` / `w:rtl` by value, the
+//   symbol fonts, and the [MS-OI29500] 17.3.2.26 character-range table.  Its answer is
+//   `FontSpan[]`, which is what a renderer, a text extractor or a measurement routine needs.
+// - {@link Mapper} maps a document font name to a {@link PhysicalFont}.  This CR ships
+//   {@link IdentityPlusMapper} over a {@link FontRegistry} the caller supplies; docx4j's
+//   `BestMatchingMapper`, the glyph-coverage pass and font metrics need font files and are a
+//   later CR, but the interface is fixed here so a consumer with `fontkit` can plug its own in.
+//
+// The theme a package with no theme part is read as having is {@link defaultThemeSetting} /
+// `pkg.fonts.defaultTheme`, and `createPackage()` gives a new package that theme's part.
+export { PhysicalFont, NOBOLD_SUFFIX, stripSuffixes } from './PhysicalFont.mjs';
+export { SimpleFontRegistry, DEFAULT_FONT_REGISTRY, EMPTY_FONT_REGISTRY, } from './registry.mjs';
+export { Mapper, UNKNOWN_ERROR, FONT_FALLBACK, isKnownFamily, hasBoldFace, isEastAsianFamily, wordDefaultFor, fontTableOf, } from './Mapper.mjs';
+export { IdentityPlusMapper } from './IdentityPlusMapper.mjs';
+export { classOf, classFromName, substitutionClass, isCondensed, leftToTheDocumentDefault, selectByClass, shortKey, vclEntryFor, isSymbol, isEastAsianForm, coverageGroupOf, SYMBOL_GROUP, EMOJI_GROUP, } from './FontFallback.mjs';
+export { scriptOf } from './scripts.mjs';
+export { RunFontSelector, BUILT_IN_DEFAULT_FONT, isOn, symbolFontName, isEmoji, spanScript, preambleRule, runLocale, } from './RunFontSelector.mjs';
+export { themeFontOf } from './ThemeFonts.mjs';
+export { getScriptForLanguageTag } from './LanguageTagToScriptMapping.mjs';
+export { toEnglish } from './CJKToEnglish.mjs';
+export { THEME_2007, THEME_2013, THEME_2023, DEFAULT_THEMES, defaultThemeOf, defaultThemeSetting, newFontSettings, themeOfSettings, } from './defaultTheme.mjs';
+export { fontsInUse, walkStories } from './fontsInUse.mjs';
+export { runFontSelectorOf } from './lookup.mjs';
+export { SUBSTITUTE_ROWS, VCL_ENTRIES, } from './substitutions.generated.mjs';

package/dist/model/fonts/lookup.d.mts

@@ -0,0 +1,5 @@
+import type { RunFontSelector } from './RunFontSelector.mjs';
+/** The package's selector, or undefined where it has none yet (nothing has awaited
+ *  `getRunFontSelector()`), where the package has no main document part, or where there is no
+ *  package at all - a fragment built on its own. */
+export declare function runFontSelectorOf(pkg: unknown): RunFontSelector | undefined;

package/dist/model/fonts/lookup.mjs

@@ -0,0 +1,12 @@
+/** The package's selector, or undefined where it has none yet (nothing has awaited
+ *  `getRunFontSelector()`), where the package has no main document part, or where there is no
+ *  package at all - a fragment built on its own. */
+export function runFontSelectorOf(pkg) {
+    var _a;
+    try {
+        return (_a = pkg === null || pkg === void 0 ? void 0 : pkg.getMainDocumentPart) === null || _a === void 0 ? void 0 : _a.call(pkg).runFontSelectorOrUndefined;
+    }
+    catch {
+        return undefined;
+    }
+}

package/dist/model/fonts/registry.d.mts

@@ -0,0 +1,31 @@
+import { PhysicalFont } from './PhysicalFont.mjs';
+/**
+ * The fonts available, by name.  The only thing the mapping passes ask of a font environment.
+ *
+ * Lookups are case-insensitive and strip a twin suffix, as docx4j's `PhysicalFonts.get` does.
+ */
+export interface FontRegistry {
+    /** The font of this name, or undefined where the environment has none. */
+    get(name: string | undefined | null): PhysicalFont | undefined;
+    /** Every font, for the passes that search by a short key (`FontFallback`'s candidate lists). */
+    all(): readonly PhysicalFont[];
+}
+/** A `FontRegistry` over a fixed list of faces. */
+export declare class SimpleFontRegistry implements FontRegistry {
+    private readonly byKey;
+    private readonly fonts;
+    constructor(fonts?: Iterable<PhysicalFont>);
+    add(font: PhysicalFont): this;
+    get(name: string | undefined | null): PhysicalFont | undefined;
+    all(): readonly PhysicalFont[];
+}
+/** A registry with nothing in it: every document font is `UNMAPPED`. */
+export declare const EMPTY_FONT_REGISTRY: FontRegistry;
+/**
+ * The default `FontRegistry`: the faces docx4j's four font jars provide, and nothing else.
+ *
+ * It is what `IdentityPlusMapper` uses where the caller supplies none, and the reason a
+ * mapping computed here can be compared with a parity golden.  A consumer with real fonts
+ * passes its own (a `SimpleFontRegistry` over what `fontkit` or `@font-face` reports).
+ */
+export declare const DEFAULT_FONT_REGISTRY: FontRegistry;