Files
PaperClipAI/ui/src/components/task-side-panel/TaskDocumentPanel.tsx
T
DottaandPaperclip cd5f930558 Add shareable image galleries to task documents (#18157)
<!-- entire-trail-link-start -->
https://entire.com/gh/paperclipai/-/trails/247/changes/paperclip/247
<!-- entire-trail-link-end -->

## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Task documents hold plans, reports, and image evidence.
> - Task attachments already have an image gallery.
> - Inline document images had no gallery navigation or image links.
> - This change gives each document a gallery that uses the existing
modal.
> - People can review the image sequence and share a link to one image.

## Linked Issues or Issue Description

**What existing behavior does this improve?**

Image review in task documents, including the side panel and Classic
interface.

**Current behavior**

Inline document images do not open a gallery. People cannot move through
them with arrow keys or share a link to one image.

**Proposed behavior**

Select an image to open the gallery. Use arrow keys or Previous and
Next. The URL records its one-based position, for example
`#document-report&image=2`. Reloading that URL opens the selected image.
Revision links keep their exact saved content.

**Reason and benefit**

People can inspect a document's image evidence in reading order and
share the exact view.

No matching issue was found. The latest 300 open PR titles were checked
for related document gallery work.

## What Changed

- Add a document renderer that collects rendered images in reading
order, including reference-style and repeated images.
- Reuse the gallery modal with optional index-change and focus-return
controls.
- Keep the document owner in the saved tab identity when people switch
between local and other-task documents.
- Match explicit current-task document owners with local document tabs.
Keep review and viewer parameters during gallery navigation.
- Treat another Classic review receipt as a new request while image
navigation retains the selected revision.
- Make inline image controls work with a keyboard. Keep focus in the
modal and restore focus on close.
- Keep document, revision, review, and maximized-view link parameters
during image navigation.
- Fix a Classic revision-cache race found by the browser test. Recheck a
pinned revision when the saved document head changes.
- Update the feature and agent access maps. No new server API or
permission is needed.

## Verification

- Passed 119 focused tests for document galleries, the shared gallery,
document rendering, the revision panel, and hash routing.
- Passed all 3 Chromium journeys: desktop, mobile, and Classic. These
use real uploads and saved document revisions.
- The browser journeys also check explicit current-task owners, review
parameters after reopening, other-task links after tab switches, and a
second Classic review link after Return to latest.
- Browser checks cover keyboard and button navigation, wraparound,
shared-link reload, exact historical content, invalid positions, focus
return and containment, scroll locking, and Escape, Close, and backdrop
dismissal.
- UI typecheck, token gates, map checks, and diff whitespace checks
passed.
- The UI production build passed in the browser harness.
- Earlier browser runs found and then verified the Classic
revision-cache fix. A later build exited 137 while the full test suite
ran. The browser run passed after that suite stopped.
- Full repository typecheck and build could not complete because Cargo
is absent. The full repository test run did not complete within this
sandbox. These checks remain subject to CI.

## Risks

- Image positions follow document reading order. Editing an unpinned
document can change those positions. A revision link retains the saved
sequence.
- The shared modal now uses Radix Escape handling. The existing gallery
tests and nested mobile dialog journey pass.
- No schema change or migration.

## Model Used

OpenAI GPT-6 through Codex. The runtime did not expose a more specific
model ID or context window size. Used reasoning, code editing, shell
commands, and browser automation.

## 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 tests locally and they pass
- [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
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-10-30 07:52:15 -05:00

120 lines
4.6 KiB
TypeScript

import { useState } from "react";
import { useQuery } from "@tanstack/react-query";
import type { IssueDocument } from "@paperclipai/shared";
import { FileQuestion, Loader2 } from "lucide-react";
import { ApiError } from "@/api/client";
import { issuesApi } from "@/api/issues";
import { DocumentAnnotationsCountChip, IssueDocumentAnnotations } from "@/components/IssueDocumentAnnotations";
import { DocumentMarkdownBody } from "@/components/DocumentMarkdownBody";
import { QueryErrorState, useQueryView } from "@/components/QueryView";
import { queryKeys } from "@/lib/queryKeys";
import { documentDisplayTitle } from "@/lib/issue-artifacts";
import { useLocation } from "@/lib/router";
export function TaskDocumentPanel({
issueId,
documentKey,
initialDocument,
revisionId,
documentIssueId,
currentIssueId = issueId,
}: {
issueId: string;
documentKey: string;
initialDocument?: IssueDocument;
revisionId?: string;
documentIssueId?: string;
currentIssueId?: string;
}) {
const location = useLocation();
const [annotationPanelOpen, setAnnotationPanelOpen] = useState(false);
const query = useQuery<IssueDocument | null>({
queryKey: [...queryKeys.issues.documents(issueId), documentKey, ...(revisionId ? ["revision", revisionId] : [])],
queryFn: async () => {
try {
const current = await issuesApi.getDocument(issueId, documentKey);
if (!revisionId) return current;
const revision = await issuesApi.getDocumentRevision(issueId, documentKey, revisionId);
return { ...current, title: revision.title, body: revision.body, format: revision.format,
latestRevisionId: revision.id, latestRevisionNumber: revision.revisionNumber, updatedAt: revision.createdAt };
} catch (error) {
if (error instanceof ApiError && error.status === 404) return null;
throw error;
}
},
initialData: revisionId ? undefined : initialDocument,
});
const view = useQueryView(query);
if (query.isLoading || view.kind === "reconnecting") {
return (
<div className="flex items-center gap-2 py-8 text-sm text-muted-foreground" role="status">
<Loader2 className="size-4 animate-spin" aria-hidden />
Loading document…
</div>
);
}
if (view.kind === "error") {
return (
<div className="py-6">
<QueryErrorState error={query.error} action="load the document" onRetry={view.retry} retrying={view.isFetching} />
</div>
);
}
const document = query.data;
if (!document) {
return (
<div className="flex items-start gap-3 py-8 text-sm" role="status">
<FileQuestion className="mt-0.5 size-5 shrink-0 text-muted-foreground" aria-hidden />
<div className="space-y-1">
<p className="font-medium">{revisionId ? "Reviewed revision unavailable" : "Document no longer available"}</p>
<p className="text-muted-foreground">
{revisionId ? "The exact reviewed revision could not be found. The current version has not been substituted." : "Close this tab or choose another document."}
</p>
</div>
</div>
);
}
return (
<article className="space-y-4">
<header className="space-y-1">
<h2 className="text-lg font-semibold">{documentDisplayTitle(document)}</h2>
<div className="flex flex-wrap items-center gap-1 text-xs text-muted-foreground">
<span>{`Revision ${document.latestRevisionNumber ?? 1}`}</span>
<span aria-hidden>·</span>
<span>{`Updated ${new Date(document.updatedAt).toLocaleString()}`}</span>
{!revisionId ? <DocumentAnnotationsCountChip
issueId={issueId}
docKey={document.key}
panelOpen={annotationPanelOpen}
onToggle={() => setAnnotationPanelOpen((open) => !open)}
/> : <span>· Reviewed version</span>}
</div>
</header>
{document.body.trim() ? (
<IssueDocumentAnnotations
issueId={issueId}
doc={document}
bodyMarkdown={document.body}
draftDirty={false}
draftConflicted={false}
historicalPreview={!!revisionId}
locationHash={location.hash}
panelOpen={annotationPanelOpen}
onPanelOpenChange={setAnnotationPanelOpen}
panelPlacement="popover"
>
<DocumentMarkdownBody documentKey={document.key} revisionId={revisionId}
documentIssueId={documentIssueId} currentIssueId={currentIssueId}>
{document.body}
</DocumentMarkdownBody>
</IssueDocumentAnnotations>
) : (
<p className="text-sm text-muted-foreground">Document is empty.</p>
)}
</article>
);
}