| 1 | import type { User, Viewer } from "./identity"; |
| 2 | import type { Result } from "./result"; |
| 3 | |
| 4 | export type Repo = { |
| 5 | id: string; |
| 6 | /** The slug of the workspace that owns it: the first URL segment. */ |
| 7 | namespace: string; |
| 8 | name: string; |
| 9 | description: string | null; |
| 10 | isPrivate: boolean; |
| 11 | ownerId: string; |
| 12 | defaultBranch: string; |
| 13 | /** Set when this repo is a pull request's working copy of another repo. */ |
| 14 | forkOf: string | null; |
| 15 | /** |
| 16 | * Whether the default branch is protected: it changes only by merging a |
| 17 | * pull request, and pushes to it are refused. |
| 18 | */ |
| 19 | protected: boolean; |
| 20 | /** RFC 3339. */ |
| 21 | createdAt: string; |
| 22 | /** |
| 23 | * Words that say what it is about, for search and Explore: lowercase |
| 24 | * letters, digits and hyphens, at most 20. |
| 25 | */ |
| 26 | topics: string[]; |
| 27 | /** Its home page, an http(s) address. */ |
| 28 | website?: string | null; |
| 29 | /** |
| 30 | * RFC 3339: when it was archived. While archived it is read-only: |
| 31 | * pushes, merges, agents and workflows are refused, and issues and pull |
| 32 | * requests are locked. Null when it is not archived. |
| 33 | */ |
| 34 | archivedAt?: string | null; |
| 35 | }; |
| 36 | |
| 37 | /** How long a deleted repository can be restored before it is purged. */ |
| 38 | export const RESTORE_DAYS = 30; |
| 39 | |
| 40 | /** A deleted repository, as its workspace's Recently deleted list shows it. */ |
| 41 | export type DeletedRepo = { |
| 42 | id: string; |
| 43 | namespace: string; |
| 44 | name: string; |
| 45 | description: string | null; |
| 46 | isPrivate: boolean; |
| 47 | /** RFC 3339. */ |
| 48 | deletedAt: string; |
| 49 | /** The username of who deleted it. */ |
| 50 | deletedBy: string; |
| 51 | /** RFC 3339: when it is purged, unless restored first. */ |
| 52 | purgeAfter: string; |
| 53 | }; |
| 54 | |
| 55 | /** Whether a repository is archived or deleted, for services deciding whether to act on it. */ |
| 56 | export type RepoStatus = { archived: boolean; deleted: boolean }; |
| 57 | |
| 58 | /** The most topics a repository has, and the longest topic. */ |
| 59 | export const MAX_TOPICS = 20; |
| 60 | export const MAX_TOPIC_CHARS = 35; |
| 61 | |
| 62 | export type RepoPath = { namespace: string; name: string }; |
| 63 | |
| 64 | export type Commit = { |
| 65 | hash: string; |
| 66 | treeHash: string; |
| 67 | message: string; |
| 68 | author: { name: string; email: string }; |
| 69 | parents: string[]; |
| 70 | /** RFC 3339. */ |
| 71 | authoredAt: string; |
| 72 | }; |
| 73 | |
| 74 | export type TreeEntry = { |
| 75 | name: string; |
| 76 | hash: string; |
| 77 | kind: "tree" | "blob" | "symlink" | "gitlink" | "exec"; |
| 78 | }; |
| 79 | |
| 80 | export type TreeView = { |
| 81 | repo: Repo; |
| 82 | ref: string; |
| 83 | path: string; |
| 84 | /** Null when the repo has no commits yet. */ |
| 85 | head: Commit | null; |
| 86 | entries: TreeEntry[]; |
| 87 | readme: { name: string; text: string | null } | null; |
| 88 | }; |
| 89 | |
| 90 | export type BlobView = { |
| 91 | repo: Repo; |
| 92 | ref: string; |
| 93 | path: string; |
| 94 | size: number; |
| 95 | /** Null when the file is binary or too large to show. */ |
| 96 | text: string | null; |
| 97 | }; |
| 98 | |
| 99 | /** A git remote and a short-lived credential for it. */ |
| 100 | export type GitAccess = { remote: string; token: string }; |
| 101 | |
| 102 | export type GitService = "git-upload-pack" | "git-receive-pack"; |
| 103 | |
| 104 | export type CreateRepoInput = { |
| 105 | /** The workspace to create it in; the creator must be a member. */ |
| 106 | namespace: string; |
| 107 | name: string; |
| 108 | description?: string | null; |
| 109 | isPrivate?: boolean; |
| 110 | /** |
| 111 | * The https address of a public git repository to copy the default branch |
| 112 | * of, such as `https://github.com/owner/repo`. |
| 113 | */ |
| 114 | importUrl?: string; |
| 115 | }; |
| 116 | |
| 117 | /** Repositories: metadata, contents and git access. */ |
| 118 | export interface ReposApi { |
| 119 | get(path: RepoPath, viewer: Viewer): Promise<Result<Repo>>; |
| 120 | getById(id: string, viewer: Viewer): Promise<Result<Repo>>; |
| 121 | /** |
| 122 | * Of these ids (at most 500), the repositories the viewer can read, in |
| 123 | * one call. Forks and deleted repositories are left out. |
| 124 | */ |
| 125 | readable(ids: string[], viewer: Viewer): Promise<Repo[]>; |
| 126 | /** |
| 127 | * The workspaces in which this account made a public repository, and so |
| 128 | * a public project anyone can see. By account id. |
| 129 | */ |
| 130 | publicNamespaces(ownerId: string): Promise<string[]>; |
| 131 | /** Repos the viewer may see, newest first, optionally matching `query`. */ |
| 132 | list( |
| 133 | viewer: Viewer, |
| 134 | options?: { |
| 135 | query?: string; |
| 136 | /** Only repos in this workspace. */ |
| 137 | namespace?: string; |
| 138 | /** Only repos in workspaces the viewer belongs to. */ |
| 139 | memberOnly?: boolean; |
| 140 | }, |
| 141 | ): Promise<Repo[]>; |
| 142 | create(owner: User, input: CreateRepoInput): Promise<Result<Repo>>; |
| 143 | /** |
| 144 | * Changes whichever details are given. Members of the repository's |
| 145 | * workspace only. An empty description clears it. |
| 146 | */ |
| 147 | update( |
| 148 | actor: User, |
| 149 | path: RepoPath, |
| 150 | changes: { |
| 151 | description?: string; |
| 152 | isPrivate?: boolean; |
| 153 | protected?: boolean; |
| 154 | topics?: string[]; |
| 155 | /** An empty string clears it. */ |
| 156 | website?: string; |
| 157 | }, |
| 158 | ): Promise<Result<Repo>>; |
| 159 | /** |
| 160 | * Deletes the repository. Owners only, who type its full name as |
| 161 | * `confirm`. It is hidden at once and can be restored for |
| 162 | * `RESTORE_DAYS` days, then purged. Publishes `repo.deleted`. |
| 163 | */ |
| 164 | delete(actor: User, path: RepoPath, confirm: string): Promise<Result<DeletedRepo>>; |
| 165 | /** A workspace's recently deleted repositories, newest first. Owners only; empty otherwise. */ |
| 166 | deleted(viewer: Viewer, namespace: string): Promise<DeletedRepo[]>; |
| 167 | /** Brings a deleted repository back as it was. Owners only. Publishes `repo.restored`. */ |
| 168 | restore(actor: User, path: RepoPath): Promise<Result<Repo>>; |
| 169 | /** |
| 170 | * Removes a deleted repository for good now, its git data with it, and |
| 171 | * frees its name. Owners only, who type its full name. Publishes `repo.purged`. |
| 172 | */ |
| 173 | purge(actor: User, path: RepoPath, confirm: string): Promise<Result<boolean>>; |
| 174 | /** |
| 175 | * Renames the repository in its workspace. Owners only. The old path |
| 176 | * redirects until a repository is made there. Publishes `repo.renamed`. |
| 177 | */ |
| 178 | rename(actor: User, path: RepoPath, name: string): Promise<Result<Repo>>; |
| 179 | /** |
| 180 | * Archives the repository (read-only) or unarchives it. Owners only. |
| 181 | * Publishes `repo.archived` or `repo.unarchived`. |
| 182 | */ |
| 183 | archive(actor: User, path: RepoPath, archived: boolean): Promise<Result<Repo>>; |
| 184 | /** |
| 185 | * Makes the repository public or private. Owners only, who type its full |
| 186 | * name as `confirm`. Publishes `repo.updated` and `repo.visibility_changed`. |
| 187 | */ |
| 188 | setVisibility(actor: User, path: RepoPath, isPrivate: boolean, confirm: string): Promise<Result<Repo>>; |
| 189 | /** Makes another existing branch the default. Members. */ |
| 190 | setDefaultBranch(actor: User, path: RepoPath, branch: string): Promise<Result<Repo>>; |
| 191 | /** |
| 192 | * Renames a branch; pull requests from it follow, and addresses naming the |
| 193 | * old one redirect. Members; only owners rename the default branch. |
| 194 | */ |
| 195 | renameBranch(actor: User, path: RepoPath, from: string, to: string): Promise<Result<Repo>>; |
| 196 | /** What a branch renamed away from `branch` is called now, or null. */ |
| 197 | resolveBranch(repoId: string, branch: string): Promise<string | null>; |
| 198 | /** Whether a repository is archived or deleted; an unknown id answers as deleted. */ |
| 199 | statusById(id: string): Promise<RepoStatus>; |
| 200 | /** |
| 201 | * Moves the repository to the workspace `to`, keeping its name, id and |
| 202 | * everything under it. The actor must own both workspaces. The old path |
| 203 | * redirects until a repository is made there. Publishes `repo.transferred`. |
| 204 | */ |
| 205 | transfer(actor: User, path: RepoPath, to: string): Promise<Result<Repo>>; |
| 206 | /** |
| 207 | * Where a repository transferred away from `path` is now; null when |
| 208 | * `path` is a repository or never was one that moved. Callers check the |
| 209 | * viewer may see it there. |
| 210 | */ |
| 211 | resolvePath(path: RepoPath): Promise<RepoPath | null>; |
| 212 | |
| 213 | tree(path: RepoPath, viewer: Viewer, ref: string | null, treePath: string): Promise<Result<TreeView>>; |
| 214 | blob(path: RepoPath, viewer: Viewer, ref: string, filePath: string): Promise<Result<BlobView>>; |
| 215 | log(path: RepoPath, viewer: Viewer, ref: string | null, limit: number): Promise<Result<Commit[]>>; |
| 216 | /** |
| 217 | * Who last changed each line of a file as of `ref` (the default branch if |
| 218 | * null). Not found when the file is missing or is not text. |
| 219 | */ |
| 220 | blame(path: RepoPath, viewer: Viewer, ref: string | null, filePath: string): Promise<Result<Blame>>; |
| 221 | |
| 222 | /** |
| 223 | * A copy-on-write copy of `source`, hidden from listings, for one pull request |
| 224 | * to work in. |
| 225 | */ |
| 226 | forkForPull(sourceId: string, pullId: string, actor: User): Promise<Result<Repo>>; |
| 227 | |
| 228 | /** |
| 229 | * Authorizes a git operation and returns where to send it. Pushing to a |
| 230 | * repo that does not exist creates it in the pusher's own namespace. |
| 231 | */ |
| 232 | gitAccess(path: RepoPath, viewer: Viewer, service: GitService): Promise<Result<GitAccess>>; |
| 233 | |
| 234 | /** The repository's branches, default branch first. */ |
| 235 | branches(path: RepoPath, viewer: Viewer): Promise<Result<Branch[]>>; |
| 236 | |
| 237 | /** |
| 238 | * Every file at `ref` (the default branch when null), at most `limit` |
| 239 | * (10,000 at most). No viewer: check access first. |
| 240 | */ |
| 241 | listFiles(repoId: string, ref: string | null, limit: number): Promise<FileList>; |
| 242 | |
| 243 | /** Blobs' bytes as standard base64, at most 100; `data` is null for one missing or over `maxBytes`. No viewer. */ |
| 244 | rawBlobs(repoId: string, hashes: string[], maxBytes: number): Promise<RawBlob[]>; |
| 245 | |
| 246 | /** |
| 247 | * Writes one file on a new branch made from the default branch's head, as |
| 248 | * one commit by `actor`, for a change g1t proposes on their behalf (a |
| 249 | * starter workflow). Refused unless they may push, when the branch exists, |
| 250 | * or when the file is already there. |
| 251 | */ |
| 252 | commitFile( |
| 253 | repo: RepoPath, |
| 254 | actor: User, |
| 255 | file: { branch: string; path: string; content: string; message: string }, |
| 256 | ): Promise<Result<{ branch: string; commit: string }>>; |
| 257 | |
| 258 | /** |
| 259 | * Moves a repository's default branch to the head of a pull request's |
| 260 | * source: a fork (`sourceId` is the fork) or one of the repository's own |
| 261 | * branches (`sourceId` is the repository, and `branch` is required). |
| 262 | * Refused with "conflict" when the source is behind, since that would |
| 263 | * discard commits. |
| 264 | */ |
| 265 | land(sourceId: string, actor: User, branch?: string | null): Promise<Result<{ commit: string; previous: string | null }>>; |
| 266 | |
| 267 | /** |
| 268 | * What `head` changes relative to `base`. `head` is a branch or a commit |
| 269 | * and defaults to the default branch. With no `base`, a fork is compared |
| 270 | * with the last commit it shares with the repository it came from, and a |
| 271 | * branch with the point where it left the default branch. |
| 272 | */ |
| 273 | compare(repoId: string, viewer: Viewer, base?: string | null, head?: string | null): Promise<Result<Comparison>>; |
| 274 | } |
| 275 | |
| 276 | /** Lines `start` to `end` (inclusive, from 1) last changed by `commit`. */ |
| 277 | export type BlameRange = { start: number; end: number; commit: string }; |
| 278 | |
| 279 | /** Who last changed each line of a file. */ |
| 280 | export type Blame = { |
| 281 | /** The commit the file was read at. */ |
| 282 | head: string; |
| 283 | /** Every line, in order, in runs that share a commit. */ |
| 284 | ranges: BlameRange[]; |
| 285 | /** The commits the ranges name, each once. */ |
| 286 | commits: Commit[]; |
| 287 | /** True when the history was too long to read in full. */ |
| 288 | partial: boolean; |
| 289 | }; |
| 290 | |
| 291 | /** A branch and the commit it points to. */ |
| 292 | export type Branch = { name: string; hash: string }; |
| 293 | |
| 294 | /** Files at a commit, and whether there were more than were listed. */ |
| 295 | export type FileList = { commit: string | null; files: { path: string; hash: string | null }[]; truncated: boolean }; |
| 296 | |
| 297 | /** One blob's bytes, standard base64; null when missing or too large. */ |
| 298 | export type RawBlob = { hash: string; size: number; data: string | null }; |
| 299 | |
| 300 | /** |
| 301 | * What came of bringing a pull request up to date with the default branch |
| 302 | * without a sandbox. `needs_agent` pushed nothing: the runner's `update` |
| 303 | * merges it in a sandbox, with an agent if it conflicts. |
| 304 | */ |
| 305 | export type PullBranchUpdate = |
| 306 | | { outcome: "updated"; commit: string; previous: string } |
| 307 | | { outcome: "up_to_date"; commit: string } |
| 308 | | { |
| 309 | outcome: "needs_agent"; |
| 310 | /** |
| 311 | * `overlap`: both sides changed some of the same files. `conflicting`: |
| 312 | * merging is known to conflict. `unsupported`: it could not be worked |
| 313 | * out without git, such as for a very large change. |
| 314 | */ |
| 315 | reason: "overlap" | "conflicting" | "unsupported"; |
| 316 | detail: string; |
| 317 | /** The files both changed, or that conflict, when known. */ |
| 318 | paths: string[]; |
| 319 | }; |
| 320 | |
| 321 | export type DiffLine = { |
| 322 | kind: "context" | "add" | "delete"; |
| 323 | /** Line number in the old file; null for added lines. */ |
| 324 | old: number | null; |
| 325 | /** Line number in the new file; null for deleted lines. */ |
| 326 | new: number | null; |
| 327 | text: string; |
| 328 | }; |
| 329 | |
| 330 | /** A run of changed lines with their surrounding context. */ |
| 331 | export type Hunk = { lines: DiffLine[] }; |
| 332 | |
| 333 | export type FileDiff = { |
| 334 | path: string; |
| 335 | status: "added" | "modified" | "deleted"; |
| 336 | additions: number; |
| 337 | deletions: number; |
| 338 | /** True when the file is binary or too large, so no lines are shown. */ |
| 339 | binary: boolean; |
| 340 | hunks: Hunk[]; |
| 341 | }; |
| 342 | |
| 343 | /** What changed between two commits. */ |
| 344 | export type Comparison = { |
| 345 | base: string | null; |
| 346 | head: string; |
| 347 | files: FileDiff[]; |
| 348 | /** True when the change was too large to return in full. */ |
| 349 | truncated: boolean; |
| 350 | }; |