@easybits.cloud/mailmask 0.3.3 → 0.4.0

package/dist/index.cjs

@@ -60,6 +60,7 @@ var MailMask = class {
     this.webhooks = new WebhooksResource(req);
     this.smtp = new SmtpResource(req);
     this.apiKeys = new ApiKeysResource(req);
+    this.dns = new DnsResource(req);
   }
 };
 var DomainsResource = class {
@@ -85,6 +86,33 @@ var DomainsResource = class {
     return this.req(`/api/domains/${id}/verify`, { method: "POST" });
   }
 };
+var DnsResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list(domainId) {
+    return this.req(`/api/domains/${domainId}/dns`);
+  }
+  createZone(domainId) {
+    return this.req(`/api/domains/${domainId}/dns/zone`, { method: "POST" });
+  }
+  delegation(domainId) {
+    return this.req(`/api/domains/${domainId}/dns/delegation`);
+  }
+  import(domainId) {
+    return this.req(`/api/domains/${domainId}/dns/import`, { method: "POST" });
+  }
+  /** Reemplaza el conjunto: `values` sustituye por completo lo que hubiera en ese nombre y tipo. */
+  upsert(domainId, record) {
+    return this.req(`/api/domains/${domainId}/dns/records`, { method: "PUT", body: JSON.stringify(record) });
+  }
+  delete(domainId, name, type) {
+    return this.req(`/api/domains/${domainId}/dns/records`, { method: "DELETE", body: JSON.stringify({ name, type }) });
+  }
+  preset(domainId, preset, target, subdomain) {
+    return this.req(`/api/domains/${domainId}/dns/preset`, { method: "POST", body: JSON.stringify({ preset, target, subdomain }) });
+  }
+};
 var AliasesResource = class {
   constructor(req) {
     this.req = req;

package/dist/index.d.cts

@@ -299,6 +299,61 @@ interface ApiKey {
     lastUsedAt?: string;
     createdAt: string;
 }
+type DnsRecordType = "A" | "AAAA" | "CNAME" | "TXT" | "MX" | "NS" | "CAA" | "SRV";
+/**
+ * Un conjunto de registros con el mismo nombre y tipo. El DNS trabaja así, no con registros
+ * sueltos: `values` es la lista completa y al escribirla reemplaza lo que hubiera.
+ */
+interface DnsRRSet {
+    name: string;
+    type: DnsRecordType;
+    ttl: number;
+    values: string[];
+}
+interface DnsRRSetAnotado extends DnsRRSet {
+    /** Lo pone MailMask para que el correo funcione. */
+    managed: boolean;
+    editable: boolean;
+    managedReason?: string;
+    /** Valores que hay que conservar aunque el registro sea editable (el SPF). */
+    protectedValues?: string[];
+}
+interface DnsZoneState {
+    status: "none" | "pending_delegation" | "active";
+    hostedZoneId?: string;
+    nameservers?: string[];
+    delegated?: boolean;
+}
+interface DnsListResponse {
+    zone: DnsZoneState;
+    records: DnsRRSetAnotado[];
+    /** Presente cuando todavía no hay zona: dice qué hacer. */
+    hint?: string;
+}
+interface DnsZoneCreated {
+    hostedZoneId: string;
+    nameservers: string[];
+    /** Lo que copiamos de tu proveedor anterior. Revísalo: puede faltar algo. */
+    imported: DnsRRSet[];
+    importWarning: string;
+}
+interface DnsDelegation {
+    delegated: boolean;
+    observed: string[];
+    expected: string[];
+}
+interface DnsImportResult {
+    found: DnsRRSet[];
+    nameservers: string[];
+    warning: string;
+}
+interface DnsChangeResult {
+    record?: DnsRRSet;
+    records?: DnsRRSet[];
+    changeId: string;
+    propagacion: string;
+}
+type DnsPreset = "vercel" | "netlify" | "github-pages" | "cloudflare-pages" | "render" | "fly" | "redirect-a-www" | "dmarc";
 
 declare class MailMaskError extends Error {
     status: number;
@@ -317,6 +372,7 @@ declare class MailMask {
     webhooks: WebhooksResource;
     smtp: SmtpResource;
     apiKeys: ApiKeysResource;
+    dns: DnsResource;
     constructor(config: MailMaskConfig);
 }
 type Req = <T>(path: string, opts?: RequestInit) => Promise<T>;
@@ -332,6 +388,26 @@ declare class DomainsResource {
     health(id: string): Promise<Record<string, unknown>>;
     verify(id: string): Promise<DomainVerification>;
 }
+declare class DnsResource {
+    private req;
+    constructor(req: Req);
+    list(domainId: string): Promise<DnsListResponse>;
+    createZone(domainId: string): Promise<DnsZoneCreated>;
+    delegation(domainId: string): Promise<DnsDelegation>;
+    import(domainId: string): Promise<DnsImportResult>;
+    /** Reemplaza el conjunto: `values` sustituye por completo lo que hubiera en ese nombre y tipo. */
+    upsert(domainId: string, record: {
+        name: string;
+        type: DnsRecordType;
+        values: string[];
+        ttl?: number;
+    }): Promise<DnsChangeResult>;
+    delete(domainId: string, name: string, type: DnsRecordType): Promise<{
+        ok: boolean;
+        changeId: string;
+    }>;
+    preset(domainId: string, preset: DnsPreset, target?: string, subdomain?: string): Promise<DnsChangeResult>;
+}
 declare class AliasesResource {
     private req;
     constructor(req: Req);
@@ -442,4 +518,4 @@ interface WebhookSignatureHeaders {
  */
 declare function verifyWebhookSignature(secret: string, headers: WebhookSignatureHeaders, rawBody: string, toleranceMs?: number): Promise<boolean>;
 
-export { type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BulkJob, type BulkJobCreated, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsRecord, type Domain, type DomainCreated, type DomainVerification, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };
+export { type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BulkJob, type BulkJobCreated, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsChangeResult, type DnsDelegation, type DnsImportResult, type DnsListResponse, type DnsPreset, type DnsRRSet, type DnsRRSetAnotado, type DnsRecord, type DnsRecordType, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainVerification, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };

package/dist/index.d.ts

@@ -299,6 +299,61 @@ interface ApiKey {
     lastUsedAt?: string;
     createdAt: string;
 }
+type DnsRecordType = "A" | "AAAA" | "CNAME" | "TXT" | "MX" | "NS" | "CAA" | "SRV";
+/**
+ * Un conjunto de registros con el mismo nombre y tipo. El DNS trabaja así, no con registros
+ * sueltos: `values` es la lista completa y al escribirla reemplaza lo que hubiera.
+ */
+interface DnsRRSet {
+    name: string;
+    type: DnsRecordType;
+    ttl: number;
+    values: string[];
+}
+interface DnsRRSetAnotado extends DnsRRSet {
+    /** Lo pone MailMask para que el correo funcione. */
+    managed: boolean;
+    editable: boolean;
+    managedReason?: string;
+    /** Valores que hay que conservar aunque el registro sea editable (el SPF). */
+    protectedValues?: string[];
+}
+interface DnsZoneState {
+    status: "none" | "pending_delegation" | "active";
+    hostedZoneId?: string;
+    nameservers?: string[];
+    delegated?: boolean;
+}
+interface DnsListResponse {
+    zone: DnsZoneState;
+    records: DnsRRSetAnotado[];
+    /** Presente cuando todavía no hay zona: dice qué hacer. */
+    hint?: string;
+}
+interface DnsZoneCreated {
+    hostedZoneId: string;
+    nameservers: string[];
+    /** Lo que copiamos de tu proveedor anterior. Revísalo: puede faltar algo. */
+    imported: DnsRRSet[];
+    importWarning: string;
+}
+interface DnsDelegation {
+    delegated: boolean;
+    observed: string[];
+    expected: string[];
+}
+interface DnsImportResult {
+    found: DnsRRSet[];
+    nameservers: string[];
+    warning: string;
+}
+interface DnsChangeResult {
+    record?: DnsRRSet;
+    records?: DnsRRSet[];
+    changeId: string;
+    propagacion: string;
+}
+type DnsPreset = "vercel" | "netlify" | "github-pages" | "cloudflare-pages" | "render" | "fly" | "redirect-a-www" | "dmarc";
 
 declare class MailMaskError extends Error {
     status: number;
@@ -317,6 +372,7 @@ declare class MailMask {
     webhooks: WebhooksResource;
     smtp: SmtpResource;
     apiKeys: ApiKeysResource;
+    dns: DnsResource;
     constructor(config: MailMaskConfig);
 }
 type Req = <T>(path: string, opts?: RequestInit) => Promise<T>;
@@ -332,6 +388,26 @@ declare class DomainsResource {
     health(id: string): Promise<Record<string, unknown>>;
     verify(id: string): Promise<DomainVerification>;
 }
+declare class DnsResource {
+    private req;
+    constructor(req: Req);
+    list(domainId: string): Promise<DnsListResponse>;
+    createZone(domainId: string): Promise<DnsZoneCreated>;
+    delegation(domainId: string): Promise<DnsDelegation>;
+    import(domainId: string): Promise<DnsImportResult>;
+    /** Reemplaza el conjunto: `values` sustituye por completo lo que hubiera en ese nombre y tipo. */
+    upsert(domainId: string, record: {
+        name: string;
+        type: DnsRecordType;
+        values: string[];
+        ttl?: number;
+    }): Promise<DnsChangeResult>;
+    delete(domainId: string, name: string, type: DnsRecordType): Promise<{
+        ok: boolean;
+        changeId: string;
+    }>;
+    preset(domainId: string, preset: DnsPreset, target?: string, subdomain?: string): Promise<DnsChangeResult>;
+}
 declare class AliasesResource {
     private req;
     constructor(req: Req);
@@ -442,4 +518,4 @@ interface WebhookSignatureHeaders {
  */
 declare function verifyWebhookSignature(secret: string, headers: WebhookSignatureHeaders, rawBody: string, toleranceMs?: number): Promise<boolean>;
 
-export { type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BulkJob, type BulkJobCreated, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsRecord, type Domain, type DomainCreated, type DomainVerification, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };
+export { type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BulkJob, type BulkJobCreated, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsChangeResult, type DnsDelegation, type DnsImportResult, type DnsListResponse, type DnsPreset, type DnsRRSet, type DnsRRSetAnotado, type DnsRecord, type DnsRecordType, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainVerification, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };

package/dist/index.js

@@ -32,6 +32,7 @@ var MailMask = class {
     this.webhooks = new WebhooksResource(req);
     this.smtp = new SmtpResource(req);
     this.apiKeys = new ApiKeysResource(req);
+    this.dns = new DnsResource(req);
   }
 };
 var DomainsResource = class {
@@ -57,6 +58,33 @@ var DomainsResource = class {
     return this.req(`/api/domains/${id}/verify`, { method: "POST" });
   }
 };
+var DnsResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list(domainId) {
+    return this.req(`/api/domains/${domainId}/dns`);
+  }
+  createZone(domainId) {
+    return this.req(`/api/domains/${domainId}/dns/zone`, { method: "POST" });
+  }
+  delegation(domainId) {
+    return this.req(`/api/domains/${domainId}/dns/delegation`);
+  }
+  import(domainId) {
+    return this.req(`/api/domains/${domainId}/dns/import`, { method: "POST" });
+  }
+  /** Reemplaza el conjunto: `values` sustituye por completo lo que hubiera en ese nombre y tipo. */
+  upsert(domainId, record) {
+    return this.req(`/api/domains/${domainId}/dns/records`, { method: "PUT", body: JSON.stringify(record) });
+  }
+  delete(domainId, name, type) {
+    return this.req(`/api/domains/${domainId}/dns/records`, { method: "DELETE", body: JSON.stringify({ name, type }) });
+  }
+  preset(domainId, preset, target, subdomain) {
+    return this.req(`/api/domains/${domainId}/dns/preset`, { method: "POST", body: JSON.stringify({ preset, target, subdomain }) });
+  }
+};
 var AliasesResource = class {
   constructor(req) {
     this.req = req;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easybits.cloud/mailmask",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "Official SDK for the MailMask email alias/forwarding API",
   "type": "module",
   "main": "./dist/index.cjs",