mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 18:10: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>
309 lines
15 KiB
TypeScript
309 lines
15 KiB
TypeScript
import { Navigate, Outlet, Route, Routes, useLocation, useParams } from "@/lib/router";
|
|
import { Button } from "@/components/ui/button";
|
|
import { Layout } from "./components/Layout";
|
|
import { OnboardingWizard } from "./components/OnboardingWizard";
|
|
import { CloudAccessGate } from "./components/CloudAccessGate";
|
|
import { Dashboard } from "./pages/Dashboard";
|
|
import { Companies } from "./pages/Companies";
|
|
import { Agents } from "./pages/Agents";
|
|
import { AgentDetail } from "./pages/AgentDetail";
|
|
import { Projects } from "./pages/Projects";
|
|
import { ProjectDetail } from "./pages/ProjectDetail";
|
|
import { ProjectWorkspaceDetail } from "./pages/ProjectWorkspaceDetail";
|
|
import { Workspaces } from "./pages/Workspaces";
|
|
import { Issues } from "./pages/Issues";
|
|
import { IssueDetail } from "./pages/IssueDetail";
|
|
import { Routines } from "./pages/Routines";
|
|
import { RoutineDetail } from "./pages/RoutineDetail";
|
|
import { UserProfile } from "./pages/UserProfile";
|
|
import { ExecutionWorkspaceDetail } from "./pages/ExecutionWorkspaceDetail";
|
|
import { Goals } from "./pages/Goals";
|
|
import { GoalDetail } from "./pages/GoalDetail";
|
|
import { Approvals } from "./pages/Approvals";
|
|
import { ApprovalDetail } from "./pages/ApprovalDetail";
|
|
import { Costs } from "./pages/Costs";
|
|
import { Activity } from "./pages/Activity";
|
|
import { Inbox } from "./pages/Inbox";
|
|
import { CompanySettings } from "./pages/CompanySettings";
|
|
import { CompanyAccess } from "./pages/CompanyAccess";
|
|
import { CompanyInvites } from "./pages/CompanyInvites";
|
|
import { CompanySkills } from "./pages/CompanySkills";
|
|
import { CompanyExport } from "./pages/CompanyExport";
|
|
import { CompanyImport } from "./pages/CompanyImport";
|
|
import { DesignGuide } from "./pages/DesignGuide";
|
|
import { InstanceGeneralSettings } from "./pages/InstanceGeneralSettings";
|
|
import { InstanceAccess } from "./pages/InstanceAccess";
|
|
import { InstanceSettings } from "./pages/InstanceSettings";
|
|
import { InstanceExperimentalSettings } from "./pages/InstanceExperimentalSettings";
|
|
import { ProfileSettings } from "./pages/ProfileSettings";
|
|
import { PluginManager } from "./pages/PluginManager";
|
|
import { PluginSettings } from "./pages/PluginSettings";
|
|
import { AdapterManager } from "./pages/AdapterManager";
|
|
import { PluginPage } from "./pages/PluginPage";
|
|
import { OrgChart } from "./pages/OrgChart";
|
|
import { NewAgent } from "./pages/NewAgent";
|
|
import { AuthPage } from "./pages/Auth";
|
|
import { BoardClaimPage } from "./pages/BoardClaim";
|
|
import { CliAuthPage } from "./pages/CliAuth";
|
|
import { InviteLandingPage } from "./pages/InviteLanding";
|
|
import { JoinRequestQueue } from "./pages/JoinRequestQueue";
|
|
import { NotFoundPage } from "./pages/NotFound";
|
|
import { useCompany } from "./context/CompanyContext";
|
|
import { useDialog } from "./context/DialogContext";
|
|
import { loadLastInboxTab } from "./lib/inbox";
|
|
import { shouldRedirectCompanylessRouteToOnboarding } from "./lib/onboarding-route";
|
|
|
|
function boardRoutes() {
|
|
return (
|
|
<>
|
|
<Route index element={<Navigate to="dashboard" replace />} />
|
|
<Route path="dashboard" element={<Dashboard />} />
|
|
<Route path="onboarding" element={<OnboardingRoutePage />} />
|
|
<Route path="companies" element={<Companies />} />
|
|
<Route path="company/settings" element={<CompanySettings />} />
|
|
<Route path="company/settings/access" element={<CompanyAccess />} />
|
|
<Route path="company/settings/invites" element={<CompanyInvites />} />
|
|
<Route path="company/export/*" element={<CompanyExport />} />
|
|
<Route path="company/import" element={<CompanyImport />} />
|
|
<Route path="skills/*" element={<CompanySkills />} />
|
|
<Route path="settings" element={<LegacySettingsRedirect />} />
|
|
<Route path="settings/*" element={<LegacySettingsRedirect />} />
|
|
<Route path="plugins/:pluginId" element={<PluginPage />} />
|
|
<Route path="org" element={<OrgChart />} />
|
|
<Route path="agents" element={<Navigate to="/agents/all" replace />} />
|
|
<Route path="agents/all" element={<Agents />} />
|
|
<Route path="agents/active" element={<Agents />} />
|
|
<Route path="agents/paused" element={<Agents />} />
|
|
<Route path="agents/error" element={<Agents />} />
|
|
<Route path="agents/new" element={<NewAgent />} />
|
|
<Route path="agents/:agentId" element={<AgentDetail />} />
|
|
<Route path="agents/:agentId/:tab" element={<AgentDetail />} />
|
|
<Route path="agents/:agentId/runs/:runId" element={<AgentDetail />} />
|
|
<Route path="projects" element={<Projects />} />
|
|
<Route path="projects/:projectId" element={<ProjectDetail />} />
|
|
<Route path="projects/:projectId/overview" element={<ProjectDetail />} />
|
|
<Route path="projects/:projectId/issues" element={<ProjectDetail />} />
|
|
<Route path="projects/:projectId/issues/:filter" element={<ProjectDetail />} />
|
|
<Route path="projects/:projectId/workspaces/:workspaceId" element={<ProjectWorkspaceDetail />} />
|
|
<Route path="projects/:projectId/workspaces" element={<ProjectDetail />} />
|
|
<Route path="projects/:projectId/configuration" element={<ProjectDetail />} />
|
|
<Route path="projects/:projectId/budget" element={<ProjectDetail />} />
|
|
<Route path="workspaces" element={<Workspaces />} />
|
|
<Route path="issues" element={<Issues />} />
|
|
<Route path="issues/all" element={<Navigate to="/issues" replace />} />
|
|
<Route path="issues/active" element={<Navigate to="/issues" replace />} />
|
|
<Route path="issues/backlog" element={<Navigate to="/issues" replace />} />
|
|
<Route path="issues/done" element={<Navigate to="/issues" replace />} />
|
|
<Route path="issues/recent" element={<Navigate to="/issues" replace />} />
|
|
<Route path="issues/:issueId" element={<IssueDetail />} />
|
|
<Route path="routines" element={<Routines />} />
|
|
<Route path="routines/:routineId" element={<RoutineDetail />} />
|
|
<Route path="execution-workspaces/:workspaceId" element={<ExecutionWorkspaceDetail />} />
|
|
<Route path="execution-workspaces/:workspaceId/configuration" element={<ExecutionWorkspaceDetail />} />
|
|
<Route path="execution-workspaces/:workspaceId/runtime-logs" element={<ExecutionWorkspaceDetail />} />
|
|
<Route path="execution-workspaces/:workspaceId/issues" element={<ExecutionWorkspaceDetail />} />
|
|
<Route path="goals" element={<Goals />} />
|
|
<Route path="goals/:goalId" element={<GoalDetail />} />
|
|
<Route path="approvals" element={<Navigate to="/approvals/pending" replace />} />
|
|
<Route path="approvals/pending" element={<Approvals />} />
|
|
<Route path="approvals/all" element={<Approvals />} />
|
|
<Route path="approvals/:approvalId" element={<ApprovalDetail />} />
|
|
<Route path="costs" element={<Costs />} />
|
|
<Route path="activity" element={<Activity />} />
|
|
<Route path="inbox" element={<InboxRootRedirect />} />
|
|
<Route path="inbox/mine" element={<Inbox />} />
|
|
<Route path="inbox/recent" element={<Inbox />} />
|
|
<Route path="inbox/unread" element={<Inbox />} />
|
|
<Route path="inbox/all" element={<Inbox />} />
|
|
<Route path="inbox/requests" element={<JoinRequestQueue />} />
|
|
<Route path="inbox/new" element={<Navigate to="/inbox/mine" replace />} />
|
|
<Route path="u/:userSlug" element={<UserProfile />} />
|
|
<Route path="design-guide" element={<DesignGuide />} />
|
|
<Route path="instance/settings/adapters" element={<AdapterManager />} />
|
|
<Route path=":pluginRoutePath" element={<PluginPage />} />
|
|
<Route path="*" element={<NotFoundPage scope="board" />} />
|
|
</>
|
|
);
|
|
}
|
|
|
|
function InboxRootRedirect() {
|
|
return <Navigate to={`/inbox/${loadLastInboxTab()}`} replace />;
|
|
}
|
|
|
|
function LegacySettingsRedirect() {
|
|
const location = useLocation();
|
|
return <Navigate to={`/instance/settings/general${location.search}${location.hash}`} replace />;
|
|
}
|
|
|
|
function OnboardingRoutePage() {
|
|
const { companies } = useCompany();
|
|
const { openOnboarding } = useDialog();
|
|
const { companyPrefix } = useParams<{ companyPrefix?: string }>();
|
|
const matchedCompany = companyPrefix
|
|
? companies.find((company) => company.issuePrefix.toUpperCase() === companyPrefix.toUpperCase()) ?? null
|
|
: null;
|
|
|
|
const title = matchedCompany
|
|
? `Add another agent to ${matchedCompany.name}`
|
|
: companies.length > 0
|
|
? "Create another company"
|
|
: "Create your first company";
|
|
const description = matchedCompany
|
|
? "Run onboarding again to add an agent and a starter task for this company."
|
|
: companies.length > 0
|
|
? "Run onboarding again to create another company and seed its first agent."
|
|
: "Get started by creating a company and your first agent.";
|
|
|
|
return (
|
|
<div className="mx-auto max-w-xl py-10">
|
|
<div className="rounded-lg border border-border bg-card p-6">
|
|
<h1 className="text-xl font-semibold">{title}</h1>
|
|
<p className="mt-2 text-sm text-muted-foreground">{description}</p>
|
|
<div className="mt-4">
|
|
<Button
|
|
onClick={() =>
|
|
matchedCompany
|
|
? openOnboarding({ initialStep: 2, companyId: matchedCompany.id })
|
|
: openOnboarding()
|
|
}
|
|
>
|
|
{matchedCompany ? "Add Agent" : "Start Onboarding"}
|
|
</Button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function CompanyRootRedirect() {
|
|
const { companies, selectedCompany, loading } = useCompany();
|
|
const location = useLocation();
|
|
|
|
if (loading) {
|
|
return <div className="mx-auto max-w-xl py-10 text-sm text-muted-foreground">Loading...</div>;
|
|
}
|
|
|
|
const targetCompany = selectedCompany ?? companies[0] ?? null;
|
|
if (!targetCompany) {
|
|
if (
|
|
shouldRedirectCompanylessRouteToOnboarding({
|
|
pathname: location.pathname,
|
|
hasCompanies: false,
|
|
})
|
|
) {
|
|
return <Navigate to="/onboarding" replace />;
|
|
}
|
|
return <NoCompaniesStartPage />;
|
|
}
|
|
|
|
return <Navigate to={`/${targetCompany.issuePrefix}/dashboard`} replace />;
|
|
}
|
|
|
|
function UnprefixedBoardRedirect() {
|
|
const location = useLocation();
|
|
const { companies, selectedCompany, loading } = useCompany();
|
|
|
|
if (loading) {
|
|
return <div className="mx-auto max-w-xl py-10 text-sm text-muted-foreground">Loading...</div>;
|
|
}
|
|
|
|
const targetCompany = selectedCompany ?? companies[0] ?? null;
|
|
if (!targetCompany) {
|
|
if (
|
|
shouldRedirectCompanylessRouteToOnboarding({
|
|
pathname: location.pathname,
|
|
hasCompanies: false,
|
|
})
|
|
) {
|
|
return <Navigate to="/onboarding" replace />;
|
|
}
|
|
return <NoCompaniesStartPage />;
|
|
}
|
|
|
|
return (
|
|
<Navigate
|
|
to={`/${targetCompany.issuePrefix}${location.pathname}${location.search}${location.hash}`}
|
|
replace
|
|
/>
|
|
);
|
|
}
|
|
|
|
function NoCompaniesStartPage() {
|
|
const { openOnboarding } = useDialog();
|
|
|
|
return (
|
|
<div className="mx-auto max-w-xl py-10">
|
|
<div className="rounded-lg border border-border bg-card p-6">
|
|
<h1 className="text-xl font-semibold">Create your first company</h1>
|
|
<p className="mt-2 text-sm text-muted-foreground">
|
|
Get started by creating a company.
|
|
</p>
|
|
<div className="mt-4">
|
|
<Button onClick={() => openOnboarding()}>New Company</Button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export function App() {
|
|
return (
|
|
<>
|
|
<Routes>
|
|
<Route path="auth" element={<AuthPage />} />
|
|
<Route path="board-claim/:token" element={<BoardClaimPage />} />
|
|
<Route path="cli-auth/:id" element={<CliAuthPage />} />
|
|
<Route path="invite/:token" element={<InviteLandingPage />} />
|
|
|
|
<Route element={<CloudAccessGate />}>
|
|
<Route index element={<CompanyRootRedirect />} />
|
|
<Route path="onboarding" element={<OnboardingRoutePage />} />
|
|
<Route path="instance" element={<Navigate to="/instance/settings/general" replace />} />
|
|
<Route path="instance/settings" element={<Layout />}>
|
|
<Route index element={<Navigate to="general" replace />} />
|
|
<Route path="profile" element={<ProfileSettings />} />
|
|
<Route path="general" element={<InstanceGeneralSettings />} />
|
|
<Route path="access" element={<InstanceAccess />} />
|
|
<Route path="heartbeats" element={<InstanceSettings />} />
|
|
<Route path="experimental" element={<InstanceExperimentalSettings />} />
|
|
<Route path="plugins" element={<PluginManager />} />
|
|
<Route path="plugins/:pluginId" element={<PluginSettings />} />
|
|
<Route path="adapters" element={<AdapterManager />} />
|
|
</Route>
|
|
<Route path="companies" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="issues" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="issues/:issueId" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="routines" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="routines/:routineId" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="u/:userSlug" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="skills/*" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="settings" element={<LegacySettingsRedirect />} />
|
|
<Route path="settings/*" element={<LegacySettingsRedirect />} />
|
|
<Route path="agents" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="agents/new" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="agents/:agentId" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="agents/:agentId/:tab" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="agents/:agentId/runs/:runId" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="projects" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="projects/:projectId" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="projects/:projectId/overview" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="projects/:projectId/issues" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="projects/:projectId/issues/:filter" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="projects/:projectId/workspaces" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="projects/:projectId/workspaces/:workspaceId" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="projects/:projectId/configuration" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="workspaces" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="execution-workspaces/:workspaceId" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="execution-workspaces/:workspaceId/configuration" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="execution-workspaces/:workspaceId/runtime-logs" element={<UnprefixedBoardRedirect />} />
|
|
<Route path="execution-workspaces/:workspaceId/issues" element={<UnprefixedBoardRedirect />} />
|
|
<Route path=":companyPrefix" element={<Layout />}>
|
|
{boardRoutes()}
|
|
</Route>
|
|
<Route path="*" element={<NotFoundPage scope="global" />} />
|
|
</Route>
|
|
</Routes>
|
|
<OnboardingWizard />
|
|
</>
|
|
);
|
|
}
|