@becollective/utils 1.1.0 → 1.2.0

package/bundle.js

@@ -40,25 +40,53 @@ var password = {
 
 var moment = require('moment');
 /**
- * Check if a user requires parent(guardian) consent
- * i.e. Is under the age of 16 years, based on GDPR
- * https://gdpr-info.eu/art-8-gdpr/
- * @param {*} dateOfBirth moment.js compatible date time
+ * Get current age based on the given birth date
+ * @param {string} dateOfBirth
+ * @param {string} unit the measurement of the the difference
+ *  The supported measurements are:
+ *  years, months, weeks, days, hours, minutes, and seconds. 
+ * @returns {number} age
  */
 
 
-var isUnderSixteen = function isUnderSixteen(dateOfBirth) {
-  var age = moment().diff(dateOfBirth, 'years');
+var getAge = function getAge(dateOfBirth) {
+  var unit = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'years';
+  var age = moment().diff(dateOfBirth, unit);
 
   if (isNaN(age)) {
     throw new Error('Invalid date');
   }
 
-  return age < 16;
+  return age;
+};
+/**
+ * Check if a user requires parent(guardian) consent
+ * i.e. Is under the age of 16 years, based on GDPR
+ * https://gdpr-info.eu/art-8-gdpr/
+ * @param {string} dateOfBirth moment.js compatible date time
+ * @returns {boolean}
+ * NOTE:
+ * We used to not allow child (under 16) to register,
+ * and birthdate is not a required field for ghost user
+ * So an existing user could have no birthdate, we assume these users are adults
+ * TODO:
+ * Remove above logic after we migrated all legacy
+ * data to have a consistent birthdate property.
+ * Then we should throw error if birthdate is not valid
+ */
+
+var isUnderSixteen = function isUnderSixteen(dateOfBirth) {
+  if (!dateOfBirth || !moment(dateOfBirth).isValid()) {
+    return false;
+  }
+
+  var age = getAge(dateOfBirth);
+  return isNaN(age) ? false : age < 16;
 };
 
 var util = {
   password: password,
-  isUnderSixteen: isUnderSixteen
+  isUnderSixteen: isUnderSixteen,
+  getAge: getAge
 };
 module.exports = util;

package/date-time.js

@@ -1,15 +1,39 @@
 const moment = require('moment');
 
+/**
+ * Get current age based on the given birth date
+ * @param {string} dateOfBirth
+ * @param {string} unit the measurement of the the difference
+ *  The supported measurements are:
+ *  years, months, weeks, days, hours, minutes, and seconds. 
+ * @returns {number} age
+ */
+export const getAge = (dateOfBirth, unit='years') => {
+  const age = moment().diff(dateOfBirth, unit);
+  if (isNaN(age)) {
+    throw new Error('Invalid date');
+  }
+  return age;
+};
 /**
  * Check if a user requires parent(guardian) consent
  * i.e. Is under the age of 16 years, based on GDPR
  * https://gdpr-info.eu/art-8-gdpr/
- * @param {*} dateOfBirth moment.js compatible date time
+ * @param {string} dateOfBirth moment.js compatible date time
+ * @returns {boolean}
+ * NOTE:
+ * We used to not allow child (under 16) to register,
+ * and birthdate is not a required field for ghost user
+ * So an existing user could have no birthdate, we assume these users are adults
+ * TODO:
+ * Remove above logic after we migrated all legacy
+ * data to have a consistent birthdate property.
+ * Then we should throw error if birthdate is not valid
  */
 export const isUnderSixteen = dateOfBirth => {
-  const age = moment().diff(dateOfBirth, 'years');
-  if (isNaN(age)) {
-    throw new Error('Invalid date');
+  if (!dateOfBirth || !moment(dateOfBirth).isValid()) {
+    return false;
   }
-  return age < 16;
+  const age = getAge(dateOfBirth);
+  return isNaN(age) ? false : age < 16;
 };

package/index.js

@@ -1,9 +1,10 @@
 import { password } from './password';
-import { isUnderSixteen } from './date-time';
+import { isUnderSixteen, getAge } from './date-time';
 
 const util = {
   password,
   isUnderSixteen,
+  getAge,
 };
 
 module.exports = util;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@becollective/utils",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Common utilities",
   "main": "bundle.js",
   "scripts": {

package/tests/date-time.test.js

@@ -0,0 +1,56 @@
+const { isUnderSixteen, getAge } = require('../bundle.js');
+const moment = require('moment');
+
+describe('getAge', () => {
+  const refPoint = moment().subtract(16, 'years');
+
+  test('Returns the correct age', () => {
+    const dob = moment(refPoint);
+
+    expect(getAge(dob)).toBe(16);
+    expect(getAge(dob.subtract(1, 'year').utc().format())).toBe(17);
+    expect(getAge(dob.add(13, 'months').utc().format())).toBe(15);
+  });
+
+  test('Returns the age in specified measurement', () => {
+    const dob = moment().subtract(15, 'months');
+
+    expect(getAge(dob)).toBe(1);
+    expect(getAge(dob, 'years')).toBe(1);
+    expect(getAge(dob, 'months')).toBe(15);
+  });
+
+  test('Throws Error if dob is not a valid date-string', () => {
+    expect(() => getAge(notDefined)).toThrow(/not defined/);
+    expect(() => getAge(null)).toThrow(/Invalid date/);
+    expect(() => getAge('not-valid')).toThrow(/Invalid date/);
+  });
+});
+
+describe('isUnderSixteen', () => {
+  const refPoint = moment().subtract(16, 'years');
+  const obj = {};
+  test('Is not U16 if dob is 16 years ago', () => {
+    const dob = moment(refPoint);
+
+    expect(isUnderSixteen(dob.subtract(1, 'second').utc().format())).toBe(false);
+    expect(isUnderSixteen(dob.subtract(100, 'year').utc().format())).toBe(false);
+  });
+
+  test('Is U16 if dob is less than 16 years ago', () => {
+    const dob = moment(refPoint);
+
+    expect(isUnderSixteen(dob.add(1, 'second').utc().format())).toBe(true);
+    expect(isUnderSixteen(dob.add(100, 'year').utc().format())).toBe(true);
+  });
+
+  test('Undefined dob', () => {
+    expect(isUnderSixteen(obj.notDefined)).toBe(false);
+  });
+  test('Null dob', () => {
+    expect(isUnderSixteen(null)).toBe(false);
+  });
+  test('Invalid date string', () => {
+    expect(isUnderSixteen('not-valid')).toBe(false);
+  });
+});

package/tests/isUnderSixteen.test.js

@@ -1,26 +0,0 @@
-const { isUnderSixteen } = require('../bundle.js');
-const moment = require('moment');
-
-describe('isUnderSixteen', () => {
-  const refPoint = moment().subtract(16, 'years');
-
-  test('Is not U16 if dob is 16 years ago', () => {
-    const dob = moment(refPoint);
-
-    expect(isUnderSixteen(dob.subtract(1, 'second').utc().format())).toBe(false);
-    expect(isUnderSixteen(dob.subtract(100, 'year').utc().format())).toBe(false);
-  });
-
-  test('Is U16 if dob is less than 16 years ago', () => {
-    const dob = moment(refPoint);
-
-    expect(isUnderSixteen(dob.add(1, 'second').utc().format())).toBe(true);
-    expect(isUnderSixteen(dob.add(100, 'year').utc().format())).toBe(true);
-  });
-
-  test('Throws Error if dob is not a valid date-string', () => {
-    expect(() => isUnderSixteen(notDefined)).toThrow(/not defined/);
-    expect(() => isUnderSixteen(null)).toThrow(/Invalid date/);
-    expect(() => isUnderSixteen('not-valid')).toThrow(/Invalid date/);
-  });
-});