import {z} from 'zod' export type GetApiRisksArgs = {min_severity?: ('info' | 'low' | 'medium' | 'high' | 'critical') | undefined, include_meta?: boolean | undefined, include_sources?: boolean | undefined, asset_portfolio_names?: Array | undefined}; export type GetApiRisksOptions = {baseUrl?: string | undefined, APIKeyInHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const riskWaiver = z.object({active_at: z.string().optional(), all_hostnames: z.boolean().optional(), approved_by: z.string().optional(), created_by: z.string().optional(), expires_at: z.string().optional(), hostnames: z.array(z.string()).optional(), justification: z.string().optional()}); export const risk = z.object({category: z.string().optional(), description: z.string().optional(), finding: z.string().optional(), firstDetected: z.string().optional(), hostnameCount: z.number().int().optional(), hostnameMeta: z.record(z.string(), z.string()).optional(), hostnames: z.array(z.string()).optional(), id: z.string().optional(), remediation: z.string().optional(), risk: z.string().optional(), riskSubtype: z.string().optional(), riskType: z.string().optional(), risk_waivers: z.array(riskWaiver).optional(), severity: z.string().optional(), sources: z.array(z.string()).optional()}); export const getRisksV1RespBody = z.object({risks: z.array(risk).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 a list of active risks for your account * * GET /risks */ export const getApiRisks = async (args: GetApiRisksArgs, options?: GetApiRisksOptions) => { const {baseUrl = "https://cyber-risk.upguard.com/api/public", fetch: fetchFn = fetch, APIKeyInHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.min_severity != null) query.append("min_severity", String(args.min_severity)) if (args.include_meta != null) query.append("include_meta", String(args.include_meta)) if (args.include_sources != null) query.append("include_sources", String(args.include_sources)) for (const item of args.asset_portfolio_names ?? []) query.append("asset_portfolio_names", String(item)) if (APIKeyInHeader !== undefined) headers.set("Authorization", APIKeyInHeader) const url = `${baseUrl.replace(/\/+$/, '')}/risks${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(getRisksV1RespBody, await res.json()) };