@aoxborrow/registrar-client 0.1.0 → 0.3.0

package/README.md

@@ -4,6 +4,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Node.js](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue.svg)](https://www.typescriptlang.org)
+[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-ea4aaa?logo=githubsponsors&logoColor=white)](https://github.com/sponsors/aoxborrow)
 
 > One consistent, fully-typed TypeScript interface to many domain registrar APIs.
 
@@ -55,8 +56,9 @@ npm install @aoxborrow/registrar-client
 | `spaceship`  | Spaceship  | key + secret               | —       |                                              |
 
 Each provider class exposes static discovery metadata — `displayName`,
-`configFields` (the credential fields it needs), and `helpText` (where to get
-them) — so you can build a credential UI generically.
+`website` (its public domain, e.g. `gandi.net`), `configFields` (the credential
+fields it needs), and `helpText` (where to get them) — so you can build a
+credential UI generically.
 
 Research notes for additional registrars live in
 [`docs/registrars/`](docs/registrars). Three are documented but **not**

package/dist/index.cjs

@@ -258,7 +258,7 @@ var RegistrarClient = class {
         try {
           const detail = await this.provider.getDomain(name, opts);
           let merged = { ...domains[index], ...detail };
-          if (merged.nameservers.length === 0) {
+          if (merged.nameservers.length === 0 && this.provider.requiresNameserversFetch) {
             try {
               const nameservers = normalizeNameservers(
                 await this.provider.getNameservers(name, opts)
@@ -646,6 +646,11 @@ var BaseRegistrar = class {
   supports(feature) {
     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.
+  requiresNameserversFetch = true;
   constructor(credentials, httpConfig, options) {
     const { environment = "production", ...clientOptions } = options ?? {};
     this.credentials = credentials;
@@ -743,6 +748,7 @@ var BaseRegistrar = class {
 var CloudflareRegistrar = class _CloudflareRegistrar extends BaseRegistrar {
   name = "cloudflare";
   static displayName = "Cloudflare";
+  static website = "cloudflare.com";
   static 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 in the URL or on the Overview page of any zone.';
   static configFields = [
     { name: "apiToken", label: "API Token", type: "password", required: true },
@@ -1599,6 +1605,7 @@ var SUPPORTED_DNS_TYPES = /* @__PURE__ */ new Set(["A", "AAAA", "CNAME", "MX", "
 var DynadotRegistrar = class extends BaseRegistrar {
   name = "dynadot";
   static displayName = "Dynadot";
+  static website = "dynadot.com";
   static 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; the secret signs requests (X-Signature) and is never sent directly.";
   static configFields = [
     { name: "apiKey", label: "API Key", type: "password", required: true },
@@ -1714,6 +1721,9 @@ ${bodyStr}`;
     if (!data.domain_info) throw new NotFoundError(`Dynadot: domain '${domainName}' not found`);
     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.
+  requiresNameserversFetch = false;
   async getNameservers(domainName, opts) {
     const domain = await this.getDomain(domainName, opts);
     return domain.nameservers;
@@ -2346,6 +2356,7 @@ var GANDI_TYPE_TO_FORWARD = {
 var GandiRegistrar = class extends BaseRegistrar {
   name = "gandi";
   static displayName = "Gandi.net";
+  static website = "gandi.net";
   static helpText = "Generate a Personal Access Token (PAT) in your Gandi account under Account Settings > Security. The token needs permission to manage domains. (Gandi has deprecated the legacy API Key; use a PAT.)";
   static configFields = [
     { name: "apiKey", label: "Personal Access Token", type: "password", required: true }
@@ -3032,6 +3043,7 @@ var PRICE_MICRO_UNITS = 1e6;
 var GoDaddyRegistrar = class _GoDaddyRegistrar extends BaseRegistrar {
   name = "godaddy";
   static displayName = "GoDaddy";
+  static website = "godaddy.com";
   static helpText = 'Authenticate one of two ways. For production, create a Personal Access Token (PAT) at https://developer.godaddy.com and pass it as `apiToken` \u2014 this enables the modern v3 API. For sandbox testing, create OTE (test environment) keys and pass `apiKey` + `apiSecret` with { environment: "sandbox" }; OTE only exposes the legacy v1 API. The sso-key (API Key/Secret) scheme is deprecated by GoDaddy in 2026. Domain forwarding uses the v2 customer-scoped API \u2014 set `customerId` to your GoDaddy customer UUID, or to your numeric shopper/account ID (which the client resolves to the UUID via an sso-key-authenticated lookup).';
   static configFields = [
     { name: "apiToken", label: "API Token (PAT)", type: "password", required: false },
@@ -3155,6 +3167,9 @@ var GoDaddyRegistrar = 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.
+  requiresNameserversFetch = false;
   async getNameservers(domainName, opts) {
     const domain = await this.getDomain(domainName, opts);
     return domain.nameservers;
@@ -3896,6 +3911,7 @@ var TOKEN_URL = "https://api.namebright.com/auth/token";
 var NameBrightRegistrar = class extends BaseRegistrar {
   name = "namebright";
   static displayName = "NameBright";
+  static website = "namebright.com";
   static helpText = 'API access is not enabled by default \u2014 you must request it from NameBright (contact support / your account manager) before the API Management page is available. Once enabled, create an API Application under my.namebright.com > My Account > API Management. The Client ID is "<accountName>:<applicationName>"; NameBright issues the Client Secret. Note the application also enforces an IP whitelist.';
   static configFields = [
     { name: "clientId", label: "Client ID", type: "text", required: true },
@@ -4386,6 +4402,7 @@ var NC_CONTACT_ROLES = [
 var NamecheapRegistrar = class extends BaseRegistrar {
   name = "namecheap";
   static displayName = "Namecheap";
+  static website = "namecheap.com";
   static 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. Provide the whitelisted IP as the Client IP field.";
   static configFields = [
     { name: "username", label: "Username", type: "text", required: true },
@@ -4943,6 +4960,7 @@ function toNcContactParams(prefix, c) {
 var NameSiloRegistrar = class extends BaseRegistrar {
   name = "namesilo";
   static displayName = "NameSilo";
+  static website = "namesilo.com";
   static 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 testing, use { environment: "sandbox" } (OTE host ote.namesilo.com) \u2014 OTE credentials are not self-service; you must contact NameSilo support to be issued them.';
   static configFields = [
     { name: "apiKey", label: "API Key", type: "password", required: true }
@@ -5053,6 +5071,9 @@ var NameSiloRegistrar = class extends BaseRegistrar {
       nameservers: extractNsHosts(r.nameservers)
     });
   }
+  // getNameservers re-reads getDomain (getDomainInfo carries NS; no separate
+  // endpoint), so listing enrichment gains nothing from the fallback — skip it.
+  requiresNameserversFetch = false;
   async getNameservers(domainName, opts) {
     const domain = await this.getDomain(domainName, opts);
     return domain.nameservers;
@@ -5624,6 +5645,7 @@ var PB_TYPE_TO_FORWARD = {
 var PorkbunRegistrar = class extends BaseRegistrar {
   name = "porkbun";
   static displayName = "Porkbun";
+  static website = "porkbun.com";
   static 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 the domain details). For testing, use a sandbox key (prefixed "pk1_sb_") with { environment: "sandbox" } \u2014 it hits the same base URL but an isolated test environment with $1,000 of fake credit and no real charges (top up or reset via POST /sandbox/topup and POST /sandbox/reset).';
   static configFields = [
     { name: "apiKey", label: "API Key", type: "password", required: true },
@@ -6230,6 +6252,7 @@ var WRITABLE_DNS_TYPES = /* @__PURE__ */ new Set(["A", "AAAA", "CNAME", "NS", "T
 var SpaceshipRegistrar = class extends BaseRegistrar {
   name = "spaceship";
   static displayName = "Spaceship";
+  static website = "spaceship.com";
   static 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.';
   static configFields = [
     { name: "apiKey", label: "API Key", type: "password", required: true },
@@ -6292,6 +6315,9 @@ var SpaceshipRegistrar = class extends BaseRegistrar {
   async getDomain(domainName, opts) {
     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.
+  requiresNameserversFetch = false;
   async getNameservers(domainName, opts) {
     const d = await this.getRaw(domainName, opts);
     return d.nameservers?.hosts ?? [];