@util.js/emails 0.41.6 → 0.41.8

package/dist/EmailHeaders.js

@@ -0,0 +1,178 @@
+"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
+ */
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+var _weakMap = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/weak-map"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/createClass"));
+var EmailHeaders = /*#__PURE__*/function () {
+  function EmailHeaders(options) {
+    (0, _classCallCheck2["default"])(this, EmailHeaders);
+    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
+   */
+  return (0, _createClass2["default"])(EmailHeaders, [{
+    key: "deliveredTo",
+    value: 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
+     */
+  }, {
+    key: "date",
+    value: 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
+     */
+  }, {
+    key: "from",
+    value: 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
+     */
+  }, {
+    key: "get",
+    value: 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
+     */
+  }, {
+    key: "inReplyTo",
+    value: 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
+     */
+  }, {
+    key: "messageId",
+    value: 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
+     */
+  }, {
+    key: "references",
+    value: 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
+     */
+  }, {
+    key: "subject",
+    value: 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
+     */
+  }, {
+    key: "to",
+    value: 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
+     */
+  }, {
+    key: "toString",
+    value: function toString() {
+      return "EmailHeaders " + json().stringify(headerMap(this), null, "  ");
+    }
+  }]);
+}();
+module.exports = EmailHeaders;
+var dependencies = new _weakMap["default"]();
+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/dist/Emails.js

@@ -0,0 +1,92 @@
+"use strict";
+
+/**
+ * JavaScript utility methods for emails
+ * @public
+ * @class
+ */
+var _sliceInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/slice");
+var _Array$from = require("@babel/runtime-corejs3/core-js-stable/array/from");
+var _Symbol = require("@babel/runtime-corejs3/core-js-stable/symbol");
+var _getIteratorMethod = require("@babel/runtime-corejs3/core-js/get-iterator-method");
+var _Array$isArray = require("@babel/runtime-corejs3/core-js-stable/array/is-array");
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/createClass"));
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof _Symbol && _getIteratorMethod(r) || r["@@iterator"]; if (!t) { if (_Array$isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { var _context; if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = _sliceInstanceProperty(_context = {}.toString.call(r)).call(_context, 8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? _Array$from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+var Emails = /*#__PURE__*/function () {
+  function Emails() {
+    (0, _classCallCheck2["default"])(this, Emails);
+  }
+  return (0, _createClass2["default"])(Emails, [{
+    key: "isValidEmail",
+    value:
+    /**
+     * 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
+     */
+    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
+     */
+  }, {
+    key: "wrapHeaders",
+    value: function wrapHeaders(nameValueArrayOfHeaders) {
+      var headerMap = {};
+      var lowercaseHeaderMap = {};
+      var _iterator = _createForOfIteratorHelper(nameValueArrayOfHeaders),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var header = _step.value;
+          headerMap[header.name] = header.value;
+          lowercaseHeaderMap[header.name.toLowerCase()] = header.value;
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      var EmailHeaders = requireEmailHeaders();
+      return new EmailHeaders({
+        headerMap: headerMap,
+        lowercaseHeaderMap: lowercaseHeaderMap
+      });
+    }
+  }]);
+}();
+module.exports = Emails;
+var dependencies = {};
+function requireEmailHeaders() {
+  return dependencies.EmailHeaders || (dependencies.EmailHeaders = require("./EmailHeaders"));
+}

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.6"
+  "version": "0.41.8"
 }

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);
-    });
-  });
-});