chore: kickstart domain-check repository

README.md

@@ -24,11 +24,12 @@ $ yarn add @nodesecure/domain-check
 ## Usage example
 
 ```js
-import { main as domainCheck } from '@nodesecure/domain-check';
+import { whois, resolveMxRecords } from '@nodesecure/domain-check';
 
-const myDomain = 'bar.com';
+const myDomain = 'google.com';
 
-const domainInformations = await domainCheck(myDomain);
+const domainExpirationDate = await whois(myDomain);
+const mxRecords = await resolveMxRecords(myDomain);
 ```
 
 ## Contributors ✨

src/index.js

@@ -1,18 +1,8 @@
 import { whois } from "./domainExpirationDate.js";
 import { resolveMxRecords } from "./unregisteredMxRecords.js";
 
-export async function main(domain) {
-  if (!domain) {
-    throw new Error("Domain is required");
-  }
+export {
+  whois,
+  resolveMxRecords
+};
 
-  const domainExpirationDate = await whois(domain);
-  const mxRecordsUnregistered = await resolveMxRecords(domain);
-
-  return {
-    domainExpirationDate,
-    mxRecordsUnregistered
-  };
-}
-
-main().catch((err) => console.error(err));

src/unregisteredMxRecords.js

@@ -1,4 +1,4 @@
-import dns from "dns/promises";
+import dns from "node:dns/promises";
 
 export async function resolveMxRecords(domain) {
   const mxRecords = await dns.resolveMx(domain)
@@ -7,7 +7,10 @@ export async function resolveMxRecords(domain) {
         : err.message));
 
   if (mxRecords instanceof Error) {
-    return mxRecords.message;
+    return {
+      error: mxRecords.message,
+      context: mxRecords
+    };
   }
 
   return mxRecords.map(({ exchange }) => exchange);

test/index.js

@@ -1,7 +1,44 @@
 // Import Third-party Dependencies
 import test from "tape";
 
-test("should pass", (t) => {
-  t.pass();
+// Import Internal Dependencies
+import { whois, resolveMxRecords } from "../src/index.js";
+
+// MX OK
+test("Given a valid domain, this test should pass", async(t) => {
+  // Given
+  const domain = "google.com";
+
+  // When
+  const mxRecords = await resolveMxRecords(domain);
+
+  // Then
+  t.equal(mxRecords[0], "smtp.google.com");
+  t.end();
+});
+
+// MX KO
+test("Given an invalid domain, this test should not pass", async(t) => {
+  // Given
+  const domain = "aaa";
+
+  // When
+  const mxRecords = await resolveMxRecords(domain);
+
+  // Then
+  t.equal(mxRecords.error, `queryMx ENODATA ${domain}`);
+  t.end();
+});
+
+// Socket
+test("Given a valid domain, this test should pass", async(t) => {
+  // Given
+  const domain = "google.com";
+
+  // When
+  const domainExpirationDate = await whois(domain);
+
+  // Then
+  t.isNot(domainExpirationDate, "");
   t.end();
 });