mailisk 2.0.1 → 2.2.1

package/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Build and Test
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    name: Test
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js 18.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Run tests
+        run: npm test

package/README.md

@@ -1,10 +1,11 @@
 # Mailisk Node Client
 
-Mailisk is an end-to-end email testing platform. It allows you to receive emails with code and automate email tests.
+Mailisk is an end-to-end email and SMS testing platform. It allows you to receive emails and SMS messages with code to automate tests.
 
 - Get a unique subdomain and unlimited email addresses for free.
 - Easily automate E2E password reset and account verification by catching emails.
-- Virtual SMTP support to test outbound email without 3rd party clients.
+- Receive SMS messages and automate SMS tests.
+- Virtual SMTP and SMS support to test without 3rd party clients.
 
 ## Get started
 
@@ -35,7 +36,7 @@ const { MailiskClient } = require("mailisk");
 const mailisk = new MailiskClient({ apiKey: "YOUR_API_KEY" });
 
 // send email (using virtual SMTP)
-await client.sendVirtualEmail(namespace, {
+await mailisk.sendVirtualEmail(namespace, {
   from: "test@example.com",
   to: `john@${namespace}.mailisk.net`,
   subject: "Testing",
@@ -43,7 +44,7 @@ await client.sendVirtualEmail(namespace, {
 });
 
 // receive email
-const result = await client.searchInbox(namespace);
+const result = await mailisk.searchInbox(namespace);
 
 console.log(result);
 ```
@@ -52,37 +53,44 @@ console.log(result);
 
 This library wraps the REST API endpoints. Find out more in the [API Reference](https://docs.mailisk.com/api-reference/).
 
-## Client functions
+## Client functions (Email)
+
+### `searchInbox(namespace, params?, requestOptions?)`
+
+Use `searchInbox` to fetch messages that arrived in a given namespace, optionally waiting until the first new mail shows up.
 
-### searchInbox(namespace, params?)
+For the full parameter options see the [endpoint reference](https://docs.mailisk.com/api-reference/search-inbox.html#request-1).
 
-The `searchInbox` function takes a namespace and call parameters.
+Default behaviour:
 
-- By default it uses the `wait` flag. This means the call won't return until at least one email is received. Disabling this flag via `wait: false` can cause it to return an empty response immediately.
-- The request timeout is adjustable by passing `timeout` in the request options. By default it uses a timeout of 5 minutes.
-- By default `from_timestamp` is set to **current timestamp - 5 seconds**. This ensures that only new emails are returned. Without this, older emails would also be returned, potentially disrupting you if you were waiting for a specific email. This can be overriden by passing the `from_timestamp` parameter (`from_timestmap: 0` will disable filtering by email age).
+- Waits until at least one new email arrives (override with `wait: false`).
+- Times out after 5 minutes if nothing shows up (adjust via `requestOptions.timeout`).
+- Ignores messages older than 15 minutes to avoid picking up leftovers from previous tests (change via `from_timestamp`).
+
+#### Quick examples
 
 ```js
-// timeout of 5 minutes
+// wait up to the default 5 min for *any* new mail
 await mailisk.searchInbox(namespace);
-// timeout of 1 minute
+// custom 60-second timeout
 await mailisk.searchInbox(namespace, {}, { timeout: 1000 * 60 });
-// returns immediately, even if the result would be empty
+// polling pattern — return immediately, even if inbox is empty
 await mailisk.searchInbox(namespace, { wait: false });
+// returns the last 20 emails in the namespace immediately
+await mailisk.searchInbox(namespace, { wait: false, from_timestamp: 0, limit: 20 });
 ```
 
 #### Filter by destination address
 
-A common use case is filtering the returned emails by the destination address, this is done using the `to_addr_prefix` parameter.
+A common pattern is to wait for the email your UI just triggered (e.g. password-reset).
+Pass `to_addr_prefix` so you don’t pick up stale messages:
 
 ```js
 const { data: emails } = await mailisk.searchInbox(namespace, {
-  to_addr_prefix: "john@mynamespace.mailisk.net",
+  to_addr_prefix: `john@${namespace}.mailisk.net`,
 });
 ```
 
-For more parameter options see the [endpoint reference](https://docs.mailisk.com/api-reference/search-inbox.html#request-1).
-
 ### sendVirtualEmail(namespace, params)
 
 Send an email using [Virtual SMTP](https://docs.mailisk.com/smtp.html). This will fetch the SMTP settings for the selected namespace and send an email. These emails can only be sent to an address that ends in `@{namespace}.mailisk.net`.
@@ -98,15 +106,107 @@ await mailisk.sendVirtualEmail(namespace, {
 });
 ```
 
-This does not call an API endpoint but rather uses nodemailer to send an email using SMTP.
-
-### listNamespaces()
+### `listNamespaces()`
 
 List all namespaces associated with the current API Key.
 
 ```js
-const namespacesResponse = await mailisk.listNamespaces();
+const { data: namespaces } = await mailisk.listNamespaces();
 
 // will be ['namespace1', 'namespace2']
-const namespaces = namespacesResponse.map((nr) => nr.namespace);
+const namespacesList = namespaces.map((nr) => nr.namespace);
+```
+
+### `getAttachment(attachmentId)`
+
+Get information about an attachment.
+
+```ts
+const attachment = await mailisk.getAttachment(attachmentId);
+```
+
+### `downloadAttachment(attachmentId)`
+
+Retrieve the raw bytes of a file attached to an email message.  
+Typically you call this after `searchInbox` → iterate over `email.attachments[]` → pass the desired `attachment.id`.
+
+#### Quick examples
+
+```js
+import fs from "node:fs";
+import path from "node:path";
+
+// assume 'email' was fetched via searchInbox()
+const { id, filename } = email.attachments[0];
+
+// download the attachment
+const buffer = await mailisk.downloadAttachment(id);
+
+// save to disk (preserve original filename)
+fs.writeFileSync(filename, buffer);
+```
+
+Streaming large files
+
+downloadAttachment returns the entire file as a single Buffer.
+If you expect very large attachments and want to avoid holding them fully in memory, use getAttachment(attachmentId).download_url and stream with fetch / axios instead:
+
+```js
+const meta = await mailisk.getAttachment(id);
+const res = await fetch(meta.download_url);
+const fileStream = fs.createWriteStream(filename);
+await new Promise((ok, err) => res.body.pipe(fileStream).on("finish", ok).on("error", err));
+```
+
+## Client functions (SMS)
+
+### `searchSmsMessages(phoneNumber, params?, requestOptions?)`
+
+Fetch recent SMS messages that were delivered to one of your Mailisk phone numbers.  
+For the full parameter list see the [Search SMS reference](https://docs.mailisk.com/api-reference/search-sms-messages.html#request).
+
+Default behaviour:
+
+- Waits until at least one SMS matches the filters (override with `wait: false`).
+- Times out after 5 minutes if nothing shows up (adjust via `requestOptions.timeout`).
+- Ignores messages older than 15 minutes (change via `from_date`).
+
+#### Quick examples
+
+```js
+// get or wait for SMS messages sent to ths number
+const { data: sms } = await mailisk.searchSmsMessages(phoneNumber);
+
+// look for a verification code coming from a known sender
+await mailisk.searchSmsMessages(phoneNumber, {
+  from_number: "+1800555",
+  body: "Your code",
+});
+
+// polling pattern — return immediately even if nothing matched
+await mailisk.searchSmsMessages(
+  phoneNumber,
+  { wait: false, limit: 10, from_date: new Date(Date.now() - 1000 * 60 * 5).toISOString() },
+  { timeout: 10_000 }
+);
+```
+
+### `listSmsNumbers()`
+
+List all SMS phone numbers associated with the current account.
+
+```js
+const { data: phoneNumbers } = await mailisk.listSmsNumbers();
+```
+
+### `sendVirtualSms(params)`
+
+Send a virtual SMS message to a phone number you have access to.
+
+```js
+await mailisk.sendVirtualSms({
+  from_number: "15551234567",
+  to_number: "15557654321",
+  body: "Test message",
+});
 ```

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { AxiosRequestConfig } from 'axios';
+import { AxiosBasicCredentials, AxiosRequestConfig } from 'axios';
+import { Attachment } from 'nodemailer/lib/mailer';
 
 interface EmailAddress {
     /** Email address */
@@ -6,6 +7,16 @@ interface EmailAddress {
     /** Display name, if one is specified */
     name?: string;
 }
+interface EmailAttachment {
+    /** Unique identifier for the attachment */
+    id: string;
+    /** Filename of the attachment */
+    filename: string;
+    /** Content type of the attachment */
+    content_type: string;
+    /** Size in bytes of the attachment */
+    size: number;
+}
 interface Email {
     /** Namespace scoped ID */
     id: string;
@@ -31,6 +42,44 @@ interface Email {
     expires_timestamp: number;
     /** The spam score as reported by SpamAssassin */
     spam_score?: number;
+    /** The headers of the email */
+    headers?: Record<string, string>;
+    /** The attachments of the email */
+    attachments?: EmailAttachment[];
+}
+interface SmsMessage {
+    /** Unique identifier for the message */
+    id: string;
+    /** Unique identifier for the SMS phone number */
+    sms_phone_number_id: string;
+    /** Body of the message */
+    body: string;
+    /** From number of the message */
+    from_number: string;
+    /** To number of the message */
+    to_number: string;
+    /** Provider message ID */
+    provider_message_id?: string;
+    /** Date and time the message was created */
+    created_at: string;
+    /** Direction of the message */
+    direction: "inbound" | "outbound";
+}
+interface SmsNumber {
+    /** Unique identifier for the SMS number */
+    id: string;
+    /** Unique identifier for the organisation */
+    organisation_id: string;
+    /** Status of the SMS number */
+    status: "requested" | "active" | "disabled";
+    /** Country of the SMS number */
+    country: string;
+    /** SMS Phone number */
+    phone_number?: string;
+    /** Date and time the SMS number was created */
+    created_at: string;
+    /** Date and time the SMS number was updated */
+    updated_at: string;
 }
 interface SearchInboxParams {
     /**
@@ -96,13 +145,22 @@ interface SmtpSettings {
         password: string;
     };
 }
+interface GetAttachmentResponse {
+    data: {
+        id: string;
+        filename: string;
+        content_type: string;
+        size: number;
+        expires_at: string | null;
+        download_url: string;
+    };
+}
 interface ListNamespacesResponse {
-    data: [
-        {
-            id: string;
-            namespace: string;
-        }
-    ];
+    total_count: number;
+    data: {
+        id: string;
+        namespace: string;
+    }[];
 }
 interface SendVirtualEmailParams {
     /** Sender of email */
@@ -119,14 +177,89 @@ interface SendVirtualEmailParams {
     text?: string | undefined;
     /** The HTML version of the message */
     html?: string | undefined;
+    /** Custom headers for the email */
+    headers?: Record<string, string>;
+    /** Attachments to the email */
+    attachments?: Attachment[];
+}
+interface SearchSmsMessagesParams {
+    /**
+     * The maximum number of SMS messages returned (1-100), used alongside `offset` for pagination.
+     */
+    limit?: number;
+    /**
+     * The number of SMS messages to skip/ignore, used alongside `limit` for pagination.
+     */
+    offset?: number;
+    /**
+     * Filter messages by body contents (case insensitive).
+     */
+    body?: string;
+    /**
+     * Filter messages by sender phone number prefix.
+     */
+    from_number?: string;
+    /**
+     * Filter messages created on or after this date.
+     * Provide an ISO 8601 timestamp string.
+     */
+    from_date?: string;
+    /**
+     * Filter messages created on or before this date.
+     * Provide an ISO 8601 timestamp string.
+     */
+    to_date?: string;
+    /**
+     * When true, keep the request open until at least one SMS is returned.
+     */
+    wait?: boolean;
+}
+interface SearchSmsMessagesResponse {
+    total_count: number;
+    options: SearchSmsMessagesParams;
+    data: SmsMessage[];
+}
+interface ListSmsNumbersResponse {
+    total_count: number;
+    data: SmsNumber[];
+}
+interface SendVirtualSmsParams {
+    /** The phone number to send the SMS from */
+    from_number: string;
+    /** The phone number to send the SMS to */
+    to_number: string;
+    /** The body of the SMS message */
+    body: string;
 }
 
 declare class MailiskClient {
-    constructor({ apiKey, baseUrl }: {
+    constructor({ apiKey, baseUrl, auth }: {
         apiKey: string;
         baseUrl?: string;
+        auth?: AxiosBasicCredentials;
     });
     private readonly axiosInstance;
+    /**
+     * Search SMS messages sent to a phone number.
+     *
+     * @example
+     * Search for SMS messages sent to a phone number
+     * ```typescript
+     * const { data: smsMessages } = await client.searchSmsMessages("1234567890");
+     * ```
+     */
+    searchSmsMessages(phoneNumber: string, params?: SearchSmsMessagesParams, config?: AxiosRequestConfig): Promise<SearchSmsMessagesResponse>;
+    /**
+     * List all SMS phone numbers associated with the current account.
+     *
+     * @example
+     * List all SMS phone numbers
+     * ```typescript
+     * const { data: smsNumbers } = await client.listSmsNumbers();
+     * ```
+     */
+    listSmsNumbers(): Promise<ListSmsNumbersResponse>;
+    sendVirtualSms(params: SendVirtualSmsParams): Promise<void>;
     /**
      * List all namespaces that belong to the current account (API key).
      */
@@ -152,12 +285,12 @@ declare class MailiskClient {
      * Search inbox of a namespace.
      *
      * By default, this calls the api using the `wait` flag. This means the call won't timeout until at least one email is received or 5 minutes pass.
-     * It also uses a default `from_timestamp` of **current timestamp - 5 seconds**. This means that older emails will be ignored.
+     * It also uses a default `from_timestamp` of **current timestamp - 15 minutes**. This means that older emails will be ignored.
      *
      * Both of these settings can be overriden by passing them in the `params` object.
      *
      * @example
-     * Get the latest emails in the namespace
+     * Get the latest emails
      * ```typescript
      * const { data: emails } = await client.searchInbox(namespace);
      * ```
@@ -166,7 +299,17 @@ declare class MailiskClient {
      * Get the latest emails for a specific email address
      * ```typescript
      * const { data: emails } = await client.searchInbox(namespace, {
-     *  to_addr_prefix: 'john@mynamespace.mailisk.net'
+     *   to_addr_prefix: 'john@mynamespace.mailisk.net'
+     * });
+     * ```
+     *
+     * @example
+     * Get the last 20 emails in the namespace
+     * ```typescript
+     * const { data: emails } = await mailisk.searchInbox(namespace, {
+     *   wait: false,
+     *   from_timestamp: 0,
+     *   limit: 20
      * });
      * ```
      */
@@ -175,6 +318,21 @@ declare class MailiskClient {
      * Get the SMTP settings for a namespace.
      */
     getSmtpSettings(namespace: string): Promise<SmtpSettings>;
+    getAttachment(attachmentId: string): Promise<GetAttachmentResponse>;
+    /**
+     * Download an attachment from an attachment ID.
+     *
+     * @example
+     * Download an attachment from an email
+     * ```typescript
+     * const attachment = email.attachments[0];
+     * const attachmentBuffer = await client.downloadAttachment(attachment.id);
+     *
+     * // save to file
+     * fs.writeFileSync(attachment.filename, attachmentBuffer);
+     * ```
+     */
+    downloadAttachment(attachmentId: string): Promise<Buffer>;
 }
 
 export { MailiskClient };

package/dist/index.js

@@ -35,15 +35,47 @@ module.exports = __toCommonJS(src_exports);
 var import_axios = __toESM(require("axios"));
 var import_nodemailer = __toESM(require("nodemailer"));
 var MailiskClient = class {
-  constructor({ apiKey, baseUrl }) {
+  constructor({ apiKey, baseUrl, auth }) {
     this.axiosInstance = import_axios.default.create({
       headers: {
         "X-Api-Key": apiKey
       },
-      baseURL: baseUrl || "https://api.mailisk.com/"
+      baseURL: baseUrl || "https://api.mailisk.com/",
+      auth
     });
   }
   axiosInstance;
+  async searchSmsMessages(phoneNumber, params, config) {
+    let _params = { ...params };
+    if (params?.from_date === void 0 || params?.from_date === null) {
+      _params.from_date = new Date(Date.now() - 15 * 60 * 1e3).toISOString();
+    }
+    if (params?.wait !== false) {
+      _params.wait = true;
+    }
+    let _config = { ...config };
+    if (config?.maxRedirects === void 0) {
+      _config.maxRedirects = 99999;
+    }
+    if (_params.wait && config?.timeout === void 0) {
+      _config.timeout = 1e3 * 60 * 5;
+    }
+    const requestParams = {
+      ..._params,
+      from_date: _params.from_date ?? void 0,
+      to_date: _params.to_date ?? void 0
+    };
+    return (await this.axiosInstance.get(`api/sms/${phoneNumber}/messages`, {
+      ..._config,
+      params: requestParams
+    })).data;
+  }
+  async listSmsNumbers() {
+    return (await this.axiosInstance.get("api/sms/numbers")).data;
+  }
+  async sendVirtualSms(params) {
+    return (await this.axiosInstance.post("api/sms/virtual", params)).data;
+  }
   async listNamespaces() {
     return (await this.axiosInstance.get("api/namespaces")).data;
   }
@@ -58,13 +90,15 @@ var MailiskClient = class {
         pass: smtpSettings.data.password
       }
     });
-    const { from, to, subject, text, html } = params;
+    const { from, to, subject, text, html, headers, attachments } = params;
     await transport.sendMail({
       from,
       to,
       subject,
       text,
-      html
+      html,
+      headers,
+      attachments
     });
     transport.close();
   }
@@ -77,10 +111,10 @@ var MailiskClient = class {
       _params.wait = true;
     }
     let _config = { ...config };
-    if (!config?.maxRedirects) {
+    if (config?.maxRedirects === void 0) {
       _config.maxRedirects = 99999;
     }
-    if (_params.wait && !config?.timeout) {
+    if (_params.wait && config?.timeout === void 0) {
       _config.timeout = 1e3 * 60 * 5;
     }
     return (await this.axiosInstance.get(`api/emails/${namespace}/inbox`, {
@@ -92,6 +126,15 @@ var MailiskClient = class {
     const result = await this.axiosInstance.get(`api/smtp/${namespace}`);
     return result.data;
   }
+  async getAttachment(attachmentId) {
+    const result = await this.axiosInstance.get(`api/attachments/${attachmentId}`);
+    return result.data;
+  }
+  async downloadAttachment(attachmentId) {
+    const result = await this.getAttachment(attachmentId);
+    const response = await import_axios.default.get(result.data.download_url, { responseType: "arraybuffer" });
+    return Buffer.from(response.data);
+  }
 };
 __name(MailiskClient, "MailiskClient");
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/mailisk.ts"],"sourcesContent":["export * from \"./mailisk\";\n","import axios, { AxiosRequestConfig } from \"axios\";\nimport {\n  ListNamespacesResponse,\n  SearchInboxParams,\n  SearchInboxResponse,\n  SendVirtualEmailParams,\n  SmtpSettings,\n} from \"./mailisk.interfaces\";\nimport nodemailer from \"nodemailer\";\n\nexport class MailiskClient {\n  constructor({ apiKey, baseUrl }: { apiKey: string; baseUrl?: string }) {\n    this.axiosInstance = axios.create({\n      headers: {\n        \"X-Api-Key\": apiKey,\n      },\n      baseURL: baseUrl || \"https://api.mailisk.com/\",\n    });\n  }\n\n  private readonly axiosInstance;\n\n  /**\n   * List all namespaces that belong to the current account (API key).\n   */\n  async listNamespaces(): Promise<ListNamespacesResponse> {\n    return (await this.axiosInstance.get(\"api/namespaces\")).data;\n  }\n\n  /**\n   * Send an email using the Virtual SMTP.\n   *\n   * These emails can only be sent to valid Mailisk namespaces, i.e. emails that end in @mynamespace.mailisk.net\n   *\n   * @example\n   * For example, sending a test email:\n   * ```typescript\n   * client.sendVirtualEmail(namespace, {\n   *   from: \"test@example.com\",\n   *   to: `john@${namespace}.mailisk.net`,\n   *   subject: \"This is a test\",\n   *   text: \"Testing\",\n   * });\n   * ```\n   */\n  async sendVirtualEmail(namespace: string, params: SendVirtualEmailParams): Promise<void> {\n    const smtpSettings = await this.getSmtpSettings(namespace);\n\n    // TODO: to should match namespace\n\n    const transport = nodemailer.createTransport({\n      host: smtpSettings.data.host,\n      port: smtpSettings.data.port,\n      secure: false,\n      auth: {\n        user: smtpSettings.data.username,\n        pass: smtpSettings.data.password,\n      },\n    });\n\n    const { from, to, subject, text, html } = params;\n\n    await transport.sendMail({\n      from,\n      to,\n      subject,\n      text,\n      html,\n    });\n\n    transport.close();\n  }\n\n  /**\n   * Search inbox of a namespace.\n   *\n   * By default, this calls the api using the `wait` flag. This means the call won't timeout until at least one email is received or 5 minutes pass.\n   * It also uses a default `from_timestamp` of **current timestamp - 5 seconds**. This means that older emails will be ignored.\n   *\n   * Both of these settings can be overriden by passing them in the `params` object.\n   *\n   * @example\n   * Get the latest emails in the namespace\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace);\n   * ```\n   *\n   * @example\n   * Get the latest emails for a specific email address\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace, {\n   *  to_addr_prefix: 'john@mynamespace.mailisk.net'\n   * });\n   * ```\n   */\n  async searchInbox(\n    namespace: string,\n    params?: SearchInboxParams,\n    config?: AxiosRequestConfig\n  ): Promise<SearchInboxResponse> {\n    let _params = { ...params };\n\n    // default from timestamp, 15 minutes before starting this request\n    if (params?.from_timestamp === undefined || params?.from_timestamp === null) {\n      _params.from_timestamp = Math.floor(new Date().getTime() / 1000) - 15 * 60;\n    }\n\n    // by default wait for email\n    if (params?.wait !== false) {\n      _params.wait = true;\n    }\n\n    let _config = { ...config };\n\n    if (!config?.maxRedirects) {\n      _config.maxRedirects = 99999;\n    }\n\n    // by default, wait 5 minutes for emails before timing out\n    if (_params.wait && !config?.timeout) {\n      _config.timeout = 1000 * 60 * 5;\n    }\n\n    return (\n      await this.axiosInstance.get(`api/emails/${namespace}/inbox`, {\n        ..._config,\n        params: _params,\n      })\n    ).data;\n  }\n\n  /**\n   * Get the SMTP settings for a namespace.\n   */\n  async getSmtpSettings(namespace: string): Promise<SmtpSettings> {\n    const result = await this.axiosInstance.get(`api/smtp/${namespace}`);\n    return result.data;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAA0C;AAQ1C,wBAAuB;AAEhB,IAAM,gBAAN,MAAoB;AAAA,EACzB,YAAY,EAAE,QAAQ,QAAQ,GAAyC;AACrE,SAAK,gBAAgB,aAAAA,QAAM,OAAO;AAAA,MAChC,SAAS;AAAA,QACP,aAAa;AAAA,MACf;AAAA,MACA,SAAS,WAAW;AAAA,IACtB,CAAC;AAAA,EACH;AAAA,EAEiB;AAAA,EAKjB,MAAM,iBAAkD;AACtD,YAAQ,MAAM,KAAK,cAAc,IAAI,gBAAgB,GAAG;AAAA,EAC1D;AAAA,EAkBA,MAAM,iBAAiB,WAAmB,QAA+C;AACvF,UAAM,eAAe,MAAM,KAAK,gBAAgB,SAAS;AAIzD,UAAM,YAAY,kBAAAC,QAAW,gBAAgB;AAAA,MAC3C,MAAM,aAAa,KAAK;AAAA,MACxB,MAAM,aAAa,KAAK;AAAA,MACxB,QAAQ;AAAA,MACR,MAAM;AAAA,QACJ,MAAM,aAAa,KAAK;AAAA,QACxB,MAAM,aAAa,KAAK;AAAA,MAC1B;AAAA,IACF,CAAC;AAED,UAAM,EAAE,MAAM,IAAI,SAAS,MAAM,KAAK,IAAI;AAE1C,UAAM,UAAU,SAAS;AAAA,MACvB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,cAAU,MAAM;AAAA,EAClB;AAAA,EAwBA,MAAM,YACJ,WACA,QACA,QAC8B;AAC9B,QAAI,UAAU,EAAE,GAAG,OAAO;AAG1B,QAAI,QAAQ,mBAAmB,UAAa,QAAQ,mBAAmB,MAAM;AAC3E,cAAQ,iBAAiB,KAAK,MAAM,IAAI,KAAK,EAAE,QAAQ,IAAI,GAAI,IAAI,KAAK;AAAA,IAC1E;AAGA,QAAI,QAAQ,SAAS,OAAO;AAC1B,cAAQ,OAAO;AAAA,IACjB;AAEA,QAAI,UAAU,EAAE,GAAG,OAAO;AAE1B,QAAI,CAAC,QAAQ,cAAc;AACzB,cAAQ,eAAe;AAAA,IACzB;AAGA,QAAI,QAAQ,QAAQ,CAAC,QAAQ,SAAS;AACpC,cAAQ,UAAU,MAAO,KAAK;AAAA,IAChC;AAEA,YACE,MAAM,KAAK,cAAc,IAAI,cAAc,mBAAmB;AAAA,MAC5D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA,EAKA,MAAM,gBAAgB,WAA0C;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,YAAY,WAAW;AACnE,WAAO,OAAO;AAAA,EAChB;AACF;AAhIa;","names":["axios","nodemailer"]}
+{"version":3,"sources":["../src/index.ts","../src/mailisk.ts"],"sourcesContent":["export * from \"./mailisk\";\n","import axios, { AxiosBasicCredentials, AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport {\n  GetAttachmentResponse,\n  ListNamespacesResponse,\n  ListSmsNumbersResponse,\n  SearchInboxParams,\n  SearchInboxResponse,\n  SearchSmsMessagesParams,\n  SearchSmsMessagesResponse,\n  SendVirtualEmailParams,\n  SendVirtualSmsParams,\n  SmtpSettings,\n} from \"./mailisk.interfaces\";\nimport nodemailer from \"nodemailer\";\n\nexport class MailiskClient {\n  constructor({ apiKey, baseUrl, auth }: { apiKey: string; baseUrl?: string; auth?: AxiosBasicCredentials }) {\n    this.axiosInstance = axios.create({\n      headers: {\n        \"X-Api-Key\": apiKey,\n      },\n      baseURL: baseUrl || \"https://api.mailisk.com/\",\n      auth,\n    });\n  }\n\n  private readonly axiosInstance: AxiosInstance;\n\n  /**\n   * Search SMS messages sent to a phone number.\n   *\n   * @example\n   * Search for SMS messages sent to a phone number\n   * ```typescript\n   * const { data: smsMessages } = await client.searchSmsMessages(\"1234567890\");\n   * ```\n   */\n  async searchSmsMessages(\n    phoneNumber: string,\n    params?: SearchSmsMessagesParams,\n    config?: AxiosRequestConfig\n  ): Promise<SearchSmsMessagesResponse> {\n    let _params: SearchSmsMessagesParams = { ...params };\n\n    // default from timestamp, 15 minutes before starting this request\n    if (params?.from_date === undefined || params?.from_date === null) {\n      _params.from_date = new Date(Date.now() - 15 * 60 * 1000).toISOString();\n    }\n\n    // by default wait for sms\n    if (params?.wait !== false) {\n      _params.wait = true;\n    }\n\n    let _config = { ...config };\n\n    if (config?.maxRedirects === undefined) {\n      _config.maxRedirects = 99999;\n    }\n\n    // by default, wait 5 minutes for emails before timing out\n    if (_params.wait && config?.timeout === undefined) {\n      _config.timeout = 1000 * 60 * 5;\n    }\n\n    const requestParams = {\n      ..._params,\n      from_date: _params.from_date ?? undefined,\n      to_date: _params.to_date ?? undefined,\n    };\n\n    return (\n      await this.axiosInstance.get(`api/sms/${phoneNumber}/messages`, {\n        ..._config,\n        params: requestParams,\n      })\n    ).data;\n  }\n\n  /**\n   * List all SMS phone numbers associated with the current account.\n   *\n   * @example\n   * List all SMS phone numbers\n   * ```typescript\n   * const { data: smsNumbers } = await client.listSmsNumbers();\n   * ```\n   */\n  async listSmsNumbers(): Promise<ListSmsNumbersResponse> {\n    return (await this.axiosInstance.get(\"api/sms/numbers\")).data;\n  }\n\n  async sendVirtualSms(params: SendVirtualSmsParams): Promise<void> {\n    return (await this.axiosInstance.post(\"api/sms/virtual\", params)).data;\n  }\n\n  /**\n   * List all namespaces that belong to the current account (API key).\n   */\n  async listNamespaces(): Promise<ListNamespacesResponse> {\n    return (await this.axiosInstance.get(\"api/namespaces\")).data;\n  }\n\n  /**\n   * Send an email using the Virtual SMTP.\n   *\n   * These emails can only be sent to valid Mailisk namespaces, i.e. emails that end in @mynamespace.mailisk.net\n   *\n   * @example\n   * For example, sending a test email:\n   * ```typescript\n   * client.sendVirtualEmail(namespace, {\n   *   from: \"test@example.com\",\n   *   to: `john@${namespace}.mailisk.net`,\n   *   subject: \"This is a test\",\n   *   text: \"Testing\",\n   * });\n   * ```\n   */\n  async sendVirtualEmail(namespace: string, params: SendVirtualEmailParams): Promise<void> {\n    const smtpSettings = await this.getSmtpSettings(namespace);\n\n    const transport = nodemailer.createTransport({\n      host: smtpSettings.data.host,\n      port: smtpSettings.data.port,\n      secure: false,\n      auth: {\n        user: smtpSettings.data.username,\n        pass: smtpSettings.data.password,\n      },\n    });\n\n    const { from, to, subject, text, html, headers, attachments } = params;\n\n    await transport.sendMail({\n      from,\n      to,\n      subject,\n      text,\n      html,\n      headers,\n      attachments,\n    });\n\n    transport.close();\n  }\n\n  /**\n   * Search inbox of a namespace.\n   *\n   * By default, this calls the api using the `wait` flag. This means the call won't timeout until at least one email is received or 5 minutes pass.\n   * It also uses a default `from_timestamp` of **current timestamp - 15 minutes**. This means that older emails will be ignored.\n   *\n   * Both of these settings can be overriden by passing them in the `params` object.\n   *\n   * @example\n   * Get the latest emails\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace);\n   * ```\n   *\n   * @example\n   * Get the latest emails for a specific email address\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace, {\n   *   to_addr_prefix: 'john@mynamespace.mailisk.net'\n   * });\n   * ```\n   *\n   * @example\n   * Get the last 20 emails in the namespace\n   * ```typescript\n   * const { data: emails } = await mailisk.searchInbox(namespace, {\n   *   wait: false,\n   *   from_timestamp: 0,\n   *   limit: 20\n   * });\n   * ```\n   */\n  async searchInbox(\n    namespace: string,\n    params?: SearchInboxParams,\n    config?: AxiosRequestConfig\n  ): Promise<SearchInboxResponse> {\n    let _params = { ...params };\n\n    // default from timestamp, 15 minutes before starting this request\n    if (params?.from_timestamp === undefined || params?.from_timestamp === null) {\n      _params.from_timestamp = Math.floor(new Date().getTime() / 1000) - 15 * 60;\n    }\n\n    // by default wait for email\n    if (params?.wait !== false) {\n      _params.wait = true;\n    }\n\n    let _config = { ...config };\n\n    if (config?.maxRedirects === undefined) {\n      _config.maxRedirects = 99999;\n    }\n\n    // by default, wait 5 minutes for emails before timing out\n    if (_params.wait && config?.timeout === undefined) {\n      _config.timeout = 1000 * 60 * 5;\n    }\n\n    return (\n      await this.axiosInstance.get(`api/emails/${namespace}/inbox`, {\n        ..._config,\n        params: _params,\n      })\n    ).data;\n  }\n\n  /**\n   * Get the SMTP settings for a namespace.\n   */\n  async getSmtpSettings(namespace: string): Promise<SmtpSettings> {\n    const result = await this.axiosInstance.get(`api/smtp/${namespace}`);\n    return result.data;\n  }\n\n  async getAttachment(attachmentId: string): Promise<GetAttachmentResponse> {\n    const result = await this.axiosInstance.get(`api/attachments/${attachmentId}`);\n    return result.data;\n  }\n\n  /**\n   * Download an attachment from an attachment ID.\n   *\n   * @example\n   * Download an attachment from an email\n   * ```typescript\n   * const attachment = email.attachments[0];\n   * const attachmentBuffer = await client.downloadAttachment(attachment.id);\n   *\n   * // save to file\n   * fs.writeFileSync(attachment.filename, attachmentBuffer);\n   * ```\n   */\n  async downloadAttachment(attachmentId: string): Promise<Buffer> {\n    const result = await this.getAttachment(attachmentId);\n\n    const response = await axios.get(result.data.download_url, { responseType: \"arraybuffer\" });\n    return Buffer.from(response.data);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAgF;AAahF,wBAAuB;AAEhB,IAAM,gBAAN,MAAoB;AAAA,EACzB,YAAY,EAAE,QAAQ,SAAS,KAAK,GAAuE;AACzG,SAAK,gBAAgB,aAAAA,QAAM,OAAO;AAAA,MAChC,SAAS;AAAA,QACP,aAAa;AAAA,MACf;AAAA,MACA,SAAS,WAAW;AAAA,MACpB;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEiB;AAAA,EAWjB,MAAM,kBACJ,aACA,QACA,QACoC;AACpC,QAAI,UAAmC,EAAE,GAAG,OAAO;AAGnD,QAAI,QAAQ,cAAc,UAAa,QAAQ,cAAc,MAAM;AACjE,cAAQ,YAAY,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,GAAI,EAAE,YAAY;AAAA,IACxE;AAGA,QAAI,QAAQ,SAAS,OAAO;AAC1B,cAAQ,OAAO;AAAA,IACjB;AAEA,QAAI,UAAU,EAAE,GAAG,OAAO;AAE1B,QAAI,QAAQ,iBAAiB,QAAW;AACtC,cAAQ,eAAe;AAAA,IACzB;AAGA,QAAI,QAAQ,QAAQ,QAAQ,YAAY,QAAW;AACjD,cAAQ,UAAU,MAAO,KAAK;AAAA,IAChC;AAEA,UAAM,gBAAgB;AAAA,MACpB,GAAG;AAAA,MACH,WAAW,QAAQ,aAAa;AAAA,MAChC,SAAS,QAAQ,WAAW;AAAA,IAC9B;AAEA,YACE,MAAM,KAAK,cAAc,IAAI,WAAW,wBAAwB;AAAA,MAC9D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA,EAWA,MAAM,iBAAkD;AACtD,YAAQ,MAAM,KAAK,cAAc,IAAI,iBAAiB,GAAG;AAAA,EAC3D;AAAA,EAEA,MAAM,eAAe,QAA6C;AAChE,YAAQ,MAAM,KAAK,cAAc,KAAK,mBAAmB,MAAM,GAAG;AAAA,EACpE;AAAA,EAKA,MAAM,iBAAkD;AACtD,YAAQ,MAAM,KAAK,cAAc,IAAI,gBAAgB,GAAG;AAAA,EAC1D;AAAA,EAkBA,MAAM,iBAAiB,WAAmB,QAA+C;AACvF,UAAM,eAAe,MAAM,KAAK,gBAAgB,SAAS;AAEzD,UAAM,YAAY,kBAAAC,QAAW,gBAAgB;AAAA,MAC3C,MAAM,aAAa,KAAK;AAAA,MACxB,MAAM,aAAa,KAAK;AAAA,MACxB,QAAQ;AAAA,MACR,MAAM;AAAA,QACJ,MAAM,aAAa,KAAK;AAAA,QACxB,MAAM,aAAa,KAAK;AAAA,MAC1B;AAAA,IACF,CAAC;AAED,UAAM,EAAE,MAAM,IAAI,SAAS,MAAM,MAAM,SAAS,YAAY,IAAI;AAEhE,UAAM,UAAU,SAAS;AAAA,MACvB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,cAAU,MAAM;AAAA,EAClB;AAAA,EAkCA,MAAM,YACJ,WACA,QACA,QAC8B;AAC9B,QAAI,UAAU,EAAE,GAAG,OAAO;AAG1B,QAAI,QAAQ,mBAAmB,UAAa,QAAQ,mBAAmB,MAAM;AAC3E,cAAQ,iBAAiB,KAAK,MAAM,IAAI,KAAK,EAAE,QAAQ,IAAI,GAAI,IAAI,KAAK;AAAA,IAC1E;AAGA,QAAI,QAAQ,SAAS,OAAO;AAC1B,cAAQ,OAAO;AAAA,IACjB;AAEA,QAAI,UAAU,EAAE,GAAG,OAAO;AAE1B,QAAI,QAAQ,iBAAiB,QAAW;AACtC,cAAQ,eAAe;AAAA,IACzB;AAGA,QAAI,QAAQ,QAAQ,QAAQ,YAAY,QAAW;AACjD,cAAQ,UAAU,MAAO,KAAK;AAAA,IAChC;AAEA,YACE,MAAM,KAAK,cAAc,IAAI,cAAc,mBAAmB;AAAA,MAC5D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA,EAKA,MAAM,gBAAgB,WAA0C;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,YAAY,WAAW;AACnE,WAAO,OAAO;AAAA,EAChB;AAAA,EAEA,MAAM,cAAc,cAAsD;AACxE,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,mBAAmB,cAAc;AAC7E,WAAO,OAAO;AAAA,EAChB;AAAA,EAeA,MAAM,mBAAmB,cAAuC;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,YAAY;AAEpD,UAAM,WAAW,MAAM,aAAAD,QAAM,IAAI,OAAO,KAAK,cAAc,EAAE,cAAc,cAAc,CAAC;AAC1F,WAAO,OAAO,KAAK,SAAS,IAAI;AAAA,EAClC;AACF;AAxOa;","names":["axios","nodemailer"]}