singularity-core 0.17.0 → 0.17.1

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/README.md CHANGED
@@ -15,4 +15,4 @@ export const { login, logout, getValidSession, hasUserPermission } =
15
15
  createCookieSession({ client: fetchAuthServerClient, cookiePrefix: "filion" });
16
16
  ```
17
17
 
18
- See [AGENTS.md](./AGENTS.md) for the subpaths and the rules for adding code. Open fixes are in [IMPROVEMENTS.md](./IMPROVEMENTS.md).
18
+ See [AGENTS.md](./AGENTS.md) for the subpaths and the rules for adding code. Open fixes are in [IMPROVEMENTS.md](./IMPROVEMENTS.md). What each version contains is in [RELEASE_NOTES.md](./RELEASE_NOTES.md).
@@ -41,6 +41,17 @@ export declare function themeNeedsClientBootstrap(theme: Theme): boolean;
41
41
  * Applies or removes the `dark` class on `document.documentElement`.
42
42
  */
43
43
  export declare function applyDarkClass(isDark: boolean): void;
44
+ /**
45
+ * The named theme to show: `raw` when it is one of `names`, else `fallback`.
46
+ * A named theme is a whole look, picked with `data-theme` on `<html>`, and
47
+ * each has a light and a dark mode; it is not the `Theme` preference above.
48
+ * The names belong to the app's UI library, so the app passes them in.
49
+ */
50
+ export declare function resolveThemeName<TName extends string>(raw: string | null | undefined, names: readonly TName[], fallback: TName): TName;
51
+ /**
52
+ * Sets the named theme on `document.documentElement` as `data-theme`.
53
+ */
54
+ export declare function applyThemeName(themeName: string): void;
44
55
  /**
45
56
  * Inline script for first paint when preference is `system` (or legacy localStorage-only).
46
57
  * `storageKey` is both the localStorage key and the cookie name unless
@@ -54,6 +54,21 @@ export function applyDarkClass(isDark) {
54
54
  root.classList.remove("dark");
55
55
  }
56
56
  }
57
+ /**
58
+ * The named theme to show: `raw` when it is one of `names`, else `fallback`.
59
+ * A named theme is a whole look, picked with `data-theme` on `<html>`, and
60
+ * each has a light and a dark mode; it is not the `Theme` preference above.
61
+ * The names belong to the app's UI library, so the app passes them in.
62
+ */
63
+ export function resolveThemeName(raw, names, fallback) {
64
+ return names.find((name) => name === raw) ?? fallback;
65
+ }
66
+ /**
67
+ * Sets the named theme on `document.documentElement` as `data-theme`.
68
+ */
69
+ export function applyThemeName(themeName) {
70
+ document.documentElement.dataset.theme = themeName;
71
+ }
57
72
  /**
58
73
  * A JS string literal for an inline `<script>`: JSON-quoted, with `<`
59
74
  * escaped so the text can never close the script tag.
@@ -14,6 +14,19 @@ type ThemeProviderProps = {
14
14
  /** Saves the preference for SSR, normally a server function setting the cookie. */
15
15
  persistTheme: (theme: Theme) => unknown;
16
16
  onResolvedIsDarkChange?: (isDark: boolean) => void;
17
+ /**
18
+ * The named themes a visitor may pick from, for an app with a theme
19
+ * picker. A named theme is a whole look (`data-theme` on `<html>`), each
20
+ * with a light and a dark mode. Leave out for an app with one fixed theme.
21
+ */
22
+ themeNames?: readonly string[];
23
+ /**
24
+ * The named theme the server rendered on `<html>`, from `getThemeName`.
25
+ * Pass it with `themeNames`.
26
+ */
27
+ initialThemeName?: string;
28
+ /** Saves the named theme for SSR, normally a server function setting the cookie. */
29
+ persistThemeName?: (themeName: string) => unknown;
17
30
  };
18
31
  type ThemeProviderState = {
19
32
  /** The preference: light, dark or system. */
@@ -30,13 +43,25 @@ type ThemeProviderState = {
30
43
  resolvedTheme: "light" | "dark";
31
44
  /** False on the server and the first client render, so their markup matches. */
32
45
  mounted: boolean;
46
+ /** The named themes a visitor may pick from. Empty when the app has one fixed theme. */
47
+ themeNames: readonly string[];
48
+ /** The named theme shown. Undefined when the app offers none. */
49
+ themeName: string | undefined;
50
+ /**
51
+ * Shows a named theme (`data-theme` on `<html>`) and saves it with
52
+ * `persistThemeName`. A name that is not in `themeNames` is ignored.
53
+ */
54
+ setThemeName: (themeName: string) => void;
33
55
  };
34
56
  /**
35
57
  * Manages theme preference (localStorage + cookie) and syncs the `dark` class on `<html>`.
58
+ * With `themeNames` it also holds the named theme a visitor picked and sets
59
+ * it as `data-theme` on `<html>`.
36
60
  */
37
- export declare function ThemeProvider({ children, initialTheme, initialIsDark, storageKey, persistTheme, onResolvedIsDarkChange, }: ThemeProviderProps): React.JSX.Element;
61
+ export declare function ThemeProvider({ children, initialTheme, initialIsDark, storageKey, persistTheme, onResolvedIsDarkChange, themeNames, initialThemeName, persistThemeName, }: ThemeProviderProps): React.JSX.Element;
38
62
  /**
39
- * Hook to access the theme preference, the theme shown, and the setters.
63
+ * Hook to access the theme preference, the theme shown, and the setters,
64
+ * plus the named theme and its setter when the app offers a picker.
40
65
  */
41
66
  export declare const useTheme: () => ThemeProviderState;
42
67
  export {};
@@ -1,12 +1,17 @@
1
1
  import { jsx as _jsx } from "react/jsx-runtime";
2
2
  import * as React from "react";
3
- import { applyDarkClass, resolveIsDark, SYSTEM_DARK_WHEN_UNKNOWN, ThemeSchema, } from "./index.js";
3
+ import { applyDarkClass, applyThemeName, resolveIsDark, SYSTEM_DARK_WHEN_UNKNOWN, ThemeSchema, } from "./index.js";
4
+ /** One array for "no named themes", so the context value keeps its identity. */
5
+ const NO_THEME_NAMES = [];
4
6
  const initialState = {
5
7
  theme: "system",
6
8
  setTheme: () => null,
7
9
  toggleTheme: () => null,
8
10
  resolvedTheme: SYSTEM_DARK_WHEN_UNKNOWN ? "dark" : "light",
9
11
  mounted: false,
12
+ themeNames: NO_THEME_NAMES,
13
+ themeName: undefined,
14
+ setThemeName: () => null,
10
15
  };
11
16
  /**
12
17
  * One context for every copy of this module. TanStack Start bundles this
@@ -51,9 +56,14 @@ function storeTheme(storageKey, theme) {
51
56
  }
52
57
  /**
53
58
  * Manages theme preference (localStorage + cookie) and syncs the `dark` class on `<html>`.
59
+ * With `themeNames` it also holds the named theme a visitor picked and sets
60
+ * it as `data-theme` on `<html>`.
54
61
  */
55
- export function ThemeProvider({ children, initialTheme, initialIsDark = SYSTEM_DARK_WHEN_UNKNOWN, storageKey, persistTheme, onResolvedIsDarkChange, }) {
62
+ export function ThemeProvider({ children, initialTheme, initialIsDark = SYSTEM_DARK_WHEN_UNKNOWN, storageKey, persistTheme, onResolvedIsDarkChange, themeNames = NO_THEME_NAMES, initialThemeName, persistThemeName, }) {
56
63
  const [theme, setThemeState] = React.useState(initialTheme);
64
+ // The server rendered the first one on <html>; after that `setThemeName`
65
+ // sets the attribute itself.
66
+ const [themeName, setThemeNameState] = React.useState(initialThemeName);
57
67
  // The OS preference; undefined until mounted.
58
68
  const [systemPrefersDark, setSystemPrefersDark] = React.useState(undefined);
59
69
  const mounted = systemPrefersDark !== undefined;
@@ -63,6 +73,8 @@ export function ThemeProvider({ children, initialTheme, initialIsDark = SYSTEM_D
63
73
  persistRef.current = persistTheme;
64
74
  const onResolvedIsDarkChangeRef = React.useRef(onResolvedIsDarkChange);
65
75
  onResolvedIsDarkChangeRef.current = onResolvedIsDarkChange;
76
+ const persistThemeNameRef = React.useRef(persistThemeName);
77
+ persistThemeNameRef.current = persistThemeName;
66
78
  React.useEffect(() => {
67
79
  const storedTheme = readStoredTheme(storageKey);
68
80
  if (!storedTheme) {
@@ -102,11 +114,22 @@ export function ThemeProvider({ children, initialTheme, initialIsDark = SYSTEM_D
102
114
  toggleTheme: () => setTheme(resolveIsDark(theme, getSystemPrefersDark()) ? "light" : "dark"),
103
115
  resolvedTheme: isDark ? "dark" : "light",
104
116
  mounted,
117
+ themeNames,
118
+ themeName,
119
+ setThemeName: (newThemeName) => {
120
+ if (!themeNames.includes(newThemeName)) {
121
+ return;
122
+ }
123
+ applyThemeName(newThemeName);
124
+ void persistThemeNameRef.current?.(newThemeName);
125
+ setThemeNameState(newThemeName);
126
+ },
105
127
  };
106
- }, [theme, storageKey, isDark, mounted]);
128
+ }, [theme, storageKey, isDark, mounted, themeNames, themeName]);
107
129
  return (_jsx(ThemeProviderContext.Provider, { value: value, children: children }));
108
130
  }
109
131
  /**
110
- * Hook to access the theme preference, the theme shown, and the setters.
132
+ * Hook to access the theme preference, the theme shown, and the setters,
133
+ * plus the named theme and its setter when the app offers a picker.
111
134
  */
112
135
  export const useTheme = () => React.useContext(ThemeProviderContext);
@@ -10,3 +10,15 @@ export declare function getThemeContext(cookieName: string): ThemeContext;
10
10
  * Persists theme preference in an HTTP cookie for SSR on the next request.
11
11
  */
12
12
  export declare function setThemeCookie(cookieName: string, theme: Theme): void;
13
+ /**
14
+ * Reads the named theme a visitor picked from the `cookieName` cookie: its
15
+ * value when it is one of `names`, else `fallback`. The root route renders it
16
+ * as `data-theme` on `<html>`. The cookie is the only place it is kept, so
17
+ * the server always knows it and the page needs no first-paint script for it.
18
+ */
19
+ export declare function getThemeName<TName extends string>(cookieName: string, names: readonly TName[], fallback: TName): TName;
20
+ /**
21
+ * Persists the named theme in an HTTP cookie for SSR on the next request.
22
+ * The app's server function checks the name against its own list first.
23
+ */
24
+ export declare function setThemeNameCookie(cookieName: string, themeName: string): void;
@@ -1,5 +1,5 @@
1
1
  import { getCookie, getRequestHeader, setCookie, } from "@tanstack/react-start/server";
2
- import { resolveIsDark, SYSTEM_DARK_WHEN_UNKNOWN, ThemeSchema, } from "./index.js";
2
+ import { resolveIsDark, resolveThemeName, SYSTEM_DARK_WHEN_UNKNOWN, ThemeSchema, } from "./index.js";
3
3
  /**
4
4
  * Reads theme preference from the `cookieName` cookie and resolves dark mode
5
5
  * for SSR. For a `system` preference it uses `Sec-CH-Prefers-Color-Scheme`,
@@ -19,13 +19,31 @@ export function getThemeContext(cookieName) {
19
19
  const isDark = resolveIsDark(theme, prefersDark);
20
20
  return { theme, isDark };
21
21
  }
22
+ /** A year, for the whole site. Readable by script: the bootstrap script reads the preference. */
23
+ const THEME_COOKIE_OPTIONS = {
24
+ path: "/",
25
+ maxAge: 60 * 60 * 24 * 365,
26
+ sameSite: "lax",
27
+ };
22
28
  /**
23
29
  * Persists theme preference in an HTTP cookie for SSR on the next request.
24
30
  */
25
31
  export function setThemeCookie(cookieName, theme) {
26
- setCookie(cookieName, theme, {
27
- path: "/",
28
- maxAge: 60 * 60 * 24 * 365,
29
- sameSite: "lax",
30
- });
32
+ setCookie(cookieName, theme, THEME_COOKIE_OPTIONS);
33
+ }
34
+ /**
35
+ * Reads the named theme a visitor picked from the `cookieName` cookie: its
36
+ * value when it is one of `names`, else `fallback`. The root route renders it
37
+ * as `data-theme` on `<html>`. The cookie is the only place it is kept, so
38
+ * the server always knows it and the page needs no first-paint script for it.
39
+ */
40
+ export function getThemeName(cookieName, names, fallback) {
41
+ return resolveThemeName(getCookie(cookieName), names, fallback);
42
+ }
43
+ /**
44
+ * Persists the named theme in an HTTP cookie for SSR on the next request.
45
+ * The app's server function checks the name against its own list first.
46
+ */
47
+ export function setThemeNameCookie(cookieName, themeName) {
48
+ setCookie(cookieName, themeName, THEME_COOKIE_OPTIONS);
31
49
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "singularity-core",
3
- "version": "0.17.0",
3
+ "version": "0.17.1",
4
4
  "description": "Shared non-UI code for Singularity TanStack Start apps: auth sessions, API client middleware, API schemas, paging, route data, images, formatting, HTTP helpers, theme, cookie notice, SEO, security headers and telemetry.",
5
5
  "type": "module",
6
6
  "author": "Filip",