import {z} from 'zod' export type GetApiV1ScansVulnChangelogsArgs = {time?: ('last_day' | 'last_week' | 'last_month' | 'last_3_months' | 'last_6_months' | 'last_12_months' | 'all_time') | undefined, event_type?: string | undefined, sort_asc?: string | undefined, sort_desc?: string | undefined, limit?: number | undefined, offset?: number | undefined, 'X-Team-Id'?: string | undefined}; export type GetApiV1ScansVulnChangelogsOptions = {baseUrl?: string | undefined, XAPIKey?: string | undefined, fetch?: typeof fetch | undefined}; export const vulnIssueTrackerItem = z.object({id: z.string().optional(), url: z.string().optional()}); export const vulnerabilityEvent = z.object({"curl-command": z.string().optional(), "extracted-results": z.array(z.string()).optional(), "extractor-name": z.string().optional(), host: z.string().optional(), info: z.object({classification: z.object({cpe: z.string().optional(), "cve-id": z.array(z.string()).optional(), "cvss-metrics": z.string().optional(), "cvss-score": z.number().optional(), "cwe-id": z.array(z.string()).optional(), "epss-percentile": z.number().optional(), "epss-score": z.number().optional()}).optional(), metadata: z.object({}).optional(), author: z.array(z.string()).optional(), description: z.string().optional(), impact: z.string().optional(), name: z.string(), tags: z.array(z.string()).optional(), reference: z.array(z.string()).optional(), remediation: z.string().optional(), severity: z.string().optional()}).optional(), ip: z.string().optional(), "matched-at": z.string().optional(), "matched-line": z.array(z.number().int()).optional(), "matcher-name": z.string().optional(), "matcher-status": z.boolean().optional(), path: z.string().optional(), request: z.string().optional(), response: z.string().optional(), "template-id": z.string().optional(), "template-path": z.string().optional(), timestamp: z.string().optional(), type: z.string().optional(), error: z.string().optional(), issue_trackers: z.object({jira: vulnIssueTrackerItem.optional(), github: vulnIssueTrackerItem.optional(), gitlab: vulnIssueTrackerItem.optional(), linear: vulnIssueTrackerItem.optional(), custom: vulnIssueTrackerItem.optional()}).optional(), port: z.string().optional()}); export const vulnerabilityChangelogsEvent = z.object({name: z.string().optional(), from: z.unknown(), to: z.unknown()}); export const vulnerabilityChangelogs = z.object({matcher_status: z.boolean(), vuln_id: z.string(), target: z.string(), template_url: z.string().optional(), created_at: z.string(), updated_at: z.string().optional(), scan_id: z.string(), event: vulnerabilityEvent, change_event: z.array(vulnerabilityChangelogsEvent).optional(), template_id: z.string(), template_path: z.string().optional(), template_encoded: z.string().optional(), result_type: z.string(), vuln_status: z.string().optional(), vuln_hash: z.string(), labels: z.array(z.string()).optional()}); export const getApiV1ScansVulnChangelogsResponse = z.object({data: z.array(vulnerabilityChangelogs)}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get all Vulnerability Changelogs * * GET /v1/scans/vuln/changelogs */ export const getApiV1ScansVulnChangelogs = async (args: GetApiV1ScansVulnChangelogsArgs, options?: GetApiV1ScansVulnChangelogsOptions) => { const {baseUrl = "https://api.projectdiscovery.io", fetch: fetchFn = fetch, XAPIKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.time != null) query.append("time", String(args.time)) if (args.event_type != null) query.append("event_type", String(args.event_type)) if (args.sort_asc != null) query.append("sort_asc", String(args.sort_asc)) if (args.sort_desc != null) query.append("sort_desc", String(args.sort_desc)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (args['X-Team-Id'] != null) headers.set("X-Team-Id", String(args['X-Team-Id'])) if (XAPIKey !== undefined) headers.set("X-API-Key", XAPIKey) const url = `${baseUrl.replace(/\/+$/, '')}/v1/scans/vuln/changelogs${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiV1ScansVulnChangelogsResponse, await res.json()) };