Skip to content

Variable: ReviewSchemas

Makaio Framework


Makaio Framework / contracts / ReviewSchemas

const ReviewSchemas: object

Defined in: ../../../packages/contracts/src/capabilities/review/schemas.ts:146

Bus subject schemas for the review capability namespace.

Each key maps to a subject name (prefixed with review. by the namespace registration). Events are bare Zod schemas; RPC subjects carry { request, response } pairs.

finding.statusChanged: ZodObject<{ finding: ZodObject<{ addressedAt: ZodNullable<ZodNumber>; addressedBy: ZodNullable<ZodString>; agentPrompt: ZodNullable<ZodString>; createdAt: ZodNumber; dismissedReason: ZodNullable<ZodString>; endLine: ZodNullable<ZodNumber>; file: ZodNullable<ZodString>; id: ZodString; message: ZodString; origin: ZodEnum<{ agent: "agent"; cli-output: "cli-output"; inline: "inline"; issue-comment: "issue-comment"; review-body: "review-body"; }>; rawCommentId: ZodNullable<ZodNumber>; reviewer: ZodString; severity: ZodEnum<{ critical: "critical"; major: "major"; minor: "minor"; nitpick: "nitpick"; }>; sourceId: ZodString; startLine: ZodNullable<ZodNumber>; status: ZodEnum<{ addressed: "addressed"; deferred: "deferred"; dismissed: "dismissed"; open: "open"; verified: "verified"; }>; suggestedChanges: ZodArray<ZodObject<{ file: ZodString; newCode: ZodString; oldCode: ZodString; }, $strip>>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; threadId: ZodNullable<ZodString>; updatedAt: ZodNumber; verifiedAt: ZodNullable<ZodNumber>; }, $strip>; previousStatus: ZodEnum<{ addressed: "addressed"; deferred: "deferred"; dismissed: "dismissed"; open: "open"; verified: "verified"; }>; }, $strip>

Finding status changed.

Subject: review.finding.statusChanged

finding.updateStatus: object

Update finding lifecycle status.

Subject: review.finding.updateStatus

request: ZodObject<{ addressedBy: ZodOptional<ZodString>; findingId: ZodString; reason: ZodOptional<ZodString>; status: ZodEnum<{ addressed: "addressed"; deferred: "deferred"; dismissed: "dismissed"; open: "open"; verified: "verified"; }>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; }, $strip>

response: ZodObject<{ finding: ZodObject<{ addressedAt: ZodNullable<ZodNumber>; addressedBy: ZodNullable<ZodString>; agentPrompt: ZodNullable<ZodString>; createdAt: ZodNumber; dismissedReason: ZodNullable<ZodString>; endLine: ZodNullable<ZodNumber>; file: ZodNullable<ZodString>; id: ZodString; message: ZodString; origin: ZodEnum<{ agent: "agent"; cli-output: "cli-output"; inline: "inline"; issue-comment: "issue-comment"; review-body: "review-body"; }>; rawCommentId: ZodNullable<ZodNumber>; reviewer: ZodString; severity: ZodEnum<{ critical: "critical"; major: "major"; minor: "minor"; nitpick: "nitpick"; }>; sourceId: ZodString; startLine: ZodNullable<ZodNumber>; status: ZodEnum<{ addressed: "addressed"; deferred: "deferred"; dismissed: "dismissed"; open: "open"; verified: "verified"; }>; suggestedChanges: ZodArray<ZodObject<{ file: ZodString; newCode: ZodString; oldCode: ZodString; }, $strip>>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; threadId: ZodNullable<ZodString>; updatedAt: ZodNumber; verifiedAt: ZodNullable<ZodNumber>; }, $strip>; success: ZodBoolean; }, $strip>

findings.arrived: ZodObject<{ created: ZodNumber; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; updated: ZodNumber; }, $strip>

New/updated findings available.

Subject: review.findings.arrived

