@aoxborrow/registrar-client 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,768 @@
+import { X2jOptions } from 'fast-xml-parser';
+
+declare const Feature: {
+    readonly TestConnection: "testConnection";
+    readonly ListDomains: "listDomains";
+    readonly GetDomain: "getDomain";
+    readonly CheckAvailability: "checkAvailability";
+    readonly GetPricing: "getPricing";
+    readonly RegisterDomain: "registerDomain";
+    readonly RenewDomain: "renewDomain";
+    readonly SetAutoRenew: "setAutoRenew";
+    readonly TransferIn: "transferIn";
+    readonly UpdateNameservers: "updateNameservers";
+    readonly GetNameservers: "getNameservers";
+    readonly LockDomain: "lockDomain";
+    readonly UnlockDomain: "unlockDomain";
+    readonly SetPrivacy: "setPrivacy";
+    readonly GetContacts: "getContacts";
+    readonly UpdateContacts: "updateContacts";
+    readonly GetDnsRecords: "getDnsRecords";
+    readonly SetDnsRecords: "setDnsRecords";
+    readonly GetAuthCode: "getAuthCode";
+    readonly GetDnssec: "getDnssec";
+    readonly DisableDnssec: "disableDnssec";
+    readonly GetEmailForwarding: "getEmailForwarding";
+    readonly SetEmailForwarding: "setEmailForwarding";
+    readonly GetDomainForwarding: "getDomainForwarding";
+    readonly SetDomainForwarding: "setDomainForwarding";
+};
+type RegistrarFeature = (typeof Feature)[keyof typeof Feature];
+declare const CORE_FEATURES: readonly ["testConnection", "listDomains", "getDomain", "checkAvailability", "getPricing", "registerDomain", "renewDomain", "setAutoRenew", "transferIn", "updateNameservers", "getNameservers", "lockDomain", "unlockDomain", "setPrivacy", "getContacts", "updateContacts", "getDnsRecords", "setDnsRecords"];
+declare const EXTENDED_FEATURES: readonly ["getAuthCode", "getDnssec", "disableDnssec", "getEmailForwarding", "setEmailForwarding", "getDomainForwarding", "setDomainForwarding"];
+declare const ALL_FEATURES: readonly ["testConnection", "listDomains", "getDomain", "checkAvailability", "getPricing", "registerDomain", "renewDomain", "setAutoRenew", "transferIn", "updateNameservers", "getNameservers", "lockDomain", "unlockDomain", "setPrivacy", "getContacts", "updateContacts", "getDnsRecords", "setDnsRecords", "getAuthCode", "getDnssec", "disableDnssec", "getEmailForwarding", "setEmailForwarding", "getDomainForwarding", "setDomainForwarding"];
+declare function isCoreFeature(feature: RegistrarFeature): boolean;
+
+interface RegistrarClientOptions {
+    timeout: number;
+    retries: number;
+    backoff: number;
+    signal?: AbortSignal;
+}
+type RequestOptions = Partial<RegistrarClientOptions>;
+interface ListDomainsOptions extends RequestOptions {
+    search?: string;
+    detailed?: boolean;
+}
+type RegistrarEnvironment = 'production' | 'sandbox';
+interface RegistrarOptions extends Partial<RegistrarClientOptions> {
+    environment?: RegistrarEnvironment;
+}
+interface ConnectionResult {
+    success: boolean;
+    message: string;
+}
+interface OperationResult {
+    success: boolean;
+    message: string;
+}
+interface ConfigField {
+    name: string;
+    label: string;
+    type: 'text' | 'password' | 'select';
+    required: boolean;
+    options?: string[];
+    default?: string;
+}
+interface Domain {
+    domainName: string;
+    registrar: string;
+    status: string;
+    createdDate: Date | null;
+    expirationDate: Date | null;
+    renewalDate: Date | null;
+    autoRenew: boolean;
+    locked: boolean;
+    privacy: boolean;
+    nameservers: string[];
+    syncedAt: Date;
+    deleted: boolean;
+}
+interface DomainInput {
+    domainName?: string;
+    registrar?: string;
+    status?: string;
+    createdDate?: Date | string | number | null;
+    expirationDate?: Date | string | number | null;
+    renewalDate?: Date | string | number | null;
+    autoRenew?: boolean;
+    locked?: boolean;
+    privacy?: boolean;
+    nameservers?: unknown;
+    syncedAt?: Date;
+    deleted?: boolean;
+}
+interface Contact {
+    firstName: string;
+    lastName: string;
+    organization?: string;
+    email: string;
+    phone: string;
+    fax?: string;
+    address1: string;
+    address2?: string;
+    city: string;
+    state?: string;
+    postalCode: string;
+    country: string;
+}
+interface ContactSet {
+    registrant?: Contact;
+    admin?: Contact;
+    tech?: Contact;
+    billing?: Contact;
+}
+interface DnsRecord {
+    type: string;
+    name: string;
+    value: string;
+    ttl?: number;
+    priority?: number;
+    weight?: number;
+    port?: number;
+}
+interface DomainAvailability {
+    domainName: string;
+    available: boolean;
+    premium?: boolean;
+    price?: number;
+    currency?: string;
+    period?: number;
+}
+interface TldPricing {
+    tld: string;
+    currency: string;
+    registration?: number;
+    renewal?: number;
+    transfer?: number;
+}
+interface RegistrationConsent {
+    agreedBy: string;
+    agreedAt?: string;
+}
+interface TransferDomainInput {
+    authCode: string;
+    years?: number;
+    contacts?: ContactSet;
+    consent?: RegistrationConsent;
+    privacy?: boolean;
+    autoRenew?: boolean;
+}
+interface RegisterDomainInput {
+    years?: number;
+    contacts: ContactSet;
+    nameservers?: string[];
+    privacy?: boolean;
+    autoRenew?: boolean;
+    consent?: RegistrationConsent;
+}
+type RegistrarCredentials = Record<string, string>;
+interface EmailForward {
+    alias: string;
+    forwardTo: string;
+}
+type DomainForwardType = 'temporary' | 'permanent' | 'masked';
+interface DomainForward {
+    host: string;
+    url: string;
+    type: DomainForwardType;
+}
+interface DsRecord {
+    keyTag: number;
+    algorithm: number;
+    digestType: number;
+    digest: string;
+}
+interface DnssecStatus {
+    enabled: boolean;
+    dsRecords: DsRecord[];
+}
+interface Registrar {
+    readonly name: string;
+    readonly environment: RegistrarEnvironment;
+    readonly features: readonly RegistrarFeature[];
+    supports(feature: RegistrarFeature): boolean;
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    renewDomain(domainName: string, years?: number, opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    transferIn(domainName: string, input: TransferDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    lockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    setPrivacy(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    getContacts(domainName: string, opts?: RequestOptions): Promise<ContactSet>;
+    updateContacts(domainName: string, contacts: ContactSet, opts?: RequestOptions): Promise<OperationResult>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    getEmailForwarding(domainName: string, opts?: RequestOptions): Promise<EmailForward[]>;
+    setEmailForwarding(domainName: string, forwards: EmailForward[], opts?: RequestOptions): Promise<OperationResult>;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+    getAuthCode(domainName: string, opts?: RequestOptions): Promise<string>;
+    getDnssec(domainName: string, opts?: RequestOptions): Promise<DnssecStatus>;
+    disableDnssec(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+}
+interface RegistrarConstructor {
+    new (credentials: RegistrarCredentials, options?: RegistrarOptions): Registrar;
+    readonly displayName: string;
+    readonly configFields: ConfigField[];
+    readonly helpText: string;
+    readonly supportsSandbox: boolean;
+    readonly extendedFeatures: readonly RegistrarFeature[];
+    readonly features: readonly RegistrarFeature[];
+}
+
+declare class RegistrarClient {
+    readonly provider: Registrar;
+    constructor(provider: Registrar);
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    private enrichWithDetail;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    renewDomain(domainName: string, years?: number, opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    transferIn(domainName: string, input: TransferDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    lockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    setPrivacy(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    getContacts(domainName: string, opts?: RequestOptions): Promise<ContactSet>;
+    updateContacts(domainName: string, contacts: ContactSet, opts?: RequestOptions): Promise<OperationResult>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    getEmailForwarding(domainName: string, opts?: RequestOptions): Promise<EmailForward[]>;
+    setEmailForwarding(domainName: string, forwards: EmailForward[], opts?: RequestOptions): Promise<OperationResult>;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+}
+
+type DomainSource = Registrar | RegistrarClient;
+interface PortfolioError {
+    registrar: string;
+    error: Error;
+}
+interface PortfolioResult {
+    domains: Domain[];
+    errors: PortfolioError[];
+}
+declare function listPortfolio(sources: DomainSource[], opts?: ListDomainsOptions): Promise<PortfolioResult>;
+
+declare function toRegistrarError(error: unknown): RegistrarError;
+declare class RegistrarError extends Error {
+    status: number;
+    providerCode?: string;
+    constructor(message: string);
+    shouldRetry(): boolean;
+}
+declare class RetryableRegistrarError extends RegistrarError {
+    constructor(message: string);
+    shouldRetry(): boolean;
+}
+declare class TimeoutError extends RetryableRegistrarError {
+    status: number;
+    constructor(message: string);
+}
+declare class ConnectionError extends RetryableRegistrarError {
+    status: number;
+    constructor(message: string);
+}
+declare class AuthenticationError extends RegistrarError {
+    status: number;
+    constructor(message: string);
+}
+declare class AuthorizationError extends RegistrarError {
+    status: number;
+    constructor(message: string);
+}
+declare class NotFoundError extends RegistrarError {
+    status: number;
+    constructor(message: string);
+}
+declare class RateLimitError extends RetryableRegistrarError {
+    status: number;
+    retryAfter?: number;
+    constructor(message: string, retryAfter?: number);
+}
+declare class InvalidResponseError extends RetryableRegistrarError {
+    status: number;
+    constructor(message: string);
+}
+declare class ParsingError extends RegistrarError {
+    status: number;
+    constructor(message: string);
+}
+declare class ConfigurationError extends RegistrarError {
+    status: number;
+    constructor(message: string);
+}
+declare class ConsentRequiredError extends RegistrarError {
+    status: number;
+    constructor(message: string);
+}
+declare class NotImplementedError extends RegistrarError {
+    status: number;
+    constructor(message: string);
+}
+declare class AbortError extends RegistrarError {
+    status: number;
+    constructor(message: string);
+    shouldRetry(): boolean;
+}
+
+interface HttpClientConfig {
+    baseUrl: string;
+    headers?: Record<string, string>;
+    options: RegistrarClientOptions;
+}
+interface RequestConfig {
+    method?: string;
+    path: string;
+    query?: Record<string, string | number | boolean | undefined>;
+    body?: unknown;
+    headers?: Record<string, string>;
+    timeout?: number;
+    retries?: number;
+    backoff?: number;
+    signal?: AbortSignal;
+}
+declare class HttpClient {
+    protected config: HttpClientConfig;
+    constructor(config: HttpClientConfig);
+    request<T = unknown>(req: RequestConfig): Promise<T>;
+    requestText(req: RequestConfig): Promise<string>;
+    protected withRetries<T>(req: RequestConfig, attemptFn: () => Promise<T>): Promise<T>;
+    protected buildUrl(req: RequestConfig): string;
+    protected send(req: RequestConfig): Promise<string>;
+    protected toStatusError(response: Response, url: string): Promise<RegistrarError>;
+}
+
+declare function selectBaseUrl(registrar: string, environment: RegistrarEnvironment | undefined, urls: {
+    production: string;
+    sandbox?: string;
+}): string;
+declare abstract class BaseRegistrar implements Registrar {
+    abstract readonly name: string;
+    protected http: HttpClient;
+    protected credentials: RegistrarCredentials;
+    protected options: RegistrarClientOptions;
+    readonly environment: RegistrarEnvironment;
+    static readonly extendedFeatures: readonly RegistrarFeature[];
+    static get features(): readonly RegistrarFeature[];
+    get features(): readonly RegistrarFeature[];
+    supports(feature: RegistrarFeature): boolean;
+    constructor(credentials: RegistrarCredentials, httpConfig: Omit<HttpClientConfig, 'options'>, options?: RegistrarOptions);
+    testConnection(_opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(_opts?: ListDomainsOptions): Promise<Domain[]>;
+    renewDomain(_domainName: string, _years?: number, _opts?: RequestOptions): Promise<OperationResult>;
+    updateNameservers(_domainName: string, _nameservers: string[], _opts?: RequestOptions): Promise<OperationResult>;
+    lockDomain(_domainName: string, _opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(_domainName: string, _opts?: RequestOptions): Promise<OperationResult>;
+    getDomain(_domainName: string, _opts?: RequestOptions): Promise<Domain>;
+    checkAvailability(_domainNames: string[], _opts?: RequestOptions): Promise<DomainAvailability[]>;
+    getPricing(_tldOrDomain: string, _opts?: RequestOptions): Promise<TldPricing>;
+    registerDomain(_domainName: string, _input: RegisterDomainInput, _opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(_domainName: string, _enabled: boolean, _opts?: RequestOptions): Promise<OperationResult>;
+    transferIn(_domainName: string, _input: TransferDomainInput, _opts?: RequestOptions): Promise<OperationResult>;
+    getNameservers(_domainName: string, _opts?: RequestOptions): Promise<string[]>;
+    setPrivacy(_domainName: string, _enabled: boolean, _opts?: RequestOptions): Promise<OperationResult>;
+    getContacts(_domainName: string, _opts?: RequestOptions): Promise<ContactSet>;
+    updateContacts(_domainName: string, _contacts: ContactSet, _opts?: RequestOptions): Promise<OperationResult>;
+    getDnsRecords(_domainName: string, _opts?: RequestOptions): Promise<DnsRecord[]>;
+    setDnsRecords(_domainName: string, _records: DnsRecord[], _opts?: RequestOptions): Promise<OperationResult>;
+    getEmailForwarding(_domainName: string, _opts?: RequestOptions): Promise<EmailForward[]>;
+    setEmailForwarding(_domainName: string, _forwards: EmailForward[], _opts?: RequestOptions): Promise<OperationResult>;
+    getDomainForwarding(_domainName: string, _opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(_domainName: string, _forwards: DomainForward[], _opts?: RequestOptions): Promise<OperationResult>;
+    getAuthCode(_domainName: string, _opts?: RequestOptions): Promise<string>;
+    getDnssec(_domainName: string, _opts?: RequestOptions): Promise<DnssecStatus>;
+    disableDnssec(_domainName: string, _opts?: RequestOptions): Promise<OperationResult>;
+    protected notImplemented(method: string): Promise<never>;
+}
+
+declare class CloudflareRegistrar extends BaseRegistrar {
+    readonly name = "cloudflare";
+    static readonly displayName = "Cloudflare";
+    static readonly helpText: string;
+    static readonly configFields: ConfigField[];
+    static readonly supportsSandbox = false;
+    static readonly extendedFeatures: readonly RegistrarFeature[];
+    constructor(credentials: RegistrarCredentials, options?: RegistrarOptions);
+    private get accountPath();
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    private toDomain;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    getContacts(domainName: string, opts?: RequestOptions): Promise<ContactSet>;
+    private get registrarPath();
+    private domainCheck;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    private findZone;
+    private requireZone;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+    private getRedirectRuleset;
+    private ensurePlaceholderRecord;
+    private removePlaceholderRecords;
+    getEmailForwarding(domainName: string, opts?: RequestOptions): Promise<EmailForward[]>;
+    setEmailForwarding(domainName: string, forwards: EmailForward[], opts?: RequestOptions): Promise<OperationResult>;
+    private ensureDestinations;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    private static readonly UPDATE_UNAVAILABLE;
+    renewDomain(_domainName: string, _years?: number, _opts?: RequestOptions): Promise<OperationResult>;
+    updateNameservers(_domainName: string, _nameservers: string[], _opts?: RequestOptions): Promise<OperationResult>;
+    lockDomain(_domainName: string, _opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(_domainName: string, _opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(_domainName: string, _enabled: boolean, _opts?: RequestOptions): Promise<OperationResult>;
+    setPrivacy(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    private findDomain;
+    private patchDomain;
+}
+
+declare class DynadotRegistrar extends BaseRegistrar {
+    readonly name = "dynadot";
+    static readonly displayName = "Dynadot";
+    static readonly helpText: string;
+    static readonly configFields: ConfigField[];
+    static readonly supportsSandbox = true;
+    static readonly extendedFeatures: readonly RegistrarFeature[];
+    constructor(credentials: RegistrarCredentials, options?: RegistrarOptions);
+    private signedRequest;
+    private read;
+    private mutate;
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    private domainInfo;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    getContacts(domainName: string, opts?: RequestOptions): Promise<ContactSet>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    private renewPriceCheck;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    transferIn(domainName: string, input: TransferDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    renewDomain(domainName: string, years?: number, opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    lockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    private setLock;
+    setPrivacy(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    updateContacts(domainName: string, contacts: ContactSet, opts?: RequestOptions): Promise<OperationResult>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    getAuthCode(domainName: string, opts?: RequestOptions): Promise<string>;
+    getDnssec(domainName: string, opts?: RequestOptions): Promise<DnssecStatus>;
+    disableDnssec(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    getEmailForwarding(domainName: string, opts?: RequestOptions): Promise<EmailForward[]>;
+    setEmailForwarding(domainName: string, forwards: EmailForward[], opts?: RequestOptions): Promise<OperationResult>;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+    private toDomain;
+}
+
+declare class GandiRegistrar extends BaseRegistrar {
+    readonly name = "gandi";
+    static readonly displayName = "Gandi.net";
+    static readonly helpText: string;
+    static readonly configFields: ConfigField[];
+    static readonly supportsSandbox = true;
+    static readonly extendedFeatures: readonly RegistrarFeature[];
+    constructor(credentials: RegistrarCredentials, options?: RegistrarOptions);
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    private toDomain;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    getContacts(domainName: string, opts?: RequestOptions): Promise<ContactSet>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    renewDomain(domainName: string, years?: number, opts?: RequestOptions): Promise<OperationResult>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    lockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    getAuthCode(domainName: string, opts?: RequestOptions): Promise<string>;
+    getDnssec(domainName: string, opts?: RequestOptions): Promise<DnssecStatus>;
+    disableDnssec(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    getEmailForwarding(domainName: string, opts?: RequestOptions): Promise<EmailForward[]>;
+    setEmailForwarding(domainName: string, forwards: EmailForward[], opts?: RequestOptions): Promise<OperationResult>;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    setPrivacy(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    updateContacts(domainName: string, contacts: ContactSet, opts?: RequestOptions): Promise<OperationResult>;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    transferIn(domainName: string, input: TransferDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    private mutate;
+}
+
+declare class GoDaddyRegistrar extends BaseRegistrar {
+    readonly name = "godaddy";
+    static readonly displayName = "GoDaddy";
+    static readonly helpText: string;
+    static readonly configFields: ConfigField[];
+    static readonly supportsSandbox = true;
+    static readonly extendedFeatures: readonly RegistrarFeature[];
+    private readonly useV3;
+    private customerIdPromise?;
+    constructor(credentials: RegistrarCredentials, options?: RegistrarOptions);
+    private static authHeader;
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    private listDomainsV3;
+    private listDomainsV1;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    private registerDomainV3;
+    private pollOperation;
+    transferIn(domainName: string, input: TransferDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    private buildConsent;
+    renewDomain(domainName: string, years?: number, opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    lockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    setPrivacy(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    getContacts(domainName: string, opts?: RequestOptions): Promise<ContactSet>;
+    updateContacts(domainName: string, contacts: ContactSet, opts?: RequestOptions): Promise<OperationResult>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    private getV3Records;
+    private setDnsRecordsV3;
+    private resolveCustomerId;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+    private forwardPath;
+    getAuthCode(domainName: string, opts?: RequestOptions): Promise<string>;
+    private toDomain;
+    private toDomainV3;
+    private mutate;
+}
+
+declare class NameBrightRegistrar extends BaseRegistrar {
+    readonly name = "namebright";
+    static readonly displayName = "NameBright";
+    static readonly helpText: string;
+    static readonly configFields: ConfigField[];
+    static readonly supportsSandbox = false;
+    static readonly extendedFeatures: readonly RegistrarFeature[];
+    private token?;
+    private tokenExpiresAt;
+    constructor(credentials: RegistrarCredentials, options?: RegistrarOptions);
+    private getToken;
+    private authed;
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    getAuthCode(domainName: string, opts?: RequestOptions): Promise<string>;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    getContacts(domainName: string, opts?: RequestOptions): Promise<ContactSet>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    getPricing(_tldOrDomain: string, _opts?: RequestOptions): Promise<TldPricing>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    lockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    setPrivacy(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    renewDomain(domainName: string, years?: number, opts?: RequestOptions): Promise<OperationResult>;
+    private purchase;
+    private setDomainFlag;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    private toDomain;
+}
+
+declare class NamecheapRegistrar extends BaseRegistrar {
+    readonly name = "namecheap";
+    static readonly displayName = "Namecheap";
+    static readonly helpText: string;
+    static readonly configFields: ConfigField[];
+    static readonly supportsSandbox = true;
+    static readonly extendedFeatures: readonly RegistrarFeature[];
+    constructor(credentials: RegistrarCredentials, options?: RegistrarOptions);
+    private baseQuery;
+    private call;
+    private command;
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    private getRegistrarLock;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    transferIn(domainName: string, input: TransferDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    renewDomain(domainName: string, years?: number, opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    lockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    setPrivacy(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    getContacts(domainName: string, opts?: RequestOptions): Promise<ContactSet>;
+    updateContacts(domainName: string, contacts: ContactSet, opts?: RequestOptions): Promise<OperationResult>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    getEmailForwarding(domainName: string, opts?: RequestOptions): Promise<EmailForward[]>;
+    setEmailForwarding(domainName: string, forwards: EmailForward[], opts?: RequestOptions): Promise<OperationResult>;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+}
+
+declare class NameSiloRegistrar extends BaseRegistrar {
+    readonly name = "namesilo";
+    static readonly displayName = "NameSilo";
+    static readonly helpText: string;
+    static readonly configFields: ConfigField[];
+    static readonly supportsSandbox = true;
+    static readonly extendedFeatures: readonly RegistrarFeature[];
+    constructor(credentials: RegistrarCredentials, options?: RegistrarOptions);
+    private call;
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    getContacts(domainName: string, opts?: RequestOptions): Promise<ContactSet>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    renewDomain(domainName: string, years?: number, opts?: RequestOptions): Promise<OperationResult>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    lockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    getDnssec(domainName: string, opts?: RequestOptions): Promise<DnssecStatus>;
+    disableDnssec(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    private listEmailForwards;
+    getEmailForwarding(domainName: string, opts?: RequestOptions): Promise<EmailForward[]>;
+    setEmailForwarding(domainName: string, forwards: EmailForward[], opts?: RequestOptions): Promise<OperationResult>;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    setPrivacy(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    updateContacts(domainName: string, contacts: ContactSet, opts?: RequestOptions): Promise<OperationResult>;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    transferIn(domainName: string, input: TransferDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+}
+
+declare class PorkbunRegistrar extends BaseRegistrar {
+    readonly name = "porkbun";
+    static readonly displayName = "Porkbun";
+    static readonly helpText: string;
+    static readonly configFields: ConfigField[];
+    static readonly supportsSandbox = true;
+    static readonly extendedFeatures: readonly RegistrarFeature[];
+    constructor(credentials: RegistrarCredentials, options?: RegistrarOptions);
+    private call;
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    getContacts(_domainName: string, _opts?: RequestOptions): Promise<ContactSet>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    private tldPricing;
+    private renewPriceCheck;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    renewDomain(domainName: string, _years?: number, opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    transferIn(domainName: string, input: TransferDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    updateContacts(domainName: string, contacts: ContactSet, opts?: RequestOptions): Promise<OperationResult>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    getDnssec(domainName: string, opts?: RequestOptions): Promise<DnssecStatus>;
+    disableDnssec(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+}
+
+declare class SpaceshipRegistrar extends BaseRegistrar {
+    readonly name = "spaceship";
+    static readonly displayName = "Spaceship";
+    static readonly helpText: string;
+    static readonly configFields: ConfigField[];
+    static readonly supportsSandbox = false;
+    static readonly extendedFeatures: readonly RegistrarFeature[];
+    constructor(credentials: RegistrarCredentials, options?: RegistrarOptions);
+    testConnection(opts?: RequestOptions): Promise<ConnectionResult>;
+    listDomains(opts?: ListDomainsOptions): Promise<Domain[]>;
+    getDomain(domainName: string, opts?: RequestOptions): Promise<Domain>;
+    getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]>;
+    getAuthCode(domainName: string, opts?: RequestOptions): Promise<string>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    getPricing(_tldOrDomain: string, _opts?: RequestOptions): Promise<TldPricing>;
+    registerDomain(domainName: string, input: RegisterDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    transferIn(domainName: string, input: TransferDomainInput, opts?: RequestOptions): Promise<OperationResult>;
+    renewDomain(domainName: string, years?: number, opts?: RequestOptions): Promise<OperationResult>;
+    setAutoRenew(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    lockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    unlockDomain(domainName: string, opts?: RequestOptions): Promise<OperationResult>;
+    setPrivacy(domainName: string, enabled: boolean, opts?: RequestOptions): Promise<OperationResult>;
+    getContacts(domainName: string, opts?: RequestOptions): Promise<ContactSet>;
+    updateContacts(domainName: string, contacts: ContactSet, opts?: RequestOptions): Promise<OperationResult>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    private getRaw;
+    private getContact;
+    private saveContactSet;
+    private saveContact;
+    private fetchRecords;
+    private toDomain;
+    private mutate;
+}
+
+declare const registrars: {
+    cloudflare: typeof CloudflareRegistrar;
+    dynadot: typeof DynadotRegistrar;
+    gandi: typeof GandiRegistrar;
+    godaddy: typeof GoDaddyRegistrar;
+    namebright: typeof NameBrightRegistrar;
+    namecheap: typeof NamecheapRegistrar;
+    namesilo: typeof NameSiloRegistrar;
+    porkbun: typeof PorkbunRegistrar;
+    spaceship: typeof SpaceshipRegistrar;
+};
+type RegistrarName = keyof typeof registrars;
+declare function createRegistrar(name: RegistrarName, credentials: RegistrarCredentials, options?: RegistrarOptions): Registrar;
+
+declare function parseXml<T = unknown>(xml: string, options?: Partial<X2jOptions>): T;
+declare function ensureArray<T>(value: T | T[] | undefined | null): T[];
+
+declare const DEFAULT_OPTIONS: RegistrarClientOptions;
+declare const USER_AGENT = "@aoxborrow/registrar-client";
+
+declare function sleep(ms: number): Promise<void>;
+type SettableDomainForward = DomainForward & {
+    type: 'temporary' | 'permanent';
+};
+declare const MASKED_FORWARD_UNSUPPORTED = "masked/framed forwarding is not supported by this library; use \"temporary\" or \"permanent\"";
+declare function settableForwards(forwards: DomainForward[]): SettableDomainForward[];
+declare function requireConsent(provider: string, consent: RegistrationConsent | undefined): RegistrationConsent;
+declare function filterDomains(domains: Domain[], search?: string): Domain[];
+declare function normalizeDomain(domain: string): string;
+declare function backoffDelay(backoff: number, attempt: number): number;
+declare function parseDate(value: Date | string | number | null | undefined): Date | null;
+declare function normalizeNameservers(nameservers: unknown): string[];
+declare function createDomain(data?: DomainInput): Domain;
+
+export { ALL_FEATURES, AbortError, AuthenticationError, AuthorizationError, BaseRegistrar, CORE_FEATURES, CloudflareRegistrar, type ConfigField, ConfigurationError, ConnectionError, type ConnectionResult, ConsentRequiredError, type Contact, type ContactSet, DEFAULT_OPTIONS, type DnsRecord, type DnssecStatus, type Domain, type DomainAvailability, type DomainForward, type DomainForwardType, type DomainInput, type DomainSource, type DsRecord, DynadotRegistrar, EXTENDED_FEATURES, type EmailForward, Feature, GandiRegistrar, GoDaddyRegistrar, HttpClient, type HttpClientConfig, InvalidResponseError, type ListDomainsOptions, MASKED_FORWARD_UNSUPPORTED, NameBrightRegistrar, NameSiloRegistrar, NamecheapRegistrar, NotFoundError, NotImplementedError, type OperationResult, ParsingError, PorkbunRegistrar, type PortfolioError, type PortfolioResult, RateLimitError, type RegisterDomainInput, type Registrar, RegistrarClient, type RegistrarClientOptions, type RegistrarConstructor, type RegistrarCredentials, type RegistrarEnvironment, RegistrarError, type RegistrarFeature, type RegistrarName, type RegistrarOptions, type RegistrationConsent, type RequestConfig, type RequestOptions, RetryableRegistrarError, type SettableDomainForward, SpaceshipRegistrar, TimeoutError, type TldPricing, type TransferDomainInput, USER_AGENT, backoffDelay, createDomain, createRegistrar, ensureArray, filterDomains, isCoreFeature, listPortfolio, normalizeDomain, normalizeNameservers, parseDate, parseXml, registrars, requireConsent, selectBaseUrl, settableForwards, sleep, toRegistrarError };