-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Expand file tree
/
Copy pathpackages.go
More file actions
319 lines (272 loc) · 12.8 KB
/
packages.go
File metadata and controls
319 lines (272 loc) · 12.8 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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
// Copyright 2020 The go-github AUTHORS. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package github
import (
"encoding/json"
)
// Package represents a GitHub package.
type Package struct {
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
PackageType *string `json:"package_type,omitempty"` // One of "npm", "maven", "rubygems", "docker", "nuget", "container". For webhook events "container" is "CONTAINER"
HTMLURL *string `json:"html_url,omitempty"`
Visibility *string `json:"visibility,omitempty"`
Owner *User `json:"owner,omitempty"`
Repository *Repository `json:"repository,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
// The following are only populated for webhook events
Namespace *string `json:"namespace,omitempty"`
Description *string `json:"description,omitempty"`
Ecosystem *string `json:"ecosystem,omitempty"`
PackageVersion *PackageVersion `json:"package_version,omitempty"`
Registry *PackageRegistry `json:"registry,omitempty"`
// The following are NOT populated for webhook events
URL *string `json:"url,omitempty"`
VersionCount *int64 `json:"version_count,omitempty"`
}
func (p Package) String() string {
return Stringify(p)
}
// PackageVersion represents a GitHub package version.
type PackageVersion struct {
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
URL *string `json:"url,omitempty"`
PackageHTMLURL *string `json:"package_html_url,omitempty"`
License *string `json:"license,omitempty"`
Description *string `json:"description,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
Metadata json.RawMessage `json:"metadata,omitempty"` // For webhook events this will be []interface, else it will be of type PackageMetadata
// The following are only populated for webhook events
Version *string `json:"version,omitempty"`
Summary *string `json:"summary,omitempty"`
Body json.RawMessage `json:"body,omitempty"` // Can either be a string or of type PackageVersionBody
BodyHTML *string `json:"body_html,omitempty"`
Release *PackageRelease `json:"release,omitempty"`
Manifest *string `json:"manifest,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
TagName *string `json:"tag_name,omitempty"`
TargetCommitish *string `json:"target_commitish,omitempty"`
TargetOID *string `json:"target_oid,omitempty"`
Draft *bool `json:"draft,omitempty"`
Prerelease *bool `json:"prerelease,omitempty"`
ContainerMetadata *PackageEventContainerMetadata `json:"container_metadata,omitempty"`
DockerMetadata []any `json:"docker_metadata,omitempty"`
NPMMetadata *PackageNPMMetadata `json:"npm_metadata,omitempty"`
NugetMetadata []*PackageNugetMetadata `json:"nuget_metadata,omitempty"`
RubyMetadata map[string]any `json:"ruby_metadata,omitempty"`
PackageFiles []*PackageFile `json:"package_files,omitempty"`
PackageURL *string `json:"package_url,omitempty"`
Author *User `json:"author,omitempty"`
SourceURL *string `json:"source_url,omitempty"`
InstallationCommand *string `json:"installation_command,omitempty"`
// The following are NOT populated for webhook events
DeletedAt *Timestamp `json:"deleted_at,omitempty"`
}
// GetBody returns the body field as a string if it's valid.
func (pv *PackageVersion) GetBody() (body string, ok bool) {
if pv == nil || pv.Body == nil {
return "", false
}
if err := json.Unmarshal(pv.Body, &body); err != nil {
return "", false
}
return body, true
}
// GetBodyAsPackageVersionBody returns the body field as a PackageVersionBody if it's valid.
func (pv *PackageVersion) GetBodyAsPackageVersionBody() (body *PackageVersionBody, ok bool) {
if pv == nil || pv.Body == nil {
return nil, false
}
if err := json.Unmarshal(pv.Body, &body); err != nil {
return nil, false
}
return body, true
}
// GetMetadata returns the metadata field as PackageMetadata if it's valid.
func (pv *PackageVersion) GetMetadata() (metadata *PackageMetadata, ok bool) {
if pv == nil || pv.Metadata == nil {
return nil, false
}
if err := json.Unmarshal(pv.Metadata, &metadata); err != nil {
return nil, false
}
return metadata, true
}
// GetRawMetadata returns the metadata field as a json.RawMessage.
func (pv *PackageVersion) GetRawMetadata() json.RawMessage {
if pv == nil || pv.Metadata == nil {
return json.RawMessage{}
}
return pv.Metadata
}
func (pv PackageVersion) String() string {
return Stringify(pv)
}
// PackageRelease represents a GitHub package version release.
type PackageRelease struct {
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
ID *int64 `json:"id,omitempty"`
TagName *string `json:"tag_name,omitempty"`
TargetCommitish *string `json:"target_commitish,omitempty"`
Name *string `json:"name,omitempty"`
Draft *bool `json:"draft,omitempty"`
Author *User `json:"author,omitempty"`
Prerelease *bool `json:"prerelease,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
PublishedAt *Timestamp `json:"published_at,omitempty"`
}
func (r PackageRelease) String() string {
return Stringify(r)
}
// PackageFile represents a GitHub package version release file.
type PackageFile struct {
DownloadURL *string `json:"download_url,omitempty"`
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
SHA256 *string `json:"sha256,omitempty"`
SHA1 *string `json:"sha1,omitempty"`
MD5 *string `json:"md5,omitempty"`
ContentType *string `json:"content_type,omitempty"`
State *string `json:"state,omitempty"`
Author *User `json:"author,omitempty"`
Size *int64 `json:"size,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
}
func (pf PackageFile) String() string {
return Stringify(pf)
}
// PackageRegistry represents a GitHub package registry.
type PackageRegistry struct {
AboutURL *string `json:"about_url,omitempty"`
Name *string `json:"name,omitempty"`
Type *string `json:"type,omitempty"`
URL *string `json:"url,omitempty"`
Vendor *string `json:"vendor,omitempty"`
}
func (r PackageRegistry) String() string {
return Stringify(r)
}
// PackageListOptions represents the optional list options for a package.
type PackageListOptions struct {
// Visibility of packages "public", "internal" or "private".
Visibility *string `url:"visibility,omitempty"`
// PackageType represents the type of package.
// It can be one of "npm", "maven", "rubygems", "nuget", "docker", or "container".
PackageType *string `url:"package_type,omitempty"`
// State of package either "active" or "deleted".
State *string `url:"state,omitempty"`
ListOptions
}
// PackageMetadata represents metadata from a package.
type PackageMetadata struct {
PackageType *string `json:"package_type,omitempty"`
Container *PackageContainerMetadata `json:"container,omitempty"`
}
func (r PackageMetadata) String() string {
return Stringify(r)
}
// PackageContainerMetadata represents container metadata for docker container packages.
type PackageContainerMetadata struct {
Tags []string `json:"tags,omitempty"`
}
func (r PackageContainerMetadata) String() string {
return Stringify(r)
}
// PackageVersionBody represents the body field of a package version.
type PackageVersionBody struct {
Repo *Repository `json:"repository,omitempty"`
Info *PackageVersionBodyInfo `json:"info,omitempty"`
}
func (b PackageVersionBody) String() string {
return Stringify(b)
}
// PackageVersionBodyInfo represents the info field of a PackageVersionBody.
type PackageVersionBodyInfo struct {
Type *string `json:"type,omitempty"`
OID *string `json:"oid,omitempty"`
Mode *int64 `json:"mode,omitempty"`
Name *string `json:"name,omitempty"`
Path *string `json:"path,omitempty"`
Size *int64 `json:"size,omitempty"`
Collection *bool `json:"collection,omitempty"`
}
func (bi PackageVersionBodyInfo) String() string {
return Stringify(bi)
}
// PackageEventContainerMetadata represents metadata for container packages as part of a webhook event.
// See also PackageContainerMetadata.
type PackageEventContainerMetadata struct {
Labels map[string]any `json:"labels,omitempty"`
Manifest map[string]any `json:"manifest,omitempty"`
Tag *PackageEventContainerMetadataTag `json:"tag,omitempty"`
}
func (m PackageEventContainerMetadata) String() string {
return Stringify(m)
}
// PackageEventContainerMetadataTag represents a tag of a GitHub container package.
type PackageEventContainerMetadataTag struct {
Name *string `json:"name,omitempty"`
Digest *string `json:"digest,omitempty"`
}
func (mt PackageEventContainerMetadataTag) String() string {
return Stringify(mt)
}
// PackageNugetMetadata represents nuget metadata for a GitHub package.
type PackageNugetMetadata struct {
ID json.RawMessage `json:"id,omitempty"` // Can either be an int64 or string
Name *string `json:"name,omitempty"`
Value json.RawMessage `json:"value,omitempty"` // Can either be a bool, string, integer or object
}
func (nm PackageNugetMetadata) String() string {
return Stringify(nm)
}
// PackageNPMMetadata represents NPM metadata for a GitHub package.
type PackageNPMMetadata struct {
Name *string `json:"name,omitempty"`
Version *string `json:"version,omitempty"`
NPMUser *string `json:"npm_user,omitempty"`
Author map[string]string `json:"author,omitempty"`
Bugs map[string]string `json:"bugs,omitempty"`
Dependencies map[string]string `json:"dependencies,omitempty"`
DevDependencies map[string]string `json:"dev_dependencies,omitempty"`
PeerDependencies map[string]string `json:"peer_dependencies,omitempty"`
OptionalDependencies map[string]string `json:"optional_dependencies,omitempty"`
Description *string `json:"description,omitempty"`
Dist map[string]string `json:"dist,omitempty"`
GitHead *string `json:"git_head,omitempty"`
Homepage *string `json:"homepage,omitempty"`
License *string `json:"license,omitempty"`
Main *string `json:"main,omitempty"`
Repository map[string]string `json:"repository,omitempty"`
Scripts map[string]any `json:"scripts,omitempty"`
ID *string `json:"id,omitempty"`
NodeVersion *string `json:"node_version,omitempty"`
NPMVersion *string `json:"npm_version,omitempty"`
HasShrinkwrap *bool `json:"has_shrinkwrap,omitempty"`
Maintainers []any `json:"maintainers,omitempty"`
Contributors []any `json:"contributors,omitempty"`
Engines map[string]string `json:"engines,omitempty"`
Keywords []string `json:"keywords,omitempty"`
Files []string `json:"files,omitempty"`
Bin map[string]any `json:"bin,omitempty"`
Man map[string]any `json:"man,omitempty"`
Directories map[string]string `json:"directories,omitempty"`
OS []string `json:"os,omitempty"`
CPU []string `json:"cpu,omitempty"`
Readme *string `json:"readme,omitempty"`
InstallationCommand *string `json:"installation_command,omitempty"`
ReleaseID *int64 `json:"release_id,omitempty"`
CommitOID *string `json:"commit_oid,omitempty"`
PublishedViaActions *bool `json:"published_via_actions,omitempty"`
DeletedByID *int64 `json:"deleted_by_id,omitempty"`
}
func (nm PackageNPMMetadata) String() string {
return Stringify(nm)
}