Skip to content

Variable: VCSSubjects

Makaio Framework


Makaio Framework / contracts / VCSSubjects

const VCSSubjects: BusSubjects<FlatSubjectDefinitions<"vcs", { capability.write: { request: ZodObject<{ repoPath: ZodString; }, $strip>; response: ZodObject<{ canWrite: ZodBoolean; level: ZodEnum<{ admin: "admin"; maintain: "maintain"; none: "none"; read: "read"; triage: "triage"; write: "write"; }>; }, $strip>; }; checks.get: { request: ZodObject<{ commitSha: ZodString; repoPath: ZodString; }, $strip>; response: ZodObject<{ checks: ZodArray<ZodObject<{ completedAt: ZodNullable<ZodString>; conclusion: ZodNullable<ZodEnum<…>>; id: ZodNumber; jobName: ZodOptional<ZodString>; name: ZodString; startedAt: ZodNullable<ZodString>; status: ZodEnum<{ completed: …; in_progress: …; queued: …; }>; url: ZodString; workflowName: ZodOptional<ZodString>; }, $strip>>; }, $strip>; }; comments.create: { request: ZodObject<{ body: ZodString; commitId: ZodString; line: ZodNumber; path: ZodString; prNumber: ZodNumber; repoPath: ZodString; side: ZodOptional<ZodEnum<{ LEFT: "LEFT"; RIGHT: "RIGHT"; }>>; }, $strip>; response: ZodObject<{ comment: ZodObject<{ author: ZodString; body: ZodString; createdAt: ZodString; diffHunk: ZodOptional<ZodNullable<ZodString>>; id: ZodNumber; inReplyToId: ZodNullable<ZodNumber>; isResolved: ZodOptional<ZodNullable<ZodBoolean>>; line: ZodNullable<ZodNumber>; path: ZodNullable<ZodString>; threadId: ZodOptional<ZodNullable<ZodString>>; updatedAt: ZodString; }, $strip>; }, $strip>; }; comments.list: { request: ZodObject<{ prNumber: ZodNumber; repoPath: ZodString; }, $strip>; response: ZodObject<{ comments: ZodArray<ZodObject<{ author: ZodString; body: ZodString; createdAt: ZodString; diffHunk: ZodOptional<ZodNullable<…>>; id: ZodNumber; inReplyToId: ZodNullable<ZodNumber>; isResolved: ZodOptional<ZodNullable<…>>; line: ZodNullable<ZodNumber>; path: ZodNullable<ZodString>; threadId: ZodOptional<ZodNullable<…>>; updatedAt: ZodString; }, $strip>>; }, $strip>; }; comments.reply: { request: ZodObject<{ body: ZodString; commentId: ZodNumber; prNumber: ZodNumber; repoPath: ZodString; }, $strip>; response: ZodObject<{ comment: ZodObject<{ author: ZodString; body: ZodString; createdAt: ZodString; diffHunk: ZodOptional<ZodNullable<ZodString>>; id: ZodNumber; inReplyToId: ZodNullable<ZodNumber>; isResolved: ZodOptional<ZodNullable<ZodBoolean>>; line: ZodNullable<ZodNumber>; path: ZodNullable<ZodString>; threadId: ZodOptional<ZodNullable<ZodString>>; updatedAt: ZodString; }, $strip>; }, $strip>; }; comments.resolveThread: { request: ZodObject<{ prNumber: ZodNumber; repoPath: ZodString; threadId: ZodString; }, $strip>; response: ZodObject<{ success: ZodBoolean; }, $strip>; }; pr.get: { request: ZodObject<{ prNumber: ZodNumber; repoPath: ZodString; }, $strip>; response: ZodObject<{ pullRequest: ZodNullable<ZodObject<{ additions: ZodOptional<ZodNumber>; assignees: ZodArray<ZodString>; author: ZodString; baseBranch: ZodString; body: ZodNullable<ZodString>; branch: ZodString; changedFiles: ZodOptional<ZodNumber>; commentCount: ZodOptional<ZodNumber>; createdAt: ZodString; deletions: ZodOptional<ZodNumber>; draft: ZodBoolean; head: ZodOptional<ZodNullable<…>>; id: ZodString; labels: ZodArray<ZodString>; mergeable: ZodNullable<ZodBoolean>; mergeableState: ZodOptional<ZodString>; mergedAt: ZodNullable<ZodString>; number: ZodNumber; requestedReviewers: ZodArray<ZodString>; reviewCount: ZodOptional<ZodNumber>; reviews: ZodArray<ZodObject<…, …>>; state: ZodEnum<{ closed: …; merged: …; open: …; }>; title: ZodString; updatedAt: ZodString; url: ZodString; }, $strip>>; }, $strip>; }; pr.list: { request: ZodObject<{ branch: ZodString; repoPath: ZodString; }, $strip>; response: ZodObject<{ pullRequests: ZodArray<ZodObject<{ additions: ZodOptional<ZodNumber>; author: ZodString; baseBranch: ZodString; branch: ZodString; changedFiles: ZodOptional<ZodNumber>; commentCount: ZodOptional<ZodNumber>; createdAt: ZodString; deletions: ZodOptional<ZodNumber>; draft: ZodBoolean; head: ZodOptional<ZodNullable<…>>; id: ZodString; mergedAt: ZodNullable<ZodString>; number: ZodNumber; reviewCount: ZodOptional<ZodNumber>; state: ZodEnum<{ closed: …; merged: …; open: …; }>; title: ZodString; updatedAt: ZodString; url: ZodString; }, $strip>>; }, $strip>; }; pr.listForFile: { request: ZodObject<{ filePath: ZodString; repoPath: ZodString; }, $strip>; response: ZodObject<{ pullRequests: ZodArray<ZodObject<{ author: ZodString; baseBranch: ZodString; branch: ZodString; createdAt: ZodString; draft: ZodBoolean; head: ZodOptional<ZodNullable<…>>; id: ZodString; mergedAt: ZodNullable<ZodString>; number: ZodNumber; state: ZodEnum<{ closed: …; merged: …; open: …; }>; title: ZodString; updatedAt: ZodString; url: ZodString; }, $strip>>; }, $strip>; }; repository.get: { request: ZodObject<{ repoPath: ZodString; }, $strip>; response: ZodObject<{ repository: ZodNullable<ZodObject<{ defaultBranch: ZodOptional<ZodString>; owner: ZodString; provider: ZodString; repo: ZodString; url: ZodString; }, $strip>>; }, $strip>; }; statuses.get: { request: ZodObject<{ commitSha: ZodString; repoPath: ZodString; }, $strip>; response: ZodObject<{ statuses: ZodArray<ZodObject<{ context: ZodString; createdAt: ZodString; creator: ZodNullable<ZodString>; description: ZodNullable<ZodString>; id: ZodNumber; state: ZodEnum<{ error: …; failure: …; pending: …; success: …; }>; targetUrl: ZodNullable<ZodString>; updatedAt: ZodString; }, $strip>>; }, $strip>; }; }>, "vcs"> = VCSNamespace.subjects

Defined in: ../../../packages/contracts/src/capabilities/vcs/namespace.ts:32

Type-safe subjects for VCS operations.

Provides strongly-typed request/response handlers for each VCS subject.