Interface: ReviewSourceSnapshot
Makaio Framework / contracts / ReviewSourceSnapshot
Interface: ReviewSourceSnapshot
Section titled “Interface: ReviewSourceSnapshot”Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:48
Snapshot of raw data from a review source, before processing.
Properties
Section titled “Properties”cliOutput?
Section titled “cliOutput?”
optionalcliOutput?:string
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:62
CLI tool output
comments
Section titled “comments”comments:
object[]
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:56
Inline and general review comments
author
Section titled “author”author:
string
Username of the commenter
body:
string
Comment body text
createdAt
Section titled “createdAt”createdAt:
string
ISO timestamp when comment was created
diffHunk?
Section titled “diffHunk?”
optionaldiffHunk?:string|null
Diff hunk context for the comment (if available)
id:
number
Unique identifier for the comment
inReplyToId
Section titled “inReplyToId”inReplyToId:
number|null
ID of the parent comment if this is a reply
isResolved?
Section titled “isResolved?”
optionalisResolved?:boolean|null
Whether this comment’s thread is resolved
line:
number|null
Line number (null for general PR comments)
path:
string|null
File path the comment is on (null for general PR comments)
threadId?
Section titled “threadId?”
optionalthreadId?:string|null
GraphQL node ID for thread operations (GitHub: PRRT_*)
updatedAt
Section titled “updatedAt”updatedAt:
string
ISO timestamp when comment was last updated
issueComments?
Section titled “issueComments?”
optionalissueComments?:object[]
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:60
Issue-level comments (e.g., from issue timeline)
author
Section titled “author”author:
string
Author username
body:
string
Comment body
createdAt
Section titled “createdAt”createdAt:
string|null
ISO timestamp when created
id:
string|number
Comment ID
updatedAt
Section titled “updatedAt”updatedAt:
string|null
ISO timestamp when updated
url:
string|null
URL to the comment
rateLimitBody?
Section titled “rateLimitBody?”
optionalrateLimitBody?:string
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:64
Raw body containing rate limit information
reviewer
Section titled “reviewer”reviewer:
string
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:52
Reviewer family
reviews
Section titled “reviews”reviews:
object[]
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:58
Review-level bodies
author
Section titled “author”author:
string
Username of the reviewer
body:
string|null
Review body text
id:
number
Unique identifier for the review
state:
"APPROVED"|"CHANGES_REQUESTED"|"COMMENTED"|"PENDING"|"DISMISSED"
Review state
submittedAt
Section titled “submittedAt”submittedAt:
string|null
ISO timestamp when review was submitted
sourceId
Section titled “sourceId”sourceId:
string
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:50
Source that produced this snapshot
target
Section titled “target”target:
object
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:54
Target PR/branch
branch?
Section titled “branch?”
optionalbranch?:string
Branch name
headSha?
Section titled “headSha?”
optionalheadSha?:string
Head commit SHA
prNumber?
Section titled “prNumber?”
optionalprNumber?:number
Pull request number
repository
Section titled “repository”repository:
string
Repository identity (e.g., ‘owner/repo’)