fix: add email validation

graasp · Nov 11, 2024 · 884ab65 · 884ab65
1 parent d9bfc38
commit 884ab65
Show file tree

Hide file tree

Showing 10 changed files with 1,050 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -303,3 +303,7 @@ export {
   type ChatBotMessage,
   GPTVersion,
 } from './chatbot/chatbot.js';
+
+export { isEmail } from './validation/isEmail.js';
+export { isFQDN } from './validation/isFQDN.js';
+export { isIP } from './validation/isIP.js';
diff --git a/src/validation/isByteLength.test.ts b/src/validation/isByteLength.test.ts
@@ -0,0 +1,40 @@
+import { describe } from 'vitest';
+
+import { isByteLength } from './isByteLength.js';
+import { testFunc } from './testUtils.js';
+
+describe('isByteLength', () => {
+  testFunc(
+    'only min for "%s"',
+    isByteLength,
+    { min: 2 },
+    {
+      valid: ['abc', 'de', 'abcd', 'ｇｍａｉｌ'],
+      invalid: ['', 'a'],
+    },
+  );
+  testFunc(
+    'min and max for "%s"',
+    isByteLength,
+    { min: 2, max: 3 },
+    { valid: ['abc', 'de', 'ｇ'], invalid: ['', 'a', 'abcd', 'ｇｍ'] },
+  );
+  testFunc(
+    'only max for "%s"',
+    isByteLength,
+    { max: 3 },
+    {
+      valid: ['abc', 'de', 'ｇ', 'a', ''],
+      invalid: ['abcd', 'ｇｍ'],
+    },
+  );
+  testFunc(
+    'only max for "%s"',
+    isByteLength,
+    { max: 0 },
+    {
+      valid: [''],
+      invalid: ['ｇ', 'a'],
+    },
+  );
+});
diff --git a/src/validation/isByteLength.ts b/src/validation/isByteLength.ts
@@ -0,0 +1,11 @@
+export function isByteLength(
+  str: string,
+  options?: Partial<{ min: number; max: number }>,
+) {
+  const min = options?.min ?? 0;
+  const len = encodeURI(str).split(/%..|./).length - 1;
+  if (typeof options?.max === 'undefined') {
+    return len >= min;
+  }
+  return len >= min && len <= options.max;
+}
diff --git a/src/validation/isEmail.test.ts b/src/validation/isEmail.test.ts
@@ -0,0 +1,322 @@
+import { describe } from 'vitest';
+
+import { isEmail } from './isEmail.js';
+import { testFunc } from './testUtils.js';
+
+describe('isEmail', () => {
+  testFunc(
+    'Default options',
+    isEmail,
+    {},
+    {
+      valid: [
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        'hans.m端[email protected]',
+        'hans@m端ller.com',
+        'test|123@m端ller.com',
+        '[email protected]',
+        '[email protected]',
+        '"foobar"@example.com',
+        '"  foo  m端ller "@example.com',
+        '"foo\\@bar"@example.com',
+        `${'a'.repeat(64)}@${'a'.repeat(63)}.com`,
+        `${'a'.repeat(31)}@gmail.com`,
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+      ],
+      invalid: [
+        'foobar@my_sarisari_store.typepad.com',
+        'invalidemail@',
+        'invalid.com',
+        '@invalid.com',
+        '[email protected].',
+        'foo@_bar.com',
+        'somename@ｇｍａｉｌ.com',
+        '[email protected].',
+        '[email protected]',
+        'ｇｍａｉｌｇｍａｉｌｇｍａｉｌｇｍａｉｌｇｍａｉｌ@gmail.com',
+        `${'a'.repeat(64)}@${'a'.repeat(251)}.com`,
+        `${'a'.repeat(65)}@${'a'.repeat(250)}.com`,
+        `${'a'.repeat(64)}@${'a'.repeat(64)}.com`,
+        `${'a'.repeat(64)}@${'a'.repeat(63)}.${'a'.repeat(63)}.${'a'.repeat(63)}.${'a'.repeat(58)}.com`,
+        '[email protected] m',
+        '[email protected] m',
+        '[email protected] m',
+        '[email protected] m',
+        '[email protected] m',
+        '[email protected] m',
+        '[email protected] m',
+        '[email protected] m',
+        '[email protected] m',
+        '[email protected] m',
+        '[email protected] m',
+        '[email protected]　m',
+        '[email protected]　m',
+        '[email protected]',
+        'test123+invalid! [email protected]',
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        'wrong()[]",:;<>@@gmail.com',
+        '"wrong()[]",:;<>@@gmail.com',
+        '[email protected]�',
+        '[email protected]©',
+        'nbsp [email protected]',
+        'nbsp_test@te st.com',
+        '[email protected] m',
+        '"[email protected]',
+        '"foo"[email protected]',
+        'foo"bar"@gmail.com',
+      ],
+    },
+  );
+
+  testFunc(
+    'Domain specific validation',
+    isEmail,
+    { domainSpecificValidation: true },
+    {
+      valid: [
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        `${'a'.repeat(30)}@gmail.com`,
+      ],
+      invalid: [
+        `${'a'.repeat(31)}@gmail.com`,
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+      ],
+    },
+  );
+
+  testFunc(
+    'Allow underscores',
+    isEmail,
+    { allowUnderscores: true },
+    { valid: ['foobar@my_sarisari_store.typepad.com'] },
+  );
+
+  testFunc(
+    'Allow UTF8 part',
+    isEmail,
+    { allowUtf8LocalPart: false },
+    {
+      valid: [
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        'hans@m端ller.com',
+        'test|123@m端ller.com',
+        '[email protected]',
+        '[email protected]',
+        '"foobar"@example.com',
+        '"foo\\@bar"@example.com',
+        '"  foo  bar  "@example.com',
+      ],
+      invalid: [
+        'invalidemail@',
+        'invalid.com',
+        '@invalid.com',
+        '[email protected].',
+        '[email protected].',
+        'somename@ｇｍａｉｌ.com',
+        'hans.m端[email protected]',
+        '[email protected]',
+        'tü[email protected]',
+        'nbsp [email protected]',
+      ],
+    },
+  );
+
+  testFunc(
+    'Allow display name',
+    isEmail,
+    { allowDisplayName: true },
+    {
+      valid: [
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        'hans.m端[email protected]',
+        'hans@m端ller.com',
+        'test|123@m端ller.com',
+        '[email protected]',
+        '[email protected]',
+        'Some Name <[email protected]>',
+        'Some Name <[email protected]>',
+        'Some Name <[email protected]>',
+        'Some Name <[email protected]>',
+        'Some Name <hans.m端[email protected]>',
+        'Some Name <hans@m端ller.com>',
+        'Some Name <test|123@m端ller.com>',
+        'Some Name <[email protected]>',
+        // eslint-disable-next-line quotes
+        "'Foo Bar, Esq'<[email protected]>",
+        'Some Name <[email protected]>',
+        'Some Middle Name <[email protected]>',
+        'Name <[email protected]>',
+        'Name<[email protected]>',
+        'Some Name <[email protected]>',
+        'Name🍓With🍑Emoji🚴‍♀️🏆<[email protected]>',
+        '🍇🍗🍑<[email protected]>',
+        '"<displayNameInBrackets>"<[email protected]>',
+        '"\\"quotes\\""<[email protected]>',
+        '"name;"<[email protected]>',
+        '"name;" <[email protected]>',
+      ],
+      invalid: [
+        'invalidemail@',
+        'invalid.com',
+        '@invalid.com',
+        '[email protected].',
+        '[email protected].',
+        'Some Name <invalidemail@>',
+        'Some Name <invalid.com>',
+        'Some Name <@invalid.com>',
+        'Some Name <[email protected].>',
+        'Some Name <[email protected].>',
+        'Some Name [email protected].>',
+        'Some Name <[email protected].',
+        'Some Name < [email protected] >',
+        'Name [email protected]',
+        'Some Name <[email protected]>',
+        'Some Name<emoji_in_address🍈@aftership.com>',
+        'invisibleCharacter\u001F<[email protected]>',
+        '<displayNameInBrackets><[email protected]>',
+        '\\"quotes\\"<[email protected]>',
+        '""quotes""<[email protected]>',
+        'name;<[email protected]>',
+        '    <[email protected]>',
+        '"    "<[email protected]>',
+      ],
+    },
+  );
+
+  testFunc(
+    'Require display name',
+    isEmail,
+    { requireDisplayName: true },
+    {
+      valid: [
+        'Some Name <[email protected]>',
+        'Some Name <[email protected]>',
+        'Some Name <[email protected]>',
+        'Some Name <[email protected]>',
+        'Some Name <hans.m端[email protected]>',
+        'Some Name <hans@m端ller.com>',
+        'Some Name <test|123@m端ller.com>',
+        'Some Name <[email protected]>',
+        'Some Name <[email protected]>',
+        'Some Middle Name <[email protected]>',
+        'Name <[email protected]>',
+        'Name<[email protected]>',
+      ],
+      invalid: [
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        '[email protected]',
+        'hans.m端[email protected]',
+        'hans@m端ller.com',
+        'test|123@m端ller.com',
+        '[email protected]',
+        'invalidemail@',
+        'invalid.com',
+        '@invalid.com',
+        '[email protected].',
+        '[email protected].',
+        'Some Name <invalidemail@>',
+        'Some Name <invalid.com>',
+        'Some Name <@invalid.com>',
+        'Some Name <[email protected].>',
+        'Some Name <[email protected].>',
+        'Some Name [email protected].>',
+        'Some Name <[email protected].',
+        'Some Name < [email protected] >',
+        'Name [email protected]',
+      ],
+    },
+  );
+
+  testFunc(
+    'Allow Ip Domain',
+    isEmail,
+    { allowIpDomain: true },
+    {
+      valid: ['email@[123.123.123.123]', '[email protected]'],
+      invalid: [
+        '[email protected]',
+        '[email protected]',
+        'email@[266.266.266.266]',
+      ],
+    },
+  );
+
+  testFunc(
+    'Blacklisted chars',
+    isEmail,
+    { blacklistedChars: 'abc"' },
+    {
+      valid: ['[email protected]'],
+      invalid: [
+        '[email protected]',
+        '"foobr"@example.com',
+        '" foo m端ller "@example.com',
+        '"foo@br"@example.com',
+      ],
+    },
+  );
+
+  testFunc(
+    'Ignore Max length allowed',
+    isEmail,
+    { ignoreMaxLength: true },
+
+    {
+      valid: [
+        'Deleted-user-id-19430-Team-5051deleted-user-id-19430-team-5051XXXXXX@example.com',
+      ],
+    },
+  );
+
+  testFunc(
+    'Ignore Max length disallowed',
+    isEmail,
+    { ignoreMaxLength: false },
+    {
+      invalid: [
+        'Deleted-user-id-19430-Team-5051deleted-user-id-19430-team-5051XXXXXX@example.com',
+        'Deleted-user-id-19430-Team-5051deleted-user-id-19430-team-5051XXXXXX@Deleted-user-id-19430-Team-5051deleted-user-id-19430-team-5051XXXXXX.com',
+      ],
+    },
+  );
+
+  testFunc(
+    'Blacklist host',
+    isEmail,
+    { hostBlacklist: ['gmail.com', 'foo.bar.com'] },
+    {
+      valid: ['[email protected]'],
+      invalid: ['[email protected]', '[email protected]'],
+    },
+  );
+
+  testFunc(
+    'Whitelist host',
+    isEmail,
+    { hostWhitelist: ['gmail.com', 'foo.bar.com'] },
+    {
+      valid: ['[email protected]', '[email protected]'],
+      invalid: ['[email protected]', '[email protected]', '[email protected]'],
+    },
+  );
+});