@datatechsolutions/tympan-tokens 0.3.1 → 0.4.1

package/README.md

@@ -15,16 +15,55 @@ npm test -w @datatechsolutions/tympan-tokens           # vitest: colour math, ra
 
 | Output | Content |
 |---|---|
-| `@datatechsolutions/tympan-tokens/tokens.css` | every `--ty-*` custom property, in `@layer tympan.tokens` |
+| `@datatechsolutions/tympan-tokens/tokens.css` | every `--ty-*` custom property, in `@layer tympan.tokens`; starts with `@import './fonts.css'` |
+| `@datatechsolutions/tympan-tokens/fonts.css` | `@font-face` rules (font-display swap, unicode-range slices) for the base stacks and the per-script Noto families (CJK in `@datatechsolutions/tympan-fonts-cjk/fonts.css`) |
+| `@datatechsolutions/tympan-tokens/fonts/` | the bundled woff2 files, their licences (`<family>/OFL.txt`) and `manifest.json` (family, weights, version, origin, licence, size) |
 | `@datatechsolutions/tympan-tokens/tokens.json` | resolved values: base, density steps, each preset × mode (× high contrast) |
 | `@datatechsolutions/tympan-tokens/dtcg/*.tokens.json` | W3C DTCG trees (2025.10 format) of every set, as fed to Style Dictionary (`dtcg/print/` for the print themes) |
 | `@datatechsolutions/tympan-tokens/print-themes.css` | opt-in: every print book style as a UI theme (`data-ty-theme="print-<style>"`), light, dark and high contrast |
 | `@datatechsolutions/tympan-tokens/print-themes/<theme>.css` | opt-in: one print theme per file (for example `print-themes/print-suico.css`) |
-| `@datatechsolutions/tympan-tokens/print-themes.json` | name, label, font stylesheet URL and CSS file of each print theme |
+| `@datatechsolutions/tympan-tokens/print-themes.json` | name, label, CSS file and (legacy) Google Fonts URL of each print theme |
 | `@datatechsolutions/tympan-tokens/values` | the resolved values as a typed JS module (`values`, `cssVar()`) |
 | `@datatechsolutions/tympan-tokens` | the generator: colour math, `resolveTheme`, presets, `generateThemeCss`, DTCG conversion |
 | `dist/contrast-report.md` | WCAG ratio and APCA Lc of every declared pair, per preset and mode |
 
+## Fonts
+
+Every family a theme names ships in the package as woff2 (89 families, SIL
+OFL 1.1, from Google Fonts; see `THIRD_PARTY_NOTICES.md` and
+`fonts/manifest.json`): Source Serif 4, IBM Plex Sans and Mono, the Noto
+families of the per-script `:lang()` stacks (Arabic, Hebrew, Indic, Thai,
+Ethiopic …) and every print theme's families. Files are sliced by
+`unicode-range` the way Google Fonts serves them; a browser downloads a slice
+only when text uses that face and falls in its range.
+
+The CJK Noto families (Noto Sans and Serif JP, SC, TC, KR; about 41 MB) are
+the exception: the stacks and `:lang()` rules still name them, but their
+files and `@font-face` rules are in the optional package
+`@datatechsolutions/tympan-fonts-cjk` (`CJK_FONT_FAMILIES`,
+`CJK_FONT_SPECS`). Without it, CJK text falls back to the system faces (macOS
+and Windows cover CJK); with it, the bundled faces load:
+
+```ts
+import '@datatechsolutions/tympan-fonts-cjk/fonts.css'
+```
+
+- `tokens.css` imports `./fonts.css` (base stacks and non-CJK Noto); a bundler
+  resolves the relative URLs (`../fonts/<family>/<file>.woff2`) and emits the
+  files as assets. `@datatechsolutions/tympan/styles.css` keeps the same
+  import as `@import '@datatechsolutions/tympan-tokens/fonts.css'`.
+- The print theme sheets carry their own families' rules.
+- To opt out (strict size budget, own font hosting): import the tokens
+  without the fonts by aliasing `@datatechsolutions/tympan-tokens/fonts.css`
+  to an empty file in your bundler; the stacks then fall back to system
+  faces. `fontFaceCss(manifest, specs, base)` builds the same rules for a
+  subset of families.
+- `node scripts/fetch-fonts.mjs` (`npm run fetch-fonts`) refetches the files
+  from `BASE_FONT_SPECS`, `SCRIPT_FONT_SPECS` and the print styles'
+  `googleFonts` into this package's `fonts/` and, for the CJK families,
+  `packages/fonts-cjk/fonts/` (manifest and notices per package); the build
+  fails when a non-CJK spec has no bundled files.
+
 ## Token model
 
 **Static (authored as DTCG in `src/base/`)**: spacing on a 4 px base
