Add axios, Use async/await Add JSDoc comments and Remove request

Author: a-rustacean

.gitignore

@@ -1 +1,130 @@
-node_modules
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

README.md

@@ -1,25 +1,29 @@
-node-temp-mail
-===================
+# node-temp-mail
 
 Node wrapper for creating and fetching temporary, disposable emails, as well as their new messages.
 
-#### Installation
-```
+## Installation
+
+```shell
 npm install node-temp-mail
 ```
 
-#### Usage
-```
-var TempMail = require('node-temp-mail');
+## Usage
+
+```javascript
+const TempMail = require("node-temp-mail");
 
 // Let's create an address object so it can be accessed by the module.
-var address = new TempMail("testAddress");
+const address = new TempMail("testAddress");
 
 // We already have the address object, so now let's access it and get a list of the emails in a nice & neat json object.
-address.fetchEmails(function(err,body){
+address.fetchEmails((err, body) => {
   console.log(body);
 });
 
+// Or we can use the async/await syntax
+const body = await address.fetchEmails();
+
 // If for any reason you need to see the full temporary email address, you can use the following function.
-address.getAddress()
+address.getAddress();
 ```

index.js

@@ -1,70 +1,65 @@
-var request = require('request');
+const { default: axios } = require("axios");
+const nodify = require("./nodify");
 
-function buildJson(callback, label, currentJson, addressJson, currentIndex, finalIndex) {
-
-  request({
-    url: "https://www.1secmail.com/api/v1/?action=readMessage&login="+label+"&domain=1secmail.com&id="+addressJson[currentIndex].id,
-    json: true
-  }, function (error, response, body) {
-    if (error || response.statusCode !== 200) {
-      return callback(error || {statusCode: response.statusCode});
-    }
-    else {
-      var messageBody = {}
-      messageBody.from = body.from;
-      messageBody.timestamp = body.date;
-      messageBody.subject = body.subject;
-      messageBody.message = body.textBody;
-      currentJson.messages.push(messageBody);
-      if((currentIndex+1) < finalIndex){
-        buildJson(callback, label, currentJson, addressJson, (currentIndex+1), finalIndex);
-      }
-      else {
-        callback(null, currentJson);
-      }
-    }
-  });
-}
+/** @typedef {{ from: string, timestaml: string, subject: string, message: string }} */
+/** @typedef {{ address: string, messageCount: number, messages: Message[] }} EmailFetchResult */
 
 class TempMail {
+  /** @type {string} */
+  mailingAddressLabel;
+
+  /**
+   * create a new instance of TempMail
+   * @param {string} mailingAddressLabel mailing address label
+   */
   constructor(mailingAddressLabel) {
     this.mailingAddressLabel = mailingAddressLabel;
   }
 
-  fetchEmails(callback){
-    var isComplete = false;
-    var mailingAddressLabel = this.mailingAddressLabel;
-
-
-    request({
-      url: "https://www.1secmail.com/api/v1/?action=getMessages&login="+mailingAddressLabel+"&domain=1secmail.com",
-      json: true
-    }, function (error, response, body) {
-      if (error || response.statusCode !== 200) {
-        return callback(error || {statusCode: response.statusCode});
+  /**
+   * fetchs emails and returns it
+   * @returns {Promise<EmailFetchResult>}
+   */
+  async #fetchEmails() {
+    const httpResponse = await axios.get("https://www.1secmail.com/api/v1/?action=getMessages&login=" + this.mailingAddressLabel + "&domain=1secmail.com");
+    const data = httpResponse.data;
+    const messages = await Promise.all(data.map(async (email) => {
+      const mailHttpResponse = await axios.get("https://www.1secmail.com/api/v1/?action=readMessage&login=" + label + "&domain=1secmail.com&id=" + email.id);
+      const mailData = mailHttpResponse.data;
+      return {
+        from: mailData.from,
+        timestamp: mailData.date,
+        subject: mailData.subject,
+        message: mailData.textBody
       }
-      else {
-        response = {};
-        response.address = mailingAddressLabel + "@1secmail.com";
-        response.messageCount = body.length;
-        response.messages = [];
-        if(body.length > 0){
-          buildJson(callback, mailingAddressLabel, response, body, 0, body.length);
-        }
-        else {
-          callback(null, response);
-        }
-      }
-    });
-
+    }));
+    const res = {
+      address: this.mailingAddressLabel + "@1secmail.com",
+      messageCount: data.length,
+      messages
+    };
+    return res;
+  }
 
+  /**
+   * fetchs emails and calls the callback if not provided just returns a promise
+   * @param {import("./nodify").callback<EmailFetchResult, Error>} callback callback
+   * @returns {Promise<EmailFetchResult>}
+   */
+  fetchEmails(callback) {
+    return nodify(this.#fetchEmails(), callback);
   }
 
-  getAddress(){
-    var response = {};
-    response.address = this.mailingAddressLabel + "@1secmail.com";
-    return response;
+  /**
+   * returns the mailing address label
+   * @returns {{ address: string }}
+   */
+  getAddress() {
+    return {
+      address: this.mailingAddressLabel + "@1secmail.com"
+    }
   }
 }
 
 module.exports = TempMail;
+