findings.fetch: object

Fetch findings from external sources.

Subject: review.findings.fetch

request: ZodObject<{ repoPath: ZodString; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; }, $strip>

response: ZodObject<{ created: ZodNumber; findings: ZodArray<ZodObject<{ addressedAt: ZodNullable<ZodNumber>; addressedBy: ZodNullable<ZodString>; agentPrompt: ZodNullable<ZodString>; createdAt: ZodNumber; dismissedReason: ZodNullable<ZodString>; endLine: ZodNullable<ZodNumber>; file: ZodNullable<ZodString>; id: ZodString; message: ZodString; origin: ZodEnum<{ agent: "agent"; cli-output: "cli-output"; inline: "inline"; issue-comment: "issue-comment"; review-body: "review-body"; }>; rawCommentId: ZodNullable<ZodNumber>; reviewer: ZodString; severity: ZodEnum<{ critical: "critical"; major: "major"; minor: "minor"; nitpick: "nitpick"; }>; sourceId: ZodString; startLine: ZodNullable<ZodNumber>; status: ZodEnum<{ addressed: "addressed"; deferred: "deferred"; dismissed: "dismissed"; open: "open"; verified: "verified"; }>; suggestedChanges: ZodArray<ZodObject<{ file: ZodString; newCode: ZodString; oldCode: ZodString; }, $strip>>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; threadId: ZodNullable<ZodString>; updatedAt: ZodNumber; verifiedAt: ZodNullable<ZodNumber>; }, $strip>>; updated: ZodNumber; }, $strip>

findings.list: object

List stored findings.

Subject: review.findings.list

request: ZodObject<{ status: ZodOptional<ZodEnum<{ addressed: "addressed"; deferred: "deferred"; dismissed: "dismissed"; open: "open"; verified: "verified"; }>>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; }, $strip>

response: ZodObject<{ findings: ZodArray<ZodObject<{ addressedAt: ZodNullable<ZodNumber>; addressedBy: ZodNullable<ZodString>; agentPrompt: ZodNullable<ZodString>; createdAt: ZodNumber; dismissedReason: ZodNullable<ZodString>; endLine: ZodNullable<ZodNumber>; file: ZodNullable<ZodString>; id: ZodString; message: ZodString; origin: ZodEnum<{ agent: "agent"; cli-output: "cli-output"; inline: "inline"; issue-comment: "issue-comment"; review-body: "review-body"; }>; rawCommentId: ZodNullable<ZodNumber>; reviewer: ZodString; severity: ZodEnum<{ critical: "critical"; major: "major"; minor: "minor"; nitpick: "nitpick"; }>; sourceId: ZodString; startLine: ZodNullable<ZodNumber>; status: ZodEnum<{ addressed: "addressed"; deferred: "deferred"; dismissed: "dismissed"; open: "open"; verified: "verified"; }>; suggestedChanges: ZodArray<ZodObject<{ file: ZodString; newCode: ZodString; oldCode: ZodString; }, $strip>>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; threadId: ZodNullable<ZodString>; updatedAt: ZodNumber; verifiedAt: ZodNullable<ZodNumber>; }, $strip>>; }, $strip>

findings.submit: object

Submit an agent-produced finding.

Subject: review.findings.submit

request: ZodObject<{ finding: ZodObject<{ agentPrompt: ZodNullable<ZodString>; createdAt: ZodOptional<ZodNumber>; dismissedReason: ZodNullable<ZodString>; endLine: ZodNullable<ZodNumber>; file: ZodNullable<ZodString>; id: ZodString; message: ZodString; origin: ZodEnum<{ agent: "agent"; cli-output: "cli-output"; inline: "inline"; issue-comment: "issue-comment"; review-body: "review-body"; }>; rawCommentId: ZodNullable<ZodNumber>; reviewer: ZodString; severity: ZodEnum<{ critical: "critical"; major: "major"; minor: "minor"; nitpick: "nitpick"; }>; sourceId: ZodString; startLine: ZodNullable<ZodNumber>; status: ZodEnum<{ addressed: "addressed"; deferred: "deferred"; dismissed: "dismissed"; open: "open"; verified: "verified"; }>; suggestedChanges: ZodArray<ZodObject<{ file: ZodString; newCode: ZodString; oldCode: ZodString; }, $strip>>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; threadId: ZodNullable<ZodString>; updatedAt: ZodOptional<ZodNumber>; }, $strip>; }, $strip>

