Skip to content

Where people and agents ship software together. The open-source git platform for the whole job: issues, agents, checks and deploys to the edge.

988 linesCodeBlameRaw
1import type { ActionsApi } from "./actions";
2import type { AiApi } from "./ai";
3import type { BillingAdminApi, BillingApi } from "./billing";
4import type { DeploymentsApi } from "./deployments";
5import type { ProjectsApi } from "./projects";
6import type { EventsApi } from "./events";
7import type { IdentityAdminApi, IdentityApi } from "./identity";
8import type { IntegrationsApi } from "./integrations";
9import type { PackagesApi } from "./packages";
10import type { WebhooksApi } from "./webhooks";
11import type { ReposApi } from "./repos";
12import type { PullDetail, WorkApi } from "./work";
13import type { Result } from "./result";
14import type { RunnersAdminApi, RunnersApi } from "./runners";
15
16/** A service binding, as far as these clients need it. */
17export type ServiceBinding = {
18 fetch(input: string, init?: RequestInit): Promise<Response>;
19};
20
21/**
22 * Calls a method on a service that speaks the JSON protocol used by the
23 * Rust services: `POST /rpc/<method>` with the arguments as the body.
24 */
25async function rpc<T>(
26 service: ServiceBinding,
27 method: string,
28 args: object,
29): Promise<T> {
30 // The hostname is ignored; a service binding always reaches its service.
31 const response = await service.fetch(`https://service/rpc/${method}`, {
32 method: "POST",
33 headers: { "content-type": "application/json" },
34 body: JSON.stringify(args),
35 });
36 if (!response.ok) {
37 throw new Error(`${method} failed with status ${response.status}`);
38 }
39 return (await response.json()) as T;
40}
41
42export function identityClient(service: ServiceBinding): IdentityApi {
43 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
44 return {
45 register: (username, email, password, inviteCode, client, emailProof) =>
46 call("register", {
47 username,
48 email,
49 password,
50 invite_code: inviteCode ?? null,
51 email_proof: emailProof ?? null,
52 client: client ?? null,
53 }),
54 signIn: (username, password, client) => call("sign_in", { username, password, client: client ?? null }),
55 twoFactorSignIn: (challenge, code, client) => call("two_factor_sign_in", { challenge, code, client: client ?? null }),
56 signOut: (sessionToken) => call("sign_out", { sessionToken }),
57 resendVerification: (user) => call("resend_verification", { user }),
58 verifyEmail: (token) => call("verify_email", { token }),
59 requestPasswordReset: (email, client) => call("request_password_reset", { email, client: client ?? null }),
60 resetPassword: (token, password) =>
61 call("reset_password", { token, password }),
62 deviceStart: (clientName) => call("device_start", { clientName }),
63 deviceLookup: (userCode) => call("device_lookup", { userCode }),
64 deviceResolve: (userCode, user, approve) =>
65 call("device_resolve", { userCode, user, approve }),
66 deviceClaim: (deviceCode) => call("device_claim", { deviceCode }),
67 oauthAuthorize: (user, approval) => call("oauth_authorize", { user, ...approval }),
68 oauthExchange: (code, codeVerifier, clientId, redirectUri) =>
69 call("oauth_exchange", { code, codeVerifier, clientId, redirectUri }),
70 oauthRefresh: (refreshToken, clientId) =>
71 call("oauth_refresh", { refreshToken, clientId }),
72 listOAuthGrants: (user) => call("list_oauth_grants", { user }),
73 revokeOAuthGrant: (user, id) => call("revoke_oauth_grant", { user, id }),
74 updateOAuthGrant: (user, id, grant) =>
75 call("update_oauth_grant", { user, id, scopes: grant.scopes }),
76 createWorkspace: (user, slug, name) => call("create_workspace", { user, slug, name }),
77 getWorkspace: (slug) => call("get_workspace", { slug }),
78 workspaceResidency: (slug) => call("workspace_residency", { slug }),
79 setWorkspaceResidency: (actor, slug, residency) => call("set_workspace_residency", { actor, slug, residency }),
80 listMembers: (slug, viewer) => call("list_members", { slug, viewer }),
81 addMember: (actor, slug, username) => call("add_member", { actor, slug, username }),
82 removeMember: (actor, slug, username) =>
83 call("remove_member", { actor, slug, username, surface: "web" }),
84 updateMember: (actor, slug, username, change) =>
85 call("update_member", { actor, slug, username, role: change.role ?? null, org_roles: change.org_roles ?? null, surface: "web" }),
86 transferOwnership: (actor, slug, username) => call("transfer_ownership", { actor, slug, username, surface: "web" }),
87 leaveWorkspace: (user, slug) => call("leave_workspace", { user, slug, surface: "web" }),
88 setMemberPrivileges: (actor, slug, change) => call("set_member_privileges", { actor, slug, privileges: change, surface: "web" }),
89 setTwoFactorRequirement: (actor, slug, required) =>
90 call("set_two_factor_requirement", { actor, slug, required, surface: "web" }),
91 updateWorkspace: (actor, slug, details) =>
92 call("update_workspace", { actor, slug, ...details }),
93 renameWorkspace: (actor, slug, newSlug) => call("rename_workspace", { actor, slug, newSlug }),
94 checkWorkspaceRename: (actor, slug, newSlug) =>
95 call("check_workspace_rename", { actor, slug, newSlug }),
96 resolveSlug: (slug) => call("resolve_slug", { slug }),
97 deleteWorkspace: (actor, slug, confirm) => call("delete_workspace", { actor, slug, confirm }),
98 checkWorkspaceDeletion: (actor, slug) => call("check_workspace_deletion", { actor, slug }),
99 setWorkspaceAvatar: (actor, slug, image) => call("set_workspace_avatar", { actor, slug, image }),
100 setUserAvatar: (user, image) => call("set_user_avatar", { user, image }),
101 listWorkspaceTokens: (slug, viewer) => call("list_workspace_tokens", { slug, viewer }),
102 removeWorkspaceToken: (actor, slug, id) =>
103 call("remove_workspace_token", { actor, slug, id }),
104 createToken: (actor, input) =>
105 call("create_token", {
106 actor,
107 owner: input.owner ?? null,
108 name: input.name,
109 description: input.description ?? null,
110 ttl_seconds: input.ttlSeconds,
111 workspace: input.workspace,
112 repository_selection: input.repositorySelection,
113 repositories: input.repositories,
114 permissions: input.permissions,
115 website: input.website ?? false,
116 }),
117 updateToken: (actor, id, change, owner) =>
118 call("update_token", {
119 actor,
120 id,
121 owner: owner ?? null,
122 name: change.name ?? null,
123 description: change.description ?? null,
124 repository_selection: change.repositorySelection ?? null,
125 repositories: change.repositories ?? null,
126 permissions: change.permissions ?? null,
127 website: change.website ?? null,
128 }),
129 regenerateToken: (actor, id, ttlSeconds, owner) =>
130 call("regenerate_token", { actor, id, owner: owner ?? null, ttl_seconds: ttlSeconds ?? null }),
131 getTokenPolicy: (slug, viewer) => call("get_token_policy", { slug, viewer }),
132 setTokenPolicy: (actor, slug, change) =>
133 call("set_token_policy", {
134 actor,
135 slug,
136 allow_tokens_for_all_workspaces: change.allowTokensForAllWorkspaces ?? null,
137 allow_tokens_for_this_workspace: change.allowTokensForThisWorkspace ?? null,
138 require_approval: change.requireApproval ?? null,
139 max_lifetime_days: change.maxLifetimeDays ?? null,
140 forbid_no_expiry: change.forbidNoExpiry ?? null,
141 surface: "web",
142 }),
143 listMemberTokens: (actor, slug, filter = {}) =>
144 call("list_member_tokens", { actor, slug, status: filter.status ?? null }),
145 reviewTokenRequest: (actor, slug, id, approve, reason) =>
146 call("review_token_request", { actor, slug, id, approve, reason: reason ?? null, surface: "web" }),
147 revokeMemberToken: (actor, slug, id, reason) =>
148 call("revoke_member_token", { actor, slug, id, reason: reason ?? null, surface: "web" }),
149 userForSession: (sessionToken) => call("user_for_session", { sessionToken }),
150 listInvites: (user) => call("list_invites", { user }),
151 createInvite: (user, invite) =>
152 call("create_invite", {
153 user,
154 email: invite.email,
155 message: invite.message ?? null,
156 join: invite.join ?? null,
157 join_role: invite.join ? (invite.joinRole ?? null) : null,
158 surface: "web",
159 }),
160 revokeInvite: (user, id) => call("revoke_invite", { user, id }),
161 resendInvite: (user, id) => call("resend_invite", { user, id }),
162 checkInvite: (code, client, options = {}) =>
163 call("check_invite", {
164 code,
165 client: client ?? null,
166 viewer: options.viewer ?? null,
167 any_status: options.anyStatus ?? false,
168 email_proof: options.emailProof ?? null,
169 }),
170 acceptInvite: (user, code) => call("accept_invite", { user, code }),
171 inviteMember: (actor, slug, who) =>
172 call("invite_member", { actor, slug, email: who.email ?? "", username: who.username ?? null, role: who.role ?? null, message: who.message ?? null }),
173 listInvitations: (user) => call("list_invitations", { user }),
174 acceptInvitation: (user, id) => call("accept_invitation", { user, id, surface: "web" }),
175 declineInvitation: (user, id) => call("decline_invitation", { user, id, surface: "web" }),
176 findPeople: (query, limit) => call("find_people", { query, limit: limit ?? null }),
177 workspaceInvites: (slug, viewer) => call("workspace_invites", { slug, viewer }),
178 revokeWorkspaceInvite: (actor, slug, id) => call("revoke_workspace_invite", { actor, slug, id }),
179 resendWorkspaceInvite: (actor, slug, id) => call("resend_workspace_invite", { actor, slug, id }),
180 userForGitCredentials: (username, secret) =>
181 call("user_for_git_credentials", { username, secret }),
182 userForAccessToken: (token) => call("user_for_access_token", { token }),
183 userForSshKey: (fingerprint) => call("user_for_ssh_key", { fingerprint }),
184 userByUsername: (username) => call("user_by_username", { username }),
185 usernames: (ids) => call("usernames", { ids }),
186 accounts: (ids) => call("accounts", { ids }),
187 usersForAudience: (ids) => call("users_for_audience", { ids }),
188 profile: (username) => call("profile", { username }),
189 updateProfile: (actor, fields) => call("update_profile", { actor, ...fields }),
190 profileWorkspaces: (username, viewer, publicIn) =>
191 call("profile_workspaces", { username, viewer, public: publicIn }),
192 dockPins: (user, workspace) => call("dock_pins", { user, workspace }),
193 setDockPins: (user, workspace, apps) => call("set_dock_pins", { user, workspace, apps }),
194 onboarding: (user, workspace) => call("onboarding", { user, workspace }),
195 setOnboarding: (user, workspace, change) => call("set_onboarding", { user, workspace, change }),
196 soundSettings: (user) => call("sound_settings", { user }),
197 setSoundSettings: (user, change) => call("set_sound_settings", { user, change }),
198 listSshKeys: (user) => call("list_ssh_keys", { user }),
199 addSshKey: (user, title, publicKey) =>
200 call("add_ssh_key", { user, title, publicKey }),
201 removeSshKey: (user, id) => call("remove_ssh_key", { user, id }),
202 listAccessTokens: (user) => call("list_access_tokens", { user }),
203 createAccessToken: (user, name, ttlSeconds, grant) =>
204 call("create_access_token", {
205 user,
206 name,
207 ttlSeconds,
208 scopes: grant?.scopes ?? null,
209 listed: grant?.listed ?? false,
210 }),
211 removeAccessToken: (user, id) => call("remove_access_token", { user, id }),
212 createRunCredential: (input) => call("create_run_credential", input),
213 bindRunCredentials: (tokenHashes, runId) => call("bind_run_credentials", { tokenHashes, runId }),
214 revokeRunCredentials: (target) => call("revoke_run_credentials", target),
215 // Who has access to a repository; see access.ts.
216 repoAccess: (owner, name, viewer) => call("repo_access", { viewer, path: { namespace: owner, name } }),
217 addCollaborator: (actor, owner, name, invitee, role) =>
218 call("add_collaborator", { actor, path: { namespace: owner, name }, invitee, role }),
219 setCollaboratorRole: (actor, owner, name, username, role) =>
220 call("set_collaborator_role", { actor, path: { namespace: owner, name }, username, role }),
221 removeCollaborator: (actor, owner, name, username) =>
222 call("remove_collaborator", { actor, path: { namespace: owner, name }, username }),
223 collaboratorPermission: (viewer, owner, name, username) =>
224 call("collaborator_permission", { viewer, path: { namespace: owner, name }, username }),
225 myRepoInvitations: (user) => call("my_repo_invitations", { user }),
226 respondRepoInvitation: (user, id, accept) => call("respond_repo_invitation", { user, id, accept }),
227 revokeRepoInvitation: (actor, owner, name, id) =>
228 call("revoke_repo_invitation", { actor, path: { namespace: owner, name }, id }),
229 setBasePermission: (actor, slug, base) => call("set_base_permission", { actor, slug, base_permission: base }),
230 outsideCollaborators: (viewer, slug) => call("outside_collaborators", { viewer, slug }),
231 // A repository's deploy keys; see deploy-keys.ts.
232 listDeployKeys: (viewer, owner, name) => call("list_deploy_keys", { viewer, path: { namespace: owner, name } }),
233 addDeployKey: (actor, owner, name, key) =>
234 call("add_deploy_key", { actor, path: { namespace: owner, name }, title: key.title, key: key.key, read_only: key.readOnly }),
235 removeDeployKey: (actor, owner, name, id) => call("remove_deploy_key", { actor, path: { namespace: owner, name }, id }),
236 // Teams; see teams.ts.
237 listTeams: (viewer, workspace, query) => call("list_teams", { viewer, workspace, query: query ?? null }),
238 getTeam: (viewer, workspace, team) => call("get_team", { viewer, workspace, team }),
239 createTeam: (actor, workspace, team) => call("create_team", { actor, workspace, ...team }),
240 setTeamCreation: (actor, slug, setting) => call("set_team_creation", { actor, slug, team_creation: setting }),
241 updateTeam: (actor, workspace, team, changes) => call("update_team", { actor, workspace, team, ...changes }),
242 deleteTeam: (actor, workspace, team) => call("delete_team", { actor, workspace, team }),
243 teamMembers: (viewer, workspace, team, includeChildTeams) =>
244 call("team_members", { viewer, workspace, team, include_child_teams: includeChildTeams ?? false }),
245 setTeamMember: (actor, workspace, team, username, role) =>
246 call("set_team_member", { actor, workspace, team, username, role }),
247 removeTeamMember: (actor, workspace, team, username) =>
248 call("remove_team_member", { actor, workspace, team, username }),
249 childTeams: (viewer, workspace, team) => call("child_teams", { viewer, workspace, team }),
250 teamRepos: (viewer, workspace, team) => call("team_repos", { viewer, workspace, team }),
251 setTeamRepo: (actor, workspace, team, owner, name, role) =>
252 call("set_team_repo", { actor, workspace, team, repo: { namespace: owner, name }, role }),
253 removeTeamRepo: (actor, workspace, team, owner, name) =>
254 call("remove_team_repo", { actor, workspace, team, repo: { namespace: owner, name } }),
255 userTeams: (viewer, workspace, username) => call("user_teams", { viewer, workspace, username }),
256 teamMemberships: (viewer, workspace) => call("team_memberships", { viewer, workspace }),
257 // People; see people.ts.
258 peopleDirectory: (viewer, workspace) => call("people_directory", { viewer, workspace }),
259 setMemberProfile: (actor, workspace, username, changes) => call("set_member_profile", { actor, workspace, username, ...changes }),
260 };
261}
262
263/**
264 * The slug a renamed workspace has now, for a `workspace.renamed` handler:
265 * asked of identity by the workspace's id, so that renames delivered twice
266 * or out of order converge. Falls back to the event's `to`.
267 */
268export async function currentWorkspaceSlug(
269 identity: ServiceBinding,
270 renamed: { workspaceId: string; to: string },
271): Promise<string> {
272 const names = await identityClient(identity).usernames([renamed.workspaceId]);
273 return names[renamed.workspaceId] ?? renamed.to;
274}
275
276/** The slugs whose rows move to `current`: the two a rename names, less `current`. */
277export function staleSlugs(renamed: { from: string; to: string }, current: string): string[] {
278 return [...new Set([renamed.from, renamed.to])].filter((slug) => slug !== current);
279}
280
281/**
282 * Where a transferred repository is now, as `namespace/name`, for a
283 * `repo.transferred` handler: asked of repos by id, so transfers delivered
284 * twice or out of order converge. Falls back to the event's destination.
285 */
286export async function currentRepoPath(
287 repos: ServiceBinding,
288 transferred: { repoId: string; name: string; to: string },
289): Promise<string> {
290 const path = await rpc<{ namespace: string; name: string } | null>(repos, "path_by_id", { id: transferred.repoId });
291 return path ? `${path.namespace}/${path.name}` : `${transferred.to}/${transferred.name}`;
292}
293
294/** The paths whose rows move to `current`: the two a transfer names, less `current`. */
295export function stalePaths(transferred: { name: string; from: string; to: string }, current: string): string[] {
296 return [...new Set([transferred.from, transferred.to].map((ns) => `${ns}/${transferred.name}`))].filter(
297 (path) => path !== current,
298 );
299}
300
301/**
302 * A repository's path change, from `repo.transferred` or `repo.renamed`,
303 * read the same way: the two paths (`namespace/name`) the event names, old
304 * then new. Null for any other event.
305 */
306export type RepoMove = { repoId: string; paths: [string, string] };
307
308export function repoMove(event: { type: string; data: unknown }): RepoMove | null {
309 const data = event.data as Record<string, string>;
310 if (event.type === "repo.transferred") {
311 return { repoId: data.repoId!, paths: [`${data.from}/${data.name}`, `${data.to}/${data.name}`] };
312 }
313 if (event.type === "repo.renamed") {
314 return { repoId: data.repoId!, paths: [`${data.namespace}/${data.from}`, `${data.namespace}/${data.to}`] };
315 }
316 return null;
317}
318
319/**
320 * Where a moved repository is now, as `namespace/name`: asked of repos by
321 * id, so moves delivered twice or out of order converge. Falls back to the
322 * event's new path.
323 */
324export async function currentMovedPath(repos: ServiceBinding, move: RepoMove): Promise<string> {
325 const path = await rpc<{ namespace: string; name: string } | null>(repos, "path_by_id", { id: move.repoId });
326 return path ? `${path.namespace}/${path.name}` : move.paths[1];
327}
328
329/** The paths whose rows move to `current`: the two a move names, less `current`. */
330export function staleMovedPaths(move: RepoMove, current: string): string[] {
331 return [...new Set(move.paths)].filter((path) => path !== current);
332}
333
334/** Staff-only identity. Only sudo binds to it; see `IdentityAdminApi`. */
335export function identityAdminClient(service: ServiceBinding): IdentityAdminApi {
336 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
337 return {
338 growth: () => call("admin_growth", {}),
339 workspaces: (query) => call("admin_workspaces", { query: query ?? null }),
340 workspace: (slug) => call("admin_workspace", { slug }),
341 invites: (query, options = {}) => call("admin_invites", { query: query ?? null, to_g1t: options.toG1t ?? false }),
342 grantInvites: (username, amount, note, staff) => call("admin_grant_invites", { username, amount, note, staff }),
343 revokeInvite: (id, staff) => call("admin_revoke_invite", { id, staff }),
344 suspendUser: (name, suspend, reason, staff) => call("admin_suspend_user", { name, suspend, reason, staff }),
345 suspendWorkspace: (name, suspend, reason, staff) => call("admin_suspend_workspace", { name, suspend, reason, staff }),
346 blockedDomains: () => call("admin_blocked_domains", {}),
347 blockDomain: (domain, block, reason, staff) => call("admin_block_domain", { domain, block, reason, staff }),
348 deletedWorkspaces: () => call("admin_deleted_workspaces", {}),
349 restoreWorkspace: (workspaceId, staff) => call("admin_restore_workspace", { workspaceId, staff }),
350 purgeWorkspace: (workspaceId, staff, confirm) => call("admin_purge_workspace", { workspaceId, staff, confirm }),
351 aliases: () => call("admin_aliases", {}),
352 setAlias: (alias, workspace, note, staff) => call("admin_set_alias", { alias, workspace, note, staff }),
353 removeAlias: (alias, reason, staff) => call("admin_remove_alias", { alias, reason, staff }),
354 };
355}
356
357export function reposClient(service: ServiceBinding): ReposApi {
358 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
359 return {
360 get: (path, viewer) => call("get", { path, viewer }),
361 getById: (id, viewer) => call("get_by_id", { id, viewer }),
362 readable: (ids, viewer) => call("readable", { ids, viewer }),
363 publicNamespaces: (ownerId) => call("public_namespaces", { ownerId }),
364 list: (viewer, options = {}) => call("list", { viewer, ...options }),
365 create: (owner, input) => call("create", { owner, ...input }),
366 update: (actor, path, changes) => call("update", { actor, path, ...changes }),
367 transfer: (actor, path, to) => call("transfer", { actor, path, to }),
368 delete: (actor, path, confirm) => call("delete", { actor, path, confirm }),
369 deleted: (viewer, namespace) => call("deleted", { viewer, namespace }),
370 restore: (actor, path) => call("restore", { actor, path }),
371 purge: (actor, path, confirm) => call("purge", { actor, path, confirm }),
372 rename: (actor, path, name) => call("rename", { actor, path, name }),
373 archive: (actor, path, archived) => call("archive", { actor, path, archived }),
374 setVisibility: (actor, path, isPrivate, confirm) => call("set_visibility", { actor, path, isPrivate, confirm }),
375 setDefaultBranch: (actor, path, branch) => call("set_default_branch", { actor, path, branch }),
376 renameBranch: (actor, path, from, to) => call("rename_branch", { actor, path, from, to }),
377 createBranch: (actor, path, name, from = "") => call("create_branch", { actor, path, name, from }),
378 removeBranch: (actor, path, branch, head) => call("remove_branch", { actor, path, branch, head }),
379 resolveBranch: (repoId, branch) => call("resolve_branch", { repoId, branch }),
380 statusById: (id) => call("status_by_id", { id }),
381 storageOptions: () => call("storage_options", {}),
382 resolvePath: (path) => call("resolve_path", { path }),
383 tree: (path, viewer, ref, treePath) =>
384 call("tree", { path, viewer, ref, treePath }),
385 blob: (path, viewer, ref, filePath) =>
386 call("blob", { path, viewer, ref, filePath }),
387 log: (path, viewer, ref, limit) => call("log", { path, viewer, ref, limit }),
388 blame: (path, viewer, ref, filePath) => call("blame", { path, viewer, ref, filePath }),
389 forkForPull: (sourceId, pullId, actor) =>
390 call("fork_for_pull", { sourceId, pullId, actor }),
391 fork: (actor, path, input) => call("fork", { actor, path, ...input }),
392 forks: (path, viewer, limit) => call("forks", { path, viewer, limit: limit ?? null }),
393 syncFork: (actor, path, branch) => call("sync_fork", { actor, path, branch: branch ?? null }),
394 detachFork: (actor, path) => call("detach_fork", { actor, path }),
395 gitAccess: (path, viewer, service) =>
396 call("git_access", { path, viewer, service }),
397 branches: (path, viewer) => call("branches", { path, viewer }),
398 pathById: (id) => call("path_by_id", { id }),
399 lastCommits: (path, viewer, ref, treePath) => call("last_commits", { path, viewer, ref, treePath }),
400 branchDrift: (path, viewer, base, heads) => call("branch_drift", { path, viewer, base, heads }),
401 tags: (path, viewer) => call("tags", { path, viewer }),
402 about: (path, viewer) => call("about", { path, viewer }),
403 languages: (path, viewer) => call("languages", { path, viewer }),
404 contributors: (path, viewer) => call("contributors", { path, viewer }),
405 license: (path, viewer) => call("license", { path, viewer }),
406 stars: (path, viewer) => call("stars", { path, viewer }),
407 star: (actor, path, starred) => call("star", { path, actor, starred }),
408 stargazers: (path, viewer, page) => call("stargazers", { path, viewer, page: page ?? null }),
409 starred: (username, viewer) => call("starred", { username, viewer }),
410 releases: (path, viewer) => call("releases", { path, viewer }),
411 release: (path, viewer, which) => call("release", { path, viewer, id: which.id ?? null, tag: which.tag ?? null, latest: which.latest ?? false }),
412 createRelease: (actor, path, release) => call("create_release", { path, actor, ...release }),
413 updateRelease: (actor, path, id, change) => call("update_release", { path, actor, id, ...change }),
414 deleteRelease: (actor, path, id) => call("delete_release", { path, actor, id }),
415 listFiles: (repoId, ref, limit, options) => call("list_files", { repoId, ref, skipDirs: [], limit, links: options?.links ?? false }),
416 openArchiveToken: (path, token) => call("open_archive_token", { path, token }),
417 rawBlobs: (repoId, hashes, maxBytes) => call("raw_blobs", { repoId, hashes, maxBytes }),
418 rawFile: (repoId, ref, path, maxBytes) => call("raw_file", { repoId, ref, path, maxBytes }),
419 commitFile: (repo, actor, file) => call("commit_file", { repo, actor, ...file }),
420 land: (sourceId, actor, branch) => call("land", { sourceId, actor, branch }),
421 compare: (repoId, viewer, base, head, baseBranch, paths, targetId) =>
422 call("compare", { repoId, viewer, base, head, baseBranch, paths: paths ?? null, ...(targetId ? { targetId } : {}) }),
423 claimBackups: (limit, maxRunning) => call("claim_backups", { limit, maxRunning }),
424 // The sandbox's own calls are snake_case (they come through the API).
425 failBackup: (jobId, token, error) => call("backup_fail", { job_id: jobId, token, error }),
426 };
427}
428
429/**
430 * `PullDetail`'s own fields that the work service writes in snake_case:
431 * `g1t_contracts::work::PullDetail` has no camelCase renaming, though what
432 * it holds (`Pull`, `CheckRun` and the rest) does. Each with its name here.
433 */
434const PULL_DETAIL_FIELDS = [
435 ["earlier_checks", "earlierChecks"],
436 ["required_checks", "requiredChecks"],
437 ["code_owners", "codeOwners"],
438] as const;
439
440/**
441 * A pull request's detail as the work service sent it, with its own fields
442 * in the camelCase this package uses: read at the edge, by `workClient`'s
443 * `getPull`. Either spelling is taken, so a service that already sends
444 * camelCase reads the same.
445 */
446export function pullDetailFromWire(raw: Record<string, unknown>): PullDetail {
447 const detail: Record<string, unknown> = { ...raw };
448 for (const [snake, camel] of PULL_DETAIL_FIELDS) {
449 if (snake in detail) {
450 if (!(camel in detail)) detail[camel] = detail[snake];
451 delete detail[snake];
452 }
453 }
454 return detail as PullDetail;
455}
456
457export function workClient(service: ServiceBinding): WorkApi {
458 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
459 return {
460 openIssue: (actor, repo, input) => call("open_issue", { actor, repo, ...input }),
461 listIssues: (repo, viewer, filter = {}) => call("list_issues", { repo, viewer, ...filter }),
462 getIssue: (repo, number, viewer) => call("get_issue", { repo, number, viewer }),
463 closedByCommit: (repo, commit, viewer) => call("closed_by_commit", { repo, commit, viewer }),
464 updateIssue: (actor, repo, number, input) =>
465 call("update_issue", { actor, repo, number, ...input }),
466 closeIssue: (actor, repo, number, reason) =>
467 call("close_issue", { actor, repo, number, reason }),
468 reopenIssue: (actor, repo, number) => call("reopen_issue", { actor, repo, number }),
469 listLabels: (repo, viewer) => call("list_labels", { repo, viewer }),
470 saveLabel: (actor, repo, label) => call("save_label", { actor, repo, ...label }),
471 deleteLabel: (actor, repo, name) => call("delete_label", { actor, repo, name }),
472 addDefaultLabels: (actor, repo) => call("add_default_labels", { actor, repo }),
473 setLabels: (actor, repo, number, labels, change = "set") =>
474 call("set_labels", { actor, repo, number, labels, change }),
475 listMilestones: (repo, viewer, state) => call("list_milestones", { repo, viewer, state }),
476 getMilestone: (repo, number, viewer) => call("get_milestone", { repo, number, viewer }),
477 saveMilestone: (actor, repo, milestone) => call("save_milestone", { actor, repo, ...milestone }),
478 deleteMilestone: (actor, repo, number) => call("delete_milestone", { actor, repo, number }),
479 counts: (repo, viewer) => call("counts", { repo, viewer }),
480 addComment: (actor, repo, number, comment) =>
481 call("add_comment", { actor, repo, number, ...comment }),
482 editComment: (actor, repo, commentId, body) => call("edit_comment", { actor, repo, commentId, body }),
483 deleteComment: (actor, repo, commentId) => call("delete_comment", { actor, repo, commentId }),
484 react: (actor, repo, number, reaction) => call("react", { actor, repo, number, ...reaction }),
485 reportChecks: (runId, token, report) =>
486 call("report_checks", { runId, token, ...report }),
487 startMergecheck: (pullId) => call("start_mergecheck", { pullId }),
488 failMergecheck: (pullId, token, error) => call("report_mergecheck", { pullId, token, error }),
489 advance: (pullId) => call("advance", { pullId }),
490 managedPulls: (repoId) => call("managed_pulls", { repoId }),
491 queue: (repo, viewer) => call("queue", { repo, viewer }),
492 queueBuild: (repoId) => call("queue_build", { repoId }),
493 failQueue: (entryId, token, error) => call("report_queue", { entryId, token, error }),
494 removeFromQueue: (actor, repo, number) => call("remove_from_queue", { actor, repo, number }),
495 getSettings: (repo, viewer) => call("get_settings", { repo, viewer }),
496 // Rulesets travel in snake_case (rules.ts).
497 listRulesets: (owner, viewer, includeParents = false) =>
498 call("list_rulesets", { viewer, ...owner, include_parents: includeParents }),
499 getRuleset: (owner, id, viewer) => call("get_ruleset", { viewer, ...owner, id }),
500 saveRuleset: (actor, owner, ruleset, id) => call("save_ruleset", { actor, ...owner, id: id ?? null, ruleset }),
501 deleteRuleset: (actor, owner, id) => call("delete_ruleset", { actor, ...owner, id }),
502 effectiveRules: (repo, name, viewer, target = "branch") => call("effective_rules", { viewer, repo, name, target }),
503 ruleEvaluations: (owner, viewer, filter = {}) => call("rule_evaluations", { viewer, ...owner, ...filter }),
504 seenChecks: (repo, viewer) => call("seen_checks", { repo, viewer }),
505 commitChecks: (repo, viewer, shas) => call("commit_checks", { repo, viewer, shas }),
506 getCheckRun: (repo, id, viewer) => call("get_check_run", { repo, id, viewer }),
507 checkRunAnnotations: (repo, id, viewer) => call("check_run_annotations", { repo, id, viewer }),
508 requestCheckAction: (actor, repo, id, identifier) => call("request_check_action", { actor, repo, id, identifier }),
509 rerequestCheckRun: (actor, repo, id) => call("rerequest_check_run", { actor, repo, id }),
510 codeownersErrors: (repo, viewer, ref) => call("codeowners_errors", { repo, viewer, ref: ref ?? null }),
511 updateSettings: (actor, repo, settings) =>
512 call("update_settings", { actor, repo, settings }),
513 openPull: (actor, repo, input) => call("open_pull", { actor, repo, ...input }),
514 listPulls: (repo, viewer, state, filter = {}) => call("list_pulls", { repo, viewer, state, ...filter }),
515 deliveryInsights: (repoIds, viewer, from, until) => call("delivery_insights", { repoIds, viewer, from, until }),
516 pullsForRepos: (repoIds, viewer, limit) => call("pulls_for_repos", { repoIds, viewer, limit }),
517 // Its own fields arrive in snake_case: read into camelCase here.
518 getPull: (repo, number, viewer) =>
519 call<Result<Record<string, unknown>>>("get_pull", { repo, number, viewer }).then(
520 (found): Result<PullDetail> => (found.ok ? { ok: true, value: pullDetailFromWire(found.value) } : found),
521 ),
522 updatePull: (actor, repo, number, changes) =>
523 call("update_pull", { actor, repo, number, ...changes }),
524 catchUpPull: (actor, repo, number, options = {}) => call("catch_up_pull", { actor, repo, number, ...options }),
525 setAutoMerge: (actor, repo, number, enabled, options = {}) =>
526 call("set_auto_merge", { actor, repo, number, enabled, ...options }),
527 mergeChoices: (viewer, repo, number) => call("merge_choices", { viewer, repo, number }),
528 deleteHeadBranch: (actor, repo, number) => call("delete_head_branch", { actor, repo, number }),
529 restoreHeadBranch: (actor, repo, number) => call("restore_head_branch", { actor, repo, number }),
530 commitComments: (viewer, repo, commit, page) =>
531 call("commit_comments", { viewer, repo, commit: commit ?? null, page: page ?? null }),
532 addCommitComment: (actor, repo, commit, body, at) =>
533 call("add_commit_comment", { actor, repo, commit, body, path: at?.path ?? null, line: at?.line ?? null }),
534 editCommitComment: (actor, repo, id, body) => call("edit_commit_comment", { actor, repo, id, body }),
535 deleteCommitComment: (actor, repo, id) => call("delete_commit_comment", { actor, repo, id }),
536 readyPull: (actor, repo, number, summary) =>
537 call("ready_pull", { actor, repo, number, summary }),
538 closePull: (actor, repo, number) => call("close_pull", { actor, repo, number }),
539 reopenPull: (actor, repo, number) => call("reopen_pull", { actor, repo, number }),
540 convertPullToDraft: (actor, repo, number) => call("convert_pull_to_draft", { actor, repo, number }),
541 mergePull: (actor, repo, number, options = {}) =>
542 call("merge_pull", { actor, repo, number, ...options }),
543 listActivePulls: (viewer) => call("list_active_pulls", { viewer }),
544 byAuthor: (username, viewer, filter = {}) => call("by_author", { username, viewer, ...filter }),
545 contributions: (username, viewer) => call("contributions", { username, viewer }),
546 appendSession: (actor, repo, number, entries) =>
547 call("append_session", { actor, repo, number, entries }),
548 readSession: (repo, number, viewer, afterSeq = 0) =>
549 call("read_session", { repo, number, viewer, afterSeq }),
550 // Coordination: harness sessions, claims, an issue's whole context and
551 // decision records. Their arguments are snake_case, as the Rust service
552 // reads them; what comes back is camelCase.
553 getWork: (repo, number, viewer) => call("get_work", { repo, number, viewer }),
554 listClaims: (repo, viewer, filter = {}) =>
555 call("list_claims", { repo, viewer, state: filter.state ?? null, issue: filter.issue ?? null }),
556 listWorkSessions: (repo, viewer, filter = {}) =>
557 call("list_work_sessions", {
558 repo,
559 viewer,
560 state: filter.state ?? null,
561 issue: filter.issue ?? null,
562 pull: filter.pull ?? null,
563 path: filter.path ?? null,
564 subagents: filter.subagents ?? false,
565 }),
566 getWorkSession: (repo, id, viewer, afterSeq = 0) =>
567 call("get_work_session", { repo, id, viewer, after_seq: afterSeq }),
568 pullSessions: (repo, viewer, numbers) => call("pull_sessions", { repo, viewer, numbers }),
569 listDecisions: (repo, number, viewer) => call("list_decisions", { repo, number, viewer }),
570 };
571}
572
573export function billingClient(service: ServiceBinding): BillingApi {
574 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
575 return {
576 status: () => call("status", {}),
577 account: (workspace, viewer) => call("account", { workspace, viewer }),
578 ledger: (workspace, viewer) => call("ledger", { workspace, viewer }),
579 credits: (workspace, viewer) => call("credits", { workspace, viewer }),
580 statement: (workspace, viewer, month = null, group = "day") => call("statement", { workspace, viewer, month, group }),
581 statementEntries: (workspace, viewer, filter) =>
582 call("statement_entries", {
583 workspace,
584 viewer,
585 month: filter.month,
586 kind: filter.kind,
587 day: filter.day ?? null,
588 project: filter.project ?? null,
589 before: filter.before ?? null,
590 }),
591 usage: (workspace, viewer, since) => call("usage", { workspace, viewer, since }),
592 checkout: (actor, workspace, amountCents, returnUrl, method = "card") =>
593 call("checkout", { actor, workspace, amountCents, returnUrl, method }),
594 confirm: (workspace, viewer, session) => call("confirm", { workspace, viewer, session }),
595 trial: (workspace, exempt) => call("trial", { workspace, exempt }),
596 features: (workspace, viewer) => call("features", { workspace, viewer }),
597 subscribe: (actor, workspace, feature, returnUrl) =>
598 call("subscribe", { actor, workspace, feature, returnUrl }),
599 confirmSubscription: (workspace, viewer, session) =>
600 call("confirm_subscription", { workspace, viewer, session }),
601 cancelSubscription: (actor, workspace, feature, resume = false) =>
602 call("cancel_subscription", { actor, workspace, feature, resume }),
603 convertToPaid: (actor, workspace, returnUrl) => call("convert_to_paid", { actor, workspace, returnUrl }),
604 hasFeature: (workspace, feature) => call("has_feature", { workspace, feature }),
605 freeWorkspaces: (workspaces) => call("free_workspaces", { workspaces }),
606 chargeFeature: (charge) => call("charge_feature", charge),
607 billingPortal: (actor, workspace, returnUrl) => call("billing_portal", { actor, workspace, return_url: returnUrl }),
608 recordSandbox: (usage) => call("record_sandbox", usage),
609 limit: (workspace, viewer) => call("limit", { workspace, viewer }),
610 checkLimit: (workspace) => call("check_limit", { workspace }),
611 prices: () => call("prices", {}),
612 notePending: (workspace, source, costMicros, detail = null, month = null) =>
613 call("note_pending", { workspace, source, costMicros, detail, ...(month ? { month } : {}) }),
614 usageMeters: (workspace, viewer) => call("usage_meters", { workspace, viewer }),
615 setSpendLimit: (actor, workspace, spendLimitMicros, useFullLimit = false, raiseOnce = false) =>
616 call("set_spend_limit", { actor, workspace, spendLimitMicros, use_full_limit: useFullLimit, raise_once: raiseOnce }),
617 invoices: (workspace, viewer) => call("invoices", { workspace, viewer }),
618 entitlements: (workspace) => call("entitlements", { workspace }),
619 reserve: (reservation) => call("reserve", reservation),
620 settle: (reservationId, actualMicros) => call("settle", { reservationId, actualMicros }),
621 cardCheck: (actor, workspace, returnUrl) => call("card_check", { actor, workspace, returnUrl }),
622 confirmCardCheck: (workspace, viewer, session) => call("confirm_card_check", { workspace, viewer, session }),
623 requestLimit: (actor, workspace, request) => call("request_limit", { actor, workspace, ...request }),
624 limitRequests: (workspace, viewer) => call("limit_requests", { workspace, viewer }),
625 confirmSpike: (actor, workspace, keepGoing) => call("confirm_spike", { actor, workspace, keepGoing }),
626 usageReport: (workspace, viewer, range) =>
627 call("usage_report", { workspace, viewer, from: range.from, until: range.until, products: range.products ?? [], projects: range.projects ?? [] }),
628 setBudget: (actor, workspace, budget) => call("set_budget", { actor, workspace, ...budget }),
629 billingDetails: (workspace, viewer) => call("billing_details", { workspace, viewer }),
630 setBillingDetails: (actor, workspace, details) => call("set_billing_details", { actor, workspace, ...details }),
631 };
632}
633
634export function billingAdminClient(service: ServiceBinding): BillingAdminApi {
635 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
636 return {
637 accounts: (query) => call("admin_accounts", { query: query ?? null }),
638 account: (id) => call("admin_account", { id }),
639 setTerms: (id, terms, by) => call("admin_set_terms", { id, terms, by }),
640 setAllowances: (id, allowances, note, by) => call("admin_set_allowances", { id, allowances, note, by }),
641 complimentary: (workspace) => call("admin_complimentary", { workspace }),
642 setComplimentary: (workspace, terms, note, by) =>
643 call("admin_set_complimentary", {
644 workspace,
645 allowance_micros: terms.allowanceMicros,
646 unlimited: terms.unlimited,
647 fee_cents: terms.feeCents,
648 charge_past_allowance: terms.chargePastAllowance,
649 note,
650 by,
651 }),
652 endComplimentary: (workspace, note, by) => call("admin_end_complimentary", { workspace, note, by }),
653 createEnterprise: (name, workspaces, by) => call("admin_create_enterprise", { name, workspaces, by }),
654 attach: (workspace, account, by) => call("admin_attach", { workspace, account, by }),
655 credit: (workspace, amountMicros, note, by, options = { kind: "goodwill" }) =>
656 call("admin_credit", {
657 workspace,
658 amount_micros: amountMicros,
659 note,
660 by,
661 kind: options.kind,
662 expires_at: options.expiresAt ?? null,
663 refund_for: options.refundFor ?? null,
664 refund_day: options.refundDay ?? null,
665 }),
666 credits: (filter = {}) =>
667 call("admin_credits", {
668 workspace: filter.workspace ?? null,
669 kind: filter.kind ?? null,
670 month: filter.month ?? null,
671 by: filter.by ?? null,
672 }),
673 revokeCredit: (id, note, by) => call("admin_revoke_credit", { id, note, by }),
674 resetBilling: (workspace, confirm, note, by) => call("admin_reset_billing", { workspace, confirm, note, by }),
675 detachTestStripe: (a) =>
676 call("admin_detach_test_stripe", {
677 workspace: a.workspace ?? null,
678 exclude: a.exclude ?? null,
679 dry_run: a.dryRun,
680 cancel_at_stripe: a.cancelAtStripe ?? false,
681 confirm: a.confirm ?? "",
682 by: a.by,
683 }),
684 billingLink: (workspace, by) => call("admin_billing_link", { workspace, by }),
685 stripe: (fix = false, by) => call("admin_stripe", { fix, by: by ?? null }),
686 enterpriseBilling: (id, email, by) => call("admin_enterprise_billing", { id, email, by }),
687 enterpriseAddress: (id, address, taxIdType, taxId, by) => call("admin_enterprise_address", { id, address, taxIdType, taxId, by }),
688 invoiceEnterprise: (id, by) => call("admin_invoice_enterprise", { id, by }),
689 accountsFor: (workspaces) => call("admin_accounts", { query: null, workspaces }),
690 signals: () => call("admin_signals", {}),
691 overview: () => call("admin_overview", {}),
692 sales: (workspace) => call("admin_sales", { workspace }),
693 setSales: (workspace, record, by) =>
694 call("admin_set_sales", {
695 workspace,
696 stage: record.stage,
697 owner: record.owner ?? null,
698 next_step: record.nextStep ?? null,
699 next_at: record.nextAt ?? null,
700 by,
701 }),
702 addNote: (workspace, text, by) => call("admin_add_note", { workspace, text, by }),
703 workspaceInvoices: (workspace) => call("admin_workspace_invoices", { workspace }),
704 allInvoices: (filter = {}) => call("admin_invoices", { status: filter.status ?? null, month: filter.month ?? null }),
705 audit: (filter = {}) =>
706 call("admin_audit", { by: filter.by ?? null, action: filter.action ?? null, before: filter.before ?? null }),
707 limitRequests: (status = "open") => call("admin_limit_requests", { status }),
708 decideLimitRequest: (id, decision, amountMicros, note, by) =>
709 call("admin_decide_limit_request", { id, decision, amount_micros: amountMicros, note, by }),
710 overages: () => call("admin_overages", {}),
711 goodwill: (workspace, amountMicros, reason, by, day = null, requestKey = null) =>
712 call("admin_goodwill", { workspace, amount_micros: amountMicros, reason, by, day, request_key: requestKey }),
713 velocity: () => call("admin_velocity", {}),
714 recordPayment: (workspace, amountMicros, reference, note, by) =>
715 call("admin_record_payment", { workspace, amount_micros: amountMicros, reference, note, by }),
716 costs: (days) => call("admin_costs", { days: days ?? null }),
717 costAlerts: () => call("admin_cost_alerts", {}),
718 spendCaps: () => call("admin_spend_caps", {}),
719 liftBreaker: (note, by) => call("admin_lift_breaker", { note, by }),
720 platformGuard: () => call("admin_platform_guard", {}),
721 setPause: (level, paused, note, by) => call("admin_set_pause", { level, paused, note, by }),
722 decideProposal: (id, decision, note, by) => call("admin_decide_proposal", { id, decision, note, by }),
723 setCostSettings: (settings, by) => call("admin_set_cost_settings", { settings, by }),
724 setCostMapping: (mapping, by) =>
725 call("admin_set_cost_mapping", {
726 product: mapping.product,
727 meter: mapping.meter,
728 bucket: mapping.bucket ?? "",
729 price_meter: mapping.priceMeter ?? null,
730 own_meter: mapping.ownMeter ?? null,
731 scale_to_own: mapping.scaleToOwn ?? false,
732 drift_percent: mapping.driftPercent ?? null,
733 note: mapping.note ?? "",
734 remove: mapping.remove ?? false,
735 by,
736 }),
737 runCosts: (by) => call("admin_run_costs", { by }),
738 };
739}
740
741export function eventsClient(service: ServiceBinding): EventsApi {
742 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
743 return {
744 publish: (events) => call("publish", { events }),
745 list: (query) => call("list", query),
746 activityDigest: (args) => call("activity_digest", args),
747 };
748}
749
750export function integrationsClient(service: ServiceBinding): IntegrationsApi {
751 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
752 return {
753 list: (workspace, viewer) => call("list", { workspace, viewer }),
754 connect: (actor, workspace, input) => call("connect", { actor, workspace, ...input }),
755 update: (actor, workspace, id, input) => call("update", { actor, workspace, id, ...input }),
756 disconnect: (actor, workspace, id) => call("disconnect", { actor, workspace, id }),
757 test: (actor, workspace, id) => call("test", { actor, workspace, id }),
758 deliveries: (workspace, viewer, id) => call("deliveries", { workspace, viewer, id }),
759 resolve: (workspace, viewer, reference) => call("resolve", { workspace, viewer, reference }),
760 import: (actor, repo, reference) => call("import", { actor, repo, reference }),
761 links: (repo, number) => call("links", { repo, number }),
762 };
763}
764
765/**
766 * A workspace's AI providers and Ask g1t. Kept by the integrations service,
767 * so it is built on the same binding, with its own methods.
768 */
769export function aiClient(service: ServiceBinding): AiApi {
770 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
771 return {
772 list: (workspace, viewer) => call("ai_list", { workspace, viewer }),
773 add: (actor, workspace, input) => call("ai_add", { actor, workspace, ...input }),
774 update: (actor, workspace, id, input) => call("ai_update", { actor, workspace, id, ...input }),
775 remove: (actor, workspace, id) => call("ai_remove", { actor, workspace, id }),
776 test: (actor, workspace, id) => call("ai_test", { actor, workspace, id }),
777 askSettings: (workspace, viewer) => call("ask_settings", { workspace, viewer }),
778 setAskSettings: (actor, workspace, providerId, model) =>
779 call("set_ask_settings", { actor, workspace, provider_id: providerId, model }),
780 // Streamed: the response itself, not its parsed body.
781 ask: (actor, workspace, messages, page, signal) =>
782 service.fetch("https://service/rpc/ask", {
783 method: "POST",
784 headers: { "content-type": "application/json" },
785 body: JSON.stringify({ actor, workspace, messages, page }),
786 signal,
787 }),
788 };
789}
790
791export function webhooksClient(service: ServiceBinding): WebhooksApi {
792 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
793 return {
794 list: (viewer, owner) => call("list", { viewer, ...owner }),
795 create: (actor, owner, input) => call("create", { actor, ...owner, ...input }),
796 update: (actor, owner, id, input) => call("update", { actor, ...owner, id, ...input }),
797 delete: (actor, owner, id) => call("delete", { actor, ...owner, id }),
798 ping: (actor, owner, id) => call("ping", { actor, ...owner, id }),
799 deliveries: (viewer, owner, id) => call("deliveries", { viewer, ...owner, id }),
800 redeliver: (actor, owner, deliveryId) => call("redeliver", { actor, ...owner, deliveryId }),
801 };
802}
803
804export function actionsClient(service: ServiceBinding): ActionsApi {
805 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
806 return {
807 workflows: (repo, viewer) => call("workflows", { repo, viewer }),
808 runs: (repo, viewer, filter = {}) => call("runs", { repo, viewer, ...filter }),
809 run: (repo, viewer, id, attempt) => call("run", { repo, viewer, id, attempt: attempt ?? null }),
810 logs: (repo, viewer, job, after = 0) => call("logs", { repo, viewer, job, after }),
811 summaries: (repo, viewer, id, attempt) => call("summaries", { repo, viewer, id, attempt: attempt ?? null }),
812 jobLogText: (repo, viewer, job) => call("job_log_text", { repo, viewer, job }),
813 runLogs: (repo, viewer, id, attempt) => call("run_logs", { repo, viewer, id, attempt: attempt ?? null }),
814 dispatch: (actor, repo, workflow, ref, inputs) => call("dispatch", { actor, repo, workflow, ref, inputs }),
815 cancel: (actor, repo, id, force = false) => call("cancel", { actor, repo, id, force }),
816 rerun: (actor, repo, id, failedOnly = false, options = {}) =>
817 call("rerun", { actor, repo, id, failed_only: failedOnly, job: options.job ?? null, debug: options.debug ?? false }),
818 setWorkflowEnabled: (actor, repo, workflow, enabled) =>
819 call("set_workflow_enabled", { actor, repo, workflow, enabled }),
820 settings: (actor, owner, kind) => call("settings", { actor, ...owner, kind }),
821 setSetting: (actor, owner, kind, name, value, options = {}) =>
822 call("set_setting", { actor, ...owner, kind, name, value, ...options }),
823 deleteSetting: (actor, owner, kind, name, id) => call("delete_setting", { actor, ...owner, kind, name, id }),
824 approveRun: (actor, repo, id) => call("approve_run", { actor, repo, id }),
825 pendingDeployments: (repo, viewer, id) => call("pending_deployments", { repo, viewer, id }),
826 reviewDeployments: (actor, repo, id, state, environments = [], comment) =>
827 call("review_deployments", { actor, repo, id, state, environments, comment: comment ?? null }),
828 actionsSettings: (repo, viewer) => call("actions_settings", { repo, viewer }),
829 setActionsSettings: (actor, repo, change) => call("set_actions_settings", { actor, repo, ...change }),
830 workspaceActionsSettings: (workspace, viewer) => call("workspace_actions_settings", { workspace, viewer }),
831 setWorkspaceActionsSettings: (actor, workspace, change) =>
832 call("set_workspace_actions_settings", { actor, workspace, ...change }),
833 workspaceManagedWorkflows: (workspace, viewer) => call("workspace_managed_workflows", { workspace, viewer }),
834 setWorkspaceManagedWorkflow: (actor, workspace, name, change, create = false) =>
835 call("set_workspace_managed_workflow", { actor, workspace, name, create, ...change }),
836 removeWorkspaceManagedWorkflow: (actor, workspace, name) =>
837 call("remove_workspace_managed_workflow", { actor, workspace, name }),
838 environments: (repo, viewer) => call("environments", { repo, viewer }),
839 setEnvironment: (actor, repo, name, change) => call("set_environment", { actor, repo, name, ...change }),
840 deleteEnvironment: (actor, repo, name) => call("delete_environment", { actor, repo, name }),
841 artifacts: (repo, viewer, filter = {}) => call("artifacts", { repo, viewer, ...filter }),
842 artifactDownload: (repo, viewer, by) => call("artifact_download", { repo, viewer, ...by }),
843 deleteArtifact: (actor, repo, id) => call("delete_artifact", { actor, repo, id }),
844 artifactRetention: (repo, viewer, days) => call("artifact_retention", { repo, viewer, days }),
845 };
846}
847
848
849/** Staff-only self-hosted runners, on the actions service: only sudo calls it. */
850export function runnersAdminClient(service: ServiceBinding): RunnersAdminApi {
851 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
852 return {
853 list: (workspace) => call("admin_runners", { workspace }),
854 remove: (workspace, id, staff) => call("admin_remove_runners", { workspace, id, staff }),
855 };
856}
857
858/** Self-hosted runners, kept by the actions service. */
859export function runnersClient(service: ServiceBinding): RunnersApi {
860 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
861 return {
862 stuck: (viewer) => call("stuck_jobs", { viewer }),
863 activity: (actor, workspace) => call("runner_activity", { actor, workspace }),
864 list: (actor, owner) => call("runners", { actor, ...owner }),
865 createToken: (actor, owner, group) => call("create_registration_token", { actor, ...owner, group }),
866 remove: (actor, owner, id) => call("remove_runner", { actor, ...owner, id }),
867 groups: (actor, workspace) => call("runner_groups", { actor, workspace }),
868 setGroup: (actor, workspace, group) => call("set_runner_group", { actor, workspace, ...group }),
869 deleteGroup: (actor, workspace, id) => call("delete_runner_group", { actor, workspace, id }),
870 settings: (actor, owner) => call("runner_settings", { actor, ...owner }),
871 setSettings: (actor, owner, change) => call("set_runner_settings", { actor, ...owner, ...change }),
872 reportDesktop: (actor, report) => call("report_desktop", { actor, ...report }),
873 desktops: (actor, workspace) => call("desktop_runners", { actor, workspace }),
874 };
875}
876
877export function deploymentsClient(service: ServiceBinding): DeploymentsApi {
878 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
879 return {
880 settings: (project, viewer) => call("settings", { project, viewer }),
881 updateSettings: (actor, project, changes) => call("update_settings", { actor, project, changes }),
882 list: (project, viewer) => call("list", { project, viewer }),
883 get: (project, id, viewer) => call("get", { project, id, viewer }),
884 redeploy: (actor, project, branch) => call("redeploy", { actor, project, branch }),
885 takeDown: (actor, project, branch) => call("take_down", { actor, project, branch }),
886 overview: (workspace, viewer) => call("overview", { workspace, viewer }),
887 usage: (workspace, viewer) => call("usage", { workspace, viewer }),
888 domains: (project, viewer) => call("domains", { project, viewer }),
889 addDomain: (actor, project, hostname, options = {}) =>
890 call("add_domain", { actor, project, hostname, twin: !!options.twin }),
891 removeDomain: (actor, project, id) => call("remove_domain", { actor, project, id }),
892 refreshDomain: (actor, project, id) => call("refresh_domain", { actor, project, id }),
893 repoDeployments: (repo, viewer, filter = {}) => call("list_deployments", { repo, viewer, ...filter }),
894 repoDeployment: (repo, id, viewer) => call("get_deployment", { repo, id, viewer }),
895 environments: (repo, viewer) => call("list_environments", { repo, viewer }),
896 createDeployment: (actor, repo, input) => call("create_deployment", { repo, actor, ...input }),
897 createDeploymentStatus: (actor, repo, id, input) => call("create_deployment_status", { repo, actor, id, ...input }),
898 shipped: (workspace, viewer, repos) => call("shipped", { workspace, viewer, repos }),
899 };
900}
901
902/** Packages: the registries beside the code (services/packages). */
903export function packagesClient(service: ServiceBinding): PackagesApi {
904 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
905 return {
906 list: (workspace, viewer, filter = {}) =>
907 call("list_packages", {
908 workspace,
909 viewer,
910 ecosystem: filter.ecosystem ?? null,
911 repo_id: filter.repoId ?? null,
912 query: filter.query ?? null,
913 }),
914 get: (workspace, ecosystem, name, viewer) => call("get_package", { workspace, ecosystem, name, viewer }),
915 deleteVersion: (actor, workspace, ecosystem, name, version, surface) =>
916 call("delete_version", { actor, workspace, ecosystem, name, version, surface: surface ?? null }),
917 deletePackage: (actor, workspace, ecosystem, name, surface) =>
918 call("delete_package", { actor, workspace, ecosystem, name, surface: surface ?? null }),
919 set: (actor, workspace, ecosystem, name, change, surface) =>
920 call("set_package", {
921 actor,
922 workspace,
923 ecosystem,
924 name,
925 visibility: change.visibility ?? null,
926 link: change.link ?? null,
927 unlink: change.unlink ?? false,
928 inherit_access: change.inheritAccess ?? null,
929 surface: surface ?? null,
930 }),
931 settings: (workspace, ecosystem, name, viewer) => call("package_settings", { workspace, ecosystem, name, viewer }),
932 deleted: (workspace, viewer) => call("deleted_packages", { workspace, viewer }),
933 restorePackage: (actor, workspace, ecosystem, name, surface) =>
934 call("restore_package", { actor, workspace, ecosystem, name, surface: surface ?? null }),
935 restoreVersion: (actor, workspace, ecosystem, name, version, surface) =>
936 call("restore_version", { actor, workspace, ecosystem, name, version, surface: surface ?? null }),
937 setAccess: (actor, workspace, ecosystem, name, who, role, surface) =>
938 call("set_package_access", {
939 actor,
940 workspace,
941 ecosystem,
942 name,
943 user: "user" in who ? who.user : null,
944 team: "team" in who ? who.team : null,
945 role,
946 surface: surface ?? null,
947 }),
948 removeAccess: (actor, workspace, ecosystem, name, who, surface) =>
949 call("remove_package_access", {
950 actor,
951 workspace,
952 ecosystem,
953 name,
954 user: "user" in who ? who.user : null,
955 team: "team" in who ? who.team : null,
956 surface: surface ?? null,
957 }),
958 setActionsAccess: (actor, workspace, ecosystem, name, repo, role, surface) =>
959 call("set_actions_access", { actor, workspace, ecosystem, name, repo, role, surface: surface ?? null }),
960 removeActionsAccess: (actor, workspace, ecosystem, name, repo, surface) =>
961 call("remove_actions_access", { actor, workspace, ecosystem, name, repo, surface: surface ?? null }),
962 storage: (workspace) => call("storage", { workspace }),
963 storageAll: () => call("storage_all", {}),
964 syncComposer: (repoId) => call("sync_composer", { repo_id: repoId }),
965 };
966}
967
968export function projectsClient(service: ServiceBinding): ProjectsApi {
969 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
970 return {
971 list: (workspace, viewer) => call("list", { workspace, viewer }),
972 get: (workspace, slug, viewer) => call("get", { workspace, slug, viewer }),
973 byRepo: (repoId) => call("by_repo", { repoId }),
974 describe: (actor, repoId, description) => call("describe", { actor, repoId, description }),
975 descriptions: (repoIds) => (repoIds.length ? call("descriptions", { repoIds }) : Promise.resolve({})),
976 create: (actor, workspace, input) => call("create", { actor, workspace, input }),
977 update: (actor, workspace, slug, changes) => call("update", { actor, workspace, slug, changes }),
978 setProductionImage: (actor, workspace, slug, change) => call("set_production_image", { actor, workspace, slug, change }),
979 externalProductions: () => call("external_productions", {}),
980 deploymentsChanged: (projectId, enabled) => call("deployments_changed", { projectId, enabled }),
981 shortcuts: (workspace, viewer) => call("shortcuts", { workspace, viewer }),
982 pin: (actor, workspace, slug, position) => call("pin", { actor, workspace, slug, position: position ?? null }),
983 unpin: (actor, workspace, slug) => call("unpin", { actor, workspace, slug }),
984 reorderPins: (actor, workspace, slugs) => call("reorder_pins", { actor, workspace, slugs }),
985 visited: (actor, projectId) => call("visited", { actor, projectId }),
986 publicLinks: (repos) => call("public_links", { repos }),
987 };
988}