fakeout 1.0.1 → 1.0.2

package/README.md

@@ -1,51 +1,197 @@
+<div align="center">
+
 # fakeout
 
-[![npm version](https://img.shields.io/npm/v/fakeout.svg)](https://www.npmjs.com/package/fakeout)
-[![license](https://img.shields.io/npm/l/fakeout.svg)](./LICENSE)
+**Catch disposable emails before they catch you.**
+
+[![npm version](https://img.shields.io/npm/v/fakeout?color=cb3837&label=npm&logo=npm)](https://www.npmjs.com/package/fakeout)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/fakeout?color=364fc7&label=size)](https://bundlephobia.com/package/fakeout)
+[![license](https://img.shields.io/github/license/Manas1820/fakeout?color=22863a)](./LICENSE)
+[![CI](https://img.shields.io/github/actions/workflow/status/Manas1820/fakeout/release.yml?label=CI&logo=github)](https://github.com/Manas1820/fakeout/actions)
+
+A tiny, zero-dependency library that detects disposable (burner) email domains.
+The blocklist auto-updates daily — no manual maintenance required.
+
+[Install](#install) · [Usage](#usage) · [API](#api) · [Staying up to date](#staying-up-to-date) · [How it works](#how-it-works)
+
+</div>
+
+---
 
-Detect disposable (burner) email domains. Zero dependencies, auto-updated dataset.
+## Why?
+
+Disposable email services like Mailinator, Guerrilla Mail, and thousands of others let users sign up with throwaway addresses. This means fake accounts, abused trials, and wasted resources. **fakeout** lets you detect them with a single function call.
+
+- **5,000+ domains** tracked and growing
+- **Zero dependencies** — just a `Set` lookup
+- **Auto-updated** — new domains added daily via CI
+- **TypeScript-first** — full type safety and JSDoc
 
 ## Install
 
 ```bash
+# npm
 npm install fakeout
+
+# pnpm
+pnpm add fakeout
+
+# yarn
+yarn add fakeout
 ```
 
+> Requires Node.js 18+
+
 ## Usage
 
 ```ts
 import { isDisposableEmail, isDisposableDomain, getDisposableDomains } from "fakeout";
 
-isDisposableEmail("user@mailinator.com"); // true
-isDisposableEmail("user@gmail.com");      // false
-isDisposableEmail("not-an-email");        // false
+// Check a full email address
+isDisposableEmail("user@mailinator.com");  // true
+isDisposableEmail("user@gmail.com");       // false
+isDisposableEmail("not-an-email");         // false (invalid → false)
 
-isDisposableDomain("guerrillamail.com");  // true
-isDisposableDomain("outlook.com");        // false
+// Check a bare domain
+isDisposableDomain("guerrillamail.com");   // true
+isDisposableDomain("outlook.com");         // false
 
-const domains = getDisposableDomains();   // string[] — sorted, ~5000+ entries
+// Get the full list
+const domains = getDisposableDomains();    // string[] — sorted, ~5000+ entries
+```
+
+### Common patterns
+
+**Express middleware:**
+
+```ts
+import { isDisposableEmail } from "fakeout";
+
+app.post("/signup", (req, res) => {
+  if (isDisposableEmail(req.body.email)) {
+    return res.status(422).json({ error: "Disposable emails are not allowed" });
+  }
+  // proceed with signup...
+});
+```
+
+**Form validation:**
+
+```ts
+import { isDisposableEmail } from "fakeout";
+
+function validateEmail(email: string): string | null {
+  if (isDisposableEmail(email)) {
+    return "Please use a permanent email address";
+  }
+  return null;
+}
 ```
 
 ## API
 
 ### `isDisposableEmail(email: string): boolean`
 
-Returns `true` if the email's domain is a known disposable email provider. Returns `false` for invalid emails.
+Checks if an email address belongs to a known disposable provider.
+
+| Input | Output |
+|-------|--------|
+| `"user@mailinator.com"` | `true` |
+| `"user@gmail.com"` | `false` |
+| `"bad-input"` | `false` |
+
+Returns `false` for invalid emails rather than throwing.
 
 ### `isDisposableDomain(domain: string): boolean`
 
-Returns `true` if the bare domain is in the disposable blocklist. Handles uppercase and whitespace.
+Checks if a bare domain is in the blocklist. Handles uppercase and extra whitespace.
+
+| Input | Output |
+|-------|--------|
+| `"guerrillamail.com"` | `true` |
+| `"  YOPMAIL.COM  "` | `true` |
+| `"gmail.com"` | `false` |
 
 ### `getDisposableDomains(): string[]`
 
-Returns a sorted array of all known disposable domains. Each call returns a new copy.
+Returns a sorted array of all known disposable domains. Each call returns a fresh copy, so mutations won't affect the internal dataset.
+
+## Staying up to date
+
+Domain updates are published as **patch** releases (e.g. `1.0.1` → `1.0.2`), so the default npm semver range already keeps you current:
+
+```bash
+npm install fakeout   # saves "^1.x.x" — automatically resolves to the latest patch
+```
+
+Every `npm install` (or `pnpm install` / `yarn install`) in a fresh CI environment or after deleting your lockfile will pull the newest patch. To update an existing lockfile:
+
+```bash
+npm update fakeout
+```
+
+### Automated dependency updates
+
+For hands-free updates, add [Renovate](https://github.com/renovatebot/renovate) or [Dependabot](https://docs.github.com/en/code-security/dependabot) to your repo. They'll open PRs whenever a new fakeout version is published.
+
+<details>
+<summary>Example Dependabot config</summary>
+
+```yaml
+# .github/dependabot.yml
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: daily
+```
+
+</details>
 
 ## How it works
 
-The domain dataset is sourced from [disposable-email-domains](https://github.com/disposable-email-domains/disposable-email-domains) and compiled into a `Set<string>` at build time — no file I/O at runtime.
+```
+                    ┌─────────────────────────┐
+                    │  Upstream blocklist      │
+                    │  (disposable-email-      │
+                    │   domains/disposable-    │
+                    │   email-domains)         │
+                    └────────────┬────────────┘
+                                 │ daily cron
+                                 ▼
+                    ┌─────────────────────────┐
+                    │  sync-domains script    │
+                    │  fetch → clean → hash   │
+                    │  → compare → generate   │
+                    └────────────┬────────────┘
+                                 │ if changed
+                                 ▼
+                    ┌─────────────────────────┐
+                    │  semantic-release       │
+                    │  patch bump → publish   │
+                    │  to npm                 │
+                    └─────────────────────────┘
+```
+
+1. A GitHub Actions cron job runs daily
+2. It fetches the latest domain list from upstream
+3. If the list changed (SHA-256 comparison), tests run and a new **patch version** is auto-published to npm
+4. If nothing changed, the job exits silently
+
+The domain list is compiled into a `ReadonlySet<string>` at build time — **zero file I/O at runtime**, just a fast hash lookup.
+
+## Credits
+
+The disposable domain dataset is sourced from the community-maintained [disposable-email-domains](https://github.com/disposable-email-domains/disposable-email-domains) project. Huge thanks to all its contributors for keeping the list comprehensive and up to date.
+
+## Contributing
+
+Contributions are welcome! If you find a domain that should be blocked:
 
-A GitHub Actions cron job syncs the upstream list daily. When domains change, tests run automatically and a new patch version is published to npm via [semantic-release](https://github.com/semantic-release/semantic-release).
+- For **new disposable domains**, please submit them upstream to [disposable-email-domains](https://github.com/disposable-email-domains/disposable-email-domains/issues) — they'll be picked up automatically on the next sync
+- For **bugs or feature requests** in fakeout itself, [open an issue](https://github.com/Manas1820/fakeout/issues)
 
 ## License
 
-MIT
+[MIT](./LICENSE) — use it however you like.

package/dist/domains.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"domains.d.ts","sourceRoot":"","sources":["../src/domains.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC,MAAM,CAmlKjD,CAAC"}
+{"version":3,"file":"domains.d.ts","sourceRoot":"","sources":["../src/domains.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC,MAAM,CAkuKjD,CAAC"}