smtp-address-parser - npm Package Compare versions

Comparing version 1.0.4 to 1.0.6

dist/lib/index.d.ts

 export declare function parse(address: string): any;
+/**
+ * Apply common address normalization rules, strip "+something" and
+ * remove interior "."s in a dotString. Fold case.
+ */
+export declare function normalize(address: string): string;

dist/lib/index.js

@@ -1,2 +0,2 @@
-'use strict';
+"use strict";
 var __importDefault = (this && this.__importDefault) || function (mod) {
@@ -6,7 +6,7 @@ return (mod && mod.__esModule) ? mod : { "default": mod };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parse = void 0;
+exports.normalize = exports.parse = void 0;
 // const punycode = require('punycode');
-const nearley = require('nearley');
+const nearley = require("nearley");
 const grammar_1 = __importDefault(require("./grammar"));
-grammar_1.default.ParserStart = 'Mailbox';
+grammar_1.default.ParserStart = "Mailbox";
 const grammar = nearley.Grammar.fromCompiled(grammar_1.default);
@@ -23,2 +23,31 @@ // <https://tools.ietf.org/html/rfc5321#section-4.1.2>
 exports.parse = parse;
+/**
+ * Apply common address normalization rules, strip "+something" and
+ * remove interior "."s in a dotString. Fold case.
+ */
+function normalize(address) {
+    const a = parse(address);
+    const domain = (function () {
+        if (a.domainPart.AddressLiteral)
+            return a.domainPart.AddressLiteral;
+        return a.domainPart.DomainName.toLowerCase();
+    })();
+    const local = (function () {
+        if (a.localPart.QuotedString) {
+            // Should normalize quoted string.
+            return a.localPart.QuotedString;
+        }
+        const tagless = (function () {
+            const plus_loc = a.localPart.DotString.indexOf("+");
+            if (plus_loc === -1) {
+                return a.localPart.DotString;
+            }
+            return a.localPart.DotString.substr(0, plus_loc);
+        })();
+        const dotless = tagless.replace(/\./g, "");
+        return dotless.toLowerCase();
+    })();
+    return `${local}@${domain}`;
+}
+exports.normalize = normalize;
 //# sourceMappingURL=index.js.map

dist/test/addresses.test.d.ts

 declare const assert: any;
-declare const parse: any;
+declare const normalize: any, parse: any;
 declare function _check(address: string, dot?: string, quote?: string, name?: string, addr?: string): void;

dist/test/addresses.test.js

 "use strict";
 const assert = require("assert");
-const { parse } = require("../lib/index.js");
+const { normalize, parse } = require("../lib/index.js");
 function _check(address, dot, quote, name, addr) {
@@ -58,3 +58,3 @@ const a = parse(address);
     });
-    it('Another IPv6 address literal', function () {
+    it("Another IPv6 address literal", function () {
         _check("simple@[IPv6:68:1c:a2:12:4a:e5]", "simple", undefined, undefined, "[IPv6:68:1c:a2:12:4a:e5]");
@@ -68,3 +68,3 @@ });
     });
-    it('General address literal', function () {
+    it("General address literal", function () {
         _check("simple@[tag:Can-Be-Anything]", "simple", undefined, undefined, "[tag:Can-Be-Anything]");
@@ -162,2 +162,22 @@ });
 });
+describe("test normalize", function () {
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+});
 //# sourceMappingURL=addresses.test.js.map

lib/index.ts

@@ -1,8 +0,8 @@
-'use strict';
+"use strict";
 
 // const punycode = require('punycode');
-const nearley  = require('nearley');
+const nearley = require("nearley");
 
-import { default as myGrammar } from './grammar';
-myGrammar.ParserStart = 'Mailbox';
+import { default as myGrammar } from "./grammar";
+myGrammar.ParserStart = "Mailbox";
 const grammar = nearley.Grammar.fromCompiled(myGrammar);
@@ -22,1 +22,29 @@
 }
+
+/**
+ * Apply common address normalization rules, strip "+something" and
+ * remove interior "."s in a dotString. Fold case.
+ */
+export function normalize(address: string) {
+    const a = parse(address);
+    const domain = (function () {
+        if (a.domainPart.AddressLiteral) return a.domainPart.AddressLiteral;
+        return a.domainPart.DomainName.toLowerCase();
+    })();
+    const local = (function () {
+        if (a.localPart.QuotedString) {
+            // Should normalize quoted string.
+            return a.localPart.QuotedString;
+        }
+        const tagless = (function () {
+            const plus_loc = a.localPart.DotString.indexOf("+");
+            if (plus_loc === -1) {
+                return a.localPart.DotString;
+            }
+            return a.localPart.DotString.substr(0, plus_loc);
+        })();
+        const dotless = tagless.replace(/\./g, "");
+        return dotless.toLowerCase();
+    })();
+    return `${local}@${domain}`;
+}

package.json

 {
   "name": "smtp-address-parser",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Parse an SMTP (RFC-5321) address",
@@ -5,0 +5,0 @@ "main": "dist/lib/index.js",

README.md

@@ -24,2 +24,2 @@ # smtp-address-parser
 “To the maximum extent possible, implementation techniques that impose
-no limits on the length of these objects should be used.”
+no limits on the length of these objects should be used.”

test/addresses.test.ts

@@ -5,3 +5,3 @@ "use strict";
 
-const { parse } = require("../lib/index.js");
+const { normalize, parse } = require("../lib/index.js");
 
@@ -70,3 +70,3 @@ function _check(address: string, dot?: string, quote?: string, name?: string, addr?: string) {
     });
-    it('Another IPv6 address literal', function () {
+    it("Another IPv6 address literal", function () {
         _check("simple@[IPv6:68:1c:a2:12:4a:e5]", "simple", undefined, undefined, "[IPv6:68:1c:a2:12:4a:e5]");
@@ -80,3 +80,3 @@ });
     });
-    it('General address literal', function () {
+    it("General address literal", function () {
         _check("simple@[tag:Can-Be-Anything]", "simple", undefined, undefined, "[tag:Can-Be-Anything]");
@@ -175,1 +175,22 @@ });
 });
+
+describe("test normalize", function () {
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+    it("[e-mail]", function () {
+        assert.equal(normalize("[e-mail]"), "[e-mail]");
+    });
+});

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

25

increased by4.17%

Worsened metrics

Total package byte prevSize

63784

decreased by-10.9%

Number of package files

18

decreased by-18.18%

Lines of code

710

decreased by-7.55%

No dependency changes