import {z} from 'zod' export type GetApiApi3ScansArgs = {active?: boolean | undefined, page?: number | undefined, size?: number | undefined, sort?: Array | undefined}; export type GetApiApi3ScansOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const link = z.object({deprecation: z.string().optional(), href: z.string().optional(), hreflang: z.string().optional(), media: z.string().optional(), rel: z.string().optional(), title: z.string().optional(), type: z.string().optional()}); export const pageMetadata = z.object({number: z.number().int().optional(), size: z.number().int().optional(), totalPages: z.number().int().optional(), totalResources: z.number().int().optional()}); export const engineIDSchema = z.object({id: z.number().int().optional(), newScanEngine: z.boolean().optional(), scope: z.enum(["global", "silo"]).optional()}); export const scanStatus = z.enum(["aborted", "unknown", "running", "finished", "stopped", "error", "paused", "dispatched", "integrating"]); export const vulnerabilities = z.object({critical: z.number().int().optional(), moderate: z.number().int().optional(), severe: z.number().int().optional(), total: z.number().int().optional()}); export const globalScan = z.object({assets: z.number().int().optional(), duration: z.string().optional(), endTime: z.string().optional(), engineId: z.object({}).optional(), engineIds: engineIDSchema.optional(), engineName: z.string().optional(), id: z.object({}).optional(), links: z.array(link), message: z.string().optional(), scanName: z.string().optional(), scanType: z.string().optional(), siteId: z.object({}).optional(), siteName: z.string().optional(), startTime: z.string().optional(), startedBy: z.string().optional(), startedByUsername: z.string().optional(), status: scanStatus.optional(), vulnerabilities: vulnerabilities.optional()}); export const pagedModelGlobalScan = z.object({links: z.array(link), page: pageMetadata.optional(), resources: z.array(globalScan)}); 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 }; /** * Scans * * GET /api/3/scans */ export const getApiApi3Scans = async (args: GetApiApi3ScansArgs, options?: GetApiApi3ScansOptions) => { const {baseUrl = "https://:", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json;charset=UTF-8") if (args.active != null) query.append("active", String(args.active)) if (args.page != null) query.append("page", String(args.page)) if (args.size != null) query.append("size", String(args.size)) for (const item of args.sort ?? []) query.append("sort", String(item)) const url = `${baseUrl.replace(/\/+$/, '')}/api/3/scans${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(pagedModelGlobalScan, await res.json()) };