@easybits.cloud/mailmask 0.4.9 → 0.4.11

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { MailMaskConfig, Domain, DomainCreated, DomainVerification, Alias, AliasCreated, MailboxCreated, CreateAliasInput, UpdateAliasInput, Rule, CreateRuleInput, UpdateRuleInput, EmailLog, SendEmailInput, BulkSendInput, BulkJob, BulkJobCreated, SmtpCredential, SmtpCredentialCreated, ApiKey, SendOptions, UploadAttachmentInput, UploadedAttachment, Suppression, Webhook, WebhookCreated, CreateWebhookInput, UpdateWebhookInput, WebhookDelivery, DnsRecordType, DnsListResponse, DnsZoneCreated, DnsDelegation, DnsImportResult, DnsChangeResult, DnsPreset, DnsPresetPreview, DnsSetup, WebsiteStatus, BillingStatus, AddonsResponse, CheckoutLink, DomainSearchResult, TldPrice, DomainRegistrationCreated, DomainRegistration, TransferCheck, TransferDnsInventory, RenewalLink, DomainMember, DomainInvite, CannedReply, AccountProfile, AccountMe, AccountExport, InboxPage, InboxListOptions, InboxConversation, InboxConversationDetail, InboxComposeInput, InboxReplyInput, InboxUpdateInput, InboxNote, OrdersPage, ReferralStats, UploadedEmailImage } from "./types.js";
+import type { MailMaskConfig, Domain, DomainCreated, DomainVerification, Alias, AliasCreated, MailboxCreated, CreateAliasInput, UpdateAliasInput, Rule, CreateRuleInput, UpdateRuleInput, EmailLog, SendEmailInput, BulkSendInput, BulkJob, BulkJobCreated, SmtpCredential, SmtpCredentialCreated, ApiKey, SendOptions, UploadAttachmentInput, UploadedAttachment, Suppression, Webhook, WebhookCreated, CreateWebhookInput, UpdateWebhookInput, WebhookDelivery, DnsRecordType, DnsListResponse, DnsZoneCreated, DnsDelegation, DnsImportResult, DnsAudit, DnsChangeResult, DnsPreset, DnsPresetPreview, DnsSetup, WebsiteStatus, PublishEasyBitsSiteInput, EasyBitsPublishResult, EasyBitsSiteStatus, EasyBitsUnpublishResult, BillingStatus, AddonsResponse, CheckoutLink, DomainSearchResult, TldPrice, DomainRegistrationCreated, DomainRegistration, TransferCheck, TransferDnsInventory, RenewalLink, DomainMember, DomainInvite, CannedReply, AccountProfile, AccountMe, AccountExport, InboxPage, InboxListOptions, InboxConversation, InboxConversationDetail, InboxComposeInput, InboxReplyInput, InboxUpdateInput, InboxNote, OrdersPage, ReferralStats, UploadedEmailImage } from "./types.js";
 declare class MailMaskError extends Error {
     status: number;
     constructor(status: number, message: string);
@@ -60,6 +60,16 @@ declare class DomainsResource {
     removeLogo(id: string): Promise<{
         ok: boolean;
     }>;
+    /**
+     * Publica un sitio de EasyBits en el dominio: lo da de alta en EasyBits, escribe sus
+     * registros (sin tocar el correo), verifica y, en la raíz, lo asigna. Requiere la cuenta
+     * de EasyBits conectada en el navegador; sin ella, 409 con la liga para conectarla.
+     */
+    publishEasyBitsSite(id: string, input: PublishEasyBitsSiteInput): Promise<EasyBitsPublishResult>;
+    /** Quita el sitio: el DNS vuelve a como estaba (lo que cambiaste después no se toca) y se limpia EasyBits. */
+    unpublishEasyBitsSite(id: string): Promise<EasyBitsUnpublishResult>;
+    /** Qué sitio de EasyBits está publicado en el dominio, si alguno, y si la cuenta está conectada. */
+    easyBitsSiteStatus(id: string): Promise<EasyBitsSiteStatus>;
     /** Imagen para incrustar en un correo saliente (PNG, JPG, GIF o WebP; máx. 2 MB). Efímera: se borra tras enviarse o por el barrido diario. */
     uploadImage(id: string, file: Blob, filename?: string): Promise<UploadedEmailImage>;
 }
@@ -70,6 +80,8 @@ declare class DnsResource {
     createZone(domainId: string): Promise<DnsZoneCreated>;
     delegation(domainId: string): Promise<DnsDelegation>;
     import(domainId: string): Promise<DnsImportResult>;
+    /** Mide qué registros siguen vivos y los clasifica para podar (sólo lectura). */
+    audit(domainId: string): Promise<DnsAudit>;
     /** Reemplaza el conjunto: `values` sustituye por completo lo que hubiera en ese nombre y tipo. */
     upsert(domainId: string, record: {
         name: string;
@@ -81,9 +93,16 @@ declare class DnsResource {
         ok: boolean;
         changeId: string;
     }>;
-    preset(domainId: string, preset: DnsPreset, target?: string, subdomain?: string): Promise<DnsChangeResult>;
+    /** Con 'easybits' publica un sitio de la cuenta conectada (`opts.websiteId`), igual que `domains.publishEasyBitsSite`. */
+    preset(domainId: string, preset: DnsPreset, target?: string, subdomain?: string, opts?: {
+        websiteId?: string;
+        placement?: "apex" | "subdomain";
+    }): Promise<DnsChangeResult>;
     /** Vista previa de una plantilla: lo que escribiría y lo que hay hoy, sin tocar nada. */
-    presetPreview(domainId: string, preset: DnsPreset, target?: string, subdomain?: string): Promise<DnsPresetPreview>;
+    presetPreview(domainId: string, preset: DnsPreset, target?: string, subdomain?: string, opts?: {
+        websiteId?: string;
+        placement?: "apex" | "subdomain";
+    }): Promise<DnsPresetPreview>;
     /** A dónde apunta el sitio (raíz, www y subdominios), qué plataforma es, qué está mal y si responde por HTTPS. */
     website(domainId: string): Promise<WebsiteStatus>;
 }

package/dist/index.cjs

@@ -120,6 +120,22 @@ var DomainsResource = class {
   removeLogo(id) {
     return this.req(`/api/domains/${id}/logo`, { method: "DELETE" });
   }
+  /**
+   * Publica un sitio de EasyBits en el dominio: lo da de alta en EasyBits, escribe sus
+   * registros (sin tocar el correo), verifica y, en la raíz, lo asigna. Requiere la cuenta
+   * de EasyBits conectada en el navegador; sin ella, 409 con la liga para conectarla.
+   */
+  publishEasyBitsSite(id, input) {
+    return this.req(`/api/domains/${id}/website/easybits`, { method: "POST", body: JSON.stringify(input) });
+  }
+  /** Quita el sitio: el DNS vuelve a como estaba (lo que cambiaste después no se toca) y se limpia EasyBits. */
+  unpublishEasyBitsSite(id) {
+    return this.req(`/api/domains/${id}/website/easybits`, { method: "DELETE" });
+  }
+  /** Qué sitio de EasyBits está publicado en el dominio, si alguno, y si la cuenta está conectada. */
+  easyBitsSiteStatus(id) {
+    return this.req(`/api/domains/${id}/website/easybits`);
+  }
   /** Imagen para incrustar en un correo saliente (PNG, JPG, GIF o WebP; máx. 2 MB). Efímera: se borra tras enviarse o por el barrido diario. */
   uploadImage(id, file, filename = "imagen") {
     const form = new FormData();
@@ -143,6 +159,10 @@ var DnsResource = class {
   import(domainId) {
     return this.req(`/api/domains/${domainId}/dns/import`, { method: "POST" });
   }
+  /** Mide qué registros siguen vivos y los clasifica para podar (sólo lectura). */
+  audit(domainId) {
+    return this.req(`/api/domains/${domainId}/dns/audit`);
+  }
   /** 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) });
@@ -150,12 +170,13 @@ var DnsResource = class {
   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 }) });
+  /** Con 'easybits' publica un sitio de la cuenta conectada (`opts.websiteId`), igual que `domains.publishEasyBitsSite`. */
+  preset(domainId, preset, target, subdomain, opts) {
+    return this.req(`/api/domains/${domainId}/dns/preset`, { method: "POST", body: JSON.stringify({ preset, target, subdomain, ...opts }) });
   }
   /** Vista previa de una plantilla: lo que escribiría y lo que hay hoy, sin tocar nada. */
-  presetPreview(domainId, preset, target, subdomain) {
-    return this.req(`/api/domains/${domainId}/dns/preset`, { method: "POST", body: JSON.stringify({ preset, target, subdomain, dryRun: true }) });
+  presetPreview(domainId, preset, target, subdomain, opts) {
+    return this.req(`/api/domains/${domainId}/dns/preset`, { method: "POST", body: JSON.stringify({ preset, target, subdomain, ...opts, dryRun: true }) });
   }
   /** A dónde apunta el sitio (raíz, www y subdominios), qué plataforma es, qué está mal y si responde por HTTPS. */
   website(domainId) {

package/dist/index.js

@@ -92,6 +92,22 @@ var DomainsResource = class {
   removeLogo(id) {
     return this.req(`/api/domains/${id}/logo`, { method: "DELETE" });
   }
+  /**
+   * Publica un sitio de EasyBits en el dominio: lo da de alta en EasyBits, escribe sus
+   * registros (sin tocar el correo), verifica y, en la raíz, lo asigna. Requiere la cuenta
+   * de EasyBits conectada en el navegador; sin ella, 409 con la liga para conectarla.
+   */
+  publishEasyBitsSite(id, input) {
+    return this.req(`/api/domains/${id}/website/easybits`, { method: "POST", body: JSON.stringify(input) });
+  }
+  /** Quita el sitio: el DNS vuelve a como estaba (lo que cambiaste después no se toca) y se limpia EasyBits. */
+  unpublishEasyBitsSite(id) {
+    return this.req(`/api/domains/${id}/website/easybits`, { method: "DELETE" });
+  }
+  /** Qué sitio de EasyBits está publicado en el dominio, si alguno, y si la cuenta está conectada. */
+  easyBitsSiteStatus(id) {
+    return this.req(`/api/domains/${id}/website/easybits`);
+  }
   /** Imagen para incrustar en un correo saliente (PNG, JPG, GIF o WebP; máx. 2 MB). Efímera: se borra tras enviarse o por el barrido diario. */
   uploadImage(id, file, filename = "imagen") {
     const form = new FormData();
@@ -115,6 +131,10 @@ var DnsResource = class {
   import(domainId) {
     return this.req(`/api/domains/${domainId}/dns/import`, { method: "POST" });
   }
+  /** Mide qué registros siguen vivos y los clasifica para podar (sólo lectura). */
+  audit(domainId) {
+    return this.req(`/api/domains/${domainId}/dns/audit`);
+  }
   /** 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) });
@@ -122,12 +142,13 @@ var DnsResource = class {
   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 }) });
+  /** Con 'easybits' publica un sitio de la cuenta conectada (`opts.websiteId`), igual que `domains.publishEasyBitsSite`. */
+  preset(domainId, preset, target, subdomain, opts) {
+    return this.req(`/api/domains/${domainId}/dns/preset`, { method: "POST", body: JSON.stringify({ preset, target, subdomain, ...opts }) });
   }
   /** Vista previa de una plantilla: lo que escribiría y lo que hay hoy, sin tocar nada. */
-  presetPreview(domainId, preset, target, subdomain) {
-    return this.req(`/api/domains/${domainId}/dns/preset`, { method: "POST", body: JSON.stringify({ preset, target, subdomain, dryRun: true }) });
+  presetPreview(domainId, preset, target, subdomain, opts) {
+    return this.req(`/api/domains/${domainId}/dns/preset`, { method: "POST", body: JSON.stringify({ preset, target, subdomain, ...opts, dryRun: true }) });
   }
   /** A dónde apunta el sitio (raíz, www y subdominios), qué plataforma es, qué está mal y si responde por HTTPS. */
   website(domainId) {

package/dist/types.d.ts

@@ -350,6 +350,26 @@ export interface DnsListResponse {
     /** Presente cuando todavía no hay zona: dice qué hacer. */
     hint?: string;
 }
+export type DnsAuditVerdict = "takeover_risk" | "duplicated_name" | "not_responding" | "previous_provider" | "cert_validation" | "in_use" | "keep";
+export interface DnsAuditFinding {
+    name: string;
+    type: string;
+    values: string[];
+    verdict: DnsAuditVerdict;
+    /** Lo que se midió, en español. */
+    evidence: string;
+    /** Qué conviene hacer, en español. */
+    action: string;
+}
+/** Respuesta de `dns.audit`: hallazgos ordenados, los urgentes primero. */
+export interface DnsAudit {
+    domain: string;
+    checkedAt: string;
+    summary: Partial<Record<DnsAuditVerdict, number>>;
+    findings: DnsAuditFinding[];
+    truncated: boolean;
+    note: string;
+}
 export interface DnsZoneCreated {
     hostedZoneId: string;
     nameservers: string[];
@@ -407,6 +427,71 @@ export interface WebsiteStatus {
     editable: boolean;
     hosts: WebsiteHost[];
 }
+export interface EasyBitsSite {
+    id: string;
+    name: string;
+    slug: string;
+    status: string;
+    url: string;
+    subdomainUrl?: string | null;
+}
+export interface PublishEasyBitsSiteInput {
+    /** El sitio de EasyBits: los de la cuenta salen en `easyBitsSiteStatus().sites`. */
+    websiteId: string;
+    /** 'apex' = raíz y www; 'subdomain' = `<slug>.<dominio>`. */
+    placement: "apex" | "subdomain";
+    /** Vista previa: lo que escribiría y lo que hay hoy, sin tocar EasyBits ni el DNS. */
+    dryRun?: boolean;
+}
+export interface EasyBitsPublishResult {
+    dryRun: boolean;
+    url: string;
+    site: EasyBitsSite;
+    records: DnsRRSet[];
+    /** Sólo en vista previa: lo que hay hoy en cada (nombre, tipo), null = nada. */
+    current?: (DnsRRSet | null)[];
+    /** EasyBits ya vio el TXT; si es false, el DNS ya está y la verificación llega en minutos. */
+    verified?: boolean;
+    easybitsDomainId?: string;
+}
+export interface EasyBitsSiteStatus {
+    /** Si quien pregunta tiene su cuenta de EasyBits conectada (se conecta en el navegador). */
+    linked: boolean;
+    /** Los sitios de la cuenta de EasyBits conectada (vacío sin conexión o si EasyBits no respondió). */
+    sites: EasyBitsSite[];
+    published: boolean;
+    publication: {
+        websiteId: string;
+        placement: "apex" | "subdomain";
+        url: string;
+        publishedBy: string;
+        records: DnsRRSet[];
+        createdAt: string;
+        updatedAt: string;
+    } | null;
+}
+export interface EasyBitsUnpublishResult {
+    ok: true;
+    /** No había nada publicado. */
+    nothing?: true;
+    /** Registros que volvieron a como estaban antes de publicar (`to: null` = se borró). */
+    restored: {
+        name: string;
+        type: string;
+        to: DnsRRSet | null;
+    }[];
+    /** Registros que el usuario cambió después de publicar: se dejaron como están. */
+    skipped: {
+        name: string;
+        type: string;
+        current: DnsRRSet | null;
+    }[];
+    easybits: {
+        apexCleared: boolean;
+        domainDeleted: boolean;
+        error?: string;
+    };
+}
 export interface DnsSetupRecord {
     id: string;
     type: "MX" | "TXT" | "CNAME";

package/package.json

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