import {z} from 'zod' export type GetApiV1ScansResultsArgs = {offset?: number | undefined, limit?: number | undefined, severity?: string | undefined, search?: string | undefined, host?: string | undefined, domain?: string | undefined, port?: string | undefined, templates?: string | undefined, time?: string | undefined, vuln_status?: string | undefined, tags?: string | undefined, sort_asc?: string | undefined, sort_desc?: string | undefined, is_ticket?: boolean | undefined, labels?: string | undefined, category?: string | undefined, is_regression?: boolean | undefined, is_internal?: boolean | undefined, asset_metadata?: boolean | undefined, 'X-Team-Id'?: string | undefined}; export type GetApiV1ScansResultsOptions = {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 enumerationContentTechnologyDetails = z.object({description: z.string().optional(), website: z.string().optional(), icon: z.string().optional(), categories: z.array(z.string()).optional()}); export const enumerationSourceValue = z.object({source: z.string(), metadata: z.record(z.string(), z.string())}); export const enumerationContent = z.object({enumeration_id: z.string(), name: z.string(), created_at: z.string(), updated_at: z.string().optional(), id: z.number().int(), labels: z.array(z.string()).optional(), cname: z.array(z.string()).optional(), host: z.string().optional(), port: z.number().int().optional(), ip: z.array(z.string()).optional(), status_code: z.number().int().optional(), content_length: z.number().int().optional(), vulnerabilities: z.number().int().optional(), title: z.string().optional(), technologies: z.array(z.string()).optional(), webserver: z.string().optional(), method: z.string().optional(), is_new: z.boolean(), type: z.string().optional(), asset_hash: z.string().optional(), technology_details: z.record(z.string(), enumerationContentTechnologyDetails).optional(), screenshot_path: z.string().optional(), favicon: z.string().optional(), favicon_body: z.string().optional(), cdn_name: z.string().optional(), chain_status_codes: z.array(z.string()).optional(), domain_name: z.string().optional(), redirect_location: z.string().optional(), asn: z.object({as_country: z.string().optional(), as_name: z.string().optional(), as_number: z.string().optional(), as_range: z.array(z.string()).optional()}).optional(), tls_serial_number: z.string().optional(), tls_subject_org: z.string().optional(), tls_issuer_org: z.string().optional(), tls_expired: z.boolean().optional(), tls_not_before: z.string().optional(), tls_self_signed: z.boolean().optional(), tls_mismatched: z.boolean().optional(), tls_revoked: z.boolean().optional(), tls_untrusted: z.boolean().optional(), tls_subject_cn: z.string().optional(), tls_subject_an: z.array(z.string()).optional(), body: z.string().optional(), tls_not_after: z.string().optional(), enumeration_name: z.string().optional(), extended_metadata: z.object({}).optional(), source_type: z.string().optional(), source: z.array(enumerationSourceValue).optional(), is_internal: z.boolean().optional()}); export const vulnerabilityResults = 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: z.array(vulnerabilityEvent), 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(), is_regression: z.boolean().optional(), is_internal: z.boolean().optional(), labels: z.array(z.string()).optional(), port: z.number().int().optional(), asset_metadata: enumerationContent.optional(), remediation: z.string().optional(), description: z.string().optional(), impact: z.string().optional(), reference: z.array(z.string()).optional()}); export const getApiV1ScansResultsResponse = z.object({current_page: z.number().int(), result_count: z.number().int(), total_results: z.number().int(), total_pages: z.number().int(), message: z.string(), data: z.array(vulnerabilityResults), stats: z.object({total: z.number().int().optional()}).optional(), filters: z.object({}).optional()}); 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 Results * * GET /v1/scans/results */ export const getApiV1ScansResults = async (args: GetApiV1ScansResultsArgs, options?: GetApiV1ScansResultsOptions) => { 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.offset != null) query.append("offset", String(args.offset)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.severity != null) query.append("severity", String(args.severity)) if (args.search != null) query.append("search", String(args.search)) if (args.host != null) query.append("host", String(args.host)) if (args.domain != null) query.append("domain", String(args.domain)) if (args.port != null) query.append("port", String(args.port)) if (args.templates != null) query.append("templates", String(args.templates)) if (args.time != null) query.append("time", String(args.time)) if (args.vuln_status != null) query.append("vuln_status", String(args.vuln_status)) if (args.tags != null) query.append("tags", String(args.tags)) 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.is_ticket != null) query.append("is_ticket", String(args.is_ticket)) if (args.labels != null) query.append("labels", String(args.labels)) if (args.category != null) query.append("category", String(args.category)) if (args.is_regression != null) query.append("is_regression", String(args.is_regression)) if (args.is_internal != null) query.append("is_internal", String(args.is_internal)) if (args.asset_metadata != null) query.append("asset_metadata", String(args.asset_metadata)) 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/results${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(getApiV1ScansResultsResponse, await res.json()) };