@aoxborrow/registrar-client 0.1.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aoxborrow/registrar-client",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "One consistent, fully-typed TypeScript interface to many domain registrar APIs (GoDaddy, Cloudflare, Namecheap, Spaceship, Dynadot, Porkbun, and more) behind a single pluggable multi-provider client",
   "author": {
     "name": "Aaron Oxborrow",
@@ -11,6 +11,7 @@
     "access": "public"
   },
   "homepage": "https://github.com/aoxborrow/registrar-client",
+  "funding": "https://github.com/sponsors/aoxborrow",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/aoxborrow/registrar-client.git"

package/src/client.ts

@@ -50,8 +50,10 @@ export class RegistrarClient {
           const detail = await this.provider.getDomain(name, opts);
           let merged = { ...domains[index], ...detail };
           // Some providers expose nameservers only via a dedicated endpoint, not
-          // on the domain detail — fetch them separately when still empty.
-          if (merged.nameservers.length === 0) {
+          // on the domain detail — fetch them separately when still empty. Skip
+          // providers whose getNameservers just re-reads getDomain: it would
+          // repeat the same call and return the same empty result.
+          if (merged.nameservers.length === 0 && this.provider.requiresNameserversFetch) {
             try {
               const nameservers = normalizeNameservers(
                 await this.provider.getNameservers(name, opts)

package/src/registrar.ts

@@ -75,6 +75,12 @@ export abstract class BaseRegistrar implements Registrar {
     return this.features.includes(feature);
   }
 
+  // See Registrar.requiresNameserversFetch. Defaults true, so a provider
+  // whose getNameservers hits a real endpoint keeps the enrichment fallback
+  // without opting in; the providers whose getNameservers just re-reads getDomain
+  // override this to false to drop the redundant call.
+  readonly requiresNameserversFetch: boolean = true;
+
   constructor(
     credentials: RegistrarCredentials,
     httpConfig: Omit<HttpClientConfig, 'options'>,

package/src/registrars/cloudflare.ts

@@ -175,6 +175,7 @@ export class CloudflareRegistrar extends BaseRegistrar {
   readonly name = 'cloudflare';
 
   static readonly displayName = 'Cloudflare';
+  static readonly website = 'cloudflare.com';
   static readonly helpText =
     'Create an API token in your Cloudflare dashboard under My Profile > API Tokens. ' +
     'The token needs "Account.Registrar" read/write permissions. Find your Account ID ' +

package/src/registrars/dynadot.ts

@@ -180,6 +180,7 @@ export class DynadotRegistrar extends BaseRegistrar {
   readonly name = 'dynadot';
 
   static readonly displayName = 'Dynadot';
+  static readonly website = 'dynadot.com';
   static readonly helpText =
     'Under Tools > API in your Dynadot account, generate an API Key and API Secret. ' +
     'The account must be unlocked with API access enabled. The key identifies you; ' +
@@ -320,6 +321,10 @@ export class DynadotRegistrar extends BaseRegistrar {
     return data.domain_info;
   }
 
+  // getNameservers re-reads getDomain (domain_info carries NS inline; no separate
+  // endpoint), so listing enrichment gains nothing from the fallback — skip it.
+  override readonly requiresNameserversFetch = false;
+
   override async getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]> {
     // domain_info carries the nameservers inline (empty for Dynadot-DNS-hosted
     // domains, which have no external NS)

package/src/registrars/gandi.ts

@@ -161,6 +161,7 @@ export class GandiRegistrar extends BaseRegistrar {
   readonly name = 'gandi';
 
   static readonly displayName = 'Gandi.net';
+  static readonly website = 'gandi.net';
   static readonly helpText =
     'Generate a Personal Access Token (PAT) in your Gandi account under Account ' +
     'Settings > Security. The token needs permission to manage domains. (Gandi has ' +

package/src/registrars/godaddy.ts

@@ -269,6 +269,7 @@ export class GoDaddyRegistrar extends BaseRegistrar {
   readonly name = 'godaddy';
 
   static readonly displayName = 'GoDaddy';
+  static readonly website = 'godaddy.com';
   static readonly helpText =
     'Authenticate one of two ways. For production, create a Personal Access ' +
     'Token (PAT) at https://developer.godaddy.com and pass it as `apiToken` — ' +
@@ -420,6 +421,10 @@ export class GoDaddyRegistrar extends BaseRegistrar {
     return this.toDomain(d);
   }
 
+  // getNameservers re-reads getDomain (GoDaddy has no dedicated NS endpoint), so
+  // listing enrichment gains nothing from the fallback — skip it.
+  override readonly requiresNameserversFetch = false;
+
   override async getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]> {
     const domain = await this.getDomain(domainName, opts);
     return domain.nameservers;

package/src/registrars/namebright.ts

@@ -198,6 +198,7 @@ export class NameBrightRegistrar extends BaseRegistrar {
   readonly name = 'namebright';
 
   static readonly displayName = 'NameBright';
+  static readonly website = 'namebright.com';
   static readonly helpText =
     'API access is not enabled by default — you must request it from NameBright ' +
     '(contact support / your account manager) before the API Management page is ' +

package/src/registrars/namecheap.ts

@@ -188,6 +188,7 @@ export class NamecheapRegistrar extends BaseRegistrar {
   readonly name = 'namecheap';
 
   static readonly displayName = 'Namecheap';
+  static readonly website = 'namecheap.com';
   static readonly helpText =
     'Enable API access in your Namecheap account under Profile > Tools > API Access, ' +
     'generate an API key, and whitelist your request IP(s) in the API settings. ' +

package/src/registrars/namesilo.ts

@@ -157,6 +157,7 @@ export class NameSiloRegistrar extends BaseRegistrar {
   readonly name = 'namesilo';
 
   static readonly displayName = 'NameSilo';
+  static readonly website = 'namesilo.com';
   static readonly helpText =
     'Generate an API key in your NameSilo account under Account Options > API Manager. ' +
     'You can optionally restrict the key to specific IP addresses there. For sandbox ' +
@@ -285,6 +286,10 @@ export class NameSiloRegistrar extends BaseRegistrar {
     });
   }
 
+  // getNameservers re-reads getDomain (getDomainInfo carries NS; no separate
+  // endpoint), so listing enrichment gains nothing from the fallback — skip it.
+  override readonly requiresNameserversFetch = false;
+
   override async getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]> {
     const domain = await this.getDomain(domainName, opts);
     return domain.nameservers;

package/src/registrars/porkbun.ts

@@ -182,6 +182,7 @@ export class PorkbunRegistrar extends BaseRegistrar {
   readonly name = 'porkbun';
 
   static readonly displayName = 'Porkbun';
+  static readonly website = 'porkbun.com';
   static readonly helpText =
     'Create an API key and secret in your Porkbun account under Account > API Access, ' +
     'then enable "API Access" on each domain you want to manage (per-domain toggle in ' +

package/src/registrars/spaceship.ts

@@ -133,6 +133,7 @@ export class SpaceshipRegistrar extends BaseRegistrar {
   readonly name = 'spaceship';
 
   static readonly displayName = 'Spaceship';
+  static readonly website = 'spaceship.com';
   static readonly helpText =
     'Generate your API key and secret in the API Manager at Spaceship using the ' +
     '"New API key" button. The API requires both X-API-Key and X-API-Secret headers.';
@@ -203,6 +204,10 @@ export class SpaceshipRegistrar extends BaseRegistrar {
     return this.toDomain(await this.getRaw(domainName, opts));
   }
 
+  // getNameservers reads the same getRaw payload as getDomain (no dedicated NS
+  // endpoint), so listing enrichment gains nothing from the fallback — skip it.
+  override readonly requiresNameserversFetch = false;
+
   override async getNameservers(domainName: string, opts?: RequestOptions): Promise<string[]> {
     const d = await this.getRaw(domainName, opts);
     return d.nameservers?.hosts ?? [];

package/src/types.ts

@@ -307,6 +307,13 @@ export interface Registrar {
   // the capabilities this provider supports (core contract + its extended features)
   readonly features: readonly RegistrarFeature[];
 
+  // Whether reading a domain's nameservers needs a getNameservers call beyond
+  // getDomain. True when getNameservers hits its own endpoint that can surface
+  // nameservers getDomain omits; false when it just re-reads getDomain, so
+  // listing enrichment skips the redundant fetch. See BaseRegistrar for the
+  // default.
+  readonly requiresNameserversFetch: boolean;
+
   // whether this provider supports a given capability
   supports(feature: RegistrarFeature): boolean;
 
@@ -431,11 +438,13 @@ export interface Registrar {
 }
 
 // static side of a registrar class: the constructor plus discovery metadata
-// (display name, the credential fields it needs, where to get them, and whether
-// it offers a sandbox/test environment).
+// (display name, public website, the credential fields it needs, where to get
+// them, and whether it offers a sandbox/test environment).
 export interface RegistrarConstructor {
   new (credentials: RegistrarCredentials, options?: RegistrarOptions): Registrar;
   readonly displayName: string;
+  // the provider's public website domain, e.g. "gandi.net"
+  readonly website: string;
   readonly configFields: ConfigField[];
   readonly helpText: string;
   readonly supportsSandbox: boolean;