@visulima/disposable-email-domains 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -1,94 +1,94 @@
 /**
-* Options accepted by the lookup helpers.
-*/
+ * Options accepted by the lookup helpers.
+ */
 interface DisposableEmailOptions {
   /**
-  * Domains that should never be treated as disposable, even if they appear in
-  * the built-in list. Checked before the disposable list, with the same
-  * wildcard/subdomain semantics (so `gmail.com` also allowlists
-  * `mail.gmail.com`). Useful as a runtime escape hatch for legitimate
-  * customer domains that leak into upstream sources.
-  */
+   * Domains that should never be treated as disposable, even if they appear in
+   * the built-in list. Checked before the disposable list, with the same
+   * wildcard/subdomain semantics (so `gmail.com` also allowlists
+   * `mail.gmail.com`). Useful as a runtime escape hatch for legitimate
+   * customer domains that leak into upstream sources.
+   */
   allowDomains?: Set<string>;
   /**
-  * Additional disposable domains to check on top of the built-in list. These
-  * are matched with the same wildcard/subdomain semantics as the built-in
-  * list (so a custom `custom-disposable.com` also matches
-  * `sub.custom-disposable.com`).
-  */
+   * Additional disposable domains to check on top of the built-in list. These
+   * are matched with the same wildcard/subdomain semantics as the built-in
+   * list (so a custom `custom-disposable.com` also matches
+   * `sub.custom-disposable.com`).
+   */
   customDomains?: Set<string>;
 }
 /**
-* Injects the disposable-domain list explicitly, bypassing the Node filesystem
-* loader entirely.
-*
-* Call this once at startup in edge/browser/bundled runtimes (Cloudflare Workers,
-* Next.js middleware/edge, Deno, etc.) where `node:fs` is unavailable or the dist
-* file path cannot be resolved. The recommended source is the statically
-* importable list:
-*
-* ```ts
-* import { setDomains } from "@visulima/disposable-email-domains";
-* import domains from "@visulima/disposable-email-domains/domains" with { type: "json" };
-*
-* setDomains(domains);
-* ```
-* @param domains Array of disposable domain strings.
-*/
+ * Injects the disposable-domain list explicitly, bypassing the Node filesystem
+ * loader entirely.
+ *
+ * Call this once at startup in edge/browser/bundled runtimes (Cloudflare Workers,
+ * Next.js middleware/edge, Deno, etc.) where `node:fs` is unavailable or the dist
+ * file path cannot be resolved. The recommended source is the statically
+ * importable list:
+ *
+ * ```ts
+ * import { setDomains } from "@visulima/disposable-email-domains";
+ * import domains from "@visulima/disposable-email-domains/domains" with { type: "json" };
+ *
+ * setDomains(domains);
+ * ```
+ * @param domains Array of disposable domain strings.
+ */
 declare const setDomains: (domains: ReadonlyArray<string>) => void;
 /**
-* Eagerly loads the built-in disposable-domain list (Node runtimes).
-*
-* Calling this at process/module startup moves the synchronous read + parse of
-* the multi-megabyte `dist/domains.json` off the request hot path, so the first
-* `isDisposableEmail` call no longer stalls the event loop mid-request. It is a
-* thin async wrapper around the same lazy loader, so calling it is optional and
-* idempotent.
-* @returns A promise that resolves once the list is loaded (or the load failed).
-*/
+ * Eagerly loads the built-in disposable-domain list (Node runtimes).
+ *
+ * Calling this at process/module startup moves the synchronous read + parse of
+ * the multi-megabyte `dist/domains.json` off the request hot path, so the first
+ * `isDisposableEmail` call no longer stalls the event loop mid-request. It is a
+ * thin async wrapper around the same lazy loader, so calling it is optional and
+ * idempotent.
+ * @returns A promise that resolves once the list is loaded (or the load failed).
+ */
 declare const preload: () => Promise<void>;
 /**
-* Reports whether the built-in disposable-domain list is currently loaded.
-*
-* Returns `false` when the list has not been accessed yet, or when loading
-* failed (missing/corrupt `dist/domains.json`). Callers that treat disposable
-* detection as a security control can use this to detect the degraded
-* fail-open state instead of silently allowing every address.
-* @returns True if the built-in list is loaded and non-degraded.
-*/
+ * Reports whether the built-in disposable-domain list is currently loaded.
+ *
+ * Returns `false` when the list has not been accessed yet, or when loading
+ * failed (missing/corrupt `dist/domains.json`). Callers that treat disposable
+ * detection as a security control can use this to detect the degraded
+ * fail-open state instead of silently allowing every address.
+ * @returns True if the built-in list is loaded and non-degraded.
+ */
 declare const isListLoaded: () => boolean;
 /**
-* Extracts and validates the domain from an email address.
-* @param email The email address to extract domain from.
-* @returns The normalized (lowercased, trimmed) domain string, or undefined if invalid.
-*/
+ * Extracts and validates the domain from an email address.
+ * @param email The email address to extract domain from.
+ * @returns The normalized (lowercased, trimmed) domain string, or undefined if invalid.
+ */
 declare const extractDomain: (email: string) => string | undefined;
 /**
-* Checks if a bare domain is disposable.
-*
-* Supports wildcard matching by checking parent domains (e.g.,
-* `subdomain.33mail.com` matches `33mail.com`) for the built-in list, custom
-* domains, and allowlisted domains alike.
-*
-* Useful when you already have a bare domain (from an MX lookup or a parsed
-* signup form) and do not want to fabricate an `x@domain` address.
-* @param domain The domain to check (case-insensitive).
-* @param options Either a Set of additional disposable domains or a `DisposableEmailOptions` object.
-* @returns True if the domain is disposable, false otherwise.
-*/
+ * Checks if a bare domain is disposable.
+ *
+ * Supports wildcard matching by checking parent domains (e.g.,
+ * `subdomain.33mail.com` matches `33mail.com`) for the built-in list, custom
+ * domains, and allowlisted domains alike.
+ *
+ * Useful when you already have a bare domain (from an MX lookup or a parsed
+ * signup form) and do not want to fabricate an `x@domain` address.
+ * @param domain The domain to check (case-insensitive).
+ * @param options Either a Set of additional disposable domains or a `DisposableEmailOptions` object.
+ * @returns True if the domain is disposable, false otherwise.
+ */
 declare const isDisposableDomain: (domain: string, options?: Set<string> | DisposableEmailOptions) => boolean;
 /**
-* Checks if an email address is from a disposable email service.
-* @param email The email address to check.
-* @param options Either a Set of additional disposable domains, or a `DisposableEmailOptions` object with `allowDomains`/`customDomains`.
-* @returns True if the email is from a disposable domain, false otherwise.
-*/
+ * Checks if an email address is from a disposable email service.
+ * @param email The email address to check.
+ * @param options Either a Set of additional disposable domains, or a `DisposableEmailOptions` object with `allowDomains`/`customDomains`.
+ * @returns True if the email is from a disposable domain, false otherwise.
+ */
 declare const isDisposableEmail: (email: string, options?: Set<string> | DisposableEmailOptions) => boolean;
 /**
-* Checks multiple email addresses at once.
-* @param emails Array of email addresses to check.
-* @param options Either a Set of additional disposable domains, or a `DisposableEmailOptions` object with `allowDomains`/`customDomains`.
-* @returns Map of email to boolean indicating if it's disposable.
-*/
+ * Checks multiple email addresses at once.
+ * @param emails Array of email addresses to check.
+ * @param options Either a Set of additional disposable domains, or a `DisposableEmailOptions` object with `allowDomains`/`customDomains`.
+ * @returns Map of email to boolean indicating if it's disposable.
+ */
 declare const areDisposableEmails: (emails: string[], options?: Set<string> | DisposableEmailOptions) => Map<string, boolean>;
 export { type DisposableEmailOptions, areDisposableEmails, extractDomain, isDisposableDomain, isDisposableEmail, isListLoaded, preload, setDomains };

