3.1: add support for webhooks and fix server error messages

Author: AlexanderEpolite

README.md

@@ -34,6 +34,29 @@ const tempmail = new TempMail();
 const tempmail = new TempMail("24-number id", "32-character token");
 ```
 
+### Types
+
+Email:
+```ts
+type Email = {
+    from: string,
+    to: string,
+    subject: string,
+    body: string,
+    html: string | null, //only if the email is HTML
+    date: number, //date in unix millis
+    ip: string, //IP address of sender
+}
+```
+
+Inbox:
+```ts
+type Inbox = {
+    address: string, //address of inbox
+    token: string, //token to use for checkInbox
+}
+```
+
 ### Create inbox
 
 To create an inbox:
@@ -44,15 +67,18 @@ tempmail.createInbox().then(inbox => {
     console.log(`Inbox: ${inbox.address} with a token of ${inbox.token}`);
 });
 
+//Or as async
+const inbox: Inbox = await tempmail.createInbox();
+
 //there are some advanced options as well
 
 //whether or not to create a community address
-const community = false;
+const community = true;
 tempmail.createInbox(community);
 
 
-//or to use a custom domain
-const domain = "example.com";
+//or to use a specific domain
+const domain = "cringemonster.com";
 tempmail.createInbox(false, domain);
 ```
 
@@ -93,3 +119,28 @@ tempmail.checkCustomDomain("example.com", "token").then(emails => {
 You can obtain a token by visiting https://tempmail.lol/custom.html
 
 Custom domains will NOT alert you if the token is invalid.
+
+### Webhooks
+
+You can set up a webhook to be called when an email is received.
+
+```js
+tempmail.setWebhook("https://example.com/webhook").then(() => {
+    console.log("Webhook set!");
+});
+```
+
+You can also remove the webhook:
+
+```js
+tempmail.removeWebhook().then(() => {
+    console.log("Webhook removed!");
+});
+```
+
+This feature is only available to TempMail Ultra subscribers.  Any email created after setting the webhook will trigger the webhook.
+The email will not be returned in the `checkInbox` function.
+
+Failed webhooks will not be retried unless a 429 Too Many Requests error is returned.
+
+Webhooks will send data in a JSON format as an array of Email objects.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tempmail.lol",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "API to generate temporary email addresses.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/index.ts

@@ -33,10 +33,14 @@ export class TempMail {
         //check for errors
         if(raw.status === 402) { //no time left
             throw new Error("BananaCrumbs ID has no more time left.");
-        } else if(raw.status === 400 && this.bananacrumbs_id) { //invalid credentials
+        } else if(raw.status === 403 && this.bananacrumbs_id) { //invalid credentials
             throw new Error("Invalid BananaCrumbs credentials provided.");
+        } else if(raw.status === 414) {
+            throw new Error("The provided webhook URL was too long (max 128 characters).");
+        } else if(raw.status === 500) {
+            throw new Error("The server encountered an internal error: " + await raw.text());
         } else if(!raw.ok) { //other error
-            throw new Error(`An error occurred while attempting to fetch data from the API: ${await raw.text()}`);
+            throw new Error(`TempMail API error: [${raw.status}] - ${await raw.text()}`);
         }
 
         return await raw.json();
@@ -109,6 +113,21 @@ export class TempMail {
         return emails;
     }
 
+    /**
+     * Set the webhook for this account
+     * @param webhook_url {string} the webhook URL to use.
+     */
+    async setWebhook(webhook_url: string): Promise<void> {
+        return this.makeRequest(`/webhook/add/` + webhook_url);
+    }
+    
+    /**
+     * Remove a webhook from the account.
+     */
+    async removeWebhook(): Promise<void> {
+        return this.makeRequest(`/webhook/remove`);
+    }
+    
 }
 
 export {