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