-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtypes.ts
More file actions
177 lines (168 loc) · 3.2 KB
/
types.ts
File metadata and controls
177 lines (168 loc) · 3.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
import type * as core from '@actions/core';
import type { getOctokit } from '@actions/github';
/**
* Core context types provided by github-typescript wrapper
*/
export type GitHubContext = {
core: typeof core;
github: ReturnType<typeof getOctokit>;
context: typeof import('@actions/github').context;
};
/**
* Repository identification
*/
export type RepoInfo = {
owner: string;
repo: string;
};
/**
* Common comment structure from GitHub API
*/
export type Comment = {
id: number;
body: string;
user: {
login: string;
id: number;
} | null;
created_at: string;
updated_at: string;
html_url: string;
};
/**
* Issue comment structure
*/
export type IssueComment = Comment & {
issue_url: string;
};
/**
* Pull request comment structure (review comments)
*/
export type PullRequestComment = Comment & {
pull_request_review_id: number;
diff_hunk: string;
path: string;
position: number | null;
original_position: number;
commit_id: string;
original_commit_id: string;
in_reply_to_id?: number;
pull_request_url: string;
};
/**
* Pull request structure with common fields
*/
export type PullRequest = {
id: number;
number: number;
title: string;
body: string | null;
state: 'open' | 'closed';
draft: boolean;
user: {
login: string;
id: number;
} | null;
labels: Array<{
id: number;
name: string;
color: string;
description: string | null;
}>;
head: {
ref: string;
sha: string;
repo: {
name: string;
owner: {
login: string;
};
} | null;
};
base: {
ref: string;
sha: string;
repo: {
name: string;
owner: {
login: string;
};
};
};
html_url: string;
created_at: string;
updated_at: string;
};
/**
* Options for sticky comment functionality
*/
export type StickyCommentOptions = {
/**
* Unique identifier for the sticky comment (used to find and update existing comments)
*/
identifier: string;
/**
* Comment body content (supports markdown)
*/
body: string;
/**
* Whether to update existing comment or create new if not found
* @default true
*/
updateIfExists?: boolean;
};
/**
* Search options for finding comments
*/
export type CommentSearchOptions = {
/**
* Search for comments containing this text
*/
bodyContains?: string;
/**
* Search for comments by specific user
*/
author?: string;
/**
* Search for comments created after this date
*/
createdAfter?: Date;
/**
* Search for comments created before this date
*/
createdBefore?: Date;
/**
* Maximum number of comments to return
* @default 100
*/
limit?: number;
};
/**
* Options for finding pull requests by label
*/
export type PullRequestSearchOptions = {
/**
* Labels that must be present on the PR (AND logic)
*/
labels: string[];
/**
* PR state to filter by
* @default 'open'
*/
state?: 'open' | 'closed' | 'all';
/**
* Maximum number of PRs to return
* @default 30
*/
limit?: number;
/**
* Sort order
* @default 'created'
*/
sort?: 'created' | 'updated' | 'popularity' | 'long-running';
/**
* Sort direction
* @default 'desc'
*/
direction?: 'asc' | 'desc';
};