cypress-maildev/src/maildevCommands.ts

An easy-to-use cypress bunch of commands to use Maildev API for tests messages reception !

/* global Cypress */
import Request from "./request";
import { Email } from "./types/Email";

export class MaildevCommands {
  public baseUrl: string;
  public request: Request;

  static get cypressCommands(): string[] {
    return [
      "maildevGetAllMessages",
      "maildevGetLastMessage",
      "maildevGetMessageById",
      "maildevVisitMessageById",
      "maildevGetMessageBySubject",
      "maildevGetMessageBySentTo",
      "maildevDeleteMessageById",
      "maildevGetOTPCode",
      "maildevDeleteAllMessages",
      "maildevHealthcheck",
    ];
  }

  constructor() {
    this.baseUrl = `${Cypress.env("MAILDEV_PROTOCOL")}://${Cypress.env(
      "MAILDEV_HOST"
    )}`;

    if (Cypress.env("MAILDEV_API_PORT")) {
      this.baseUrl += `:${Cypress.env("MAILDEV_API_PORT")}`;
    }

    this.request = new Request({
      baseUrl: this.baseUrl,
    });
  }

  maildevGetAllMessages(): Cypress.Chainable<Email[]> {
    return this.request.get("/email");
  }

  maildevGetLastMessage(): Cypress.Chainable<Email> {
    return this.maildevGetAllMessages().then((emails) => {
      return emails[emails.length - 1];
    });
  }

  maildevGetMessageById(id: string): Cypress.Chainable<Email> {
    return this.request.get(`/email/${id}`);
  }

  maildevVisitMessageById(id: string): void {
    cy.origin(`${this.baseUrl}`, { args: { id } }, ({ id }) => {
      cy.visit(`/email/${id}/html`);
    });
  }

  maildevGetMessageBySubject(str: string): Cypress.Chainable<Email> {
    return this.maildevGetAllMessages().then((emails) => {
      return emails.find((email: Email) => email.subject === str) ?? null;
    }) as Cypress.Chainable<Email>;
  }

  maildevGetMessageBySentTo(address: string): Cypress.Chainable<Email | null> {
    return this.maildevGetAllMessages().then((messages) => {
      const reversedMessages = messages.reverse();
      for (const message of reversedMessages) {
        for (const to of message.to) {
          if (to.address === address) {
            return message;
          }
        }
      }
      return null;
    }) as Cypress.Chainable<Email | null>;
  }

  maildevDeleteMessageById(id: string): Cypress.Chainable<any> {
    return this.request.delete(`/email/${id}`);
  }

  maildevGetOTPCode(str: string, digits = 6): Cypress.Chainable<string | null> {
    const OTP_REGEXP = new RegExp("\\d{" + digits + "}");
    const res = str.match(OTP_REGEXP);
    return cy.wrap(res ? res[0] : null);
  }

  maildevDeleteAllMessages(): Cypress.Chainable<any> {
    return this.request.delete("/email/all");
  }

  maildevHealthcheck(): Cypress.Chainable<any> {
    return this.request.get("/healthz");
  }
}