Interface: IReviewSource

Makaio Framework

---

Makaio Framework / contracts / IReviewSource

Interface: IReviewSource

Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:121

Review source capability provider.

Sources handle source-specific I/O: VCS reads, CLI invocation, trigger comments, and rate-limit metadata.

Extends

• ICapabilityProvider

Properties

capabilities

readonly capabilities: object

Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:129

Source capabilities

canFetch

canFetch: boolean

canTrigger

canTrigger: boolean

isPush

isPush: boolean

---

capabilityId

readonly capabilityId: "review-source"

Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:123

Must be ‘review-source’

---

displayName

readonly displayName: string

Defined in: ../../../packages/contracts/src/capability/types.ts:11

Human-readable name for display in UI

Inherited from

ICapabilityProvider.displayName

---

id

readonly id: string

Defined in: ../../../packages/contracts/src/capability/types.ts:9

Unique identifier for this provider instance

Inherited from

ICapabilityProvider.id

---

preferredProcessorKey?

readonly optional preferredProcessorKey?: string

Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:127

Preferred processor key for this source

---

providerKey?

readonly optional providerKey?: string

Defined in: ../../../packages/contracts/src/capability/types.ts:17

Stable provider identity used for joins across registries.

Unlike id, this should remain stable across runtime re-registration.

Inherited from

ICapabilityProvider.providerKey

---

reviewer

readonly reviewer: string

Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:125

Reviewer family this source feeds (e.g., ‘coderabbit’)

Methods

fetchSnapshot()?

optional fetchSnapshot(params): Promise<ReviewSourceSnapshot>

Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:145

Fetch raw snapshot from the source.

Parameters

params

FetchFindingsParams & ReviewRequestContext

Fetch parameters merged with VCS routing context

Returns

Promise<ReviewSourceSnapshot>

Raw snapshot of source data before processing

---

getRateLimit()?

optional getRateLimit(): { lastUpdatedAt: number; limit: number; remaining: number; resetsAt: number; sourceId: string; } | null

Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:150

Get current rate limit state.

Returns

Current rate limit or null if not applicable

Type Literal

{ lastUpdatedAt: number; limit: number; remaining: number; resetsAt: number; sourceId: string; }

lastUpdatedAt

lastUpdatedAt: number

Epoch ms when this was last updated

limit

limit: number

Total limit

remaining

remaining: number

Remaining review triggers

resetsAt

resetsAt: number

Epoch ms when limit resets

sourceId

sourceId: string

Source that this rate limit applies to

---

null

---

trigger()?

optional trigger(params): Promise<ReviewTriggerResult>

Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:139

Trigger a review (e.g., post “@coderabbitai review” comment).

Parameters

params

ReviewTriggerParams & ReviewRequestContext

Trigger parameters merged with VCS routing context

Returns

Promise<ReviewTriggerResult>

Result indicating whether the trigger succeeded

---

validate()?

optional validate(): Promise<{ error?: string; valid: boolean; }>

Defined in: ../../../packages/contracts/src/capability/types.ts:22

Optional validation method to check provider configuration/credentials.

Returns

Promise<{ error?: string; valid: boolean; }>

Validation result with optional error message

Inherited from

ICapabilityProvider.validate