@aoxborrow/registrar-client 0.6.0 → 0.8.0

package/dist/index.d.cts

@@ -32,14 +32,27 @@ declare const CORE_FEATURES: readonly ["testConnection", "listDomains", "getDoma
 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;
+declare const FEATURE_CALLS: Record<RegistrarFeature, {
+    intent: 'read' | 'write';
+    optsIndex: number;
+}>;
 
 interface RegistrarClientOptions {
     timeout: number;
     retries: number;
     backoff: number;
     signal?: AbortSignal;
+    fetch?: typeof globalThis.fetch;
+}
+type RequestIntent = 'read' | 'write';
+interface FeatureCall {
+    intent: RequestIntent;
+    feature?: string;
+    outcomeUnknown?: Error;
+}
+interface RequestOptions extends Partial<RegistrarClientOptions> {
+    call?: FeatureCall;
 }
-type RequestOptions = Partial<RegistrarClientOptions>;
 interface ListDomainsOptions extends RequestOptions {
     search?: string;
     detailed?: boolean;
@@ -55,6 +68,7 @@ interface ConnectionResult {
 interface OperationResult {
     success: boolean;
     message: string;
+    outcome?: 'unknown';
 }
 interface ConfigField {
     name: string;
@@ -126,6 +140,7 @@ interface DomainAvailability {
     available: boolean;
     premium?: boolean;
     price?: number;
+    renewalPrice?: number;
     currency?: string;
     period?: number;
 }
@@ -276,8 +291,22 @@ declare class TimeoutError extends RetryableRegistrarError {
 }
 declare class ConnectionError extends RetryableRegistrarError {
     status: number;
-    constructor(message: string);
+    notSent: boolean;
+    constructor(message: string, details?: {
+        notSent?: boolean;
+    });
 }
+declare class OutcomeUnknownError extends RegistrarError {
+    status: number;
+    feature?: string;
+    cause?: unknown;
+    constructor(message: string, details?: {
+        feature?: string;
+        cause?: unknown;
+    });
+}
+declare function markNotSent<T>(error: T): T;
+declare function wasNotSent(error: unknown): boolean;
 declare class AuthenticationError extends RegistrarError {
     status: number;
     constructor(message: string);
@@ -325,7 +354,10 @@ interface HttpClientConfig {
     baseUrl: string;
     headers?: Record<string, string>;
     options: RegistrarClientOptions;
+    safeMethods?: readonly string[];
+    rateLimitFallbackSeconds?: number;
 }
+declare const REST_SAFE_METHODS: readonly string[];
 interface RequestConfig {
     method?: string;
     path: string;
@@ -336,6 +368,8 @@ interface RequestConfig {
     retries?: number;
     backoff?: number;
     signal?: AbortSignal;
+    fetch?: typeof globalThis.fetch;
+    call?: FeatureCall;
 }
 declare class HttpClient {
     protected config: HttpClientConfig;
@@ -343,6 +377,7 @@ declare class HttpClient {
     request<T = unknown>(req: RequestConfig): Promise<T>;
     requestText(req: RequestConfig): Promise<string>;
     protected withRetries<T>(req: RequestConfig, attemptFn: () => Promise<T>): Promise<T>;
+    protected intentOf(req: RequestConfig): 'read' | 'write';
     protected buildUrl(req: RequestConfig): string;
     protected send(req: RequestConfig): Promise<string>;
     protected toStatusError(response: Response, url: string): Promise<RegistrarError>;
@@ -360,10 +395,12 @@ declare abstract class BaseRegistrar implements Registrar {
     readonly environment: RegistrarEnvironment;
     static readonly extendedFeatures: readonly RegistrarFeature[];
     static get features(): readonly RegistrarFeature[];
+    static readonly safeMethods: readonly string[];
     get features(): readonly RegistrarFeature[];
     supports(feature: RegistrarFeature): boolean;
     readonly requiresNameserversFetch: boolean;
     constructor(credentials: RegistrarCredentials, httpConfig: Omit<HttpClientConfig, 'options'>, options?: RegistrarOptions);
+    private threadFeatureCalls;
     testConnection(_opts?: RequestOptions): Promise<ConnectionResult>;
     listDomains(_opts?: ListDomainsOptions): Promise<Domain[]>;
     renewDomain(_domainName: string, _years?: number, _opts?: RequestOptions): Promise<OperationResult>;
@@ -394,6 +431,7 @@ declare abstract class BaseRegistrar implements Registrar {
 
 declare class CloudflareRegistrar extends BaseRegistrar {
     readonly name = "cloudflare";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "Cloudflare";
     static readonly website = "cloudflare.com";
     static readonly helpText: string;
@@ -438,6 +476,7 @@ declare class CloudflareRegistrar extends BaseRegistrar {
 
 declare class DynadotRegistrar extends BaseRegistrar {
     readonly name = "dynadot";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "Dynadot";
     static readonly website = "dynadot.com";
     static readonly helpText: string;
@@ -482,6 +521,7 @@ declare class DynadotRegistrar extends BaseRegistrar {
 
 declare class GandiRegistrar extends BaseRegistrar {
     readonly name = "gandi";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "Gandi.net";
     static readonly website = "gandi.net";
     static readonly helpText: string;
@@ -520,6 +560,7 @@ declare class GandiRegistrar extends BaseRegistrar {
 
 declare class GoDaddyRegistrar extends BaseRegistrar {
     readonly name = "godaddy";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "GoDaddy";
     static readonly website = "godaddy.com";
     static readonly helpText: string;
@@ -568,6 +609,7 @@ declare class GoDaddyRegistrar extends BaseRegistrar {
 
 declare class NameBrightRegistrar extends BaseRegistrar {
     readonly name = "namebright";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "NameBright";
     static readonly website = "namebright.com";
     static readonly helpText: string;
@@ -640,6 +682,7 @@ declare class NamecheapRegistrar extends BaseRegistrar {
 
 declare class NamecomRegistrar extends BaseRegistrar {
     readonly name = "namecom";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "Name.com";
     static readonly website = "name.com";
     static readonly supportsSandbox = true;
@@ -749,6 +792,7 @@ declare class PorkbunRegistrar extends BaseRegistrar {
 
 declare class SpaceshipRegistrar extends BaseRegistrar {
     readonly name = "spaceship";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "Spaceship";
     static readonly website = "spaceship.com";
     static readonly helpText: string;
@@ -819,5 +863,6 @@ 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;
+declare function asRead<T extends RequestOptions>(opts?: T): T;
 
-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, NamecomRegistrar, 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 };
+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_CALLS, Feature, type FeatureCall, GandiRegistrar, GoDaddyRegistrar, HttpClient, type HttpClientConfig, InvalidResponseError, type ListDomainsOptions, MASKED_FORWARD_UNSUPPORTED, NameBrightRegistrar, NameSiloRegistrar, NamecheapRegistrar, NamecomRegistrar, NotFoundError, NotImplementedError, type OperationResult, OutcomeUnknownError, ParsingError, PorkbunRegistrar, type PortfolioError, type PortfolioResult, REST_SAFE_METHODS, 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 RequestIntent, type RequestOptions, RetryableRegistrarError, type SettableDomainForward, SpaceshipRegistrar, TimeoutError, type TldPricing, type TransferDomainInput, USER_AGENT, asRead, backoffDelay, createDomain, createRegistrar, ensureArray, filterDomains, isCoreFeature, listPortfolio, markNotSent, normalizeDomain, normalizeNameservers, parseDate, parseXml, registrars, requireConsent, selectBaseUrl, settableForwards, sleep, toRegistrarError, wasNotSent };

package/dist/index.d.ts

@@ -32,14 +32,27 @@ declare const CORE_FEATURES: readonly ["testConnection", "listDomains", "getDoma
 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;
+declare const FEATURE_CALLS: Record<RegistrarFeature, {
+    intent: 'read' | 'write';
+    optsIndex: number;
+}>;
 
 interface RegistrarClientOptions {
     timeout: number;
     retries: number;
     backoff: number;
     signal?: AbortSignal;
+    fetch?: typeof globalThis.fetch;
+}
+type RequestIntent = 'read' | 'write';
+interface FeatureCall {
+    intent: RequestIntent;
+    feature?: string;
+    outcomeUnknown?: Error;
+}
+interface RequestOptions extends Partial<RegistrarClientOptions> {
+    call?: FeatureCall;
 }
-type RequestOptions = Partial<RegistrarClientOptions>;
 interface ListDomainsOptions extends RequestOptions {
     search?: string;
     detailed?: boolean;
@@ -55,6 +68,7 @@ interface ConnectionResult {
 interface OperationResult {
     success: boolean;
     message: string;
+    outcome?: 'unknown';
 }
 interface ConfigField {
     name: string;
@@ -126,6 +140,7 @@ interface DomainAvailability {
     available: boolean;
     premium?: boolean;
     price?: number;
+    renewalPrice?: number;
     currency?: string;
     period?: number;
 }
@@ -276,8 +291,22 @@ declare class TimeoutError extends RetryableRegistrarError {
 }
 declare class ConnectionError extends RetryableRegistrarError {
     status: number;
-    constructor(message: string);
+    notSent: boolean;
+    constructor(message: string, details?: {
+        notSent?: boolean;
+    });
 }
+declare class OutcomeUnknownError extends RegistrarError {
+    status: number;
+    feature?: string;
+    cause?: unknown;
+    constructor(message: string, details?: {
+        feature?: string;
+        cause?: unknown;
+    });
+}
+declare function markNotSent<T>(error: T): T;
+declare function wasNotSent(error: unknown): boolean;
 declare class AuthenticationError extends RegistrarError {
     status: number;
     constructor(message: string);
@@ -325,7 +354,10 @@ interface HttpClientConfig {
     baseUrl: string;
     headers?: Record<string, string>;
     options: RegistrarClientOptions;
+    safeMethods?: readonly string[];
+    rateLimitFallbackSeconds?: number;
 }
+declare const REST_SAFE_METHODS: readonly string[];
 interface RequestConfig {
     method?: string;
     path: string;
@@ -336,6 +368,8 @@ interface RequestConfig {
     retries?: number;
     backoff?: number;
     signal?: AbortSignal;
+    fetch?: typeof globalThis.fetch;
+    call?: FeatureCall;
 }
 declare class HttpClient {
     protected config: HttpClientConfig;
@@ -343,6 +377,7 @@ declare class HttpClient {
     request<T = unknown>(req: RequestConfig): Promise<T>;
     requestText(req: RequestConfig): Promise<string>;
     protected withRetries<T>(req: RequestConfig, attemptFn: () => Promise<T>): Promise<T>;
+    protected intentOf(req: RequestConfig): 'read' | 'write';
     protected buildUrl(req: RequestConfig): string;
     protected send(req: RequestConfig): Promise<string>;
     protected toStatusError(response: Response, url: string): Promise<RegistrarError>;
@@ -360,10 +395,12 @@ declare abstract class BaseRegistrar implements Registrar {
     readonly environment: RegistrarEnvironment;
     static readonly extendedFeatures: readonly RegistrarFeature[];
     static get features(): readonly RegistrarFeature[];
+    static readonly safeMethods: readonly string[];
     get features(): readonly RegistrarFeature[];
     supports(feature: RegistrarFeature): boolean;
     readonly requiresNameserversFetch: boolean;
     constructor(credentials: RegistrarCredentials, httpConfig: Omit<HttpClientConfig, 'options'>, options?: RegistrarOptions);
+    private threadFeatureCalls;
     testConnection(_opts?: RequestOptions): Promise<ConnectionResult>;
     listDomains(_opts?: ListDomainsOptions): Promise<Domain[]>;
     renewDomain(_domainName: string, _years?: number, _opts?: RequestOptions): Promise<OperationResult>;
@@ -394,6 +431,7 @@ declare abstract class BaseRegistrar implements Registrar {
 
 declare class CloudflareRegistrar extends BaseRegistrar {
     readonly name = "cloudflare";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "Cloudflare";
     static readonly website = "cloudflare.com";
     static readonly helpText: string;
@@ -438,6 +476,7 @@ declare class CloudflareRegistrar extends BaseRegistrar {
 
 declare class DynadotRegistrar extends BaseRegistrar {
     readonly name = "dynadot";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "Dynadot";
     static readonly website = "dynadot.com";
     static readonly helpText: string;
@@ -482,6 +521,7 @@ declare class DynadotRegistrar extends BaseRegistrar {
 
 declare class GandiRegistrar extends BaseRegistrar {
     readonly name = "gandi";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "Gandi.net";
     static readonly website = "gandi.net";
     static readonly helpText: string;
@@ -520,6 +560,7 @@ declare class GandiRegistrar extends BaseRegistrar {
 
 declare class GoDaddyRegistrar extends BaseRegistrar {
     readonly name = "godaddy";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "GoDaddy";
     static readonly website = "godaddy.com";
     static readonly helpText: string;
@@ -568,6 +609,7 @@ declare class GoDaddyRegistrar extends BaseRegistrar {
 
 declare class NameBrightRegistrar extends BaseRegistrar {
     readonly name = "namebright";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "NameBright";
     static readonly website = "namebright.com";
     static readonly helpText: string;
@@ -640,6 +682,7 @@ declare class NamecheapRegistrar extends BaseRegistrar {
 
 declare class NamecomRegistrar extends BaseRegistrar {
     readonly name = "namecom";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "Name.com";
     static readonly website = "name.com";
     static readonly supportsSandbox = true;
@@ -749,6 +792,7 @@ declare class PorkbunRegistrar extends BaseRegistrar {
 
 declare class SpaceshipRegistrar extends BaseRegistrar {
     readonly name = "spaceship";
+    static readonly safeMethods: readonly string[];
     static readonly displayName = "Spaceship";
     static readonly website = "spaceship.com";
     static readonly helpText: string;
@@ -819,5 +863,6 @@ 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;
+declare function asRead<T extends RequestOptions>(opts?: T): T;
 
-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, NamecomRegistrar, 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 };
+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_CALLS, Feature, type FeatureCall, GandiRegistrar, GoDaddyRegistrar, HttpClient, type HttpClientConfig, InvalidResponseError, type ListDomainsOptions, MASKED_FORWARD_UNSUPPORTED, NameBrightRegistrar, NameSiloRegistrar, NamecheapRegistrar, NamecomRegistrar, NotFoundError, NotImplementedError, type OperationResult, OutcomeUnknownError, ParsingError, PorkbunRegistrar, type PortfolioError, type PortfolioResult, REST_SAFE_METHODS, 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 RequestIntent, type RequestOptions, RetryableRegistrarError, type SettableDomainForward, SpaceshipRegistrar, TimeoutError, type TldPricing, type TransferDomainInput, USER_AGENT, asRead, backoffDelay, createDomain, createRegistrar, ensureArray, filterDomains, isCoreFeature, listPortfolio, markNotSent, normalizeDomain, normalizeNameservers, parseDate, parseXml, registrars, requireConsent, selectBaseUrl, settableForwards, sleep, toRegistrarError, wasNotSent };