cypress-mailisk 2.0.0 → 2.1.1

package/README.md

@@ -49,7 +49,7 @@ This Cypress command does a few extra things out of the box compared to calling
 
 - 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 it returns emails in the last 15 minutes. 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_timestamp: 0` will disable filtering by email age).
+- By default it returns emails in the last 15 minutes. This ensures that only new emails are returned. This can be overriden by passing the `from_timestamp` parameter (`from_timestamp: 0` will disable filtering by email age).
 
 ```js
 // timeout of 5 minute
@@ -60,9 +60,125 @@ cy.mailiskSearchInbox(namespace, {}, { timeout: 1000 * 60 });
 cy.mailiskSearchInbox(namespace, { wait: false });
 ```
 
-The implementation of these features is explained in the [NodeJS Guide](/guides/nodejs).
+For the full list of filters and their description see the [Search Inbox](/api-reference/search-inbox#request-1) endpoint reference.
 
-## Example
+### cy.mailiskGetAttachment
+
+This command retrieves attachment metadata including download URL, filename, content type, and size.
+
+```js
+cy.mailiskGetAttachment('yournamespace', 'attachment-id').then((attachment) => {
+  console.log(attachment.data.filename);
+  console.log(attachment.data.content_type);
+  console.log(attachment.data.size);
+});
+```
+
+### cy.mailiskDownloadAttachment
+
+This command downloads the actual attachment content as a Buffer. It first retrieves the attachment metadata, then downloads the file from the provided download URL.
+
+```js
+cy.mailiskDownloadAttachment('yournamespace', 'attachment-id').then((buffer) => {
+  // Save attachment to file
+  cy.writeFile('downloads/attachment.pdf', buffer);
+});
+```
+
+Both commands accept optional request options as a third parameter:
+
+```js
+cy.mailiskGetAttachment('yournamespace', 'attachment-id', { timeout: 30000 });
+cy.mailiskDownloadAttachment('yournamespace', 'attachment-id', { timeout: 60000 });
+```
+
+### Filter by TO address
+
+The `to_addr_prefix` option allows filtering by the email's TO address. Specifically the TO address has to start with this.
+
+For example, if someone sends an email to `my-user-1@yournamespace.mailisk.net`, you can filter it by using `my-user-1@`:
+
+```js
+cy.mailiskSearchInbox(namespace, {
+  to_addr_prefix: 'my-user-1@',
+});
+```
+
+### Filter by FROM address
+
+The `from_addr_includes` option allows filtering by the email's FROM address. Specifically the TO address has to include this. Note that this is different from the to address as it is _includes_ not _prefix_.
+
+For example, if someone sends an email from the `example.com` domain we could filter like so:
+
+```js
+cy.mailiskSearchInbox(namespace, {
+  from_addr_includes: '@example.com',
+});
+```
+
+If we know a specific email address we want to listen to we can do this:
+
+```js
+cy.mailiskSearchInbox(namespace, {
+  from_addr_includes: 'no-reply@example.com',
+});
+```
+
+### Filter by Subject
+
+The `subject_includes` option allows filtering by the email's Subject. Specifically the Subject has to include this (case-insensitive).
+
+If we're testing password reset that sends an email with the subject `Password reset request`. We could filter by something like this:
+
+```js
+cy.mailiskSearchInbox(namespace, {
+  subject_includes: 'password reset request',
+});
+```
+
+## Common test cases
+
+### Working with email attachments
+
+This example demonstrates how to search for emails with attachments and download them:
+
+```js
+describe('Test email attachments', () => {
+  const namespace = 'yournamespace';
+  const testEmailAddr = `test.user@${namespace}.mailisk.net`;
+
+  it('Finds email with attachment and downloads it', () => {
+    cy.mailiskSearchInbox(namespace, {
+      to_addr_prefix: testEmailAddr,
+      subject_includes: 'invoice',
+    }).then((response) => {
+      expect(response.data).to.not.be.empty;
+      const email = response.data[0];
+      
+      // Check if email has attachments
+      expect(email.attachments).to.not.be.empty;
+      const attachment = email.attachments[0];
+      
+      // Get attachment metadata
+      cy.mailiskGetAttachment(attachment.id).then((attachmentData) => {
+        expect(attachmentData.data.filename).to.contain('.pdf');
+        expect(attachmentData.data.content_type).to.equal('application/pdf');
+        
+        // Download the attachment
+        cy.mailiskDownloadAttachment(attachment.id).then((buffer) => {
+          // Save to downloads folder
+          cy.writeFile(`downloads/${attachmentData.data.filename}`, buffer);
+          
+          // Verify file was downloaded
+          cy.readFile(`downloads/${attachmentData.data.filename}`).should('exist');
+        });
+      });
+    });
+  });
+});
+```
+
+### Password reset page
 
 This example demonstrates going to a password reset page, requesting a new password, receiving reset code link via email and finally setting the new password.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-mailisk",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "Mailisk library for Cypress",
   "keywords": [
     "mailisk",
@@ -13,7 +13,10 @@
   "main": "index.js",
   "types": "src/mailiskCommands.d.ts",
   "scripts": {
-    "tsc": "node_modules/.bin/tsc src/mailiskCommands.d.ts --types node"
+    "tsc": "node_modules/.bin/tsc src/mailiskCommands.d.ts --types node",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage"
   },
   "peerDependencies": {
     "cypress": ">= 2.1.0"
@@ -32,6 +35,8 @@
   },
   "homepage": "https://github.com/mailisk-app/cypress-mailisk#readme",
   "devDependencies": {
-    "typescript": "^4.7.4"
+    "typescript": "^4.7.4",
+    "jest": "^29.0.0",
+    "@jest/globals": "^29.0.0"
   }
 }

package/src/mailiskCommands.d.ts

@@ -7,6 +7,17 @@ export interface EmailAddress {
   name?: string;
 }
 
+export 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;
+}
+
 export interface Email {
   /** Namespace scoped ID */
   id: string;
@@ -32,6 +43,8 @@ export interface Email {
   expires_timestamp: number;
   /** The spam score as reported by SpamAssassin */
   spam_score?: number;
+  /** The attachments of the email */
+  attachments?: EmailAttachment[];
 }
 
 export interface SearchInboxParams {
@@ -92,6 +105,17 @@ export interface SearchInboxResponse {
   data: Email[];
 }
 
+export interface GetAttachmentResponse {
+  data: {
+    id: string;
+    filename: string;
+    content_type: string;
+    size: number;
+    expires_at: string | null;
+    download_url: string;
+  };
+}
+
 declare global {
   namespace Cypress {
     interface Chainable {
@@ -111,6 +135,32 @@ declare global {
          */
         options?: Partial<Cypress.RequestOptions>,
       ): Cypress.Chainable<SearchInboxResponse>;
+
+      mailiskGetAttachment(
+        /**
+         * The attachment ID to retrieve.
+         */
+        attachmentId: string,
+        /**
+         * Request options.
+         *
+         * See https://docs.cypress.io/api/commands/request#Arguments
+         */
+        options?: Partial<Cypress.RequestOptions>,
+      ): Cypress.Chainable<GetAttachmentResponse>;
+
+      mailiskDownloadAttachment(
+        /**
+         * The attachment ID to download.
+         */
+        attachmentId: string,
+        /**
+         * Request options.
+         *
+         * See https://docs.cypress.io/api/commands/request#Arguments
+         */
+        options?: Partial<Cypress.RequestOptions>,
+      ): Cypress.Chainable<Buffer>;
     }
   }
 }

package/src/mailiskCommands.js

@@ -2,7 +2,7 @@ const Request = require('./request');
 
 class MailiskCommands {
   static get cypressCommands() {
-    return ['mailiskSetApiKey', 'mailiskListNamespaces', 'mailiskSearchInbox'];
+    return ['mailiskSetApiKey', 'mailiskListNamespaces', 'mailiskSearchInbox', 'mailiskGetAttachment', 'mailiskDownloadAttachment'];
   }
 
   constructor() {
@@ -66,6 +66,16 @@ class MailiskCommands {
       return this.request.get(`api/emails/${namespace}/inbox?${urlParams.toString()}`, _options);
     }
   }
+
+  mailiskGetAttachment(attachmentId, options = {}) {
+    return this.request.get(`api/attachments/${attachmentId}`, options);
+  }
+
+  mailiskDownloadAttachment(attachmentId, options = {}) {
+    return this.mailiskGetAttachment(attachmentId, options).then((attachment) => {
+      return this.request.getBinary(attachment.data.download_url, options);
+    });
+  }
 }
 
 module.exports = MailiskCommands;

package/src/request.js

@@ -81,6 +81,24 @@ class Request {
   del(path, opts) {
     return this.request('DELETE', path, undefined, opts);
   }
+
+  getBinary(url, opts) {
+    // For binary downloads, we need to use the full URL directly
+    const options = {
+      method: 'GET',
+      url: url,
+      encoding: null, // This tells Cypress to return binary data
+      ...opts,
+    };
+    options.failOnStatusCode = false;
+    return cy.request(options).then((response) => {
+      if (response.isOkStatusCode) {
+        return Buffer.from(response.body);
+      }
+      // Use the same error handling as regular requests
+      return this.getResponseHandler()(response);
+    });
+  }
 }
 
 module.exports = Request;