sailfork 0.3.6 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +7 -0
- package/dist/index.cjs +134 -1
- package/dist/index.js +134 -1
- package/dist/tools.cjs +344 -0
- package/dist/tools.js +344 -0
- package/dist/types/core/version.d.ts +1 -1
- package/dist/types/generated/api.d.ts +56 -0
- package/dist/types/generated/index.d.ts +1 -1
- package/dist/types/generated/ops.d.ts +91 -0
- package/dist/types/generated/types.d.ts +216 -0
- package/dist/types-cjs/core/version.d.ts +1 -1
- package/dist/types-cjs/generated/api.d.ts +56 -0
- package/dist/types-cjs/generated/index.d.ts +1 -1
- package/dist/types-cjs/generated/ops.d.ts +91 -0
- package/dist/types-cjs/generated/types.d.ts +216 -0
- package/llms.txt +7 -0
- package/package.json +1 -1
|
@@ -596,6 +596,63 @@ export type CommentProof = {
|
|
|
596
596
|
/** Sailfork ran it itself. */
|
|
597
597
|
verified: boolean;
|
|
598
598
|
};
|
|
599
|
+
/** A repository's history, or a path's, newest first. */
|
|
600
|
+
export type CommitLog = CommitRecord[] | CommitPage;
|
|
601
|
+
export type CommitPage = {
|
|
602
|
+
commits: CommitRecord[];
|
|
603
|
+
/** Set when a path's history stopped at the search's step limit: pass it as `cursor` for the commits after these. `null` when the list is whole. */
|
|
604
|
+
cursor: string | null;
|
|
605
|
+
};
|
|
606
|
+
/** A commit as the explorer API sends it: `Commit` plus the author's address. */
|
|
607
|
+
export type CommitRecord = {
|
|
608
|
+
added: number;
|
|
609
|
+
at: string;
|
|
610
|
+
author: string;
|
|
611
|
+
email: string;
|
|
612
|
+
files: number;
|
|
613
|
+
/** In a path's history, where the file was named in this commit. */
|
|
614
|
+
path?: string | null;
|
|
615
|
+
removed: number;
|
|
616
|
+
sha: string;
|
|
617
|
+
short: string;
|
|
618
|
+
subject: string;
|
|
619
|
+
};
|
|
620
|
+
/** What `commit view --json` prints: the server's answer for `GET commits/{sha}`, passed through whole. */
|
|
621
|
+
export type CommitView = {
|
|
622
|
+
body: string;
|
|
623
|
+
child: CommitRecord | null;
|
|
624
|
+
commit: CommitRecord;
|
|
625
|
+
/** The first files in path order; `filesTotal` counts every file the commit changed. */
|
|
626
|
+
files: FileDiff[];
|
|
627
|
+
filesTotal: number;
|
|
628
|
+
parent: CommitRecord | null;
|
|
629
|
+
};
|
|
630
|
+
/** What a comparison answers: the whole diff, or with `from` and `count` one page of its files. */
|
|
631
|
+
export type CompareAnswer = CompareView | CompareFiles;
|
|
632
|
+
/** One page of a comparison's files with their hunks. */
|
|
633
|
+
export type CompareFiles = {
|
|
634
|
+
files: FileDiff[];
|
|
635
|
+
/** The index of the first file in the page. */
|
|
636
|
+
from: number;
|
|
637
|
+
};
|
|
638
|
+
/** `head` against `base`: the commits `head` adds since their merge base and the files it changes. */
|
|
639
|
+
export type CompareView = {
|
|
640
|
+
/** Commits on `head` that `base` lacks. */
|
|
641
|
+
ahead: number;
|
|
642
|
+
/** With `lines`: the two commits compared, which `from` and `count` pages name so every page reads the same diff after a branch moves. */
|
|
643
|
+
base: string | null;
|
|
644
|
+
/** Commits on `base` that `head` lacks. */
|
|
645
|
+
behind: number;
|
|
646
|
+
/** The newest `ahead` commits, newest first. */
|
|
647
|
+
commits: CommitRecord[];
|
|
648
|
+
/** The merge base's tree against `head`'s: the first files in path order. With `lines`, only the leading files carry hunks. */
|
|
649
|
+
files: FileDiff[];
|
|
650
|
+
/** Every file the comparison changes; `files` lists the first of them. */
|
|
651
|
+
filesTotal: number;
|
|
652
|
+
head: string | null;
|
|
653
|
+
/** The commit `files` diff from; absent for unrelated histories, where every file is new. */
|
|
654
|
+
mergeBase: string | null;
|
|
655
|
+
};
|
|
599
656
|
export type ConflictFile = {
|
|
600
657
|
/** `None` where the base branch does not have the path. */
|
|
601
658
|
base: ConflictSide | null;
|
|
@@ -658,7 +715,22 @@ export type DeletionScheduled = {
|
|
|
658
715
|
blockers: string[];
|
|
659
716
|
deletionAt: string;
|
|
660
717
|
};
|
|
718
|
+
export type DiffHunk = {
|
|
719
|
+
header: string;
|
|
720
|
+
lines: DiffLine[];
|
|
721
|
+
};
|
|
722
|
+
export type DiffLine = {
|
|
723
|
+
kind: string;
|
|
724
|
+
new: number | null;
|
|
725
|
+
old: number | null;
|
|
726
|
+
text: string;
|
|
727
|
+
};
|
|
661
728
|
export type DiffSide = 'old' | 'new';
|
|
729
|
+
export type DiffTotals = {
|
|
730
|
+
added: number;
|
|
731
|
+
files: number;
|
|
732
|
+
removed: number;
|
|
733
|
+
};
|
|
662
734
|
export type EnvChain = {
|
|
663
735
|
/** Whether the caller may append entries: an org owner, or the owner of a personal repository. */
|
|
664
736
|
admin: boolean;
|
|
@@ -838,6 +910,16 @@ export type FailedStep = {
|
|
|
838
910
|
stepName?: string | null;
|
|
839
911
|
tail: string[];
|
|
840
912
|
};
|
|
913
|
+
export type FileDiff = {
|
|
914
|
+
added: number;
|
|
915
|
+
binary: boolean;
|
|
916
|
+
from: string | null;
|
|
917
|
+
hunks: DiffHunk[];
|
|
918
|
+
path: string;
|
|
919
|
+
removed: number;
|
|
920
|
+
status: string;
|
|
921
|
+
truncated: boolean;
|
|
922
|
+
};
|
|
841
923
|
export type FileHit = {
|
|
842
924
|
language: string;
|
|
843
925
|
matchCount: number;
|
|
@@ -1433,6 +1515,27 @@ export type PullDetail = {
|
|
|
1433
1515
|
/** REST only: the pull request's page. */
|
|
1434
1516
|
url?: string | null;
|
|
1435
1517
|
};
|
|
1518
|
+
/** A pull request's diff: an open one's branch against its base as they stand, a merged one's from the merge base and branch tip recorded when it merged. */
|
|
1519
|
+
export type PullDiff = {
|
|
1520
|
+
/** Commits on `head` that `base` lacks. */
|
|
1521
|
+
ahead: number;
|
|
1522
|
+
/** With `lines`: the two commits compared, which `from` and `count` pages name so every page reads the same diff after a branch moves. */
|
|
1523
|
+
base: string | null;
|
|
1524
|
+
/** Commits on `base` that `head` lacks. */
|
|
1525
|
+
behind: number;
|
|
1526
|
+
/** The newest `ahead` commits, newest first. */
|
|
1527
|
+
commits: CommitRecord[];
|
|
1528
|
+
/** The merge base's tree against `head`'s: the first files in path order. With `lines`, only the leading files carry hunks. */
|
|
1529
|
+
files: FileDiff[];
|
|
1530
|
+
/** Every file the comparison changes; `files` lists the first of them. */
|
|
1531
|
+
filesTotal: number;
|
|
1532
|
+
head: string | null;
|
|
1533
|
+
/** The commit `files` diff from; absent for unrelated histories, where every file is new. */
|
|
1534
|
+
mergeBase: string | null;
|
|
1535
|
+
merged: boolean;
|
|
1536
|
+
/** Totals over every file, `files` counting them all. */
|
|
1537
|
+
stats: DiffTotals;
|
|
1538
|
+
};
|
|
1436
1539
|
export type PullFile = {
|
|
1437
1540
|
from: string | null;
|
|
1438
1541
|
hunks: PullHunk[];
|
|
@@ -1443,6 +1546,10 @@ export type PullHunk = {
|
|
|
1443
1546
|
header: string;
|
|
1444
1547
|
lines: PullLine[];
|
|
1445
1548
|
};
|
|
1549
|
+
/** `{ items }`, from `GET pulls/touching` and `GET commit/{sha}/pulls`. */
|
|
1550
|
+
export type PullItems = {
|
|
1551
|
+
items: Pull[];
|
|
1552
|
+
};
|
|
1446
1553
|
export type PullLine = {
|
|
1447
1554
|
kind: string;
|
|
1448
1555
|
new: number | null;
|
|
@@ -2184,6 +2291,8 @@ export type TotpSetup = {
|
|
|
2184
2291
|
/** The base32 secret, for typing in by hand. */
|
|
2185
2292
|
secret: string;
|
|
2186
2293
|
};
|
|
2294
|
+
/** Which pull requests `pulls.touching` searches. */
|
|
2295
|
+
export type TouchingState = 'all' | 'open' | 'merged';
|
|
2187
2296
|
/** What a review says about the pull request. */
|
|
2188
2297
|
export type Verdict = 'approve' | 'changes' | 'comment';
|
|
2189
2298
|
/** Who may read a repository. */
|
|
@@ -3967,6 +4076,20 @@ export type PullsAutoMergeEnableInput = {
|
|
|
3967
4076
|
stack?: boolean | null;
|
|
3968
4077
|
};
|
|
3969
4078
|
export type PullsAutoMergeEnableOutput = AutoMerge;
|
|
4079
|
+
/**
|
|
4080
|
+
* Show the diff of the pull request from a branch: the open one, else the newest closed or merged one.
|
|
4081
|
+
*/
|
|
4082
|
+
export type PullsBranchDiffInput = {
|
|
4083
|
+
/** The pull request's head branch. */
|
|
4084
|
+
branch: string;
|
|
4085
|
+
/** Hunks for the leading files only, up to about this many diff lines. */
|
|
4086
|
+
lines?: number | null;
|
|
4087
|
+
/** The repository owner's handle. */
|
|
4088
|
+
owner: string;
|
|
4089
|
+
/** The repository's name. */
|
|
4090
|
+
repo: string;
|
|
4091
|
+
};
|
|
4092
|
+
export type PullsBranchDiffOutput = PullDiff;
|
|
3970
4093
|
/**
|
|
3971
4094
|
* Show what a pull request's checks add up to: the CI jobs of the newest run of each workflow on its head, then the latest check run of each name and reporter. `waited` lets the verdict tell a first run that has not started from one that never will.
|
|
3972
4095
|
*/
|
|
@@ -4063,6 +4186,20 @@ export type PullsDeleteCommentInput = {
|
|
|
4063
4186
|
thread: string;
|
|
4064
4187
|
};
|
|
4065
4188
|
export type PullsDeleteCommentOutput = NoContent;
|
|
4189
|
+
/**
|
|
4190
|
+
* Show what a pull request changes: the commits it adds and its diff against the merge base, with totals. A merged one answers the diff it merged. A signed-out visitor sees a public repository's.
|
|
4191
|
+
*/
|
|
4192
|
+
export type PullsDiffInput = {
|
|
4193
|
+
/** Hunks for the leading files only, up to about this many diff lines; the answer then names `base` and `head` for `repos.compare` pages of the rest. */
|
|
4194
|
+
lines?: number | null;
|
|
4195
|
+
/** Pull request number. */
|
|
4196
|
+
number: number;
|
|
4197
|
+
/** The repository owner's handle. */
|
|
4198
|
+
owner: string;
|
|
4199
|
+
/** The repository's name. */
|
|
4200
|
+
repo: string;
|
|
4201
|
+
};
|
|
4202
|
+
export type PullsDiffOutput = PullDiff;
|
|
4066
4203
|
/**
|
|
4067
4204
|
* Dismiss the reviews that approved or asked for changes on a pull request.
|
|
4068
4205
|
*/
|
|
@@ -4095,6 +4232,18 @@ export type PullsEditCommentInput = {
|
|
|
4095
4232
|
thread: string;
|
|
4096
4233
|
};
|
|
4097
4234
|
export type PullsEditCommentOutput = PullThread;
|
|
4235
|
+
/**
|
|
4236
|
+
* List the pull requests whose commits include a commit, among the newest few hundred of any state.
|
|
4237
|
+
*/
|
|
4238
|
+
export type PullsForCommitInput = {
|
|
4239
|
+
/** The repository owner's handle. */
|
|
4240
|
+
owner: string;
|
|
4241
|
+
/** The repository's name. */
|
|
4242
|
+
repo: string;
|
|
4243
|
+
/** Commit sha (or its start), branch or tag. */
|
|
4244
|
+
sha: string;
|
|
4245
|
+
};
|
|
4246
|
+
export type PullsForCommitOutput = PullItems;
|
|
4098
4247
|
/**
|
|
4099
4248
|
* Show a pull request with its threads, whether it merges cleanly and the merge rules it does not meet yet.
|
|
4100
4249
|
*/
|
|
@@ -4237,6 +4386,21 @@ export type PullsStackInput = {
|
|
|
4237
4386
|
repo: string;
|
|
4238
4387
|
};
|
|
4239
4388
|
export type PullsStackOutput = StackEntry[];
|
|
4389
|
+
/**
|
|
4390
|
+
* List the pull requests that change a file, or a folder when `path` ends in `/`, newest first. Only the newest few hundred pull requests of the chosen states are searched.
|
|
4391
|
+
*/
|
|
4392
|
+
export type PullsTouchingInput = {
|
|
4393
|
+
/** At most this many: 30 by default, at most 100. */
|
|
4394
|
+
limit?: number | null;
|
|
4395
|
+
/** The repository owner's handle. */
|
|
4396
|
+
owner: string;
|
|
4397
|
+
/** File path, or a folder ending in `/`. */
|
|
4398
|
+
path: string;
|
|
4399
|
+
/** The repository's name. */
|
|
4400
|
+
repo: string;
|
|
4401
|
+
state?: TouchingState | null;
|
|
4402
|
+
};
|
|
4403
|
+
export type PullsTouchingOutput = PullItems;
|
|
4240
4404
|
/**
|
|
4241
4405
|
* Edit a pull request: its title, description, state (close, reopen, mark ready or back to draft), reviewer, base or lock. Only the fields sent change.
|
|
4242
4406
|
*/
|
|
@@ -4273,6 +4437,58 @@ export type PullsUpdateBranchInput = {
|
|
|
4273
4437
|
repo: string;
|
|
4274
4438
|
};
|
|
4275
4439
|
export type PullsUpdateBranchOutput = BranchUpdated;
|
|
4440
|
+
/**
|
|
4441
|
+
* Show a commit: its message, author, parent and child, and its changes as a diff of the first files in path order.
|
|
4442
|
+
*/
|
|
4443
|
+
export type ReposCommitInput = {
|
|
4444
|
+
/** The repository owner's handle. */
|
|
4445
|
+
owner: string;
|
|
4446
|
+
/** The repository's name. */
|
|
4447
|
+
repo: string;
|
|
4448
|
+
/** Commit sha (or its start), branch or tag. */
|
|
4449
|
+
sha: string;
|
|
4450
|
+
};
|
|
4451
|
+
export type ReposCommitOutput = CommitView;
|
|
4452
|
+
/**
|
|
4453
|
+
* List the commits of a branch, tag or commit, newest first, or the history of one path with `path`. A signed-out visitor sees a public repository's.
|
|
4454
|
+
*/
|
|
4455
|
+
export type ReposCommitsInput = {
|
|
4456
|
+
/** The `cursor` of an answer that stopped before its page was full: the history goes on from there. */
|
|
4457
|
+
cursor?: string | null;
|
|
4458
|
+
/** `1` answers `{commits, cursor}` instead of the bare list. */
|
|
4459
|
+
envelope?: string | null;
|
|
4460
|
+
/** Commits to answer: 500 by default, at most 1000. */
|
|
4461
|
+
limit?: number | null;
|
|
4462
|
+
/** The repository owner's handle. */
|
|
4463
|
+
owner: string;
|
|
4464
|
+
/** Only commits that changed this file or folder, following a renamed file to its earlier names. */
|
|
4465
|
+
path?: string | null;
|
|
4466
|
+
/** Branch, tag or commit to start from; the default branch when absent. */
|
|
4467
|
+
ref?: string | null;
|
|
4468
|
+
/** The repository's name. */
|
|
4469
|
+
repo: string;
|
|
4470
|
+
/** Newest commits to leave out, to page. */
|
|
4471
|
+
skip?: number | null;
|
|
4472
|
+
};
|
|
4473
|
+
export type ReposCommitsOutput = CommitLog;
|
|
4474
|
+
/**
|
|
4475
|
+
* Compare two branches, tags or commits: the commits `head` adds since their merge base and its diff. `spec` is `{base}...{head}`. A signed-out visitor sees a public repository's.
|
|
4476
|
+
*/
|
|
4477
|
+
export type ReposCompareInput = {
|
|
4478
|
+
/** With `from`: how many files the page holds, 1 to 100. */
|
|
4479
|
+
count?: number | null;
|
|
4480
|
+
/** With `count`: the index of the first file of a page of files with their hunks. */
|
|
4481
|
+
from?: number | null;
|
|
4482
|
+
/** Hunks for the leading files only, up to about this many diff lines; the answer then names `base` and `head`. */
|
|
4483
|
+
lines?: number | null;
|
|
4484
|
+
/** The repository owner's handle. */
|
|
4485
|
+
owner: string;
|
|
4486
|
+
/** The repository's name. */
|
|
4487
|
+
repo: string;
|
|
4488
|
+
/** `{base}...{head}`, such as `main...feature/login`. */
|
|
4489
|
+
spec: string;
|
|
4490
|
+
};
|
|
4491
|
+
export type ReposCompareOutput = CompareAnswer;
|
|
4276
4492
|
/**
|
|
4277
4493
|
* Create a repository for the caller, or in an org they belong to.
|
|
4278
4494
|
*/
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.4.0";
|
|
2
2
|
export declare const API_VERSION = "2026-12-01";
|
|
@@ -529,6 +529,10 @@ export declare class PullsResource {
|
|
|
529
529
|
* Resolves to `{ status: "held" }` when a person has to approve it first.
|
|
530
530
|
*/
|
|
531
531
|
autoMergeEnable(input: T.PullsAutoMergeEnableInput, opts?: RequestOptions): Promise<Result<T.PullsAutoMergeEnableOutput>>;
|
|
532
|
+
/**
|
|
533
|
+
* Show the diff of the pull request from a branch: the open one, else the newest closed or merged one.
|
|
534
|
+
*/
|
|
535
|
+
branchDiff(input: T.PullsBranchDiffInput, opts?: RequestOptions): Promise<T.PullsBranchDiffOutput>;
|
|
532
536
|
/**
|
|
533
537
|
* Show what a pull request's checks add up to: the CI jobs of the newest run of each workflow on its head, then the latest check run of each name and reporter. `waited` lets the verdict tell a first run that has not started from one that never will.
|
|
534
538
|
*/
|
|
@@ -549,6 +553,10 @@ export declare class PullsResource {
|
|
|
549
553
|
* Delete a comment on a pull request.
|
|
550
554
|
*/
|
|
551
555
|
deleteComment(input: T.PullsDeleteCommentInput, opts?: RequestOptions): Promise<T.PullsDeleteCommentOutput>;
|
|
556
|
+
/**
|
|
557
|
+
* Show what a pull request changes: the commits it adds and its diff against the merge base, with totals. A merged one answers the diff it merged. A signed-out visitor sees a public repository's.
|
|
558
|
+
*/
|
|
559
|
+
diff(input: T.PullsDiffInput, opts?: RequestOptions): Promise<T.PullsDiffOutput>;
|
|
552
560
|
/**
|
|
553
561
|
* Dismiss the reviews that approved or asked for changes on a pull request.
|
|
554
562
|
*/
|
|
@@ -557,6 +565,10 @@ export declare class PullsResource {
|
|
|
557
565
|
* Edit a comment on a pull request. `at` is the comment's timestamp, which keeps an edit from landing on another comment when the thread changed.
|
|
558
566
|
*/
|
|
559
567
|
editComment(input: T.PullsEditCommentInput, opts?: RequestOptions): Promise<T.PullsEditCommentOutput>;
|
|
568
|
+
/**
|
|
569
|
+
* List the pull requests whose commits include a commit, among the newest few hundred of any state.
|
|
570
|
+
*/
|
|
571
|
+
forCommit(input: T.PullsForCommitInput, opts?: RequestOptions): Promise<T.PullsForCommitOutput>;
|
|
560
572
|
/**
|
|
561
573
|
* Show a pull request with its threads, whether it merges cleanly and the merge rules it does not meet yet.
|
|
562
574
|
*/
|
|
@@ -591,6 +603,10 @@ export declare class PullsResource {
|
|
|
591
603
|
* Show the whole tree of pull requests a pull request belongs to, root first, depth first.
|
|
592
604
|
*/
|
|
593
605
|
stack(input: T.PullsStackInput, opts?: RequestOptions): Promise<T.PullsStackOutput>;
|
|
606
|
+
/**
|
|
607
|
+
* List the pull requests that change a file, or a folder when `path` ends in `/`, newest first. Only the newest few hundred pull requests of the chosen states are searched.
|
|
608
|
+
*/
|
|
609
|
+
touching(input: T.PullsTouchingInput, opts?: RequestOptions): Promise<T.PullsTouchingOutput>;
|
|
594
610
|
/**
|
|
595
611
|
* Edit a pull request: its title, description, state (close, reopen, mark ready or back to draft), reviewer, base or lock. Only the fields sent change.
|
|
596
612
|
*/
|
|
@@ -603,6 +619,18 @@ export declare class PullsResource {
|
|
|
603
619
|
export declare class ReposResource {
|
|
604
620
|
private readonly core;
|
|
605
621
|
constructor(core: Core);
|
|
622
|
+
/**
|
|
623
|
+
* Show a commit: its message, author, parent and child, and its changes as a diff of the first files in path order.
|
|
624
|
+
*/
|
|
625
|
+
commit(input: T.ReposCommitInput, opts?: RequestOptions): Promise<T.ReposCommitOutput>;
|
|
626
|
+
/**
|
|
627
|
+
* List the commits of a branch, tag or commit, newest first, or the history of one path with `path`. A signed-out visitor sees a public repository's.
|
|
628
|
+
*/
|
|
629
|
+
commits(input: T.ReposCommitsInput, opts?: RequestOptions): Promise<T.ReposCommitsOutput>;
|
|
630
|
+
/**
|
|
631
|
+
* Compare two branches, tags or commits: the commits `head` adds since their merge base and its diff. `spec` is `{base}...{head}`. A signed-out visitor sees a public repository's.
|
|
632
|
+
*/
|
|
633
|
+
compare(input: T.ReposCompareInput, opts?: RequestOptions): Promise<T.ReposCompareOutput>;
|
|
606
634
|
/**
|
|
607
635
|
* Create a repository for the caller, or in an org they belong to.
|
|
608
636
|
*/
|
|
@@ -903,6 +931,10 @@ export declare class PullRequest {
|
|
|
903
931
|
* Delete a comment on a pull request.
|
|
904
932
|
*/
|
|
905
933
|
deleteComment(input: Omit<T.PullsDeleteCommentInput, 'owner' | 'repo' | 'number'>, opts?: RequestOptions): Promise<T.PullsDeleteCommentOutput>;
|
|
934
|
+
/**
|
|
935
|
+
* Show what a pull request changes: the commits it adds and its diff against the merge base, with totals. A merged one answers the diff it merged. A signed-out visitor sees a public repository's.
|
|
936
|
+
*/
|
|
937
|
+
diff(input?: Omit<T.PullsDiffInput, 'owner' | 'repo' | 'number'>, opts?: RequestOptions): Promise<T.PullsDiffOutput>;
|
|
906
938
|
/**
|
|
907
939
|
* Dismiss the reviews that approved or asked for changes on a pull request.
|
|
908
940
|
*/
|
|
@@ -1234,19 +1266,43 @@ export declare class RepoPullsResource {
|
|
|
1234
1266
|
private readonly core;
|
|
1235
1267
|
private readonly bound;
|
|
1236
1268
|
constructor(core: Core, bound: RepoBound);
|
|
1269
|
+
/**
|
|
1270
|
+
* Show the diff of the pull request from a branch: the open one, else the newest closed or merged one.
|
|
1271
|
+
*/
|
|
1272
|
+
branchDiff(input: Omit<T.PullsBranchDiffInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.PullsBranchDiffOutput>;
|
|
1237
1273
|
/**
|
|
1238
1274
|
* Open a pull request from a branch into a base branch. Opening one for a branch that already has an open one answers 409.
|
|
1239
1275
|
*/
|
|
1240
1276
|
create(input: Omit<T.PullsCreateInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<PullRequest>;
|
|
1277
|
+
/**
|
|
1278
|
+
* List the pull requests whose commits include a commit, among the newest few hundred of any state.
|
|
1279
|
+
*/
|
|
1280
|
+
forCommit(input: Omit<T.PullsForCommitInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.PullsForCommitOutput>;
|
|
1241
1281
|
/**
|
|
1242
1282
|
* List a repository's pull requests, newest first. A signed-out visitor sees a public repository's.
|
|
1243
1283
|
*/
|
|
1244
1284
|
list(input?: Omit<T.PullsListInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.PullsListOutput>;
|
|
1285
|
+
/**
|
|
1286
|
+
* List the pull requests that change a file, or a folder when `path` ends in `/`, newest first. Only the newest few hundred pull requests of the chosen states are searched.
|
|
1287
|
+
*/
|
|
1288
|
+
touching(input: Omit<T.PullsTouchingInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.PullsTouchingOutput>;
|
|
1245
1289
|
}
|
|
1246
1290
|
export declare class RepoReposResource {
|
|
1247
1291
|
private readonly core;
|
|
1248
1292
|
private readonly bound;
|
|
1249
1293
|
constructor(core: Core, bound: RepoBound);
|
|
1294
|
+
/**
|
|
1295
|
+
* Show a commit: its message, author, parent and child, and its changes as a diff of the first files in path order.
|
|
1296
|
+
*/
|
|
1297
|
+
commit(input: Omit<T.ReposCommitInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.ReposCommitOutput>;
|
|
1298
|
+
/**
|
|
1299
|
+
* List the commits of a branch, tag or commit, newest first, or the history of one path with `path`. A signed-out visitor sees a public repository's.
|
|
1300
|
+
*/
|
|
1301
|
+
commits(input?: Omit<T.ReposCommitsInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.ReposCommitsOutput>;
|
|
1302
|
+
/**
|
|
1303
|
+
* Compare two branches, tags or commits: the commits `head` adds since their merge base and its diff. `spec` is `{base}...{head}`. A signed-out visitor sees a public repository's.
|
|
1304
|
+
*/
|
|
1305
|
+
compare(input: Omit<T.ReposCompareInput, 'owner' | 'repo'>, opts?: RequestOptions): Promise<T.ReposCompareOutput>;
|
|
1250
1306
|
/**
|
|
1251
1307
|
* Show a repository: description, visibility, default branch, branches, clone URLs and the caller's access (`read`, `write` or `admin`). A signed-out visitor reads a public repository. An old handle of a renamed owner answers 301 with the current address.
|
|
1252
1308
|
*/
|
|
@@ -2,4 +2,4 @@ export * from "./api.js";
|
|
|
2
2
|
export { type OpId, ops } from "./ops.js";
|
|
3
3
|
export * as tools from "./tools.js";
|
|
4
4
|
export type * as types from "./types.js";
|
|
5
|
-
export type { AffectedMode, AffectedStep, AgentTrackingState, Annotation, ApiError, Artifacts, AskKind, AskOptionInput, AutoMerge, BatchItem, BranchUpdated, CaissonAffected, CaissonAsk, CaissonAstMatch, CaissonAstMatches, CaissonBase, CaissonBashResult, CaissonBatchResult, CaissonChange, CaissonChangeRequest, CaissonChanged, CaissonCommitted, CaissonEdit, CaissonFileRead, CaissonFilesRead, CaissonGlob, CaissonGrep, CaissonGrepCount, CaissonGrepLine, CaissonGrepMatch, CaissonLocated, CaissonLspAnswer, CaissonLspPlace, CaissonLspProgress, CaissonLspQuestion, CaissonLspRenamed, CaissonLspStopped, CaissonPage, CaissonPolicy, CaissonPull, CaissonRefused, CaissonReview, CaissonReviewStatus, CaissonRow, CaissonShipped, CaissonTested, Check, CheckRun, CheckRunAction, CheckRunApp, CheckRunApp2, CheckRunBody, CheckRunBrief, CheckRunList, CheckRunOutput, CheckRunText, CheckSource, CheckState, CheckStep, ChecksState, Claim, CloneDefaults, CloneDefaultsEdit, CloseReason, CodeLine, CodeSnippet, CommentKind, CommentProof, ConflictFile, ConflictKind, ConflictResolution, ConflictSide, ConflictTake, ContextVisibility, CreatedIssue, Delegate, DelegateAsk, DelegateRequest, DeletionScheduled, DiffSide, EnvChain, EnvChainEntry, EnvDeviceRequest, EnvFile, EnvFileWrite, EnvFiles, EnvLog, EnvLogEntry, EnvPendingRemoval, EnvPerson, EnvRekeyFile, EnvRepo, EnvSigned, ErrorCode, ErrorLocation, Event, EventPage, EventSubscription, FailedStep, FileHit, FindingResolution, GithubInstallUrl, GithubInstallation, GithubRepo, GrepMode, Held, HeldDecided, HeldListing, HeldRequest, Hidden, HideReason, Inbox, InboxCounts, InboxItem, Issue, IssueAsk, IssueAskAnswer, IssueAskOption, IssueComment, IssueContext, IssueDetail, IssueEvent, IssuePage, IssuePriority, IssueStage, IssueStarted, IssueState, IssueStatus, ItemRef, KeyProof, Label, LabelItem, LabelList, MeUpdated, MergeMethod, Mergeable, Milestone, MilestoneItem, MilestoneList, MilestoneState, MyIssue, MyIssues, NoContent, Opener, PathHit, PathRule, Proof, ProofSource, Pull, PullChecks, PullComment, PullCommit, PullConflicts, PullDetail, PullFile, PullHunk, PullLine, PullMerge, PullPage, PullPatchState, PullThread, QueueBatch, QueueDropped, QueueEntry, QueueStatus, Reaction, Reaction2, ReactionKind, RecoveryCodeList, RefHit, RefHit2, RefResults, RefResults2, RelatedItem, RelatedKind, RelatedLink, RelatedWork, RepoHit, RepoInfo, RepoNote, RepoNoteLimits, RepoNotes, ReviewChange, ReviewComment, ReviewFinding, ReviewFindingInput, ReviewPacket, ReviewRisk, ReviewSince, ReviewSinceFinding, Rollup, Run, RunArtifact, RunCancelled, RunEvent, RunFailures, RunId, RunJob, RunLogPage, RunLogs, RunStep, RunStepLog, RunTests, RunWait, Runs, Sandbox, SandboxBackground, SandboxCaisson, SandboxClass, SandboxExecResult, SandboxHostRef, SandboxIdle, SandboxKind, SandboxOrigin, SandboxPage, SandboxTokenMode, SandboxUsage, SandboxWait, SearchResults, SessionStep, SimilarIssue, SimilarIssues, SkippedWorkflow, SshKey, StackEntry, StopMode, SubIssue, Surface, SymbolHit, SymbolHit2, SymbolResults, SymbolResults2, TestFailure, Token, TokenCreated, TotpSetup, Verdict, Visibility, WaitAnswer, WaitTarget, WorkspaceUnread } from "./types.js";
|
|
5
|
+
export type { AffectedMode, AffectedStep, AgentTrackingState, Annotation, ApiError, Artifacts, AskKind, AskOptionInput, AutoMerge, BatchItem, BranchUpdated, CaissonAffected, CaissonAsk, CaissonAstMatch, CaissonAstMatches, CaissonBase, CaissonBashResult, CaissonBatchResult, CaissonChange, CaissonChangeRequest, CaissonChanged, CaissonCommitted, CaissonEdit, CaissonFileRead, CaissonFilesRead, CaissonGlob, CaissonGrep, CaissonGrepCount, CaissonGrepLine, CaissonGrepMatch, CaissonLocated, CaissonLspAnswer, CaissonLspPlace, CaissonLspProgress, CaissonLspQuestion, CaissonLspRenamed, CaissonLspStopped, CaissonPage, CaissonPolicy, CaissonPull, CaissonRefused, CaissonReview, CaissonReviewStatus, CaissonRow, CaissonShipped, CaissonTested, Check, CheckRun, CheckRunAction, CheckRunApp, CheckRunApp2, CheckRunBody, CheckRunBrief, CheckRunList, CheckRunOutput, CheckRunText, CheckSource, CheckState, CheckStep, ChecksState, Claim, CloneDefaults, CloneDefaultsEdit, CloseReason, CodeLine, CodeSnippet, CommentKind, CommentProof, CommitLog, CommitPage, CommitRecord, CommitView, CompareAnswer, CompareFiles, CompareView, ConflictFile, ConflictKind, ConflictResolution, ConflictSide, ConflictTake, ContextVisibility, CreatedIssue, Delegate, DelegateAsk, DelegateRequest, DeletionScheduled, DiffHunk, DiffLine, DiffSide, DiffTotals, EnvChain, EnvChainEntry, EnvDeviceRequest, EnvFile, EnvFileWrite, EnvFiles, EnvLog, EnvLogEntry, EnvPendingRemoval, EnvPerson, EnvRekeyFile, EnvRepo, EnvSigned, ErrorCode, ErrorLocation, Event, EventPage, EventSubscription, FailedStep, FileDiff, FileHit, FindingResolution, GithubInstallUrl, GithubInstallation, GithubRepo, GrepMode, Held, HeldDecided, HeldListing, HeldRequest, Hidden, HideReason, Inbox, InboxCounts, InboxItem, Issue, IssueAsk, IssueAskAnswer, IssueAskOption, IssueComment, IssueContext, IssueDetail, IssueEvent, IssuePage, IssuePriority, IssueStage, IssueStarted, IssueState, IssueStatus, ItemRef, KeyProof, Label, LabelItem, LabelList, MeUpdated, MergeMethod, Mergeable, Milestone, MilestoneItem, MilestoneList, MilestoneState, MyIssue, MyIssues, NoContent, Opener, PathHit, PathRule, Proof, ProofSource, Pull, PullChecks, PullComment, PullCommit, PullConflicts, PullDetail, PullDiff, PullFile, PullHunk, PullItems, PullLine, PullMerge, PullPage, PullPatchState, PullThread, QueueBatch, QueueDropped, QueueEntry, QueueStatus, Reaction, Reaction2, ReactionKind, RecoveryCodeList, RefHit, RefHit2, RefResults, RefResults2, RelatedItem, RelatedKind, RelatedLink, RelatedWork, RepoHit, RepoInfo, RepoNote, RepoNoteLimits, RepoNotes, ReviewChange, ReviewComment, ReviewFinding, ReviewFindingInput, ReviewPacket, ReviewRisk, ReviewSince, ReviewSinceFinding, Rollup, Run, RunArtifact, RunCancelled, RunEvent, RunFailures, RunId, RunJob, RunLogPage, RunLogs, RunStep, RunStepLog, RunTests, RunWait, Runs, Sandbox, SandboxBackground, SandboxCaisson, SandboxClass, SandboxExecResult, SandboxHostRef, SandboxIdle, SandboxKind, SandboxOrigin, SandboxPage, SandboxTokenMode, SandboxUsage, SandboxWait, SearchResults, SessionStep, SimilarIssue, SimilarIssues, SkippedWorkflow, SshKey, StackEntry, StopMode, SubIssue, Surface, SymbolHit, SymbolHit2, SymbolResults, SymbolResults2, TestFailure, Token, TokenCreated, TotpSetup, TouchingState, Verdict, Visibility, WaitAnswer, WaitTarget, WorkspaceUnread } from "./types.js";
|
|
@@ -1481,6 +1481,19 @@ export declare const ops: {
|
|
|
1481
1481
|
long: false;
|
|
1482
1482
|
paginated: false;
|
|
1483
1483
|
};
|
|
1484
|
+
'pulls.branch_diff': {
|
|
1485
|
+
id: string;
|
|
1486
|
+
method: 'GET';
|
|
1487
|
+
path: string;
|
|
1488
|
+
pathParams: string[];
|
|
1489
|
+
queryParams: string[];
|
|
1490
|
+
bodyParams: never[];
|
|
1491
|
+
effect: 'read';
|
|
1492
|
+
retry: 'safe';
|
|
1493
|
+
held: false;
|
|
1494
|
+
long: false;
|
|
1495
|
+
paginated: false;
|
|
1496
|
+
};
|
|
1484
1497
|
'pulls.checks': {
|
|
1485
1498
|
id: string;
|
|
1486
1499
|
method: 'GET';
|
|
@@ -1546,6 +1559,19 @@ export declare const ops: {
|
|
|
1546
1559
|
long: false;
|
|
1547
1560
|
paginated: false;
|
|
1548
1561
|
};
|
|
1562
|
+
'pulls.diff': {
|
|
1563
|
+
id: string;
|
|
1564
|
+
method: 'GET';
|
|
1565
|
+
path: string;
|
|
1566
|
+
pathParams: string[];
|
|
1567
|
+
queryParams: string[];
|
|
1568
|
+
bodyParams: never[];
|
|
1569
|
+
effect: 'read';
|
|
1570
|
+
retry: 'safe';
|
|
1571
|
+
held: false;
|
|
1572
|
+
long: false;
|
|
1573
|
+
paginated: false;
|
|
1574
|
+
};
|
|
1549
1575
|
'pulls.dismiss': {
|
|
1550
1576
|
id: string;
|
|
1551
1577
|
method: 'POST';
|
|
@@ -1572,6 +1598,19 @@ export declare const ops: {
|
|
|
1572
1598
|
long: false;
|
|
1573
1599
|
paginated: false;
|
|
1574
1600
|
};
|
|
1601
|
+
'pulls.for_commit': {
|
|
1602
|
+
id: string;
|
|
1603
|
+
method: 'GET';
|
|
1604
|
+
path: string;
|
|
1605
|
+
pathParams: string[];
|
|
1606
|
+
queryParams: never[];
|
|
1607
|
+
bodyParams: never[];
|
|
1608
|
+
effect: 'read';
|
|
1609
|
+
retry: 'safe';
|
|
1610
|
+
held: false;
|
|
1611
|
+
long: false;
|
|
1612
|
+
paginated: false;
|
|
1613
|
+
};
|
|
1575
1614
|
'pulls.get': {
|
|
1576
1615
|
id: string;
|
|
1577
1616
|
method: 'GET';
|
|
@@ -1676,6 +1715,19 @@ export declare const ops: {
|
|
|
1676
1715
|
long: false;
|
|
1677
1716
|
paginated: false;
|
|
1678
1717
|
};
|
|
1718
|
+
'pulls.touching': {
|
|
1719
|
+
id: string;
|
|
1720
|
+
method: 'GET';
|
|
1721
|
+
path: string;
|
|
1722
|
+
pathParams: string[];
|
|
1723
|
+
queryParams: string[];
|
|
1724
|
+
bodyParams: never[];
|
|
1725
|
+
effect: 'read';
|
|
1726
|
+
retry: 'safe';
|
|
1727
|
+
held: false;
|
|
1728
|
+
long: false;
|
|
1729
|
+
paginated: false;
|
|
1730
|
+
};
|
|
1679
1731
|
'pulls.update': {
|
|
1680
1732
|
id: string;
|
|
1681
1733
|
method: 'PATCH';
|
|
@@ -1702,6 +1754,45 @@ export declare const ops: {
|
|
|
1702
1754
|
long: false;
|
|
1703
1755
|
paginated: false;
|
|
1704
1756
|
};
|
|
1757
|
+
'repos.commit': {
|
|
1758
|
+
id: string;
|
|
1759
|
+
method: 'GET';
|
|
1760
|
+
path: string;
|
|
1761
|
+
pathParams: string[];
|
|
1762
|
+
queryParams: never[];
|
|
1763
|
+
bodyParams: never[];
|
|
1764
|
+
effect: 'read';
|
|
1765
|
+
retry: 'safe';
|
|
1766
|
+
held: false;
|
|
1767
|
+
long: false;
|
|
1768
|
+
paginated: false;
|
|
1769
|
+
};
|
|
1770
|
+
'repos.commits': {
|
|
1771
|
+
id: string;
|
|
1772
|
+
method: 'GET';
|
|
1773
|
+
path: string;
|
|
1774
|
+
pathParams: string[];
|
|
1775
|
+
queryParams: string[];
|
|
1776
|
+
bodyParams: never[];
|
|
1777
|
+
effect: 'read';
|
|
1778
|
+
retry: 'safe';
|
|
1779
|
+
held: false;
|
|
1780
|
+
long: false;
|
|
1781
|
+
paginated: false;
|
|
1782
|
+
};
|
|
1783
|
+
'repos.compare': {
|
|
1784
|
+
id: string;
|
|
1785
|
+
method: 'GET';
|
|
1786
|
+
path: string;
|
|
1787
|
+
pathParams: string[];
|
|
1788
|
+
queryParams: string[];
|
|
1789
|
+
bodyParams: never[];
|
|
1790
|
+
effect: 'read';
|
|
1791
|
+
retry: 'safe';
|
|
1792
|
+
held: false;
|
|
1793
|
+
long: false;
|
|
1794
|
+
paginated: false;
|
|
1795
|
+
};
|
|
1705
1796
|
'repos.create': {
|
|
1706
1797
|
id: string;
|
|
1707
1798
|
method: 'POST';
|