mailpit-api 1.0.5 → 1.0.6

package/README.md

@@ -1,3 +1,29 @@
 # mailpit-api
 
-A NodeJS client library, written in TypeScript, to interact with the Mailpit API.
+A NodeJS client library, written in TypeScript, to interact with the Mailpit API.
+
+[![npm version](https://img.shields.io/npm/v/mailpit-api.svg)](https://www.npmjs.com/package/mailpit-api)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
+
+This package provides a convenient way to interact with [Mailpit](https://github.com/axllent/mailpit) from your NodeJS applications.
+
+## Installation
+
+```bash
+npm install mailpit-api
+```
+
+## Example
+
+```typescript
+import { MailpitClient } from "mailpit-api";
+
+// Initialize the API client
+const mailpit = new MailpitClient("http://localhost:8025");
+
+// Get all messages
+const messages = await mailpit.listMessages();
+
+// Delete all messages
+await mailpit.deleteMessages();
+```

package/dist/cjs/index.d.ts

@@ -224,6 +224,34 @@ export interface MailpitSetTagsRequest {
     IDs: string[];
     Tags: string[];
 }
+export interface ChaosTriggersRequest {
+    Authentication?: {
+        ErrorCode: number;
+        Probability: number;
+    };
+    Recipient?: {
+        ErrorCode: number;
+        Probability: number;
+    };
+    Sender?: {
+        ErrorCode: number;
+        Probability: number;
+    };
+}
+export interface ChaosTriggersResponse {
+    Authentication: {
+        ErrorCode: number;
+        Probability: number;
+    };
+    Recipient?: {
+        ErrorCode: number;
+        Probability: number;
+    };
+    Sender?: {
+        ErrorCode: number;
+        Probability: number;
+    };
+}
 export declare class MailpitClient {
     private axiosInstance;
     constructor(baseURL: string);
@@ -253,4 +281,6 @@ export declare class MailpitClient {
     deleteTag(tag: string): Promise<string>;
     renderMessageHTML(id?: string): Promise<string>;
     renderMessageText(id?: string): Promise<string>;
+    getChaosTriggers(): Promise<ChaosTriggersResponse>;
+    setChaosTriggers(triggers?: ChaosTriggersRequest): Promise<ChaosTriggersResponse>;
 }

package/dist/cjs/index.js

@@ -50,7 +50,7 @@ class MailpitClient {
             }
         });
     }
-    // Message
+    // Application
     getInfo() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.handleRequest(() => this.axiosInstance.get("/api/v1/info"));
@@ -61,6 +61,7 @@ class MailpitClient {
             return this.handleRequest(() => this.axiosInstance.get("/api/v1/webui"));
         });
     }
+    // Message
     getMessageSummary() {
         return __awaiter(this, arguments, void 0, function* (id = "latest") {
             return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}`));
@@ -180,5 +181,15 @@ class MailpitClient {
             return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.txt`));
         });
     }
+    getChaosTriggers() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get("/api/v1/chaos"));
+        });
+    }
+    setChaosTriggers() {
+        return __awaiter(this, arguments, void 0, function* (triggers = {}) {
+            return this.handleRequest(() => this.axiosInstance.put("/api/v1/chaos", triggers));
+        });
+    }
 }
 exports.MailpitClient = MailpitClient;

package/dist/mjs/index.d.ts

@@ -224,6 +224,34 @@ export interface MailpitSetTagsRequest {
     IDs: string[];
     Tags: string[];
 }
+export interface ChaosTriggersRequest {
+    Authentication?: {
+        ErrorCode: number;
+        Probability: number;
+    };
+    Recipient?: {
+        ErrorCode: number;
+        Probability: number;
+    };
+    Sender?: {
+        ErrorCode: number;
+        Probability: number;
+    };
+}
+export interface ChaosTriggersResponse {
+    Authentication: {
+        ErrorCode: number;
+        Probability: number;
+    };
+    Recipient?: {
+        ErrorCode: number;
+        Probability: number;
+    };
+    Sender?: {
+        ErrorCode: number;
+        Probability: number;
+    };
+}
 export declare class MailpitClient {
     private axiosInstance;
     constructor(baseURL: string);
@@ -253,4 +281,6 @@ export declare class MailpitClient {
     deleteTag(tag: string): Promise<string>;
     renderMessageHTML(id?: string): Promise<string>;
     renderMessageText(id?: string): Promise<string>;
+    getChaosTriggers(): Promise<ChaosTriggersResponse>;
+    setChaosTriggers(triggers?: ChaosTriggersRequest): Promise<ChaosTriggersResponse>;
 }

package/dist/mjs/index.js

@@ -34,13 +34,14 @@ export class MailpitClient {
             }
         }
     }
