@easybits.cloud/mailmask 0.4.4 → 0.4.6

package/README.md

@@ -1,6 +1,6 @@
 # @easybits.cloud/mailmask
 
-Official TypeScript/JavaScript SDK for the [MailMask](https://mailmask.studio) email alias and forwarding API.
+Official TypeScript/JavaScript SDK for the [MailMask](https://mailmask.studio) email address, mailbox and forwarding API.
 
 ## Install
 
@@ -19,29 +19,30 @@ const mm = new MailMask({ apiKey: "mk_..." });
 const domains = await mm.domains.list();
 const domainId = domains[0].id;
 
-// Create an alias — emails to hello@yourdomain.com forward to your inbox
-const alias = await mm.aliases.create(domainId, {
+// Create an address — emails to hello@yourdomain.com forward to your inbox
+const address = await mm.addresses.create(domainId, {
   alias: "hello",
   destinations: ["you@example.com"],
 });
 
 // Send an email (routed through MailMask for high deliverability)
 await mm.send.send(domainId, {
-  from: "hello",              // must be an active alias; defaults to `noreply`
+  from: "hello",              // must be an active address; defaults to `noreply`
   fromName: "Acme",           // optional display name: Acme <hello@yourdomain.com>
   to: "client@example.com",
   subject: "Welcome!",
   html: "<p>Thanks for signing up.</p>", // or `body` (plain text) / `markdown`
 });
 
-// List aliases for a domain
-const aliases = await mm.aliases.list(domainId);
+// List addresses for a domain
+const addresses = await mm.addresses.list(domainId);
 
 // Add a domain — returns the DNS records to configure (MX, TXT, DKIM, SPF)
 const { domain, dnsRecords } = await mm.domains.create("yourdomain.com");
 
-// An alias with an IMAP mailbox (activated domain): password is returned once
-const inbox = await mm.aliases.create(domainId, { alias: "sales", mailbox: true });
+// An address with an IMAP mailbox (activated domain): password is returned once
+const inbox = await mm.addresses.create(domainId, { alias: "sales", mailbox: true });
+// `mm.aliases` still works: it is the same resource under its old name.
 console.log(inbox.buzon?.password, inbox.buzon?.imap);
 ```
 
@@ -79,7 +80,7 @@ Full API reference and examples: https://mailmask.studio/docs
 
 ## Links
 
-- [MailMask](https://mailmask.studio) — Email alias & forwarding service
+- [MailMask](https://mailmask.studio) — Email addresses, mailboxes & forwarding on your domain
 - [EasyBits](https://easybits.cloud) — Cloud platform
 - [Fixter](https://fixter.org) — Development team
 

package/dist/index.cjs

@@ -59,7 +59,8 @@ var MailMask = class {
     const doFetch = config.fetch ? config.fetch : fetch;
     const req = (path, opts) => request(this.baseUrl, this.apiKey, path, opts, doFetch);
     this.domains = new DomainsResource(req);
-    this.aliases = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
+    this.addresses = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
+    this.aliases = this.addresses;
     this.rules = new RulesResource(req);
     this.logs = new LogsResource(req);
     this.send = new SendResource(req);
@@ -369,6 +370,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) {

package/dist/index.d.cts

@@ -47,6 +47,14 @@ interface DomainVerification {
     stale?: boolean;
     error?: string;
 }
+/** Nombre público de `Alias` desde la 0.4.5. */
+type Address = Alias;
+/** Nombre público de `AliasCreated` desde la 0.4.5. */
+type AddressCreated = AliasCreated;
+/** Nombre público de `CreateAliasInput` desde la 0.4.5. */
+type CreateAddressInput = CreateAliasInput;
+/** Nombre público de `UpdateAliasInput` desde la 0.4.5. */
+type UpdateAddressInput = UpdateAliasInput;
 interface Alias {
     alias: string;
     domainId: string;
@@ -455,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;
@@ -663,6 +677,9 @@ declare class MailMask {
     private baseUrl;
     private apiKey;
     domains: DomainsResource;
+    /** Las direcciones del dominio (máscaras), con reenvío, buzón o ambos. */
+    addresses: AliasesResource;
+    /** @deprecated Usa `addresses`; es el mismo recurso y no se va a retirar. */
     aliases: AliasesResource;
     rules: RulesResource;
     logs: LogsResource;
@@ -887,6 +904,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;
@@ -1051,4 +1077,4 @@ interface WebhookSignatureHeaders {
  */
 declare function verifyWebhookSignature(secret: string, headers: WebhookSignatureHeaders, rawBody: string, toleranceMs?: number): Promise<boolean>;
 
-export { type AccountProfile, type Addon, type AddonsResponse, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, 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 UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };
+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 };

package/dist/index.d.ts

@@ -47,6 +47,14 @@ interface DomainVerification {
     stale?: boolean;
     error?: string;
 }
+/** Nombre público de `Alias` desde la 0.4.5. */
+type Address = Alias;
+/** Nombre público de `AliasCreated` desde la 0.4.5. */
+type AddressCreated = AliasCreated;
+/** Nombre público de `CreateAliasInput` desde la 0.4.5. */
+type CreateAddressInput = CreateAliasInput;
+/** Nombre público de `UpdateAliasInput` desde la 0.4.5. */
+type UpdateAddressInput = UpdateAliasInput;
 interface Alias {
     alias: string;
     domainId: string;
@@ -455,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;
@@ -663,6 +677,9 @@ declare class MailMask {
     private baseUrl;
     private apiKey;
     domains: DomainsResource;
+    /** Las direcciones del dominio (máscaras), con reenvío, buzón o ambos. */
+    addresses: AliasesResource;
+    /** @deprecated Usa `addresses`; es el mismo recurso y no se va a retirar. */
     aliases: AliasesResource;
     rules: RulesResource;
     logs: LogsResource;
@@ -887,6 +904,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;
@@ -1051,4 +1077,4 @@ interface WebhookSignatureHeaders {
  */
 declare function verifyWebhookSignature(secret: string, headers: WebhookSignatureHeaders, rawBody: string, toleranceMs?: number): Promise<boolean>;
 
-export { type AccountProfile, type Addon, type AddonsResponse, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, 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 UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };
+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 };

package/dist/index.js

@@ -31,7 +31,8 @@ var MailMask = class {
     const doFetch = config.fetch ? config.fetch : fetch;
     const req = (path, opts) => request(this.baseUrl, this.apiKey, path, opts, doFetch);
     this.domains = new DomainsResource(req);
-    this.aliases = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
+    this.addresses = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
+    this.aliases = this.addresses;
     this.rules = new RulesResource(req);
     this.logs = new LogsResource(req);
     this.send = new SendResource(req);
@@ -341,6 +342,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) {

package/package.json

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