mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-06 21:05:21 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Its UI is the operator's daily surface: task lists, boards, budgets, agent status — all built on shadcn components and Tailwind > - Visual values (colors, spacing, type sizes, radii) were hardcoded at ~1,600 call sites: the same "small gray label" was 9/10/11px depending on the file, charts disagreed with chips about status colors, two toggle-switch implementations coexisted in two greens, and there was no visual regression coverage > - This made the UI drift-prone and made any restyle a hundreds-of-files project, which discourages design iteration > - This pull request extracts visual values into a single token layer in `ui/src/index.css`, adds a Storybook visual regression suite backed by external immutable baseline archives, and then applies a deliberate retune reviewed change-by-change on screenshot diffs > - The benefit is that Paperclip's look becomes a config surface: retheming is a token edit reviewed as a snapshot diff, drift is blocked by a token gate, and future UI PRs can prove exactly what changed visually without committing hundreds of PNGs ## Linked Issues or Issue Description No existing public issue covers this work (searched "design tokens", "visual regression", "design system" across issues and PRs). Related in spirit: Refs #8982 (theming a hardcoded panel — a one-off instance of the same problem class this PR addresses systematically). **Problem (feature-request form):** UI visual values are hardcoded per call site with no source of truth and no regression coverage; consistency depends on reviewer memory, and restyling requires mass file edits. **Proposed solution (this PR):** a single token layer + enforcement gate + externally stored visual snapshot suite, then an intentional restyle on top of that foundation. ## What Changed - **Token extraction (zero visual change, machine-verified during development):** committed codemods (`scripts/codemod-*.mjs`) moved ~1,600 hardcoded color/type/spacing/radius/shadow/misc values into named tokens in a non-inline `:root` block of `ui/src/index.css`. - **Visual regression suite:** `pnpm test:storybook-visual` covers 255 stories × light/dark = 510 Playwright screenshots at `maxDiffPixels: 0`, plus new primitive-coverage stories and deterministic-render fixes. - **External visual baselines:** committed PNG snapshots were removed. `tests/storybook-visual/baseline-manifest.json` pins an immutable archive URL/hash/size/count, and `scripts/storybook-visual-baseline.mjs` handles `download`, `verify`, `pack`, and trusted maintainer `upload` flows. - **Opt-in visual CI artifacts:** added a `Storybook Visual` workflow that runs on manual dispatch or PRs labeled `storybook-visual`, downloads/verifies the baseline, runs Playwright, and uploads Playwright report/test-result artifacts for review. Normal PR runs do not mutate baseline objects. - **Token gate:** `pnpm check:token-gates` — zero hex literals, zero arbitrary bracket values, zero raw font-sizes in `ui/src/components/**` and `ui/src/pages/**`, with a documented inline allowlist for legitimate opt-outs. - **Theme retune (intentional, snapshot-reviewed):** new base theme values; radius ladder derived from a single `--radius` knob; micro-type cluster collapsed to a named ladder (`--text-nano/micro/compact` + Tailwind `text-xs`/`text-sm`); letter-spacing collapsed to named steps. - **One status-color vocabulary:** charts, quota/budget bar fills, RUNNING/live chips, and liveness indicators all use the canonical `--status-*` hues. Light-mode legibility fixes for red alert surfaces that used dark-tuned text classes. - **One switch:** `ToggleSwitch` restyled to the registry capsule form, second hand-rolled implementation removed, and all call sites unified. - **Docs:** `DESIGN.md` is the design contract; `doc/design/` holds audit reports, decision logs, and updated guidance for external baseline review/update workflows. - Dead code removed (`agentStatusBadge` duplicate map), byte-identical contrast constants consolidated, semantic renames (`--project-seed`/`--project-none`, `--liveness-blue`). ## Verification - `pnpm check:token-gates` — 3/3 gates CLEAN during the design-system run - `pnpm typecheck` && `pnpm --filter @paperclipai/ui build` — green during the design-system run - `node --test scripts/__tests__/storybook-visual-baseline.test.mjs` — pass after external-baseline rework - `pnpm exec tsc --noEmit --pretty false --module NodeNext --moduleResolution NodeNext --target ES2022 --types node,@playwright/test tests/storybook-visual/playwright.config.ts tests/storybook-visual/storybook-visual.spec.ts` — pass after external-baseline rework - `git diff --check origin/pr/9134..HEAD` — pass after external-baseline rework - `find tests/storybook-visual -type f -name '*.png' -print | wc -l` — `0` - `node scripts/storybook-visual-baseline.mjs verify` — intentionally fails closed until the first trusted maintainer publishes the baseline archive and updates `baseline-manifest.json` ## Risks - **Large but shallow:** the PR still touches many UI files due to mechanical token extraction and retune work, but committed PNG snapshot churn has been removed from the branch. - **Baseline publication required before the visual suite can pass in clean clones:** the manifest currently has placeholder archive metadata. A trusted maintainer must publish the first immutable archive, then update `baseline-manifest.json`. - **Rendering platform variance:** the external baseline should be captured in the documented Linux/Chromium environment. Future CI runs verify against the pinned archive and fail closed on checksum/count mismatch. - **Visual CI is opt-in while stabilizing:** add the `storybook-visual` label or dispatch the workflow manually to produce downloadable Playwright report/test-result artifacts. - **Scheduled follow-ups, deliberately out of scope:** Tailwind palette classes map to semantic tokens in a dedicated pass; card/pill component consolidation; ESLint ratchet. Tracked in `doc/design/DECISION-SHEET.md`. ## Model Used Claude Fable 5 (Anthropic, `claude-fable-5`, Mythos-class tier) with extended thinking, running in Claude Code with tool use; mechanical phases delegated to Claude Sonnet subagents. Follow-up external-baseline rework assisted by OpenAI Codex (`gpt-5` coding agent with repository, terminal, and GitHub tool use). All bulk rewrites executed via deterministic, idempotent scripts committed in `scripts/`; intentional visual changes were human-reviewed on screenshot contact sheets. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run targeted local verification and documented the intentional baseline-publication failure above - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green *(pending new CI run after this rework)* - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups *(pending review)* - [x] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) and OpenAI Codex --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Dotta <bippadotta@protonmail.com> Co-authored-by: Paperclip <noreply@paperclip.ing>
219 lines
6.3 KiB
TypeScript
219 lines
6.3 KiB
TypeScript
import { useEffect, useMemo, useState } from "react";
|
|
import { cn } from "../lib/utils";
|
|
|
|
const BAYER_4X4 = [
|
|
[0, 8, 2, 10],
|
|
[12, 4, 14, 6],
|
|
[3, 11, 1, 9],
|
|
[15, 7, 13, 5],
|
|
] as const;
|
|
|
|
interface CompanyPatternIconProps {
|
|
companyName: string;
|
|
logoUrl?: string | null;
|
|
brandColor?: string | null;
|
|
className?: string;
|
|
logoFit?: "cover" | "contain";
|
|
}
|
|
|
|
function hashString(value: string): number {
|
|
let hash = 2166136261;
|
|
for (let i = 0; i < value.length; i++) {
|
|
hash ^= value.charCodeAt(i);
|
|
hash = Math.imul(hash, 16777619);
|
|
}
|
|
return hash >>> 0;
|
|
}
|
|
|
|
function mulberry32(seed: number): () => number {
|
|
let state = seed >>> 0;
|
|
return () => {
|
|
state = (state + 0x6d2b79f5) >>> 0;
|
|
let t = Math.imul(state ^ (state >>> 15), 1 | state);
|
|
t ^= t + Math.imul(t ^ (t >>> 7), 61 | t);
|
|
return ((t ^ (t >>> 14)) >>> 0) / 4294967296;
|
|
};
|
|
}
|
|
|
|
function hslToRgb(h: number, s: number, l: number): [number, number, number] {
|
|
const hue = ((h % 360) + 360) % 360;
|
|
const sat = Math.max(0, Math.min(100, s)) / 100;
|
|
const light = Math.max(0, Math.min(100, l)) / 100;
|
|
|
|
const c = (1 - Math.abs(2 * light - 1)) * sat;
|
|
const x = c * (1 - Math.abs(((hue / 60) % 2) - 1));
|
|
const m = light - c / 2;
|
|
|
|
let r = 0;
|
|
let g = 0;
|
|
let b = 0;
|
|
|
|
if (hue < 60) {
|
|
r = c;
|
|
g = x;
|
|
} else if (hue < 120) {
|
|
r = x;
|
|
g = c;
|
|
} else if (hue < 180) {
|
|
g = c;
|
|
b = x;
|
|
} else if (hue < 240) {
|
|
g = x;
|
|
b = c;
|
|
} else if (hue < 300) {
|
|
r = x;
|
|
b = c;
|
|
} else {
|
|
r = c;
|
|
b = x;
|
|
}
|
|
|
|
return [
|
|
Math.round((r + m) * 255),
|
|
Math.round((g + m) * 255),
|
|
Math.round((b + m) * 255),
|
|
];
|
|
}
|
|
|
|
function hexToHue(hex: string): number {
|
|
const r = parseInt(hex.slice(1, 3), 16) / 255;
|
|
const g = parseInt(hex.slice(3, 5), 16) / 255;
|
|
const b = parseInt(hex.slice(5, 7), 16) / 255;
|
|
const max = Math.max(r, g, b);
|
|
const min = Math.min(r, g, b);
|
|
const d = max - min;
|
|
if (d === 0) return 0;
|
|
let h = 0;
|
|
if (max === r) h = ((g - b) / d) % 6;
|
|
else if (max === g) h = (b - r) / d + 2;
|
|
else h = (r - g) / d + 4;
|
|
return ((h * 60) + 360) % 360;
|
|
}
|
|
|
|
function makeCompanyPatternDataUrl(seed: string, brandColor?: string | null, logicalSize = 22, cellSize = 2): string {
|
|
if (typeof document === "undefined") return "";
|
|
|
|
const canvas = document.createElement("canvas");
|
|
canvas.width = logicalSize * cellSize;
|
|
canvas.height = logicalSize * cellSize;
|
|
|
|
const ctx = canvas.getContext("2d");
|
|
if (!ctx) return "";
|
|
|
|
const rand = mulberry32(hashString(seed));
|
|
|
|
const hue = brandColor ? hexToHue(brandColor) : Math.floor(rand() * 360);
|
|
const [offR, offG, offB] = hslToRgb(
|
|
hue,
|
|
54 + Math.floor(rand() * 14),
|
|
36 + Math.floor(rand() * 12),
|
|
);
|
|
const [onR, onG, onB] = hslToRgb(
|
|
hue + (rand() > 0.5 ? 10 : -10),
|
|
86 + Math.floor(rand() * 10),
|
|
82 + Math.floor(rand() * 10),
|
|
);
|
|
|
|
const center = (logicalSize - 1) / 2;
|
|
const half = Math.max(center, 1);
|
|
const gradientAngle = rand() * Math.PI * 2;
|
|
const gradientDirX = Math.cos(gradientAngle);
|
|
const gradientDirY = Math.sin(gradientAngle);
|
|
const maxProjection = Math.abs(gradientDirX * half) + Math.abs(gradientDirY * half);
|
|
const diagonalFrequency = 0.34 + rand() * 0.12;
|
|
const antiDiagonalFrequency = 0.33 + rand() * 0.12;
|
|
const diagonalPhase = rand() * Math.PI * 2;
|
|
const antiDiagonalPhase = rand() * Math.PI * 2;
|
|
|
|
// token-extraction: allowlisted — canvas 2D fillStyle computed at runtime from numeric channel props; not a static literal.
|
|
ctx.fillStyle = `rgb(${offR} ${offG} ${offB})`;
|
|
ctx.fillRect(0, 0, canvas.width, canvas.height);
|
|
|
|
ctx.fillStyle = `rgb(${onR} ${onG} ${onB})`;
|
|
const dotRadius = cellSize * 0.46;
|
|
|
|
for (let y = 0; y < logicalSize; y++) {
|
|
const dy = y - center;
|
|
|
|
for (let x = 0; x < logicalSize; x++) {
|
|
const dx = x - center;
|
|
|
|
// Side-to-side signal where visible gradient is produced by dither density.
|
|
const projection = dx * gradientDirX + dy * gradientDirY;
|
|
const gradient = (projection / maxProjection + 1) * 0.5;
|
|
const diagonal = Math.sin((dx + dy) * diagonalFrequency + diagonalPhase) * 0.5 + 0.5;
|
|
const antiDiagonal = Math.sin((dx - dy) * antiDiagonalFrequency + antiDiagonalPhase) * 0.5 + 0.5;
|
|
const hatch = diagonal * 0.5 + antiDiagonal * 0.5;
|
|
const signal = Math.max(0, Math.min(1, gradient + (hatch - 0.5) * 0.22));
|
|
|
|
// Canonical 16-level ordered dither: level 0..15 compared to Bayer 4x4 threshold index.
|
|
const level = Math.max(0, Math.min(15, Math.floor(signal * 16)));
|
|
const thresholdIndex = BAYER_4X4[y & 3]![x & 3]!;
|
|
if (level <= thresholdIndex) continue;
|
|
|
|
const cx = x * cellSize + cellSize / 2;
|
|
const cy = y * cellSize + cellSize / 2;
|
|
ctx.beginPath();
|
|
ctx.arc(cx, cy, dotRadius, 0, Math.PI * 2);
|
|
ctx.fill();
|
|
}
|
|
}
|
|
|
|
return canvas.toDataURL("image/png");
|
|
}
|
|
|
|
export function CompanyPatternIcon({
|
|
companyName,
|
|
logoUrl,
|
|
brandColor,
|
|
className,
|
|
logoFit = "cover",
|
|
}: CompanyPatternIconProps) {
|
|
const initial = companyName.trim().charAt(0).toUpperCase() || "?";
|
|
const [imageError, setImageError] = useState(false);
|
|
const logo = !imageError && typeof logoUrl === "string" && logoUrl.trim().length > 0 ? logoUrl : null;
|
|
useEffect(() => {
|
|
setImageError(false);
|
|
}, [logoUrl]);
|
|
const patternDataUrl = useMemo(
|
|
() => makeCompanyPatternDataUrl(companyName.trim().toLowerCase(), brandColor),
|
|
[companyName, brandColor],
|
|
);
|
|
|
|
return (
|
|
<div
|
|
className={cn(
|
|
"relative flex items-center justify-center w-11 h-11 text-base font-semibold text-white overflow-hidden",
|
|
className,
|
|
)}
|
|
>
|
|
{logo ? (
|
|
<img
|
|
src={logo}
|
|
alt={`${companyName} logo`}
|
|
onError={() => setImageError(true)}
|
|
className={cn(
|
|
"absolute inset-0 h-full w-full",
|
|
logoFit === "contain" ? "object-contain" : "object-cover",
|
|
)}
|
|
/>
|
|
) : patternDataUrl ? (
|
|
<img
|
|
src={patternDataUrl}
|
|
alt=""
|
|
aria-hidden="true"
|
|
className="absolute inset-0 h-full w-full"
|
|
style={{ imageRendering: "pixelated" }}
|
|
/>
|
|
) : (
|
|
<div className="absolute inset-0 bg-muted" />
|
|
)}
|
|
{!logo && (
|
|
<span className="relative z-10 drop-shadow-(--drop-shadow-extract-1)">
|
|
{initial}
|
|
</span>
|
|
)}
|
|
</div>
|
|
);
|
|
}
|