| 1 | import type { User, Viewer } from "./identity"; |
| 2 | import type { RepoPath } from "./repos"; |
| 3 | import type { Result } from "./result"; |
| 4 | |
| 5 | /** |
| 6 | * The filter on lists of issues and pull requests. An open pull request is |
| 7 | * a draft or one ready for review; a closed one was merged or closed |
| 8 | * without merging. |
| 9 | */ |
| 10 | export type State = "open" | "closed"; |
| 11 | |
| 12 | /** Why an issue was closed. */ |
| 13 | export type IssueReason = "completed" | "not_planned"; |
| 14 | |
| 15 | /** |
| 16 | * Something that should change in a repository: a bug, a feature, a |
| 17 | * question. Opened by a person, an agent or an integration. Pull requests |
| 18 | * are made against it; the one that is merged resolves it. |
| 19 | * |
| 20 | * Issues and pull requests share one sequence of numbers per repository. |
| 21 | */ |
| 22 | export type Issue = { |
| 23 | id: string; |
| 24 | repoId: string; |
| 25 | /** Shown as `#12`. */ |
| 26 | number: number; |
| 27 | title: string; |
| 28 | /** Markdown. Also what an agent is given to work from. */ |
| 29 | body: string; |
| 30 | labels: string[]; |
| 31 | /** Commands that must pass for a pull request to be accepted. */ |
| 32 | checks: string[]; |
| 33 | state: State; |
| 34 | /** Set when closed. */ |
| 35 | reason: IssueReason | null; |
| 36 | /** The number of the pull request whose merge closed this issue. */ |
| 37 | resolvedBy: number | null; |
| 38 | author: User; |
| 39 | /** RFC 3339. */ |
| 40 | createdAt: string; |
| 41 | /** RFC 3339. */ |
| 42 | updatedAt: string; |
| 43 | /** RFC 3339. */ |
| 44 | closedAt: string | null; |
| 45 | /** Pull requests made against this issue, in any state. */ |
| 46 | pullCount: number; |
| 47 | commentCount: number; |
| 48 | /** Usernames of the people it is assigned to. */ |
| 49 | assignees: string[]; |
| 50 | /** The numbers of the issues that have to be merged before this one is worked on. */ |
| 51 | blockedBy: number[]; |
| 52 | /** |
| 53 | * Whether a g1t agent takes it as soon as it can: at once, or when what it |
| 54 | * is blocked by has merged. |
| 55 | */ |
| 56 | queued: boolean; |
| 57 | /** |
| 58 | * The agent working on it now: the one behind its newest pull request |
| 59 | * that is still in progress in a fork, such as `g1t-agent`. |
| 60 | */ |
| 61 | agent: string | null; |
| 62 | }; |
| 63 | |
| 64 | /** `draft` is still being worked on; `open` is ready for review. */ |
| 65 | export type PullStatus = "draft" | "open" | "merged" | "closed"; |
| 66 | |
| 67 | /** Where the agent runs: on g1t's sandboxes, or in someone's own session. */ |
| 68 | export type Runtime = "hosted" | "external"; |
| 69 | |
| 70 | /** |
| 71 | * A proposed change. It is made either in a fork created for it, which is |
| 72 | * how agents work, or on a branch pushed to the repository itself. |
| 73 | */ |
| 74 | export type Pull = { |
| 75 | id: string; |
| 76 | repoId: string; |
| 77 | /** Shown as `#12`. */ |
| 78 | number: number; |
| 79 | /** The number of the issue this is for, if any. */ |
| 80 | issue: number | null; |
| 81 | title: string; |
| 82 | /** Markdown: what changed and why. Set when marked ready. */ |
| 83 | body: string | null; |
| 84 | /** A label for the agent doing the work, e.g. `claude-code`. */ |
| 85 | agent: string; |
| 86 | runtime: Runtime; |
| 87 | status: PullStatus; |
| 88 | /** The fork holding the change, unless it is on a branch. */ |
| 89 | fork: RepoPath | null; |
| 90 | /** The fork's repository id. */ |
| 91 | forkRepoId: string | null; |
| 92 | /** The branch of the repository holding the change, unless it is in a fork. */ |
| 93 | branch: string | null; |
| 94 | headCommit: string | null; |
| 95 | /** |
| 96 | * For a merged pull request, what the branch pointed to before the merge. |
| 97 | * Comparing against it shows what the pull request changed. |
| 98 | */ |
| 99 | mergeBase: string | null; |
| 100 | /** Username of whoever merged it. */ |
| 101 | mergedBy: string | null; |
| 102 | /** RFC 3339. */ |
| 103 | mergedAt: string | null; |
| 104 | /** |
| 105 | * Set on a pull request closed because another one for the same issue was |
| 106 | * merged: that one's number. |
| 107 | */ |
| 108 | supersededBy: number | null; |
| 109 | /** |
| 110 | * Where the latest run of the issue's acceptance checks stands, if there |
| 111 | * has been one against the current head. |
| 112 | */ |
| 113 | checkStatus: CheckStatus | null; |
| 114 | /** The files it changes, as of its latest push. */ |
| 115 | files: ChangedFile[]; |
| 116 | /** Usernames of the people it is assigned to. */ |
| 117 | assignees: string[]; |
| 118 | /** |
| 119 | * Those whose review was asked for: usernames, and `g1t-agent` when a g1t |
| 120 | * agent was asked. |
| 121 | */ |
| 122 | reviewers: string[]; |
| 123 | author: User; |
| 124 | /** RFC 3339. */ |
| 125 | createdAt: string; |
| 126 | /** RFC 3339. */ |
| 127 | updatedAt: string; |
| 128 | }; |
| 129 | |
| 130 | /** One file a pull request changes, and by how much. */ |
| 131 | export type ChangedFile = { path: string; additions: number; deletions: number }; |
| 132 | |
| 133 | /** |
| 134 | * Another pull request in progress that changes some of the same files. Two |
| 135 | * for the same issue are alternatives; two for different issues are heading |
| 136 | * for a conflict. |
| 137 | */ |
| 138 | export type Overlap = { |
| 139 | number: number; |
| 140 | title: string; |
| 141 | /** The number of the issue the other pull request is for. */ |
| 142 | issue: number | null; |
| 143 | /** The files both change. */ |
| 144 | paths: string[]; |
| 145 | }; |
| 146 | |
| 147 | /** `queued` waits for a sandbox; `errored` means the checks could not be run. */ |
| 148 | export type CheckStatus = "queued" | "running" | "passed" | "failed" | "errored"; |
| 149 | |
| 150 | /** How one acceptance check went. */ |
| 151 | export type CheckResult = { |
| 152 | command: string; |
| 153 | passed: boolean; |
| 154 | /** Null when the command was stopped for taking too long. */ |
| 155 | exitCode: number | null; |
| 156 | /** What the command printed; the end of it, when there was a lot. */ |
| 157 | output: string; |
| 158 | durationMs: number; |
| 159 | }; |
| 160 | |
| 161 | /** |
| 162 | * One run of an issue's acceptance checks against a pull request's head, in |
| 163 | * a sandbox that holds nothing but that commit. |
| 164 | */ |
| 165 | export type CheckRun = { |
| 166 | id: string; |
| 167 | /** The commit that was checked. */ |
| 168 | headCommit: string; |
| 169 | status: CheckStatus; |
| 170 | results: CheckResult[]; |
| 171 | /** Why the checks could not be run, when `status` is `errored`. */ |
| 172 | error: string | null; |
| 173 | /** RFC 3339. */ |
| 174 | createdAt: string; |
| 175 | /** RFC 3339. */ |
| 176 | finishedAt: string | null; |
| 177 | }; |
| 178 | |
| 179 | /** A reviewer's decision on a pull request. */ |
| 180 | export type Verdict = "approve" | "request_changes"; |
| 181 | |
| 182 | /** |
| 183 | * A comment on an issue or a pull request. On a pull request it can sit on |
| 184 | * one line of the change, and it can carry a reviewer's verdict. |
| 185 | */ |
| 186 | export type Comment = { |
| 187 | id: string; |
| 188 | /** |
| 189 | * Something a person or an agent wrote, or something that happened: an |
| 190 | * assignment, a review asked for, a close. |
| 191 | */ |
| 192 | kind: "comment" | "event"; |
| 193 | author: User; |
| 194 | /** |
| 195 | * Markdown. For an event, what its author did, as the rest of a sentence |
| 196 | * that starts with their name: "assigned ana". |
| 197 | */ |
| 198 | body: string; |
| 199 | /** The file commented on, for a comment on a line. */ |
| 200 | path: string | null; |
| 201 | /** The line of that file, as numbered after the change. */ |
| 202 | line: number | null; |
| 203 | verdict: Verdict | null; |
| 204 | /** RFC 3339. */ |
| 205 | createdAt: string; |
| 206 | }; |
| 207 | |
| 208 | export type NewComment = { |
| 209 | /** May be empty when approving. */ |
| 210 | body: string; |
| 211 | path?: string; |
| 212 | line?: number; |
| 213 | verdict?: Verdict; |
| 214 | }; |
| 215 | |
| 216 | /** What a sandbox needs to carry out a check run. */ |
| 217 | export type CheckJob = { |
| 218 | runId: string; |
| 219 | /** Lets the sandbox, and nothing else, report this run's results. */ |
| 220 | token: string; |
| 221 | commands: string[]; |
| 222 | /** The repository holding the commit: the fork, or the repository itself. */ |
| 223 | source: RepoPath; |
| 224 | commit: string; |
| 225 | /** Who opened the pull request, and so can read its source. */ |
| 226 | author: User; |
| 227 | /** Username of whoever wrote the checks: the issue's author. */ |
| 228 | requestedBy: string; |
| 229 | repo: RepoPath; |
| 230 | number: number; |
| 231 | }; |
| 232 | |
| 233 | export type CheckReport = { results?: CheckResult[]; error?: string; skip?: boolean }; |
| 234 | |
| 235 | export type SessionEntryKind = "prompt" | "message" | "tool_call" | "tool_result" | "note"; |
| 236 | |
| 237 | /** One step of an agent's session: the "why" behind a pull request's commits. */ |
| 238 | export type SessionEntry = { |
| 239 | seq: number; |
| 240 | kind: SessionEntryKind; |
| 241 | text: string; |
| 242 | /** For tool calls and results. */ |
| 243 | tool: string | null; |
| 244 | /** The fork's head commit when this entry was recorded, if known. */ |
| 245 | commit: string | null; |
| 246 | /** RFC 3339. */ |
| 247 | at: string; |
| 248 | }; |
| 249 | |
| 250 | export type NewSessionEntry = Pick<SessionEntry, "kind" | "text"> & |
| 251 | Partial<Pick<SessionEntry, "tool" | "commit">>; |
| 252 | |
| 253 | export type IssueDetail = { |
| 254 | issue: Issue; |
| 255 | /** Every pull request made against it, oldest first. */ |
| 256 | pulls: Pull[]; |
| 257 | comments: Comment[]; |
| 258 | }; |
| 259 | |
| 260 | export type PullDetail = { |
| 261 | pull: Pull; |
| 262 | /** The issue it is for, if any. */ |
| 263 | issue: Issue | null; |
| 264 | comments: Comment[]; |
| 265 | /** The latest run of the issue's acceptance checks. */ |
| 266 | checks: CheckRun | null; |
| 267 | /** Other pull requests in progress that change the same files. */ |
| 268 | overlaps: Overlap[]; |
| 269 | /** |
| 270 | * Whether the branch it would merge into has moved on without it, so that |
| 271 | * it has to catch up before it can merge. |
| 272 | */ |
| 273 | behind: boolean; |
| 274 | /** Whether a g1t agent is reviewing it right now. */ |
| 275 | reviewPending: boolean; |
| 276 | /** |
| 277 | * Where it stands on its way to being merged, for a pull request g1t is |
| 278 | * seeing through. Null on anyone else's. |
| 279 | */ |
| 280 | lifecycle: Lifecycle | null; |
| 281 | /** |
| 282 | * A merge was asked for while it was behind: g1t is bringing it up to |
| 283 | * date and will then land it. |
| 284 | */ |
| 285 | landing: boolean; |
| 286 | /** Why g1t stopped working on it, if it did. */ |
| 287 | stalled: string | null; |
| 288 | /** Messages people sent the agent while it worked, oldest first. */ |
| 289 | messages: AgentMessage[]; |
| 290 | /** What workflow runs said about its head commit, one per workflow. */ |
| 291 | statuses?: CommitStatus[]; |
| 292 | }; |
| 293 | |
| 294 | /** What a workflow run (or another tool) says about a commit. */ |
| 295 | export type CommitStatus = { |
| 296 | /** What reported it, such as `CI / push`. */ |
| 297 | context: string; |
| 298 | state: "pending" | "success" | "failure" | "error"; |
| 299 | description: string | null; |
| 300 | targetUrl: string | null; |
| 301 | updatedAt: string; |
| 302 | }; |
| 303 | |
| 304 | /** |
| 305 | * A step on the way from an assigned issue to a pull request that is ready |
| 306 | * to merge. g1t takes each one without being asked: `working` (the agent is |
| 307 | * making the change), `checking`, `reviewing`, `revising` (the agent is |
| 308 | * addressing failed checks or a review), `catching_up` (merging in the |
| 309 | * branch it would land on), then `ready` for a person to merge. `needs_you` |
| 310 | * means g1t has stopped and a person decides what happens next. |
| 311 | */ |
| 312 | export type Stage = |
| 313 | | "working" |
| 314 | | "checking" |
| 315 | | "reviewing" |
| 316 | | "revising" |
| 317 | | "catching_up" |
| 318 | | "queued" |
| 319 | | "ready" |
| 320 | | "needs_you"; |
| 321 | |
| 322 | export type Lifecycle = { |
| 323 | stage: Stage; |
| 324 | /** One sentence saying what is happening, or why it stopped. */ |
| 325 | detail: string; |
| 326 | /** How many times the agent has been sent back to revise it. */ |
| 327 | revisions: number; |
| 328 | }; |
| 329 | |
| 330 | /** What the runner needs to carry out a step of a pull request's lifecycle. */ |
| 331 | export type LifecycleJob = { |
| 332 | pullId: string; |
| 333 | repo: RepoPath; |
| 334 | number: number; |
| 335 | /** Who the pull request belongs to. Sandboxes act as them. */ |
| 336 | author: User; |
| 337 | /** The repository holding the change: its fork, or the repository itself. */ |
| 338 | source: RepoPath; |
| 339 | /** The branch of the source holding the change; its default branch when null. */ |
| 340 | branch: string | null; |
| 341 | defaultBranch: string; |
| 342 | title: string; |
| 343 | description: string; |
| 344 | issue: Issue | null; |
| 345 | /** For a revision: the failed checks or the review to address. */ |
| 346 | feedback: string; |
| 347 | /** For a revision: which one this is, from 1. */ |
| 348 | round: number; |
| 349 | }; |
| 350 | |
| 351 | /** |
| 352 | * `planning` while an agent reads the repository and writes it; `ready` for |
| 353 | * a person to read and apply; `failed` if it could not be written; |
| 354 | * `applied` once its issues are open. |
| 355 | */ |
| 356 | export type PlanStatus = "planning" | "ready" | "failed" | "applied"; |
| 357 | |
| 358 | /** One issue a plan proposes. */ |
| 359 | export type PlannedIssue = { |
| 360 | title: string; |
| 361 | /** Markdown: what to change, where, and why. */ |
| 362 | body: string; |
| 363 | labels: string[]; |
| 364 | /** Commands that must pass once the change is made. */ |
| 365 | checks: string[]; |
| 366 | /** The files it will most likely change. */ |
| 367 | files: string[]; |
| 368 | /** |
| 369 | * The positions, counting from 1, of earlier issues in the plan that have |
| 370 | * to be merged first. |
| 371 | */ |
| 372 | dependsOn: number[]; |
| 373 | /** Its number, once the plan has been applied and it was kept. */ |
| 374 | number: number | null; |
| 375 | }; |
| 376 | |
| 377 | /** An outcome someone wrote, and the issues an agent proposes to get there. */ |
| 378 | export type Plan = { |
| 379 | id: string; |
| 380 | repoId: string; |
| 381 | /** The outcome wanted, as written. */ |
| 382 | brief: string; |
| 383 | status: PlanStatus; |
| 384 | /** The agent's account of how it split the work. */ |
| 385 | summary: string; |
| 386 | issues: PlannedIssue[]; |
| 387 | /** Why it could not be written, when `status` is `failed`. */ |
| 388 | error: string | null; |
| 389 | author: User; |
| 390 | /** RFC 3339. */ |
| 391 | createdAt: string; |
| 392 | /** RFC 3339. */ |
| 393 | finishedAt: string | null; |
| 394 | /** Once applied: where each issue it opened stands now, in plan order. */ |
| 395 | progress: IssueProgress[]; |
| 396 | /** Questions and handoffs between its pull requests' agents, newest first. */ |
| 397 | exchanges: AgentMessage[]; |
| 398 | }; |
| 399 | |
| 400 | /** What a sandbox needs to write a plan. */ |
| 401 | export type PlanJob = { |
| 402 | planId: string; |
| 403 | /** Lets the sandbox, and nothing else, report this plan. */ |
| 404 | token: string; |
| 405 | brief: string; |
| 406 | repo: RepoPath; |
| 407 | }; |
| 408 | |
| 409 | /** An issue waiting for a g1t agent that can be given one now. */ |
| 410 | export type ReadyIssue = { |
| 411 | repo: RepoPath; |
| 412 | number: number; |
| 413 | /** Who queued it, on whose say-so the agent works. */ |
| 414 | actor: User; |
| 415 | }; |
| 416 | |
| 417 | /** |
| 418 | * How a repository wants its pull requests handled. A repository that has |
| 419 | * changed nothing has the defaults. |
| 420 | */ |
| 421 | export type RepoSettings = { |
| 422 | /** |
| 423 | * Land a g1t agent's pull request without a person once it is ready: |
| 424 | * checks passed and approved as the settings below require. |
| 425 | */ |
| 426 | autoMerge: boolean; |
| 427 | /** |
| 428 | * Refuse to merge a pull request that does not contain the default |
| 429 | * branch's latest commits, so that what merges is what was checked. When |
| 430 | * off, merging one that is behind brings it up to date first. |
| 431 | */ |
| 432 | requireUpToDate: boolean; |
| 433 | /** |
| 434 | * How many approving reviews a pull request needs before it may merge. A |
| 435 | * reviewer who has since asked for changes blocks it. |
| 436 | */ |
| 437 | requiredApprovals: number; |
| 438 | /** Whether a g1t agent's approval counts towards `requiredApprovals`. */ |
| 439 | countAgentApprovals: boolean; |
| 440 | /** Whether a member may merge although the acceptance checks did not pass. */ |
| 441 | allowIgnoringChecks: boolean; |
| 442 | /** Whether a g1t agent's pull request is reviewed by a second agent unasked. */ |
| 443 | agentReview: boolean; |
| 444 | /** |
| 445 | * How many times a g1t agent is sent back to its pull request before a |
| 446 | * person is asked instead. |
| 447 | */ |
| 448 | maxRevisions: number; |
| 449 | /** |
| 450 | * Merge through a queue: pull requests are tested together with those |
| 451 | * ahead of them, and only a combination that passed reaches the default |
| 452 | * branch. |
| 453 | */ |
| 454 | mergeQueue: boolean; |
| 455 | /** Username of the member who last changed the settings, if anyone has. */ |
| 456 | updatedBy: string | null; |
| 457 | /** RFC 3339. */ |
| 458 | updatedAt: string | null; |
| 459 | }; |
| 460 | |
| 461 | /** The settings a member can change. */ |
| 462 | export type RepoSettingsInput = Omit<RepoSettings, "updatedBy" | "updatedAt">; |
| 463 | |
| 464 | /** The next step for a pull request g1t is seeing through, already claimed. */ |
| 465 | export type Advance = |
| 466 | | { action: "none" } |
| 467 | | { action: "review" | "revise" | "catch_up"; job: LifecycleJob }; |
| 468 | |
| 469 | /** What a sandbox needs to review a pull request. */ |
| 470 | export type ReviewJob = { |
| 471 | runId: string; |
| 472 | /** Lets the sandbox, and nothing else, report this review. */ |
| 473 | token: string; |
| 474 | /** The repository holding the commit: the fork, or the repository itself. */ |
| 475 | source: RepoPath; |
| 476 | commit: string; |
| 477 | repo: RepoPath; |
| 478 | defaultBranch: string; |
| 479 | number: number; |
| 480 | title: string; |
| 481 | description: string; |
| 482 | /** The issue the pull request is for, which says what it should achieve. */ |
| 483 | issue: Issue | null; |
| 484 | /** Who opened the pull request, and so can read its source. */ |
| 485 | author: User; |
| 486 | }; |
| 487 | |
| 488 | export type OpenIssueInput = { |
| 489 | title: string; |
| 490 | body: string; |
| 491 | labels?: string[]; |
| 492 | checks?: string[]; |
| 493 | }; |
| 494 | |
| 495 | export type UpdateIssueInput = { |
| 496 | title?: string; |
| 497 | body?: string; |
| 498 | labels?: string[]; |
| 499 | /** Usernames of the people it is assigned to; replaces the whole set. */ |
| 500 | assignees?: string[]; |
| 501 | }; |
| 502 | |
| 503 | export type OpenPullInput = { |
| 504 | /** The number of the issue this is for. */ |
| 505 | issue?: number; |
| 506 | /** Defaults to the issue's title; required without an issue. */ |
| 507 | title?: string; |
| 508 | /** What changed and why. Usually set later, when a draft is marked ready. */ |
| 509 | body?: string; |
| 510 | /** |
| 511 | * A branch of the repository that already holds the change. The pull |
| 512 | * request is then ready for review at once and has no fork. |
| 513 | */ |
| 514 | branch?: string; |
| 515 | agent: string; |
| 516 | runtime: Runtime; |
| 517 | }; |
| 518 | |
| 519 | /** Issues, pull requests, comments and sessions. */ |
| 520 | export interface WorkApi { |
| 521 | openIssue(actor: User, repo: RepoPath, input: OpenIssueInput): Promise<Result<Issue>>; |
| 522 | /** Newest first. */ |
| 523 | listIssues( |
| 524 | repo: RepoPath, |
| 525 | viewer: Viewer, |
| 526 | filter?: { state?: State; label?: string }, |
| 527 | ): Promise<Result<Issue[]>>; |
| 528 | getIssue(repo: RepoPath, number: number, viewer: Viewer): Promise<Result<IssueDetail>>; |
| 529 | /** The author or a member of the workspace may. */ |
| 530 | updateIssue(actor: User, repo: RepoPath, number: number, input: UpdateIssueInput): Promise<Result<Issue>>; |
| 531 | closeIssue(actor: User, repo: RepoPath, number: number, reason?: IssueReason): Promise<Result<Issue>>; |
| 532 | reopenIssue(actor: User, repo: RepoPath, number: number): Promise<Result<Issue>>; |
| 533 | /** The default labels, then every other label in use on the repository. */ |
| 534 | listLabels(repo: RepoPath, viewer: Viewer): Promise<Result<string[]>>; |
| 535 | /** How many issues and pull requests are open. */ |
| 536 | counts(repo: RepoPath, viewer: Viewer): Promise<Result<{ issues: number; pulls: number }>>; |
| 537 | |
| 538 | /** |
| 539 | * On an issue or a pull request. On a pull request it may name a line of |
| 540 | * the change and carry a verdict; nobody can give a verdict on their own. |
| 541 | */ |
| 542 | addComment(actor: User, repo: RepoPath, number: number, comment: NewComment): Promise<Result<Comment>>; |
| 543 | |
| 544 | /** |
| 545 | * Begins a run of the acceptance checks for a pull request that is ready |
| 546 | * for review. For the runner service, which starts the sandbox. |
| 547 | */ |
| 548 | startChecks(pullId: string): Promise<Result<CheckJob>>; |
| 549 | /** |
| 550 | * What a sandbox says about its run. With no results and no error it has |
| 551 | * started; `skip` forgets a run that will not be carried out. |
| 552 | */ |
| 553 | reportChecks(runId: string, token: string, report: CheckReport): Promise<Result<CheckRun>>; |
| 554 | /** Begins a review by a g1t agent. For the runner service. */ |
| 555 | startReview(pullId: string): Promise<Result<ReviewJob>>; |
| 556 | /** Records that a review could not be written. For the runner service. */ |
| 557 | failReview(runId: string, token: string, error: string): Promise<Result<boolean>>; |
| 558 | |
| 559 | /** |
| 560 | * Works out the next step for a pull request g1t is seeing through and, |
| 561 | * if there is one to take now, claims it, so that it is taken once |
| 562 | * however often this is called. For the runner service. |
| 563 | */ |
| 564 | advance(pullId: string): Promise<Advance>; |
| 565 | /** Records that a step could not be carried out, so a person is asked. */ |
| 566 | stall(pullId: string, reason: string): Promise<boolean>; |
| 567 | /** Ids of the open pull requests g1t is seeing through. */ |
| 568 | managedPulls(repoId?: string): Promise<string[]>; |
| 569 | |
| 570 | /** A repository's merge queue: what is in it, in order, and what recently left. */ |
| 571 | queue(repo: RepoPath, viewer: Viewer): Promise<Result<QueueView>>; |
| 572 | /** |
| 573 | * The next batch of combined states to test for a repository, one per |
| 574 | * entry; empty while a batch is being tested or nothing waits. |
| 575 | */ |
| 576 | queueBuild(repoId: string): Promise<QueueJob[]>; |
| 577 | /** Reports that a combined state could not be built or checked. */ |
| 578 | failQueue(entryId: string, token: string, error: string): Promise<Result<QueueState>>; |
| 579 | /** Sends the agent working on a pull request a message, for its next step. */ |
| 580 | messageAgent(actor: User, repo: RepoPath, number: number, body: string): Promise<Result<AgentMessage>>; |
| 581 | /** Takes a pull request out of the merge queue. Members only. */ |
| 582 | removeFromQueue(actor: User, repo: RepoPath, number: number): Promise<Result<Pull>>; |
| 583 | |
| 584 | getSettings(repo: RepoPath, viewer: Viewer): Promise<Result<RepoSettings>>; |
| 585 | /** Members of the repository's workspace only. */ |
| 586 | updateSettings(actor: User, repo: RepoPath, settings: RepoSettingsInput): Promise<Result<RepoSettings>>; |
| 587 | /** |
| 588 | * What the runner needs to bring a pull request up to date because a |
| 589 | * merge of it was asked for. Null if none was. |
| 590 | */ |
| 591 | catchUpJob(pullId: string): Promise<LifecycleJob | null>; |
| 592 | |
| 593 | /** |
| 594 | * Opens a pull request: a draft with a fork to push to, or, given a |
| 595 | * branch, one ready for review. |
| 596 | */ |
| 597 | openPull(actor: User, repo: RepoPath, input: OpenPullInput): Promise<Result<Pull>>; |
| 598 | /** Newest first. */ |
| 599 | listPulls(repo: RepoPath, viewer: Viewer, state?: State): Promise<Result<Pull[]>>; |
| 600 | getPull(repo: RepoPath, number: number, viewer: Viewer): Promise<Result<PullDetail>>; |
| 601 | /** |
| 602 | * Changes who a pull request is assigned to and whose review is asked |
| 603 | * for; each list given replaces the whole set. Asking for `g1t-agent`'s |
| 604 | * review does not by itself start one: the runner's `review` does. |
| 605 | */ |
| 606 | updatePull( |
| 607 | actor: User, |
| 608 | repo: RepoPath, |
| 609 | number: number, |
| 610 | changes: { assignees?: string[]; reviewers?: string[] }, |
| 611 | ): Promise<Result<Pull>>; |
| 612 | /** Marks a draft ready for review and sets its description. */ |
| 613 | readyPull(actor: User, repo: RepoPath, number: number, summary: string): Promise<Result<Pull>>; |
| 614 | closePull(actor: User, repo: RepoPath, number: number): Promise<Result<Pull>>; |
| 615 | /** |
| 616 | * Lands the pull request on the repository's default branch. Unless |
| 617 | * `keepIssueOpen`, that resolves the issue it was for: the issue closes |
| 618 | * naming this pull request, and the others still in progress for it close |
| 619 | * as superseded. Only members of the repository's workspace may merge. |
| 620 | * |
| 621 | * If the default branch has moved, the pull request is brought up to date |
| 622 | * first and lands when that is done; it comes back still open, and |
| 623 | * `PullDetail.landing` is true meanwhile. A repository that requires pull |
| 624 | * requests to be up to date refuses instead. |
| 625 | */ |
| 626 | mergePull( |
| 627 | actor: User, |
| 628 | repo: RepoPath, |
| 629 | number: number, |
| 630 | options?: { |
| 631 | keepIssueOpen?: boolean; |
| 632 | /** Merge although the acceptance checks have not passed. */ |
| 633 | ignoreChecks?: boolean; |
| 634 | }, |
| 635 | ): Promise<Result<Pull>>; |
| 636 | /** |
| 637 | * Drafts and open pull requests the viewer started, most recently active |
| 638 | * first, each with where it stands if g1t is seeing it through. |
| 639 | */ |
| 640 | listActivePulls( |
| 641 | viewer: Viewer, |
| 642 | ): Promise<{ pull: Pull; issue: Issue | null; lifecycle: Lifecycle | null }[]>; |
| 643 | |
| 644 | /** |
| 645 | * Records an outcome to plan for. Members only. For the runner service, |
| 646 | * which starts the sandbox in which an agent writes the plan. |
| 647 | */ |
| 648 | startPlan(actor: User, repo: RepoPath, brief: string): Promise<Result<PlanJob>>; |
| 649 | /** Records that a plan could not be written. For the runner service. */ |
| 650 | failPlan(planId: string, token: string, error: string): Promise<Result<boolean>>; |
| 651 | /** Members only. */ |
| 652 | getPlan(repo: RepoPath, viewer: Viewer, id: string): Promise<Result<Plan>>; |
| 653 | /** Newest first. Members only. */ |
| 654 | listPlans(repo: RepoPath, viewer: Viewer): Promise<Result<Plan[]>>; |
| 655 | /** |
| 656 | * Opens a plan's issues, each blocked by the ones it depends on. With |
| 657 | * `assign`, each is queued for a g1t agent. `keep` holds the positions, |
| 658 | * from 1, of the issues to open; all of them when absent. Once. |
| 659 | */ |
| 660 | applyPlan( |
| 661 | actor: User, |
| 662 | repo: RepoPath, |
| 663 | id: string, |
| 664 | options?: { assign?: boolean; keep?: number[] }, |
| 665 | ): Promise<Result<Plan>>; |
| 666 | /** Asks for a g1t agent to take an issue as soon as it can, or withdraws that. */ |
| 667 | queueIssue(actor: User, repo: RepoPath, number: number, queued: boolean): Promise<Result<boolean>>; |
| 668 | /** Issues waiting for a g1t agent that can be given one now. For the runner. */ |
| 669 | readyIssues(repoId?: string): Promise<ReadyIssue[]>; |
| 670 | |
| 671 | /** Open issues assigned to the viewer, most recently changed first. */ |
| 672 | listAssignedIssues(viewer: Viewer): Promise<Issue[]>; |
| 673 | |
| 674 | appendSession(actor: User, repo: RepoPath, number: number, entries: NewSessionEntry[]): Promise<Result<{ count: number }>>; |
| 675 | readSession(repo: RepoPath, number: number, viewer: Viewer, afterSeq?: number): Promise<Result<SessionEntry[]>>; |
| 676 | } |
| 677 | |
| 678 | /** |
| 679 | * What to pass `ReposApi.compare` to see what a pull request changes. |
| 680 | * |
| 681 | * A fork is compared as a whole. A branch is compared by name while the |
| 682 | * pull request is open, and by the commit it was merged or closed at |
| 683 | * afterwards, so later pushes to the branch do not change the record. |
| 684 | */ |
| 685 | export function pullComparison(pull: Pull): { |
| 686 | repoId: string; |
| 687 | base: string | null; |
| 688 | head: string | null; |
| 689 | } { |
| 690 | if (pull.forkRepoId) return { repoId: pull.forkRepoId, base: pull.mergeBase, head: null }; |
| 691 | const settled = pull.status === "merged" || pull.status === "closed"; |
| 692 | return { |
| 693 | repoId: pull.repoId, |
| 694 | base: pull.mergeBase, |
| 695 | head: (settled && pull.headCommit) || pull.branch, |
| 696 | }; |
| 697 | } |
| 698 | |
| 699 | |
| 700 | /** Where a pull request in a merge queue stands. */ |
| 701 | /** Where one issue of an applied plan stands. */ |
| 702 | export type IssueProgress = { |
| 703 | number: number; |
| 704 | title: string; |
| 705 | /** |
| 706 | * `blocked`, `waiting` (for an agent), `open`, a lifecycle stage, |
| 707 | * `landed` or `closed`. |
| 708 | */ |
| 709 | state: string; |
| 710 | detail: string; |
| 711 | /** The issues it is waiting on that are still open. */ |
| 712 | blockedBy: number[]; |
| 713 | pull: number | null; |
| 714 | agent: string | null; |
| 715 | }; |
| 716 | |
| 717 | /** A message a person sent an agent at work on a pull request. */ |
| 718 | export type AgentMessage = { |
| 719 | id: string; |
| 720 | author: string; |
| 721 | body: string; |
| 722 | createdAt: string; |
| 723 | /** When the agent received it; null until then. */ |
| 724 | deliveredAt: string | null; |
| 725 | /** `message` from a person; from an agent a `question`, `handoff` or `answer`. */ |
| 726 | kind: "message" | "question" | "handoff" | "answer"; |
| 727 | /** The pull request whose agent sent it, when an agent did. */ |
| 728 | fromNumber: number | null; |
| 729 | /** The pull request it was sent to. */ |
| 730 | toNumber: number; |
| 731 | /** The reply to a question or handoff, once there is one. */ |
| 732 | answer: string | null; |
| 733 | declined: boolean; |
| 734 | /** For the sending agent: what to expect when the one it asked is not at work. */ |
| 735 | hint?: string; |
| 736 | }; |
| 737 | |
| 738 | export type QueueState = "waiting" | "testing" | "passed" | "failed" | "landed" | "removed"; |
| 739 | |
| 740 | /** One pull request's place in a merge queue. */ |
| 741 | export type QueueEntry = { |
| 742 | id: string; |
| 743 | number: number; |
| 744 | title: string; |
| 745 | agent: string; |
| 746 | state: QueueState; |
| 747 | /** The pull requests merged ahead of it in the state being tested, in order. */ |
| 748 | ahead: number[]; |
| 749 | baseCommit: string | null; |
| 750 | combinedCommit: string | null; |
| 751 | error: string | null; |
| 752 | results: CheckResult[]; |
| 753 | /** Username of whoever merged it into the queue: a person, or `g1t`. */ |
| 754 | enqueuedBy: string; |
| 755 | /** RFC 3339. */ |
| 756 | createdAt: string; |
| 757 | /** RFC 3339. */ |
| 758 | finishedAt: string | null; |
| 759 | }; |
| 760 | |
| 761 | /** A repository's merge queue: what is in it, in order, and what recently left. */ |
| 762 | export type QueueView = { |
| 763 | enabled: boolean; |
| 764 | active: QueueEntry[]; |
| 765 | /** Newest first. */ |
| 766 | recent: QueueEntry[]; |
| 767 | }; |
| 768 | |
| 769 | export type QueueStackItem = { |
| 770 | number: number; |
| 771 | title: string; |
| 772 | /** The repository holding the change, and its branch. */ |
| 773 | source: RepoPath; |
| 774 | branch: string; |
| 775 | commit: string; |
| 776 | }; |
| 777 | |
| 778 | /** What a sandbox needs to build and check one combined state. */ |
| 779 | export type QueueJob = { |
| 780 | entryId: string; |
| 781 | token: string; |
| 782 | repo: RepoPath; |
| 783 | defaultBranch: string; |
| 784 | baseCommit: string; |
| 785 | branch: string; |
| 786 | stack: QueueStackItem[]; |
| 787 | checks: string[]; |
| 788 | /** The checks of issues already completed: the default branch's contract. */ |
| 789 | contractChecks: string[]; |
| 790 | actor: User; |
| 791 | }; |