ts-mailcow-api 1.2.0 → 1.3.0

package/dist/request-factory.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.wrapPromiseToArray = wrapPromiseToArray;
 const axios_1 = require("axios");
@@ -40,7 +31,6 @@ function isErrorType(type) {
  * Throws a MailcowException if a definite error is detected.
  */
 function checkMailcowResponse(res) {
-    // Accepts either a single object or an array
     const arr = Array.isArray(res) ? res : [res];
     for (const item of arr) {
         if (isErrorType(item.type)) {
@@ -53,54 +43,44 @@ function checkMailcowResponse(res) {
  * @internal
  */
 class RequestFactory {
+    ctx;
     constructor(ctx) {
         this.ctx = ctx;
     }
+    /**
+     * Executes a request and applies Mailcow-specific error handling: a 2XX
+     * response with `type: 'danger'` or `type: 'error'` is converted into a
+     * MailcowException, and an axios error whose response body looks like a
+     * Mailcow error is unwrapped into a MailcowException as well.
+     */
+    async request(send) {
+        try {
+            const res = await send();
+            checkMailcowResponse(res.data);
+            return res.data;
+        }
+        catch (e) {
+            if (axios_1.default.isAxiosError(e) && e.response?.data) {
+                checkMailcowResponse(e.response.data);
+                throw new types_1.MailcowException('Unknown Mailcow error');
+            }
+            throw e;
+        }
+    }
     /**
      * POST Request Factory
      * @param route - The route to which to send the request.
      * @param payload - The payload to send with the request.
      */
     post(route, payload) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            try {
-                const res = yield axios_1.default.post(this.ctx.BASE_URL + route, payload, this.ctx.AXIOS_CONFIG);
-                // Only throws if response has danger or error type
-                checkMailcowResponse(res.data);
-                return res.data;
-            }
-            catch (e) {
-                if (axios_1.default.isAxiosError(e) && ((_a = e.response) === null || _a === void 0 ? void 0 : _a.data)) {
-                    // Check if the response *itself* is an error type
-                    checkMailcowResponse(e.response.data);
-                    // If no definite error, throw generic
-                    throw new types_1.MailcowException('Unknown Mailcow error');
-                }
-                throw e;
-            }
-        });
+        return this.request(() => axios_1.default.post(this.ctx.BASE_URL + route, payload, this.ctx.AXIOS_CONFIG));
     }
     /**
      * GET Request Factory
      * @param route - The route to which to send the request.
      */
     get(route) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            try {
-                const res = yield axios_1.default.get(this.ctx.BASE_URL + route, this.ctx.AXIOS_CONFIG);
-                checkMailcowResponse(res.data);
-                return res.data;
-            }
-            catch (e) {
-                if (axios_1.default.isAxiosError(e) && ((_a = e.response) === null || _a === void 0 ? void 0 : _a.data)) {
-                    checkMailcowResponse(e.response.data);
-                    throw new types_1.MailcowException('Unknown Mailcow error');
-                }
-                throw e;
-            }
-        });
+        return this.request(() => axios_1.default.get(this.ctx.BASE_URL + route, this.ctx.AXIOS_CONFIG));
     }
 }
 exports.default = RequestFactory;

