@rxova/brand 0.1.2 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rxova/brand",
3
- "version": "0.1.2",
3
+ "version": "0.2.0",
4
4
  "type": "module",
5
5
  "description": "Design tokens, Starlight theme and shared site chrome for rxova.org",
6
6
  "keywords": [
@@ -20,7 +20,7 @@
20
20
  },
21
21
  "bugs": "https://github.com/rxova/brand/issues",
22
22
  "engines": {
23
- "node": ">=20.19.0"
23
+ "node": ">=24.0.0"
24
24
  },
25
25
  "sideEffects": [
26
26
  "*.css"
@@ -58,14 +58,17 @@
58
58
  "@resvg/resvg-js": "^2.6.2",
59
59
  "@types/node": "^26.1.1",
60
60
  "astro": "^7.1.3",
61
+ "publint": "^0.3.21",
61
62
  "satori": "^0.29.0",
63
+ "tsx": "^4.23.1",
62
64
  "typescript": "6.0.3"
63
65
  },
64
66
  "scripts": {
65
67
  "typecheck": "tsc --noEmit",
66
68
  "check:astro": "astro check",
67
- "check:exports": "node scripts/check-exports.mjs",
68
- "og": "node scripts/generate-og.mjs",
69
- "check:og": "node scripts/generate-og.mjs --check"
69
+ "pack:smoke": "node --import tsx scripts/pack-smoke.ts",
70
+ "check:exports": "publint --strict",
71
+ "og": "node --import tsx scripts/generate-og.ts",
72
+ "check:og": "node --import tsx scripts/generate-og.ts --check"
70
73
  }
71
74
  }
@@ -0,0 +1,57 @@
1
+ ---
2
+ /**
3
+ * Starlight's theme picker, plus a resync when the page comes out of the
4
+ * back/forward cache.
5
+ *
6
+ * Starlight applies the stored theme in two places, both of which run exactly
7
+ * once, while the document is being parsed: the inline script in
8
+ * `ThemeProvider.astro`, and the `<starlight-theme-select>` constructor. A
9
+ * back/forward navigation that hits the bfcache *restores* the document rather
10
+ * than parsing it, so neither runs again and the page keeps whatever
11
+ * `data-theme` it carried when the visitor left.
12
+ *
13
+ * All of rxova.org is one origin sharing one `starlight-theme` key, so that is
14
+ * a visible jump rather than a curiosity: pick a theme on the landing page or
15
+ * on another project's docs, press Back, and the restored page is still on the
16
+ * old one.
17
+ *
18
+ * This wraps rather than replaces Starlight's component — the picker, its
19
+ * labels and its own logic are untouched, and a Starlight release that changes
20
+ * them changes them here too.
21
+ */
22
+ import Default from '@astrojs/starlight/components/ThemeSelect.astro'
23
+ ---
24
+
25
+ <Default><slot /></Default>
26
+
27
+ <script>
28
+ type Theme = 'auto' | 'dark' | 'light'
29
+
30
+ /** Same key and coercion Starlight uses; unknown values mean "follow the OS". */
31
+ const STORAGE_KEY = 'starlight-theme'
32
+ const parseTheme = (theme: unknown): Theme =>
33
+ theme === 'auto' || theme === 'dark' || theme === 'light' ? theme : 'auto'
34
+ const preferredColorScheme = (): Theme =>
35
+ matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark'
36
+
37
+ // `pageshow` is the only notification of a bfcache restore. A normal load
38
+ // also fires it with `persisted: false`, which we ignore — Starlight has
39
+ // already done the work in that case.
40
+ window.addEventListener('pageshow', (event) => {
41
+ if (!event.persisted) return
42
+
43
+ let stored: string | null
44
+ try {
45
+ stored = localStorage.getItem(STORAGE_KEY)
46
+ } catch {
47
+ // Storage can throw outright (Safari private mode, blocked cookies).
48
+ // Leaving the restored theme alone is the right fallback.
49
+ return
50
+ }
51
+
52
+ const theme = parseTheme(stored)
53
+ document.documentElement.dataset.theme = theme === 'auto' ? preferredColorScheme() : theme
54
+ // Keeps the picker from disagreeing with the page it controls.
55
+ StarlightThemeProvider.updatePickers(theme)
56
+ })
57
+ </script>
package/src/env.d.ts CHANGED
@@ -5,3 +5,17 @@
5
5
  // Starlight's own `.ts` sources, which import `virtual:starlight/*` modules
6
6
  // that only exist inside an Astro build — so plain `tsc` fails on them.
7
7
  // The one component that reads route data narrows it structurally instead.
8
+
9
+ // Same reasoning for this one. It mirrors Starlight's own `global.d.ts`, which
10
+ // we cannot `/// <reference>` because the package's types entry is `index.ts`
11
+ // and drags in those same virtual modules. The global is defined at runtime by
12
+ // the inline script in Starlight's `ThemeProvider.astro`; ThemeSelect.astro
13
+ // calls it. Re-check this against Starlight's `global.d.ts` on a major bump.
14
+ declare global {
15
+ interface StarlightThemeProvider {
16
+ updatePickers(theme?: string): void
17
+ }
18
+ var StarlightThemeProvider: StarlightThemeProvider
19
+ }
20
+
21
+ export {}
package/src/starlight.ts CHANGED
@@ -73,6 +73,10 @@ export function sharedStarlightConfig({
73
73
  // Starlight's default footer (pagination, edit link, last updated) plus
74
74
  // the shared four-column site footer beneath it.
75
75
  Footer: '@rxova/brand/components/Footer.astro',
76
+ // Starlight's own picker, plus a resync when a page is restored from the
77
+ // back/forward cache — without it, changing the theme on one rxova.org
78
+ // surface and pressing Back leaves the restored page on the old theme.
79
+ ThemeSelect: '@rxova/brand/components/ThemeSelect.astro',
76
80
  ...components,
77
81
  },
78
82