Skip to content
Sign up

flagon-io/g1t

public
00

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.sh
gitagentscloudflarerustforgemcp
994 linesCodeBlameRaw
1import type { SoundSettings, SoundSettingsChange } from "./sounds";
2import type { AccessClient, BasePermission, RepoGrant } from "./access";
3import type { Permissions, ScopeLevel, ScopeResource } from "./scopes";
4import type { MemberPrivileges, OrgRole, PolicyHold } from "./members";
5import type { Acting, CreateRunCredentialInput, RunBinding } from "./audit";
6import type { RepoPath } from "./repos";
7import type { Result } from "./result";
8import type { TeamCreation, TeamsClient } from "./teams";
9import type { PeopleClient } from "./people";
10import type { DeployKeysClient } from "./deploy-keys";
11import type { EmailConfirmed } from "./accounts";
12
13export type User = {
14 id: string;
15 /** Lowercased: what the person is found, linked and mentioned by. */
16 username: string;
17 /**
18 * The username as its owner wrote it (`Ana`), when that differs from
19 * `username`: what pages show (`shownUsername`). Set on the signed-in
20 * person and on people looked up by name.
21 */
22 display_username?: string;
23 /**
24 * `workspace` when a workspace is acting through one of its own access
25 * tokens: `id` is then the workspace's and `username` its slug. `system`
26 * is g1t itself doing platform work, such as a security update
27 * (`username` `g1t`). Absent means `user`.
28 */
29 kind?: "user" | "workspace" | "agent" | "system";
30 /**
31 * Whether the account's email address is confirmed. Only set on users
32 * resolved from credentials. An account that has not confirmed it can
33 * only confirm it: see `awaitsConfirmation`.
34 */
35 verified?: boolean;
36 /**
37 * The workspaces this user belongs to. Set on users resolved from
38 * credentials, so any service can authorize from it.
39 */
40 workspaces?: Membership[];
41 /**
42 * The person's uploaded avatar: the SHA-256 of its bytes, served at
43 * `/avatars/<avatar>`. Only set on the signed-in person; absent means
44 * the generated letter avatar.
45 */
46 avatar?: string;
47 /**
48 * Set on an agent resolved from its token: who it acts for ("g1t
49 * on behalf of syntaqx"), with which credential, and what it may do.
50 */
51 acting?: Acting;
52 /**
53 * The repositories this user has a role on directly, whether or not they
54 * belong to its workspace. Set with `workspaces`; see `access.ts`.
55 */
56 grants?: RepoGrant[];
57 /**
58 * Set on a user resolved from an access token: its scopes (null for full
59 * access) and the workspaces or repositories it reaches. See scopes.ts.
60 */
61 token?: {
62 token_id: string;
63 scopes?: string[] | null;
64 legacy?: boolean;
65 /** The token's name, as its owner gave it. */
66 name?: string;
67 /**
68 * A token narrowed to one workspace (or none): its workspace and
69 * repositories. The key is kept from before tokens were one kind.
70 */
71 fine_grained?: {
72 workspace?: string | null;
73 repositories?: "all" | "selected" | "public";
74 repo_ids?: string[];
75 };
76 /** A workspace's own token with Repositories: admin. */
77 admin?: boolean;
78 /** Set on what a deploy key resolves to. */
79 deploy_key?: string;
80 /** The one repository a job's token or a deploy key reaches. */
81 repo?: string;
82 /** Set on a workflow job's token (`G1T_TOKEN`): the run and job it was made for. */
83 job?: { run_id: string; job_id: string; pull_requests?: boolean };
84 /**
85 * A person's token whose owner let it use the website as them, sent as
86 * `Authorization: Bearer` (apps/web, lib/website-token.ts). Not a scope.
87 */
88 website?: boolean;
89 };
90 /**
91 * Workspaces the person belongs to but cannot use until they meet its
92 * policy, such as turning on two-factor authentication. Left out of
93 * `workspaces` and `grants` meanwhile.
94 */
95 held?: PolicyHold[];
96};
97
98/** What a member may do: an owner also manages the workspace's members. */
99export type Role = "owner" | "member";
100
101export type Membership = {
102 /** The workspace's name in URLs: `g1t.sh/<slug>`. */
103 slug: string;
104 role: Role;
105 /** Its display name. Set on users resolved from credentials. */
106 name?: string;
107 /** Its uploaded icon, as `Workspace.avatar`. */
108 avatar?: string;
109 /** The workspace's base permission: what members get on every repository. Absent means `write`. */
110 base_permission?: BasePermission;
111 /** Who may create its teams. Absent means any member. */
112 team_creation?: TeamCreation;
113 /** The roles held besides owner or member. */
114 org_roles?: OrgRole[];
115 /** What the workspace lets its members do. Absent means the defaults. */
116 privileges?: MemberPrivileges;
117 /**
118 * Whether this member uses Code: repositories, issues, pull requests,
119 * checks, deploys. False for people who only use Chat, Docs and agents
120 * (support, sales, finance): they see no repository, whatever the base
121 * permission, and agents treat them as unable to change code. Absent
122 * means true.
123 */
124 code_access?: boolean;
125};
126
127/** Whether a member uses Code. See `Membership.code_access`. */
128export function hasCodeAccess(membership: Pick<Membership, "code_access"> | null | undefined): boolean {
129 return membership?.code_access !== false;
130}
131
132/** How long an old workspace slug redirects, and stays reserved for it, after a rename. */
133export const SLUG_HOLD_DAYS = 90;
134
135/** How long a workspace must wait between renames. */
136export const RENAME_COOLDOWN_HOURS = 24;
137
138/** The largest avatar that can be uploaded, in bytes. */
139export const MAX_AVATAR_BYTES = 1024 * 1024;
140
141/**
142 * Where a workspace keeps its repositories' git data: anywhere g1t stores
143 * it (the default), or in the EU only. It applies to repositories made
144 * after it is set.
145 */
146export type DataResidency = "anywhere" | "eu";
147
148/**
149 * A workspace: the owner of repositories, and the first segment of their
150 * URLs. A person's own space and a team's are the same thing.
151 */
152export type Workspace = {
153 id: string;
154 slug: string;
155 name: string;
156 /** One line saying what the workspace is for. */
157 description: string | null;
158 /** RFC 3339. */
159 createdAt: string;
160 memberCount: number;
161 /**
162 * The workspace's uploaded icon: the SHA-256 of its bytes, served at
163 * `/avatars/<avatar>`. Null means the generated letter avatar.
164 */
165 avatar: string | null;
166 /** What every member gets on each repository; owners have Admin. */
167 basePermission?: BasePermission;
168 /** Who may create its teams. Absent means any member. */
169 teamCreation?: TeamCreation;
170 /** Whether members and outside collaborators need two-factor authentication. */
171 twoFactorRequirementEnabled?: boolean;
172} & Partial<MemberPrivileges>;
173
174export type Member = {
175 username: string;
176 /** The username as its owner wrote it (`Ana`), when that differs from `username`. */
177 display_username?: string;
178 role: Role;
179 /** The roles they hold besides `role`. */
180 org_roles?: OrgRole[];
181 /** Whether two-factor authentication is on; owners only, null for anyone else. */
182 two_factor?: boolean | null;
183 /** Their display name, when they set one. */
184 name?: string | null;
185 /** Their uploaded avatar's hash, served at `/avatars/<avatar>`; null for the generated letter avatar. */
186 avatar?: string | null;
187};
188
189/** An owner of a workspace, as staff see them. */
190export type AdminOwner = { username: string; email: string | null };
191
192/** A workspace as staff see it. Mirrors `AdminWorkspace` in `crates/contracts/src/identity.rs`. */
193export type AdminWorkspace = {
194 slug: string;
195 name: string;
196 /** RFC 3339. */
197 createdAt: string;
198 owners: AdminOwner[];
199 memberCount: number;
200};
201
202/** A member of a workspace, as staff see them. */
203export type AdminMember = { username: string; email: string | null; role: Role; /** RFC 3339. */ joined: string };
204
205export type AdminWorkspaceDetail = {
206 slug: string;
207 name: string;
208 description: string | null;
209 /** RFC 3339. */
210 createdAt: string;
211 /** Owners first, then by username. */
212 members: AdminMember[];
213 /** It can never be deleted, by anyone (identity's `PROTECTED_WORKSPACES`). */
214 protected: boolean;
215};
216
217/** The most workspaces one `workspaces` call returns. */
218export const ADMIN_WORKSPACES_LIMIT = 500;
219
220/** How long an invite works, unless identity's `INVITE_TTL_DAYS` says otherwise. */
221export const INVITE_TTL_DAYS = 30;
222/** The most characters an invitation's note keeps (`invite_member`'s `message`). */
223export const MAX_INVITE_MESSAGE = 500;
224
225/** Only a pending invite can be used or revoked. */
226/**
227 * `awaiting_confirmation`: used to make an account that has not confirmed its
228 * email address yet; what it gives is joined when the address is confirmed,
229 * unless it is revoked first.
230 */
231/**
232 * `awaiting_answer`: the account it made is confirmed, and the workspace it
233 * names waits for the person to accept or decline. `declined`: they said no.
234 */
235export type InviteStatus =
236 | "pending"
237 | "awaiting_confirmation"
238 | "awaiting_answer"
239 | "redeemed"
240 | "declined"
241 | "expired"
242 | "revoked";
243
244/** One invite. Mirrors `Invite` in `crates/contracts/src/identity.rs`. */
245export type Invite = {
246 id: string;
247 /** `g1t-k7m2-…`: returned when it is made, and to its maker while pending. */
248 code: string | null;
249 /** The code's first group, such as `g1t-k7m2`. */
250 hint: string;
251 /** Only this address can use it. */
252 email: string | null;
253 /** `account` makes an account; `workspace` joins an existing one to `workspace`. */
254 kind: "account" | "workspace";
255 /** The workspace using it joins. */
256 workspace: string | null;
257 status: InviteStatus;
258 /** Its maker's username; null when g1t staff made it. */
259 invitedBy: string | null;
260 /** The account that used it. */
261 redeemedBy: string | null;
262 /** RFC 3339. */
263 createdAt: string;
264 /** RFC 3339. */
265 expiresAt: string;
266 redeemedAt: string | null;
267 revokedAt: string | null;
268 /** The account a workspace invitation is for, by username: someone invited by username, or the account the invite made. */
269 invitee?: string | null;
270 /** The role `workspace` is joined with; null when it names none. */
271 role?: Role | null;
272 /** The staff member who minted it; only in staff views. */
273 staff?: string | null;
274};
275
276/**
277 * A workspace invitation waiting for its person's answer, as they see it.
278 * Mirrors `WorkspaceInvitation` in `crates/contracts/src/identity.rs`.
279 */
280export type WorkspaceInvitation = {
281 id: string;
282 workspace: ProfileWorkspace;
283 /** The role accepting joins with. */
284 role: Role;
285 /** Null when g1t staff sent it. */
286 invitedBy: { username: string; name: string | null; avatar: string | null } | null;
287 createdAt: string;
288 expiresAt: string;
289};
290
291/** Someone to invite, as `findPeople` finds them: never an email address. */
292export type PersonMatch = { username: string; name: string | null; avatar: string | null };
293
294/** What a valid code is for, before it is used. */
295export type InvitePreview = {
296 kind: "account" | "workspace";
297 /** Pending, unless `anyStatus` asked about a code that is spent. */
298 status: InviteStatus;
299 /** Null when g1t staff sent it. */
300 invitedBy: { username: string; name: string | null; avatar: string | null } | null;
301 workspace: ProfileWorkspace | null;
302 /** The repository it accepts an invitation to, such as `{ name: "flagon-io/g1t", role: "write" }`. */
303 repository: { name: string; role: string } | null;
304 /** Partly hidden, such as `a•••@example.com`. */
305 email: string | null;
306 /** The bound address in full, while the invite is pending: it fills in and locks the sign-up form. */
307 address: string | null;
308 /** Whether the bound address has a g1t account already: sign in to accept. */
309 hasAccount: boolean;
310 /** With a viewer: whether it is theirs (for one of their confirmed addresses, or used by them). */
311 forViewer: boolean | null;
312 expiresAt: string;
313 /**
314 * Whether the page was opened from this pending invite's own email (its
315 * `proof` checked out): the account made with it starts with `address`
316 * confirmed. False without a proof, with a wrong one, or for an invite
317 * bound to no address.
318 */
319 emailProven: boolean;
320};
321
322/**
323 * The shared invite link an account was made with. Before registration
324 * opened, staff handed groups shared links; none are made or used any more.
325 */
326export type SharedInviteSource = { id: string; label: string };
327
328/** The most rows one staff listing of invites returns. */
329export const ADMIN_INVITES_LIMIT = 500;
330
331/**
332 * Staff-only identity, for sudo.g1t.sh. It takes no viewer and checks no
333 * membership: only sudo calls it, over its service binding, once Cloudflare
334 * Access and its staff list have let someone in. Never call it on behalf of
335 * a customer.
336 */
337export interface IdentityAdminApi {
338 /** Every workspace, newest first, at most 500; `query` matches slug, name, or an owner's username or email. */
339 workspaces(query?: string): Promise<AdminWorkspace[]>;
340 /** One workspace with all its members, or null. */
341 workspace(slug: string): Promise<AdminWorkspaceDetail | null>;
342
343 /** Invites, newest first; `query` is a code's start, or part of an email, inviter or redeemer. */
344 invites(query?: string | null): Promise<Invite[]>;
345 revokeInvite(id: string, staff: string): Promise<Result<Invite>>;
346
347 /** Workspaces owners deleted that are not purged yet, newest first. */
348 deletedWorkspaces(): Promise<DeletedWorkspace[]>;
349 /**
350 * Brings a deleted workspace back, with its members, tokens and what went
351 * with it, while it is still restorable. Publishes `workspace.restored`.
352 */
353 restoreWorkspace(workspaceId: string, staff: string): Promise<Result<boolean>>;
354 /**
355 * Purges a deleted workspace now rather than at `purgeAfter`. `confirm` is
356 * its slug, typed out. Refused for a protected workspace. Publishes
357 * `workspace.deleted`.
358 */
359 purgeWorkspace(workspaceId: string, staff: string, confirm: string): Promise<Result<boolean>>;
360
361 /** Every workspace alias, by name. */
362 aliases(): Promise<WorkspaceAlias[]>;
363 /**
364 * Points `alias` at the workspace whose slug is `workspace`. Refused for
365 * one of the site's routes, anyone's username, a workspace's slug (deleted
366 * or held after a rename) and an existing alias. `note` says why.
367 */
368 setAlias(alias: string, workspace: string, note: string, staff: string): Promise<Result<WorkspaceAlias>>;
369 /** Removes an alias; `reason` goes in sudo's audit log. */
370 removeAlias(alias: string, reason: string, staff: string): Promise<Result<boolean>>;
371}
372
373/**
374 * A name g1t's staff point at a workspace, so its addresses lead there under
375 * the workspace's own name: `g1t`, the product, leads to `flagon-io`, Flagon,
376 * Inc. Staff-managed only; it follows the workspace through renames.
377 */
378export type WorkspaceAlias = {
379 alias: string;
380 workspaceId: string;
381 /** The workspace's slug and name now. */
382 workspace: string;
383 workspaceName: string;
384 /** Why it exists. */
385 note: string;
386 /** The staff member who set it, or `migration`. */
387 createdBy: string;
388 /** RFC 3339. */
389 createdAt: string;
390};
391
392/** Who is asking. Every read and write in every service takes one. */
393export type Viewer = User | null;
394
395/**
396 * Whether this is a person whose account has not confirmed its email
397 * address. Such an account can only confirm it, change it, or sign out.
398 */
399export function awaitsConfirmation(user: Pick<User, "kind" | "verified"> | null | undefined): boolean {
400 return !!user && (user.kind ?? "user") === "user" && !user.verified;
401}
402
403export type SshKey = {
404 id: string;
405 title: string;
406 fingerprint: string;
407 /** RFC 3339. */
408 createdAt: string;
409 /** When it last signed in over SSH, RFC 3339, to within 5 minutes; null when it never has. */
410 lastUsedAt: string | null;
411};
412
413export type AccessToken = {
414 id: string;
415 name: string;
416 /** RFC 3339. */
417 createdAt: string;
418 /** RFC 3339, to within a few minutes. Null until it is first used. */
419 lastUsedAt: string | null;
420 /**
421 * For a workspace's token, the username of the member who made it. Null
422 * once that account is gone, and on personal tokens.
423 */
424 createdBy: string | null;
425 /** Its scopes, as `resource:level`, the highest of each resource. Null: full access. */
426 scopes: string[] | null;
427 /** Made before tokens had scopes: full access until someone narrows it. */
428 legacy: boolean;
429 /** RFC 3339. Null: it does not expire. */
430 expiresAt: string | null;
431 /** Its scopes as permissions: each resource it may use, at the highest level. */
432 permissions?: Permissions;
433 /** What it is for, as its owner wrote it. */
434 description?: string | null;
435 /**
436 * A personal token's reach: the workspace it is made for; null for every
437 * workspace you belong to (or, with `repositorySelection` public, none).
438 * Null on a workspace's own token, which reaches its workspace.
439 */
440 workspace?: string | null;
441 /** Which repositories of that workspace it reaches. */
442 repositorySelection?: RepositorySelection;
443 /** With `selected`: the repositories, as `owner/name`, that you can see. */
444 repositories?: string[];
445 /** Whether a token made for a workspace that approves tokens may be used there yet. */
446 status?: TokenStatus;
447 /** Why an owner denied or revoked it. */
448 reviewReason?: string | null;
449 /** A workspace's own token, acting as the workspace. */
450 workspaceOwned?: boolean;
451 /** A workspace's own token with Repositories: admin, an admin of its repositories. */
452 admin?: boolean;
453 /** A personal token its owner let use the website as them. */
454 website?: boolean;
455};
456
457/** Which repositories a token reaches in its workspace: all, the selected ones, or public ones only. */
458export type RepositorySelection = "all" | "selected" | "public";
459
460/** Whether a token made for a workspace may be used there yet. */
461export type TokenStatus = "active" | "pending" | "denied" | "revoked";
462
463/** A new access token: a person's, or (with `owner`) a workspace's. */
464export type TokenInput = {
465 /** A workspace's slug to make that workspace's token; null for your own. */
466 owner?: string | null;
467 name: string;
468 description?: string | null;
469 /** 1 to 366 days; null for no expiry, where the workspaces it reaches allow that. */
470 ttlSeconds: number | null;
471 /**
472 * A personal token's reach: a workspace's slug, or null for every
473 * workspace you belong to (with `repositorySelection` public: none).
474 */
475 workspace: string | null;
476 repositorySelection: RepositorySelection;
477 /** With `selected`: `owner/name` or names in the workspace. */
478 repositories: string[];
479 /** Each resource's level; left out is no access. */
480 permissions: Partial<Record<ScopeResource, ScopeLevel>>;
481 /** A personal token: whether it may use the website as you. Off unless set. */
482 website?: boolean;
483};
484
485/** A change to a token; what is left out stays. */
486export type TokenChange = Partial<Pick<TokenInput, "name" | "description" | "repositorySelection" | "repositories" | "permissions" | "website">>;
487
488/** A workspace's rules for personal access tokens. */
489export type TokenPolicy = {
490 /** A token made for every workspace of its owner reaches this one. */
491 allowTokensForAllWorkspaces: boolean;
492 /** A token may be made for this workspace alone. */
493 allowTokensForThisWorkspace: boolean;
494 /** A token made for this workspace waits for an owner's approval. */
495 requireApproval: boolean;
496 /** Null: no limit. */
497 maxLifetimeDays: number | null;
498 forbidNoExpiry: boolean;
499 updatedBy?: string | null;
500 updatedAt?: string | null;
501};
502
503/** A member's personal token that reaches a workspace, as its owners see it. */
504export type MemberToken = {
505 owner: string;
506 token: AccessToken;
507 /** Whether it reaches the workspace now. */
508 reaches: boolean;
509 /** Why not: pending approval, denied, revoked, tokens for all workspaces not allowed, tokens made for this workspace not allowed, lasts too long, never expires. */
510 blockedBy?: string | null;
511};
512
513/** What a new or changed token may do. */
514export type TokenGrant = {
515 /** Null: full access. */
516 scopes: string[] | null;
517};
518
519export type DeviceStart = {
520 /** Secret held by the tool and exchanged for a token once approved. */
521 deviceCode: string;
522 /** Short code shown to the person, e.g. `WDJB-MJHT`. */
523 userCode: string;
524 /** Seconds until both codes stop working. */
525 expiresIn: number;
526 /** Seconds the tool should wait between polls. */
527 interval: number;
528};
529
530export type DeviceRequest = { userCode: string; clientName: string };
531
532export type DeviceClaim =
533 | { status: "pending" | "denied" | "expired" }
534 | { status: "approved"; token: string; user: User };
535
536/** What the site passes on once a person has approved an application. */
537export type OAuthApproval = {
538 clientId: string;
539 /** Shown wherever the application's access is listed. */
540 clientName: string;
541 redirectUri: string;
542 /** PKCE challenge, method S256. */
543 codeChallenge: string;
544 /** What the person granted. Null: full access. */
545 scopes: string[] | null;
546};
547
548export type OAuthTokens = {
549 accessToken: string;
550 /** Works once; using it returns the next one. */
551 refreshToken: string;
552 /** Seconds until the access token stops working. */
553 expiresIn: number;
554 /** The scopes granted, space-separated, or `*` for full access. */
555 scope?: string | null;
556};
557
558/** An application a person has signed in to. */
559export type OAuthGrant = {
560 id: string;
561 clientName: string;
562 /** RFC 3339. */
563 createdAt: string;
564 /** RFC 3339. */
565 lastUsedAt: string;
566 /** What the person granted. Null: full access. */
567 scopes: string[] | null;
568 /** Signed in before applications had scopes: full access until narrowed. */
569 legacy: boolean;
570};
571
572/** Accounts, credentials and sessions. */
573/**
574 * What deleting a workspace takes with it, and what stands in the way:
575 * nothing does while `billing` is null and it is not `protected`.
576 */
577export type WorkspaceDeletion = {
578 /** Its live repositories, deleted with it. */
579 repositories: number;
580 /** Its projects, hidden with it. */
581 projects: number;
582 members: number;
583 /** Why billing cannot close it yet, in words for its owner. */
584 billing: string | null;
585 /** It can never be deleted, by anyone. */
586 protected: boolean;
587};
588
589/** How long a deleted workspace is kept, for g1t's staff to restore, before it is purged. */
590export const WORKSPACE_RESTORE_DAYS = 30;
591
592/**
593 * Workspaces nobody can delete, whatever identity's `PROTECTED_WORKSPACES`
594 * says: Flagon's, which runs g1t. Services that act on `workspace.deleting`
595 * check it too, so one published for it by mistake changes nothing.
596 */
597export const ALWAYS_PROTECTED_WORKSPACES: readonly string[] = ["flagon-io"];
598
599/** Whether `slug` is one of `ALWAYS_PROTECTED_WORKSPACES`, in any case. */
600export function isProtectedWorkspace(slug: string): boolean {
601 return ALWAYS_PROTECTED_WORKSPACES.includes(slug.trim().toLowerCase());
602}
603
604/** A workspace an owner deleted, kept until `purgeAfter` for staff to restore. */
605export type DeletedWorkspace = {
606 workspaceId: string;
607 slug: string;
608 name: string;
609 /** RFC 3339. */
610 deletedAt: string;
611 /** The username of the owner who deleted it, or the staff member who deleted it with the account that alone owned it. */
612 deletedBy: string;
613 /** RFC 3339: when it is purged unless restored first. */
614 purgeAfter: string;
615 /** What went with it, counted when it was deleted. */
616 went: WorkspaceDeletion;
617 /** Whether staff can still restore it. */
618 restorable: boolean;
619};
620
621export interface IdentityApi extends AccessClient, TeamsClient, PeopleClient, DeployKeysClient {
622 /**
623 * Creates an account and signs it in. Anyone may register; at most
624 * five accounts an hour per `client`. `inviteCode` is optional: one from an
625 * invitation sent to `email` applies that invitation once the address is
626 * confirmed, and any other code is ignored.
627 */
628 register(
629 username: string,
630 email: string,
631 password: string,
632 inviteCode?: string | null,
633 /** Who is asking, such as the visitor's IP address, for rate limits. */
634 client?: string | null,
635 /**
636 * The `proof` from the invite email's link. When it is the invite's own
637 * and `email` is the address it was sent to, the account starts with that
638 * address confirmed; otherwise it is ignored.
639 */
640 emailProof?: string | null,
641 ): Promise<Result<{ user: User; sessionToken: string }>>;
642 /** Verifies a username and password for website sign-in. */
643 /**
644 * Verifies a username, or any confirmed address of the account, and its
645 * password. Wrong passwords are counted against the account and `client`
646 * (the visitor's IP address); past a limit nothing is checked for a while.
647 */
648 signIn(
649 username: string,
650 password: string,
651 client?: string | null,
652 ): Promise<Result<{ user: User; sessionToken: string; twoFactorChallenge?: string | null }>>;
653 /**
654 * The second step of signing in, for an account with two-factor
655 * authentication: the challenge `signIn` returned, and a code from the
656 * app or a recovery code.
657 */
658 twoFactorSignIn(challenge: string, code: string, client?: string | null): Promise<Result<{ user: User; sessionToken: string }>>;
659 signOut(sessionToken: string): Promise<void>;
660
661 /**
662 * Sends a new confirmation code and link to the primary of an account
663 * that has not confirmed it, at most once a minute.
664 */
665 resendVerification(user: User): Promise<Result<boolean>>;
666 /** Confirms the address the emailed link was sent to, signed in or not; ends the code sent with it. */
667 verifyEmail(token: string): Promise<Result<EmailConfirmed>>;
668 /** Emails a reset link if the address has an account. Always resolves. */
669 /**
670 * Any confirmed address of an account works; the link goes to it, and the
671 * primary and backup are told. A few an hour per address and per `client`.
672 */
673 requestPasswordReset(email: string, client?: string | null): Promise<boolean>;
674 /** Sets a new password from an emailed token and ends every session. */
675 resetPassword(token: string, password: string): Promise<Result<User>>;
676
677 /**
678 * Device sign-in (RFC 8628). A tool starts a request, a person approves
679 * its short code in a browser, and the tool claims an access token.
680 */
681 deviceStart(clientName: string): Promise<DeviceStart>;
682 /** What a user code is asking for, or null if it is not valid. */
683 deviceLookup(userCode: string): Promise<DeviceRequest | null>;
684 deviceResolve(userCode: string, user: User, approve: boolean): Promise<Result<boolean>>;
685 deviceClaim(deviceCode: string): Promise<DeviceClaim>;
686
687 /**
688 * OAuth 2.1 for applications that sign a person in through the browser.
689 * The caller has checked the client and its redirect address; this
690 * returns the one-time code the application exchanges for tokens.
691 */
692 oauthAuthorize(user: User, approval: OAuthApproval): Promise<{ code: string }>;
693 /** Redeems a code. It works once, for that client, with the PKCE verifier. */
694 oauthExchange(code: string, codeVerifier: string, clientId: string, redirectUri: string): Promise<Result<OAuthTokens>>;
695 /** Trades a refresh token for new tokens; the old ones stop working. */
696 oauthRefresh(refreshToken: string, clientId: string): Promise<Result<OAuthTokens>>;
697 /** Applications the user has signed in to, most recently used first. */
698 listOAuthGrants(user: User): Promise<OAuthGrant[]>;
699 /** Signs an application out. */
700 revokeOAuthGrant(user: User, id: string): Promise<void>;
701 /** Changes what an application may do, at once and when it refreshes. */
702 updateOAuthGrant(user: User, id: string, grant: TokenGrant): Promise<Result<OAuthGrant>>;
703
704 createWorkspace(user: User, slug: string, name: string): Promise<Result<Workspace>>;
705 /** Public details of a workspace, or null. */
706 getWorkspace(slug: string): Promise<Workspace | null>;
707 /** Where a workspace keeps its repositories' git data; null when there is no such workspace. */
708 workspaceResidency(slug: string): Promise<DataResidency | null>;
709 /**
710 * Owners only. Applies to repositories made from then on. Offer `eu`
711 * only when the repos service's `storageOptions()` says it is available.
712 */
713 setWorkspaceResidency(actor: User, slug: string, residency: DataResidency): Promise<Result<DataResidency>>;
714 /** Members only. */
715 listMembers(slug: string, viewer: Viewer): Promise<Result<Member[]>>;
716 /** Owners only. */
717 addMember(actor: User, slug: string, username: string): Promise<Result<boolean>>;
718 /** Owners only; your own username is leaving. Never the last owner. */
719 removeMember(actor: User, slug: string, username: string): Promise<Result<boolean>>;
720 /** Owners only: owner or member, and the roles held besides it. Never leaves no owner. */
721 updateMember(actor: User, slug: string, username: string, change: { role?: Role; org_roles?: OrgRole[] }): Promise<Result<Member>>;
722 /** Owners only: `username` becomes an owner, and you a member. */
723 transferOwnership(actor: User, slug: string, username: string): Promise<Result<boolean>>;
724 /** You leave the workspace. Never the last owner. */
725 leaveWorkspace(user: User, slug: string): Promise<Result<boolean>>;
726 /** Owners only: change some member privileges; returns all of them. */
727 setMemberPrivileges(actor: User, slug: string, change: Partial<MemberPrivileges>): Promise<Result<MemberPrivileges>>;
728 /** Owners only, with two-factor on themselves: require it of everyone. */
729 setTwoFactorRequirement(actor: User, slug: string, required: boolean): Promise<Result<boolean>>;
730 /** Owners only. An empty name falls back to the slug. */
731 updateWorkspace(actor: User, slug: string, details: { name: string; description: string }): Promise<Result<Workspace>>;
732 /**
733 * Owners only. Changes the slug, the first segment of the workspace's
734 * URLs; the display name is untouched. The old slug redirects to the new
735 * one, and stays reserved for this workspace, for `SLUG_HOLD_DAYS`.
736 * Publishes `workspace.renamed`.
737 */
738 renameWorkspace(actor: User, slug: string, newSlug: string): Promise<Result<Workspace>>;
739 /** Whether `renameWorkspace` would be allowed, changing nothing. */
740 checkWorkspaceRename(actor: User, slug: string, newSlug: string): Promise<Result<boolean>>;
741 /**
742 * The workspace's current slug when `slug` is one it was renamed from
743 * within `SLUG_HOLD_DAYS`, or when `slug` is an alias staff set for it
744 * (`WorkspaceAlias`); null otherwise, including for a slug in use.
745 */
746 resolveSlug(slug: string): Promise<string | null>;
747 /**
748 * Owners only, a person only. `confirm` is the slug, typed out. Refused
749 * for a protected workspace, and while billing cannot settle it. Its
750 * repositories, projects and apps go with it; it is kept for
751 * `WORKSPACE_RESTORE_DAYS`, when g1t's staff can restore it, then purged.
752 * Its slug is never given to anyone else; the person whose username it is
753 * may make it again once it is purged. Publishes `workspace.deleting`.
754 */
755 deleteWorkspace(actor: User, slug: string, confirm: string): Promise<Result<boolean>>;
756 /** What `deleteWorkspace` would take with it, and what stands in its way, changing nothing. */
757 checkWorkspaceDeletion(actor: User, slug: string): Promise<Result<WorkspaceDeletion>>;
758 /**
759 * Owners only. `image` is the file in base64: PNG, JPEG, WebP or GIF, at
760 * most `MAX_AVATAR_BYTES`, checked by its bytes. Null removes the icon.
761 */
762 setWorkspaceAvatar(actor: User, slug: string, image: string | null): Promise<Result<Workspace>>;
763 /** A person's own avatar, as `setWorkspaceAvatar`: the new one, or null. */
764 setUserAvatar(user: User, image: string | null): Promise<Result<string | null>>;
765
766 /**
767 * A workspace's own access tokens. They belong to the workspace, act as
768 * it, and keep working when the member who made one leaves. Members only.
769 */
770 listWorkspaceTokens(slug: string, viewer: Viewer): Promise<Result<AccessToken[]>>;
771 /** Owners only. */
772 removeWorkspaceToken(actor: User, slug: string, id: string): Promise<Result<boolean>>;
773
774 /**
775 * An access token: yours, or (with `input.owner`, owners only) a
776 * workspace's. People only, signed in. The plaintext token is returned
777 * once and never stored. A personal token made for a workspace that asks
778 * for approval starts pending unless you are an owner there.
779 */
780 createToken(actor: User, input: TokenInput): Promise<Result<{ token: string; info: AccessToken }>>;
781 /**
782 * Changes a token of yours, or (with `owner`, owners only) a
783 * workspace's; what is left out stays. Widening a token made for a
784 * workspace that approves tokens asks for approval again.
785 */
786 updateToken(actor: User, id: string, change: TokenChange, owner?: string | null): Promise<Result<AccessToken>>;
787 /**
788 * A new secret for a token, everything else kept, the old secret refused
789 * from then on: rotating it. `ttlSeconds` is its new lifetime from now
790 * (null: it does not expire), within its workspace's rules. The secret
791 * is shown once.
792 */
793 regenerateToken(actor: User, id: string, ttlSeconds: number | null, owner?: string | null): Promise<Result<{ token: string; info: AccessToken }>>;
794 /** A workspace's rules for personal access tokens. Members only. */
795 getTokenPolicy(slug: string, viewer: Viewer): Promise<Result<TokenPolicy>>;
796 /** Owners only, as people. `maxLifetimeDays` of 0 removes the limit. */
797 setTokenPolicy(
798 actor: User,
799 slug: string,
800 change: Partial<Omit<TokenPolicy, "updatedBy" | "updatedAt">>,
801 ): Promise<Result<TokenPolicy>>;
802 /** The members' tokens that can reach a workspace. Owners only. */
803 listMemberTokens(
804 actor: User,
805 slug: string,
806 filter?: { status?: TokenStatus },
807 ): Promise<Result<MemberToken[]>>;
808 /** Approve or deny a token waiting for approval. Owners only. */
809 reviewTokenRequest(actor: User, slug: string, id: string, approve: boolean, reason?: string | null): Promise<Result<MemberToken>>;
810 /** Take a member's token out of the workspace. Owners only. */
811 revokeMemberToken(actor: User, slug: string, id: string, reason?: string | null): Promise<Result<boolean>>;
812
813 userForSession(sessionToken: string): Promise<Viewer>;
814
815 /**
816 * What a code is for. Unknown, used, revoked and expired codes all get the
817 * same answer, unless `anyStatus`: then a real code that is spent is
818 * described, with its `status`. `viewer` sets `forViewer`; `emailProof`,
819 * the `proof` from the invite email's link, sets `emailProven`.
820 */
821 checkInvite(
822 code: string,
823 client?: string | null,
824 options?: { viewer?: User | null; anyStatus?: boolean; emailProof?: string | null },
825 ): Promise<Result<InvitePreview>>;
826 /**
827 * A signed-in person uses a workspace invite sent to their address, or one
828 * sent with a repository invitation; returns the workspace's slug, or
829 * `workspace/repo`.
830 */
831 acceptInvite(user: User, code: string): Promise<Result<string>>;
832 /**
833 * Owners only. Invites someone into a workspace by address (always with an
834 * invite bound to it) or by `username`: a workspace invitation they accept
835 * or decline. Nobody joins without saying yes. `role` is what they join as.
836 */
837 inviteMember(
838 actor: User,
839 slug: string,
840 who: { email?: string | null; username?: string | null; role?: Role | null; message?: string | null },
841 ): Promise<Result<Invite>>;
842 /** The workspace invitations waiting for the person's answer, newest first. */
843 listInvitations(user: User): Promise<WorkspaceInvitation[]>;
844 /** Joins the invitation's workspace with its role; returns the workspace's slug. */
845 acceptInvitation(user: User, id: string): Promise<Result<string>>;
846 /** Declines it; whoever sent it is told in their inbox. */
847 declineInvitation(user: User, id: string): Promise<Result<boolean>>;
848 /** People to invite, by username prefix or name: a username, a name and an avatar each. */
849 findPeople(query: string, limit?: number): Promise<PersonMatch[]>;
850 /** Owners only: the workspace's invites, newest first. */
851 workspaceInvites(slug: string, viewer: Viewer): Promise<Result<Invite[]>>;
852 /** Owners only. */
853 revokeWorkspaceInvite(actor: User, slug: string, id: string): Promise<Result<Invite>>;
854 /** Owners only: sends a pending invitation again, by email and in the invited account's inbox. Unchanged otherwise. */
855 resendWorkspaceInvite(actor: User, slug: string, id: string): Promise<Result<Invite>>;
856
857 /** Verifies git credentials: the account password or an access token. */
858 userForGitCredentials(username: string, secret: string): Promise<Viewer>;
859 /** Resolves a `g1t_…` access token, as sent to the API and MCP server. */
860 userForAccessToken(token: string): Promise<Viewer>;
861 userForSshKey(fingerprint: string): Promise<Viewer>;
862 userByUsername(username: string): Promise<Viewer>;
863 /** The names behind account and workspace ids; unknown ids are left out. */
864 usernames(ids: string[]): Promise<Record<string, string>>;
865 /**
866 * Internal: the people behind these ids (at most 50) with their
867 * workspaces, roles and repository grants, as a signed-in viewer has
868 * them. For the agents service's audience checks only. Ids of no live
869 * account are left out.
870 */
871 usersForAudience(ids: string[]): Promise<User[]>;
872
873 /** A person's public profile, or null if there is no such account. Never an email address. */
874 profile(username: string): Promise<Profile | null>;
875 /** A person changes their own profile. Every field is replaced; an empty one is cleared. */
876 updateProfile(actor: User, fields: ProfileFields): Promise<Result<Profile>>;
877 /**
878 * The workspaces a profile shows `viewer`: those the viewer belongs to
879 * as well, and those of `publicIn` (where the person made a public
880 * project) that the person really belongs to. Nothing else.
881 */
882 profileWorkspaces(username: string, viewer: Viewer, publicIn: string[]): Promise<ProfileWorkspace[]>;
883
884 /**
885 * The apps `user` pinned to their dock in the workspace `workspace` (a
886 * slug), in the order they set; null when they never saved any there or
887 * are not one of its members. Kept with the account, so every device
888 * shows the same dock.
889 */
890 dockPins(user: User, workspace: string): Promise<string[] | null>;
891 /**
892 * Replaces `user`'s dock pins in `workspace` with `apps`, in that order:
893 * keys of lowercase letters, digits and hyphens, repeats dropped, at
894 * most `MAX_DOCK_PINS`. Which keys are real apps is the caller's to check.
895 */
896 setDockPins(user: User, workspace: string, apps: string[]): Promise<Result<string[]>>;
897
898 /**
899 * How chat sounds and desktop notifications reach `user`, kept with the
900 * account so every device and the desktop app behave the same
901 * (`SoundSettings`). The defaults when they never changed them.
902 */
903 soundSettings(user: User): Promise<SoundSettings>;
904 /**
905 * Changes some of them: only the fields sent change, and `sound_cues`
906 * merges one cue at a time. Returns the settings as kept.
907 */
908 setSoundSettings(user: User, change: SoundSettingsChange): Promise<Result<SoundSettings>>;
909
910 listSshKeys(user: User): Promise<SshKey[]>;
911 /** Takes one line in OpenSSH public key format. */
912 addSshKey(user: User, title: string, publicKey: string): Promise<Result<SshKey>>;
913 removeSshKey(user: User, id: string): Promise<void>;
914
915 listAccessTokens(user: User): Promise<AccessToken[]>;
916 /**
917 * A credential minted for a person or workspace by another service. The
918 * plaintext token is returned once and never stored. With `ttlSeconds`
919 * the token expires and is left out of token lists; that form is used
920 * for hosted agents. Tokens people make use `createToken`.
921 */
922 createAccessToken(
923 user: User,
924 name: string,
925 ttlSeconds?: number,
926 grant?: TokenGrant & { listed?: boolean },
927 ): Promise<{ token: string; info: AccessToken }>;
928 /**
929 * A token for a g1t agent working for `onBehalfOf`: it acts as
930 * `g1t`, in `scope.repo` only, and only for `scope.operations`.
931 */
932 createAgentToken(
933 onBehalfOf: User,
934 scope: AgentScope,
935 ttlSeconds: number,
936 ): Promise<{ token: string; info: AccessToken }>;
937 removeAccessToken(user: User, id: string): Promise<void>;
938 /**
939 * A token for one sandbox run: it acts as the agent on behalf of
940 * `onBehalfOf`, can do only what the run's kind needs in `repo`, and
941 * expires after `ttlSeconds`. See `audit.ts`.
942 */
943 createRunCredential(input: CreateRunCredentialInput): Promise<{ token: string; info: AccessToken }>;
944 /** Ties tokens, by the SHA-256 of their text in hex, to the agent run their sandbox recorded. */
945 bindRunCredentials(tokenHashes: string[], runId: string): Promise<boolean>;
946 /** Ends a sandbox's run credentials, by hash or by run. Never touches another token. */
947 revokeRunCredentials(target: { tokenHashes?: string[]; runId?: string | null }): Promise<boolean>;
948}
949
950
951/** What an agent's token may do: these operations, in this repository. */
952export type AgentScope = { repo: RepoPath; operations: string[]; run?: RunBinding };
953
954/** The most apps a person pins in one workspace. Mirrors `MAX_DOCK_PINS` in `crates/contracts/src/identity.rs`. */
955export const MAX_DOCK_PINS = 24;
956
957/** The most characters each profile field takes. Mirrors `crates/contracts/src/identity.rs`. */
958export const PROFILE_LIMITS = { name: 80, bio: 160, location: 80, website: 200, pronouns: 40, timezone: 64 } as const;
959
960/** What anyone may see about a person, at `g1t.sh/u/<username>`. */
961export type Profile = {
962 /** Lowercased: what the profile is found and linked by. */
963 username: string;
964 /** The username as its owner wrote it (`Ana`), when that differs: what the page shows. */
965 displayUsername?: string | null;
966 /** The name they go by, if they gave one. */
967 name: string | null;
968 bio: string | null;
969 location: string | null;
970 /** Always an `https://` address. */
971 website: string | null;
972 pronouns: string | null;
973 /** The time zone they are in, an IANA name such as `America/Denver`. */
974 timezone: string | null;
975 /** The uploaded avatar's hash, served at `/avatars/<avatar>`. */
976 avatar: string | null;
977 /** When the account was made. RFC 3339. */
978 createdAt: string;
979};
980
981/** What a person may change on their profile. Empty clears a field. */
982export type ProfileFields = {
983 name: string;
984 bio: string;
985 location: string;
986 /** `https://…`; a bare `example.com` is taken as `https://example.com`. */
987 website: string;
988 pronouns: string;
989 /** An IANA time zone name, such as `America/Denver`; empty clears it. */
990 timezone: string;
991};
992
993/** A workspace on a person's profile. */
994export type ProfileWorkspace = { slug: string; name: string; avatar: string | null };