Skip to content

fix: remove upstream allowlist fetch and deprecate bundled allowlist #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mdesoto merged 1 commit into from
Apr 14, 2026
Merged

fix: remove upstream allowlist fetch and deprecate bundled allowlist #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ Creates and initializes a new instance. Returns `Promise<BurnerGuard>`.
| `additionalBlockedDomains` | `string[]` | — | Extra domains to add to the blocklist. |
| `additionalAllowedDomains` | `string[]` | — | Extra domains to add to the allowlist. |
| `useBundledBlocklist` | `boolean` | `true`\* | Whether to load the bundled blocklist. \*Defaults to `false` when custom `sources` are provided. |
| `useBundledAllowlist` | `boolean` | `false` | Whether to load the bundled allowlist. |
| `useBundledAllowlist` | `boolean` | `false` | **Deprecated.** Whether to load the bundled allowlist. The upstream source for this data has been removed. Use `additionalAllowedDomains` or a custom `sources` entry instead. Will be removed in a future major version. |

### Async methods

Expand Down
6 changes: 0 additions & 6 deletions scripts/update-blocklist.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ interface ListOptions {
}

const UPSTREAM_BLOCKLIST_URL = 'https://raw.githubusercontent.com/disposable-email-domains/disposable-email-domains/main/disposable_email_blocklist.conf';
const UPSTREAM_ALLOWLIST_URL = 'https://raw.githubusercontent.com/disposable-email-domains/disposable-email-domains/main/allowlist.conf';

(async () => {
const OUTPUT_DIR = path.resolve(__dirname, '..', 'data');
Expand All @@ -19,11 +18,6 @@ const UPSTREAM_ALLOWLIST_URL = 'https://raw.githubusercontent.com/disposable-ema
listName: 'Blocklist',
url: UPSTREAM_BLOCKLIST_URL,
outputPath: 'BLOCKLIST'
},
{
listName: 'Allowlist',
url: UPSTREAM_ALLOWLIST_URL,
outputPath: 'ALLOWLIST'
}
];

Expand Down
5 changes: 4 additions & 1 deletion src/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@ export interface BurnerGuardOptions {
/** Whether to load the bundled blocklist. Defaults to true. */
useBundledBlocklist?: boolean;

/** Whether to load the bundled allowlist. Defaults to false. */
/**
* Whether to load the bundled allowlist. Defaults to false.
* @deprecated The bundled allowlist is no longer maintained upstream and will be removed in a future major version. Use `additionalAllowedDomains` or a custom `sources` entry instead.
*/
useBundledAllowlist?: boolean;
}

Expand Down