import {z} from 'zod' export type GetApiTyposquatDetailsArgs = {domain: string}; export type GetApiTyposquatDetailsOptions = {baseUrl?: string | undefined, APIKeyInHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const typosquatDNSBlocklist = z.object({activity: z.string().optional(), name: z.string().optional()}); export const typosquatHostnameDNSBlocklists = z.object({dns_blocklists: z.array(typosquatDNSBlocklist).optional(), hostname: z.string().optional()}); export const permutationType = z.string(); export const typosquatPermutationDetail = z.object({a_records: z.array(z.string()).optional(), country: z.string().optional(), date_detected: z.string().optional(), hostname: z.string().optional(), hostname_dns_blocklists: z.array(typosquatHostnameDNSBlocklists).optional(), mx_records: z.array(z.string()).optional(), ns_records: z.array(z.string()).optional(), permutation_type: permutationType.optional()}); export const getTyposquatDetailsResponsePayloadBody = z.object({ignored: z.array(typosquatPermutationDetail).optional(), registered: z.array(typosquatPermutationDetail).optional(), unregistered: z.array(typosquatPermutationDetail).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 }; /** * Retrieve typosquat details for a domain. * * GET /typosquat/details */ export const getApiTyposquatDetails = async (args: GetApiTyposquatDetailsArgs, options?: GetApiTyposquatDetailsOptions) => { 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.domain != null) query.append("domain", String(args.domain)) if (APIKeyInHeader !== undefined) headers.set("Authorization", APIKeyInHeader) const url = `${baseUrl.replace(/\/+$/, '')}/typosquat/details${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(getTyposquatDetailsResponsePayloadBody, await res.json()) };