import {z} from 'zod' export type IdentifierString = string; export type GenericString = string; export type IPv4Address = string; export type ApexDomainList = string; export type EmailAddress = string; export type ApexDomain = string; export type Fqdn = string; export type Hostname = string; export type OrgNameString = string; export type SearchHashToken = string; export type BasicString = string; export type Sha1HexString = string; export type SslSubjectDnString = string; export type WebsiteTitleString = string; export type DateOperatorsFilter = string; export type MaxDaysSince = number; export type DateFilter = string; export type TimestampFilter = number | string; export type TimeWindowSeconds = number; export type CommaSeparatedTags = string; export type TopLevelDomain = string; export type BooleanOptInFlag = boolean; export type ResponseFormat = 'html' | 'json' | 'xml'; export type PositionToken = string; export type GetApiV1IrisInvestigateArgs = {adsense?: IdentifierString | undefined, baidu_analytics?: IdentifierString | undefined, contact_name?: GenericString | undefined, contact_phone?: GenericString | undefined, contact_street?: GenericString | undefined, ip?: IPv4Address | undefined, domain?: ApexDomainList | undefined, email?: EmailAddress | undefined, email_dns_soa?: EmailAddress | undefined, email_domain?: ApexDomain | undefined, facebook?: IdentifierString | undefined, ga4?: IdentifierString | undefined, google_analytics?: IdentifierString | undefined, google_tag_manager?: IdentifierString | undefined, hotjar?: IdentifierString | undefined, iana_id?: IdentifierString | undefined, mailserver_domain?: ApexDomain | undefined, mailserver_host?: Fqdn | undefined, mailserver_ip?: IPv4Address | undefined, matomo?: IdentifierString | undefined, nameserver_domain?: Hostname | undefined, nameserver_host?: Hostname | undefined, nameserver_ip?: IPv4Address | undefined, redirect_domain?: GenericString | undefined, registrant?: OrgNameString | undefined, historical_registrant?: OrgNameString | undefined, registrant_org?: OrgNameString | undefined, registrar?: OrgNameString | undefined, search_hash?: SearchHashToken | undefined, server_type?: BasicString | undefined, ssl_alt_names?: GenericString | undefined, ssl_common_name?: GenericString | undefined, ssl_duration?: number | undefined, ssl_email?: EmailAddress | undefined, ssl_hash?: Sha1HexString | undefined, ssl_org?: OrgNameString | undefined, ssl_subject?: SslSubjectDnString | undefined, ssl_issuer_common_name?: GenericString | undefined, statcounter_project?: IdentifierString | undefined, statcounter_security?: IdentifierString | undefined, tagged_with_all?: GenericString | undefined, tagged_with_any?: GenericString | undefined, website_title?: WebsiteTitleString | undefined, whois?: GenericString | undefined, historical_free_text?: GenericString | undefined, yandex_metrica?: IdentifierString | undefined, active?: boolean | undefined, create_date?: DateOperatorsFilter | undefined, create_date_within?: MaxDaysSince | undefined, expiration_date?: DateFilter | undefined, first_seen_since?: TimestampFilter | undefined, first_seen_within?: TimeWindowSeconds | undefined, ip_country_code?: string | undefined, not_tagged_with_all?: CommaSeparatedTags | undefined, not_tagged_with_any?: CommaSeparatedTags | undefined, rank?: number | undefined, risk_score?: number | undefined, ssl_not_after?: DateFilter | undefined, ssl_not_before?: DateFilter | undefined, tld?: TopLevelDomain | undefined, parsed_domain_rdap?: BooleanOptInFlag | undefined, parsed_whois?: BooleanOptInFlag | undefined, next?: BooleanOptInFlag | undefined, format?: ResponseFormat | undefined, page_size?: number | undefined, position?: PositionToken | undefined, sort_by?: ('first_seen_since' | 'create_date' | 'domain' | 'risk_score') | undefined, sort_direction?: ('asc' | 'dsc') | undefined, app_name?: IdentifierString | undefined, app_partner?: IdentifierString | undefined, app_version?: IdentifierString | undefined}; export type GetApiV1IrisInvestigateOptions = {baseUrl?: string | undefined, headerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const baseContact = z.object({name: z.unknown(), org: z.unknown(), street: z.unknown(), city: z.unknown(), state: z.unknown(), postal: z.unknown(), country: z.unknown(), phone: z.unknown(), fax: z.unknown(), email: z.array(z.unknown()).optional()}); export const riskScoreValue = z.number().int().gte(0).lte(100); export const proximity = z.object({name: z.literal("proximity"), risk_score: riskScoreValue, evidence: z.array(z.string()).optional()}); export const threatProfile = z.object({name: z.literal("threat_profile"), risk_score: riskScoreValue, evidence: z.array(z.string()).optional()}); export const threatProfileMalware = z.object({name: z.literal("threat_profile_malware"), risk_score: riskScoreValue, evidence: z.array(z.string()).optional()}); export const threatProfilePhishing = z.object({name: z.literal("threat_profile_phishing"), risk_score: riskScoreValue, evidence: z.array(z.string()).optional()}); export const threatProfileSpam = z.object({name: z.literal("threat_profile_spam"), risk_score: riskScoreValue, evidence: z.array(z.string()).optional()}); export const zeroListedScore = z.object({name: z.literal("zerolist"), risk_score: z.literal(0)}); export const domainRiskComponent = z.discriminatedUnion("name", [proximity, threatProfile, threatProfileMalware, threatProfilePhishing, threatProfileSpam, zeroListedScore]); export const domainRisk = z.object({risk_score: riskScoreValue.optional(), components: z.array(domainRiskComponent).optional()}); export const baseSslInfo = z.object({hash: z.unknown(), subject: z.unknown(), organization: z.unknown(), email: z.array(z.string()).optional(), alt_names: z.array(z.unknown()).optional(), sources: z.object({active: z.number().int().optional(), passive: z.number().int().optional()}).optional(), common_name: z.unknown(), issuer_common_name: z.unknown(), not_after: z.unknown(), not_before: z.unknown(), duration: z.unknown()}); export const pivotedValue = z.object({value: z.union([z.string(), z.number().int()]).optional(), count: z.number().int().optional()}); export const whoisContact = z.object({name: pivotedValue.optional(), org: pivotedValue.optional(), street: pivotedValue.optional(), city: pivotedValue.optional(), state: pivotedValue.optional(), postal: pivotedValue.optional(), country: pivotedValue.optional(), phone: pivotedValue.optional(), fax: pivotedValue.optional(), email: z.array(pivotedValue).optional()}); export const parsedWhois = z.object({technical_contact: whoisContact.optional(), registrant_contact: whoisContact.optional(), admin_contact: whoisContact.optional(), additional_whois_email: z.array(pivotedValue).optional(), registrar: pivotedValue.optional(), create_date: pivotedValue.optional(), expiration_date: pivotedValue.optional(), registrant_name: pivotedValue.optional(), registrant_org: pivotedValue.optional(), registrar_status: z.array(pivotedValue).optional()}); export const rdapContact = z.object({name: pivotedValue.optional(), org: pivotedValue.optional(), street: pivotedValue.optional(), city: pivotedValue.optional(), state: pivotedValue.optional(), postal: pivotedValue.optional(), country: pivotedValue.optional(), phone: pivotedValue.optional(), fax: pivotedValue.optional(), email: z.array(pivotedValue).optional()}); export const parsedDomainRdap = z.object({registrant_contact: rdapContact.optional(), admin_contact: rdapContact.optional(), technical_contact: rdapContact.optional(), registrant_name: pivotedValue.optional(), registrar_iana_id: pivotedValue.optional(), additional_whois_email: z.array(pivotedValue).optional(), registrar: pivotedValue.optional(), create_date: pivotedValue.optional(), expiration_date: pivotedValue.optional(), registrar_status: z.array(pivotedValue).optional(), email_domain: z.array(pivotedValue).optional()}); export const investigateResult = z.object({domain: z.string().optional(), whois_url: z.string().optional(), adsense: z.unknown(), alexa: z.number().int().optional(), popularity_rank: z.number().optional(), active: z.boolean().optional(), google_analytics: z.unknown(), ga4: z.array(z.unknown()).optional(), gtm_codes: z.array(z.unknown()).optional(), fb_codes: z.array(z.unknown()).optional(), hotjar_codes: z.array(z.unknown()).optional(), baidu_codes: z.array(z.unknown()).optional(), yandex_codes: z.array(z.unknown()).optional(), matomo_codes: z.array(z.unknown()).optional(), statcounter_project_codes: z.array(z.unknown()).optional(), statcounter_security_codes: z.array(z.unknown()).optional(), admin_contact: baseContact.optional(), billing_contact: baseContact.optional(), registrant_contact: baseContact.optional(), technical_contact: baseContact.optional(), create_date: z.unknown(), expiration_date: z.unknown(), email_domain: z.array(z.unknown()).optional(), soa_email: z.array(z.unknown()).optional(), ssl_email: z.array(z.unknown()).optional(), additional_whois_email: z.array(z.unknown()).optional(), ip: z.array(z.object({address: z.unknown(), asn: z.array(z.unknown()).optional(), country_code: z.unknown(), isp: z.unknown()})).optional(), mx: z.array(z.object({host: z.unknown(), domain: z.unknown(), ip: z.array(z.unknown()).optional(), priority: z.number().optional()})).optional(), name_server: z.array(z.object({host: z.unknown(), domain: z.unknown(), ip: z.array(z.unknown()).optional()})).optional(), domain_risk: domainRisk.optional(), redirect: z.unknown(), redirect_domain: z.unknown(), registrant_name: z.unknown(), registrant_org: z.unknown(), registrar: z.unknown(), registrar_status: z.array(z.string()).optional(), spf_info: z.string().optional(), ssl_info: z.array(baseSslInfo).optional(), tld: z.string().optional(), website_response: z.number().optional(), data_updated_timestamp: z.string().optional(), website_title: z.unknown(), server_type: z.unknown(), first_seen: z.unknown(), tags: z.array(z.object({label: z.string().optional(), scope: z.string().optional(), tagged_at: z.string().optional()})).optional(), parsed_whois: parsedWhois.optional(), parsed_domain_rdap: parsedDomainRdap.optional()}); export const apexDomain = z.string(); export const getApiV1IrisInvestigateResponse = z.object({response: z.object({limit_exceeded: z.boolean().optional(), has_more_results: z.boolean().optional(), message: z.string().optional(), results_count: z.number().int().optional(), total_count: z.number().int().optional(), results: z.array(investigateResult).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 data from a GET request. * Parameters are identified in descriptions as either base or filter. * Search with base parameters and filter down base results with filter parameters. * * * GET /v1/iris-investigate/ * * Also accepts auth: open_key_auth, hmac_auth */ export const getApiV1IrisInvestigate = async (args: GetApiV1IrisInvestigateArgs, options?: GetApiV1IrisInvestigateOptions) => { 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.adsense != null) query.append("adsense", String(args.adsense)) if (args.baidu_analytics != null) query.append("baidu_analytics", String(args.baidu_analytics)) if (args.contact_name != null) query.append("contact_name", String(args.contact_name)) if (args.contact_phone != null) query.append("contact_phone", String(args.contact_phone)) if (args.contact_street != null) query.append("contact_street", String(args.contact_street)) if (args.ip != null) query.append("ip", String(args.ip)) if (args.domain != null) query.append("domain", String(args.domain)) if (args.email != null) query.append("email", String(args.email)) if (args.email_dns_soa != null) query.append("email_dns_soa", String(args.email_dns_soa)) if (args.email_domain != null) query.append("email_domain", String(args.email_domain)) if (args.facebook != null) query.append("facebook", String(args.facebook)) if (args.ga4 != null) query.append("ga4", String(args.ga4)) if (args.google_analytics != null) query.append("google_analytics", String(args.google_analytics)) if (args.google_tag_manager != null) query.append("google_tag_manager", String(args.google_tag_manager)) if (args.hotjar != null) query.append("hotjar", String(args.hotjar)) if (args.iana_id != null) query.append("iana_id", String(args.iana_id)) if (args.mailserver_domain != null) query.append("mailserver_domain", String(args.mailserver_domain)) if (args.mailserver_host != null) query.append("mailserver_host", String(args.mailserver_host)) if (args.mailserver_ip != null) query.append("mailserver_ip", String(args.mailserver_ip)) if (args.matomo != null) query.append("matomo", String(args.matomo)) if (args.nameserver_domain != null) query.append("nameserver_domain", String(args.nameserver_domain)) if (args.nameserver_host != null) query.append("nameserver_host", String(args.nameserver_host)) if (args.nameserver_ip != null) query.append("nameserver_ip", String(args.nameserver_ip)) if (args.redirect_domain != null) query.append("redirect_domain", String(args.redirect_domain)) if (args.registrant != null) query.append("registrant", String(args.registrant)) if (args.historical_registrant != null) query.append("historical_registrant", String(args.historical_registrant)) if (args.registrant_org != null) query.append("registrant_org", String(args.registrant_org)) if (args.registrar != null) query.append("registrar", String(args.registrar)) if (args.search_hash != null) query.append("search_hash", String(args.search_hash)) if (args.server_type != null) query.append("server_type", String(args.server_type)) if (args.ssl_alt_names != null) query.append("ssl_alt_names", String(args.ssl_alt_names)) if (args.ssl_common_name != null) query.append("ssl_common_name", String(args.ssl_common_name)) if (args.ssl_duration != null) query.append("ssl_duration", String(args.ssl_duration)) if (args.ssl_email != null) query.append("ssl_email", String(args.ssl_email)) if (args.ssl_hash != null) query.append("ssl_hash", String(args.ssl_hash)) if (args.ssl_org != null) query.append("ssl_org", String(args.ssl_org)) if (args.ssl_subject != null) query.append("ssl_subject", String(args.ssl_subject)) if (args.ssl_issuer_common_name != null) query.append("ssl_issuer_common_name", String(args.ssl_issuer_common_name)) if (args.statcounter_project != null) query.append("statcounter_project", String(args.statcounter_project)) if (args.statcounter_security != null) query.append("statcounter_security", String(args.statcounter_security)) if (args.tagged_with_all != null) query.append("tagged_with_all", String(args.tagged_with_all)) if (args.tagged_with_any != null) query.append("tagged_with_any", String(args.tagged_with_any)) if (args.website_title != null) query.append("website_title", String(args.website_title)) if (args.whois != null) query.append("whois", String(args.whois)) if (args.historical_free_text != null) query.append("historical_free_text", String(args.historical_free_text)) if (args.yandex_metrica != null) query.append("yandex_metrica", String(args.yandex_metrica)) if (args.active != null) query.append("active", String(args.active)) if (args.create_date != null) query.append("create_date", String(args.create_date)) if (args.create_date_within != null) query.append("create_date_within", String(args.create_date_within)) if (args.expiration_date != null) query.append("expiration_date", String(args.expiration_date)) if (args.first_seen_since != null) query.append("first_seen_since", String(args.first_seen_since)) if (args.first_seen_within != null) query.append("first_seen_within", String(args.first_seen_within)) if (args.ip_country_code != null) query.append("ip_country_code", String(args.ip_country_code)) if (args.not_tagged_with_all != null) query.append("not_tagged_with_all", String(args.not_tagged_with_all)) if (args.not_tagged_with_any != null) query.append("not_tagged_with_any", String(args.not_tagged_with_any)) if (args.rank != null) query.append("rank", String(args.rank)) if (args.risk_score != null) query.append("risk_score", String(args.risk_score)) if (args.ssl_not_after != null) query.append("ssl_not_after", String(args.ssl_not_after)) if (args.ssl_not_before != null) query.append("ssl_not_before", String(args.ssl_not_before)) if (args.tld != null) query.append("tld", String(args.tld)) 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.next != null) query.append("next", String(args.next)) if (args.format != null) query.append("format", String(args.format)) if (args.page_size != null) query.append("page_size", String(args.page_size)) if (args.position != null) query.append("position", String(args.position)) if (args.sort_by != null) query.append("sort_by", String(args.sort_by)) if (args.sort_direction != null) query.append("sort_direction", String(args.sort_direction)) 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 (headerAuth !== undefined) headers.set("X-Api-Key", headerAuth) const url = `${baseUrl.replace(/\/+$/, '')}/v1/iris-investigate/${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(getApiV1IrisInvestigateResponse, await res.json()) };