@util.js/emails 0.41.5 → 0.41.7

package/package.json

@@ -8,6 +8,10 @@
     "@babel/runtime-corejs3 is required by files in the dist directory to ",
     "work in https://npm.runkit.com."
   ],
+  "files": [
+    "dist",
+    "index.js"
+  ],
   "keywords": [
     "email",
     "emails",
@@ -28,5 +32,5 @@
     "type": "git",
     "url": "https://github.com/creemama/utiljs/tree/master/packages/utiljs-emails"
   },
-  "version": "0.41.5"
+  "version": "0.41.7"
 }

package/lib/EmailHeaders.js

@@ -1,155 +0,0 @@
-"use strict";
-
-/**
- * Wrapper of email headers that makes header lookup easy.
- *
- * This class makes it so that the case of header names is not important.
- * For example, Gmail might use "In-Reply-To" whereas iCloud might use "In-reply-to".
- *
- * @public
- * @class
- */
-class EmailHeaders {
-  constructor(options) {
-    dependencies.set(this, options);
-  }
-
-  /**
-   * Returns the value of the Delivered-To header
-   *
-   * @return {undefined|string} The value of the Date header as a string or undefined
-   * @public
-   * @instance
-   * @function
-   */
-  deliveredTo() {
-    return this.get("delivered-to");
-  }
-
-  /**
-   * Returns the value of the Date header
-   *
-   * @return {undefined|string} The value of the Date header as a string or undefined
-   * @public
-   * @instance
-   * @function
-   */
-  date() {
-    return this.get("date");
-  }
-
-  /**
-   * Returns the value of the From header
-   *
-   * @return {undefined|string} The value of the From header as a string or undefined
-   * @public
-   * @instance
-   * @function
-   */
-  from() {
-    return this.get("from");
-  }
-
-  /**
-   * Returns the value of the given headerName
-   *
-   * @param {string} headerName The header to look up a value for
-   * @return {undefined|string} The value of the given header name as a string or undefined
-   * @throws {TypeError} If headerName does not have a toLowerCase function
-   * @public
-   * @instance
-   * @function
-   */
-  get(headerName) {
-    return lowercaseHeaderMap(this)[headerName.toLowerCase()];
-  }
-
-  /**
-   * Returns the value of the In-Reply-To header
-   *
-   * @return {undefined|string} The value of the In-Reply-To header as a string or undefined
-   * @public
-   * @instance
-   * @function
-   */
-  inReplyTo() {
-    return this.get("in-reply-to");
-  }
-
-  /**
-   * Returns the value of the Message-Id header
-   *
-   * @return {undefined|string} The value of the Message-Id header as a string or undefined
-   * @public
-   * @instance
-   * @function
-   */
-  messageId() {
-    return this.get("message-id");
-  }
-
-  /**
-   * Returns the value of the References header
-   *
-   * @return {undefined|string} The value of the References header as a string or undefined
-   * @public
-   * @instance
-   * @function
-   */
-  references() {
-    return this.get("references");
-  }
-
-  /**
-   * Returns the value of the Subject header
-   *
-   * @return {undefined|string} The value of the Subject header as a string or undefined
-   * @public
-   * @instance
-   * @function
-   */
-  subject() {
-    return this.get("subject");
-  }
-
-  /**
-   * Returns the value of the To header
-   *
-   * @return {undefined|string} The value of the To header as a string or undefined
-   * @public
-   * @instance
-   * @function
-   */
-  to() {
-    return this.get("to");
-  }
-
-  /**
-   * Returns a string listing the email-header names and values of this object
-   *
-   * @return {string} A string representation of this object
-   * @public
-   * @instance
-   * @function
-   */
-  toString() {
-    return "EmailHeaders " + json().stringify(headerMap(this), null, "  ");
-  }
-}
-
-module.exports = EmailHeaders;
-
-const dependencies = new WeakMap();
-function get(thiz, dependency) {
-  return dependencies.get(thiz)[dependency];
-}
-
-function headerMap(thiz) {
-  return get(thiz, "headerMap");
-}
-function json() {
-  return JSON;
-}
-function lowercaseHeaderMap(thiz) {
-  return get(thiz, "lowercaseHeaderMap");
-}

package/lib/Emails.js

