flagon-io/g1t

public

Where people and agents ship software together. The open-source git platform for the whole job: issues, agents, checks and deploys to the edge.

g1t/packages/contracts/src/clients.ts

399 lines23,074 bytesCodeBlame
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 { WebhooksApi } from "./webhooks";
9import type { ReposApi } from "./repos";
10import type { WorkApi } from "./work";
11
12/** A service binding, as far as these clients need it. */
13export type ServiceBinding = {
14 fetch(input: string, init?: RequestInit): Promise<Response>;
15};
16
17/**
18 * Calls a method on a service that speaks the JSON protocol used by the
19 * Rust services: `POST /rpc/<method>` with the arguments as the body.
20 */
21async function rpc<T>(
22 service: ServiceBinding,
23 method: string,
24 args: object,
25): Promise<T> {
26 // The hostname is ignored; a service binding always reaches its service.
27 const response = await service.fetch(`https://service/rpc/${method}`, {
28 method: "POST",
29 headers: { "content-type": "application/json" },
30 body: JSON.stringify(args),
31 });
32 if (!response.ok) {
33 throw new Error(`${method} failed with status ${response.status}`);
34 }
35 return (await response.json()) as T;
36}
37
38export function identityClient(service: ServiceBinding): IdentityApi {
39 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
40 return {
41 register: (username, email, password) =>
42 call("register", { username, email, password }),
43 signIn: (username, password) => call("sign_in", { username, password }),
44 signOut: (sessionToken) => call("sign_out", { sessionToken }),
45 resendVerification: (user) => call("resend_verification", { user }),
46 verifyEmail: (token) => call("verify_email", { token }),
47 requestPasswordReset: (email) => call("request_password_reset", { email }),
48 resetPassword: (token, password) =>
49 call("reset_password", { token, password }),
50 deviceStart: (clientName) => call("device_start", { clientName }),
51 deviceLookup: (userCode) => call("device_lookup", { userCode }),
52 deviceResolve: (userCode, user, approve) =>
53 call("device_resolve", { userCode, user, approve }),
54 deviceClaim: (deviceCode) => call("device_claim", { deviceCode }),
55 oauthAuthorize: (user, approval) => call("oauth_authorize", { user, ...approval }),
56 oauthExchange: (code, codeVerifier, clientId, redirectUri) =>
57 call("oauth_exchange", { code, codeVerifier, clientId, redirectUri }),
58 oauthRefresh: (refreshToken, clientId) =>
59 call("oauth_refresh", { refreshToken, clientId }),
60 listOAuthGrants: (user) => call("list_oauth_grants", { user }),
61 revokeOAuthGrant: (user, id) => call("revoke_oauth_grant", { user, id }),
62 createWorkspace: (user, slug, name) => call("create_workspace", { user, slug, name }),
63 getWorkspace: (slug) => call("get_workspace", { slug }),
64 listMembers: (slug, viewer) => call("list_members", { slug, viewer }),
65 addMember: (actor, slug, username) => call("add_member", { actor, slug, username }),
66 removeMember: (actor, slug, username) =>
67 call("remove_member", { actor, slug, username }),
68 updateWorkspace: (actor, slug, details) =>
69 call("update_workspace", { actor, slug, ...details }),
70 renameWorkspace: (actor, slug, newSlug) => call("rename_workspace", { actor, slug, newSlug }),
71 checkWorkspaceRename: (actor, slug, newSlug) =>
72 call("check_workspace_rename", { actor, slug, newSlug }),
73 resolveSlug: (slug) => call("resolve_slug", { slug }),
74 setWorkspaceAvatar: (actor, slug, image) => call("set_workspace_avatar", { actor, slug, image }),
75 setUserAvatar: (user, image) => call("set_user_avatar", { user, image }),
76 listWorkspaceTokens: (slug, viewer) => call("list_workspace_tokens", { slug, viewer }),
77 createWorkspaceToken: (actor, slug, name) =>
78 call("create_workspace_token", { actor, slug, name }),
79 removeWorkspaceToken: (actor, slug, id) =>
80 call("remove_workspace_token", { actor, slug, id }),
81 userForSession: (sessionToken) => call("user_for_session", { sessionToken }),
82 userForGitCredentials: (username, secret) =>
83 call("user_for_git_credentials", { username, secret }),
84 userForAccessToken: (token) => call("user_for_access_token", { token }),
85 userForSshKey: (fingerprint) => call("user_for_ssh_key", { fingerprint }),
86 userByUsername: (username) => call("user_by_username", { username }),
87 usernames: (ids) => call("usernames", { ids }),
88 profile: (username) => call("profile", { username }),
89 updateProfile: (actor, fields) => call("update_profile", { actor, ...fields }),
90 profileWorkspaces: (username, viewer, publicIn) =>
91 call("profile_workspaces", { username, viewer, public: publicIn }),
92 listSshKeys: (user) => call("list_ssh_keys", { user }),
93 addSshKey: (user, title, publicKey) =>
94 call("add_ssh_key", { user, title, publicKey }),
95 removeSshKey: (user, id) => call("remove_ssh_key", { user, id }),
96 listAccessTokens: (user) => call("list_access_tokens", { user }),
97 createAccessToken: (user, name, ttlSeconds) =>
98 call("create_access_token", { user, name, ttlSeconds }),
99 createAgentToken: (onBehalfOf, scope, ttlSeconds) =>
100 call("create_agent_token", { onBehalfOf, scope, ttlSeconds }),
101 removeAccessToken: (user, id) => call("remove_access_token", { user, id }),
102 createRunCredential: (input) => call("create_run_credential", input),
103 bindRunCredentials: (tokenHashes, runId) => call("bind_run_credentials", { tokenHashes, runId }),
104 revokeRunCredentials: (target) => call("revoke_run_credentials", target),
105 };
106}
107
108/**
109 * The slug a renamed workspace has now, for a `workspace.renamed` handler:
110 * asked of identity by the workspace's id, so that renames delivered twice
111 * or out of order converge. Falls back to the event's `to`.
112 */
113export async function currentWorkspaceSlug(
114 identity: ServiceBinding,
115 renamed: { workspaceId: string; to: string },
116): Promise<string> {
117 const names = await identityClient(identity).usernames([renamed.workspaceId]);
118 return names[renamed.workspaceId] ?? renamed.to;
119}
120
121/** The slugs whose rows move to `current`: the two a rename names, less `current`. */
122export function staleSlugs(renamed: { from: string; to: string }, current: string): string[] {
123 return [...new Set([renamed.from, renamed.to])].filter((slug) => slug !== current);
124}
125
126/** Staff-only identity. Only sudo binds to it; see `IdentityAdminApi`. */
127export function identityAdminClient(service: ServiceBinding): IdentityAdminApi {
128 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
129 return {
130 workspaces: (query) => call("admin_workspaces", { query: query ?? null }),
131 workspace: (slug) => call("admin_workspace", { slug }),
132 };
133}
134
135export function reposClient(service: ServiceBinding): ReposApi {
136 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
137 return {
138 get: (path, viewer) => call("get", { path, viewer }),
139 getById: (id, viewer) => call("get_by_id", { id, viewer }),
140 publicNamespaces: (ownerId) => call("public_namespaces", { ownerId }),
141 list: (viewer, options = {}) => call("list", { viewer, ...options }),
142 create: (owner, input) => call("create", { owner, ...input }),
143 update: (actor, path, changes) => call("update", { actor, path, ...changes }),
144 tree: (path, viewer, ref, treePath) =>
145 call("tree", { path, viewer, ref, treePath }),
146 blob: (path, viewer, ref, filePath) =>
147 call("blob", { path, viewer, ref, filePath }),
148 log: (path, viewer, ref, limit) => call("log", { path, viewer, ref, limit }),
149 blame: (path, viewer, ref, filePath) => call("blame", { path, viewer, ref, filePath }),
150 forkForPull: (sourceId, pullId, actor) =>
151 call("fork_for_pull", { sourceId, pullId, actor }),
152 gitAccess: (path, viewer, service) =>
153 call("git_access", { path, viewer, service }),
154 branches: (path, viewer) => call("branches", { path, viewer }),
155 land: (sourceId, actor, branch) => call("land", { sourceId, actor, branch }),
156 compare: (repoId, viewer, base, head) => call("compare", { repoId, viewer, base, head }),
157 };
158}
159
160export function workClient(service: ServiceBinding): WorkApi {
161 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
162 return {
163 openIssue: (actor, repo, input) => call("open_issue", { actor, repo, ...input }),
164 listIssues: (repo, viewer, filter = {}) => call("list_issues", { repo, viewer, ...filter }),
165 getIssue: (repo, number, viewer) => call("get_issue", { repo, number, viewer }),
166 updateIssue: (actor, repo, number, input) =>
167 call("update_issue", { actor, repo, number, ...input }),
168 closeIssue: (actor, repo, number, reason) =>
169 call("close_issue", { actor, repo, number, reason }),
170 reopenIssue: (actor, repo, number) => call("reopen_issue", { actor, repo, number }),
171 listLabels: (repo, viewer) => call("list_labels", { repo, viewer }),
172 counts: (repo, viewer) => call("counts", { repo, viewer }),
173 addComment: (actor, repo, number, comment) =>
174 call("add_comment", { actor, repo, number, ...comment }),
175 startChecks: (pullId) => call("start_checks", { pullId }),
176 reportChecks: (runId, token, report) =>
177 call("report_checks", { runId, token, ...report }),
178 startReview: (pullId) => call("start_review", { pullId }),
179 failReview: (runId, token, error) => call("report_review", { runId, token, error }),
180 startMergecheck: (pullId) => call("start_mergecheck", { pullId }),
181 failMergecheck: (pullId, token, error) => call("report_mergecheck", { pullId, token, error }),
182 advance: (pullId) => call("advance", { pullId }),
183 stall: (pullId, reason) => call("stall", { pullId, reason }),
184 managedPulls: (repoId) => call("managed_pulls", { repoId }),
185 queue: (repo, viewer) => call("queue", { repo, viewer }),
186 queueBuild: (repoId) => call("queue_build", { repoId }),
187 failQueue: (entryId, token, error) => call("report_queue", { entryId, token, error }),
188 removeFromQueue: (actor, repo, number) => call("remove_from_queue", { actor, repo, number }),
189 messageAgent: (actor, repo, number, body) => call("message_agent", { actor, repo, number, body }),
190 catchUpJob: (pullId) => call("catch_up_job", { pullId }),
191 wakeForMessages: (pullId) => call("wake_for_messages", { pullId }),
192 getSettings: (repo, viewer) => call("get_settings", { repo, viewer }),
193 updateSettings: (actor, repo, settings) =>
194 call("update_settings", { actor, repo, settings }),
195 openPull: (actor, repo, input) => call("open_pull", { actor, repo, ...input }),
196 listPulls: (repo, viewer, state) => call("list_pulls", { repo, viewer, state }),
197 getPull: (repo, number, viewer) => call("get_pull", { repo, number, viewer }),
198 updatePull: (actor, repo, number, changes) =>
199 call("update_pull", { actor, repo, number, ...changes }),
200 catchUpPull: (actor, repo, number) => call("catch_up_pull", { actor, repo, number }),
201 readyPull: (actor, repo, number, summary) =>
202 call("ready_pull", { actor, repo, number, summary }),
203 closePull: (actor, repo, number) => call("close_pull", { actor, repo, number }),
204 mergePull: (actor, repo, number, options = {}) =>
205 call("merge_pull", { actor, repo, number, ...options }),
206 listActivePulls: (viewer) => call("list_active_pulls", { viewer }),
207 byAuthor: (username, viewer, filter = {}) => call("by_author", { username, viewer, ...filter }),
208 startPlan: (actor, repo, brief) => call("start_plan", { actor, repo, brief }),
209 failPlan: (planId, token, error) => call("report_plan", { planId, token, error }),
210 getPlan: (repo, viewer, id) => call("get_plan", { repo, viewer, id }),
211 listPlans: (repo, viewer) => call("list_plans", { repo, viewer }),
212 applyPlan: (actor, repo, id, options = {}) =>
213 call("apply_plan", { actor, repo, id, ...options }),
214 queueIssue: (actor, repo, number, queued) =>
215 call("queue_issue", { actor, repo, number, queued }),
216 readyIssues: (repoId) => call("ready_issues", { repoId }),
217 listAssignedIssues: (viewer) => call("list_assigned_issues", { viewer }),
218 appendSession: (actor, repo, number, entries) =>
219 call("append_session", { actor, repo, number, entries }),
220 readSession: (repo, number, viewer, afterSeq = 0) =>
221 call("read_session", { repo, number, viewer, afterSeq }),
222 };
223}
224
225export function billingClient(service: ServiceBinding): BillingApi {
226 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
227 return {
228 status: () => call("status", {}),
229 account: (workspace, viewer) => call("account", { workspace, viewer }),
230 ledger: (workspace, viewer) => call("ledger", { workspace, viewer }),
231 statement: (workspace, viewer, month = null, group = "day") => call("statement", { workspace, viewer, month, group }),
232 statementEntries: (workspace, viewer, filter) =>
233 call("statement_entries", {
234 workspace,
235 viewer,
236 month: filter.month,
237 kind: filter.kind,
238 day: filter.day ?? null,
239 project: filter.project ?? null,
240 before: filter.before ?? null,
241 }),
242 usage: (workspace, viewer, since) => call("usage", { workspace, viewer, since }),
243 checkout: (actor, workspace, amountCents, returnUrl) =>
244 call("checkout", { actor, workspace, amountCents, returnUrl }),
245 confirm: (workspace, viewer, session) => call("confirm", { workspace, viewer, session }),
246 canStart: (workspace) => call("can_start", { workspace }),
247 trial: (workspace, exempt) => call("trial", { workspace, exempt }),
248 startRun: (run) => call("start_run", run),
249 features: (workspace, viewer) => call("features", { workspace, viewer }),
250 subscribe: (actor, workspace, feature, returnUrl) =>
251 call("subscribe", { actor, workspace, feature, returnUrl }),
252 confirmSubscription: (workspace, viewer, session) =>
253 call("confirm_subscription", { workspace, viewer, session }),
254 cancelSubscription: (actor, workspace, feature, resume = false) =>
255 call("cancel_subscription", { actor, workspace, feature, resume }),
256 hasFeature: (workspace, feature) => call("has_feature", { workspace, feature }),
257 chargeFeature: (charge) => call("charge_feature", charge),
258 billingPortal: (actor, workspace, returnUrl) => call("billing_portal", { actor, workspace, return_url: returnUrl }),
259 recordSandbox: (usage) => call("record_sandbox", usage),
260 limit: (workspace, viewer) => call("limit", { workspace, viewer }),
261 checkLimit: (workspace) => call("check_limit", { workspace }),
262 prices: () => call("prices", {}),
263 notePending: (workspace, source, costMicros) => call("note_pending", { workspace, source, costMicros }),
264 setSpendLimit: (actor, workspace, spendLimitMicros, useFullLimit = false) =>
265 call("set_spend_limit", { actor, workspace, spendLimitMicros, use_full_limit: useFullLimit }),
266 invoices: (workspace, viewer) => call("invoices", { workspace, viewer }),
267 };
268}
269
270export function billingAdminClient(service: ServiceBinding): BillingAdminApi {
271 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
272 return {
273 accounts: (query) => call("admin_accounts", { query: query ?? null }),
274 account: (id) => call("admin_account", { id }),
275 setTerms: (id, terms, by) => call("admin_set_terms", { id, terms, by }),
276 createEnterprise: (name, workspaces, by) => call("admin_create_enterprise", { name, workspaces, by }),
277 attach: (workspace, account, by) => call("admin_attach", { workspace, account, by }),
278 credit: (workspace, amountMicros, note, by) => call("admin_credit", { workspace, amount_micros: amountMicros, note, by }),
279 billingLink: (workspace, by) => call("admin_billing_link", { workspace, by }),
280 stripe: (setup = false, by) => call("admin_stripe", { setup, by: by ?? null }),
281 enterpriseBilling: (id, email, by) => call("admin_enterprise_billing", { id, email, by }),
282 invoiceEnterprise: (id, by) => call("admin_invoice_enterprise", { id, by }),
283 accountsFor: (workspaces) => call("admin_accounts", { query: null, workspaces }),
284 signals: () => call("admin_signals", {}),
285 overview: () => call("admin_overview", {}),
286 sales: (workspace) => call("admin_sales", { workspace }),
287 setSales: (workspace, record, by) =>
288 call("admin_set_sales", {
289 workspace,
290 stage: record.stage,
291 owner: record.owner ?? null,
292 next_step: record.nextStep ?? null,
293 next_at: record.nextAt ?? null,
294 by,
295 }),
296 addNote: (workspace, text, by) => call("admin_add_note", { workspace, text, by }),
297 workspaceInvoices: (workspace) => call("admin_workspace_invoices", { workspace }),
298 allInvoices: (filter = {}) => call("admin_invoices", { status: filter.status ?? null, month: filter.month ?? null }),
299 audit: (filter = {}) =>
300 call("admin_audit", { by: filter.by ?? null, action: filter.action ?? null, before: filter.before ?? null }),
301 };
302}
303
304export function eventsClient(service: ServiceBinding): EventsApi {
305 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
306 return {
307 publish: (events) => call("publish", { events }),
308 list: (query) => call("list", query),
309 };
310}
311
312export function integrationsClient(service: ServiceBinding): IntegrationsApi {
313 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
314 return {
315 list: (workspace, viewer) => call("list", { workspace, viewer }),
316 connect: (actor, workspace, input) => call("connect", { actor, workspace, ...input }),
317 update: (actor, workspace, id, input) => call("update", { actor, workspace, id, ...input }),
318 disconnect: (actor, workspace, id) => call("disconnect", { actor, workspace, id }),
319 test: (actor, workspace, id) => call("test", { actor, workspace, id }),
320 deliveries: (workspace, viewer, id) => call("deliveries", { workspace, viewer, id }),
321 resolve: (workspace, viewer, reference) => call("resolve", { workspace, viewer, reference }),
322 references: (workspace, text, limit) => call("references", { workspace, text, limit }),
323 import: (actor, repo, reference, assign) => call("import", { actor, repo, reference, assign }),
324 links: (repo, number) => call("links", { repo, number }),
325 modelProvider: (workspace) => call("model_provider", { workspace }),
326 openModelSession: (run) => call("open_model_session", run),
327 modelUpstream: (token) => call("model_upstream", { token }),
328 routes: (workspace, viewer) => call("routes", { workspace, viewer }),
329 setRoutes: (actor, workspace, routes) => call("set_routes", { actor, workspace, routes }),
330 };
331}
332
333export function webhooksClient(service: ServiceBinding): WebhooksApi {
334 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
335 return {
336 list: (viewer, owner) => call("list", { viewer, ...owner }),
337 create: (actor, owner, input) => call("create", { actor, ...owner, ...input }),
338 update: (actor, owner, id, input) => call("update", { actor, ...owner, id, ...input }),
339 delete: (actor, owner, id) => call("delete", { actor, ...owner, id }),
340 ping: (actor, owner, id) => call("ping", { actor, ...owner, id }),
341 deliveries: (viewer, owner, id) => call("deliveries", { viewer, ...owner, id }),
342 redeliver: (actor, owner, deliveryId) => call("redeliver", { actor, ...owner, deliveryId }),
343 };
344}
345
346export function actionsClient(service: ServiceBinding): ActionsApi {
347 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
348 return {
349 workflows: (repo, viewer) => call("workflows", { repo, viewer }),
350 runs: (repo, viewer, filter = {}) => call("runs", { repo, viewer, ...filter }),
351 run: (repo, viewer, id) => call("run", { repo, viewer, id }),
352 logs: (repo, viewer, job, after = 0) => call("logs", { repo, viewer, job, after }),
353 dispatch: (actor, repo, workflow, ref, inputs) => call("dispatch", { actor, repo, workflow, ref, inputs }),
354 cancel: (actor, repo, id) => call("cancel", { actor, repo, id }),
355 rerun: (actor, repo, id, failedOnly = false) => call("rerun", { actor, repo, id, failed_only: failedOnly }),
356 setWorkflowEnabled: (actor, repo, workflow, enabled) =>
357 call("set_workflow_enabled", { actor, repo, workflow, enabled }),
358 settings: (actor, owner, kind) => call("settings", { actor, ...owner, kind }),
359 setSetting: (actor, owner, kind, name, value, options = {}) =>
360 call("set_setting", { actor, ...owner, kind, name, value, ...options }),
361 deleteSetting: (actor, owner, kind, name, id) => call("delete_setting", { actor, ...owner, kind, name, id }),
362 };
363}
364
365
366export function deploymentsClient(service: ServiceBinding): DeploymentsApi {
367 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
368 return {
369 settings: (project, viewer) => call("settings", { project, viewer }),
370 updateSettings: (actor, project, changes) => call("update_settings", { actor, project, changes }),
371 list: (project, viewer) => call("list", { project, viewer }),
372 get: (project, id, viewer) => call("get", { project, id, viewer }),
373 redeploy: (actor, project, branch) => call("redeploy", { actor, project, branch }),
374 takeDown: (actor, project, branch) => call("take_down", { actor, project, branch }),
375 stack: (actor, project, branch) => call("stack", { actor, project, branch }),
376 overview: (workspace, viewer) => call("overview", { workspace, viewer }),
377 usage: (workspace, viewer) => call("usage", { workspace, viewer }),
378 domains: (project, viewer) => call("domains", { project, viewer }),
379 addDomain: (actor, project, hostname, options = {}) =>
380 call("add_domain", { actor, project, hostname, twin: !!options.twin }),
381 removeDomain: (actor, project, id) => call("remove_domain", { actor, project, id }),
382 refreshDomain: (actor, project, id) => call("refresh_domain", { actor, project, id }),
383 };
384}
385
386export function projectsClient(service: ServiceBinding): ProjectsApi {
387 const call = <T>(method: string, args: object) => rpc<T>(service, method, args);
388 return {
389 list: (workspace, viewer) => call("list", { workspace, viewer }),
390 get: (workspace, slug, viewer) => call("get", { workspace, slug, viewer }),
391 byRepo: (repoId) => call("by_repo", { repoId }),
392 create: (actor, workspace, input) => call("create", { actor, workspace, input }),
393 update: (actor, workspace, slug, changes) => call("update", { actor, workspace, slug, changes }),
394 dependencies: (workspace, slug, viewer) => call("dependencies", { workspace, slug, viewer }),
395 addDependency: (actor, workspace, slug, on, as) => call("add_dependency", { actor, workspace, slug, on, as }),
396 removeDependency: (actor, workspace, slug, on) => call("remove_dependency", { actor, workspace, slug, on }),
397 graph: (projectId) => call("graph", { projectId }),
398 };
399}