@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
package/dist/modules/issue-comments.d.ts ADDED
@@ -0,0 +1,101 @@
1
+ export declare function readyGitHubIssueComments(token: string): {
2
+ new (owner: string, repo: string, issueNumber: number): {
3
+ get apiEndpoint(): string;
4
+ get pageSizeForRequest(): number;
5
+ getList(query?: Record<string, string>): Promise<{
6
+ id: number;
7
+ node_id: string;
8
+ url: string;
9
+ body?: string;
10
+ body_text?: string;
11
+ body_html?: string;
12
+ html_url: string;
13
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
14
+ created_at: string;
15
+ updated_at: string;
16
+ issue_url: string;
17
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
18
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
19
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
20
+ }[]>;
21
+ issueNumber: number;
22
+ owner: string;
23
+ repo: string;
24
+ token: string;
25
+ get apiOrigin(): string;
26
+ get requestHeaders(): {
27
+ accept: string;
28
+ authorization: string;
29
+ "X-GitHub-Api-Version": string;
30
+ };
31
+ getPagedList(query?: Record<string, string>): Promise<{
32
+ id: number;
33
+ node_id: string;
34
+ url: string;
35
+ body?: string;
36
+ body_text?: string;
37
+ body_html?: string;
38
+ html_url: string;
39
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
40
+ created_at: string;
41
+ updated_at: string;
42
+ issue_url: string;
43
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
44
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
45
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
46
+ }[]>;
47
+ get(): Promise<{
48
+ id: number;
49
+ node_id: string;
50
+ url: string;
51
+ body?: string;
52
+ body_text?: string;
53
+ body_html?: string;
54
+ html_url: string;
55
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
56
+ created_at: string;
57
+ updated_at: string;
58
+ issue_url: string;
59
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
60
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
61
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
62
+ }>;
63
+ post(body: {
64
+ body: string;
65
+ }): Promise<{
66
+ id: number;
67
+ node_id: string;
68
+ url: string;
69
+ body?: string;
70
+ body_text?: string;
71
+ body_html?: string;
72
+ html_url: string;
73
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
74
+ created_at: string;
75
+ updated_at: string;
76
+ issue_url: string;
77
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
78
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
79
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
80
+ }>;
81
+ patch(body: {
82
+ body: string;
83
+ }): Promise<{
84
+ id: number;
85
+ node_id: string;
86
+ url: string;
87
+ body?: string;
88
+ body_text?: string;
89
+ body_html?: string;
90
+ html_url: string;
91
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
92
+ created_at: string;
93
+ updated_at: string;
94
+ issue_url: string;
95
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
96
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
97
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
98
+ }>;
99
+ delete(): Promise<void>;
100
+ };
101
+ };
package/dist/modules/issue.d.ts ADDED
@@ -0,0 +1,330 @@
1
+ export declare function readyGitHubIssue(token: string): {
2
+ new (owner: string, repo: string, issueNumber: number): {
3
+ get apiEndpoint(): string;
4
+ getComments(): Promise<{
5
+ id: number;
6
+ node_id: string;
7
+ url: string;
8
+ body?: string;
9
+ body_text?: string;
10
+ body_html?: string;
11
+ html_url: string;
12
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
13
+ created_at: string;
14
+ updated_at: string;
15
+ issue_url: string;
16
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
17
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
18
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
19
+ }[]>;
20
+ postComment(body: {
21
+ body: string;
22
+ }): Promise<{
23
+ id: number;
24
+ node_id: string;
25
+ url: string;
26
+ body?: string;
27
+ body_text?: string;
28
+ body_html?: string;
29
+ html_url: string;
30
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
31
+ created_at: string;
32
+ updated_at: string;
33
+ issue_url: string;
34
+ author_association: import("@octokit/openapi-types").components["schemas"]["author-association"];
35
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
36
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
37
+ }>;
38
+ issueNumber: number;
39
+ owner: string;
40
+ repo: string;
41
+ token: string;
42
+ get apiOrigin(): string;
43
+ get requestHeaders(): {
44
+ accept: string;
45
+ authorization: string;
46
+ "X-GitHub-Api-Version": string;
47
+ };
48
+ get pageSizeForRequest(): number;
49
+ getPagedList(query?: Record<string, string>): Promise<{
50
+ id: number;
51
+ node_id: string;
52
+ url: string;
53
+ repository_url: string;
54
+ labels_url: string;
55
+ comments_url: string;
56
+ events_url: string;
57
+ html_url: string;
58
+ number: number;
59
+ state: string;
60
+ state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null;
61
+ title: string;
62
+ body?: string | null;
63
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
64
+ labels: import("@octokit/openapi-types").OneOf<[string, {
65
+ id?: number;
66
+ node_id?: string;
67
+ url?: string;
68
+ name?: string;
69
+ description?: string | null;
70
+ color?: string | null;
71
+ default?: boolean;
72
+ }]>[];
73
+ assignee: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
74
+ assignees?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
75
+ milestone: import("@octokit/openapi-types").components["schemas"]["nullable-milestone"];
76
+ locked: boolean;
77
+ active_lock_reason?: string | null;
78
+ comments: number;
79
+ pull_request?: {
80
+ merged_at?: string | null;
81
+ diff_url: string | null;
82
+ html_url: string | null;
83
+ patch_url: string | null;
84
+ url: string | null;
85
+ };
86
+ closed_at: string | null;
87
+ created_at: string;
88
+ updated_at: string;
89
+ draft?: boolean;
90
+ closed_by?: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
91
+ body_html?: string;
92
+ body_text?: string;
93
+ timeline_url?: string;
94
+ type?: import("@octokit/openapi-types").components["schemas"]["issue-type"];
95
+ repository?: import("@octokit/openapi-types").components["schemas"]["repository"];
96
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
97
+ author_association?: import("@octokit/openapi-types").components["schemas"]["author-association"];
98
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
99
+ sub_issues_summary?: import("@octokit/openapi-types").components["schemas"]["sub-issues-summary"];
100
+ parent_issue_url?: string | null;
101
+ issue_dependencies_summary?: import("@octokit/openapi-types").components["schemas"]["issue-dependencies-summary"];
102
+ issue_field_values?: import("@octokit/openapi-types").components["schemas"]["issue-field-value"][];
103
+ }[]>;
104
+ getList(query?: Record<string, string>): Promise<{
105
+ id: number;
106
+ node_id: string;
107
+ url: string;
108
+ repository_url: string;
109
+ labels_url: string;
110
+ comments_url: string;
111
+ events_url: string;
112
+ html_url: string;
113
+ number: number;
114
+ state: string;
115
+ state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null;
116
+ title: string;
117
+ body?: string | null;
118
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
119
+ labels: import("@octokit/openapi-types").OneOf<[string, {
120
+ id?: number;
121
+ node_id?: string;
122
+ url?: string;
123
+ name?: string;
124
+ description?: string | null;
125
+ color?: string | null;
126
+ default?: boolean;
127
+ }]>[];
128
+ assignee: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
129
+ assignees?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
130
+ milestone: import("@octokit/openapi-types").components["schemas"]["nullable-milestone"];
131
+ locked: boolean;
132
+ active_lock_reason?: string | null;
133
+ comments: number;
134
+ pull_request?: {
135
+ merged_at?: string | null;
136
+ diff_url: string | null;
137
+ html_url: string | null;
138
+ patch_url: string | null;
139
+ url: string | null;
140
+ };
141
+ closed_at: string | null;
142
+ created_at: string;
143
+ updated_at: string;
144
+ draft?: boolean;
145
+ closed_by?: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
146
+ body_html?: string;
147
+ body_text?: string;
148
+ timeline_url?: string;
149
+ type?: import("@octokit/openapi-types").components["schemas"]["issue-type"];
150
+ repository?: import("@octokit/openapi-types").components["schemas"]["repository"];
151
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
152
+ author_association?: import("@octokit/openapi-types").components["schemas"]["author-association"];
153
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
154
+ sub_issues_summary?: import("@octokit/openapi-types").components["schemas"]["sub-issues-summary"];
155
+ parent_issue_url?: string | null;
156
+ issue_dependencies_summary?: import("@octokit/openapi-types").components["schemas"]["issue-dependencies-summary"];
157
+ issue_field_values?: import("@octokit/openapi-types").components["schemas"]["issue-field-value"][];
158
+ }[]>;
159
+ get(): Promise<{
160
+ id: number;
161
+ node_id: string;
162
+ url: string;
163
+ repository_url: string;
164
+ labels_url: string;
165
+ comments_url: string;
166
+ events_url: string;
167
+ html_url: string;
168
+ number: number;
169
+ state: string;
170
+ state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null;
171
+ title: string;
172
+ body?: string | null;
173
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
174
+ labels: import("@octokit/openapi-types").OneOf<[string, {
175
+ id?: number;
176
+ node_id?: string;
177
+ url?: string;
178
+ name?: string;
179
+ description?: string | null;
180
+ color?: string | null;
181
+ default?: boolean;
182
+ }]>[];
183
+ assignee: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
184
+ assignees?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
185
+ milestone: import("@octokit/openapi-types").components["schemas"]["nullable-milestone"];
186
+ locked: boolean;
187
+ active_lock_reason?: string | null;
188
+ comments: number;
189
+ pull_request?: {
190
+ merged_at?: string | null;
191
+ diff_url: string | null;
192
+ html_url: string | null;
193
+ patch_url: string | null;
194
+ url: string | null;
195
+ };
196
+ closed_at: string | null;
197
+ created_at: string;
198
+ updated_at: string;
199
+ draft?: boolean;
200
+ closed_by?: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
201
+ body_html?: string;
202
+ body_text?: string;
203
+ timeline_url?: string;
204
+ type?: import("@octokit/openapi-types").components["schemas"]["issue-type"];
205
+ repository?: import("@octokit/openapi-types").components["schemas"]["repository"];
206
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
207
+ author_association?: import("@octokit/openapi-types").components["schemas"]["author-association"];
208
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
209
+ sub_issues_summary?: import("@octokit/openapi-types").components["schemas"]["sub-issues-summary"];
210
+ parent_issue_url?: string | null;
211
+ issue_dependencies_summary?: import("@octokit/openapi-types").components["schemas"]["issue-dependencies-summary"];
212
+ issue_field_values?: import("@octokit/openapi-types").components["schemas"]["issue-field-value"][];
213
+ }>;
214
+ post(body: {
215
+ data: never;
216
+ }): Promise<{
217
+ id: number;
218
+ node_id: string;
219
+ url: string;
220
+ repository_url: string;
221
+ labels_url: string;
222
+ comments_url: string;
223
+ events_url: string;
224
+ html_url: string;
225
+ number: number;
226
+ state: string;
227
+ state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null;
228
+ title: string;
229
+ body?: string | null;
230
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
231
+ labels: import("@octokit/openapi-types").OneOf<[string, {
232
+ id?: number;
233
+ node_id?: string;
234
+ url?: string;
235
+ name?: string;
236
+ description?: string | null;
237
+ color?: string | null;
238
+ default?: boolean;
239
+ }]>[];
240
+ assignee: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
241
+ assignees?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
242
+ milestone: import("@octokit/openapi-types").components["schemas"]["nullable-milestone"];
243
+ locked: boolean;
244
+ active_lock_reason?: string | null;
245
+ comments: number;
246
+ pull_request?: {
247
+ merged_at?: string | null;
248
+ diff_url: string | null;
249
+ html_url: string | null;
250
+ patch_url: string | null;
251
+ url: string | null;
252
+ };
253
+ closed_at: string | null;
254
+ created_at: string;
255
+ updated_at: string;
256
+ draft?: boolean;
257
+ closed_by?: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
258
+ body_html?: string;
259
+ body_text?: string;
260
+ timeline_url?: string;
261
+ type?: import("@octokit/openapi-types").components["schemas"]["issue-type"];
262
+ repository?: import("@octokit/openapi-types").components["schemas"]["repository"];
263
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
264
+ author_association?: import("@octokit/openapi-types").components["schemas"]["author-association"];
265
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
266
+ sub_issues_summary?: import("@octokit/openapi-types").components["schemas"]["sub-issues-summary"];
267
+ parent_issue_url?: string | null;
268
+ issue_dependencies_summary?: import("@octokit/openapi-types").components["schemas"]["issue-dependencies-summary"];
269
+ issue_field_values?: import("@octokit/openapi-types").components["schemas"]["issue-field-value"][];
270
+ }>;
271
+ patch(body: {
272
+ data: never;
273
+ }): Promise<{
274
+ id: number;
275
+ node_id: string;
276
+ url: string;
277
+ repository_url: string;
278
+ labels_url: string;
279
+ comments_url: string;
280
+ events_url: string;
281
+ html_url: string;
282
+ number: number;
283
+ state: string;
284
+ state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null;
285
+ title: string;
286
+ body?: string | null;
287
+ user: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
288
+ labels: import("@octokit/openapi-types").OneOf<[string, {
289
+ id?: number;
290
+ node_id?: string;
291
+ url?: string;
292
+ name?: string;
293
+ description?: string | null;
294
+ color?: string | null;
295
+ default?: boolean;
296
+ }]>[];
297
+ assignee: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
298
+ assignees?: import("@octokit/openapi-types").components["schemas"]["simple-user"][] | null;
299
+ milestone: import("@octokit/openapi-types").components["schemas"]["nullable-milestone"];
300
+ locked: boolean;
301
+ active_lock_reason?: string | null;
302
+ comments: number;
303
+ pull_request?: {
304
+ merged_at?: string | null;
305
+ diff_url: string | null;
306
+ html_url: string | null;
307
+ patch_url: string | null;
308
+ url: string | null;
309
+ };
310
+ closed_at: string | null;
311
+ created_at: string;
312
+ updated_at: string;
313
+ draft?: boolean;
314
+ closed_by?: import("@octokit/openapi-types").components["schemas"]["nullable-simple-user"];
315
+ body_html?: string;
316
+ body_text?: string;
317
+ timeline_url?: string;
318
+ type?: import("@octokit/openapi-types").components["schemas"]["issue-type"];
319
+ repository?: import("@octokit/openapi-types").components["schemas"]["repository"];
320
+ performed_via_github_app?: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
321
+ author_association?: import("@octokit/openapi-types").components["schemas"]["author-association"];
322
+ reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
323
+ sub_issues_summary?: import("@octokit/openapi-types").components["schemas"]["sub-issues-summary"];
324
+ parent_issue_url?: string | null;
325
+ issue_dependencies_summary?: import("@octokit/openapi-types").components["schemas"]["issue-dependencies-summary"];
326
+ issue_field_values?: import("@octokit/openapi-types").components["schemas"]["issue-field-value"][];
327
+ }>;
328
+ delete(): Promise<void>;
329
+ };
330
+ };