Skip to content

Variable: VCSPRSchemas

Makaio Framework


Makaio Framework / contracts / VCSPRSchemas

const VCSPRSchemas: object

Defined in: ../../../packages/contracts/src/capabilities/vcs-pr/schemas.ts:195

Bus subject schemas for VCS:PR operations.

Defines request/response and event payload shapes for all enriched PR entity subjects registered under the vcs:pr namespace.

checks.changed: ZodObject<{ checks: ZodObject<{ failed: ZodNumber; failedChecks: ZodArray<ZodObject<{ completedAt: ZodNullable<ZodString>; conclusion: ZodString; detailsUrl: ZodNullable<ZodString>; failedStep: ZodNullable<ZodString>; id: ZodNumber; name: ZodString; source: ZodEnum<{ check-run: "check-run"; commit-status: "commit-status"; }>; workflowName: ZodString; }, $strip>>; passed: ZodNumber; pending: ZodNumber; skipped: ZodNumber; status: ZodEnum<{ failing: "failing"; mixed: "mixed"; passing: "passing"; pending: "pending"; }>; summary: ZodString; total: ZodNumber; }, $strip>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodNumber; repository: ZodString; }, $strip>; }, $strip>

Checks changed. Subject: vcs:pr.checks.changed

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

Merge conflict detected. Subject: vcs:pr.conflicted

get: object

Get enriched PR state. Subject: vcs:pr.get

request: ZodObject<{ prNumber: ZodNumber; repoPath: ZodString; }, $strip>

response: ZodObject<{ pr: ZodObject<{ author: ZodString; baseBranch: ZodString; branch: ZodString; checks: ZodObject<{ failed: ZodNumber; failedChecks: ZodArray<ZodObject<{ completedAt: …; conclusion: …; detailsUrl: …; failedStep: …; id: …; name: …; source: …; workflowName: …; }, $strip>>; passed: ZodNumber; pending: ZodNumber; skipped: ZodNumber; status: ZodEnum<{ failing: "failing"; mixed: "mixed"; passing: "passing"; pending: "pending"; }>; summary: ZodString; total: ZodNumber; }, $strip>; draft: ZodBoolean; findings: ZodObject<{ addressed: ZodNumber; dismissed: ZodNumber; open: ZodNumber; openBySeverity: ZodObject<{ critical: ZodNumber; major: ZodNumber; minor: ZodNumber; nitpick: ZodNumber; }, $strip>; summary: ZodString; total: ZodNumber; verified: ZodNumber; }, $strip>; headSha: ZodString; labels: ZodArray<ZodObject<{ name: ZodString; semantic: ZodNullable<ZodEnum<…>>; }, $strip>>; mergeable: ZodNullable<ZodBoolean>; number: ZodNumber; readiness: ZodObject<{ blockers: ZodArray<ZodString>; status: ZodEnum<{ blocked: "blocked"; needs-attention: "needs-attention"; ready: "ready"; }>; warnings: ZodArray<ZodString>; }, $strip>; repository: ZodString; reviews: ZodObject<{ approvals: ZodNumber; changesRequested: ZodNumber; commented: ZodNumber; reviewers: ZodArray<ZodObject<{ reviewer: …; state: …; submittedAt: …; }, $strip>>; status: ZodEnum<{ approved: "approved"; changes-requested: "changes-requested"; pending: "pending"; }>; summary: ZodString; }, $strip>; state: ZodEnum<{ closed: "closed"; merged: "merged"; open: "open"; }>; syncedAt: ZodNumber; title: ZodString; url: ZodString; }, $strip>; }, $strip>

labels.changed: ZodObject<{ labels: ZodArray<ZodObject<{ name: ZodString; semantic: ZodNullable<ZodEnum<{ automation: "automation"; custom: "custom"; priority: "priority"; review: "review"; size: "size"; status: "status"; type: "type"; }>>; }, $strip>>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodNumber; repository: ZodString; }, $strip>; }, $strip>

Labels changed. Subject: vcs:pr.labels.changed

list: object

List enriched PR states. Subject: vcs:pr.list

request: ZodObject<{ branch: ZodOptional<ZodString>; repoPath: ZodString; }, $strip>

response: ZodObject<{ prs: ZodArray<ZodObject<{ author: ZodString; baseBranch: ZodString; branch: ZodString; checks: ZodObject<{ failed: ZodNumber; failedChecks: ZodArray<ZodObject<…, …>>; passed: ZodNumber; pending: ZodNumber; skipped: ZodNumber; status: ZodEnum<{ failing: …; mixed: …; passing: …; pending: …; }>; summary: ZodString; total: ZodNumber; }, $strip>; draft: ZodBoolean; findings: ZodObject<{ addressed: ZodNumber; dismissed: ZodNumber; open: ZodNumber; openBySeverity: ZodObject<{ critical: …; major: …; minor: …; nitpick: …; }, $strip>; summary: ZodString; total: ZodNumber; verified: ZodNumber; }, $strip>; headSha: ZodString; labels: ZodArray<ZodObject<{ name: ZodString; semantic: ZodNullable<…>; }, $strip>>; mergeable: ZodNullable<ZodBoolean>; number: ZodNumber; readiness: ZodObject<{ blockers: ZodArray<ZodString>; status: ZodEnum<{ blocked: …; needs-attention: …; ready: …; }>; warnings: ZodArray<ZodString>; }, $strip>; repository: ZodString; reviews: ZodObject<{ approvals: ZodNumber; changesRequested: ZodNumber; commented: ZodNumber; reviewers: ZodArray<ZodObject<…, …>>; status: ZodEnum<{ approved: …; changes-requested: …; pending: …; }>; summary: ZodString; }, $strip>; state: ZodEnum<{ closed: "closed"; merged: "merged"; open: "open"; }>; syncedAt: ZodNumber; title: ZodString; url: ZodString; }, $strip>>; }, $strip>