package/dist/index.js

@@ -1 +1 @@
-import{createRequire as m}from"node:module";const p=m(import.meta.url),r=typeof globalThis<"u"&&typeof globalThis.process<"u"?globalThis.process:process,u=e=>{if(typeof r<"u"&&r.versions&&r.versions.node){const[t,s]=r.versions.node.split(".").map(Number);if(t>22||t===22&&s>=3||t===20&&s>=16)return r.getBuiltinModule(e)}return p(e)},{readFileSync:_}=u("node:fs"),{dirname:h,join:y}=u("node:path"),{fileURLToPath:b}=u("node:url"),g=/\.$/;let n,d=!1,c=!1;const w=b(import.meta.url),j=h(w),v=()=>{try{const e=y(j,"..","dist","domains.json"),t=_(e,"utf8"),s=JSON.parse(t);return Array.isArray(s)?s:[]}catch(e){c||(c=!0,console.warn("[@visulima/disposable-email-domains] Failed to load dist/domains.json; disposable email detection is disabled.",e));return}},f=()=>{if(n===void 0){const e=v();if(e===void 0)return new Set;n=new Set(e),d=!0}return n},T=e=>{n=new Set(e),d=!0,c=!1},q=async()=>{await Promise.resolve(),f()},E=()=>d,D=e=>{if(!e||typeof e!="string")return;const t=e.toLowerCase().trim(),s=t.lastIndexOf("@");return s===-1||s===0||s===t.length-1?void 0:t.slice(s+1).replace(g,"")||void 0},S=e=>e instanceof Set?{customDomains:e}:e??{},l=(e,t,s)=>{if(s.has(e))return!0;for(let o=1;o<t.length;o+=1)if(s.has(t.slice(o).join(".")))return!0;return!1},L=(e,t)=>{if(!e||typeof e!="string")return!1;const{allowDomains:s,customDomains:o}=S(t),i=e.toLowerCase().trim(),a=i.split(".");return s&&s.size>0&&l(i,a,s)?!1:o&&o.size>0&&l(i,a,o)?!0:l(i,a,f())},x=(e,t)=>{const s=D(e);return s?L(s,t):!1},M=(e,t)=>{const s=new Map;for(const o of e)s.set(o,x(o,t));return s};export{M as areDisposableEmails,D as extractDomain,L as isDisposableDomain,x as isDisposableEmail,E as isListLoaded,q as preload,T as setDomains};
+import{createRequire as m}from"node:module";let p;const _=e=>(p??=m(import.meta.url))(e),r=typeof globalThis<"u"&&typeof globalThis.process<"u"?globalThis.process:process,u=e=>{if(typeof r<"u"&&r.versions&&r.versions.node){const[t,s]=r.versions.node.split(".").map(Number);if(t>22||t===22&&s>=3||t===20&&s>=16)return r.getBuiltinModule(e)}return _(e)},{readFileSync:h}=u("node:fs"),{dirname:y,join:w}=u("node:path"),{fileURLToPath:j}=u("node:url"),b=/\.$/;let n,d=!1,c=!1;const g=j(import.meta.url),v=y(g),D=()=>{try{const e=w(v,"..","dist","domains.json"),t=h(e,"utf8"),s=JSON.parse(t);if(!Array.isArray(s))throw new TypeError("dist/domains.json did not contain a JSON array.");return s}catch(e){c||(c=!0,console.warn("[@visulima/disposable-email-domains] Failed to load dist/domains.json; disposable email detection is disabled.",e));return}},f=()=>{if(n===void 0){const e=D();if(e===void 0)return new Set;n=new Set(e),d=!0}return n},E=e=>{n=new Set(e),d=!0,c=!1},O=async()=>{await Promise.resolve(),f()},P=()=>d,S=e=>{if(!e||typeof e!="string")return;const t=e.toLowerCase().trim(),s=t.lastIndexOf("@");return s===-1||s===0||s===t.length-1?void 0:t.slice(s+1).replace(b,"")||void 0},L=e=>e instanceof Set?{customDomains:e}:e??{},l=(e,t,s)=>{if(s.has(e))return!0;for(let o=1;o<t.length;o+=1)if(s.has(t.slice(o).join(".")))return!0;return!1},T=(e,t)=>{if(!e||typeof e!="string")return!1;const{allowDomains:s,customDomains:o}=L(t),i=e.toLowerCase().trim(),a=i.split(".");return s&&s.size>0&&l(i,a,s)?!1:o&&o.size>0&&l(i,a,o)?!0:l(i,a,f())},q=(e,t)=>{const s=S(e);return s?T(s,t):!1},R=(e,t)=>{const s=new Map;for(const o of e)s.set(o,q(o,t));return s};export{R as areDisposableEmails,S as extractDomain,T as isDisposableDomain,q as isDisposableEmail,P as isListLoaded,O as preload,E as setDomains};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/disposable-email-domains",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A regularly updated list of disposable and temporary email domains.",
   "keywords": [
     "disposable-email",
@@ -43,7 +43,7 @@
     },
     "./domains": {
       "types": "./dist/domains.d.ts",
-      "default": "./dist/domains.json"
+      "default": "./dist/domains.js"
     },
     "./package.json": "./package.json"
   },