Files
PaperClipAI/ui/src/api/companies.ts
T
cf1def0ca6 feat(inbox): rebuild compact cards and share task review controls (#20961)
## Thinking Path

> - Paperclip helps people manage AI agents and their work.
> - The inbox collects decisions, requests, and updates for the people
in a company.
> - People need a clear personal queue and a consistent way to answer
each request.
> - Repeated headings, inconsistent card actions, and separate review
flows make that work harder.
> - This pull request connects the inbox UI to the routing foundation in
#20959.
> - Compact cards use shared task controls and open supporting work in a
side panel.
> - People can answer, claim, transfer, archive, and inspect outcomes
from one place.

## Linked Issues or Issue Description

**What existing behavior does this improve?**

The inbox cards, personal views, shared task controls, and decision
history.

**Subsystem affected**

UI. This PR targets master and uses the routing foundation merged in
#20959.

**Current behavior**

The inbox repeats headings and counts. Cards have different layouts and
action placement. The requester can repeat the signed-in person's name.
Review and question controls differ between the inbox and task thread.

**Proposed behavior**

Open Assigned to you by default. Show one count line above the cards.
Use a compact card layout with consistent actions and supporting
details. Show the requester's avatar and name only when they differ from
the signed-in person. Share question controls, including a radio option
for Other that reveals a text field when selected.

**Reason and benefit**

People can scan their queue and complete requests without losing the
surrounding task or creating separate drafts for the same review.

**Breaking changes**

The default inbox view becomes personal. The all-assignee and shared
views remain available. Card close menus distinguish personal archive
and snooze from shared withdrawal.

**Additional context**

Refs #20959, #19363, and #19520. Refs #20268 for related
actionable-request work. This stack adds personal routing and shared
controls. ROADMAP.md includes Multiple Human Users and Agent Reviews and
Approvals.

## What Changed

- Add personal, unassigned, company, all-assignee, and archived inbox
views. Add claim, transfer, personal close actions, receipts, and
history controls.
- Use compact decision cards with a single count line, one-pixel
borders, and equal space above, below, and to the right of each primary
action.
- Open artifacts and synchronized confirmation/approval controls in a
shared side panel. Share their revision drafts and action state with the
task thread. Other requests keep one editable form on the inbox card
while reviewing an artifact.
- Make Other match the question options and reveal its field only when
selected. Apply this to inbox and task question cards.
- Hide self-requester labels, space agent avatars, and use the standard
canceled status icon for withdrawn requests.
- Use connector logos in connector cards. Keep the connector promotion
background and sidebar border continuous.
- Add company and project decision-owner controls and document the
updated inbox behavior.

## Verification

- The complete [GitHub Actions CI
matrix](https://github.com/paperclipai/paperclip/actions/runs/43141559641)
passes on `8d81a75e49b518fff6b6ff4c23dd67979b0b97ee` (Linux/Node 24:
typecheck, build, general and serialized tests, Runner support, browser
shards, and aggregate gates). Greptile is 5/5 on that exact head with
zero open findings, and the security scan passes.
- Local UI typechecking passes. Eight focused suites pass 382 tests: 236
inbox/review/question/connector tests plus all 146 composer tests.
Regressions passed red to green for attachment links, prompt rendering,
single-form artifact review, connector scope copy, accessible headings,
and the composer test harness's missing theme provider. The final commit
changes only that test harness; production code is unchanged from
`59d015833f`.
- Browser acceptance on the production implementation confirms preserved
selected answers with one editable question form, accessible Markdown
prompts, inert image references, accurate connector scope copy, native
PDF downloads, image sidebar previews, and Open file requesting the
attachment endpoint while preserving the inbox URL. Request reads and
file responses were intercepted; no question answers were written. The
preview is healthy on the final head.
- Visual and interaction checks cover Other radio behavior in both
themes and on mobile, the loaded Google Calendar logo, and 20px above,
below, and to the right of the primary action across all 23 visible
cards. The affected desktop/mobile navigation and sidebar specs pass
locally and in the final CI browser matrix.
- Real-editor browser checks confirm Ctrl/Cmd+Enter cannot bypass
another person's confirmation. Cancel preserves the draft and unlocks
silently; Continue submits once. Approval write failures remain visible.
- `pnpm verify` returns exit 2 because DESIGN.md requires broader
coverage; the final full CI matrix supplies every requested gate. Maps
and Storybook catalog structural checks pass. The routing foundation
#20959 merged after passing 249 database tests, server typechecking,
full CI, Greptile 5/5, and security scanning. Its backend and SDK
registry are preserved.
- Demo data is retained for testing; database suites and browser specs
use separate disposable databases.

## Risks

- The inbox uses the routing contracts merged in #20959. Personal
filters and history affect shared task entry points; the affected
controls are included in local regression coverage and full CI.
- Personal defaults and close-menu wording change inbox behavior.
Existing resolver permissions still control shared actions.
- Shared revision state and live invalidation affect two surfaces.
Focused tests cover draft synchronization, action locks, and incoming
updates.
- Visual changes use the existing design tokens and component
primitives.

## Model Used

OpenAI GPT-6 through Codex. Used repository tools, code execution, and
browser checks. This session does not expose a more specific runtime
model ID or its context-window size.

## 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 described the issue in-PR following the relevant issue
template
- [x] I have not referenced internal/instance-local Paperclip issues or
links
- [x] My branch name describes the change and contains no internal
Paperclip ticket id
- [x] I have run focused 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: Scott Tong <scott@scottsmbpm5max.lan>
Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-11-11 21:05:00 -08:00

180 lines
7.8 KiB
TypeScript

import type {
Company,
CompanyPortabilityExportRequest,
CompanyPortabilityExportPreviewResult,
CompanyPortabilityExportResult,
CompanyPortabilityImportRequest,
CompanyPortabilityImportResult,
CompanyPortabilityPreviewRequest,
CompanyPortabilityPreviewResult,
UpdateCompanyBranding,
} from "@paperclipai/shared";
import type { ExportFidelityReport } from "@paperclipai/shared/portability-fidelity";
import {
companyImportTransferApplyPath,
companyImportTransferPartPath,
companyImportTransferPath,
companyImportTransferPreviewPath,
COMPANY_IMPORT_TRANSFERS_ROUTE_PATH,
type CompanyImportTransferCreated,
type CompanyImportTransferDeclaration,
type CompanyImportTransferPartUploadResult,
type CompanyImportTransferStatus,
} from "@paperclipai/shared/company-import-transfer";
import { api, detachInflightGet, type RequestOptions } from "./client";
// The board navigates only into companies the user can enter. The unscoped
// directory also includes companies visible solely through instance admin.
const COMPANIES_LIST_PATH = "/companies?scope=accessible";
const COMPANIES_DIRECTORY_PATH = "/companies";
export type CompanyStats = Record<string, { agentCount: number; issueCount: number }>;
/**
* Import fields for a zip package upload: everything the JSON request carries
* except `source` — the source is the uploaded zip, read server-side. Sent as a
* JSON-encoded `meta` form field alongside the raw `package` file.
*/
export type CompanyPortabilityPreviewMeta = Omit<CompanyPortabilityPreviewRequest, "source">;
export type CompanyPortabilityImportMeta = Omit<CompanyPortabilityImportRequest, "source">;
function importPackageForm(file: File, meta: CompanyPortabilityPreviewMeta | CompanyPortabilityImportMeta): FormData {
const form = new FormData();
form.append("package", file);
form.append("meta", JSON.stringify(meta));
return form;
}
export type CompanyImportJobState = "running" | "succeeded" | "failed";
/** 202 body from the async opt-in on POST /companies/import (and the 409 body when a job is already running). */
export interface CompanyImportJobAccepted {
job: { id: string; status: CompanyImportJobState };
statusUrl: string;
retryAfterMs?: number;
}
export interface CompanyImportJobStatus {
job: {
id: string;
status: CompanyImportJobState;
createdAt?: string;
updatedAt?: string;
completedAt?: string;
error?: { message: string };
/**
* Summary retained for every terminal job (board and cloud tenant); carries
* the imported company id so the page can navigate even when the full
* `importResult` is no longer available.
*/
result?: {
companyId: string;
agentCount?: number;
warningCount?: number;
companyAction?: unknown;
};
/** Board-created jobs carry the full result for parity with the sync response. */
importResult?: CompanyPortabilityImportResult;
};
retryAfterMs?: number;
}
export const companiesApi = {
list: () => api.get<Company[]>(COMPANIES_LIST_PATH),
directory: () => api.get<Company[]>(COMPANIES_DIRECTORY_PATH),
detachInflightDirectory: () => detachInflightGet(COMPANIES_DIRECTORY_PATH),
/**
* Call before re-reading the list for a different account: an in-flight
* `/companies` GET issued under the previous session would otherwise be
* coalesced into, and answer with that account's companies.
*/
detachInflightList: () => detachInflightGet(COMPANIES_LIST_PATH),
get: (companyId: string) => api.get<Company>(`/companies/${companyId}`),
stats: () => api.get<CompanyStats>("/companies/stats"),
create: (data: {
name: string;
description?: string | null;
budgetMonthlyCents?: number;
}) =>
api.post<Company>("/companies", data),
update: (
companyId: string,
data: Partial<
Pick<
Company,
| "name"
| "description"
| "status"
| "budgetMonthlyCents"
| "defaultDecisionOwnerUserId"
| "budgetOwnerUserId"
| "requireBoardApprovalForNewAgents"
| "interactionResolverGovernance"
| "feedbackDataSharingEnabled"
| "logoAssetId"
>
>,
) => api.patch<Company>(`/companies/${companyId}`, data),
updateBranding: (companyId: string, data: UpdateCompanyBranding) =>
api.patch<Company>(`/companies/${companyId}/branding`, data),
archive: (companyId: string) => api.post<Company>(`/companies/${companyId}/archive`, {}),
remove: (companyId: string) => api.delete<{ ok: true }>(`/companies/${companyId}`),
exportBundle: (
companyId: string,
data: CompanyPortabilityExportRequest,
) =>
api.post<CompanyPortabilityExportResult>(`/companies/${companyId}/exports`, data),
exportPreview: (
companyId: string,
data: CompanyPortabilityExportRequest,
options?: RequestOptions,
) =>
api.post<CompanyPortabilityExportPreviewResult>(`/companies/${companyId}/exports/preview`, data, options),
exportFidelity: (companyId: string) =>
api.get<ExportFidelityReport>(`/companies/${companyId}/export/fidelity`),
importPreview: (data: CompanyPortabilityPreviewRequest) =>
api.post<CompanyPortabilityPreviewResult>("/companies/import/preview", data),
/** Preview a local .zip package by uploading the raw compressed zip as multipart. */
importPreviewPackage: (file: File, meta: CompanyPortabilityPreviewMeta) =>
api.postForm<CompanyPortabilityPreviewResult>("/companies/import/preview", importPackageForm(file, meta)),
importBundle: (data: CompanyPortabilityImportRequest) =>
api.post<CompanyPortabilityImportResult>("/companies/import", data),
// Submit an import as a server-side job: 202 with a job id to poll, or 409
// with the already-running job. Board sessions opt in with the proxy-safe
// `?async=1` query parameter — the Cloud harness strips the inbound
// `x-paperclip-cloud-*` header a browser would otherwise use, so that header
// never survives to engage the async path.
importBundleAsync: (data: CompanyPortabilityImportRequest) =>
api.post<CompanyImportJobAccepted>("/companies/import?async=1", data),
/** Submit a local .zip package as an async import job by uploading the raw compressed zip as multipart. */
importBundlePackageAsync: (file: File, meta: CompanyPortabilityImportMeta) =>
api.postForm<CompanyImportJobAccepted>("/companies/import?async=1", importPackageForm(file, meta)),
getImportJob: (jobId: string) =>
api.get<CompanyImportJobStatus>(`/companies/import/jobs/${encodeURIComponent(jobId)}`),
// Chunked resumable transfer for large local .zip packages: declare the
// sliced zip (content-addressed, so re-declaring the same file resumes the
// prior transfer with its uploaded parts intact), upload the missing parts,
// then preview/apply against the server-side assembled spool. Shapes and
// paths come from the shared transfer contract.
importTransferCreate: (manifest: CompanyImportTransferDeclaration) =>
api.post<CompanyImportTransferCreated>(`/companies${COMPANY_IMPORT_TRANSFERS_ROUTE_PATH}`, manifest),
importTransferUploadPart: (transferId: string, index: number, bytes: Blob) =>
api.putRaw<CompanyImportTransferPartUploadResult>(
`/companies${companyImportTransferPartPath(transferId, index)}`,
bytes,
),
importTransferStatus: (transferId: string) =>
api.get<CompanyImportTransferStatus>(`/companies${companyImportTransferPath(transferId)}`),
importTransferPreview: (transferId: string, meta: CompanyPortabilityPreviewMeta) =>
api.post<CompanyPortabilityPreviewResult>(
`/companies${companyImportTransferPreviewPath(transferId)}`,
meta,
),
/** Apply a fully uploaded transfer as an async job (same 202/409 contract as importBundlePackageAsync). */
importTransferApply: (transferId: string, meta: CompanyPortabilityImportMeta) =>
api.post<CompanyImportJobAccepted>(
`/companies${companyImportTransferApplyPath(transferId)}?async=1`,
meta,
),
};