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