@@ -142,8 +181,8 @@ focus ring, slate 50 / 950 grounds, glass surfaces).
 style draws on is named only in its description (`referencia`, "inspirado em
 …").
 Optional fields cover page ornaments (`estrutura.moldura`, `cor.ornamento`),
-columns (`estrutura.barras`), running-head bands and title treatments. Each `PrintStyle` names its fonts (Google Fonts,
-OFL), paper and ink, data and proof-state colours, paper texture, stroke,
+columns (`estrutura.barras`), running-head bands and title treatments. Each `PrintStyle` names its fonts (Google Fonts
+families, OFL, bundled in `fonts/`), paper and ink, data and proof-state colours, paper texture, stroke,
 chart renderer, proof-mark shape and page structure.
 
 ```ts
@@ -227,8 +266,11 @@ example `print-suico`, `print-minimo-de-tinta`). The mapping is data-driven:
   accent kept as the brand where it reads.
 - **Typography**: `fonts.display` and `fonts.body` are the style's title and
   body stacks; `fonts.mono` is the style's mono stack only when it is really
-  monospace (otherwise the base mono stays). `fontsUrl` is the style's Google
-  Fonts css2 URL (`googleFontsUrl`) limited to those families.
+  monospace (otherwise the base mono stays). The theme's sheet declares the
+  bundled `@font-face` rules of the style's families (`printThemeFontSpecs`).
+  `fontsUrl` (the style's Google Fonts css2 URL, `googleFontsUrl`) and
+  `printThemeFontUrls` remain as legacy API for hosts that prefer Google's
+  CDN; the themes no longer need them.
 - **Surface**: radius from the print corner radius (mm at 96 dpi); glass,
   a gradient call to action and soft shadows only for the card and wash
   styles (`dashboard`, `aquarela`); flat shadows for the ruled print styles
@@ -246,18 +288,16 @@ The print themes are **not** in `tokens.css`. To enable them in an app:
 
 ```ts
 import '@datatechsolutions/tympan/styles.css'                      // or tokens.css
-import '@datatechsolutions/tympan-tokens/print-themes.css'         // all print themes (about 2 MB, 160 kB gzip)
+import '@datatechsolutions/tympan-tokens/print-themes.css'         // all print themes (about 2.3 MB, with their @font-face rules)
 // or only the ones you offer:
 import '@datatechsolutions/tympan-tokens/print-themes/print-suico.css'
 
-import { printThemeFontUrls } from '@datatechsolutions/tympan-tokens'
-<ThemeProvider theme="print-suico" fonts={printThemeFontUrls}>…</ThemeProvider>
+<ThemeProvider theme="print-suico">…</ThemeProvider>
 ```
 
-`ThemeProvider`'s `fonts` map (theme name to stylesheet URL) adds the font
-link of the current theme; `themeInitScript(key, defaults, { fonts })` does the
-same before first paint. Without it the stacks fall back to the style's
-system families. `generatePrintThemesCss(list)` builds the same sheet at
+Each sheet declares the `@font-face` rules of its style's families, with URLs
+relative to the package's `fonts/`; the files load only when the theme is
+active and text uses them. `generatePrintThemesCss(list)` builds the same sheet at
 runtime. A default theme nested inside a print theme inherits the print
 fonts, because the built-in presets do not redeclare the font tokens.
 

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,103 @@
+# Third-party notices
+
+`@datatechsolutions/tympan-tokens` is licensed under FSL-1.1-ALv2 (Copyright 2026 Natalia Mesquita).
+It bundles the font files below, unmodified, in `fonts/`: every family the Tympan themes name except the CJK Noto families (those are in @datatechsolutions/tympan-fonts-cjk)
+(generated by `packages/tokens/scripts/fetch-fonts.mjs`; fetched 2026-10-05 from the Google Fonts css2 API
+as woff2 sliced by unicode-range). Each family keeps its own licence, shipped next to its files.
+The SIL Open Font License 1.1 allows bundling and redistribution with software; the fonts may
+not be sold by themselves, and Reserved Font Names apply to modified versions (none here are modified).
+Font-file sizes: see `fonts/manifest.json`.
+
+| Family | Version (gstatic) | Licence | Designer | Files | Size | Licence file |
+|---|---|---|---|---|---|---|
+| Albert Sans | v4 | OFL-1.1 | Andreas Rasmussen | 4 | 0.07 MB | `fonts/albertsans/OFL.txt` |
+| Alegreya | v41 | OFL-1.1 | Juan Pablo del Peral, HT Fonts | 14 | 0.24 MB | `fonts/alegreya/OFL.txt` |
+| Alegreya SC | v28 | OFL-1.1 | Juan Pablo del Peral, HT Fonts | 14 | 0.16 MB | `fonts/alegreyasc/OFL.txt` |
+| Alfa Slab One | v21 | OFL-1.1 | JM Solé | 3 | 0.03 MB | `fonts/alfaslabone/OFL.txt` |
+| Allerta Stencil | v24 | OFL-1.1 | Matt McInerney | 1 | 0.01 MB | `fonts/allertastencil/OFL.txt` |
+| Archivo | v25 | OFL-1.1 | Omnibus-Type | 12 | 0.40 MB | `fonts/archivo/OFL.txt` |
+| Archivo Black | v23 | OFL-1.1 | Omnibus-Type | 2 | 0.02 MB | `fonts/archivoblack/OFL.txt` |
+| Arimo | v36 | OFL-1.1 | Steve Matteson | 8 | 0.20 MB | `fonts/arimo/OFL.txt` |
+| Bangers | v25 | OFL-1.1 | Vernon Adams | 3 | 0.03 MB | `fonts/bangers/OFL.txt` |
+| Barlow | v13 | OFL-1.1 | Jeremy Tribby | 18 | 0.18 MB | `fonts/barlow/OFL.txt` |
+| Barlow Condensed | v13 | OFL-1.1 | Jeremy Tribby | 6 | 0.05 MB | `fonts/barlowcondensed/OFL.txt` |
+| Bricolage Grotesque | v9 | OFL-1.1 | Mathieu Triay | 3 | 0.20 MB | `fonts/bricolagegrotesque/OFL.txt` |
+| Bungee | v17 | OFL-1.1 | David Jonathan Ross | 3 | 0.03 MB | `fonts/bungee/OFL.txt` |
+| Caveat | v23 | OFL-1.1 | Impallari Type | 4 | 0.21 MB | `fonts/caveat/OFL.txt` |
+| Comic Neue | v9 | OFL-1.1 | Craig Rozynski, Hrant Papazian | 2 | 0.02 MB | `fonts/comicneue/OFL.txt` |
+| Cormorant Garamond | v21 | OFL-1.1 | Christian Thalmann | 10 | 0.25 MB | `fonts/cormorantgaramond/OFL.txt` |
+| Courier Prime | v11 | OFL-1.1 | Alan Dague-Greene | 4 | 0.04 MB | `fonts/courierprime/OFL.txt` |
+| Crimson Pro | v28 | OFL-1.1 | Jacques Le Bailly | 6 | 0.13 MB | `fonts/crimsonpro/OFL.txt` |
+| DM Serif Display | v17 | OFL-1.1 | Colophon Foundry | 4 | 0.05 MB | `fonts/dmserifdisplay/OFL.txt` |
+| EB Garamond | v33 | OFL-1.1 | Georg Duffner, Octavio Pardo | 14 | 0.48 MB | `fonts/ebgaramond/OFL.txt` |
+| Federo | v20 | OFL-1.1 | Cyreal | 1 | 0.01 MB | `fonts/federo/OFL.txt` |
+| Fira Sans Condensed | v11 | OFL-1.1 | Carrois Apostrophe | 35 | 0.43 MB | `fonts/firasanscondensed/OFL.txt` |
+| Gelasio | v14 | OFL-1.1 | Eben Sorkin | 6 | 0.13 MB | `fonts/gelasio/OFL.txt` |
+| Gochi Hand | v27 | OFL-1.1 | HT Fonts | 1 | 0.02 MB | `fonts/gochihand/OFL.txt` |
+| Hanken Grotesk | v12 | OFL-1.1 | Alfredo Marco Pradil, Hanken Design Co. | 8 | 0.09 MB | `fonts/hankengrotesk/OFL.txt` |
+| Hind | v18 | OFL-1.1 | Indian Type Foundry | 12 | 0.19 MB | `fonts/hind/OFL.txt` |
+| IBM Plex Mono | v20 | OFL-1.1 | Mike Abbink, Bold Monday | 25 | 0.16 MB | `fonts/ibmplexmono/OFL.txt` |
+| IBM Plex Sans | v23 | OFL-1.1 | Mike Abbink, Bold Monday | 12 | 0.19 MB | `fonts/ibmplexsans/OFL.txt` |
+| IBM Plex Sans Condensed | v15 | OFL-1.1 | Mike Abbink, Bold Monday | 20 | 0.15 MB | `fonts/ibmplexsanscondensed/OFL.txt` |
+| IBM Plex Serif | v20 | OFL-1.1 | Mike Abbink, Bold Monday | 15 | 0.13 MB | `fonts/ibmplexserif/OFL.txt` |
+| IM Fell English | v14 | OFL-1.1 | Igino Marini | 2 | 0.11 MB | `fonts/imfellenglish/OFL.txt` |
+| IM Fell English SC | v16 | OFL-1.1 | Igino Marini | 1 | 0.05 MB | `fonts/imfellenglishsc/OFL.txt` |
+| Inter | v20 | OFL-1.1 | Rasmus Andersson | 7 | 0.21 MB | `fonts/inter/OFL.txt` |
+| Jost | v20 | OFL-1.1 | Owen Earl | 6 | 0.07 MB | `fonts/jost/OFL.txt` |
+| Kalam | v18 | OFL-1.1 | Indian Type Foundry | 6 | 0.14 MB | `fonts/kalam/OFL.txt` |
+| Lato | v25 | OFL-1.1 | Łukasz Dziedzic | 6 | 0.05 MB | `fonts/lato/OFL.txt` |
+| League Spartan | v15 | OFL-1.1 | Matt Bailey, Tyler Finck | 3 | 0.05 MB | `fonts/leaguespartan/OFL.txt` |
+| Libre Bodoni | v9 | OFL-1.1 | Pablo Impallari, Rodrigo Fuenzalida | 3 | 0.05 MB | `fonts/librebodoni/OFL.txt` |
+| Libre Franklin | v20 | OFL-1.1 | Impallari Type | 10 | 0.15 MB | `fonts/librefranklin/OFL.txt` |
+| Literata | v40 | OFL-1.1 | TypeTogether | 14 | 0.43 MB | `fonts/literata/OFL.txt` |
+| Londrina Solid | v19 | OFL-1.1 | Marcelo Magalhães | 2 | 0.04 MB | `fonts/londrinasolid/OFL.txt` |
+| Major Mono Display | v18 | OFL-1.1 | Emre Parlak | 3 | 0.02 MB | `fonts/majormonodisplay/OFL.txt` |
+| Montserrat | v31 | OFL-1.1 | Julieta Ulanovsky, Sol Matas, Juan Pablo del Peral, Jacques Le Bailly | 10 | 0.22 MB | `fonts/montserrat/OFL.txt` |
+| Newsreader | v26 | OFL-1.1 | Production Type | 6 | 0.49 MB | `fonts/newsreader/OFL.txt` |
+| Noto Naskh Arabic | v44 | OFL-1.1 | Google | 5 | 0.14 MB | `fonts/notonaskharabic/OFL.txt` |
+| Noto Sans | v42 | OFL-1.1 | Google | 8 | 0.42 MB | `fonts/notosans/OFL.txt` |
+| Noto Sans Arabic | v33 | OFL-1.1 | Google | 5 | 0.24 MB | `fonts/notosansarabic/OFL.txt` |
+| Noto Sans Armenian | v47 | OFL-1.1 | Google | 3 | 0.07 MB | `fonts/notosansarmenian/OFL.txt` |
+| Noto Sans Bengali | v33 | OFL-1.1 | Google | 3 | 0.14 MB | `fonts/notosansbengali/OFL.txt` |
+| Noto Sans Devanagari | v30 | OFL-1.1 | Google | 3 | 0.15 MB | `fonts/notosansdevanagari/OFL.txt` |
+| Noto Sans Ethiopic | v50 | OFL-1.1 | Google | 3 | 0.23 MB | `fonts/notosansethiopic/OFL.txt` |
+| Noto Sans Georgian | v48 | OFL-1.1 | Google | 7 | 0.11 MB | `fonts/notosansgeorgian/OFL.txt` |
+| Noto Sans Gujarati | v27 | OFL-1.1 | Google | 5 | 0.19 MB | `fonts/notosansgujarati/OFL.txt` |
+| Noto Sans Gurmukhi | v29 | OFL-1.1 | Google | 3 | 0.08 MB | `fonts/notosansgurmukhi/OFL.txt` |
+| Noto Sans Hebrew | v50 | OFL-1.1 | Google | 5 | 0.04 MB | `fonts/notosanshebrew/OFL.txt` |
+| Noto Sans Kannada | v32 | OFL-1.1 | Google | 3 | 0.13 MB | `fonts/notosanskannada/OFL.txt` |
+| Noto Sans Khmer | v29 | OFL-1.1 | Google | 3 | 0.09 MB | `fonts/notosanskhmer/OFL.txt` |
+| Noto Sans Lao | v33 | OFL-1.1 | Google | 3 | 0.06 MB | `fonts/notosanslao/OFL.txt` |
+| Noto Sans Malayalam | v29 | OFL-1.1 | Google | 3 | 0.13 MB | `fonts/notosansmalayalam/OFL.txt` |
+| Noto Sans Mono | v37 | OFL-1.1 | Google | 7 | 0.30 MB | `fonts/notosansmono/OFL.txt` |
+| Noto Sans Myanmar | v27 | OFL-1.1 | Google | 3 | 0.19 MB | `fonts/notosansmyanmar/OFL.txt` |
+| Noto Sans Sinhala | v36 | OFL-1.1 | Google | 3 | 0.17 MB | `fonts/notosanssinhala/OFL.txt` |
+| Noto Sans Tamil | v31 | OFL-1.1 | Google | 3 | 0.10 MB | `fonts/notosanstamil/OFL.txt` |
+| Noto Sans Telugu | v30 | OFL-1.1 | Google | 3 | 0.16 MB | `fonts/notosanstelugu/OFL.txt` |
+| Noto Sans Thai | v29 | OFL-1.1 | Google | 3 | 0.07 MB | `fonts/notosansthai/OFL.txt` |
+| Noto Serif | v33 | OFL-1.1 | Google | 8 | 0.44 MB | `fonts/notoserif/OFL.txt` |
+| Noto Serif Bengali | v31 | OFL-1.1 | Google | 3 | 0.22 MB | `fonts/notoserifbengali/OFL.txt` |
+| Noto Serif Devanagari | v34 | OFL-1.1 | Google | 3 | 0.16 MB | `fonts/notoserifdevanagari/OFL.txt` |
+| Noto Serif Ethiopic | v32 | OFL-1.1 | Google | 3 | 0.22 MB | `fonts/notoserifethiopic/OFL.txt` |
+| Noto Serif Hebrew | v30 | OFL-1.1 | Google | 3 | 0.06 MB | `fonts/notoserifhebrew/OFL.txt` |
+| Noto Serif Tamil | v31 | OFL-1.1 | Google | 3 | 0.11 MB | `fonts/notoseriftamil/OFL.txt` |
+| Noto Serif Thai | v28 | OFL-1.1 | Google | 3 | 0.08 MB | `fonts/notoserifthai/OFL.txt` |
+| Nunito | v32 | OFL-1.1 | Vernon Adams, Cyreal, Jacques Le Bailly | 10 | 0.19 MB | `fonts/nunito/OFL.txt` |
+| Nunito Sans | v19 | OFL-1.1 | Vernon Adams, Jacques Le Bailly, Manvel Shmavonyan, Alexei Vanyashin | 15 | 0.44 MB | `fonts/nunitosans/OFL.txt` |
+| Old Standard TT | v22 | OFL-1.1 | Alexey Kryukov | 15 | 0.15 MB | `fonts/oldstandardtt/OFL.txt` |
+| Oswald | v57 | OFL-1.1 | Vernon Adams, Kalapi Gajjar, Cyreal | 5 | 0.07 MB | `fonts/oswald/OFL.txt` |
+| Patrick Hand SC | v17 | OFL-1.1 | Patrick Wagesreiter | 3 | 0.03 MB | `fonts/patrickhandsc/OFL.txt` |
+| PT Sans | v18 | OFL-1.1 | ParaType | 12 | 0.10 MB | `fonts/ptsans/OFL.txt` |
+| PT Sans Narrow | v19 | OFL-1.1 | ParaType | 8 | 0.07 MB | `fonts/ptsansnarrow/OFL.txt` |
+| PT Serif | v19 | OFL-1.1 | ParaType | 12 | 0.13 MB | `fonts/ptserif/OFL.txt` |
+| Rubik | v31 | OFL-1.1 | Hubert and Fischer, Meir Sadan, Cyreal, Daniel Grumer, Omaima Dajani | 12 | 0.18 MB | `fonts/rubik/OFL.txt` |
+| Rubik Mono One | v20 | OFL-1.1 | Hubert and Fischer | 3 | 0.01 MB | `fonts/rubikmonoone/OFL.txt` |
+| Share Tech Mono | v16 | OFL-1.1 | Carrois Apostrophe | 1 | 0.01 MB | `fonts/sharetechmono/OFL.txt` |
+| Shrikhand | v17 | OFL-1.1 | Jonny Pinhorn | 3 | 0.06 MB | `fonts/shrikhand/OFL.txt` |
+| Source Serif 4 | v15 | OFL-1.1 | Frank Grießhammer | 12 | 0.59 MB | `fonts/sourceserif4/OFL.txt` |
+| Space Mono | v17 | OFL-1.1 | Colophon Foundry | 9 | 0.07 MB | `fonts/spacemono/OFL.txt` |
+| Stardos Stencil | v15 | OFL-1.1 | Vernon Adams | 2 | 0.03 MB | `fonts/stardosstencil/OFL.txt` |
+| STIX Two Text | v18 | OFL-1.1 | Tiro Typeworks, Ross Mills, John Hudson, Paul Hanslow | 12 | 0.20 MB | `fonts/stixtwotext/OFL.txt` |
+| Work Sans | v24 | OFL-1.1 | Wei Huang | 6 | 0.13 MB | `fonts/worksans/OFL.txt` |
+
+Total: 89 families, 599 files, 13.38 MB.