@visulima/email-verifier 1.0.0 → 1.0.2

package/dist/packem_shared/mx.d-NAesS5sg.d.ts

@@ -1,117 +0,0 @@
-/**
-* Generic cache interface for caching any type of data.
-* Implementations can use in-memory cache, LRU cache, Redis, etc.
-*/
-interface Cache<T = unknown> {
-  /**
-  * Clears all cached entries.
-  */
-  clear: () => Promise<void>;
-  /**
-  * Deletes a cached entry.
-  * @param key The cache key.
-  */
-  delete: (key: string) => Promise<void>;
-  /**
-  * Gets a cached value.
-  * @param key The cache key.
-  * @returns The cached value or undefined if not found or expired.
-  */
-  get: (key: string) => Promise<T | undefined>;
-  /**
-  * Sets a cached value.
-  * @param key The cache key.
-  * @param value The value to cache.
-  * @param ttl Time-to-live in milliseconds.
-  */
-  set: (key: string, value: T, ttl: number) => Promise<void>;
-}
-/**
-* Options for creating an in-memory cache.
-*/
-interface InMemoryCacheOptions {
-  /**
-  * Maximum number of entries in the cache.
-  * @default 500
-  */
-  max?: number;
-  /**
-  * Default TTL in milliseconds for entries.
-  * @default 3600000 (1 hour)
-  */
-  ttl?: number;
-}
-/**
-* Default in-memory cache implementation using LRU cache.
-*
-* Shared by the MX and SMTP probes so repeated lookups against the same domain
-* (e.g. when verifying a list) avoid redundant DNS/socket work.
-*/
-declare class InMemoryCache<T extends object = Record<string, unknown>> implements Cache<T> {
-  private readonly cache;
-  constructor(options?: InMemoryCacheOptions);
-  clear: () => Promise<void>;
-  delete: (key: string) => Promise<void>;
-  get: (key: string) => Promise<T | undefined>;
-  set: (key: string, value: T, ttl: number) => Promise<void>;
-}
-/**
-* MX record information.
-*/
-interface MxRecord {
-  exchange: string;
-  priority: number;
-}
-/**
-* How the domain's mail-acceptance was established.
-*
-* - `mx`: the domain published MX records.
-* - `address`: the domain has no MX but resolves to an A/AAAA record, so by RFC 5321 §5.1 the address itself is treated as an implicit MX.
-* - `none`: neither MX nor address records exist.
-*/
-type MxResolution = "address" | "mx" | "none";
-/**
-* Result of an MX/domain check.
-*/
-interface MxCheckResult {
-  /** True when the domain itself resolves but publishes no MX records. */
-  domainResolves: boolean;
-  error?: string;
-  records?: MxRecord[];
-  resolvedVia: MxResolution;
-  /** True when the domain can accept mail (has MX or A/AAAA records). */
-  valid: boolean;
-}
-/**
-* Options for MX record checking.
-*/
-interface MxCheckOptions {
-  cache?: Cache<MxCheckResult>;
-  /**
-  * When true (the default), a domain with no MX records but a resolvable
-  * A/AAAA record is still considered able to accept mail (implicit MX).
-  */
-  fallbackToAddress?: boolean;
-  ttl?: number;
-}
-/**
-* Checks MX records for a domain, with an optional A/AAAA fallback.
-*
-* Distinguishes three states emailable separates as "MX Record Detection" and
-* "Domain Validation": records present (`mx`), no MX but the domain resolves
-* (`address`, implicit MX), and nothing resolves (`none`).
-* @param domain The domain to check.
-* @param options Options including caching and the address fallback toggle.
-* @returns The MX/domain check result.
-* @example
-* ```ts
-* import { checkMxRecords } from "@visulima/email-verifier/checks/mx";
-*
-* const result = await checkMxRecords("example.com");
-* if (result.valid) {
-*     console.log(result.resolvedVia, result.records);
-* }
-* ```
-*/
-declare const checkMxRecords: (domain: string, options?: MxCheckOptions) => Promise<MxCheckResult>;
-export { Cache as C, InMemoryCache as I, MxCheckOptions as M, InMemoryCacheOptions as a, MxCheckResult as b, MxRecord as c, MxResolution as d, checkMxRecords as e };