reviews.changed: ZodObject<{ reviews: ZodObject<{ approvals: ZodNumber; changesRequested: ZodNumber; commented: ZodNumber; reviewers: ZodArray<ZodObject<{ reviewer: ZodString; state: ZodEnum<{ APPROVED: "APPROVED"; CHANGES_REQUESTED: "CHANGES_REQUESTED"; COMMENTED: "COMMENTED"; DISMISSED: "DISMISSED"; PENDING: "PENDING"; }>; submittedAt: ZodNullable<ZodString>; }, $strip>>; status: ZodEnum<{ approved: "approved"; changes-requested: "changes-requested"; pending: "pending"; }>; summary: ZodString; }, $strip>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodNumber; repository: ZodString; }, $strip>; }, $strip>

Reviews changed. Subject: vcs:pr.reviews.changed

stateChanged: ZodObject<{ pr: ZodObject<{ author: ZodString; baseBranch: ZodString; branch: ZodString; checks: ZodObject<{ failed: ZodNumber; failedChecks: ZodArray<ZodObject<{ completedAt: ZodNullable<…>; conclusion: ZodString; detailsUrl: ZodNullable<…>; failedStep: ZodNullable<…>; id: ZodNumber; name: ZodString; source: ZodEnum<…>; workflowName: ZodString; }, $strip>>; passed: ZodNumber; pending: ZodNumber; skipped: ZodNumber; status: ZodEnum<{ failing: "failing"; mixed: "mixed"; passing: "passing"; pending: "pending"; }>; summary: ZodString; total: ZodNumber; }, $strip>; draft: ZodBoolean; findings: ZodObject<{ addressed: ZodNumber; dismissed: ZodNumber; open: ZodNumber; openBySeverity: ZodObject<{ critical: ZodNumber; major: ZodNumber; minor: ZodNumber; nitpick: ZodNumber; }, $strip>; summary: ZodString; total: ZodNumber; verified: ZodNumber; }, $strip>; headSha: ZodString; labels: ZodArray<ZodObject<{ name: ZodString; semantic: ZodNullable<ZodEnum<{ automation: …; custom: …; priority: …; review: …; size: …; status: …; type: …; }>>; }, $strip>>; mergeable: ZodNullable<ZodBoolean>; number: ZodNumber; readiness: ZodObject<{ blockers: ZodArray<ZodString>; status: ZodEnum<{ blocked: "blocked"; needs-attention: "needs-attention"; ready: "ready"; }>; warnings: ZodArray<ZodString>; }, $strip>; repository: ZodString; reviews: ZodObject<{ approvals: ZodNumber; changesRequested: ZodNumber; commented: ZodNumber; reviewers: ZodArray<ZodObject<{ reviewer: ZodString; state: ZodEnum<…>; submittedAt: ZodNullable<…>; }, $strip>>; status: ZodEnum<{ approved: "approved"; changes-requested: "changes-requested"; pending: "pending"; }>; summary: ZodString; }, $strip>; state: ZodEnum<{ closed: "closed"; merged: "merged"; open: "open"; }>; syncedAt: ZodNumber; title: ZodString; url: ZodString; }, $strip>; target: ZodObject<{ branch: ZodOptional<ZodString>; headSha: ZodOptional<ZodString>; prNumber: ZodNumber; repository: ZodString; }, $strip>; }, $strip>

Any sub-state changed. Subject: vcs:pr.stateChanged

sync: object

Force re-sync PR state. Subject: vcs:pr.sync

request: ZodObject<{ prNumber: ZodNumber; repoPath: ZodString; }, $strip>

response: ZodObject<{ pr: ZodObject<{ author: ZodString; baseBranch: ZodString; branch: ZodString; checks: ZodObject<{ failed: ZodNumber; failedChecks: ZodArray<ZodObject<{ completedAt: …; conclusion: …; detailsUrl: …; failedStep: …; id: …; name: …; source: …; workflowName: …; }, $strip>>; passed: ZodNumber; pending: ZodNumber; skipped: ZodNumber; status: ZodEnum<{ failing: "failing"; mixed: "mixed"; passing: "passing"; pending: "pending"; }>; summary: ZodString; total: ZodNumber; }, $strip>; draft: ZodBoolean; findings: ZodObject<{ addressed: ZodNumber; dismissed: ZodNumber; open: ZodNumber; openBySeverity: ZodObject<{ critical: ZodNumber; major: ZodNumber; minor: ZodNumber; nitpick: ZodNumber; }, $strip>; summary: ZodString; total: ZodNumber; verified: ZodNumber; }, $strip>; headSha: ZodString; labels: ZodArray<ZodObject<{ name: ZodString; semantic: ZodNullable<ZodEnum<…>>; }, $strip>>; mergeable: ZodNullable<ZodBoolean>; number: ZodNumber; readiness: ZodObject<{ blockers: ZodArray<ZodString>; status: ZodEnum<{ blocked: "blocked"; needs-attention: "needs-attention"; ready: "ready"; }>; warnings: ZodArray<ZodString>; }, $strip>; repository: ZodString; reviews: ZodObject<{ approvals: ZodNumber; changesRequested: ZodNumber; commented: ZodNumber; reviewers: ZodArray<ZodObject<{ reviewer: …; state: …; submittedAt: …; }, $strip>>; status: ZodEnum<{ approved: "approved"; changes-requested: "changes-requested"; pending: "pending"; }>; summary: ZodString; }, $strip>; state: ZodEnum<{ closed: "closed"; merged: "merged"; open: "open"; }>; syncedAt: ZodNumber; title: ZodString; url: ZodString; }, $strip>; }, $strip>