-    // Message
+    // Application
     async getInfo() {
         return this.handleRequest(() => this.axiosInstance.get("/api/v1/info"));
     }
     async getConfiguration() {
         return this.handleRequest(() => this.axiosInstance.get("/api/v1/webui"));
     }
+    // Message
     async getMessageSummary(id = "latest") {
         return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}`));
     }
@@ -118,4 +119,10 @@ export class MailpitClient {
     async renderMessageText(id = "latest") {
         return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.txt`));
     }
+    async getChaosTriggers() {
+        return this.handleRequest(() => this.axiosInstance.get("/api/v1/chaos"));
+    }
+    async setChaosTriggers(triggers = {}) {
+        return this.handleRequest(() => this.axiosInstance.put("/api/v1/chaos", triggers));
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailpit-api",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A NodeJS client library, written in TypeScript, to interact with the Mailpit API.",
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
   "author": "Matthew Spahr",
   "license": "MIT",
   "dependencies": {
-    "axios": "^1.7.8"
+    "axios": "^1.7.9"
   },
   "devDependencies": {
     "@eslint/js": "^8.57.0",
@@ -41,11 +41,11 @@
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "@typescript-eslint/parser": "^7.18.0",
     "eslint": "^8.57.0",
-    "globals": "^15.13.0",
+    "globals": "^15.14.0",
     "jest": "^29.7.0",
     "prettier": "3.4.2",
     "tsx": "^4.19.2",
-    "typescript": "^5.7.2",
+    "typescript": "^5.7.3",
     "typescript-eslint": "^7.18.0"
   }
 }

package/src/index.ts

@@ -241,6 +241,36 @@ export interface MailpitSetTagsRequest {
   Tags: string[];
 }
 
+export interface ChaosTriggersRequest {
+  Authentication?: {
+    ErrorCode: number;
+    Probability: number;
+  };
+  Recipient?: {
+    ErrorCode: number;
+    Probability: number;
+  };
+  Sender?: {
+    ErrorCode: number;
+    Probability: number;
+  };
+}
+
+export interface ChaosTriggersResponse {
+  Authentication: {
+    ErrorCode: number;
+    Probability: number;
+  };
+  Recipient?: {
+    ErrorCode: number;
+    Probability: number;
+  };
+  Sender?: {
+    ErrorCode: number;
+    Probability: number;
+  };
+}
+
 export class MailpitClient {
   private axiosInstance: AxiosInstance;
 
@@ -281,7 +311,7 @@ export class MailpitClient {
     }
   }
 
-  // Message
+  // Application
   public async getInfo(): Promise<MailpitInfoResponse> {
     return this.handleRequest(() =>
       this.axiosInstance.get<MailpitInfoResponse>("/api/v1/info"),
@@ -294,6 +324,7 @@ export class MailpitClient {
     );
   }
 
+  // Message
   public async getMessageSummary(
     id: string = "latest",
   ): Promise<MailpitMessageSummaryResponse> {
@@ -488,4 +519,18 @@ export class MailpitClient {
       this.axiosInstance.get<string>(`/view/${id}.txt`),
     );
   }
+
+  public async getChaosTriggers(): Promise<ChaosTriggersResponse> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<ChaosTriggersResponse>("/api/v1/chaos"),
+    );
+  }
+
+  public async setChaosTriggers(
+    triggers: ChaosTriggersRequest = {},
+  ): Promise<ChaosTriggersResponse> {
+    return this.handleRequest(() =>
+      this.axiosInstance.put<ChaosTriggersResponse>("/api/v1/chaos", triggers),
+    );
+  }
 }