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