@aoxborrow/registrar-client 0.8.0 → 0.9.1

package/dist/index.d.cts

@@ -68,6 +68,7 @@ interface ConnectionResult {
 interface OperationResult {
     success: boolean;
     message: string;
+    pending?: boolean;
     outcome?: 'unknown';
 }
 interface ConfigField {
@@ -474,6 +475,31 @@ declare class CloudflareRegistrar extends BaseRegistrar {
     private patchDomain;
 }
 
+declare class Domain101Registrar extends BaseRegistrar {
+    readonly name = "101domain";
+    static readonly safeMethods: readonly string[];
+    static readonly displayName = "101domain";
+    static readonly website = "101domain.com";
+    static readonly supportsSandbox = false;
+    static readonly configFields: ConfigField[];
+    static readonly helpText: string;
+    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[]>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+    private request;
+    private rawRecords;
+}
+
 declare class DynadotRegistrar extends BaseRegistrar {
     readonly name = "dynadot";
     static readonly safeMethods: readonly string[];
@@ -830,6 +856,7 @@ declare class SpaceshipRegistrar extends BaseRegistrar {
 }
 
 declare const registrars: {
+    '101domain': typeof Domain101Registrar;
     cloudflare: typeof CloudflareRegistrar;
     dynadot: typeof DynadotRegistrar;
     gandi: typeof GandiRegistrar;
@@ -844,6 +871,40 @@ declare const registrars: {
 type RegistrarName = keyof typeof registrars;
 declare function createRegistrar(name: RegistrarName, credentials: RegistrarCredentials, options?: RegistrarOptions): Registrar;
 
+declare class DnsSyntaxError extends Error {
+    constructor(message: string);
+}
+interface DnsEntry {
+    owner: string;
+    kind: string;
+    ttl: number;
+    rdata: string;
+}
+interface RecordClash {
+    owner: string;
+    kind: string;
+    detail: string;
+}
+type NameRole = 'owner' | 'target';
+type LabelMapper = (label: string) => string | null;
+interface DelegationSigner {
+    keyTag: number;
+    algorithm: number;
+    digestType: number;
+    digest: string;
+}
+declare function useLabelMapper(mapper: LabelMapper): void;
+declare function resetLabelMapper(): void;
+declare function prepareName(input: string, role?: NameRole): string;
+declare function isIpv4(text: string): boolean;
+declare function isIpv6(text: string): boolean;
+declare function readDelegationSigner(rdata: string): DelegationSigner;
+declare function prepareRdata(kind: string, rdata: string, owner?: string): string;
+declare function prepareEntry(entry: DnsEntry): DnsEntry;
+declare function findCnameConflicts(entries: readonly DnsEntry[]): RecordClash[];
+declare function findRepeatedRecords(entries: readonly DnsEntry[]): RecordClash[];
+declare function toDnsEntry(record: DnsRecord, defaultTtl?: number): DnsEntry;
+
 declare function parseXml<T = unknown>(xml: string, options?: Partial<X2jOptions>): T;
 declare function ensureArray<T>(value: T | T[] | undefined | null): T[];
 
@@ -865,4 +926,4 @@ 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_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 };
+export { ALL_FEATURES, AbortError, AuthenticationError, AuthorizationError, BaseRegistrar, CORE_FEATURES, CloudflareRegistrar, type ConfigField, ConfigurationError, ConnectionError, type ConnectionResult, ConsentRequiredError, type Contact, type ContactSet, DEFAULT_OPTIONS, type DelegationSigner, type DnsEntry, type DnsRecord, DnsSyntaxError, type DnssecStatus, type Domain, Domain101Registrar, 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 LabelMapper, type ListDomainsOptions, MASKED_FORWARD_UNSUPPORTED, NameBrightRegistrar, type NameRole, NameSiloRegistrar, NamecheapRegistrar, NamecomRegistrar, NotFoundError, NotImplementedError, type OperationResult, OutcomeUnknownError, ParsingError, PorkbunRegistrar, type PortfolioError, type PortfolioResult, REST_SAFE_METHODS, RateLimitError, type RecordClash, 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, findCnameConflicts, findRepeatedRecords, isCoreFeature, isIpv4, isIpv6, listPortfolio, markNotSent, normalizeDomain, normalizeNameservers, parseDate, parseXml, prepareEntry, prepareName, prepareRdata, readDelegationSigner, registrars, requireConsent, resetLabelMapper, selectBaseUrl, settableForwards, sleep, toDnsEntry, toRegistrarError, useLabelMapper, wasNotSent };

package/dist/index.d.ts

@@ -68,6 +68,7 @@ interface ConnectionResult {
 interface OperationResult {
     success: boolean;
     message: string;
+    pending?: boolean;
     outcome?: 'unknown';
 }
 interface ConfigField {
@@ -474,6 +475,31 @@ declare class CloudflareRegistrar extends BaseRegistrar {
     private patchDomain;
 }
 
+declare class Domain101Registrar extends BaseRegistrar {
+    readonly name = "101domain";
+    static readonly safeMethods: readonly string[];
+    static readonly displayName = "101domain";
+    static readonly website = "101domain.com";
+    static readonly supportsSandbox = false;
+    static readonly configFields: ConfigField[];
+    static readonly helpText: string;
+    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[]>;
+    updateNameservers(domainName: string, nameservers: string[], opts?: RequestOptions): Promise<OperationResult>;
+    checkAvailability(domainNames: string[], opts?: RequestOptions): Promise<DomainAvailability[]>;
+    getPricing(tldOrDomain: string, opts?: RequestOptions): Promise<TldPricing>;
+    getDnsRecords(domainName: string, opts?: RequestOptions): Promise<DnsRecord[]>;
+    setDnsRecords(domainName: string, records: DnsRecord[], opts?: RequestOptions): Promise<OperationResult>;
+    getDomainForwarding(domainName: string, opts?: RequestOptions): Promise<DomainForward[]>;
+    setDomainForwarding(domainName: string, forwards: DomainForward[], opts?: RequestOptions): Promise<OperationResult>;
+    private request;
+    private rawRecords;
+}
+
 declare class DynadotRegistrar extends BaseRegistrar {
     readonly name = "dynadot";
     static readonly safeMethods: readonly string[];
@@ -830,6 +856,7 @@ declare class SpaceshipRegistrar extends BaseRegistrar {
 }
 
 declare const registrars: {
+    '101domain': typeof Domain101Registrar;
     cloudflare: typeof CloudflareRegistrar;
     dynadot: typeof DynadotRegistrar;
     gandi: typeof GandiRegistrar;
@@ -844,6 +871,40 @@ declare const registrars: {
 type RegistrarName = keyof typeof registrars;
 declare function createRegistrar(name: RegistrarName, credentials: RegistrarCredentials, options?: RegistrarOptions): Registrar;
 
+declare class DnsSyntaxError extends Error {
+    constructor(message: string);
+}
+interface DnsEntry {
+    owner: string;
+    kind: string;
+    ttl: number;
+    rdata: string;
+}
+interface RecordClash {
+    owner: string;
+    kind: string;
+    detail: string;
+}
+type NameRole = 'owner' | 'target';
+type LabelMapper = (label: string) => string | null;
+interface DelegationSigner {
+    keyTag: number;
+    algorithm: number;
+    digestType: number;
+    digest: string;
+}
+declare function useLabelMapper(mapper: LabelMapper): void;
+declare function resetLabelMapper(): void;
+declare function prepareName(input: string, role?: NameRole): string;
+declare function isIpv4(text: string): boolean;
+declare function isIpv6(text: string): boolean;
+declare function readDelegationSigner(rdata: string): DelegationSigner;
+declare function prepareRdata(kind: string, rdata: string, owner?: string): string;
+declare function prepareEntry(entry: DnsEntry): DnsEntry;
+declare function findCnameConflicts(entries: readonly DnsEntry[]): RecordClash[];
+declare function findRepeatedRecords(entries: readonly DnsEntry[]): RecordClash[];
+declare function toDnsEntry(record: DnsRecord, defaultTtl?: number): DnsEntry;
+
 declare function parseXml<T = unknown>(xml: string, options?: Partial<X2jOptions>): T;
 declare function ensureArray<T>(value: T | T[] | undefined | null): T[];
 
@@ -865,4 +926,4 @@ 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_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 };
+export { ALL_FEATURES, AbortError, AuthenticationError, AuthorizationError, BaseRegistrar, CORE_FEATURES, CloudflareRegistrar, type ConfigField, ConfigurationError, ConnectionError, type ConnectionResult, ConsentRequiredError, type Contact, type ContactSet, DEFAULT_OPTIONS, type DelegationSigner, type DnsEntry, type DnsRecord, DnsSyntaxError, type DnssecStatus, type Domain, Domain101Registrar, 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 LabelMapper, type ListDomainsOptions, MASKED_FORWARD_UNSUPPORTED, NameBrightRegistrar, type NameRole, NameSiloRegistrar, NamecheapRegistrar, NamecomRegistrar, NotFoundError, NotImplementedError, type OperationResult, OutcomeUnknownError, ParsingError, PorkbunRegistrar, type PortfolioError, type PortfolioResult, REST_SAFE_METHODS, RateLimitError, type RecordClash, 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, findCnameConflicts, findRepeatedRecords, isCoreFeature, isIpv4, isIpv6, listPortfolio, markNotSent, normalizeDomain, normalizeNameservers, parseDate, parseXml, prepareEntry, prepareName, prepareRdata, readDelegationSigner, registrars, requireConsent, resetLabelMapper, selectBaseUrl, settableForwards, sleep, toDnsEntry, toRegistrarError, useLabelMapper, wasNotSent };