package/dist/request-factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"request-factory.js","sourceRoot":"","sources":["../src/request-factory.ts"],"names":[],"mappings":";;;;;;;;;;;AAkBA,gDAMC;AAxBD,iCAA0B;AAC1B,mCAA0E;AAG1E;;;;GAIG;AACH,SAAS,WAAW,CAAI,IAAa;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC7C,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAI,OAAyB;IAC7D,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,OAAO;aACJ,IAAI,CAAC,CAAC,GAAY,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;aACjD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACjF,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,WAAW,CAAC,IAAwB;IAC3C,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,OAAO,CAAC;AAC/C,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,GAAmC;IAC/D,6CAA6C;IAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC7C,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;QACvB,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,wBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAqB,cAAc;IAGjC,YAAY,GAAkB;QAC5B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACG,IAAI,CAAsB,KAAa,EAAE,OAAU;;;YACvD,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,IAAI,CAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBAC3F,mDAAmD;gBACnD,oBAAoB,CAAC,GAAG,CAAC,IAAkC,CAAC,CAAC;gBAC7D,OAAO,GAAG,CAAC,IAAI,CAAC;YAClB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,eAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAI,MAAA,CAAC,CAAC,QAAQ,0CAAE,IAAI,CAAA,EAAE,CAAC;oBAC9C,kDAAkD;oBAClD,oBAAoB,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAkC,CAAC,CAAC;oBACpE,sCAAsC;oBACtC,MAAM,IAAI,wBAAgB,CAAC,uBAAuB,CAAC,CAAC;gBACtD,CAAC;gBACD,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;KAAA;IAED;;;OAGG;IACG,GAAG,CAAI,KAAa;;;YACxB,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,GAAG,CAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBACjF,oBAAoB,CAAC,GAAG,CAAC,IAAkC,CAAC,CAAC;gBAC7D,OAAO,GAAG,CAAC,IAAI,CAAC;YAClB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,eAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAI,MAAA,CAAC,CAAC,QAAQ,0CAAE,IAAI,CAAA,EAAE,CAAC;oBAC9C,oBAAoB,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAkC,CAAC,CAAC;oBACpE,MAAM,IAAI,wBAAgB,CAAC,uBAAuB,CAAC,CAAC;gBACtD,CAAC;gBACD,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;KAAA;CACF;AA9CD,iCA8CC"}
+{"version":3,"file":"request-factory.js","sourceRoot":"","sources":["../src/request-factory.ts"],"names":[],"mappings":";;AAkBA,gDAMC;AAxBD,iCAA6C;AAC7C,mCAA0E;AAG1E;;;;GAIG;AACH,SAAS,WAAW,CAAI,IAAa;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC7C,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAI,OAAyB;IAC7D,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,OAAO;aACJ,IAAI,CAAC,CAAC,GAAY,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;aACjD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACjF,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,WAAW,CAAC,IAAwB;IAC3C,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,OAAO,CAAC;AAC/C,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,GAAmC;IAC/D,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC7C,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;QACvB,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,wBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAqB,cAAc;IACzB,GAAG,CAAgB;IAE3B,YAAY,GAAkB;QAC5B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,OAAO,CAAI,IAAqC;QAC5D,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAI,EAAE,CAAC;YACzB,oBAAoB,CAAC,GAAG,CAAC,IAAkC,CAAC,CAAC;YAC7D,OAAO,GAAG,CAAC,IAAI,CAAC;QAClB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,eAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC9C,oBAAoB,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAkC,CAAC,CAAC;gBACpE,MAAM,IAAI,wBAAgB,CAAC,uBAAuB,CAAC,CAAC;YACtD,CAAC;YACD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAsB,KAAa,EAAE,OAAU;QACjD,OAAO,IAAI,CAAC,OAAO,CAAI,GAAG,EAAE,CAAC,eAAK,CAAC,IAAI,CAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,GAAG,CAAI,KAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAI,GAAG,EAAE,CAAC,eAAK,CAAC,GAAG,CAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/F,CAAC;CACF;AA3CD,iCA2CC"}

package/dist/types.d.ts

@@ -219,7 +219,7 @@ export interface Domain {
      */
     relay_all_recipients_int: boolean;
     /**
-     * If the domain should only relay unknown adresses.
+     * If the domain should only relay unknown addresses.
      */
     relay_unknown_only: boolean;
     /**
@@ -318,7 +318,7 @@ export interface BaseMailboxAttributes {
     /**
      * The authentication source for this mailbox.
      */
-    authsource: 'mailcow' | 'ldap' | 'keycloack' | 'generic-oidc';
+    authsource: 'mailcow' | 'ldap' | 'keycloak' | 'generic-oidc';
 }
 /**
  * Mailbox creation request.
@@ -567,9 +567,9 @@ export interface PushoverEditRequest {
     items: string | string[];
 }
 /**
- * Quarantaine notification edit payload.
+ * Quarantine notification edit payload.
  */
