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