Skip to content
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.

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

feat(email): isolate is free email fn #759

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1,248 changes: 635 additions & 613 deletions package-lock.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
"@fullhuman/postcss-purgecss": "^6.0.0",
"@gouvfr/dsfr": "^1.12.1",
"@numerique-gouv/crisp": "https://github.com/douglasduteil/crisp/releases/download/v1.6.1/douglasduteil-crisp-1.6.1.tgz",
"@numerique-gouv/moncomptepro.free-email": "workspace:*",
"@panva/jose": "^1.9.3",
"@sentry/node": "^7.112.2",
"@sentry/tracing": "^7.114.0",
Expand Down
2 changes: 2 additions & 0 deletions packages/free-email/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
dist
tsconfig.tsbuildinfo
43 changes: 43 additions & 0 deletions packages/free-email/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"name": "@numerique-gouv/moncomptepro.free-email",
"version": "0.0.0",
"private": true,
"type": "module",
"exports": {
".": {
"require": {
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
},
"import": {
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
},
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
},
"./data/*": {
"require": {
"types": "./dist/data/*.d.ts",
"default": "./dist/data/*.js"
},
"import": {
"types": "./dist/data/*.d.ts",
"default": "./dist/data/*.js"
},
"types": "./dist/data/*.d.ts",
"default": "./dist/data/*.js"
}
},
"scripts": {
"build": "tsc --build",
"dev": "npm run build -- --watch --preserveWatchOutput",
"check": "npm run build -- --noEmit"
},
"dependencies": {
"is-disposable-email-domain": "^1.0.7"
},
"devDependencies": {
"@tsconfig/node22": "^22.0.0"
}
}
11 changes: 11 additions & 0 deletions packages/free-email/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
//

import { isFree } from "is-disposable-email-domain";
import mostUsedFreeEmailDomains from "./data/most-used-free-email-domains";

//

export function isAFreeDomain(domain: string) {
// heavily inspired from https://stackoverflow.com/questions/71232973/check-email-domain-type-personal-email-or-company-email#answer-72640757
return isFree(domain) || mostUsedFreeEmailDomains.includes(domain);
}
15 changes: 15 additions & 0 deletions packages/free-email/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"compilerOptions": {
"composite": true,
"declaration": true,
"declarationMap": true,
"outDir": "./dist",
"rootDir": "src",
"types": ["./types"],
"module": "Preserve",
"moduleResolution": "Bundler",
"verbatimModuleSyntax": true
},
"extends": "@tsconfig/node22/tsconfig.json",
"references": []
}
5 changes: 5 additions & 0 deletions packages/free-email/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//

declare module "is-disposable-email-domain" {
function isFree(email: string): boolean;
}
2 changes: 1 addition & 1 deletion src/services/did-you-mean.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import mostUsedFreeEmailDomains from "@numerique-gouv/moncomptepro.free-email/data/most-used-free-email-domains";

Check failure on line 1 in src/services/did-you-mean.ts

View workflow job for this annotation

GitHub Actions / test

Cannot find module '@numerique-gouv/moncomptepro.free-email/data/most-used-free-email-domains' or its corresponding type declarations.
import { run as spellCheckEmail } from "@zootools/email-spell-checker";
import gouvfrDomains from "../data/gouvfr-domains";
import mostUsedFreeEmailDomains from "../data/most-used-free-email-domains";
import otherGouvDomains from "../data/other-gouv-domains";

// Display an email suggestion for most used public domains
Expand Down
8 changes: 4 additions & 4 deletions src/services/email.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// heavily inspired from https://stackoverflow.com/questions/71232973/check-email-domain-type-personal-email-or-company-email#answer-72640757
import { isFree } from "is-disposable-email-domain";
//

import { isAFreeDomain } from "@numerique-gouv/moncomptepro.free-email";

Check failure on line 3 in src/services/email.ts

View workflow job for this annotation

GitHub Actions / test

Cannot find module '@numerique-gouv/moncomptepro.free-email' or its corresponding type declarations.
import { parse_host } from "tld-extract";
import {
FEATURE_CONSIDER_ALL_EMAIL_DOMAINS_AS_FREE,
FEATURE_CONSIDER_ALL_EMAIL_DOMAINS_AS_NON_FREE,
} from "../config/env";
import mostUsedFreeEmailDomains from "../data/most-used-free-email-domains";

export const isAFreeEmailProvider = (domain: string) => {
if (FEATURE_CONSIDER_ALL_EMAIL_DOMAINS_AS_FREE) {
Expand All @@ -16,7 +16,7 @@
return false;
}

return isFree(domain) || mostUsedFreeEmailDomains.includes(domain);
return isAFreeDomain(domain);
};

export const getEmailDomain = (email: string) => {
Expand Down
3 changes: 2 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@
"verbatimModuleSyntax": true
},
"exclude": ["packages/*"],
"extends": "@tsconfig/node20/tsconfig.json"
"extends": "@tsconfig/node20/tsconfig.json",
"references": [{ "path": "./packages/free-email" }]
}
Loading