-export interface QuarantaineEditRequest {
+export interface QuarantineEditRequest {
     /**
      * The attributes to edit.
      */
@@ -586,6 +586,10 @@ export interface QuarantaineEditRequest {
         anyOf: string | string[];
     };
 }
+/**
+ * @deprecated Misspelling. Use {@link QuarantineEditRequest} instead. Will be removed in 2.0.0.
+ */
+export type QuarantaineEditRequest = QuarantineEditRequest;
 /**
  * Spam score edit payload.
  */
@@ -1125,7 +1129,7 @@ export interface PFLog extends Log {
  */
 export interface RLLog extends Log {
     /**
-     * From email adress.
+     * From email address.
      */
     from: string;
     /**

package/dist/types.js

@@ -5,6 +5,10 @@ exports.MailcowException = void 0;
  * Error class used for exception handling.
  */
 class MailcowException extends Error {
+    /**
+     * The error message provided by Mailcow.
+     */
+    message;
 }
 exports.MailcowException = MailcowException;
 //# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAq7CA;;GAEG;AACH,MAAa,gBAAiB,SAAQ,KAAK;CAK1C;AALD,4CAKC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AA07CA;;GAEG;AACH,MAAa,gBAAiB,SAAQ,KAAK;IACzC;;OAEG;IACH,OAAO,CAAS;CACjB;AALD,4CAKC"}

package/package.json

@@ -1,58 +1,57 @@
-{
-  "name": "ts-mailcow-api",
-  "version": "1.2.0",
-  "description": "TypeScript wrapper for the mailcow API.",
-  "scripts": {
-    "test": "mocha -r ts-node/register --extensions ts \"test/**/*.test.ts\"",
-    "lint": "eslint src",
-    "lint:fix": "eslint src --fix",
-    "format": "prettier --ignore-path .gitignore --check ./src/",
-    "format:fix": "prettier --ignore-path .gitignore --write ./src/",
-    "docs": "typedoc",
-    "build": "tsc",
-    "prepare": "tsc",
-    "prepublishOnly": "yarn install --frozen-lockfile && yarn build",
-    "postpublish": "git add package.json && git tag v%npm_package_version% && git commit -m \"chore: version update %npm_package_version%\" && git push --tags"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/JustSamuel/ts-mailcow-api.git"
-  },
-  "bugs": {
-    "url": "https://github.com/JustSamuel/ts-mailcow-api/issues"
-  },
-  "homepage": "https://github.com/JustSamuel/ts-mailcow-api#readme",
-  "author": "Samuel",
-  "files": [
-    "dist"
-  ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "keywords": [
-    "mailcow",
-    "typescript",
-    "API"
-  ],
-  "license": "ISC",
-  "devDependencies": {
-    "@gewis/eslint-config-typescript": "^2.4.0",
-    "@gewis/prettier-config": "^2.2.2",
-    "@types/chai": "^4.2.18",
-    "@types/mocha": "^8.2.2",
-    "@types/node": "^24.0.0",
-    "chai": "^4.3.4",
-    "eslint": "^9.24.0",
-    "mocha": "^10.1.0",
-    "prettier": "^3.5.3",
-    "ts-mocha": "^11.1.0",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.28.5",
-    "typedoc-plugin-merge-modules": "^7.0.0",
-    "typedoc-plugin-missing-exports": "^4.0.0",
-    "typescript": "^5.8.3"
-  },
-  "dependencies": {
-    "axios": "^1.9.0"
-  },
-  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
-}
+{
+  "name": "ts-mailcow-api",
+  "version": "1.3.0",
+  "description": "TypeScript wrapper for the mailcow API.",
+  "scripts": {
+    "test": "ts-mocha \"test/**/*.test.ts\"",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "format": "prettier --ignore-path .gitignore --check ./src/",
+    "format:fix": "prettier --ignore-path .gitignore --write ./src/",
+    "docs": "typedoc",
+    "build": "tsc",
+    "prepare": "tsc",
+    "prepublishOnly": "yarn install --frozen-lockfile && yarn build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JustSamuel/ts-mailcow-api.git"
+  },
+  "bugs": {
+    "url": "https://github.com/JustSamuel/ts-mailcow-api/issues"
+  },
+  "homepage": "https://github.com/JustSamuel/ts-mailcow-api#readme",
+  "author": "Samuel",
+  "files": [
+    "dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "mailcow",
+    "typescript",
+    "API"
+  ],
+  "license": "AGPL-3.0-only",
+  "devDependencies": {
+    "@gewis/eslint-config-typescript": "^2.4.0",
+    "@gewis/prettier-config": "^2.2.2",
+    "@types/chai": "^4.2.18",
+    "@types/mocha": "^8.2.2",
+    "@types/node": "^24.0.0",
+    "chai": "^4.3.4",
+    "eslint": "^9.24.0",
+    "mocha": "^10.1.0",
+    "prettier": "^3.5.3",
+    "ts-mocha": "^11.1.0",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.28.5",
+    "typedoc-plugin-merge-modules": "^7.0.0",
+    "typedoc-plugin-missing-exports": "^4.0.0",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "axios": "^1.9.0"
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}