@tomsd/github-repo-js 0.2.2 → 0.2.3

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.
Files changed (41) hide show
  1. package/README.md +3 -3
  2. package/dist/index.d.ts +443 -5094
  3. package/dist/index.iife.js +1 -0
  4. package/dist/index.mjs +1 -0
  5. package/dist/modules/base.d.ts +31 -0
  6. package/dist/modules/blob.d.ts +68 -0
  7. package/dist/modules/blobs.d.ts +67 -0
  8. package/dist/modules/github-classes.d.ts +4647 -0
  9. package/dist/modules/issue-comments.d.ts +101 -0
  10. package/dist/modules/issue.d.ts +330 -0
  11. package/dist/modules/my-issues.d.ts +289 -0
  12. package/dist/modules/organization-audit-log.d.ts +22 -0
  13. package/dist/modules/organization-repositories.d.ts +591 -0
  14. package/dist/modules/pull-commits.d.ts +177 -0
  15. package/dist/modules/pull-reviewers.d.ts +41 -0
  16. package/dist/modules/reference-get.d.ts +67 -0
  17. package/dist/modules/reference.d.ts +73 -0
  18. package/dist/modules/repository-artifact.d.ts +118 -0
  19. package/dist/modules/repository-artifacts.d.ts +118 -0
  20. package/dist/modules/repository-branch.d.ts +82 -0
  21. package/dist/modules/repository-branches.d.ts +66 -0
  22. package/dist/modules/repository-commits.d.ts +211 -0
  23. package/dist/modules/repository-issues.d.ts +317 -0
  24. package/dist/modules/repository-latest-release.d.ts +21 -0
  25. package/dist/modules/repository-pull.d.ts +458 -0
  26. package/dist/modules/repository-pulls.d.ts +369 -0
  27. package/dist/modules/repository-references.d.ts +82 -0
  28. package/dist/modules/repository-releases.d.ts +171 -0
  29. package/dist/modules/repository-runs.d.ts +206 -0
  30. package/dist/modules/repository-trees.d.ts +99 -0
  31. package/dist/modules/repository.d.ts +2267 -0
  32. package/dist/modules/tree.d.ts +82 -0
  33. package/dist/modules/user-organizations.d.ts +84 -0
  34. package/dist/modules/user-repositories.d.ts +597 -0
  35. package/dist/modules/user.d.ts +500 -0
  36. package/dist/repl.mjs +4 -0
  37. package/dist/utils/index.d.ts +6 -0
  38. package/package.json +6 -6
  39. package/dist/index.global.js +0 -1
  40. package/dist/index.js +0 -1
  41. package/dist/repl.js +0 -4
