FilesExpand file tree

main

/

schemas.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

215 lines (202 loc) · 6.02 KB

main

/

schemas.ts

Copy path

Top

File metadata and controls

• Code
• Blame

215 lines (202 loc) · 6.02 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

import * as z from 'zod'

import {parsePURL} from './purl'

export const SEVERITIES = ['critical', 'high', 'moderate', 'low'] as const

export const SCOPES = ['unknown', 'runtime', 'development'] as const

export const SeveritySchema = z.enum(SEVERITIES).default('low')

const PackageURL = z

.string()

.transform(purlString => {

return parsePURL(purlString)

})

.superRefine((purl, context) => {

if (purl.error) {

context.addIssue({

code: z.ZodIssueCode.custom,

message: `Error parsing package-url: ${purl.error}`

})

}

if (!purl.name) {

context.addIssue({

code: z.ZodIssueCode.custom,

message: `Error parsing package-url: name is required`

})

}

})

const PackageURLWithNamespace = z

.string()

.transform(purlString => {

return parsePURL(purlString)

})

.superRefine((purl, context) => {

if (purl.error) {

context.addIssue({

code: z.ZodIssueCode.custom,

message: `Error parsing purl: ${purl.error}`

})

}

if (purl.namespace === null) {

context.addIssue({

code: z.ZodIssueCode.custom,

message: `package-url must have a namespace, and the namespace must be followed by '/'`

})

}

})

const PackageURLString = z.string().superRefine((value, context) => {

const purl = parsePURL(value)

if (purl.error) {

context.addIssue({

code: z.ZodIssueCode.custom,

message: `Error parsing package-url: ${purl.error}`

})

}

if (!purl.name) {

context.addIssue({

code: z.ZodIssueCode.custom,

message: `Error parsing package-url: name is required`

})

}

})

export const ChangeSchema = z.object({

change_type: z.enum(['added', 'removed']),

manifest: z.string(),

ecosystem: z.string(),

name: z.string(),

version: z.string(),

package_url: z.string(),

license: z.string().nullable(),

source_repository_url: z.string().nullable(),

scope: z.enum(SCOPES).optional(),

vulnerabilities: z

.array(

z.object({

severity: SeveritySchema,

advisory_ghsa_id: z.string(),

advisory_summary: z.string(),

advisory_url: z.string()

})

)

.optional()

.default([])

})

export const PullRequestSchema = z.object({

number: z.number(),

base: z.object({sha: z.string()}),

head: z.object({sha: z.string()})

})

export const MergeGroupSchema = z.object({

base_sha: z.string(),

head_sha: z.string()

})

export const ConfigurationOptionsSchema = z

.object({

fail_on_severity: SeveritySchema,

fail_on_scopes: z.array(z.enum(SCOPES)).default(['runtime']),

allow_licenses: z.array(z.string()).optional(),

deny_licenses: z.array(z.string()).optional(),

allow_dependencies_licenses: z.array(PackageURLString).optional(),

allow_ghsas: z.array(z.string()).default([]),

deny_packages: z.array(PackageURL).default([]),

deny_groups: z.array(PackageURLWithNamespace).default([]),

license_check: z.boolean().default(true),

vulnerability_check: z.boolean().default(true),

config_file: z.string().optional(),

base_ref: z.string().optional(),

head_ref: z.string().optional(),

retry_on_snapshot_warnings: z.boolean().default(false),

retry_on_snapshot_warnings_timeout: z.number().default(120),

show_openssf_scorecard: z.boolean().optional().default(true),

warn_on_openssf_scorecard_level: z.number().default(3),

show_patched_versions: z.boolean().default(false),

comment_summary_in_pr: z

.union([

z.preprocess(

val => (val === 'true' ? true : val === 'false' ? false : val),

z.boolean()

),

z.enum(['always', 'never', 'on-failure'])

])

.default('never'),

warn_only: z.boolean().default(false)

})

.transform(config => {

if (config.comment_summary_in_pr === true) {

config.comment_summary_in_pr = 'always'

} else if (config.comment_summary_in_pr === false) {

config.comment_summary_in_pr = 'never'

}

return config

})

.superRefine((config, context) => {

if (config.allow_licenses && config.deny_licenses) {

context.addIssue({

code: z.ZodIssueCode.custom,

message: 'You cannot specify both allow-licenses and deny-licenses'

})

}

if (config.allow_licenses && config.allow_licenses.length < 1) {

context.addIssue({

code: z.ZodIssueCode.custom,

message: 'You should provide at least one license in allow-licenses'

})

}

if (

config.license_check === false &&

config.vulnerability_check === false

) {

context.addIssue({

code: z.ZodIssueCode.custom,

message: "Can't disable both license-check and vulnerability-check"

})

}

})

export const ChangesSchema = z.array(ChangeSchema)

export const ComparisonResponseSchema = z.object({

changes: z.array(ChangeSchema),

snapshot_warnings: z.string()

})

export const ScorecardApiSchema = z.object({

date: z.string(),

repo: z

.object({

name: z.string(),

commit: z.string()

})

.nullish(),

scorecard: z

.object({

version: z.string(),

commit: z.string()

})

.nullish(),

checks: z

.array(

z.object({

name: z.string(),

documentation: z.object({

shortDescription: z.string(),

url: z.string()

}),

score: z.string(),

reason: z.string(),

details: z.array(z.string())

})

)

.nullish(),

score: z.number().nullish()

})

export const ScorecardSchema = z.object({

dependencies: z.array(

z.object({

change: ChangeSchema,

scorecard: ScorecardApiSchema.nullish()

})

)

})

export type Change = z.infer<typeof ChangeSchema>

export type Changes = z.infer<typeof ChangesSchema>

export type ComparisonResponse = z.infer<typeof ComparisonResponseSchema>

export type ConfigurationOptions = z.infer<typeof ConfigurationOptionsSchema>

export type Severity = z.infer<typeof SeveritySchema>

export type Scope = (typeof SCOPES)[number]

export type Scorecard = z.infer<typeof ScorecardSchema>

export type ScorecardApi = z.infer<typeof ScorecardApiSchema>