feat: stricter error handling will now also throw on "2XX" codes but with error body.

Author: JustSamuel

src/request-factory.ts

@@ -1,5 +1,5 @@
-import axios, { AxiosError, AxiosResponse } from 'axios';
-import { MailcowErrorResponse, MailcowException } from './types';
+import axios from 'axios';
+import { BaseResponse, MailcowException, MailcowResponse } from './types';
 import MailcowClient from './index';
 
 /**
@@ -24,6 +24,24 @@ export function wrapPromiseToArray<T>(promise: Promise<T | T[]>): Promise<T[]> {
   });
 }
 
+function isErrorType(type: string | undefined): boolean {
+  return type === 'danger' || type === 'error';
+}
+
+/**
+ * Checks if a Mailcow API response indicates an error.
+ * Throws a MailcowException if a definite error is detected.
+ */
+function checkMailcowResponse(res: MailcowResponse | BaseResponse): void {
+  // Accepts either a single object or an array
+  const arr = Array.isArray(res) ? res : [res];
+  for (const item of arr) {
+    if (isErrorType(item.type)) {
+      throw new MailcowException(Array.isArray(item.msg) ? item.msg.join(', ') : item.msg);
+    }
+  }
+}
+
 /**
  * Factory method patterns for creating Axios Requests.
  * @internal
@@ -41,38 +59,37 @@ export default class RequestFactory {
    * @param payload - The payload to send with the request.
    */
   async post<T, P extends object>(route: string, payload: P): Promise<T> {
-    return new Promise((resolve, reject) => {
-      axios
-        .post(this.ctx.BASE_URL + route, payload, this.ctx.AXIOS_CONFIG)
-        // On succes
-        .then((res: AxiosResponse<T>) => {
-          resolve(res.data);
-        })
-        // On error
-        .catch((e: AxiosError<MailcowErrorResponse>) => {
-          const { msg } = e.response.data;
-          reject(new MailcowException(msg));
-        });
-    });
+    try {
+      const res = await axios.post<T>(this.ctx.BASE_URL + route, payload, this.ctx.AXIOS_CONFIG);
+      // Only throws if response has danger or error type
+      checkMailcowResponse(res.data as unknown as MailcowResponse);
+      return res.data;
+    } catch (e) {
+      if (axios.isAxiosError(e) && e.response?.data) {
+        // Check if the response *itself* is an error type
+        checkMailcowResponse(e.response.data as unknown as MailcowResponse);
+        // If no definite error, throw generic
+        throw new MailcowException('Unknown Mailcow error');
+      }
+      throw e;
+    }
   }
 
   /**
    * GET Request Factory
    * @param route - The route to which to send the request.
    */
   async get<T>(route: string): Promise<T> {
-    return new Promise((resolve, reject) => {
-      axios
-        .get(this.ctx.BASE_URL + route, this.ctx.AXIOS_CONFIG)
-        // On succes
-        .then((res: AxiosResponse<T>) => {
-          resolve(res.data);
-        })
-        // On error
-        .catch((e: AxiosError<MailcowErrorResponse>) => {
-          const { msg } = e.response.data;
-          reject(new MailcowException(msg));
-        });
-    });
+    try {
+      const res = await axios.get<T>(this.ctx.BASE_URL + route, this.ctx.AXIOS_CONFIG);
+      checkMailcowResponse(res.data as unknown as MailcowResponse);
+      return res.data;
+    } catch (e) {
+      if (axios.isAxiosError(e) && e.response?.data) {
+        checkMailcowResponse(e.response.data as unknown as MailcowResponse);
+        throw new MailcowException('Unknown Mailcow error');
+      }
+      throw e;
+    }
   }
 }

test/index.test.ts

@@ -7,8 +7,8 @@ import {
   MailcowResponse,
   Syncjob,
   SyncjobAttributes, SyncjobEditAttributes
-} from "../src/types";
-import { AliasEditAttributes } from "../src/types";
+} from "../src";
+import { AliasEditAttributes } from "../src";
 import * as https from "node:https";
 
 const mcc: MailcowClient = new MailcowClient(
@@ -27,7 +27,6 @@ function isSucces(res: MailcowResponse) {
 async function thenTestOrFail(promise: Promise<any>, test: Function, fatal = false): Promise<void> {
   await promise
     .then((res: any) => {
-      console.log(JSON.stringify(res, null, 4));
       test(res);
     })
     .catch((err) => {
@@ -44,7 +43,14 @@ describe("Alias Endpoint tests", (): void => {
     await thenTestOrFail(mcc.aliases.get(), (res: Alias[]) => expect(res).to.be.length.least(1), true)
   });
   it('should get a single alias', async () => {
-    await thenTestOrFail(mcc.aliases.get(8), (res: Alias[]) => expect(res).to.be.length.least(1), true)
+    let id: number;
+    await mcc.aliases.get().then((res: Alias[]) => {
+      id = res[0].id
+    })
+
+    await thenTestOrFail(mcc.aliases.get(id), (res: Alias[]) => {
+      expect(res).to.be.length.least(1)
+    }, true)
   });
   describe("Modify aliases", (): void => {
     const attr: AliasPostRequest = {