@easybits.cloud/mailmask 0.2.0 → 0.2.2

package/README.md

@@ -31,7 +31,7 @@ await mm.send.send(domainId, {
   fromName: "Acme",           // optional display name: Acme <hello@yourdomain.com>
   to: "client@example.com",
   subject: "Welcome!",
-  html: "<p>Thanks for signing up.</p>",
+  html: "<p>Thanks for signing up.</p>", // or `body` (plain text) / `markdown`
 });
 
 // List aliases for a domain

package/dist/index.cjs

@@ -124,8 +124,10 @@ var LogsResource = class {
   constructor(req) {
     this.req = req;
   }
-  list(domainId) {
-    return this.req(`/api/domains/${domainId}/logs`);
+  /** `limit` por omisión 50, máximo 100. */
+  list(domainId, opts) {
+    const qs = opts?.limit ? `?limit=${encodeURIComponent(opts.limit)}` : "";
+    return this.req(`/api/domains/${domainId}/logs${qs}`);
   }
 };
 var SendResource = class {

package/dist/index.d.cts

@@ -13,7 +13,21 @@ interface Domain {
     domain: string;
     verified: boolean;
     mxConfigured: boolean;
+    registeredViaMailmask: boolean;
     createdAt: string;
+    /** Sólo en `domains.list`: reenvíos del mes en curso. */
+    monthlyForwards?: number;
+    /** Sólo en `domains.list`: tope de reenvíos por hora del plan. */
+    forwardPerHour?: number;
+}
+/** Respuesta de `domains.verify`. */
+interface DomainVerification {
+    domain: string;
+    verified: boolean;
+    dkimVerified: boolean;
+    /** true cuando no se pudo consultar a SES: los campos son el último estado conocido. */
+    stale?: boolean;
+    error?: string;
 }
 interface Alias {
     alias: string;
@@ -21,6 +35,8 @@ interface Alias {
     destinations: string[];
     enabled: boolean;
     forwardCount: number;
+    lastFrom?: string | null;
+    lastAt?: string | null;
     createdAt: string;
 }
 interface CreateAliasInput {
@@ -32,31 +48,38 @@ interface UpdateAliasInput {
     enabled?: boolean;
     destinations?: string[];
 }
+type RuleField = "to" | "from" | "subject";
+type RuleMatch = "contains" | "equals" | "regex";
+/** `forward` y `webhook` requieren `target`; `discard` no. */
+type RuleAction = "forward" | "webhook" | "discard";
 interface Rule {
     id: string;
     domainId: string;
-    field: "to" | "from" | "subject";
-    match: string;
+    field: RuleField;
+    match: RuleMatch;
     value: string;
-    action: string;
+    action: RuleAction;
     target: string;
     priority: number;
     enabled: boolean;
     createdAt: string;
 }
 interface CreateRuleInput {
-    field: "to" | "from" | "subject";
-    match: string;
+    field: RuleField;
+    /** Los patrones `regex` se validan al guardar: uno peligroso responde 400. */
+    match: RuleMatch;
     value: string;
-    action: string;
-    target: string;
+    action: RuleAction;
+    /** Destino del `forward` o URL del `webhook`. Se ignora con `discard`. */
+    target?: string;
     priority?: number;
+    enabled?: boolean;
 }
 interface UpdateRuleInput {
-    field?: "to" | "from" | "subject";
-    match?: string;
+    field?: RuleField;
+    match?: RuleMatch;
     value?: string;
-    action?: string;
+    action?: RuleAction;
     target?: string;
     priority?: number;
     enabled?: boolean;
@@ -70,14 +93,16 @@ interface EmailLog {
     subject: string;
     status: string;
     forwardedTo: string;
+    sizeBytes: number;
     error?: string;
 }
 interface SendEmailInput {
     to: string;
     subject: string;
-    /** Al menos uno de `html` o `body`. Con los dos se manda multipart. */
+    /** Al menos uno de `html`, `body` o `markdown`. Con html y body se manda multipart. HTML máx. 100 KB. */
     html?: string;
     body?: string;
+    markdown?: string;
     replyTo?: string;
     /**
      * Parte local de un alias **activo** del dominio. Sin esto el correo sale
@@ -141,6 +166,8 @@ interface SmtpCredentialCreated {
 interface ApiKey {
     id: string;
     name: string;
+    /** Primeros caracteres de la llave, para identificarla en listados. */
+    keyPrefix: string;
     lastUsedAt?: string;
     createdAt: string;
 }
@@ -174,7 +201,7 @@ declare class DomainsResource {
         ok: boolean;
     }>;
     health(id: string): Promise<Record<string, unknown>>;
-    verify(id: string): Promise<Record<string, unknown>>;
+    verify(id: string): Promise<DomainVerification>;
 }
 declare class AliasesResource {
     private req;
@@ -199,12 +226,16 @@ declare class RulesResource {
 declare class LogsResource {
     private req;
     constructor(req: Req);
-    list(domainId: string): Promise<EmailLog[]>;
+    /** `limit` por omisión 50, máximo 100. */
+    list(domainId: string, opts?: {
+        limit?: number;
+    }): Promise<EmailLog[]>;
 }
 declare class SendResource {
     private req;
     constructor(req: Req);
     send(domainId: string, input: SendEmailInput): Promise<{
+        ok: boolean;
         messageId: string;
     }>;
     bulkSend(domainId: string, input: BulkSendInput): Promise<BulkJobCreated>;
@@ -231,4 +262,4 @@ declare class ApiKeysResource {
     }>;
 }
 
-export { type Alias, type ApiKey, type BulkJob, type BulkJobCreated, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type Domain, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type Rule, type SendEmailInput, type SmtpCredential, type SmtpCredentialCreated, type UpdateAliasInput, type UpdateRuleInput };
+export { type Alias, type ApiKey, type BulkJob, type BulkJobCreated, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type Domain, type DomainVerification, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SmtpCredential, type SmtpCredentialCreated, type UpdateAliasInput, type UpdateRuleInput };

package/dist/index.d.ts

@@ -13,7 +13,21 @@ interface Domain {
     domain: string;
     verified: boolean;
     mxConfigured: boolean;
+    registeredViaMailmask: boolean;
     createdAt: string;
+    /** Sólo en `domains.list`: reenvíos del mes en curso. */
+    monthlyForwards?: number;
+    /** Sólo en `domains.list`: tope de reenvíos por hora del plan. */
+    forwardPerHour?: number;
+}
+/** Respuesta de `domains.verify`. */
+interface DomainVerification {
+    domain: string;
+    verified: boolean;
+    dkimVerified: boolean;
+    /** true cuando no se pudo consultar a SES: los campos son el último estado conocido. */
+    stale?: boolean;
+    error?: string;
 }
 interface Alias {
     alias: string;
@@ -21,6 +35,8 @@ interface Alias {
     destinations: string[];
     enabled: boolean;
     forwardCount: number;
+    lastFrom?: string | null;
+    lastAt?: string | null;
     createdAt: string;
 }
 interface CreateAliasInput {
@@ -32,31 +48,38 @@ interface UpdateAliasInput {
     enabled?: boolean;
     destinations?: string[];
 }
+type RuleField = "to" | "from" | "subject";
+type RuleMatch = "contains" | "equals" | "regex";
+/** `forward` y `webhook` requieren `target`; `discard` no. */
+type RuleAction = "forward" | "webhook" | "discard";
 interface Rule {
     id: string;
     domainId: string;
-    field: "to" | "from" | "subject";
-    match: string;
+    field: RuleField;
+    match: RuleMatch;
     value: string;
-    action: string;
+    action: RuleAction;
     target: string;
     priority: number;
     enabled: boolean;
     createdAt: string;
 }
 interface CreateRuleInput {
-    field: "to" | "from" | "subject";
-    match: string;
+    field: RuleField;
+    /** Los patrones `regex` se validan al guardar: uno peligroso responde 400. */
+    match: RuleMatch;
     value: string;
-    action: string;
-    target: string;
+    action: RuleAction;
+    /** Destino del `forward` o URL del `webhook`. Se ignora con `discard`. */
+    target?: string;
     priority?: number;
+    enabled?: boolean;
 }
 interface UpdateRuleInput {
-    field?: "to" | "from" | "subject";
-    match?: string;
+    field?: RuleField;
+    match?: RuleMatch;
     value?: string;
-    action?: string;
+    action?: RuleAction;
     target?: string;
     priority?: number;
     enabled?: boolean;
@@ -70,14 +93,16 @@ interface EmailLog {
     subject: string;
     status: string;
     forwardedTo: string;
+    sizeBytes: number;
     error?: string;
 }
 interface SendEmailInput {
     to: string;
     subject: string;
-    /** Al menos uno de `html` o `body`. Con los dos se manda multipart. */
+    /** Al menos uno de `html`, `body` o `markdown`. Con html y body se manda multipart. HTML máx. 100 KB. */
     html?: string;
     body?: string;
+    markdown?: string;
     replyTo?: string;
     /**
      * Parte local de un alias **activo** del dominio. Sin esto el correo sale
@@ -141,6 +166,8 @@ interface SmtpCredentialCreated {
 interface ApiKey {
     id: string;
     name: string;
+    /** Primeros caracteres de la llave, para identificarla en listados. */
+    keyPrefix: string;
     lastUsedAt?: string;
     createdAt: string;
 }
@@ -174,7 +201,7 @@ declare class DomainsResource {
         ok: boolean;
     }>;
     health(id: string): Promise<Record<string, unknown>>;
-    verify(id: string): Promise<Record<string, unknown>>;
+    verify(id: string): Promise<DomainVerification>;
 }
 declare class AliasesResource {
     private req;
@@ -199,12 +226,16 @@ declare class RulesResource {
 declare class LogsResource {
     private req;
     constructor(req: Req);
-    list(domainId: string): Promise<EmailLog[]>;
+    /** `limit` por omisión 50, máximo 100. */
+    list(domainId: string, opts?: {
+        limit?: number;
+    }): Promise<EmailLog[]>;
 }
 declare class SendResource {
     private req;
     constructor(req: Req);
     send(domainId: string, input: SendEmailInput): Promise<{
+        ok: boolean;
         messageId: string;
     }>;
     bulkSend(domainId: string, input: BulkSendInput): Promise<BulkJobCreated>;
@@ -231,4 +262,4 @@ declare class ApiKeysResource {
     }>;
 }
 
-export { type Alias, type ApiKey, type BulkJob, type BulkJobCreated, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type Domain, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type Rule, type SendEmailInput, type SmtpCredential, type SmtpCredentialCreated, type UpdateAliasInput, type UpdateRuleInput };
+export { type Alias, type ApiKey, type BulkJob, type BulkJobCreated, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type Domain, type DomainVerification, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SmtpCredential, type SmtpCredentialCreated, type UpdateAliasInput, type UpdateRuleInput };

package/dist/index.js

@@ -97,8 +97,10 @@ var LogsResource = class {
   constructor(req) {
     this.req = req;
   }
-  list(domainId) {
-    return this.req(`/api/domains/${domainId}/logs`);
+  /** `limit` por omisión 50, máximo 100. */
+  list(domainId, opts) {
+    const qs = opts?.limit ? `?limit=${encodeURIComponent(opts.limit)}` : "";
+    return this.req(`/api/domains/${domainId}/logs${qs}`);
   }
 };
 var SendResource = class {

package/package.json

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