@@ -0,0 +1,458 @@
1
+ export declare function readyGitHubRepositoryPull(token: string): {
2
+ new (owner: string, repo: string, pullNumber: number): {
3
+ get apiEndpoint(): string;
4
+ getCommits(): Promise<{
5
+ url: string;
6
+ sha: string;
7
+ node_id: string;
8
+ html_url: string;
9
+ comments_url: string;
10
+ commit: {
11
+ url: string;
12
+ author: import("@octokit/openapi-types").components["schemas"]["nullable-git-user"];
13
+ committer: import("@octokit/openapi-types").components["schemas"]["nullable-git-user"];
14
+ message: string;
15
+ comment_count: number;
16
+ tree: {
17
+ sha: string;
18
+ url: string;
19
+ };
20
+ verification?: import("@octokit/openapi-types").components["schemas"]["verification"];
21
+ };
22
+ author: import("@octokit/openapi-types").components["schemas"]["simple-user"] | import("@octokit/openapi-types").components["schemas"]["empty-object"] | null;
23
+ committer: import("@octokit/openapi-types").components["schemas"]["simple-user"] | import("@octokit/openapi-types").components["schemas"]["empty-object"] | null;
24
+ parents: {
25
+ sha: string;
26
+ url: string;
27
+ html_url?: string;
28
+ }[];
29
+ stats?: {
30
+ additions?: number;
31
+ deletions?: number;
32
+ total?: number;
33
+ };
34
+ files?: import("@octokit/openapi-types").components["schemas"]["diff-entry"][];
35
+ }[]>;
36
+ getReviewers(): Promise<{
37
+ users: import("@octokit/openapi-types").components["schemas"]["simple-user"][];
38
+ teams: import("@octokit/openapi-types").components["schemas"]["team"][];
39
+ }>;
40
+ postReviewers(body: {
41
+ data: never;
42
+ }): Promise<{
43
+ users: import("@octokit/openapi-types").components["schemas"]["simple-user"][];
44
+ teams: import("@octokit/openapi-types").components["schemas"]["team"][];
45
+ }>;
46
+ pullNumber: number;
47
+ owner: string;
48
+ repo: string;
49
+ token: string;
50
+ get apiOrigin(): string;
51
+ get requestHeaders(): {
52
+ accept: string;
53
+ authorization: string;
54
+ "X-GitHub-Api-Version": string;
55
+ };
56
+ get pageSizeForRequest(): number;
57
+ getPagedList(query?: Record<string, string>): Promise<{
58
+ url: string;
59
+ id: number;
60
+ node_id: string;
61
+ html_url: string;
62
+ diff_url: string;
63
+ patch_url: string;
64
+ issue_url: string;
65
+ commits_url: string;
66
+ review_comments_url: string;
67
+ review_comment_url: string;
68
+ comments_url: string;
69
+ statuses_url: string;
70
+ number: number;
71
+ state: "open" | "closed";
72
+ locked: boolean;
73
+ title: string;
74
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
75
+ body: string | null;
76
+ labels: {
77
+ id: number;
78
+ node_id: string;
79
+ url: string;
80
+ name: string;
81
+ description: string | null;
82
+ color: string;
83
+ default: boolean;
84
+ }[];
85
+ milestone: import("@octokit/openapi-types").components["schemas"]["nullable-milestone"];
86
+ active_lock_reason?: string | null;
87
+ created_at: string;
88
+ updated_at: string;
89
+ closed_at: string | null;
90
+ merged_at: string | null;
91
+ merge_commit_sha: string | null;
92
+ assignee: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
93
+ assignees?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
94
+ requested_reviewers?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
95
+ requested_teams?: import("@octokit/openapi-types").components["schemas"]["team-simple"][] | null;
96
+ head: {
97
+ label: string;
98
+ ref: string;
99
+ repo: import("@octokit/openapi-types").components["schemas"]["repository"];
100
+ sha: string;
101
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
102
+ };
103
+ base: {
104
+ label: string;
105
+ ref: string;
106
+ repo: import("@octokit/openapi-types").components["schemas"]["repository"];
107
+ sha: string;
108
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
109
+ };
110
+ _links: {
111
+ comments: import("@octokit/openapi-types").components["schemas"]["link"];
112
+ commits: import("@octokit/openapi-types").components["schemas"]["link"];
113
+ statuses: import("@octokit/openapi-types").components["schemas"]["link"];
114
+ html: import("@octokit/openapi-types").components["schemas"]["link"];
115
+ issue: import("@octokit/openapi-types").components["schemas"]["link"];
116
+ review_comments: import("@octokit/openapi-types").components["schemas"]["link"];
117
+ review_comment: import("@octokit/openapi-types").components["schemas"]["link"];
118
+ self: import("@octokit/openapi-types").components["schemas"]["link"];
119
+ };
120
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
121
+ auto_merge: import("@octokit/openapi-types").components["schemas"]["auto-merge"];
122
+ draft?: boolean;
123
+ merged: boolean;
124
+ mergeable: boolean | null;
125
+ rebaseable?: boolean | null;
126
+ mergeable_state: string;
127
+ merged_by: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
128
+ comments: number;
129
+ review_comments: number;
130
+ maintainer_can_modify: boolean;
131
+ commits: number;
132
+ additions: number;
133
+ deletions: number;
134
+ changed_files: number;
135
+ }[]>;
136
+ getList(query?: Record<string, string>): Promise<{
137
+ url: string;
138
+ id: number;
139
+ node_id: string;
140
+ html_url: string;
141
+ diff_url: string;
142
+ patch_url: string;
143
+ issue_url: string;
144
+ commits_url: string;
145
+ review_comments_url: string;
146
+ review_comment_url: string;
147
+ comments_url: string;
148
+ statuses_url: string;
149
+ number: number;
150
+ state: "open" | "closed";
151
+ locked: boolean;
152
+ title: string;
153
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
154
+ body: string | null;
155
+ labels: {
156
+ id: number;
157
+ node_id: string;
158
+ url: string;
159
+ name: string;
160
+ description: string | null;
161
+ color: string;
162
+ default: boolean;
163
+ }[];
164
+ milestone: import("@octokit/openapi-types").components["schemas"]["nullable-milestone"];
165
+ active_lock_reason?: string | null;
166
+ created_at: string;
167
+ updated_at: string;
168
+ closed_at: string | null;
169
+ merged_at: string | null;
170
+ merge_commit_sha: string | null;
171
+ assignee: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
172
+ assignees?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
173
+ requested_reviewers?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
174
+ requested_teams?: import("@octokit/openapi-types").components["schemas"]["team-simple"][] | null;
175
+ head: {
176
+ label: string;
177
+ ref: string;
178
+ repo: import("@octokit/openapi-types").components["schemas"]["repository"];
179
+ sha: string;
180
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
181
+ };
182
+ base: {
183
+ label: string;
184
+ ref: string;
185
+ repo: import("@octokit/openapi-types").components["schemas"]["repository"];
186
+ sha: string;
187
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
188
+ };
189
+ _links: {
190
+ comments: import("@octokit/openapi-types").components["schemas"]["link"];
191
+ commits: import("@octokit/openapi-types").components["schemas"]["link"];
192
+ statuses: import("@octokit/openapi-types").components["schemas"]["link"];
193
+ html: import("@octokit/openapi-types").components["schemas"]["link"];
194
+ issue: import("@octokit/openapi-types").components["schemas"]["link"];
195
+ review_comments: import("@octokit/openapi-types").components["schemas"]["link"];
196
+ review_comment: import("@octokit/openapi-types").components["schemas"]["link"];
197
+ self: import("@octokit/openapi-types").components["schemas"]["link"];
198
+ };
199
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
200
+ auto_merge: import("@octokit/openapi-types").components["schemas"]["auto-merge"];
201
+ draft?: boolean;
202
+ merged: boolean;
203
+ mergeable: boolean | null;
204
+ rebaseable?: boolean | null;
205
+ mergeable_state: string;
206
+ merged_by: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
207
+ comments: number;
208
+ review_comments: number;
209
+ maintainer_can_modify: boolean;
210
+ commits: number;
211
+ additions: number;
212
+ deletions: number;
213
+ changed_files: number;
214
+ }[]>;
215
+ get(): Promise<{
216
+ url: string;
217
+ id: number;
218
+ node_id: string;
219
+ html_url: string;
220
+ diff_url: string;
221
+ patch_url: string;
222
+ issue_url: string;
223
+ commits_url: string;
224
+ review_comments_url: string;
225
+ review_comment_url: string;
226
+ comments_url: string;
227
+ statuses_url: string;
228
+ number: number;
229
+ state: "open" | "closed";
230
+ locked: boolean;
231
+ title: string;
232
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
233
+ body: string | null;
234
+ labels: {
235
+ id: number;
236
+ node_id: string;
237
+ url: string;
238
+ name: string;
239
+ description: string | null;
240
+ color: string;
241
+ default: boolean;
242
+ }[];
243
+ milestone: import("@octokit/openapi-types").components["schemas"]["nullable-milestone"];
244
+ active_lock_reason?: string | null;
245
+ created_at: string;
246
+ updated_at: string;
247
+ closed_at: string | null;
248
+ merged_at: string | null;
249
+ merge_commit_sha: string | null;
250
+ assignee: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
251
+ assignees?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
252
+ requested_reviewers?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
253
+ requested_teams?: import("@octokit/openapi-types").components["schemas"]["team-simple"][] | null;
254
+ head: {
255
+ label: string;
256
+ ref: string;
257
+ repo: import("@octokit/openapi-types").components["schemas"]["repository"];
258
+ sha: string;
259
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
260
+ };
261
+ base: {
262
+ label: string;
263
+ ref: string;
264
+ repo: import("@octokit/openapi-types").components["schemas"]["repository"];
265
+ sha: string;
266
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
267
+ };
268
+ _links: {
269
+ comments: import("@octokit/openapi-types").components["schemas"]["link"];
270
+ commits: import("@octokit/openapi-types").components["schemas"]["link"];
271
+ statuses: import("@octokit/openapi-types").components["schemas"]["link"];
272
+ html: import("@octokit/openapi-types").components["schemas"]["link"];
273
+ issue: import("@octokit/openapi-types").components["schemas"]["link"];
274
+ review_comments: import("@octokit/openapi-types").components["schemas"]["link"];
275
+ review_comment: import("@octokit/openapi-types").components["schemas"]["link"];
276
+ self: import("@octokit/openapi-types").components["schemas"]["link"];
277
+ };
278
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
279
+ auto_merge: import("@octokit/openapi-types").components["schemas"]["auto-merge"];
280
+ draft?: boolean;
281
+ merged: boolean;
282
+ mergeable: boolean | null;
283
+ rebaseable?: boolean | null;
284
+ mergeable_state: string;
285
+ merged_by: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
286
+ comments: number;
287
+ review_comments: number;
288
+ maintainer_can_modify: boolean;
289
+ commits: number;
290
+ additions: number;
291
+ deletions: number;
292
+ changed_files: number;
293
+ }>;
294
+ post(body: {
295
+ data: never;
296
+ }): Promise<{
297
+ url: string;
298
+ id: number;
299
+ node_id: string;
300
+ html_url: string;
301
+ diff_url: string;
302
+ patch_url: string;
303
+ issue_url: string;
304
+ commits_url: string;
305
+ review_comments_url: string;
306
+ review_comment_url: string;
307
+ comments_url: string;
308
+ statuses_url: string;
309
+ number: number;
310
+ state: "open" | "closed";
311
+ locked: boolean;
312
+ title: string;
313
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
314
+ body: string | null;
315
+ labels: {
316
+ id: number;
317
+ node_id: string;
318
+ url: string;
319
+ name: string;
320
+ description: string | null;
321
+ color: string;
322
+ default: boolean;
323
+ }[];
324
+ milestone: import("@octokit/openapi-types").components["schemas"]["nullable-milestone"];
325
+ active_lock_reason?: string | null;
326
+ created_at: string;
327
+ updated_at: string;
328
+ closed_at: string | null;
329
+ merged_at: string | null;
330
+ merge_commit_sha: string | null;
331
+ assignee: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
332
+ assignees?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
333
+ requested_reviewers?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
334
+ requested_teams?: import("@octokit/openapi-types").components["schemas"]["team-simple"][] | null;
335
+ head: {
336
+ label: string;
337
+ ref: string;
338
+ repo: import("@octokit/openapi-types").components["schemas"]["repository"];
339
+ sha: string;
340
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
341
+ };
342
+ base: {
343
+ label: string;
344
+ ref: string;
345
+ repo: import("@octokit/openapi-types").components["schemas"]["repository"];
346
+ sha: string;
347
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
348
+ };
349
+ _links: {
350
+ comments: import("@octokit/openapi-types").components["schemas"]["link"];
351
+ commits: import("@octokit/openapi-types").components["schemas"]["link"];
352
+ statuses: import("@octokit/openapi-types").components["schemas"]["link"];
353
+ html: import("@octokit/openapi-types").components["schemas"]["link"];
354
+ issue: import("@octokit/openapi-types").components["schemas"]["link"];
355
+ review_comments: import("@octokit/openapi-types").components["schemas"]["link"];
356
+ review_comment: import("@octokit/openapi-types").components["schemas"]["link"];
357
+ self: import("@octokit/openapi-types").components["schemas"]["link"];
358
+ };
359
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
360
+ auto_merge: import("@octokit/openapi-types").components["schemas"]["auto-merge"];
361
+ draft?: boolean;
362
+ merged: boolean;
363
+ mergeable: boolean | null;
364
+ rebaseable?: boolean | null;
365
+ mergeable_state: string;
366
+ merged_by: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
367
+ comments: number;
368
+ review_comments: number;
369
+ maintainer_can_modify: boolean;
370
+ commits: number;
371
+ additions: number;
372
+ deletions: number;
373
+ changed_files: number;
374
+ }>;
375
+ patch(body: {
376
+ data: never;
377
+ }): Promise<{
378
+ url: string;
379
+ id: number;
380
+ node_id: string;
381
+ html_url: string;
382
+ diff_url: string;
383
+ patch_url: string;
384
+ issue_url: string;
385
+ commits_url: string;
386
+ review_comments_url: string;
387
+ review_comment_url: string;
388
+ comments_url: string;
389
+ statuses_url: string;
390
+ number: number;
391
+ state: "open" | "closed";
392
+ locked: boolean;
393
+ title: string;
394
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
395
+ body: string | null;
396
+ labels: {
397
+ id: number;
398
+ node_id: string;
399
+ url: string;
400
+ name: string;
401
+ description: string | null;
402
+ color: string;
403
+ default: boolean;
404
+ }[];
405
+ milestone: import("@octokit/openapi-types").components["schemas"]["nullable-milestone"];
406
+ active_lock_reason?: string | null;
407
+ created_at: string;
408
+ updated_at: string;
409
+ closed_at: string | null;
410
+ merged_at: string | null;
411
+ merge_commit_sha: string | null;
412
+ assignee: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
413
+ assignees?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
414
+ requested_reviewers?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
415
+ requested_teams?: import("@octokit/openapi-types").components["schemas"]["team-simple"][] | null;
416
+ head: {
417
+ label: string;
418
+ ref: string;
419
+ repo: import("@octokit/openapi-types").components["schemas"]["repository"];
420
+ sha: string;
421
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
422
+ };
423
+ base: {
424
+ label: string;
425
+ ref: string;
426
+ repo: import("@octokit/openapi-types").components["schemas"]["repository"];
427
+ sha: string;
428
+ user: import("@octokit/openapi-types").components["schemas"]["simple-user"];
429
+ };
430
+ _links: {
431
+ comments: import("@octokit/openapi-types").components["schemas"]["link"];
432
+ commits: import("@octokit/openapi-types").components["schemas"]["link"];
433
+ statuses: import("@octokit/openapi-types").components["schemas"]["link"];
434
+ html: import("@octokit/openapi-types").components["schemas"]["link"];
435
+ issue: import("@octokit/openapi-types").components["schemas"]["link"];
436
+ review_comments: import("@octokit/openapi-types").components["schemas"]["link"];
437
+ review_comment: import("@octokit/openapi-types").components["schemas"]["link"];
438
+ self: import("@octokit/openapi-types").components["schemas"]["link"];
439
+ };
440
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
441
+ auto_merge: import("@octokit/openapi-types").components["schemas"]["auto-merge"];
442
+ draft?: boolean;
443
+ merged: boolean;
444
+ mergeable: boolean | null;
445
+ rebaseable?: boolean | null;
446
+ mergeable_state: string;
447
+ merged_by: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
448
+ comments: number;
449
+ review_comments: number;
450
+ maintainer_can_modify: boolean;
451
+ commits: number;
452
+ additions: number;
453
+ deletions: number;
454
+ changed_files: number;
455
+ }>;
456
+ delete(): Promise<void>;
457
+ };
458
+ };