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