mailisk 2.2.1 → 2.2.3

package/.github/workflows/test.yml

@@ -9,7 +9,6 @@ on:
 jobs:
   test:
     name: Test
-    needs: build
     runs-on: ubuntu-latest
 
     steps:

package/README.md

@@ -11,6 +11,10 @@ Mailisk is an end-to-end email and SMS testing platform. It allows you to receiv
 
 For a more step-by-step walkthrough see the [NodeJS Guide](https://docs.mailisk.com/guides/nodejs.html).
 
+### Requirements
+
+- Node.js 18 or newer
+
 ### Installation
 
 #### Install with npm

package/dist/index.d.mts

@@ -0,0 +1,338 @@
+import { AxiosBasicCredentials, AxiosRequestConfig } from 'axios';
+import { Attachment } from 'nodemailer/lib/mailer';
+
+interface EmailAddress {
+    /** Email address */
+    address: string;
+    /** 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;
+    /** Sender of email */
+    from: EmailAddress;
+    /** Recepients of email */
+    to: EmailAddress[];
+    /** Carbon-copied recipients for email message */
+    cc?: EmailAddress[];
+    /** Blind carbon-copied recipients for email message */
+    bcc?: EmailAddress[];
+    /** Subject of email */
+    subject?: string;
+    /** Email content that was sent in HTML format */
+    html?: string;
+    /** Email content that was sent in plain text format */
+    text?: string;
+    /** The datetime that this email was received */
+    received_date: Date;
+    /** The unix timestamp (s) that this email was received */
+    received_timestamp: number;
+    /** The unix timestamp (s) when this email will be deleted */
+    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 {
+    /**
+     * The maximum number of emails that can be returned in this request, used alongside `offset` for pagination.
+     */
+    limit?: number;
+    /**
+     * The number of emails to skip/ignore, used alongside `limit` for pagination.
+     */
+    offset?: number;
+    /**
+     * Filter emails by starting unix timestamp in seconds.
+     */
+    from_timestamp?: number;
+    /**
+     * Filter emails by ending unix timestamp in seconds.
+     */
+    to_timestamp?: number;
+    /**
+     * Filter emails by 'to' address. Address must start with this.
+     *
+     * 'foo' would return for 'foobar@namespace.mailisk.net' but not 'barfoo@namespace.mailisk.net'
+     */
+    to_addr_prefix?: string;
+    /**
+     * Filter emails by 'from' address. Address must include this.
+     *
+     * '@foo' would return for 'a@foo.com', 'b@foo.net'
+     */
+    from_addr_includes?: string;
+    /**
+     * Filter emails by subject. This is case insensitive. Subject must include this.
+     *
+     * 'password' would return for 'Password reset', 'Reset password notification' but not 'Reset'
+     */
+    subject_includes?: string;
+    /**
+     * Will keep the request going till at least one email would be returned.
+     *
+     * Default is `true`
+     */
+    wait?: boolean;
+}
+interface SearchInboxResponse {
+    /**
+     * Total number of emails matching query.
+     */
+    total_count: number;
+    /**
+     * Parameters that were used for the query
+     */
+    options: SearchInboxParams;
+    /**
+     * Emails
+     */
+    data: Email[];
+}
+interface SmtpSettings {
+    data: {
+        host: string;
+        port: number;
+        username: string;
+        password: string;
+    };
+}
+interface GetAttachmentResponse {
+    data: {
+        id: string;
+        filename: string;
+        content_type: string;
+        size: number;
+        expires_at: string | null;
+        download_url: string;
+    };
+}
+interface ListNamespacesResponse {
+    total_count: number;
+    data: {
+        id: string;
+        namespace: string;
+    }[];
+}
+interface SendVirtualEmailParams {
+    /** Sender of email */
+    from: string;
+    /**
+     * Recepients of email
+     *
+     * Must match namespace. E.g. if using namespace 'mynamespace' `to` must be 'something@mynamespace.mailisk.net'.
+     */
+    to: string;
+    /** The subject of the e-mail */
+    subject: string;
+    /** The plaintext version of the message */
+    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, 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).
+     */
+    listNamespaces(): Promise<ListNamespacesResponse>;
+    /**
+     * Send an email using the Virtual SMTP.
+     *
+     * These emails can only be sent to valid Mailisk namespaces, i.e. emails that end in @mynamespace.mailisk.net
+     *
+     * @example
+     * For example, sending a test email:
+     * ```typescript
+     * client.sendVirtualEmail(namespace, {
+     *   from: "test@example.com",
+     *   to: `john@${namespace}.mailisk.net`,
+     *   subject: "This is a test",
+     *   text: "Testing",
+     * });
+     * ```
+     */
+    sendVirtualEmail(namespace: string, params: SendVirtualEmailParams): Promise<void>;
+    /**
+     * 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 - 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
+     * ```typescript
+     * const { data: emails } = await client.searchInbox(namespace);
+     * ```
+     *
+     * @example
+     * Get the latest emails for a specific email address
+     * ```typescript
+     * const { data: emails } = await client.searchInbox(namespace, {
+     *   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
+     * });
+     * ```
+     */
+    searchInbox(namespace: string, params?: SearchInboxParams, config?: AxiosRequestConfig): Promise<SearchInboxResponse>;
+    /**
+     * 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

@@ -19,22 +19,29 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   MailiskClient: () => MailiskClient
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/mailisk.ts
 var import_axios = __toESM(require("axios"));
 var import_nodemailer = __toESM(require("nodemailer"));
 var MailiskClient = class {
+  static {
+    __name(this, "MailiskClient");
+  }
   constructor({ apiKey, baseUrl, auth }) {
     this.axiosInstance = import_axios.default.create({
       headers: {
@@ -45,6 +52,15 @@ var MailiskClient = class {
     });
   }
   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");
+   * ```
+   */
   async searchSmsMessages(phoneNumber, params, config) {
     let _params = { ...params };
     if (params?.from_date === void 0 || params?.from_date === null) {
@@ -70,15 +86,43 @@ var MailiskClient = class {
       params: requestParams
     })).data;
   }
+  /**
+   * List all SMS phone numbers associated with the current account.
+   *
+   * @example
+   * List all SMS phone numbers
+   * ```typescript
+   * const { data: smsNumbers } = await client.listSmsNumbers();
+   * ```
+   */
   async listSmsNumbers() {
     return (await this.axiosInstance.get("api/sms/numbers")).data;
   }
   async sendVirtualSms(params) {
     return (await this.axiosInstance.post("api/sms/virtual", params)).data;
   }
+  /**
+   * List all namespaces that belong to the current account (API key).
+   */
   async listNamespaces() {
     return (await this.axiosInstance.get("api/namespaces")).data;
   }
+  /**
+   * Send an email using the Virtual SMTP.
+   *
+   * These emails can only be sent to valid Mailisk namespaces, i.e. emails that end in @mynamespace.mailisk.net
+   *
+   * @example
+   * For example, sending a test email:
+   * ```typescript
+   * client.sendVirtualEmail(namespace, {
+   *   from: "test@example.com",
+   *   to: `john@${namespace}.mailisk.net`,
+   *   subject: "This is a test",
+   *   text: "Testing",
+   * });
+   * ```
+   */
   async sendVirtualEmail(namespace, params) {
     const smtpSettings = await this.getSmtpSettings(namespace);
     const transport = import_nodemailer.default.createTransport({
@@ -102,10 +146,42 @@ var MailiskClient = class {
     });
     transport.close();
   }
+  /**
+   * 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 - 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
+   * ```typescript
+   * const { data: emails } = await client.searchInbox(namespace);
+   * ```
+   *
+   * @example
+   * Get the latest emails for a specific email address
+   * ```typescript
+   * const { data: emails } = await client.searchInbox(namespace, {
+   *   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
+   * });
+   * ```
+   */
   async searchInbox(namespace, params, config) {
     let _params = { ...params };
     if (params?.from_timestamp === void 0 || params?.from_timestamp === null) {
-      _params.from_timestamp = Math.floor(new Date().getTime() / 1e3) - 15 * 60;
+      _params.from_timestamp = Math.floor((/* @__PURE__ */ new Date()).getTime() / 1e3) - 15 * 60;
     }
     if (params?.wait !== false) {
       _params.wait = true;
@@ -122,6 +198,9 @@ var MailiskClient = class {
       params: _params
     })).data;
   }
+  /**
+   * Get the SMTP settings for a namespace.
+   */
   async getSmtpSettings(namespace) {
     const result = await this.axiosInstance.get(`api/smtp/${namespace}`);
     return result.data;
@@ -130,13 +209,25 @@ var MailiskClient = class {
     const result = await this.axiosInstance.get(`api/attachments/${attachmentId}`);
     return result.data;
   }
+  /**
+   * 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);
+   * ```
+   */
   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:
 0 && (module.exports = {
   MailiskClient

package/dist/index.js.map

@@ -1 +1 @@
-{"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"]}
+{"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,EAf3B,OAe2B;AAAA;AAAA;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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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,WAAW,aAAa;AAAA,MAC9D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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;AAAA;AAAA;AAAA,EAKA,MAAM,iBAAkD;AACtD,YAAQ,MAAM,KAAK,cAAc,IAAI,gBAAgB,GAAG;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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,OAAM,oBAAI,KAAK,GAAE,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,SAAS,UAAU;AAAA,MAC5D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,gBAAgB,WAA0C;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,YAAY,SAAS,EAAE;AACnE,WAAO,OAAO;AAAA,EAChB;AAAA,EAEA,MAAM,cAAc,cAAsD;AACxE,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,mBAAmB,YAAY,EAAE;AAC7E,WAAO,OAAO;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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;","names":["axios","nodemailer"]}