Sign in

pulls/pr_01m47d24b0e6n91zwymwxg0vpx

public

pr_01m47d24b0e6n91zwymwxg0vpx/packages/contracts/src/repos.ts

318 lines11,494 bytesCodeBlame
1import type { User, Viewer } from "./identity";
2import type { Result } from "./result";
3
4export 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. */
38export const RESTORE_DAYS = 30;
39
40/** A deleted repository, as its workspace's Recently deleted list shows it. */
41export 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. */
56export type RepoStatus = { archived: boolean; deleted: boolean };
57
58/** The most topics a repository has, and the longest topic. */
59export const MAX_TOPICS = 20;
60export const MAX_TOPIC_CHARS = 35;
61
62export type RepoPath = { namespace: string; name: string };
63
64export 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
74export type TreeEntry = {
75 name: string;
76 hash: string;
77 kind: "tree" | "blob" | "symlink" | "gitlink" | "exec";
78};
79
80export 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
90export 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. */
100export type GitAccess = { remote: string; token: string };
101
102export type GitService = "git-upload-pack" | "git-receive-pack";
103
104export 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. */
118export interface ReposApi {
119 get(path: RepoPath, viewer: Viewer): Promise<Result<Repo>>;
120 getById(id: string, viewer: Viewer): Promise<Result<Repo>>;
121 /**
122 * The workspaces in which this account made a public repository, and so
123 * a public project anyone can see. By account id.
124 */
125 publicNamespaces(ownerId: string): Promise<string[]>;
126 /** Repos the viewer may see, newest first, optionally matching `query`. */
127 list(
128 viewer: Viewer,
129 options?: {
130 query?: string;
131 /** Only repos in this workspace. */
132 namespace?: string;
133 /** Only repos in workspaces the viewer belongs to. */
134 memberOnly?: boolean;
135 },
136 ): Promise<Repo[]>;
137 create(owner: User, input: CreateRepoInput): Promise<Result<Repo>>;
138 /**
139 * Changes whichever details are given. Members of the repository's
140 * workspace only. An empty description clears it.
141 */
142 update(
143 actor: User,
144 path: RepoPath,
145 changes: {
146 description?: string;
147 isPrivate?: boolean;
148 protected?: boolean;
149 topics?: string[];
150 /** An empty string clears it. */
151 website?: string;
152 },
153 ): Promise<Result<Repo>>;
154 /**
155 * Deletes the repository. Owners only, who type its full name as
156 * `confirm`. It is hidden at once and can be restored for
157 * `RESTORE_DAYS` days, then purged. Publishes `repo.deleted`.
158 */
159 delete(actor: User, path: RepoPath, confirm: string): Promise<Result<DeletedRepo>>;
160 /** A workspace's recently deleted repositories, newest first. Owners only; empty otherwise. */
161 deleted(viewer: Viewer, namespace: string): Promise<DeletedRepo[]>;
162 /** Brings a deleted repository back as it was. Owners only. Publishes `repo.restored`. */
163 restore(actor: User, path: RepoPath): Promise<Result<Repo>>;
164 /**
165 * Removes a deleted repository for good now, its git data with it, and
166 * frees its name. Owners only, who type its full name. Publishes `repo.purged`.
167 */
168 purge(actor: User, path: RepoPath, confirm: string): Promise<Result<boolean>>;
169 /**
170 * Renames the repository in its workspace. Owners only. The old path
171 * redirects until a repository is made there. Publishes `repo.renamed`.
172 */
173 rename(actor: User, path: RepoPath, name: string): Promise<Result<Repo>>;
174 /**
175 * Archives the repository (read-only) or unarchives it. Owners only.
176 * Publishes `repo.archived` or `repo.unarchived`.
177 */
178 archive(actor: User, path: RepoPath, archived: boolean): Promise<Result<Repo>>;
179 /**
180 * Makes the repository public or private. Owners only, who type its full
181 * name as `confirm`. Publishes `repo.updated` and `repo.visibility_changed`.
182 */
183 setVisibility(actor: User, path: RepoPath, isPrivate: boolean, confirm: string): Promise<Result<Repo>>;
184 /** Makes another existing branch the default. Members. */
185 setDefaultBranch(actor: User, path: RepoPath, branch: string): Promise<Result<Repo>>;
186 /**
187 * Renames a branch; pull requests from it follow, and addresses naming the
188 * old one redirect. Members; only owners rename the default branch.
189 */
190 renameBranch(actor: User, path: RepoPath, from: string, to: string): Promise<Result<Repo>>;
191 /** What a branch renamed away from `branch` is called now, or null. */
192 resolveBranch(repoId: string, branch: string): Promise<string | null>;
193 /** Whether a repository is archived or deleted; an unknown id answers as deleted. */
194 statusById(id: string): Promise<RepoStatus>;
195 /**
196 * Moves the repository to the workspace `to`, keeping its name, id and
197 * everything under it. The actor must own both workspaces. The old path
198 * redirects until a repository is made there. Publishes `repo.transferred`.
199 */
200 transfer(actor: User, path: RepoPath, to: string): Promise<Result<Repo>>;
201 /**
202 * Where a repository transferred away from `path` is now; null when
203 * `path` is a repository or never was one that moved. Callers check the
204 * viewer may see it there.
205 */
206 resolvePath(path: RepoPath): Promise<RepoPath | null>;
207
208 tree(path: RepoPath, viewer: Viewer, ref: string | null, treePath: string): Promise<Result<TreeView>>;
209 blob(path: RepoPath, viewer: Viewer, ref: string, filePath: string): Promise<Result<BlobView>>;
210 log(path: RepoPath, viewer: Viewer, ref: string | null, limit: number): Promise<Result<Commit[]>>;
211 /**
212 * Who last changed each line of a file as of `ref` (the default branch if
213 * null). Not found when the file is missing or is not text.
214 */
215 blame(path: RepoPath, viewer: Viewer, ref: string | null, filePath: string): Promise<Result<Blame>>;
216
217 /**
218 * A copy-on-write copy of `source`, hidden from listings, for one pull request
219 * to work in.
220 */
221 forkForPull(sourceId: string, pullId: string, actor: User): Promise<Result<Repo>>;
222
223 /**
224 * Authorizes a git operation and returns where to send it. Pushing to a
225 * repo that does not exist creates it in the pusher's own namespace.
226 */
227 gitAccess(path: RepoPath, viewer: Viewer, service: GitService): Promise<Result<GitAccess>>;
228
229 /** The repository's branches, default branch first. */
230 branches(path: RepoPath, viewer: Viewer): Promise<Result<Branch[]>>;
231
232 /**
233 * Moves a repository's default branch to the head of a pull request's
234 * source: a fork (`sourceId` is the fork) or one of the repository's own
235 * branches (`sourceId` is the repository, and `branch` is required).
236 * Refused with "conflict" when the source is behind, since that would
237 * discard commits.
238 */
239 land(sourceId: string, actor: User, branch?: string | null): Promise<Result<{ commit: string; previous: string | null }>>;
240
241 /**
242 * What `head` changes relative to `base`. `head` is a branch or a commit
243 * and defaults to the default branch. With no `base`, a fork is compared
244 * with the last commit it shares with the repository it came from, and a
245 * branch with the point where it left the default branch.
246 */
247 compare(repoId: string, viewer: Viewer, base?: string | null, head?: string | null): Promise<Result<Comparison>>;
248}
249
250/** Lines `start` to `end` (inclusive, from 1) last changed by `commit`. */
251export type BlameRange = { start: number; end: number; commit: string };
252
253/** Who last changed each line of a file. */
254export type Blame = {
255 /** The commit the file was read at. */
256 head: string;
257 /** Every line, in order, in runs that share a commit. */
258 ranges: BlameRange[];
259 /** The commits the ranges name, each once. */
260 commits: Commit[];
261 /** True when the history was too long to read in full. */
262 partial: boolean;
263};
264
265/** A branch and the commit it points to. */
266export type Branch = { name: string; hash: string };
267
268/**
269 * What came of bringing a pull request up to date with the default branch
270 * without a sandbox. `needs_agent` pushed nothing: the runner's `update`
271 * merges it in a sandbox, with an agent if it conflicts.
272 */
273export type PullBranchUpdate =
274 | { outcome: "updated"; commit: string; previous: string }
275 | { outcome: "up_to_date"; commit: string }
276 | {
277 outcome: "needs_agent";
278 /**
279 * `overlap`: both sides changed some of the same files. `conflicting`:
280 * merging is known to conflict. `unsupported`: it could not be worked
281 * out without git, such as for a very large change.
282 */
283 reason: "overlap" | "conflicting" | "unsupported";
284 detail: string;
285 /** The files both changed, or that conflict, when known. */
286 paths: string[];
287 };
288
289export type DiffLine = {
290 kind: "context" | "add" | "delete";
291 /** Line number in the old file; null for added lines. */
292 old: number | null;
293 /** Line number in the new file; null for deleted lines. */
294 new: number | null;
295 text: string;
296};
297
298/** A run of changed lines with their surrounding context. */
299export type Hunk = { lines: DiffLine[] };
300
301export type FileDiff = {
302 path: string;
303 status: "added" | "modified" | "deleted";
304 additions: number;
305 deletions: number;
306 /** True when the file is binary or too large, so no lines are shown. */
307 binary: boolean;
308 hunks: Hunk[];
309};
310
311/** What changed between two commits. */
312export type Comparison = {
313 base: string | null;
314 head: string;
315 files: FileDiff[];
316 /** True when the change was too large to return in full. */
317 truncated: boolean;
318};