feat: added PhoneNumber scalar

Author: ccuilla

src/PhoneNumber.js

@@ -0,0 +1,52 @@
+import { GraphQLScalarType } from 'graphql';
+import { GraphQLError } from 'graphql/error';
+import { Kind } from 'graphql/language';
+
+const PHONE_NUMBER_REGEX = new RegExp(
+  /^\+\d{11,15}$/,
+);
+
+export default new GraphQLScalarType({
+  name: 'PhoneNumber',
+
+  description:
+    'A field whose value conforms to the standard E.164 format as specified in: https://en.wikipedia.org/wiki/E.164. Basically this is +17895551234.',
+
+  serialize(value) {
+    if (typeof value !== 'string') {
+      throw new TypeError(`Value is not string: ${value}`);
+    }
+
+    if (!PHONE_NUMBER_REGEX.test(value)) {
+      throw new TypeError(`Value is not a valid phone number of the form +17895551234 (10-15 digits): ${value}`);
+    }
+
+    return value;
+  },
+
+  parseValue(value) {
+    if (typeof value !== 'string') {
+      throw new TypeError(`Value is not string: ${value}`);
+    }
+
+    if (!PHONE_NUMBER_REGEX.test(value)) {
+      throw new TypeError(`Value is not a valid phone number of the form +17895551234 (10-15 digits): ${value}`);
+    }
+
+    return value;
+  },
+
+  parseLiteral(ast) {
+    if (ast.kind !== Kind.STRING) {
+      throw new GraphQLError(
+        `Can only validate strings as phone numbers but got a: ${ast.kind}`,
+      );
+    }
+
+    if (!PHONE_NUMBER_REGEX.test(ast.value)) {
+      throw new TypeError(`Value is not a valid phone number of the form +17895551234 (10-15 digits): ${ast.value}`);
+    }
+
+    return ast.value;
+  },
+});

src/__tests__/PhoneNumber.test.js

@@ -0,0 +1,121 @@
+/* global describe, test, expect */
+
+import { Kind } from 'graphql/language';
+
+import { PhoneNumber } from '../';
+
+describe('PhoneNumber', () => {
+  describe('valid', () => {
+    test('serialize', () => {
+      expect(PhoneNumber.serialize('+17895551234')).toBe('+17895551234');
+    });
+
+    test('parseValue', () => {
+      expect(PhoneNumber.parseValue('+17895551234')).toBe('+17895551234');
+    });
+
+    test('parseLiteral', () => {
+      expect(
+        PhoneNumber.parseLiteral({ value: '+17895551234', kind: Kind.STRING }),
+      ).toBe('+17895551234');
+    });
+  });
+
+  describe('invalid', () => {
+    describe('not a phone number', () => {
+      test('serialize', () => {
+        expect(() => PhoneNumber.serialize('this is not a phone number')).toThrow(
+          /^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/,
+        );
+      });
+
+      test('parseValue', () => {
+        expect(() => PhoneNumber.parseValue('this is not a phone number')).toThrow(
+          /^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/,
+        );
+      });
+
+      test('parseLiteral', () => {
+        expect(() =>
+          PhoneNumber.parseLiteral({ value: 'this is not a phone number', kind: Kind.STRING }),
+        ).toThrow(/^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/);
+      });
+    });
+
+    describe('not a string', () => {
+      test('serialize', () => {
+        expect(() => PhoneNumber.serialize(123)).toThrow(/Value is not string/);
+      });
+
+      test('parseValue', () => {
+        expect(() => PhoneNumber.parseValue(123)).toThrow(/Value is not string/);
+      });
+
+      test('parseLiteral', () => {
+        expect(() => PhoneNumber.parseLiteral({ value: 123, kind: Kind.INT })).toThrow(
+          /Can only validate strings as phone numbers but got a/,
+        );
+      });
+    });
+
+    describe('too short', () => {
+      test('serialize', () => {
+        expect(() => PhoneNumber.serialize('+1789555123')).toThrow(
+          /^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/,
+        );
+      });
+
+      test('parseValue', () => {
+        expect(() => PhoneNumber.parseValue('+1789555123')).toThrow(
+          /^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/,
+        );
+      });
+
+      test('parseLiteral', () => {
+        expect(() =>
+          PhoneNumber.parseLiteral({ value: '+1789555123', kind: Kind.STRING }),
+        ).toThrow(/^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/);
+      });
+    });
+
+    describe('too long', () => {
+      test('serialize', () => {
+        expect(() => PhoneNumber.serialize('+1789555123456789')).toThrow(
+          /^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/,
+        );
+      });
+
+      test('parseValue', () => {
+        expect(() => PhoneNumber.parseValue('+1789555123456789')).toThrow(
+          /^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/,
+        );
+      });
+
+      test('parseLiteral', () => {
+        expect(() =>
+          PhoneNumber.parseLiteral({ value: '+1789555123456789', kind: Kind.STRING }),
+        ).toThrow(/^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/);
+      });
+    });
+
+    describe('no plus sign', () => {
+      test('serialize', () => {
+        expect(() => PhoneNumber.serialize('17895551234')).toThrow(
+          /^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/,
+        );
+      });
+
+      test('parseValue', () => {
+        expect(() => PhoneNumber.parseValue('17895551234')).toThrow(
+          /^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/,
+        );
+      });
+
+      test('parseLiteral', () => {
+        expect(() =>
+          PhoneNumber.parseLiteral({ value: '17895551234', kind: Kind.STRING }),
+        ).toThrow(/^Value is not a valid phone number of the form \+17895551234 \(10-15 digits\)/);
+      });
+    });
+  });
+});

src/index.js

@@ -9,6 +9,7 @@ import NonNegativeFloat from './NonNegativeFloat';
 import NegativeFloat from './NegativeFloat';
 import EmailAddress from './EmailAddress';
 import URL from './URL';
+import PhoneNumber from './PhoneNumber';
 
 export {
   DateTime,
@@ -22,6 +23,7 @@ export {
   NegativeFloat,
   EmailAddress,
   URL,
+  PhoneNumber,
 };
 
 export default {
@@ -35,4 +37,5 @@ export default {
   NegativeFloat,
   EmailAddress,
   URL,
+  PhoneNumber,
 };