@datatechsolutions/tympan-tokens 0.4.0 → 0.4.1

package/fonts/worksans/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2019 The Work Sans Project Authors (https://github.com/weiweihuanghuang/Work-Sans)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datatechsolutions/tympan-tokens",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Tympan design tokens: W3C DTCG source (colour, space, radius, type, elevation and glass, motion, z) and an OKLCH theme generator, with the tympan, fakhir, astrlabe, neutral and high-contrast presets in light and dark (plus opt-in UI themes derived from the print book styles), built to --ty-* CSS custom properties, JSON and a TypeScript export.",
   "license": "FSL-1.1-ALv2",
   "author": "Natalia Mesquita",
@@ -40,6 +40,8 @@
       "default": "./dist/print-aliases.js"
     },
     "./tokens.css": "./dist/tokens.css",
+    "./fonts.css": "./dist/fonts.css",
+    "./fonts/*": "./fonts/*",
     "./print-themes.css": "./dist/print-themes.css",
     "./print-themes/*": "./dist/print-themes/*",
     "./print-themes.json": "./dist/print-themes.json",
@@ -51,14 +53,17 @@
   "files": [
     "dist",
     "src",
+    "fonts",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "THIRD_PARTY_NOTICES.md"
   ],
   "scripts": {
     "build": "node scripts/build.mjs && tsdown",
     "typecheck": "tsc --noEmit -p tsconfig.json && node scripts/build.mjs --check",
     "test": "vitest run",
-    "prepack": "npm run build"
+    "prepack": "npm run build",
+    "fetch-fonts": "node scripts/fetch-fonts.mjs"
   },
   "devDependencies": {
     "style-dictionary": "^5.5.5"

package/src/fonts.ts

@@ -0,0 +1,136 @@
+// Bundled web fonts. Tympan ships every family its themes name as woff2
+// files inside this package (packages/tokens/fonts/, fetched once by
+// scripts/fetch-fonts.mjs and committed), declared with @font-face in
+// dist/fonts.css (imported by tokens.css) and in the print theme sheets.
+// The CJK families are the exception: they ship in the optional
+// @datatechsolutions/tympan-fonts-cjk package (see CJK_FONT_FAMILIES).
+// @font-face only downloads a file when text uses that face and falls in its
+// unicode-range, so nothing is fetched from a third party at runtime and an
+// unused script or theme costs nothing.
+//
+// The lists below are the source of truth for what scripts/fetch-fonts.mjs
+// downloads; the specs use the Google Fonts css2 syntax
+// (`Family Name:axes@values`) because that is where the files come from.
+
+import { SCRIPT_RULES } from './scripts.ts'
+
+/** Base stacks of every preset: Source Serif 4, IBM Plex Sans, IBM Plex Mono. */
+export const BASE_FONT_SPECS: readonly string[] = [
+  'Source Serif 4:ital,opsz,wght@0,8..60,400;0,8..60,600;0,8..60,700;1,8..60,400',
+  'IBM Plex Sans:ital,wght@0,400;0,500;0,600;0,700;1,400',
+  'IBM Plex Mono:ital,wght@0,400;0,500;0,600;0,700;1,400',
+]
+
+const NOTO_WEIGHTS = 'wght@400;500;600;700'
+
+/** Noto families named by the base stacks and the per-script `:lang()` rules. */
+export const SCRIPT_FONT_FAMILIES: readonly string[] = [
+  ...new Set([
+    'Noto Sans',
+    'Noto Serif',
+    'Noto Sans Mono',
+    'Noto Naskh Arabic',
+    'Noto Sans Arabic',
+    'Noto Sans Hebrew',
+    'Noto Serif Hebrew',
+    'Noto Sans Devanagari',
+    'Noto Serif Devanagari',
+    'Noto Sans Bengali',
+    'Noto Sans Tamil',
+    'Noto Sans Thai',
+    'Noto Serif Thai',
+    'Noto Sans Ethiopic',
+    'Noto Serif Ethiopic',
+    'Noto Sans Armenian',
+    'Noto Sans Georgian',
+    'Noto Sans JP',
+    'Noto Serif JP',
+    'Noto Sans SC',
+    'Noto Serif SC',
+    'Noto Sans KR',
+    'Noto Serif KR',
+    ...SCRIPT_RULES.flatMap((r) => [...r.sans, ...(r.serif ?? [])]),
+  ]),
+]
+
+export const SCRIPT_FONT_SPECS: readonly string[] = SCRIPT_FONT_FAMILIES.map((f) => `${f}:${NOTO_WEIGHTS}`)
+
+/**
+ * The CJK Noto families (about 41 MB of woff2). The token stacks and the
+ * `:lang()` rules still name them, but their files and @font-face rules live
+ * in the optional package @datatechsolutions/tympan-fonts-cjk (activated with
+ * `import '@datatechsolutions/tympan-fonts-cjk/fonts.css'`); without it the
+ * browser falls back to the system CJK faces.
+ */
+export const CJK_FONT_FAMILIES: readonly string[] = [
+  'Noto Sans JP',
+  'Noto Serif JP',
+  'Noto Sans SC',
+  'Noto Serif SC',
+  'Noto Sans TC',
+  'Noto Serif TC',
+  'Noto Sans KR',
+  'Noto Serif KR',
+]
+
+const isCjkSpec = (spec: string) => CJK_FONT_FAMILIES.includes(spec.split(':')[0]!)
+
+/** Specs whose faces go into the fonts.css of @datatechsolutions/tympan-fonts-cjk. */
+export const CJK_FONT_SPECS: readonly string[] = SCRIPT_FONT_SPECS.filter(isCjkSpec)
+
+/** Every spec whose faces go into dist/fonts.css (and so tokens.css): base and non-CJK Noto. */
+export const CORE_FONT_SPECS: readonly string[] = [...BASE_FONT_SPECS, ...SCRIPT_FONT_SPECS.filter((s) => !isCjkSpec(s))]
+
+/**
+ * Family names that are platform faces, generic keywords or legacy aliases
+ * kept as fallbacks; they get no @font-face (tests check that every other
+ * family a theme names is bundled).
+ */
+export const SYSTEM_FONT_FAMILIES: readonly string[] = [
+  'serif', 'sans-serif', 'monospace', 'cursive', 'fantasy', 'system-ui', 'ui-monospace', 'ui-sans-serif', 'ui-serif',
+  '-apple-system', 'BlinkMacSystemFont', 'Segoe UI', 'Segoe Print', 'Roboto', 'Helvetica Neue', 'Helvetica', 'Arial',
+  'Georgia', 'Times New Roman', 'Times', 'SFMono-Regular', 'Menlo', 'Monaco', 'Consolas', 'Liberation Mono', 'Courier New',
+  'Courier', 'Palatino', 'Palatino Linotype', 'Book Antiqua', 'Garamond', 'Baskerville', 'Didot', 'Futura', 'Gill Sans',
+  'Optima', 'Impact', 'Verdana', 'Tahoma', 'Trebuchet MS', 'Arial Narrow', 'Arial Black', 'Avenir', 'Avenir Next',
+  'American Typewriter', 'Rockwell', 'Copperplate', 'Bodoni 72', 'Hoefler Text', 'Iowan Old Style', 'Charter',
+  'Source Serif Pro',
+]
+
+/** Shape of fonts/manifest.json (written by scripts/fetch-fonts.mjs). */
+export interface FontManifest {
+  families: Record<string, { slug: string; version: string | null; files: number; bytes: number; license: string; licenseFile: string }>
+  faces: Record<string, { family: string; style: string; weights: number[]; unicodeRange: string | null; file: string; bytes: number }>
+  specs: Record<string, string[]>
+}
+
+/**
+ * @font-face rules for the faces of `specs`, with `url(<base><file>)`
+ * (`base` is the path from the stylesheet to the fonts/ folder), font-display
+ * swap and the unicode-range of each slice. Faces shared by several specs
+ * are declared once.
+ */
+export function fontFaceCss(manifest: FontManifest, specs: readonly string[], base: string): string {
+  const ids = new Set<string>()
+  for (const spec of specs) {
+    const faces = manifest.specs[spec]
+    if (!faces) throw new Error(`Font spec not bundled (run scripts/fetch-fonts.mjs): ${spec}`)
+    for (const id of faces) ids.add(id)
+  }
+  return [...ids]
+    .map((id) => {
+      const f = manifest.faces[id]!
+      const lo = Math.min(...f.weights)
+      const hi = Math.max(...f.weights)
+      return [
+        '@font-face {',
+        `  font-family: '${f.family}';`,
+        `  font-style: ${f.style};`,
+        `  font-weight: ${lo === hi ? lo : `${lo} ${hi}`};`,
+        '  font-display: swap;',
+        `  src: url('${base}${f.file}') format('woff2');`,
+        ...(f.unicodeRange ? [`  unicode-range: ${f.unicodeRange};`] : []),
+        '}',
+      ].join('\n')
+    })
+    .join('\n')
+}

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './flow.ts'
 export * from './print-presets.ts'
 export * from './print-themes.ts'
 export * from './print-aliases.ts'
+export * from './fonts.ts'
 
 import { presets as corePresets } from './presets.ts'
 import { printThemePresets } from './print-themes.ts'

package/src/print-themes.ts

@@ -398,7 +398,20 @@ function draftPrintTheme(style: PrintStyle, override: PrintThemeOverride = PRINT
 /** Every book style as a UI theme, in the order of `printPresets`. */
 export const printThemePresets: readonly ThemeConfig[] = (Object.values(printPresets) as PrintStyle[]).map((s) => printStyleToTheme(s))
 
-/** Stylesheet URL of the families of each print theme, by theme name (for ThemeProvider's `fonts`). */
+/**
+ * Legacy: Google Fonts stylesheet URL of the families of each print theme, by
+ * theme name. The print theme sheets now declare the bundled fonts
+ * (`printThemeFontSpecs`), so ThemeProvider needs no `fonts` map; this stays
+ * for hosts that prefer Google's CDN.
+ */
 export const printThemeFontUrls: Readonly<Record<string, string>> = Object.fromEntries(
   printThemePresets.filter((t) => t.fontsUrl).map((t) => [t.name, t.fontsUrl!]),
 )
+
+/**
+ * Google Fonts specs of each print theme, by theme name: the families its
+ * stacks name, bundled under fonts/ and declared in the theme's sheet.
+ */
+export const printThemeFontSpecs: Readonly<Record<string, readonly string[]>> = Object.fromEntries(
+  (Object.values(printPresets) as PrintStyle[]).map((s) => [`${PRINT_THEME_PREFIX}${s.name}`, [...s.googleFonts]]),
+)