response: ZodObject<{ finding: ZodObject<{ addressedAt: ZodNullable<ZodNumber>; addressedBy: ZodNullable<ZodString>; agentPrompt: ZodNullable<ZodString>; createdAt: ZodNumber; dismissedReason: ZodNullable<ZodString>; endLine: ZodNullable<ZodNumber>; file: ZodNullable<ZodString>; id: ZodString; message: ZodString; origin: ZodEnum<{ agent: "agent"; cli-output: "cli-output"; inline: "inline"; issue-comment: "issue-comment"; review-body: "review-body"; }>; rawCommentId: ZodNullable<ZodNumber>; reviewer: ZodString; severity: ZodEnum<{ critical: "critical"; major: "major"; minor: "minor"; nitpick: "nitpick"; }>; sourceId: ZodString; startLine: ZodNullable<ZodNumber>; status: ZodEnum<{ addressed: "addressed"; deferred: "deferred"; dismissed: "dismissed"; open: "open"; verified: "verified"; }>; suggestedChanges: ZodArray<ZodObject<{ file: ZodString; newCode: ZodString; oldCode: ZodString; }, $strip>>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; threadId: ZodNullable<ZodString>; updatedAt: ZodNumber; verifiedAt: ZodNullable<ZodNumber>; }, $strip>; }, $strip>

source.list: object

List available sources and their rate limits.

Subject: review.source.list

request: ZodObject<{ }, $strip>

response: ZodObject<{ rateLimits: ZodArray<ZodObject<{ lastUpdatedAt: ZodNumber; limit: ZodNumber; remaining: ZodNumber; resetsAt: ZodNumber; sourceId: ZodString; }, $strip>>; sources: ZodArray<ZodObject<{ capabilities: ZodObject<{ canFetch: ZodBoolean; canTrigger: ZodBoolean; isPush: ZodBoolean; }, $strip>; displayName: ZodString; processorKey: ZodNullable<ZodString>; reviewer: ZodString; shadowedProcessors: ZodOptional<ZodArray<ZodString>>; sourceId: ZodString; }, $strip>>; }, $strip>

source.rateLimitChanged: ZodObject<{ rateLimit: ZodObject<{ lastUpdatedAt: ZodNumber; limit: ZodNumber; remaining: ZodNumber; resetsAt: ZodNumber; sourceId: ZodString; }, $strip>; }, $strip>

Source rate limit changed.

Subject: review.source.rateLimitChanged

source.registered: ZodObject<{ displayName: ZodString; reviewer: ZodString; sourceId: ZodString; }, $strip>

Source announces itself.

Subject: review.source.registered

start: object

Trigger a review.

Subject: review.start

request: ZodObject<{ repoPath: ZodString; sourceId: ZodOptional<ZodString>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; }, $strip>

response: ZodObject<{ estimatedDelayMs: ZodOptional<ZodNumber>; rateLimit: ZodNullable<ZodObject<{ lastUpdatedAt: ZodNumber; limit: ZodNumber; remaining: ZodNumber; resetsAt: ZodNumber; sourceId: ZodString; }, $strip>>; triggered: ZodBoolean; }, $strip>

started: ZodObject<{ sourceId: ZodString; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodOptional<ZodNumber>; repository: ZodString; }, $strip>; }, $strip>

Review was triggered.

Subject: review.started