mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 08:22:20 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agent work is coordinated through issues, comments, interactions, and approval-style handoffs. > - Existing issue-thread interactions could ask questions, suggest tasks, and request confirmation, but they did not support a structured checkbox confirmation payload for choosing one or more options. > - That gap made board/user confirmations harder to validate consistently across API callers, plugin helpers, CLI tooling, and the UI. > - This pull request adds the shared checkbox confirmation contract, server handling, client helpers, and issue-thread UI needed to render and submit structured selections. > - The benefit is that agents can request bounded multi-select confirmations in the same audited issue-thread flow as other Paperclip interactions. ## Linked Issues or Issue Description - No public GitHub issue found for this exact branch. Internal Paperclip issue: PAP-10415 / PAP-10441 requested creating this PR for the checkbox confirmation issue-thread UI component work. - GitHub duplicate search performed for checkbox confirmation / issue-thread interaction PRs; no matching open PR was found. - Related issue search result `#7497` was unrelated company file cleanup work, so it is not linked as a related issue. ## What Changed - Added shared types, validators, constants, and tests for `request_checkbox_confirmation` interactions. - Extended server issue-thread interaction service and routes for checkbox confirmation creation, validation, expiration, and response handling. - Added CLI, MCP, and plugin SDK helper coverage so external callers can create the new interaction shape consistently. - Updated the issue-thread interaction UI to render checkbox confirmations with min/max bounds, selection summaries, stale-target states, and accept/decline flows. - Documented the checkbox confirmation interaction contract in the Paperclip skill/API reference. ## Verification - Rebased cleanly on `paperclipai/paperclip` `master` fetched into `public-gh/master` at `a4fa0eaf5`. - Confirmed the PR diff does not include `pnpm-lock.yaml` or `.github/workflows` changes. - Ran focused tests with `NODE_ENV=test`: ```sh NODE_ENV=test pnpm run preflight:workspace-links NODE_ENV=test pnpm exec vitest run packages/shared/src/issue-thread-interactions.test.ts server/src/__tests__/issue-thread-interaction-routes.test.ts server/src/__tests__/issue-thread-interactions-service.test.ts ui/src/components/IssueThreadInteractionCard.test.tsx ui/src/lib/issue-thread-interactions.test.ts cli/src/__tests__/issue-subresources.test.ts cli/src/__tests__/project-goal.test.ts packages/mcp-server/src/tools.test.ts packages/plugins/sdk/tests/testing-actions.test.ts ``` Result: 8 test files passed, 78 tests passed. - CI on latest head `63b9e55` is green. - Greptile Review passed on latest head; GraphQL review-thread check shows all Greptile threads resolved. ## Risks - Medium surface area because the interaction contract touches shared validators, server routes/services, UI rendering, CLI, MCP, plugin SDK helpers, and docs. - No database migrations are included. - `pnpm-lock.yaml` is intentionally excluded per repository lockfile policy. - UI screenshots are not attached because the task explicitly requested not to add design screenshots or images unless they were part of the work; component tests cover the new rendering and interaction states. > 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 coding agent based on GPT-5, with repository file access, shell command execution, git/GitHub CLI tooling, and Paperclip control-plane API access. Exact hosted model ID/context-window metadata is not exposed inside 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 - [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>
215 lines
7.4 KiB
TypeScript
215 lines
7.4 KiB
TypeScript
export type {
|
|
AskUserQuestionsAnswer,
|
|
AskUserQuestionsInteraction,
|
|
AskUserQuestionsPayload,
|
|
AskUserQuestionsQuestion,
|
|
AskUserQuestionsQuestionOption,
|
|
AskUserQuestionsResult,
|
|
IssueThreadInteraction,
|
|
IssueThreadInteractionActorFields,
|
|
IssueThreadInteractionBase,
|
|
IssueThreadInteractionContinuationPolicy,
|
|
IssueThreadInteractionStatus,
|
|
RequestCheckboxConfirmationInteraction,
|
|
RequestCheckboxConfirmationOption,
|
|
RequestCheckboxConfirmationPayload,
|
|
RequestCheckboxConfirmationResult,
|
|
RequestConfirmationInteraction,
|
|
RequestConfirmationIssueDocumentTarget,
|
|
RequestConfirmationPayload,
|
|
RequestConfirmationResult,
|
|
RequestConfirmationTarget,
|
|
SuggestedTaskDraft,
|
|
SuggestTasksInteraction,
|
|
SuggestTasksPayload,
|
|
SuggestTasksResult,
|
|
SuggestTasksResultCreatedTask,
|
|
} from "@paperclipai/shared";
|
|
import type {
|
|
AskUserQuestionsAnswer,
|
|
AskUserQuestionsInteraction,
|
|
AskUserQuestionsQuestion,
|
|
IssueThreadInteraction,
|
|
RequestCheckboxConfirmationPayload,
|
|
RequestCheckboxConfirmationResult,
|
|
RequestConfirmationInteraction,
|
|
RequestConfirmationTarget,
|
|
SuggestedTaskDraft,
|
|
SuggestTasksInteraction,
|
|
SuggestTasksResultCreatedTask,
|
|
} from "@paperclipai/shared";
|
|
|
|
export interface SuggestedTaskTreeNode {
|
|
task: SuggestedTaskDraft;
|
|
children: SuggestedTaskTreeNode[];
|
|
}
|
|
|
|
export function isIssueThreadInteraction(
|
|
value: unknown,
|
|
): value is IssueThreadInteraction {
|
|
if (!value || typeof value !== "object") return false;
|
|
const candidate = value as Partial<IssueThreadInteraction>;
|
|
return typeof candidate.id === "string"
|
|
&& typeof candidate.companyId === "string"
|
|
&& typeof candidate.issueId === "string"
|
|
&& (
|
|
candidate.kind === "suggest_tasks"
|
|
|| candidate.kind === "ask_user_questions"
|
|
|| candidate.kind === "request_confirmation"
|
|
|| candidate.kind === "request_checkbox_confirmation"
|
|
);
|
|
}
|
|
|
|
export function getCheckboxConfirmationSelectedLabels(args: {
|
|
payload: RequestCheckboxConfirmationPayload;
|
|
result?: RequestCheckboxConfirmationResult | null;
|
|
}): string[] {
|
|
const { payload, result } = args;
|
|
const selectedIds = result?.selectedOptionIds ?? [];
|
|
const optionLabelById = new Map(
|
|
payload.options.map((option) => [option.id, option.label] as const),
|
|
);
|
|
return selectedIds
|
|
.map((optionId) => optionLabelById.get(optionId))
|
|
.filter((label): label is string => typeof label === "string");
|
|
}
|
|
|
|
export function normalizeRequestConfirmationTargetHref(href: string) {
|
|
const value = href.trim();
|
|
if (value.startsWith("#")) return value;
|
|
if (value.startsWith("/")) return value.startsWith("//") ? null : value;
|
|
return /^https?:\/\//i.test(value) ? value : null;
|
|
}
|
|
|
|
export function getRequestConfirmationTargetHref({
|
|
issueId,
|
|
target,
|
|
}: {
|
|
issueId: string;
|
|
target: RequestConfirmationTarget;
|
|
}) {
|
|
if (target.href) {
|
|
const safeHref = normalizeRequestConfirmationTargetHref(target.href);
|
|
if (safeHref) return safeHref;
|
|
}
|
|
if (target.type === "issue_document") {
|
|
const targetIssueId = target.issueId ?? issueId;
|
|
return `/issues/${targetIssueId}#document-${encodeURIComponent(target.key)}`;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
export function buildIssueThreadInteractionSummary(
|
|
interaction: IssueThreadInteraction,
|
|
) {
|
|
if (interaction.kind === "suggest_tasks") {
|
|
const count = interaction.payload.tasks.length;
|
|
if (interaction.status === "accepted") {
|
|
const createdCount = interaction.result?.createdTasks?.length ?? 0;
|
|
const skippedCount = interaction.result?.skippedClientKeys?.length ?? 0;
|
|
if (skippedCount > 0) {
|
|
return `Accepted ${createdCount} of ${count} tasks`;
|
|
}
|
|
return createdCount === 1 ? "Accepted 1 task" : `Accepted ${createdCount} tasks`;
|
|
}
|
|
if (interaction.status === "rejected") {
|
|
return count === 1 ? "Rejected 1 task" : `Rejected ${count} tasks`;
|
|
}
|
|
return count === 1 ? "Suggested 1 task" : `Suggested ${count} tasks`;
|
|
}
|
|
|
|
if (interaction.kind === "request_confirmation") {
|
|
if (interaction.status === "accepted") return "Confirmed request";
|
|
if (interaction.status === "rejected") return "Declined request";
|
|
if (interaction.status === "expired") {
|
|
const outcome = interaction.result?.outcome;
|
|
if (outcome === "superseded_by_comment") return "Confirmation expired after comment";
|
|
if (outcome === "stale_target") return "Confirmation expired after target changed";
|
|
return "Confirmation expired";
|
|
}
|
|
return "Requested confirmation";
|
|
}
|
|
|
|
if (interaction.kind === "request_checkbox_confirmation") {
|
|
const optionCount = interaction.payload.options.length;
|
|
if (interaction.status === "accepted") {
|
|
const selectedCount = interaction.result?.selectedOptionIds?.length ?? 0;
|
|
if (selectedCount === 0) return "Confirmed with no options selected";
|
|
return selectedCount === 1
|
|
? `Confirmed 1 of ${optionCount} options`
|
|
: `Confirmed ${selectedCount} of ${optionCount} options`;
|
|
}
|
|
if (interaction.status === "rejected") return "Declined selection";
|
|
if (interaction.status === "expired") {
|
|
const outcome = interaction.result?.outcome;
|
|
if (outcome === "superseded_by_comment") return "Selection expired after comment";
|
|
if (outcome === "stale_target") return "Selection expired after target changed";
|
|
return "Selection expired";
|
|
}
|
|
return optionCount === 1
|
|
? "Requested a selection from 1 option"
|
|
: `Requested a selection from ${optionCount} options`;
|
|
}
|
|
|
|
const count = interaction.payload.questions.length;
|
|
if (interaction.status === "answered") {
|
|
return count === 1 ? "Answered 1 question" : `Answered ${count} questions`;
|
|
}
|
|
if (interaction.status === "cancelled") {
|
|
return count === 1 ? "Cancelled 1 question" : `Cancelled ${count} questions`;
|
|
}
|
|
return count === 1 ? "Asked 1 question" : `Asked ${count} questions`;
|
|
}
|
|
|
|
export function buildSuggestedTaskTree(
|
|
tasks: readonly SuggestedTaskDraft[],
|
|
): SuggestedTaskTreeNode[] {
|
|
const nodes = new Map<string, SuggestedTaskTreeNode>();
|
|
for (const task of tasks) {
|
|
nodes.set(task.clientKey, { task, children: [] });
|
|
}
|
|
|
|
const roots: SuggestedTaskTreeNode[] = [];
|
|
for (const task of tasks) {
|
|
const node = nodes.get(task.clientKey);
|
|
if (!node) continue;
|
|
const parentNode = task.parentClientKey ? nodes.get(task.parentClientKey) : null;
|
|
if (parentNode) {
|
|
parentNode.children.push(node);
|
|
continue;
|
|
}
|
|
roots.push(node);
|
|
}
|
|
|
|
return roots;
|
|
}
|
|
|
|
export function countSuggestedTaskNodes(node: SuggestedTaskTreeNode): number {
|
|
return 1 + node.children.reduce((sum, child) => sum + countSuggestedTaskNodes(child), 0);
|
|
}
|
|
|
|
export function collectSuggestedTaskClientKeys(node: SuggestedTaskTreeNode): string[] {
|
|
return [
|
|
node.task.clientKey,
|
|
...node.children.flatMap((child) => collectSuggestedTaskClientKeys(child)),
|
|
];
|
|
}
|
|
|
|
export function getQuestionAnswerLabels(args: {
|
|
question: AskUserQuestionsQuestion;
|
|
answers: readonly AskUserQuestionsAnswer[];
|
|
}) {
|
|
const { question, answers } = args;
|
|
const answer = answers.find((candidate) => candidate.questionId === question.id);
|
|
const selectedIds = answer?.optionIds ?? [];
|
|
const optionLabelById = new Map(
|
|
question.options.map((option) => [option.id, option.label] as const),
|
|
);
|
|
const labels = selectedIds
|
|
.map((optionId) => optionLabelById.get(optionId))
|
|
.filter((label): label is string => typeof label === "string");
|
|
const otherText = answer?.otherText?.trim();
|
|
if (otherText) labels.push(`Other: ${otherText}`);
|
|
return labels;
|
|
}
|