import {z} from 'zod' export type GetApiIpsArgs = {labels?: Array | undefined, asset_portfolio_names?: Array | undefined, page_token?: string | undefined, page_size?: number | undefined, sort_by?: ('ip' | 'owner' | 'country' | 'asn' | 'as_name' | 'automated_score') | undefined, sort_desc?: boolean | undefined}; export type GetApiIpsOptions = {baseUrl?: string | undefined, APIKeyInHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const iPSource = z.string(); export const iP = z.object({as_name: z.string().optional(), asn: z.number().int().optional(), automated_score: z.number().int().optional(), country: z.string().optional(), ip: z.string().optional(), labels: z.array(z.string()).optional(), owner: z.string().optional(), services: z.array(z.string()).optional(), sources: z.array(iPSource).optional()}); export const getIPsV1RespBody = z.object({ips: z.array(iP).optional(), next_page_token: z.string().optional(), total_results: z.number().int().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 ips * * GET /ips */ export const getApiIps = async (args: GetApiIpsArgs, options?: GetApiIpsOptions) => { 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") for (const item of args.labels ?? []) query.append("labels", String(item)) for (const item of args.asset_portfolio_names ?? []) query.append("asset_portfolio_names", String(item)) if (args.page_token != null) query.append("page_token", String(args.page_token)) if (args.page_size != null) query.append("page_size", String(args.page_size)) if (args.sort_by != null) query.append("sort_by", String(args.sort_by)) if (args.sort_desc != null) query.append("sort_desc", String(args.sort_desc)) if (APIKeyInHeader !== undefined) headers.set("Authorization", APIKeyInHeader) const url = `${baseUrl.replace(/\/+$/, '')}/ips${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(getIPsV1RespBody, await res.json()) };