mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-16 02:40:39 +09:00
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - The board UI is the main operator surface, so its component and workflow coverage needs to stay reviewable as the product grows. > - This branch adds Storybook as a dedicated UI reference surface for core Paperclip screens and interaction patterns. > - That work spans Storybook infrastructure, app-level provider wiring, and a large fixture set that can render real control-plane states without a live backend. > - The branch also expands coverage across agents, budgets, issues, chat, dialogs, navigation, projects, and data visualization so future UI changes have a concrete visual baseline. > - This pull request packages that Storybook work on top of the latest `master`, excludes the lockfile from the final diff per repo policy, and fixes one fixture contract drift caught during verification. > - The benefit is a single reviewable PR that adds broad UI documentation and regression-surfacing coverage without losing the existing branch work. ## What Changed - Added Storybook 10 wiring for the UI package, including root scripts, UI package scripts, Storybook config, preview wrappers, Tailwind entrypoints, and setup docs. - Added a large fixture-backed data source for Storybook so complex board states can render without a live server. - Added story suites covering foundations, status language, control-plane surfaces, overview, UX labs, agent management, budget and finance, forms and editors, issue management, navigation and layout, chat and comments, data visualization, dialogs and modals, and projects/goals/workspaces. - Adjusted several UI components for Storybook parity so dialogs, menus, keyboard shortcuts, budget markers, markdown editing, and related surfaces render correctly in isolation. - Rebasing work for PR assembly: replayed the branch onto current `master`, removed `pnpm-lock.yaml` from the final PR diff, and aligned the dashboard fixture with the current `DashboardSummary.runActivity` API contract. ## Verification - `pnpm --filter @paperclipai/ui typecheck` - `pnpm --filter @paperclipai/ui build-storybook` - Manual diff audit after rebase: verified the PR no longer includes `pnpm-lock.yaml` and now cleanly targets current `master`. - Before/after UI note: before this branch there was no dedicated Storybook surface for these Paperclip views; after this branch the local Storybook build includes the new overview and domain story suites in `ui/storybook-static`. ## Risks - Large static fixture files can drift from shared types as dashboard and UI contracts evolve; this PR already needed one fixture correction for `runActivity`. - Storybook bundle output includes some large chunks, so future growth may need chunking work if build performance becomes an issue. - Several component tweaks were made for isolated rendering parity, so reviewers should spot-check key board surfaces against the live app behavior. ## Model Used - OpenAI Codex, GPT-5-based coding agent in the Paperclip harness; exact serving model ID is not exposed in-runtime to the agent. - Tool-assisted workflow with terminal execution, git operations, local typecheck/build verification, and GitHub CLI PR creation. - Context window/reasoning mode not surfaced by the harness. ## 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
256 lines
9.2 KiB
TypeScript
256 lines
9.2 KiB
TypeScript
import { useState } from "react";
|
|
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
|
import {
|
|
BookOpen,
|
|
LogOut,
|
|
type LucideIcon,
|
|
Moon,
|
|
Settings,
|
|
UserRound,
|
|
Sun,
|
|
UserRoundPen,
|
|
} from "lucide-react";
|
|
import type { DeploymentMode } from "@paperclipai/shared";
|
|
import { Link } from "@/lib/router";
|
|
import { authApi } from "@/api/auth";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
import { useSidebar } from "../context/SidebarContext";
|
|
import { useTheme } from "../context/ThemeContext";
|
|
import { Popover, PopoverContent, PopoverTrigger } from "@/components/ui/popover";
|
|
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar";
|
|
import { cn } from "../lib/utils";
|
|
|
|
const PROFILE_SETTINGS_PATH = "/instance/settings/profile";
|
|
const DOCS_URL = "https://docs.paperclip.ing/";
|
|
|
|
interface SidebarAccountMenuProps {
|
|
deploymentMode?: DeploymentMode;
|
|
instanceSettingsTarget: string;
|
|
open?: boolean;
|
|
onOpenChange?: (open: boolean) => void;
|
|
version?: string | null;
|
|
}
|
|
|
|
interface MenuActionProps {
|
|
label: string;
|
|
description: string;
|
|
icon: LucideIcon;
|
|
onClick?: () => void;
|
|
href?: string;
|
|
external?: boolean;
|
|
}
|
|
|
|
function deriveInitials(name: string) {
|
|
const parts = name.trim().split(/\s+/).filter(Boolean);
|
|
if (parts.length >= 2) {
|
|
return `${parts[0]?.[0] ?? ""}${parts[parts.length - 1]?.[0] ?? ""}`.toUpperCase();
|
|
}
|
|
return name.slice(0, 2).toUpperCase();
|
|
}
|
|
|
|
function deriveUserSlug(name: string | null | undefined, email: string | null | undefined, id: string | null | undefined) {
|
|
const candidates = [name, email?.split("@")[0], email, id];
|
|
for (const candidate of candidates) {
|
|
const slug = candidate
|
|
?.trim()
|
|
.toLowerCase()
|
|
.replace(/['"]/g, "")
|
|
.replace(/[^a-z0-9]+/g, "-")
|
|
.replace(/^-+|-+$/g, "");
|
|
if (slug) return slug;
|
|
}
|
|
return "me";
|
|
}
|
|
|
|
function MenuAction({ label, description, icon: Icon, onClick, href, external = false }: MenuActionProps) {
|
|
const className =
|
|
"flex w-full items-start gap-3 rounded-xl px-3 py-3 text-left transition-colors hover:bg-accent/60";
|
|
|
|
const content = (
|
|
<>
|
|
<span className="mt-0.5 rounded-lg border border-border bg-background/70 p-2 text-muted-foreground">
|
|
<Icon className="size-4" />
|
|
</span>
|
|
<span className="min-w-0 flex-1">
|
|
<span className="block text-sm font-medium text-foreground">{label}</span>
|
|
<span className="block text-xs text-muted-foreground">{description}</span>
|
|
</span>
|
|
</>
|
|
);
|
|
|
|
if (href) {
|
|
if (external) {
|
|
return (
|
|
<a href={href} target="_blank" rel="noreferrer" className={className} onClick={onClick}>
|
|
{content}
|
|
</a>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<Link to={href} className={className} onClick={onClick}>
|
|
{content}
|
|
</Link>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<button type="button" className={className} onClick={onClick}>
|
|
{content}
|
|
</button>
|
|
);
|
|
}
|
|
|
|
export function SidebarAccountMenu({
|
|
deploymentMode,
|
|
instanceSettingsTarget,
|
|
open: controlledOpen,
|
|
onOpenChange,
|
|
version,
|
|
}: SidebarAccountMenuProps) {
|
|
const [internalOpen, setInternalOpen] = useState(false);
|
|
const queryClient = useQueryClient();
|
|
const { isMobile, setSidebarOpen } = useSidebar();
|
|
const { theme, toggleTheme } = useTheme();
|
|
const open = controlledOpen ?? internalOpen;
|
|
const setOpen = onOpenChange ?? setInternalOpen;
|
|
const { data: session } = useQuery({
|
|
queryKey: queryKeys.auth.session,
|
|
queryFn: () => authApi.getSession(),
|
|
retry: false,
|
|
});
|
|
|
|
const signOutMutation = useMutation({
|
|
mutationFn: () => authApi.signOut(),
|
|
onSuccess: async () => {
|
|
setOpen(false);
|
|
await queryClient.invalidateQueries({ queryKey: queryKeys.auth.session });
|
|
},
|
|
});
|
|
|
|
const displayName = session?.user.name?.trim() || "Board";
|
|
const secondaryLabel =
|
|
session?.user.email?.trim() || (deploymentMode === "authenticated" ? "Signed in" : "Local workspace board");
|
|
const accountBadge = deploymentMode === "authenticated" ? "Account" : "Local";
|
|
const initials = deriveInitials(displayName);
|
|
const profileHref = `/u/${deriveUserSlug(session?.user.name, session?.user.email, session?.user.id)}`;
|
|
|
|
function closeNavigationChrome() {
|
|
setOpen(false);
|
|
if (isMobile) setSidebarOpen(false);
|
|
}
|
|
|
|
return (
|
|
<div className="border-t border-r border-border bg-background px-3 py-2">
|
|
<Popover open={open} onOpenChange={setOpen}>
|
|
<PopoverTrigger asChild>
|
|
<button
|
|
type="button"
|
|
className="flex w-full items-center gap-2.5 px-3 py-2 text-left text-[13px] font-medium text-foreground/80 transition-colors hover:bg-accent/50 hover:text-foreground"
|
|
aria-label="Open account menu"
|
|
>
|
|
<Avatar size="sm">
|
|
{session?.user.image ? <AvatarImage src={session.user.image} alt={displayName} /> : null}
|
|
<AvatarFallback>{initials}</AvatarFallback>
|
|
</Avatar>
|
|
<span className="min-w-0 flex-1 truncate">{displayName}</span>
|
|
</button>
|
|
</PopoverTrigger>
|
|
<PopoverContent
|
|
side="top"
|
|
align="start"
|
|
sideOffset={10}
|
|
className="w-[var(--radix-popover-trigger-width)] overflow-hidden rounded-t-2xl rounded-b-none border-border p-0 shadow-2xl"
|
|
>
|
|
<div className="h-24 bg-[linear-gradient(135deg,hsl(var(--primary))_0%,hsl(var(--accent))_55%,hsl(var(--muted))_100%)]" />
|
|
<div className="-mt-8 px-4 pb-4">
|
|
<div className="flex items-start gap-3">
|
|
<div className="rounded-2xl border-4 border-popover bg-popover p-0.5 shadow-sm">
|
|
<Avatar size="lg">
|
|
{session?.user.image ? <AvatarImage src={session.user.image} alt={displayName} /> : null}
|
|
<AvatarFallback>{initials}</AvatarFallback>
|
|
</Avatar>
|
|
</div>
|
|
<div className="min-w-0 flex-1 pt-1">
|
|
<div className="flex items-center gap-2">
|
|
<h2 className="truncate text-base font-semibold text-foreground">{displayName}</h2>
|
|
<span className="rounded-full bg-accent px-2 py-0.5 text-[10px] font-semibold uppercase tracking-wide text-muted-foreground">
|
|
{accountBadge}
|
|
</span>
|
|
</div>
|
|
<p className="truncate text-sm text-muted-foreground">{secondaryLabel}</p>
|
|
{version ? (
|
|
<p className="mt-1 text-xs text-muted-foreground">Paperclip v{version}</p>
|
|
) : null}
|
|
</div>
|
|
</div>
|
|
|
|
<div className="mt-4 space-y-1">
|
|
<MenuAction
|
|
label="View profile"
|
|
description="Open your activity, task, and usage ledger."
|
|
icon={UserRound}
|
|
href={profileHref}
|
|
onClick={closeNavigationChrome}
|
|
/>
|
|
<MenuAction
|
|
label="Edit profile"
|
|
description="Update your display name and avatar."
|
|
icon={UserRoundPen}
|
|
href={PROFILE_SETTINGS_PATH}
|
|
onClick={closeNavigationChrome}
|
|
/>
|
|
<MenuAction
|
|
label="Instance settings"
|
|
description="Jump back to the last settings page you opened."
|
|
icon={Settings}
|
|
href={instanceSettingsTarget}
|
|
onClick={closeNavigationChrome}
|
|
/>
|
|
<MenuAction
|
|
label="Documentation"
|
|
description="Open Paperclip docs in a new tab."
|
|
icon={BookOpen}
|
|
href={DOCS_URL}
|
|
external
|
|
onClick={() => setOpen(false)}
|
|
/>
|
|
<MenuAction
|
|
label={theme === "dark" ? "Switch to light mode" : "Switch to dark mode"}
|
|
description="Toggle the app appearance."
|
|
icon={theme === "dark" ? Sun : Moon}
|
|
onClick={() => {
|
|
toggleTheme();
|
|
setOpen(false);
|
|
}}
|
|
/>
|
|
{deploymentMode === "authenticated" ? (
|
|
<button
|
|
type="button"
|
|
className={cn(
|
|
"flex w-full items-start gap-3 rounded-xl px-3 py-3 text-left transition-colors hover:bg-destructive/10",
|
|
signOutMutation.isPending && "cursor-not-allowed opacity-60",
|
|
)}
|
|
onClick={() => signOutMutation.mutate()}
|
|
disabled={signOutMutation.isPending}
|
|
>
|
|
<span className="mt-0.5 rounded-lg border border-border bg-background/70 p-2 text-muted-foreground">
|
|
<LogOut className="size-4" />
|
|
</span>
|
|
<span className="min-w-0 flex-1">
|
|
<span className="block text-sm font-medium text-foreground">
|
|
{signOutMutation.isPending ? "Signing out..." : "Sign out"}
|
|
</span>
|
|
<span className="block text-xs text-muted-foreground">
|
|
End this browser session.
|
|
</span>
|
|
</span>
|
|
</button>
|
|
) : null}
|
|
</div>
|
|
</div>
|
|
</PopoverContent>
|
|
</Popover>
|
|
</div>
|
|
);
|
|
}
|