@@ -1,71 +0,0 @@
-"use strict";
-
-/**
- * JavaScript utility methods for emails
- * @public
- * @class
- */
-class Emails {
-  /**
-   * Returns whether the given string is a valid email.
-   *
-   * The regular expression used to validate strings comes from a [W3C article]{@link https://www.w3.org/TR/2012/WD-html-markup-20120320/input.email.html}.
-   *
-   * @param {string} string The string to test
-   * @return {boolean} true if the given string is a valid email or false otherwise
-   * @public
-   * @instance
-   * @function
-   */
-  isValidEmail(string) {
-    return /^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/.test(
-      string,
-    );
-  }
-
-  /**
-   * Wraps the given nameValueArrayOfHeaders inside an object that makes email-header lookup easy.
-   *
-   * When using the returned object, you no longer have to worry about the case (e.g., "In-Reply-To" or "In-reply-to") of email headers.
-   *
-   * [googleapis]{@link https://www.npmjs.com/package/googleapis}'s interface to Gmail returns email headers as an array of name-value objects. The following is a sample:
-   * <pre>
-   * [ { name: 'Delivered-To', value: 'c@creemama.com' },
-   * ...
-   *   { name: 'Date', value: 'Tue, 10 Jul 2018 10:18:52 -0700' },
-   * ...
-   *   { name: 'To', value: 'Chris Topher <c@creemama.com>' } ]
-   * </pre>
-   *
-   * @param {Array} nameValueArrayOfHeaders An array of name-value objects containing email headers
-   * @return {EmailHeaders} A new {@link EmailHeaders} instance
-   * @throws {TypeError} If nameValueArrayOfHeaders is not an array-like object containing name-value objects
-   * @public
-   * @instance
-   * @function
-   */
-  wrapHeaders(nameValueArrayOfHeaders) {
-    const headerMap = {};
-    const lowercaseHeaderMap = {};
-    for (const header of nameValueArrayOfHeaders) {
-      headerMap[header.name] = header.value;
-      lowercaseHeaderMap[header.name.toLowerCase()] = header.value;
-    }
-    const EmailHeaders = requireEmailHeaders();
-    return new EmailHeaders({
-      headerMap,
-      lowercaseHeaderMap,
-    });
-  }
-}
-
-module.exports = Emails;
-
-const dependencies = {};
-
-function requireEmailHeaders() {
-  return (
-    dependencies.EmailHeaders ||
-    (dependencies.EmailHeaders = require("./EmailHeaders"))
-  );
-}

package/test/EmailsTest.js

@@ -1,73 +0,0 @@
-"use strict";
-
-const emails = require("..");
-const { expect } = require("chai");
-
-describe("Emails", () => {
-  describe("#isValidEmail(string)", () => {
-    it("should validate foo-bar.baz@example.com", () => {
-      expect(emails.isValidEmail("foo-bar.baz@example.com")).to.be.true;
-    });
-    it("should validate a@a", () => {
-      expect(emails.isValidEmail("a@a")).to.be.true;
-    });
-    it("should invalidate foo-bar.bazexample.com", () => {
-      expect(emails.isValidEmail("foo-bar.bazexample.com")).to.be.false;
-    });
-    it("should invalidate a@", () => {
-      expect(emails.isValidEmail("a@")).to.be.false;
-    });
-    it("should invalidate @b", () => {
-      expect(emails.isValidEmail("a@")).to.be.false;
-    });
-    it("should invalidate null", () => {
-      expect(emails.isValidEmail(null)).to.be.false;
-    });
-    it("should validate the array ['foo-bar.baz@example.com']", () => {
-      expect(emails.isValidEmail(["foo-bar.baz@example.com"])).to.be.true;
-    });
-    it("should invalidate the array ['foo-bar.baz@example.com', 'a@a']", () => {
-      expect(emails.isValidEmail(["foo-bar.baz@example.com", "a@a"])).to.be
-        .false;
-    });
-  });
-
-  describe("#wrapHeaders(nameValueArrayOfHeaders)", () => {
-    it("should return a valid EmailHeaders instance", () => {
-      const nameValueArrayOfHeaders = [
-        { name: "Delivered-To", value: "c@creemama.com" },
-        { name: "Date", value: "Tue, 10 Jul 2018 10:18:52 -0700" },
-        { name: "To", value: "Chris Topher <c@creemama.com>" },
-      ];
-
-      const headers = emails.wrapHeaders(nameValueArrayOfHeaders);
-
-      expect(headers.deliveredTo()).to.eql("c@creemama.com");
-      expect(headers.from()).to.be.undefined;
-      expect(headers.get("Date")).to.eql("Tue, 10 Jul 2018 10:18:52 -0700");
-      expect(headers.get("date")).to.eql("Tue, 10 Jul 2018 10:18:52 -0700");
-      expect(() => headers.get()).to.throw(TypeError);
-      expect(() => headers.get(null)).to.throw(TypeError);
-      expect(() => headers.get({})).to.throw(TypeError);
-      expect(() => headers.get(5)).to.throw(TypeError);
-      expect(headers.inReplyTo()).to.be.undefined;
-      expect(headers.messageId()).to.be.undefined;
-      expect(headers.references()).to.be.undefined;
-      expect(headers.subject()).to.be.undefined;
-      expect(headers.to()).to.eql("Chris Topher <c@creemama.com>");
-      expect(headers.toString()).to.eql(
-        "EmailHeaders {\n" +
-          '  "Delivered-To": "c@creemama.com",\n' +
-          '  "Date": "Tue, 10 Jul 2018 10:18:52 -0700",\n' +
-          '  "To": "Chris Topher <c@creemama.com>"\n' +
-          "}",
-      );
-    });
-    it("should throw a TypeError if nameValueArrayOfHeaders is not an array-like object containing name-value objects", () => {
-      expect(() => emails.wrapHeaders()).to.throw(TypeError);
-      expect(() => emails.wrapHeaders(null)).to.throw(TypeError);
-      expect(() => emails.wrapHeaders(5)).to.throw(TypeError);
-      expect(() => emails.wrapHeaders([0, "a", "b"])).to.throw(TypeError);
-    });
-  });
-});