@easybits.cloud/mailmask 0.4.5 → 0.4.7

package/README.md

@@ -62,6 +62,13 @@ await mm.send.send(domainId, {
   inReplyTo: "<abc@mail.example.com>", references: "<abc@mail.example.com>",
 }, { idempotencyKey: `invoice-42` });
 
+// Account: identity + usage, and a full JSON export
+const me = await mm.account.me();
+const backup = await mm.account.export();
+
+// Upload an image to embed in an outgoing email (returns a public url)
+const { url } = await mm.domains.uploadImage(domainId, imageBlob);
+
 // Suppression list (hard bounces / complaints)
 await mm.suppressions.list(domainId);
 await mm.suppressions.remove(domainId, "fixed@example.com");

package/dist/index.cjs

@@ -120,6 +120,12 @@ var DomainsResource = class {
   removeLogo(id) {
     return this.req(`/api/domains/${id}/logo`, { method: "DELETE" });
   }
+  /** 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();
+    form.append("file", file, filename);
+    return this.req(`/api/domains/${id}/images`, { method: "POST", body: form });
+  }
 };
 var DnsResource = class {
   constructor(req) {
@@ -370,6 +376,13 @@ var RegistrationsResource = class {
   cancelRenewal(regId) {
     return this.req(`/api/domains/registrations/${regId}/renewal/cancel`, { method: "POST" });
   }
+  /**
+   * Pone el candado de transferencia. Quitarlo no está en el SDK a propósito: sólo se hace
+   * desde el panel, con la sesión del dueño y confirmando por correo.
+   */
+  lock(regId) {
+    return this.req(`/api/domains/registrations/${regId}/transfer-lock`, { method: "POST", body: JSON.stringify({ locked: true }) });
+  }
 };
 var TransfersResource = class {
   constructor(req) {
@@ -441,6 +454,18 @@ var AccountResource = class {
   constructor(req) {
     this.req = req;
   }
+  /**
+   * Identidad y uso de la cuenta: dominios, derechos por dominio, add-ons y cuotas.
+   * Sustituto de `whoami` mientras no exista un endpoint de identidad más chico — ver
+   * `docs/agents/mailmask-cli.md`.
+   */
+  me() {
+    return this.req("/api/auth/me");
+  }
+  /** Todo tu dato (alias, reglas y logs de cada dominio) como JSON exportable. */
+  export() {
+    return this.req("/api/export");
+  }
   getProfile() {
     return this.req("/api/profile");
   }

package/dist/index.d.cts

@@ -463,6 +463,12 @@ interface DomainRegistration {
     nextChargeAt: string | null;
     dnsImportStatus: string;
     transferAuthCodeHint: string | null;
+    /** Candado de transferencia (`clientTransferProhibited`); null si aún no se ha leído de AWS. */
+    transferLock: boolean | null;
+    /** Mientras está quitado: cuándo se vuelve a poner solo. */
+    transferUnlockedUntil: string | null;
+    /** Desde cuándo puede cambiar de registrador (regla de 60 días de ICANN). */
+    transferEligibleAt: string;
     lastError: string | null;
     createdAt: string;
     [k: string]: unknown;
@@ -529,6 +535,93 @@ interface AccountProfile {
     /** Ruta relativa al host de MailMask (`/api/avatar/...`), o null sin foto. */
     avatarUrl: string | null;
 }
+/** Derechos y uso de UN dominio, dentro de `AccountMe.porDominio`. */
+interface AccountMeDomainUsage {
+    id: string;
+    domain: string;
+    /** Límites del dominio (sends, aliases, dominios, etc.), por plan y add-ons. */
+    derechos: Record<string, unknown>;
+    addons: Addon[];
+    uso: {
+        aliases: {
+            current: number;
+            limit: number;
+        };
+        rules: {
+            current: number;
+            limit: number;
+        };
+        sends: {
+            current: number;
+            limit: number;
+        };
+        forwards: {
+            current: number;
+            limit: number;
+        };
+        mailboxBytes: {
+            current: number;
+            limit: number;
+        };
+    };
+}
+/** Respuesta de `account.me()`: identidad de la cuenta y su uso, por dominio y total. */
+interface AccountMe extends AccountProfile {
+    isAdmin: boolean;
+    assistant: boolean;
+    domainsCount: number;
+    emailVerified: boolean;
+    forwards: {
+        current: number;
+        limit: number;
+    };
+    subscription: {
+        plan: string;
+        status: string;
+        currentPeriodEnd: string | null;
+        planLabel: string;
+        [k: string]: unknown;
+    };
+    porDominio: AccountMeDomainUsage[];
+    addons: Addon[];
+    planPriceCents: number | null;
+    addonCatalog: Record<string, {
+        price: number;
+        label: string;
+    }>;
+    addonsForSale: string[];
+    lastOrder: Order | null;
+    usage: {
+        domains: {
+            current: number;
+            limit: number | null;
+        };
+        aliasesPerDomain: unknown[];
+        rulesPerDomain: unknown[];
+        sendsPerDomain: unknown[];
+    };
+    referralSlug?: string | null;
+    referralStats: ReferralStats;
+}
+/** Respuesta de `account.export()`: todo el dato del usuario, listo para descargar. */
+interface AccountExport {
+    email: string;
+    exportedAt: string;
+    domains: {
+        domain: string;
+        domainId: string;
+        verified: boolean;
+        aliases: Alias[];
+        rules: Rule[];
+        logs: EmailLog[];
+    }[];
+}
+/** Respuesta de `domains.uploadImage()`. */
+interface UploadedEmailImage {
+    ok: boolean;
+    /** Efímera: se borra tras enviarse (o la barre el aseo diario si nunca se usó). */
+    url: string;
+}
 type InboxStatus = "open" | "snoozed" | "closed";
 interface InboxConversation {
     id: string;
@@ -724,6 +817,8 @@ declare class DomainsResource {
     removeLogo(id: string): Promise<{
         ok: boolean;
     }>;
+    /** 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>;
 }
 declare class DnsResource {
     private req;
@@ -898,6 +993,15 @@ declare class RegistrationsResource {
         ok: boolean;
         aviso: string;
     }>;
+    /**
+     * Pone el candado de transferencia. Quitarlo no está en el SDK a propósito: sólo se hace
+     * desde el panel, con la sesión del dueño y confirmando por correo.
+     */
+    lock(regId: string): Promise<{
+        ok: boolean;
+        transferLock: boolean;
+        transferUnlockedUntil: null;
+    }>;
 }
 declare class TransfersResource {
     private req;
@@ -970,6 +1074,14 @@ declare class CannedResource {
 declare class AccountResource {
     private req;
     constructor(req: Req);
+    /**
+     * Identidad y uso de la cuenta: dominios, derechos por dominio, add-ons y cuotas.
+     * Sustituto de `whoami` mientras no exista un endpoint de identidad más chico — ver
+     * `docs/agents/mailmask-cli.md`.
+     */
+    me(): Promise<AccountMe>;
+    /** Todo tu dato (alias, reglas y logs de cada dominio) como JSON exportable. */
+    export(): Promise<AccountExport>;
     getProfile(): Promise<AccountProfile>;
     /** Nombre visible (máx. 60 caracteres). Cadena vacía lo borra. */
     updateProfile(input: {
@@ -1062,4 +1174,4 @@ interface WebhookSignatureHeaders {
  */
 declare function verifyWebhookSignature(secret: string, headers: WebhookSignatureHeaders, rawBody: string, toleranceMs?: number): Promise<boolean>;
 
-export { type AccountProfile, type Addon, type AddonsResponse, type Address, type AddressCreated, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAddressInput, 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 DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, type InboxAttachment, type InboxComposeInput, type InboxConversation, type InboxConversationDetail, type InboxListOptions, type InboxMessage, type InboxNote, type InboxPage, type InboxReplyInput, type InboxStatus, type InboxUpdateInput, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Order, type OrdersPage, type ReferralStats, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAddressInput, 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 AccountExport, type AccountMe, type AccountMeDomainUsage, type AccountProfile, type Addon, type AddonsResponse, type Address, type AddressCreated, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAddressInput, 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 DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, type InboxAttachment, type InboxComposeInput, type InboxConversation, type InboxConversationDetail, type InboxListOptions, type InboxMessage, type InboxNote, type InboxPage, type InboxReplyInput, type InboxStatus, type InboxUpdateInput, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Order, type OrdersPage, type ReferralStats, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAddressInput, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type UploadedEmailImage, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };

package/dist/index.d.ts

@@ -463,6 +463,12 @@ interface DomainRegistration {
     nextChargeAt: string | null;
     dnsImportStatus: string;
     transferAuthCodeHint: string | null;
+    /** Candado de transferencia (`clientTransferProhibited`); null si aún no se ha leído de AWS. */
+    transferLock: boolean | null;
+    /** Mientras está quitado: cuándo se vuelve a poner solo. */
+    transferUnlockedUntil: string | null;
+    /** Desde cuándo puede cambiar de registrador (regla de 60 días de ICANN). */
+    transferEligibleAt: string;
     lastError: string | null;
     createdAt: string;
     [k: string]: unknown;
@@ -529,6 +535,93 @@ interface AccountProfile {
     /** Ruta relativa al host de MailMask (`/api/avatar/...`), o null sin foto. */
     avatarUrl: string | null;
 }
+/** Derechos y uso de UN dominio, dentro de `AccountMe.porDominio`. */
+interface AccountMeDomainUsage {
+    id: string;
+    domain: string;
+    /** Límites del dominio (sends, aliases, dominios, etc.), por plan y add-ons. */
+    derechos: Record<string, unknown>;
+    addons: Addon[];
+    uso: {
+        aliases: {
+            current: number;
+            limit: number;
+        };
+        rules: {
+            current: number;
+            limit: number;
+        };
+        sends: {
+            current: number;
+            limit: number;
+        };
+        forwards: {
+            current: number;
+            limit: number;
+        };
+        mailboxBytes: {
+            current: number;
+            limit: number;
+        };
+    };
+}
+/** Respuesta de `account.me()`: identidad de la cuenta y su uso, por dominio y total. */
+interface AccountMe extends AccountProfile {
+    isAdmin: boolean;
+    assistant: boolean;
+    domainsCount: number;
+    emailVerified: boolean;
+    forwards: {
+        current: number;
+        limit: number;
+    };
+    subscription: {
+        plan: string;
+        status: string;
+        currentPeriodEnd: string | null;
+        planLabel: string;
+        [k: string]: unknown;
+    };
+    porDominio: AccountMeDomainUsage[];
+    addons: Addon[];
+    planPriceCents: number | null;
+    addonCatalog: Record<string, {
+        price: number;
+        label: string;
+    }>;
+    addonsForSale: string[];
+    lastOrder: Order | null;
+    usage: {
+        domains: {
+            current: number;
+            limit: number | null;
+        };
+        aliasesPerDomain: unknown[];
+        rulesPerDomain: unknown[];
+        sendsPerDomain: unknown[];
+    };
+    referralSlug?: string | null;
+    referralStats: ReferralStats;
+}
+/** Respuesta de `account.export()`: todo el dato del usuario, listo para descargar. */
+interface AccountExport {
+    email: string;
+    exportedAt: string;
+    domains: {
+        domain: string;
+        domainId: string;
+        verified: boolean;
+        aliases: Alias[];
+        rules: Rule[];
+        logs: EmailLog[];
+    }[];
+}
+/** Respuesta de `domains.uploadImage()`. */
+interface UploadedEmailImage {
+    ok: boolean;
+    /** Efímera: se borra tras enviarse (o la barre el aseo diario si nunca se usó). */
+    url: string;
+}
 type InboxStatus = "open" | "snoozed" | "closed";
 interface InboxConversation {
     id: string;
@@ -724,6 +817,8 @@ declare class DomainsResource {
     removeLogo(id: string): Promise<{
         ok: boolean;
     }>;
+    /** 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>;
 }
 declare class DnsResource {
     private req;
@@ -898,6 +993,15 @@ declare class RegistrationsResource {
         ok: boolean;
         aviso: string;
     }>;
+    /**
+     * Pone el candado de transferencia. Quitarlo no está en el SDK a propósito: sólo se hace
+     * desde el panel, con la sesión del dueño y confirmando por correo.
+     */
+    lock(regId: string): Promise<{
+        ok: boolean;
+        transferLock: boolean;
+        transferUnlockedUntil: null;
+    }>;
 }
 declare class TransfersResource {
     private req;
@@ -970,6 +1074,14 @@ declare class CannedResource {
 declare class AccountResource {
     private req;
     constructor(req: Req);
+    /**
+     * Identidad y uso de la cuenta: dominios, derechos por dominio, add-ons y cuotas.
+     * Sustituto de `whoami` mientras no exista un endpoint de identidad más chico — ver
+     * `docs/agents/mailmask-cli.md`.
+     */
+    me(): Promise<AccountMe>;
+    /** Todo tu dato (alias, reglas y logs de cada dominio) como JSON exportable. */
+    export(): Promise<AccountExport>;
     getProfile(): Promise<AccountProfile>;
     /** Nombre visible (máx. 60 caracteres). Cadena vacía lo borra. */
     updateProfile(input: {
@@ -1062,4 +1174,4 @@ interface WebhookSignatureHeaders {
  */
 declare function verifyWebhookSignature(secret: string, headers: WebhookSignatureHeaders, rawBody: string, toleranceMs?: number): Promise<boolean>;
 
-export { type AccountProfile, type Addon, type AddonsResponse, type Address, type AddressCreated, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAddressInput, 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 DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, type InboxAttachment, type InboxComposeInput, type InboxConversation, type InboxConversationDetail, type InboxListOptions, type InboxMessage, type InboxNote, type InboxPage, type InboxReplyInput, type InboxStatus, type InboxUpdateInput, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Order, type OrdersPage, type ReferralStats, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAddressInput, 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 AccountExport, type AccountMe, type AccountMeDomainUsage, type AccountProfile, type Addon, type AddonsResponse, type Address, type AddressCreated, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAddressInput, 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 DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, type InboxAttachment, type InboxComposeInput, type InboxConversation, type InboxConversationDetail, type InboxListOptions, type InboxMessage, type InboxNote, type InboxPage, type InboxReplyInput, type InboxStatus, type InboxUpdateInput, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Order, type OrdersPage, type ReferralStats, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAddressInput, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type UploadedEmailImage, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };

package/dist/index.js

@@ -92,6 +92,12 @@ var DomainsResource = class {
   removeLogo(id) {
     return this.req(`/api/domains/${id}/logo`, { method: "DELETE" });
   }
+  /** 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();
+    form.append("file", file, filename);
+    return this.req(`/api/domains/${id}/images`, { method: "POST", body: form });
+  }
 };
 var DnsResource = class {
   constructor(req) {
@@ -342,6 +348,13 @@ var RegistrationsResource = class {
   cancelRenewal(regId) {
     return this.req(`/api/domains/registrations/${regId}/renewal/cancel`, { method: "POST" });
   }
+  /**
+   * Pone el candado de transferencia. Quitarlo no está en el SDK a propósito: sólo se hace
+   * desde el panel, con la sesión del dueño y confirmando por correo.
+   */
+  lock(regId) {
+    return this.req(`/api/domains/registrations/${regId}/transfer-lock`, { method: "POST", body: JSON.stringify({ locked: true }) });
+  }
 };
 var TransfersResource = class {
   constructor(req) {
@@ -413,6 +426,18 @@ var AccountResource = class {
   constructor(req) {
     this.req = req;
   }
+  /**
+   * Identidad y uso de la cuenta: dominios, derechos por dominio, add-ons y cuotas.
+   * Sustituto de `whoami` mientras no exista un endpoint de identidad más chico — ver
+   * `docs/agents/mailmask-cli.md`.
+   */
+  me() {
+    return this.req("/api/auth/me");
+  }
+  /** Todo tu dato (alias, reglas y logs de cada dominio) como JSON exportable. */
+  export() {
+    return this.req("/api/export");
+  }
   getProfile() {
     return this.req("/api/profile");
   }

package/package.json

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