@easybits.cloud/mailmask 0.1.3 → 0.2.0

package/README.md

@@ -13,7 +13,7 @@ npm i @easybits.cloud/mailmask
 ```ts
 import { MailMask } from "@easybits.cloud/mailmask";
 
-const mm = new MailMask({ apiKey: "mm_live_..." });
+const mm = new MailMask({ apiKey: "mk_..." });
 
 // Get your domains
 const domains = await mm.domains.list();
@@ -21,13 +21,14 @@ const domainId = domains[0].id;
 
 // Create an alias — emails to hello@yourdomain.com forward to your inbox
 const alias = await mm.aliases.create(domainId, {
-  local: "hello",
+  alias: "hello",
   destinations: ["you@example.com"],
 });
 
 // Send an email (routed through MailMask for high deliverability)
 await mm.send.send(domainId, {
-  from: "hello",
+  from: "hello",              // must be an active alias; 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>",

package/dist/index.cjs

@@ -33,8 +33,8 @@ var MailMaskError = class extends Error {
     this.name = "MailMaskError";
   }
 };
-async function request(baseUrl, apiKey, path, opts) {
-  const res = await fetch(`${baseUrl}${path}`, {
+async function request(baseUrl, apiKey, path, opts, doFetch = fetch) {
+  const res = await doFetch(`${baseUrl}${path}`, {
     ...opts,
     headers: {
       "Authorization": `Bearer ${apiKey}`,
@@ -52,7 +52,8 @@ var MailMask = class {
   constructor(config) {
     this.apiKey = config.apiKey;
     this.baseUrl = (config.baseUrl || "https://www.mailmask.studio").replace(/\/$/, "");
-    const req = (path, opts) => request(this.baseUrl, this.apiKey, path, opts);
+    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);
     this.rules = new RulesResource(req);
@@ -90,16 +91,16 @@ var AliasesResource = class {
     this.req = req;
   }
   list(domainId) {
-    return this.req(`/api/domains/${domainId}/aliases`);
+    return this.req(`/api/domains/${domainId}/alias`);
   }
   create(domainId, input) {
-    return this.req(`/api/domains/${domainId}/aliases`, { method: "POST", body: JSON.stringify(input) });
+    return this.req(`/api/domains/${domainId}/alias`, { method: "POST", body: JSON.stringify(input) });
   }
   update(domainId, alias, input) {
-    return this.req(`/api/domains/${domainId}/aliases/${alias}`, { method: "PUT", body: JSON.stringify(input) });
+    return this.req(`/api/domains/${domainId}/alias/${alias}`, { method: "PUT", body: JSON.stringify(input) });
   }
   delete(domainId, alias) {
-    return this.req(`/api/domains/${domainId}/aliases/${alias}`, { method: "DELETE" });
+    return this.req(`/api/domains/${domainId}/alias/${alias}`, { method: "DELETE" });
   }
 };
 var RulesResource = class {
@@ -135,10 +136,10 @@ var SendResource = class {
     return this.req(`/api/domains/${domainId}/send`, { method: "POST", body: JSON.stringify(input) });
   }
   bulkSend(domainId, input) {
-    return this.req(`/api/domains/${domainId}/bulk-send`, { method: "POST", body: JSON.stringify(input) });
+    return this.req(`/api/domains/${domainId}/send-bulk`, { method: "POST", body: JSON.stringify(input) });
   }
   bulkStatus(domainId, jobId) {
-    return this.req(`/api/domains/${domainId}/bulk-send/${jobId}`);
+    return this.req(`/api/domains/${domainId}/bulk/${jobId}`);
   }
 };
 var SmtpResource = class {

package/dist/index.d.cts

@@ -1,6 +1,12 @@
 interface MailMaskConfig {
     apiKey: string;
     baseUrl?: string;
+    /**
+     * `fetch` alterno. Sirve para poner un timeout por llamada
+     * (`AbortSignal.timeout`), reintentos o un proxy, y para probar el SDK
+     * contra el servidor en proceso sin levantar un puerto.
+     */
+    fetch?: typeof fetch;
 }
 interface Domain {
     id: string;
@@ -18,8 +24,9 @@ interface Alias {
     createdAt: string;
 }
 interface CreateAliasInput {
-    local: string;
-    forwardTo: string | string[];
+    /** Parte local, sin el dominio: "hola" para hola@tudominio.com. `*` para catch-all. */
+    alias: string;
+    destinations: string[];
 }
 interface UpdateAliasInput {
     enabled?: boolean;
@@ -66,23 +73,49 @@ interface EmailLog {
     error?: string;
 }
 interface SendEmailInput {
-    fromLocal: string;
     to: string;
     subject: string;
-    html: string;
+    /** Al menos uno de `html` o `body`. Con los dos se manda multipart. */
+    html?: string;
+    body?: string;
+    replyTo?: string;
+    /**
+     * Parte local de un alias **activo** del dominio. Sin esto el correo sale
+     * desde `noreply@tudominio.com`.
+     */
+    from?: string;
+    /** Nombre visible del remitente: `Libretas <hola@tudominio.com>`. */
+    fromName?: string;
 }
 interface BulkSendInput {
-    from: string;
     recipients: string[];
     subject: string;
     html: string;
+    /** Alias activo del dominio; por omisión `noreply`. */
+    from?: string;
+}
+/** Lo que devuelve `bulkSend`: el job se encola, todavía no hay estado que leer. */
+interface BulkJobCreated {
+    ok: boolean;
+    jobId: string;
 }
 interface BulkJob {
     id: string;
+    domainId: string;
+    recipients: string[];
+    subject: string;
+    html: string;
+    from: string;
     status: string;
     totalRecipients: number;
     sent: number;
     failed: number;
+    /** Destinatarios saltados por bounce o queja previa: total = sent + failed + skippedSuppressed. */
+    skippedSuppressed: number;
+    lastError?: string | null;
+    createdAt: string;
+    completedAt?: string | null;
+    expiresAt: string;
 }
 interface SmtpCredential {
     id: string;
@@ -91,6 +124,20 @@ interface SmtpCredential {
     iamUsername: string;
     createdAt: string;
 }
+/**
+ * Lo que devuelve `smtp.create`. La contraseña se muestra **una sola vez**: no
+ * se puede volver a consultar, sólo revocar la credencial y crear otra.
+ */
+interface SmtpCredentialCreated {
+    id: string;
+    label: string;
+    server: string;
+    port: number;
+    encryption: string;
+    username: string;
+    password: string;
+    createdAt: string;
+}
 interface ApiKey {
     id: string;
     name: string;
@@ -160,16 +207,14 @@ declare class SendResource {
     send(domainId: string, input: SendEmailInput): Promise<{
         messageId: string;
     }>;
-    bulkSend(domainId: string, input: BulkSendInput): Promise<BulkJob>;
+    bulkSend(domainId: string, input: BulkSendInput): Promise<BulkJobCreated>;
     bulkStatus(domainId: string, jobId: string): Promise<BulkJob>;
 }
 declare class SmtpResource {
     private req;
     constructor(req: Req);
     list(domainId: string): Promise<SmtpCredential[]>;
-    create(domainId: string, label: string): Promise<SmtpCredential & {
-        smtpPassword: string;
-    }>;
+    create(domainId: string, label: string): Promise<SmtpCredentialCreated>;
     revoke(domainId: string, credId: string): Promise<{
         ok: boolean;
     }>;
@@ -186,4 +231,4 @@ declare class ApiKeysResource {
     }>;
 }
 
-export { type Alias, type ApiKey, type BulkJob, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type Domain, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type Rule, type SendEmailInput, type SmtpCredential, type UpdateAliasInput, type UpdateRuleInput };
+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 };

package/dist/index.d.ts

@@ -1,6 +1,12 @@
 interface MailMaskConfig {
     apiKey: string;
     baseUrl?: string;
+    /**
+     * `fetch` alterno. Sirve para poner un timeout por llamada
+     * (`AbortSignal.timeout`), reintentos o un proxy, y para probar el SDK
+     * contra el servidor en proceso sin levantar un puerto.
+     */
+    fetch?: typeof fetch;
 }
 interface Domain {
     id: string;
@@ -18,8 +24,9 @@ interface Alias {
     createdAt: string;
 }
 interface CreateAliasInput {
-    local: string;
-    forwardTo: string | string[];
+    /** Parte local, sin el dominio: "hola" para hola@tudominio.com. `*` para catch-all. */
+    alias: string;
+    destinations: string[];
 }
 interface UpdateAliasInput {
     enabled?: boolean;
@@ -66,23 +73,49 @@ interface EmailLog {
     error?: string;
 }
 interface SendEmailInput {
-    fromLocal: string;
     to: string;
     subject: string;
-    html: string;
+    /** Al menos uno de `html` o `body`. Con los dos se manda multipart. */
+    html?: string;
+    body?: string;
+    replyTo?: string;
+    /**
+     * Parte local de un alias **activo** del dominio. Sin esto el correo sale
+     * desde `noreply@tudominio.com`.
+     */
+    from?: string;
+    /** Nombre visible del remitente: `Libretas <hola@tudominio.com>`. */
+    fromName?: string;
 }
 interface BulkSendInput {
-    from: string;
     recipients: string[];
     subject: string;
     html: string;
+    /** Alias activo del dominio; por omisión `noreply`. */
+    from?: string;
+}
+/** Lo que devuelve `bulkSend`: el job se encola, todavía no hay estado que leer. */
+interface BulkJobCreated {
+    ok: boolean;
+    jobId: string;
 }
 interface BulkJob {
     id: string;
+    domainId: string;
+    recipients: string[];
+    subject: string;
+    html: string;
+    from: string;
     status: string;
     totalRecipients: number;
     sent: number;
     failed: number;
+    /** Destinatarios saltados por bounce o queja previa: total = sent + failed + skippedSuppressed. */
+    skippedSuppressed: number;
+    lastError?: string | null;
+    createdAt: string;
+    completedAt?: string | null;
+    expiresAt: string;
 }
 interface SmtpCredential {
     id: string;
@@ -91,6 +124,20 @@ interface SmtpCredential {
     iamUsername: string;
     createdAt: string;
 }
+/**
+ * Lo que devuelve `smtp.create`. La contraseña se muestra **una sola vez**: no
+ * se puede volver a consultar, sólo revocar la credencial y crear otra.
+ */
+interface SmtpCredentialCreated {
+    id: string;
+    label: string;
+    server: string;
+    port: number;
+    encryption: string;
+    username: string;
+    password: string;
+    createdAt: string;
+}
 interface ApiKey {
     id: string;
     name: string;
@@ -160,16 +207,14 @@ declare class SendResource {
     send(domainId: string, input: SendEmailInput): Promise<{
         messageId: string;
     }>;
-    bulkSend(domainId: string, input: BulkSendInput): Promise<BulkJob>;
+    bulkSend(domainId: string, input: BulkSendInput): Promise<BulkJobCreated>;
     bulkStatus(domainId: string, jobId: string): Promise<BulkJob>;
 }
 declare class SmtpResource {
     private req;
     constructor(req: Req);
     list(domainId: string): Promise<SmtpCredential[]>;
-    create(domainId: string, label: string): Promise<SmtpCredential & {
-        smtpPassword: string;
-    }>;
+    create(domainId: string, label: string): Promise<SmtpCredentialCreated>;
     revoke(domainId: string, credId: string): Promise<{
         ok: boolean;
     }>;
@@ -186,4 +231,4 @@ declare class ApiKeysResource {
     }>;
 }
 
-export { type Alias, type ApiKey, type BulkJob, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type Domain, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type Rule, type SendEmailInput, type SmtpCredential, type UpdateAliasInput, type UpdateRuleInput };
+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 };

package/dist/index.js

@@ -6,8 +6,8 @@ var MailMaskError = class extends Error {
     this.name = "MailMaskError";
   }
 };
-async function request(baseUrl, apiKey, path, opts) {
-  const res = await fetch(`${baseUrl}${path}`, {
+async function request(baseUrl, apiKey, path, opts, doFetch = fetch) {
+  const res = await doFetch(`${baseUrl}${path}`, {
     ...opts,
     headers: {
       "Authorization": `Bearer ${apiKey}`,
@@ -25,7 +25,8 @@ var MailMask = class {
   constructor(config) {
     this.apiKey = config.apiKey;
     this.baseUrl = (config.baseUrl || "https://www.mailmask.studio").replace(/\/$/, "");
-    const req = (path, opts) => request(this.baseUrl, this.apiKey, path, opts);
+    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);
     this.rules = new RulesResource(req);
@@ -63,16 +64,16 @@ var AliasesResource = class {
     this.req = req;
   }
   list(domainId) {
-    return this.req(`/api/domains/${domainId}/aliases`);
+    return this.req(`/api/domains/${domainId}/alias`);
   }
   create(domainId, input) {
-    return this.req(`/api/domains/${domainId}/aliases`, { method: "POST", body: JSON.stringify(input) });
+    return this.req(`/api/domains/${domainId}/alias`, { method: "POST", body: JSON.stringify(input) });
   }
   update(domainId, alias, input) {
-    return this.req(`/api/domains/${domainId}/aliases/${alias}`, { method: "PUT", body: JSON.stringify(input) });
+    return this.req(`/api/domains/${domainId}/alias/${alias}`, { method: "PUT", body: JSON.stringify(input) });
   }
   delete(domainId, alias) {
-    return this.req(`/api/domains/${domainId}/aliases/${alias}`, { method: "DELETE" });
+    return this.req(`/api/domains/${domainId}/alias/${alias}`, { method: "DELETE" });
   }
 };
 var RulesResource = class {
@@ -108,10 +109,10 @@ var SendResource = class {
     return this.req(`/api/domains/${domainId}/send`, { method: "POST", body: JSON.stringify(input) });
   }
   bulkSend(domainId, input) {
-    return this.req(`/api/domains/${domainId}/bulk-send`, { method: "POST", body: JSON.stringify(input) });
+    return this.req(`/api/domains/${domainId}/send-bulk`, { method: "POST", body: JSON.stringify(input) });
   }
   bulkStatus(domainId, jobId) {
-    return this.req(`/api/domains/${domainId}/bulk-send/${jobId}`);
+    return this.req(`/api/domains/${domainId}/bulk/${jobId}`);
   }
 };
 var SmtpResource = class {

package/package.json

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