Add company artifacts page (#7621)
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Operators need a way to inspect files and work products created by agents across a company without opening each issue one by one. > - The existing issue detail surfaces already show attachments and outputs, but there was no company-level artifacts index or search-result affordance for artifact-like records. > - The backend needed a company-scoped artifacts projection API that preserves issue/run attribution and safe links back to source records. > - The UI needed a first-class Artifacts page, sidebar entry, reusable artifact cards, and deep-link handling that keeps company prefixes intact. > - This pull request adds the company artifacts API and page, then wires artifacts into search and issue output surfaces. > - The benefit is a single place to browse, filter, and open generated work products and attachments while preserving company boundaries. ## Linked Issues or Issue Description Fixes #7622. Feature request fields: - Problem/motivation: company operators need a consolidated artifacts surface for attachments and work products produced by agents. - Proposed solution: add a company-scoped artifacts projection endpoint, a board Artifacts route, reusable cards, sidebar navigation, and artifact search integration. - Alternatives considered: keep artifact discovery only on individual issue pages; that forces operators to know the source issue before finding generated outputs. - Roadmap alignment: checked `ROADMAP.md`; this is a focused board UI/API improvement and does not duplicate a listed roadmap item. ## What Changed - Added shared artifact types and validators. - Added a company-scoped artifact projection service/API with tests for attachment/work-product attribution. - Added Artifacts board UI route, API client, sidebar link, cards, filters, and storybook coverage. - Added artifact result handling to company search and issue output/deep-link flows. - Rebased the branch onto the latest `public-gh/master` state and resolved the route-test conflict by preserving both upstream team-catalog coverage and artifact route coverage. - Fixed a local Sidebar test helper so it no longer depends on a runtime-undefined `React.act` export in this dependency install. ## Verification - `pnpm --filter @paperclipai/ui exec vitest run src/components/artifacts/ArtifactCard.test.tsx src/api/artifacts.test.ts src/lib/company-routes.test.ts` - `pnpm --filter @paperclipai/ui exec vitest run src/pages/Artifacts.test.tsx src/pages/Search.test.tsx src/components/Sidebar.test.tsx` - `pnpm exec vitest run server/src/__tests__/company-artifacts-service.test.ts server/src/__tests__/company-search-service.test.ts server/src/__tests__/company-search-rate-limit-routes.test.ts server/src/__tests__/issue-agent-mutation-ownership-routes.test.ts` - Confirmed the PR diff does not include `pnpm-lock.yaml` or `.github/workflows/*`. - Duplicate search: no open PRs or issues found for `artifact page ArtifactCard` in `paperclipai/paperclip`. Screenshots are intentionally omitted per the internal task instruction not to add design screenshots or images to this PR unless they are specifically part of the work. I also attempted browser capture in this runner, but `agent-browser` failed to launch Chrome and Playwright Chromium is missing `libatk-1.0.so.0`. ## Risks - Low-to-medium risk: this adds a new API projection and UI surface, so attribution/link regressions could affect artifact navigation. - Company scoping is covered in the new service/API tests. - No database migrations are included. - No lockfile or workflow changes are included. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used OpenAI Codex, GPT-5 coding agent with tool use and local command execution. Exact hosted model identifier is not exposed in this runtime. ## 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 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 (intentionally omitted per task instruction; browser capture unavailable in this runner) - [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 - [ ] 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>
This commit is contained in:
Dotta
@@ -0,0 +1,75 @@
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
const mockApi = vi.hoisted(() => ({
|
||||
get: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock("./client", () => ({
|
||||
api: mockApi,
|
||||
}));
|
||||
|
||||
import { artifactsApi, type CompanyArtifact } from "./artifacts";
|
||||
|
||||
function sampleArtifact(overrides: Partial<CompanyArtifact> = {}): CompanyArtifact {
|
||||
return {
|
||||
id: "wp-1",
|
||||
source: "work_product",
|
||||
mediaKind: "video",
|
||||
title: "Primary cut",
|
||||
previewText: null,
|
||||
contentType: "video/mp4",
|
||||
contentPath: "/files/wp-1.mp4",
|
||||
openPath: "/files/wp-1.mp4",
|
||||
downloadPath: "/files/wp-1.mp4?download=1",
|
||||
issue: { id: "issue-1", identifier: "PAP-10205", title: "Demo reel" },
|
||||
project: { id: "proj-1", name: "Paperclip App" },
|
||||
createdByAgent: { id: "agent-1", name: "ClaudeCoder" },
|
||||
updatedAt: "2026-06-01T00:00:00.000Z",
|
||||
href: "/issues/PAP-10205#work-product-wp-1",
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
describe("artifactsApi.list", () => {
|
||||
beforeEach(() => {
|
||||
mockApi.get.mockReset();
|
||||
mockApi.get.mockResolvedValue({ artifacts: [], nextCursor: null });
|
||||
});
|
||||
|
||||
it("calls the company-scoped artifacts endpoint with no params", async () => {
|
||||
await artifactsApi.list("company-1");
|
||||
expect(mockApi.get).toHaveBeenCalledWith("/companies/company-1/artifacts");
|
||||
});
|
||||
|
||||
it("omits the kind param when filtering by all", async () => {
|
||||
await artifactsApi.list("company-1", { kind: "all" });
|
||||
expect(mockApi.get).toHaveBeenCalledWith("/companies/company-1/artifacts");
|
||||
});
|
||||
|
||||
it("serializes kind, project, search, and pagination params", async () => {
|
||||
await artifactsApi.list("company-1", {
|
||||
kind: "video",
|
||||
projectId: "proj-1",
|
||||
q: "demo reel",
|
||||
limit: 24,
|
||||
cursor: "abc",
|
||||
});
|
||||
expect(mockApi.get).toHaveBeenCalledWith(
|
||||
"/companies/company-1/artifacts?kind=video&projectId=proj-1&q=demo+reel&limit=24&cursor=abc",
|
||||
);
|
||||
});
|
||||
|
||||
it("returns the envelope shape from the backend", async () => {
|
||||
const artifact = sampleArtifact();
|
||||
mockApi.get.mockResolvedValue({ artifacts: [artifact], nextCursor: "next" });
|
||||
const result = await artifactsApi.list("company-1");
|
||||
expect(result).toEqual({ artifacts: [artifact], nextCursor: "next" });
|
||||
});
|
||||
|
||||
it("normalizes a bare array response into the envelope shape", async () => {
|
||||
const artifact = sampleArtifact();
|
||||
mockApi.get.mockResolvedValue([artifact]);
|
||||
const result = await artifactsApi.list("company-1");
|
||||
expect(result).toEqual({ artifacts: [artifact], nextCursor: null });
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,71 @@
|
||||
import { api } from "./client";
|
||||
import type {
|
||||
CompanyArtifact,
|
||||
CompanyArtifactMediaKind,
|
||||
CompanyArtifactsResponse,
|
||||
} from "@paperclipai/shared";
|
||||
|
||||
export type {
|
||||
CompanyArtifact,
|
||||
CompanyArtifactMediaKind as ArtifactMediaKind,
|
||||
CompanyArtifactsResponse,
|
||||
CompanyArtifactSource as ArtifactSource,
|
||||
} from "@paperclipai/shared";
|
||||
|
||||
/**
|
||||
* Company-level Artifacts client (PAP-10359).
|
||||
*
|
||||
* Talks to the company-scoped artifacts projection endpoint
|
||||
* (`GET /api/companies/:companyId/artifacts`) defined by the approved
|
||||
* Artifacts plan (PAP-10353). The endpoint flattens agent-produced issue
|
||||
* documents, direct attachments, and `artifact` work products into a single
|
||||
* card-ready list so the UI never has to stitch issue-specific endpoints
|
||||
* together.
|
||||
*
|
||||
* The `CompanyArtifact` shape is imported from `@paperclipai/shared` so the
|
||||
* frontend and server stay synchronized as the contract evolves.
|
||||
*/
|
||||
|
||||
export type ArtifactKindFilter = Exclude<CompanyArtifactMediaKind, "empty"> | "all";
|
||||
|
||||
export interface ListArtifactsParams {
|
||||
kind?: ArtifactKindFilter;
|
||||
projectId?: string;
|
||||
q?: string;
|
||||
limit?: number;
|
||||
cursor?: string;
|
||||
}
|
||||
|
||||
function buildArtifactsQuery(params?: ListArtifactsParams): string {
|
||||
const search = new URLSearchParams();
|
||||
if (params?.kind && params.kind !== "all") search.set("kind", params.kind);
|
||||
if (params?.projectId) search.set("projectId", params.projectId);
|
||||
if (params?.q) search.set("q", params.q);
|
||||
if (params?.limit != null) search.set("limit", String(params.limit));
|
||||
if (params?.cursor) search.set("cursor", params.cursor);
|
||||
const qs = search.toString();
|
||||
return qs ? `?${qs}` : "";
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalize the endpoint response. The contract is an envelope
|
||||
* (`{ artifacts, nextCursor }`), but we also tolerate a bare array so the page
|
||||
* keeps working if the backend ships the simpler shape.
|
||||
*/
|
||||
function normalizeArtifactsResponse(
|
||||
raw: CompanyArtifactsResponse | CompanyArtifact[],
|
||||
): CompanyArtifactsResponse {
|
||||
if (Array.isArray(raw)) {
|
||||
return { artifacts: raw, nextCursor: null };
|
||||
}
|
||||
return { artifacts: raw.artifacts ?? [], nextCursor: raw.nextCursor ?? null };
|
||||
}
|
||||
|
||||
export const artifactsApi = {
|
||||
list: async (companyId: string, params?: ListArtifactsParams): Promise<CompanyArtifactsResponse> => {
|
||||
const raw = await api.get<CompanyArtifactsResponse | CompanyArtifact[]>(
|
||||
`/companies/${companyId}/artifacts${buildArtifactsQuery(params)}`,
|
||||
);
|
||||
return normalizeArtifactsResponse(raw);
|
||||
},
|
||||
};
|
||||
Reference in New Issue
Block a user