@emailverifier/sdk 0.1.1 → 0.1.2

package/README.md

@@ -1,88 +1,88 @@
-# Email Verifier SDK
-
-Offline email analysis, a typed client for [emailverifier.dev](https://emailverifier.dev), and a CLI in one package.
-
-The offline functions use bundled data and make no network requests. They can identify syntax problems, disposable providers, free mailbox providers, role addresses, and common provider typos. They cannot confirm whether a mailbox exists or will accept mail.
-
-## Install
-
-```bash
-npm install @emailverifier/sdk
-```
-
-Node.js 20 or newer is required. The package has no runtime dependencies and sends no telemetry.
-
-## Free offline analysis
-
-```ts
-import { analyzeEmail } from '@emailverifier/sdk/offline'
-
-const result = analyzeEmail('Support+Trial@Gmail.com')
-
-console.log(result.checks.syntax)
-console.log(result.checks.disposable)
-console.log(result.checks.freeProvider)
-console.log(result.checks.roleBased)
-console.log(result.suggestion)
-```
-
-The result intentionally has no `deliverable` field. DNS, SMTP recipient acceptance, and catch-all detection require the hosted API.
-
-You can also import focused helpers:
-
-```ts
-import {
-  isDisposableDomain,
-  isFreeEmailProvider,
-  isRoleAddress
-} from '@emailverifier/sdk/offline'
-```
-
-## Hosted verification
-
-Create a project at [emailverifier.dev](https://emailverifier.dev), then use its API key:
-
-```ts
-import { EmailVerifier } from '@emailverifier/sdk'
-
-const client = new EmailVerifier({
-  apiKey: process.env.EMAILVERIFIER_API_KEY!
-})
-
-const verification = await client.verify('hello@example.com')
-const domain = await client.checkDomain('example.com')
-const usage = await client.getUsage()
-```
-
-`verify` and `checkDomain` each use one project credit. `getUsage` does not use a credit. The client does not retry failed requests automatically.
-
-## CLI
-
-Run local analysis without an account or API key:
-
-```bash
-npx @emailverifier/sdk check hello@example.com
-npx @emailverifier/sdk check hello@example.com --json
-```
-
-Remote commands read the key from the environment. API keys are deliberately not accepted as command-line arguments because command histories and process lists can expose them.
-
-```bash
-export EMAILVERIFIER_API_KEY=ev_your_project_key
-
-npx @emailverifier/sdk verify hello@example.com
-npx @emailverifier/sdk domain example.com
-npx @emailverifier/sdk usage
-```
-
-Use `EMAILVERIFIER_BASE_URL` only when testing against a local or self-selected API origin.
-
-## Data updates
-
-The disposable-domain snapshot comes from [disposable/disposable-email-domains](https://github.com/disposable/disposable-email-domains) and includes additional maintained aliases. Its license is recorded in [THIRD_PARTY_NOTICES.md](./THIRD_PARTY_NOTICES.md).
-
-The scheduled GitHub workflow validates upstream data, runs the package checks, publishes a patch release, and commits the updated snapshot when the list changes. npm Trusted Publishing must be connected to this repository before that workflow can publish.
-
-## License
-
-MIT
+# Email Verifier SDK
+
+Offline email analysis, a typed client for [emailverifier.dev](https://emailverifier.dev), and a CLI in one package.
+
+The offline functions use bundled data and make no network requests. They can identify syntax problems, disposable providers, free mailbox providers, role addresses, and common provider typos. They cannot confirm whether a mailbox exists or will accept mail.
+
+## Install
+
+```bash
+npm install @emailverifier/sdk
+```
+
+Node.js 20 or newer is required. The package has no runtime dependencies and sends no telemetry.
+
+## Free offline analysis
+
+```ts
+import { analyzeEmail } from '@emailverifier/sdk/offline'
+
+const result = analyzeEmail('Support+Trial@Gmail.com')
+
+console.log(result.checks.syntax)
+console.log(result.checks.disposable)
+console.log(result.checks.freeProvider)
+console.log(result.checks.roleBased)
+console.log(result.suggestion)
+```
+
+The result intentionally has no `deliverable` field. DNS, SMTP recipient acceptance, and catch-all detection require the hosted API.
+
+You can also import focused helpers:
+
+```ts
+import {
+  isDisposableDomain,
+  isFreeEmailProvider,
+  isRoleAddress
+} from '@emailverifier/sdk/offline'
+```
+
+## Hosted verification
+
+Create a project at [emailverifier.dev](https://emailverifier.dev), then use its API key:
+
+```ts
+import { EmailVerifier } from '@emailverifier/sdk'
+
+const client = new EmailVerifier({
+  apiKey: process.env.EMAILVERIFIER_API_KEY!
+})
+
+const verification = await client.verify('hello@example.com')
+const domain = await client.checkDomain('example.com')
+const usage = await client.getUsage()
+```
+
+`verify` and `checkDomain` each use one project credit. `getUsage` does not use a credit. The client does not retry failed requests automatically.
+
+## CLI
+
+Run local analysis without an account or API key:
+
+```bash
+npx @emailverifier/sdk check hello@example.com
+npx @emailverifier/sdk check hello@example.com --json
+```
+
+Remote commands read the key from the environment. API keys are deliberately not accepted as command-line arguments because command histories and process lists can expose them.
+
+```bash
+export EMAILVERIFIER_API_KEY=ev_your_project_key
+
+npx @emailverifier/sdk verify hello@example.com
+npx @emailverifier/sdk domain example.com
+npx @emailverifier/sdk usage
+```
+
+Use `EMAILVERIFIER_BASE_URL` only when testing against a local or self-selected API origin.
+
+## Data updates
+
+The disposable-domain snapshot comes from [disposable/disposable-email-domains](https://github.com/disposable/disposable-email-domains) and includes additional maintained aliases. Its license is recorded in [THIRD_PARTY_NOTICES.md](./THIRD_PARTY_NOTICES.md).
+
+The scheduled GitHub workflow validates upstream data, commits changed snapshots, and publishes a tested patch release. Configure npm Trusted Publishing for GitHub owner `usamaejaz`, repository `emailverifier`, workflow `update-data.yml`, environment `npm`, and the `npm publish` action.
+
+## License
+
+MIT

package/THIRD_PARTY_NOTICES.md

@@ -1,28 +1,28 @@
-# Disposable email domain data
-
+# Disposable email domain data
+
 The generated `src/data/disposable-domains.generated.ts` snapshot incorporates data from
-[disposable/disposable-email-domains](https://github.com/disposable/disposable-email-domains).
-The snapshot is maintained inside this repository and is not fetched at runtime.
-
-MIT License
-
-Copyright (c) 2017 Andrei Simionescu  
-Copyright (c) 2017 Stefan Meinecke, greenSec GmbH
-
-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.
+[disposable/disposable-email-domains](https://github.com/disposable/disposable-email-domains).
+The snapshot is maintained inside this repository and is not fetched at runtime.
+
+MIT License
+
+Copyright (c) 2017 Andrei Simionescu  
+Copyright (c) 2017 Stefan Meinecke, greenSec GmbH
+
+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.