Email Sentry npm packages used to validate, check disposable emails and normalize email to use in the production

Author: ameghcoder

.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: ⬇️ Checkout code
+        uses: actions/checkout@v3
+
+      - name: ⚙️ Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: 📦 Install dependencies
+        run: npm install
+
+      - name: 🧪 Run tests
+        run: npm run test

.gitignore

@@ -0,0 +1,31 @@
+# Node modules
+node_modules/
+
+# Build output
+dist/
+
+# Test coverage
+coverage/
+
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# OS-specific files
+.DS_Store
+Thumbs.db
+
+# Env files (if used later)
+.env
+.env.*
+
+# TypeScript cache
+*.tsbuildinfo
+
+# IDE/editor files
+.vscode/
+.idea/
+
+# GitHub workflow logs (optional)
+*.log

LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 Yashraj Yadav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,99 @@
+# 📧 email-sentry
+
+[![Author](https://img.shields.io/badge/Author-@ameghcoder-blue?logo=github)](https://github.com/ameghcoder)
+[![NPM version](https://img.shields.io/npm/v/email-sentry?color=blue&label=npm)](https://www.npmjs.com/package/email-sentry)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)
+[![Tests](https://github.com/yourusername/email-sentry/actions/workflows/test.yml/badge.svg)](https://github.com/yourusername/email-sentry/actions/workflows/test.yml)
+
+---
+
+`email-sentry` is a lightweight and production-ready utility to:
+
+- ✅ Validate email format
+- 🚫 Detect disposable/temp email domains
+- 📩 Normalize Gmail aliases (e.g. `user+promo@gmail.com` → `user@gmail.com`)
+
+---
+
+## ✨ Features
+
+- ✅ Simple API
+- 📦 Tiny & dependency-light
+- 🛡️ Helps prevent spam/bots during user signups
+- 🔍 Supports thousands of disposable email providers
+- 🔧 Built in TypeScript (fully typed)
+
+---
+
+## 📦 Installation
+
+```bash
+npm install email-sentry
+# or
+yarn add email-sentry
+```
+
+---
+
+## 🚀 Usage
+
+```ts
+import { emailSentry } from "email-sentry";
+
+const result = emailSentry("user+promo@mailinator.com", {
+  validate: true,
+  checkDisposable: true,
+  normalizeGmailAliases: true,
+});
+
+console.log(result);
+/*
+{
+  inputEmail: 'user+promo@mailinator.com',
+  success: true,
+  isValid: true,
+  isDisposable: true,
+  outputEmail: 'user@gmail.com'
+}
+*/
+```
+
+---
+
+## ⚙️ Options
+
+| Option                | Type      | Description                                       |
+|------------------------|-----------|---------------------------------------------------|
+| `validate`             | `boolean` | Validates email using the powerful email validator package   |
+| `checkDisposable`      | `boolean` | Checks against known disposable email domains, contains 5000+ disposable domains data   |
+| `normalizeGmailAliases` | `boolean` | Removes `+something` from Gmail addresses and prevent the same email address to use to create account         |
+
+---
+
+## 🧪 Testing
+
+Run all tests with:
+
+```bash
+npm test
+```
+
+Or watch mode:
+
+```bash
+npm run test:watch
+```
+
+---
+
+## 📄 License
+
+MIT © [Yashraj](https://github.com/ameghcoder)
+
+---
+
+## 🙋‍♂️ Author
+
+Made with ❤️ by [**Yashraj**](https://github.com/ameghcoder)
+
+If you like this project, consider ⭐️ starring the repo or sharing it. It helps a lot!