Files
Ekklesia/packages/design-tokens/tests/registry.test.ts
T
ekklesiaandClaude Opus 5 e03d38fcab feat: give every Ekklesia screen one set of design tokens and elements
Modules have owned their own UI since ADR 0021, but the platform has never
said what that UI should look like. Every screen here — the Dashboard shell,
the display host, the module template — invented its own hex colours, font
stack, spacing, and radii, and they already disagreed. A module author had no
vocabulary for "the ordinary panel background", so the only available answer
was to invent one, and two modules would invent two.

Add `@ekklesia/design-tokens`: one validated, enumerable registry of semantic
tokens. A token declares a name, label, description, and default value; its
category and `--ekklesia-*` identifier are derived from the name, so it can
never claim one category while being named for another. Construction rejects
duplicates, malformed names, unknown categories, empty or overlong text, and
any value that is not a bounded literal — no declaration terminator, rule
block, comment, at-rule, `url(`, `!important`, escape, control character, or
markup. A registry that constructs can therefore be emitted as CSS without
escaping, because nothing needing escaping can be in it. That validation is
also what makes a future theme editor implementable rather than aspirational.

Add `@ekklesia/ui`: button, icon button, text input, select, checkbox, field
wrapper, panel, dialog, tabs, table and list primitives, badge, toast, and
empty/error/loading states — every value a token reference, with real
`:focus-visible` treatment and status that never depends on colour alone.
Deliberately small: an element earns its place when two consumers need it.

The stylesheet is a string rather than a `.css` file so the identical bytes
install into a document or an isolated artifact root, and so hover, disabled,
and focus-visible are real CSS rather than JavaScript approximations of them.

`pnpm boundaries` opens exactly two shared roles to modules, by name — every
other role stays rejected — and pins both design packages to the bottom of the
presentation stack. Both are browser-safe by construction, proven by a real
compile of module-shaped source in which `process.env` must fail to typecheck.

The shell installs the defaults at its document root for the Dashboard and the
display; custom properties inherit into module artifacts, so a module reads
`var(--ekklesia-…)` with nothing to import at run time and nothing for a host
to forget to pass.

Co-Authored-By: Claude Opus 5 <[email protected]>
2026-08-27 06:59:44 -05:00

138 lines
4.8 KiB
TypeScript

// @vitest-environment happy-dom
import { describe, expect, it } from "vitest";
import {
DESIGN_TOKEN_CATEGORIES,
DESIGN_TOKEN_STYLE_ATTRIBUTE,
DESIGN_TOKEN_VARIABLE_PREFIX,
designToken,
ekklesiaDesignTokens,
ekklesiaDesignTokenStylesheet,
installEkklesiaDesignTokens,
} from "../src/index.js";
describe("the Ekklesia design token registry", () => {
it("is enumerable and deterministic", () => {
const first = ekklesiaDesignTokens.list();
const second = ekklesiaDesignTokens.list();
expect(first).toBe(second);
expect(Object.isFrozen(first)).toBe(true);
expect(first.length).toBeGreaterThan(0);
expect(first.map((token) => token.name)).toEqual(second.map((token) => token.name));
expect(ekklesiaDesignTokenStylesheet()).toBe(ekklesiaDesignTokenStylesheet());
});
it("declares a unique name and CSS variable for every token", () => {
const names = ekklesiaDesignTokens.list().map((token) => token.name);
const variables = ekklesiaDesignTokens.list().map((token) => token.cssVariable);
expect(new Set(names).size).toBe(names.length);
expect(new Set(variables).size).toBe(variables.length);
expect(variables.every((variable) => variable.startsWith(DESIGN_TOKEN_VARIABLE_PREFIX))).toBe(
true,
);
});
it("gives every token a human-readable label, description, and derived category", () => {
for (const token of ekklesiaDesignTokens.list()) {
expect(token.label.trim().length).toBeGreaterThan(0);
expect(token.description.trim().length).toBeGreaterThan(0);
expect(DESIGN_TOKEN_CATEGORIES).toContain(token.category);
expect(token.name.startsWith(`${token.category}.`)).toBe(true);
}
});
it("covers the semantic families the platform promises", () => {
const names = new Set(ekklesiaDesignTokens.list().map((token) => token.name));
for (const required of [
"background.page",
"background.canvas",
"background.surface",
"background.raised",
"background.overlay",
"background.inset",
"text.primary",
"text.secondary",
"text.muted",
"text.inverse",
"text.success",
"text.warning",
"text.danger",
"accent.base",
"accent.focus",
"border.base",
"border.divider",
"state.hover-background",
"state.pressed-background",
"state.selected-background",
"state.disabled-opacity",
"state.focus-visible-width",
"typography.family-sans",
"typography.size-md",
"typography.weight-bold",
"typography.line-height-normal",
"typography.size-heading-1",
"spacing.md",
"radius.md",
"shadow.md",
"control.height-md",
]) {
expect(names).toContain(required);
}
});
it("pairs every status colour with a non-colour symbol", () => {
for (const status of ["success", "warning", "danger", "info"]) {
expect(ekklesiaDesignTokens.has(`status.${status}-background`)).toBe(true);
expect(ekklesiaDesignTokens.has(`status.${status}-border`)).toBe(true);
const symbol = ekklesiaDesignTokens.get(`status.${status}-symbol`);
expect(symbol?.value.length).toBeGreaterThan(0);
}
});
it("hands component code a var() reference rather than a raw colour", () => {
expect(designToken("text.primary")).toBe("var(--ekklesia-text-primary)");
expect(ekklesiaDesignTokens.variable("text.primary")).toBe("--ekklesia-text-primary");
});
it("emits a stylesheet declaring every registered token exactly once", () => {
const stylesheet = ekklesiaDesignTokenStylesheet();
for (const token of ekklesiaDesignTokens.list()) {
expect(stylesheet.split(`${token.cssVariable}:`).length).toBe(2);
}
});
it("installs the default theme at a document root exactly once and removes what it added", () => {
const remove = installEkklesiaDesignTokens(document);
const installedAgain = installEkklesiaDesignTokens(document);
expect(document.querySelectorAll(`style[${DESIGN_TOKEN_STYLE_ATTRIBUTE}]`).length).toBe(1);
expect(
document
.querySelector(`style[${DESIGN_TOKEN_STYLE_ATTRIBUTE}]`)
?.textContent?.includes("--ekklesia-background-page"),
).toBe(true);
installedAgain();
expect(document.querySelectorAll(`style[${DESIGN_TOKEN_STYLE_ATTRIBUTE}]`).length).toBe(1);
remove();
remove();
expect(document.querySelectorAll(`style[${DESIGN_TOKEN_STYLE_ATTRIBUTE}]`).length).toBe(0);
});
it("installs host-scoped values into an isolated shadow root", () => {
const host = document.createElement("div");
document.body.appendChild(host);
const shadow = host.attachShadow({ mode: "open" });
installEkklesiaDesignTokens(shadow, { scope: "host" });
const style = shadow.querySelector(`style[${DESIGN_TOKEN_STYLE_ATTRIBUTE}]`);
expect(style?.textContent?.startsWith(":host {")).toBe(true);
host.remove();
});
});