ts-mailcow-api 0.6.2 → 0.8.1

package/src/index.ts

@@ -3,11 +3,14 @@
  */
 
 import { AxiosRequestConfig } from 'axios';
-import domainEndpoints from './Endpoints/domain-endpoints';
-import antiSpamEndpoints from './Endpoints/antispam-endpoints';
-import mailboxEndpoints from './Endpoints/mailbox-endpoint';
+import { domainEndpoints, DomainEndpoints } from './Endpoints/domain-endpoints';
+import { antiSpamEndpoints, AntiSpamEndpoints } from './Endpoints/antispam-endpoints';
+import { mailboxEndpoints, MailboxEndpoints } from './Endpoints/mailbox-endpoint';
 import RequestFactory from './request-factory';
 import { aliasEndpoints, AliasEndpoints } from './Endpoints/alias-endpoints';
+import { syncjobEndpoints, SyncjobEndpoints } from './Endpoints/syncjob-endpoints';
+import { forwardingEndpoints, ForwardingEndpoints } from './Endpoints/forwarding-endpoints';
+import { logEndpoints, LogEndpoints } from './Endpoints/log-endpoints';
 
 /**
  * Class containing all the logic to interface with the Mailcow API in TypeScript.
@@ -24,7 +27,11 @@ class MailcowClient {
    */
   readonly API_KEY: string;
 
-  HEADERS: {};
+  /**
+   * The headers used for every request.
+   * @internal
+   */
+  HEADERS: AxiosRequestConfig;
 
   /**
    * Creates a MailcowClient using the given URL and API key.
@@ -32,7 +39,7 @@ class MailcowClient {
    * @param API_KEY  - The API key of the Mailcow API.
    */
   constructor(BASE_URL: string, API_KEY: string) {
-    this.BASE_URL = BASE_URL;
+    this.BASE_URL = BASE_URL.charAt(BASE_URL.length - 1) === '/' ? BASE_URL : BASE_URL.concat('/');
     this.API_KEY = API_KEY;
 
     // Set the correct Axios headers.
@@ -41,21 +48,63 @@ class MailcowClient {
         'Content-Type': 'application/json',
         'X-API-Key': this.API_KEY
       }
-    } as AxiosRequestConfig;
+    };
   }
 
+  /**
+   * Factory method pattern for creating HTTP requests.
+   * @internal
+   */
   public requestFactory = new RequestFactory(this)
 
   /**
    * All endpoints related to Aliases.
+   * See {@link AliasEndpoints}
+   * @external
    */
   public aliases: AliasEndpoints = aliasEndpoints(this)
 
-  public domains = domainEndpoints(this)
+  /**
+   * All endpoints related to Domains.
+   * See {@link DomainEndpoints}
+   * @external
+   */
+  public domains: DomainEndpoints = domainEndpoints(this)
 
-  public spamPolicy = antiSpamEndpoints(this)
+  /**
+   * All endpoints related to spam policies.
+   * See {@link AntiSpamEndpoints}
+   * @external
+   */
+  public spamPolicy: AntiSpamEndpoints = antiSpamEndpoints(this)
 
-  public mailbox = mailboxEndpoints(this)
+  /**
+   * All endpoints related to mailboxes.
+   * See {@link MailboxEndpoints}
+   * @external
+   */
+  public mailbox: MailboxEndpoints = mailboxEndpoints(this)
+
+  /**
+   * All endpoints related to sync jobs.
+   * See {@link SyncjobEndpoints}
+   * @external
+   */
+  public syncjobs: SyncjobEndpoints = syncjobEndpoints(this)
+
+  /**
+   * All endpoints related to forwarding hosts.
+   * See {@link ForwardingEndpoints}
+   * @external
+   */
+  public forwardingHosts: ForwardingEndpoints = forwardingEndpoints(this)
+
+  /**
+   * All endpoints related to logs.
+   * See {@link LogEndpoints}
+   * @external
+   */
+  public logs: LogEndpoints = logEndpoints(this)
 }
 
 export default MailcowClient;

package/src/request-factory.ts

@@ -2,10 +2,20 @@ import axios, { AxiosError, AxiosResponse } from 'axios';
 import { MailcowErrorResponse, MailcowException, Payload } from './types';
 import MailcowClient from './index';
 
+/**
+ * Ensures output is an array.
+ * @param item
+ * @internal
+ */
 function wrapToArray<T>(item: T | T[]): T[] {
   return Array.isArray(item) ? item : [item];
 }
 
+/**
+ * Function that wraps T | T[] to T[]
+ * @internal
+ * @param promise - The promise of which the output to wrap.
+ */
 export function wrapPromiseToArray<T>(promise: Promise<T|T[]>): Promise<T[]> {
   return new Promise<T[]>((resolve, reject) => {
     promise