mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-25 02:26:12 +02:00
Changes for the UX review items on PAP-9436: - Highlights are now translucent boxes with state-specific outlines instead of baseline borders. Focused open anchors get a 2px primary outline plus fill so they read as a real "lift"; stale anchors get a dashed amber outline plus a ⚠ glyph at the run end; resolved anchors stay dashed and dim. - Document count chip lives inside the document header row (next to the rev/updated chrome) via a new DocumentAnnotationsCountChip component, so it stays visible while the document is folded and conforms to neighbor rhythm. IssueDocumentAnnotations now exposes only the body wrapper + side panel and accepts controlled panelOpen state from the section. - Comment authors render as `<name> · <role>` (e.g. `Dotta · board`, `UXDesigner · agent`) using the same agentMap / userProfileMap that IssueDetail already builds for IssueComments. Maps flow through IssueDocumentsSection → IssueDocumentAnnotations → DocumentAnnotationPanel. - Side panel header drops the duplicate "PLAN" pill — the doc key already brought the user here. Header now reads `Comments / rev N`. - Filter chips are real low-contrast chips (rounded ghost buttons with an active background tint) instead of three-weight Button variants. - Thread action row is now Resolve (secondary) + Reply (primary), with Copy link collapsed into a `…` overflow dropdown. - Persistent "+ New comment on selection" CTA pinned to the bottom of the panel with a ⌘⇧M keyboard shortcut. The CTA disables itself when a draft is dirty / conflicted / previewing history, matching the same gate the body selection toolbar already enforced. - ThreadCard expanded state now uses `ring-1 ring-ring/70` rather than `border-primary/60` so the focus affordance is the standard design-system ring. - Mobile bottom sheet is now the real shadcn Sheet (`SheetContent side="bottom"`) — backdrop, focus trap, drag handle, motion all come from the primitive. - IssueDocumentsSection accepts storybook-only seeds (`defaultAnnotationPanelOpenKeys`, `defaultAnnotationFocusedThreadIds`, `forceEditDocumentKey`) so we can capture deterministic integrated screenshots instead of Storybook-isolated panel mocks. - New integrated Storybook stories render the real IssueDocumentsSection chrome at 1440×900 desktop + 390×844 mobile, with edit-mode and dirty- draft variants. Stale state-only stories kept for visual debugging. - design/PAP-9436-doc-annotation-ui/screenshots/ refreshed: the old Storybook-isolated captures are removed; 5 new integrated captures (01–05) replace them, and 4 isolated state captures (10–13) remain for reference. Tests: - Existing unit tests updated to the controlled-panel contract; new tests cover author identity rendering (`<name> · <role>`) and the persistent CTA. - `pnpm vitest run` over the annotation surface (4 files, 23 tests) green. Co-Authored-By: Paperclip <noreply@paperclip.ing>
105 lines
4.6 KiB
JavaScript
105 lines
4.6 KiB
JavaScript
#!/usr/bin/env node
|
|
// Capture screenshots of the Document Annotation storybook stories.
|
|
// Usage: node scripts/screenshot-doc-annotations.mjs <storybook-static-dir> <output-dir>
|
|
|
|
import http from "node:http";
|
|
import path from "node:path";
|
|
import fs from "node:fs/promises";
|
|
import { chromium } from "@playwright/test";
|
|
|
|
async function main() {
|
|
const [, , staticDir, outDir] = process.argv;
|
|
if (!staticDir || !outDir) {
|
|
console.error("usage: node scripts/screenshot-doc-annotations.mjs <storybook-static-dir> <output-dir>");
|
|
process.exit(1);
|
|
}
|
|
await fs.mkdir(outDir, { recursive: true });
|
|
const absStaticDir = path.resolve(staticDir);
|
|
|
|
const server = http.createServer(async (req, res) => {
|
|
try {
|
|
let urlPath = decodeURIComponent((req.url || "/").split("?")[0]);
|
|
if (urlPath.endsWith("/")) urlPath += "iframe.html";
|
|
const filePath = path.resolve(absStaticDir, `.${urlPath}`);
|
|
if (!filePath.startsWith(absStaticDir + path.sep) && filePath !== absStaticDir) {
|
|
res.writeHead(403);
|
|
res.end("Forbidden");
|
|
return;
|
|
}
|
|
const buf = await fs.readFile(filePath);
|
|
const ext = path.extname(filePath).toLowerCase();
|
|
const mime = {
|
|
".html": "text/html; charset=utf-8",
|
|
".js": "application/javascript",
|
|
".css": "text/css",
|
|
".json": "application/json",
|
|
".svg": "image/svg+xml",
|
|
".png": "image/png",
|
|
".woff": "font/woff",
|
|
".woff2": "font/woff2",
|
|
".map": "application/json",
|
|
}[ext] || "application/octet-stream";
|
|
res.writeHead(200, { "content-type": mime });
|
|
res.end(buf);
|
|
} catch (err) {
|
|
res.writeHead(404);
|
|
res.end(String(err));
|
|
}
|
|
});
|
|
|
|
await new Promise((resolve) => server.listen(0, "127.0.0.1", resolve));
|
|
const port = server.address().port;
|
|
const baseUrl = `http://127.0.0.1:${port}/iframe.html`;
|
|
|
|
const browser = await chromium.launch();
|
|
try {
|
|
const stories = [
|
|
// INTEGRATED — these are the captures the UX gate requires. They render
|
|
// IssueDocumentsSection chrome (count chip in header row, body + side panel
|
|
// wired together, edit mode wrapping the layer, real shadcn Sheet on mobile).
|
|
{ id: "product-documents-annotations--integrated-desktop-open", file: "01-integrated-desktop-open.png", width: 1440, height: 900 },
|
|
{ id: "product-documents-annotations--integrated-desktop-zero-comments", file: "02-integrated-desktop-zero-count.png", width: 1440, height: 900 },
|
|
{ id: "product-documents-annotations--integrated-desktop-edit-mode", file: "03-integrated-desktop-edit-mode.png", width: 1440, height: 900 },
|
|
{ id: "product-documents-annotations--integrated-desktop-dirty-draft", file: "04-integrated-desktop-dirty-draft.png", width: 1440, height: 900 },
|
|
{ id: "product-documents-annotations--integrated-mobile-bottom-sheet", file: "05-integrated-mobile-sheet.png", width: 390, height: 844 },
|
|
// ISOLATED — kept around for visual debugging of state pieces.
|
|
{ id: "product-documents-annotations--desktop-open-focused", file: "10-states-open-focused.png", width: 1280, height: 900 },
|
|
{ id: "product-documents-annotations--desktop-resolved-focused", file: "11-states-resolved-focused.png", width: 1280, height: 900 },
|
|
{ id: "product-documents-annotations--desktop-stale-focused", file: "12-states-stale-focused.png", width: 1280, height: 900 },
|
|
{ id: "product-documents-annotations--desktop-orphaned-focused", file: "13-states-orphaned-focused.png", width: 1280, height: 900 },
|
|
];
|
|
|
|
const themeArg = (process.env.SCREENSHOT_THEME || "dark").toLowerCase();
|
|
const theme = themeArg === "light" ? "light" : "dark";
|
|
|
|
for (const story of stories) {
|
|
const ctx = await browser.newContext({
|
|
viewport: { width: story.width, height: story.height },
|
|
deviceScaleFactor: 2,
|
|
colorScheme: theme,
|
|
});
|
|
const page = await ctx.newPage();
|
|
const url = `${baseUrl}?id=${story.id}&viewMode=story&globals=theme:${theme}`;
|
|
await page.goto(url, { waitUntil: "networkidle" });
|
|
await page.evaluate((appliedTheme) => {
|
|
document.documentElement.classList.toggle("dark", appliedTheme === "dark");
|
|
document.documentElement.style.colorScheme = appliedTheme;
|
|
}, theme);
|
|
// Allow async query prefill + the layer's interval-driven layout pass to settle.
|
|
await page.waitForTimeout(900);
|
|
const out = path.join(outDir, story.file);
|
|
await page.screenshot({ path: out, fullPage: false });
|
|
console.log("wrote", out);
|
|
await ctx.close();
|
|
}
|
|
} finally {
|
|
await browser.close();
|
|
server.close();
|
|
}
|
|
}
|
|
|
|
main().catch((err) => {
|
|
console.error(err);
|
|
process.exit(1);
|
|
});
|