import {z} from 'zod' export type IdentifierString = string; export type ApexDomainList = string; export type BooleanOptInFlag = boolean; export type ResponseFormat = 'html' | 'json' | 'xml'; export type GetApiV1IrisEnrichArgs = {app_name?: IdentifierString | undefined, app_partner?: IdentifierString | undefined, app_version?: IdentifierString | undefined, domain: ApexDomainList, parsed_domain_rdap?: BooleanOptInFlag | undefined, parsed_whois?: BooleanOptInFlag | undefined, format?: ResponseFormat | undefined}; export type GetApiV1IrisEnrichOptions = {baseUrl?: string | undefined, headerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const enrichTracker = z.object({value: z.string().optional()}); export const enrichValue = z.object({value: z.union([z.string(), z.number().int()]).optional()}); export const enrichContact = z.object({name: enrichValue.optional(), org: enrichValue.optional(), street: enrichValue.optional(), city: enrichValue.optional(), state: enrichValue.optional(), postal: enrichValue.optional(), country: enrichValue.optional(), phone: enrichValue.optional(), fax: enrichValue.optional(), email: z.array(enrichValue).optional()}); export const enrichResult = z.object({domain: z.string().optional(), whois_url: z.string().optional(), adsense: enrichTracker.optional(), alexa: z.number().int().optional(), popularity_rank: z.number().optional(), active: z.boolean().optional(), google_analytics: enrichTracker.optional(), ga4: z.array(enrichTracker).optional(), gtm_codes: z.array(enrichTracker).optional(), fb_codes: z.array(enrichTracker).optional(), hotjar_codes: z.array(enrichTracker).optional(), baidu_codes: z.array(enrichTracker).optional(), yandex_codes: z.array(enrichTracker).optional(), matomo_codes: z.array(enrichTracker).optional(), statcounter_project_codes: z.array(enrichTracker).optional(), statcounter_security_codes: z.array(enrichTracker).optional(), admin_contact: enrichContact.optional(), billing_contact: enrichContact.optional(), registrant_contact: enrichContact.optional(), technical_contact: enrichContact.optional(), create_date: enrichValue.optional(), expiration_date: enrichValue.optional(), email_domain: z.array(enrichValue).optional(), soa_email: z.array(enrichValue).optional(), ssl_email: z.array(enrichValue).optional(), additional_whois_email: z.array(enrichValue).optional(), ip: z.array(z.object({address: enrichValue.optional(), asn: z.array(enrichValue).optional(), country_code: enrichValue.optional(), isp: enrichValue.optional()})).optional(), mx: z.array(z.object({host: enrichValue.optional(), domain: enrichValue.optional(), ip: z.array(enrichValue).optional(), priority: z.number().optional()})).optional(), name_server: z.array(z.object({host: enrichValue.optional(), domain: enrichValue.optional(), ip: z.array(enrichValue).optional()})).optional(), domain_risk: z.object({risk_score: z.number().int().gte(0).lte(99).optional(), components: z.array(z.object({})).optional()}).optional(), redirect: enrichValue.optional(), redirect_domain: enrichValue.optional(), registrant_name: enrichValue.optional(), registrant_org: enrichValue.optional(), registrar: enrichValue.optional(), registrar_status: z.array(z.string()).optional(), spf_info: z.string().optional(), ssl_info: z.array(z.object({hash: enrichValue.optional(), subject: enrichValue.optional(), organization: enrichValue.optional(), email: z.array(z.string()).optional(), alt_names: z.array(enrichValue).optional(), sources: z.object({active: z.number().int().optional(), passive: z.number().int().optional()}).optional(), common_name: enrichValue.optional(), issuer_common_name: enrichValue.optional(), not_after: enrichValue.optional(), not_before: enrichValue.optional(), duration: enrichValue.optional()})).optional(), tld: z.string().optional(), website_response: z.number().optional(), data_updated_timestamp: z.string().optional(), website_title: enrichValue.optional(), server_type: enrichValue.optional(), first_seen: enrichValue.optional(), tags: z.array(z.object({label: z.string().optional(), scope: z.string().optional(), tagged_at: z.string().optional()})).optional(), parsed_whois: z.object({}).optional(), parsed_domain_rdap: z.object({}).optional()}); export const apexDomain = z.string(); export const getApiV1IrisEnrichResponse = z.object({response: z.object({limit_exceeded: z.boolean().optional(), message: z.string().optional(), results_count: z.number().int().optional(), has_more_results: z.boolean().optional(), results: z.array(enrichResult).optional(), missing_domains: z.array(apexDomain).optional()}).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 }; /** * Returns results from a GET request to Iris Enrich. * * GET /v1/iris-enrich/ * * Also accepts auth: open_key_auth, hmac_auth */ export const getApiV1IrisEnrich = async (args: GetApiV1IrisEnrichArgs, options?: GetApiV1IrisEnrichOptions) => { const {baseUrl = "https://api.domaintools.com", fetch: fetchFn = fetch, headerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.app_name != null) query.append("app_name", String(args.app_name)) if (args.app_partner != null) query.append("app_partner", String(args.app_partner)) if (args.app_version != null) query.append("app_version", String(args.app_version)) if (args.domain != null) query.append("domain", String(args.domain)) if (args.parsed_domain_rdap != null) query.append("parsed_domain_rdap", String(args.parsed_domain_rdap)) if (args.parsed_whois != null) query.append("parsed_whois", String(args.parsed_whois)) if (args.format != null) query.append("format", String(args.format)) if (headerAuth !== undefined) headers.set("X-Api-Key", headerAuth) const url = `${baseUrl.replace(/\/+$/, '')}/v1/iris-enrich/${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(getApiV1IrisEnrichResponse, await res.json()) };