@aoxborrow/registrar-client 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/dist/index.cjs +9 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +10 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.js +9 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/registrars/cloudflare.ts +1 -0
- package/src/registrars/dynadot.ts +1 -0
- package/src/registrars/gandi.ts +1 -0
- package/src/registrars/godaddy.ts +1 -0
- package/src/registrars/namebright.ts +1 -0
- package/src/registrars/namecheap.ts +1 -0
- package/src/registrars/namesilo.ts +1 -0
- package/src/registrars/porkbun.ts +1 -0
- package/src/registrars/spaceship.ts +1 -0
- package/src/types.ts +4 -2
package/dist/index.d.cts
CHANGED
|
@@ -211,6 +211,7 @@ interface Registrar {
|
|
|
211
211
|
interface RegistrarConstructor {
|
|
212
212
|
new (credentials: RegistrarCredentials, options?: RegistrarOptions): Registrar;
|
|
213
213
|
readonly displayName: string;
|
|
214
|
+
readonly website: string;
|
|
214
215
|
readonly configFields: ConfigField[];
|
|
215
216
|
readonly helpText: string;
|
|
216
217
|
readonly supportsSandbox: boolean;
|
|
@@ -392,6 +393,7 @@ declare abstract class BaseRegistrar implements Registrar {
|
|
|
392
393
|
declare class CloudflareRegistrar extends BaseRegistrar {
|
|
393
394
|
readonly name = "cloudflare";
|
|
394
395
|
static readonly displayName = "Cloudflare";
|
|
396
|
+
static readonly website = "cloudflare.com";
|
|
395
397
|
static readonly helpText: string;
|
|
396
398
|
static readonly configFields: ConfigField[];
|
|
397
399
|
static readonly supportsSandbox = false;
|
|
@@ -435,6 +437,7 @@ declare class CloudflareRegistrar extends BaseRegistrar {
|
|
|
435
437
|
declare class DynadotRegistrar extends BaseRegistrar {
|
|
436
438
|
readonly name = "dynadot";
|
|
437
439
|
static readonly displayName = "Dynadot";
|
|
440
|
+
static readonly website = "dynadot.com";
|
|
438
441
|
static readonly helpText: string;
|
|
439
442
|
static readonly configFields: ConfigField[];
|
|
440
443
|
static readonly supportsSandbox = true;
|
|
@@ -477,6 +480,7 @@ declare class DynadotRegistrar extends BaseRegistrar {
|
|
|
477
480
|
declare class GandiRegistrar extends BaseRegistrar {
|
|
478
481
|
readonly name = "gandi";
|
|
479
482
|
static readonly displayName = "Gandi.net";
|
|
483
|
+
static readonly website = "gandi.net";
|
|
480
484
|
static readonly helpText: string;
|
|
481
485
|
static readonly configFields: ConfigField[];
|
|
482
486
|
static readonly supportsSandbox = true;
|
|
@@ -514,6 +518,7 @@ declare class GandiRegistrar extends BaseRegistrar {
|
|
|
514
518
|
declare class GoDaddyRegistrar extends BaseRegistrar {
|
|
515
519
|
readonly name = "godaddy";
|
|
516
520
|
static readonly displayName = "GoDaddy";
|
|
521
|
+
static readonly website = "godaddy.com";
|
|
517
522
|
static readonly helpText: string;
|
|
518
523
|
static readonly configFields: ConfigField[];
|
|
519
524
|
static readonly supportsSandbox = true;
|
|
@@ -560,6 +565,7 @@ declare class GoDaddyRegistrar extends BaseRegistrar {
|
|
|
560
565
|
declare class NameBrightRegistrar extends BaseRegistrar {
|
|
561
566
|
readonly name = "namebright";
|
|
562
567
|
static readonly displayName = "NameBright";
|
|
568
|
+
static readonly website = "namebright.com";
|
|
563
569
|
static readonly helpText: string;
|
|
564
570
|
static readonly configFields: ConfigField[];
|
|
565
571
|
static readonly supportsSandbox = false;
|
|
@@ -594,6 +600,7 @@ declare class NameBrightRegistrar extends BaseRegistrar {
|
|
|
594
600
|
declare class NamecheapRegistrar extends BaseRegistrar {
|
|
595
601
|
readonly name = "namecheap";
|
|
596
602
|
static readonly displayName = "Namecheap";
|
|
603
|
+
static readonly website = "namecheap.com";
|
|
597
604
|
static readonly helpText: string;
|
|
598
605
|
static readonly configFields: ConfigField[];
|
|
599
606
|
static readonly supportsSandbox = true;
|
|
@@ -630,6 +637,7 @@ declare class NamecheapRegistrar extends BaseRegistrar {
|
|
|
630
637
|
declare class NameSiloRegistrar extends BaseRegistrar {
|
|
631
638
|
readonly name = "namesilo";
|
|
632
639
|
static readonly displayName = "NameSilo";
|
|
640
|
+
static readonly website = "namesilo.com";
|
|
633
641
|
static readonly helpText: string;
|
|
634
642
|
static readonly configFields: ConfigField[];
|
|
635
643
|
static readonly supportsSandbox = true;
|
|
@@ -666,6 +674,7 @@ declare class NameSiloRegistrar extends BaseRegistrar {
|
|
|
666
674
|
declare class PorkbunRegistrar extends BaseRegistrar {
|
|
667
675
|
readonly name = "porkbun";
|
|
668
676
|
static readonly displayName = "Porkbun";
|
|
677
|
+
static readonly website = "porkbun.com";
|
|
669
678
|
static readonly helpText: string;
|
|
670
679
|
static readonly configFields: ConfigField[];
|
|
671
680
|
static readonly supportsSandbox = true;
|
|
@@ -698,6 +707,7 @@ declare class PorkbunRegistrar extends BaseRegistrar {
|
|
|
698
707
|
declare class SpaceshipRegistrar extends BaseRegistrar {
|
|
699
708
|
readonly name = "spaceship";
|
|
700
709
|
static readonly displayName = "Spaceship";
|
|
710
|
+
static readonly website = "spaceship.com";
|
|
701
711
|
static readonly helpText: string;
|
|
702
712
|
static readonly configFields: ConfigField[];
|
|
703
713
|
static readonly supportsSandbox = false;
|
package/dist/index.d.ts
CHANGED
|
@@ -211,6 +211,7 @@ interface Registrar {
|
|
|
211
211
|
interface RegistrarConstructor {
|
|
212
212
|
new (credentials: RegistrarCredentials, options?: RegistrarOptions): Registrar;
|
|
213
213
|
readonly displayName: string;
|
|
214
|
+
readonly website: string;
|
|
214
215
|
readonly configFields: ConfigField[];
|
|
215
216
|
readonly helpText: string;
|
|
216
217
|
readonly supportsSandbox: boolean;
|
|
@@ -392,6 +393,7 @@ declare abstract class BaseRegistrar implements Registrar {
|
|
|
392
393
|
declare class CloudflareRegistrar extends BaseRegistrar {
|
|
393
394
|
readonly name = "cloudflare";
|
|
394
395
|
static readonly displayName = "Cloudflare";
|
|
396
|
+
static readonly website = "cloudflare.com";
|
|
395
397
|
static readonly helpText: string;
|
|
396
398
|
static readonly configFields: ConfigField[];
|
|
397
399
|
static readonly supportsSandbox = false;
|
|
@@ -435,6 +437,7 @@ declare class CloudflareRegistrar extends BaseRegistrar {
|
|
|
435
437
|
declare class DynadotRegistrar extends BaseRegistrar {
|
|
436
438
|
readonly name = "dynadot";
|
|
437
439
|
static readonly displayName = "Dynadot";
|
|
440
|
+
static readonly website = "dynadot.com";
|
|
438
441
|
static readonly helpText: string;
|
|
439
442
|
static readonly configFields: ConfigField[];
|
|
440
443
|
static readonly supportsSandbox = true;
|
|
@@ -477,6 +480,7 @@ declare class DynadotRegistrar extends BaseRegistrar {
|
|
|
477
480
|
declare class GandiRegistrar extends BaseRegistrar {
|
|
478
481
|
readonly name = "gandi";
|
|
479
482
|
static readonly displayName = "Gandi.net";
|
|
483
|
+
static readonly website = "gandi.net";
|
|
480
484
|
static readonly helpText: string;
|
|
481
485
|
static readonly configFields: ConfigField[];
|
|
482
486
|
static readonly supportsSandbox = true;
|
|
@@ -514,6 +518,7 @@ declare class GandiRegistrar extends BaseRegistrar {
|
|
|
514
518
|
declare class GoDaddyRegistrar extends BaseRegistrar {
|
|
515
519
|
readonly name = "godaddy";
|
|
516
520
|
static readonly displayName = "GoDaddy";
|
|
521
|
+
static readonly website = "godaddy.com";
|
|
517
522
|
static readonly helpText: string;
|
|
518
523
|
static readonly configFields: ConfigField[];
|
|
519
524
|
static readonly supportsSandbox = true;
|
|
@@ -560,6 +565,7 @@ declare class GoDaddyRegistrar extends BaseRegistrar {
|
|
|
560
565
|
declare class NameBrightRegistrar extends BaseRegistrar {
|
|
561
566
|
readonly name = "namebright";
|
|
562
567
|
static readonly displayName = "NameBright";
|
|
568
|
+
static readonly website = "namebright.com";
|
|
563
569
|
static readonly helpText: string;
|
|
564
570
|
static readonly configFields: ConfigField[];
|
|
565
571
|
static readonly supportsSandbox = false;
|
|
@@ -594,6 +600,7 @@ declare class NameBrightRegistrar extends BaseRegistrar {
|
|
|
594
600
|
declare class NamecheapRegistrar extends BaseRegistrar {
|
|
595
601
|
readonly name = "namecheap";
|
|
596
602
|
static readonly displayName = "Namecheap";
|
|
603
|
+
static readonly website = "namecheap.com";
|
|
597
604
|
static readonly helpText: string;
|
|
598
605
|
static readonly configFields: ConfigField[];
|
|
599
606
|
static readonly supportsSandbox = true;
|
|
@@ -630,6 +637,7 @@ declare class NamecheapRegistrar extends BaseRegistrar {
|
|
|
630
637
|
declare class NameSiloRegistrar extends BaseRegistrar {
|
|
631
638
|
readonly name = "namesilo";
|
|
632
639
|
static readonly displayName = "NameSilo";
|
|
640
|
+
static readonly website = "namesilo.com";
|
|
633
641
|
static readonly helpText: string;
|
|
634
642
|
static readonly configFields: ConfigField[];
|
|
635
643
|
static readonly supportsSandbox = true;
|
|
@@ -666,6 +674,7 @@ declare class NameSiloRegistrar extends BaseRegistrar {
|
|
|
666
674
|
declare class PorkbunRegistrar extends BaseRegistrar {
|
|
667
675
|
readonly name = "porkbun";
|
|
668
676
|
static readonly displayName = "Porkbun";
|
|
677
|
+
static readonly website = "porkbun.com";
|
|
669
678
|
static readonly helpText: string;
|
|
670
679
|
static readonly configFields: ConfigField[];
|
|
671
680
|
static readonly supportsSandbox = true;
|
|
@@ -698,6 +707,7 @@ declare class PorkbunRegistrar extends BaseRegistrar {
|
|
|
698
707
|
declare class SpaceshipRegistrar extends BaseRegistrar {
|
|
699
708
|
readonly name = "spaceship";
|
|
700
709
|
static readonly displayName = "Spaceship";
|
|
710
|
+
static readonly website = "spaceship.com";
|
|
701
711
|
static readonly helpText: string;
|
|
702
712
|
static readonly configFields: ConfigField[];
|
|
703
713
|
static readonly supportsSandbox = false;
|
package/dist/index.js
CHANGED
|
@@ -741,6 +741,7 @@ var BaseRegistrar = class {
|
|
|
741
741
|
var CloudflareRegistrar = class _CloudflareRegistrar extends BaseRegistrar {
|
|
742
742
|
name = "cloudflare";
|
|
743
743
|
static displayName = "Cloudflare";
|
|
744
|
+
static website = "cloudflare.com";
|
|
744
745
|
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.';
|
|
745
746
|
static configFields = [
|
|
746
747
|
{ name: "apiToken", label: "API Token", type: "password", required: true },
|
|
@@ -1597,6 +1598,7 @@ var SUPPORTED_DNS_TYPES = /* @__PURE__ */ new Set(["A", "AAAA", "CNAME", "MX", "
|
|
|
1597
1598
|
var DynadotRegistrar = class extends BaseRegistrar {
|
|
1598
1599
|
name = "dynadot";
|
|
1599
1600
|
static displayName = "Dynadot";
|
|
1601
|
+
static website = "dynadot.com";
|
|
1600
1602
|
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.";
|
|
1601
1603
|
static configFields = [
|
|
1602
1604
|
{ name: "apiKey", label: "API Key", type: "password", required: true },
|
|
@@ -2344,6 +2346,7 @@ var GANDI_TYPE_TO_FORWARD = {
|
|
|
2344
2346
|
var GandiRegistrar = class extends BaseRegistrar {
|
|
2345
2347
|
name = "gandi";
|
|
2346
2348
|
static displayName = "Gandi.net";
|
|
2349
|
+
static website = "gandi.net";
|
|
2347
2350
|
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.)";
|
|
2348
2351
|
static configFields = [
|
|
2349
2352
|
{ name: "apiKey", label: "Personal Access Token", type: "password", required: true }
|
|
@@ -3030,6 +3033,7 @@ var PRICE_MICRO_UNITS = 1e6;
|
|
|
3030
3033
|
var GoDaddyRegistrar = class _GoDaddyRegistrar extends BaseRegistrar {
|
|
3031
3034
|
name = "godaddy";
|
|
3032
3035
|
static displayName = "GoDaddy";
|
|
3036
|
+
static website = "godaddy.com";
|
|
3033
3037
|
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).';
|
|
3034
3038
|
static configFields = [
|
|
3035
3039
|
{ name: "apiToken", label: "API Token (PAT)", type: "password", required: false },
|
|
@@ -3894,6 +3898,7 @@ var TOKEN_URL = "https://api.namebright.com/auth/token";
|
|
|
3894
3898
|
var NameBrightRegistrar = class extends BaseRegistrar {
|
|
3895
3899
|
name = "namebright";
|
|
3896
3900
|
static displayName = "NameBright";
|
|
3901
|
+
static website = "namebright.com";
|
|
3897
3902
|
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.';
|
|
3898
3903
|
static configFields = [
|
|
3899
3904
|
{ name: "clientId", label: "Client ID", type: "text", required: true },
|
|
@@ -4384,6 +4389,7 @@ var NC_CONTACT_ROLES = [
|
|
|
4384
4389
|
var NamecheapRegistrar = class extends BaseRegistrar {
|
|
4385
4390
|
name = "namecheap";
|
|
4386
4391
|
static displayName = "Namecheap";
|
|
4392
|
+
static website = "namecheap.com";
|
|
4387
4393
|
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.";
|
|
4388
4394
|
static configFields = [
|
|
4389
4395
|
{ name: "username", label: "Username", type: "text", required: true },
|
|
@@ -4941,6 +4947,7 @@ function toNcContactParams(prefix, c) {
|
|
|
4941
4947
|
var NameSiloRegistrar = class extends BaseRegistrar {
|
|
4942
4948
|
name = "namesilo";
|
|
4943
4949
|
static displayName = "NameSilo";
|
|
4950
|
+
static website = "namesilo.com";
|
|
4944
4951
|
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.';
|
|
4945
4952
|
static configFields = [
|
|
4946
4953
|
{ name: "apiKey", label: "API Key", type: "password", required: true }
|
|
@@ -5622,6 +5629,7 @@ var PB_TYPE_TO_FORWARD = {
|
|
|
5622
5629
|
var PorkbunRegistrar = class extends BaseRegistrar {
|
|
5623
5630
|
name = "porkbun";
|
|
5624
5631
|
static displayName = "Porkbun";
|
|
5632
|
+
static website = "porkbun.com";
|
|
5625
5633
|
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).';
|
|
5626
5634
|
static configFields = [
|
|
5627
5635
|
{ name: "apiKey", label: "API Key", type: "password", required: true },
|
|
@@ -6228,6 +6236,7 @@ var WRITABLE_DNS_TYPES = /* @__PURE__ */ new Set(["A", "AAAA", "CNAME", "NS", "T
|
|
|
6228
6236
|
var SpaceshipRegistrar = class extends BaseRegistrar {
|
|
6229
6237
|
name = "spaceship";
|
|
6230
6238
|
static displayName = "Spaceship";
|
|
6239
|
+
static website = "spaceship.com";
|
|
6231
6240
|
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.';
|
|
6232
6241
|
static configFields = [
|
|
6233
6242
|
{ name: "apiKey", label: "API Key", type: "password", required: true },
|