@becollective/utils 1.10.2 → 2.0.0

package/tests/{date-time.test.js → date-time.test.ts}

@@ -1,19 +1,19 @@
-const { isUnderSixteen, isUnderAge, getAge, getShiftText } = require('../bundle.js');
-const moment = require('moment');
+import { isUnderSixteen, isUnderAge, getAge, getShiftText } from '../lib/date-time';
+import { DateTime } from 'luxon';
 
 describe('getAge', () => {
-  const refPoint = moment().subtract(16, 'years');
+  const refPoint = DateTime.now().minus({ years: 16 });
 
   test('Returns the correct age', () => {
-    const dob = moment(refPoint);
+    const dob = 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);
+    expect(getAge(dob.minus({ years: 1 }).toUTC())).toBe(17);
+    expect(getAge(dob.plus({ months: 12 }).toUTC())).toBe(15);
   });
 
   test('Returns the age in specified measurement', () => {
-    const dob = moment().subtract(15, 'months');
+    const dob = DateTime.now().minus({ months: 15 });
 
     expect(getAge(dob)).toBe(1);
     expect(getAge(dob, 'years')).toBe(1);
@@ -22,31 +22,31 @@ describe('getAge', () => {
 
   test('Throws Error if dob is not a valid date-string', () => {
     // eslint-disable-next-line no-undef
-    expect(() => getAge(notDefined)).toThrow(/not defined/);
+    // cannot currently get this state due to TypeScript
+    // expect(() => getAge(undefined)).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);
+  const refPoint = DateTime.now().minus({ years: 16 });
+  test('Is not U16 if dob is 16 or 100 years ago', () => {
+    const dob = refPoint;
 
-    expect(isUnderSixteen(dob.subtract(1, 'minute').utc().format())).toBe(false);
-    expect(isUnderSixteen(dob.subtract(100, 'year').utc().format())).toBe(false);
+    expect(isUnderSixteen(dob.minus({ minutes: 1 }).toUTC())).toBe(false);
+    expect(isUnderSixteen(dob.minus({ years: 100 }).toUTC())).toBe(false);
   });
 
   test('Is U16 if dob is less than 16 years ago', () => {
-    const dob = moment(refPoint);
+    const dob = refPoint;
 
-    expect(isUnderSixteen(dob.add(1, 'minute').utc().format())).toBe(true);
-    expect(isUnderSixteen(dob.add(100, 'year').utc().format())).toBe(true);
+    expect(isUnderSixteen(dob.plus({ minutes: 1 }).toUTC())).toBe(true);
+    expect(isUnderSixteen(dob.plus({ years: 100 }).toUTC())).toBe(true);
   });
 
   test('Undefined dob', () => {
-    expect(isUnderSixteen(obj.notDefined)).toBe(false);
+    expect(isUnderSixteen(undefined)).toBe(false);
   });
   test('Null dob', () => {
     expect(isUnderSixteen(null)).toBe(false);
@@ -57,24 +57,24 @@ describe('isUnderSixteen', () => {
 });
 
 describe('isUnderAge - dateOfBirth', () => {
-  const refPoint = moment().subtract(13, 'years');
+  const refPoint = DateTime.now().minus({ years: 13 });
   const obj = {};
   test('Is not U13 if dob is 13 years ago', () => {
-    const dob = moment(refPoint);
+    const dob = refPoint;
 
-    expect(isUnderAge(dob.subtract(1, 'minute').utc().format(), 13)).toBe(false);
-    expect(isUnderAge(dob.subtract(100, 'year').utc().format(), 13)).toBe(false);
+    expect(isUnderAge(dob.minus({ minutes: 1 }).toUTC(), 13)).toBe(false);
+    expect(isUnderAge(dob.minus({ years: 100 }).toUTC(), 13)).toBe(false);
   });
 
   test('Is U16 if dob is less than 16 years ago', () => {
-    const dob = moment(refPoint);
+    const dob = refPoint;
 
-    expect(isUnderAge(dob.add(1, 'minute').utc().format(), 13)).toBe(true);
-    expect(isUnderAge(dob.add(100, 'year').utc().format(), 13)).toBe(true);
+    expect(isUnderAge(dob.plus({ minutes: 1 }).toUTC(), 13)).toBe(true);
+    expect(isUnderAge(dob.plus({ years: 100 }).toUTC(), 13)).toBe(true);
   });
 
   test('Undefined dob', () => {
-    expect(isUnderAge(obj.notDefined, 13)).toBe(false);
+    expect(isUnderAge(undefined, 13)).toBe(false);
   });
   test('Null dob', () => {
     expect(isUnderAge(null, 13)).toBe(false);
@@ -99,42 +99,43 @@ describe('isUnderAge - maxAcknowledgedAge', () => {
   });
 
   test('Undefined maxAcknowledgedAge', () => {
-    expect(isUnderAge(null, 13, obj.notDefined)).toBe(false);
+    expect(isUnderAge(null, 13, undefined)).toBe(false);
   });
   test('Null maxAcknowledgedAge', () => {
     expect(isUnderAge(null, 13, null)).toBe(false);
   });
-  test('Invalid value', () => {
-    expect(isUnderAge(null, 13, '13x')).toBe(false);
-  });
+  // Will not execute due to TypeScript
+  // test('Invalid value', () => {
+  //   expect(isUnderAge(null, 13, '13x')).toBe(false);
+  // });
 });
 
 describe('isUnderAge - 10', () => {
-  const refPoint = moment().subtract(10, 'years');
+  const refPoint = DateTime.now().minus({ years: 10 });
   const obj = {};
   test('Is not U13 if dob is 10 years ago', () => {
-    const dob = moment(refPoint);
+    const dob = refPoint;
 
-    expect(isUnderAge(dob.subtract(1, 'minute').utc().format(), 10)).toBe(false);
-    expect(isUnderAge(dob.subtract(100, 'year').utc().format(), 10)).toBe(false);
+    expect(isUnderAge(dob.minus({ minutes: 1 }).toUTC(), 10)).toBe(false);
+    expect(isUnderAge(dob.minus({ years: 100 }).toUTC(), 10)).toBe(false);
   });
 
   test('Is U10 if dob is less than 10 years ago', () => {
-    const dob = moment(refPoint);
+    const dob = refPoint;
 
-    expect(isUnderAge(dob.add(1, 'minute').utc().format(), 10)).toBe(true);
-    expect(isUnderAge(dob.add(100, 'year').utc().format(), 10)).toBe(true);
+    expect(isUnderAge(dob.plus({ minutes: 1 }).toUTC(), 10)).toBe(true);
+    expect(isUnderAge(dob.plus({ years: 100 }).toUTC(), 10)).toBe(true);
   });
 });
 
 describe('isUnderAge - over 13', () => {
-  const refPoint = moment().subtract(15, 'years');
+  const refPoint = DateTime.now().minus({ years: 15 });
   const obj = {};
   test('Is not U13 if dob is 15 years ago', () => {
-    const dob = moment(refPoint);
+    const dob = refPoint;
 
-    expect(isUnderAge(dob.subtract(1, 'minute').utc().format(), 15)).toBe(false);
-    expect(isUnderAge(dob.subtract(100, 'year').utc().format(), 15)).toBe(false);
+    expect(isUnderAge(dob.minus({ minutes: 1 }).toUTC(), 15)).toBe(false);
+    expect(isUnderAge(dob.minus({ years: 100 }).toUTC(), 15)).toBe(false);
   });
 });
 
@@ -144,12 +145,13 @@ describe('getShiftText', () => {
   const melbourne = 'Australia/Melbourne';
   const auckland = 'Pacific/Auckland';
   test('get shift text with melbourne timezone', () => {
-    expect(getShiftText(from, to, melbourne)).toBe('Thursday, 30 July 2020, 10:00am-3:30pm');
+    expect(getShiftText(from, to, melbourne)).toBe('Thursday, 30 July 2020, 10:00AM-3:30PM');
   });
   test('get shift text with auckland timezone', () => {
-    expect(getShiftText(from, to, auckland)).toBe('Thursday, 30 July 2020, 12:00pm-5:30pm');
-  });
-  test('with empty data', () => {
-    expect(getShiftText()).toBe('');
+    expect(getShiftText(from, to, auckland)).toBe('Thursday, 30 July 2020, 12:00PM-5:30PM');
   });
+  // Will not execute due to TypeScript
+  // test('with empty data', () => {
+  //   expect(getShiftText()).toBe('');
+  // });
 });

package/tests/featureFlag.test.ts

@@ -1,18 +1,23 @@
-import axios from 'axios';
-import FeatureFlag from '../src/FeatureFlag';
+import { FeatureFlag } from '../lib/FeatureFlag';
 
 const featureFlag = new FeatureFlag();
-jest.mock('axios');
-const mockAxios = axios as jest.Mocked<typeof axios>;
 const feature = 'test-feature';
 
+let spy;
+
+const createFetchSpyResolve = (mockResponse) => {
+  spy = jest.spyOn(global, "fetch").mockImplementation(
+    jest.fn(
+      () => Promise.resolve({ ok: true, json: () => Promise.resolve(mockResponse),
+    }),
+  ) as jest.Mock );
+}
+
 describe('Make feature decision based on feature flags', () => {
   test('should return true if feature is flagged active on localtest', async () => {
-    mockAxios.get.mockReturnValue(
-      Promise.resolve({
-        data: { Environments: ['localtest', 'compose'] },
-      })
-    );
+    createFetchSpyResolve({
+      Environments: ['localtest', 'compose'],
+    });
     const isActive = await featureFlag.isFeatureActive(feature, {
       env: 'localtest',
     });
@@ -20,11 +25,9 @@ describe('Make feature decision based on feature flags', () => {
   });
   test('should return false if feature is NOT flagged active on localtest', async () => {
     featureFlag.clearCache();
-    mockAxios.get.mockReturnValue(
-      Promise.resolve({
-        data: { Environments: ['dev-au'] },
-      })
-    );
+    createFetchSpyResolve({
+      Environments: ['dev-au'],
+    });
     const isActive = await featureFlag.isFeatureActive(feature, {
       env: 'localtest',
     });
@@ -32,7 +35,7 @@ describe('Make feature decision based on feature flags', () => {
   });
   test('should return false if no result returned from feature flag', async () => {
     featureFlag.clearCache();
-    mockAxios.get.mockReturnValue(Promise.resolve({}));
+    createFetchSpyResolve({});
     const isActive = await featureFlag.isFeatureActive(feature, {
       env: 'localtest',
     });
@@ -41,61 +44,55 @@ describe('Make feature decision based on feature flags', () => {
   describe('Test caching', () => {
     test('should return same result for same parameter without fetch api', async () => {
       featureFlag.clearCache();
-      mockAxios.get.mockReturnValue(
-        Promise.resolve({
-          data: { Environments: ['localtest', 'compose'] },
-        })
-      );
+      createFetchSpyResolve({
+        Environments: ['localtest', 'compose'],
+      });
       const isActive = await featureFlag.isFeatureActive(feature, {
         env: 'localtest',
       });
-      expect(mockAxios.get).toBeCalled();
+      expect(spy).toHaveBeenCalled();
       expect(isActive).toBe(true);
-      mockAxios.get.mockClear();
+      spy.mockClear();
       const secondCallResult = await featureFlag.isFeatureActive(feature, {
         env: 'localtest',
       });
-      expect(mockAxios.get).not.toBeCalled();
+      expect(spy).not.toHaveBeenCalled();
       expect(secondCallResult).toBe(true);
     });
     test('should fetch api after expiry', async () => {
       featureFlag.clearCache();
       featureFlag.setCacheTtl(0);
-      mockAxios.get.mockReturnValue(
-        Promise.resolve({
-          data: { Environments: ['localtest', 'compose'] },
-        })
-      );
+      createFetchSpyResolve({
+        Environments: ['localtest', 'compose'],
+      });
       const isActive = await featureFlag.isFeatureActive(feature, {
         env: 'localtest',
       });
-      expect(mockAxios.get).toBeCalled();
+      expect(spy).toHaveBeenCalled();
       expect(isActive).toBe(true);
-      mockAxios.get.mockClear();
+      spy.mockClear();
       const secondCallResult = await featureFlag.isFeatureActive(feature, {
         env: 'localtest',
       });
-      expect(mockAxios.get).toBeCalled();
+      expect(spy).toHaveBeenCalled();
       expect(secondCallResult).toBe(true);
     });
     test('should fetch api for different parameter', async () => {
       featureFlag.clearCache();
       featureFlag.setCacheTtl(1000 * 60 * 5);
-      mockAxios.get.mockReturnValue(
-        Promise.resolve({
-          data: { Environments: ['localtest', 'compose'] },
-        })
-      );
+      createFetchSpyResolve({
+        Environments: ['localtest', 'compose'],
+      });
       const isActive = await featureFlag.isFeatureActive(feature, {
         env: 'localtest',
       });
-      expect(mockAxios.get).toBeCalled();
+      expect(spy).toHaveBeenCalled();
       expect(isActive).toBe(true);
-      mockAxios.get.mockClear();
+      spy.mockClear();
       const secondCallResult = await featureFlag.isFeatureActive(feature, {
         env: 'compose',
       });
-      expect(mockAxios.get).toBeCalled();
+      expect(spy).toHaveBeenCalled();
       expect(secondCallResult).toBe(true);
     });
   });

package/tests/forms.test-data.json

@@ -0,0 +1,43 @@
+{
+  "B1WsCeOaz": "Sam Smith",
+  "B1Wnumber": 5,
+  "B1WsCe555": "Yes",
+  "ryDRCeupz": "Joe",
+  "rkBk1-_pG": "+61434111222",
+  "rkF-kbOaz": ["Newspaper", "Google"],
+  "H1n4yZ_pM": "I like polar bears",
+  "SkbLy-_aG": true,
+  "B1UwJWOaM": ["Wed", "Tues", "Thurs"],
+  "BkgcybupG": "Male",
+  "r139kWOpz": "2018-05-31",
+  "Goh1che2u": {
+    "geo": {
+      "lat": -37.83528429999999,
+      "lng": 144.99534949999997
+    },
+    "location": {
+      "short": "South Yarra",
+      "long": "South Yarra"
+    },
+    "region": {
+      "short": "VIC",
+      "long": "Victoria"
+    },
+    "country": {
+      "short": "AU",
+      "long": "Australia"
+    }
+  },
+  "r1v5wcI0M": {
+    "from": "2018-05-15",
+    "to": "2018-05-23"
+  },
+  "BkNCKH9CM": "+61434111222",
+  "HyIyAz3X7": ["57b560694987a6d4c3554b1b", "57b560694987a6d4c3554b1d"],
+  "Bie7ohXee": {
+    "opportunityId": "5b988e6fa5db77bf46bcac79",
+    "volunteerId": "5b988e74a5db77bf46bcac7a",
+    "filename": "/foo/bar/baz.pdf"
+  },
+  "Bie7ohXef": "UK"
+}

package/tests/forms.test-schema.json

@@ -0,0 +1,144 @@
+{
+  "type": "object",
+  "required": ["H1n4yZ_pM", "BkgcybupG"],
+  "properties": {
+    "B1WsCeOaz": {
+      "type": "string",
+      "title": "Who are you?"
+    },
+    "B1Wnumber": {
+      "type": "number",
+      "title": "Rate this"
+    },
+    "B1WsCe555": {
+      "type": "string",
+      "title": "Do you own your own vehicle?",
+      "bcReportable": "BC_OWN_VEHICLE"
+    },
+    "SJh2Rx_6G": {
+      "type": "string",
+      "title": "References",
+      "bcType": "heading"
+    },
+    "ryDRCeupz": {
+      "type": "string",
+      "title": "Name"
+    },
+    "rkBk1-_pG": {
+      "type": "string",
+      "title": "Phone",
+      "bcType": "phone"
+    },
+    "S1Bly-uaf": {
+      "type": "string",
+      "title": "Other",
+      "bcType": "heading"
+    },
+    "rkF-kbOaz": {
+      "type": "array",
+      "title": "Where did you hear about us?",
+      "items": {
+        "type": "string",
+        "enum": ["Newspaper", "Google", "Word of mouth"]
+      },
+      "uniqueItems": true,
+      "bcRequired": false
+    },
+    "H1n4yZ_pM": {
+      "type": "string",
+      "title": "Why do you want to help us?"
+    },
+    "SkbLy-_aG": {
+      "type": "boolean",
+      "title": "Volunteered Before?"
+    },
+    "B1UwJWOaM": {
+      "type": "array",
+      "title": "What days would you like to volunteer",
+      "items": {
+        "type": "string",
+        "enum": ["Mon", "Tues", "Wed", "Thurs", "Fri"]
+      },
+      "uniqueItems": true
+    },
+    "BkgcybupG": {
+      "type": "string",
+      "title": "Gender",
+      "items": {
+        "type": "string",
+        "enum": ["Male", "Female", "Other"]
+      }
+    },
+    "r139kWOpz": {
+      "type": "string",
+      "title": "When can you start?",
+      "bcType": "date"
+    },
+    "Goh1che2u": {
+      "type": "object",
+      "title": "Where do you want to volunteer?",
+      "bcType": "location"
+    },
+    "r1v5wcI0M": {
+      "title": "What date range would you prefer?",
+      "type": "object",
+      "properties": {},
+      "bcType": "dateRange"
+    },
+    "BkNCKH9CM": {
+      "title": "Phone Number",
+      "type": "string",
+      "bcType": "phone"
+    },
+    "SyDtPZrkm": {
+      "type": "string",
+      "title": "spacer",
+      "bcType": "spacer"
+    },
+    "cSCgS2dlE": {
+      "title": "Paragraph",
+      "text": "<p>Rich text</p>",
+      "type": "string",
+      "bcType": "textParagraph"
+    },
+    "HyIyAz3X7": {
+      "title": "Skills Required",
+      "type": "array",
+      "uniqueItems": true,
+      "bcType": "skills",
+      "items": {
+        "type": "string",
+        "anyOf": [
+          {
+            "enum": ["57b560694987a6d4c3554b1b"],
+            "title": "Office Reception",
+            "type": "string"
+          },
+          {
+            "enum": ["57b560694987a6d4c3554b1d"],
+            "title": "Executive Administration",
+            "type": "string"
+          },
+          {
+            "enum": ["57b560694987a6d4c3554b1c"],
+            "title": "Office Management",
+            "type": "string"
+          }
+        ]
+      }
+    },
+    "Bie7ohXee": {
+      "title": "Upload a file",
+      "type": "string",
+      "bcType": "file"
+    },
+    "Bie7ohXef": {
+      "type": "string",
+      "title": "Country of Birth",
+      "items": {
+        "type": "string",
+        "enum": ["UK", "AU", "NZ"]
+      }
+    }
+  }
+}

package/tests/forms.test-uischema.json

@@ -0,0 +1,117 @@
+{
+  "ui:order": [
+    "B1WsCeOaz",
+    "B1WsCe555",
+    "SJh2Rx_6G",
+    "ryDRCeupz",
+    "rkBk1-_pG",
+    "S1Bly-uaf",
+    "rkF-kbOaz",
+    "H1n4yZ_pM",
+    "SkbLy-_aG",
+    "B1UwJWOaM",
+    "BkgcybupG",
+    "r139kWOpz",
+    "r1v5wcI0M",
+    "BkNCKH9CM",
+    "SyDtPZrkm"
+  ],
+  "B1WsCeOaz": {
+    "ui:widget": "WidgetTextBox",
+    "ui:title": "Who are you?",
+    "ui:bc-helperText": "Something helpful"
+  },
+  "B1Wnumber": {
+    "ui:widget": "WidgetSocialPrescribing",
+    "ui:title": "Rate this"
+  },
+  "B1WsCe555": {
+    "ui:widget": "WidgetTextBox",
+    "ui:title": "Do you own your own vehicle?",
+    "ui:bc-helperText": "Something helpful"
+  },
+  "SJh2Rx_6G": {
+    "ui:widget": "WidgetHeading",
+    "ui:title": "References"
+  },
+  "ryDRCeupz": {
+    "ui:widget": "WidgetTextBox",
+    "ui:title": "Name"
+  },
+  "rkBk1-_pG": {
+    "ui:widget": "WidgetPhone",
+    "ui:title": "Phone"
+  },
+  "S1Bly-uaf": {
+    "ui:widget": "WidgetHeading",
+    "ui:title": "Other"
+  },
+  "rkF-kbOaz": {
+    "ui:widget": "WidgetDropDown",
+    "ui:title": "Where did you hear about us?",
+    "ui:bc-helperText": "",
+    "ui:bc-required": false,
+    "ui:bc-multiSelect": true
+  },
+  "H1n4yZ_pM": {
+    "ui:widget": "WidgetTextArea",
+    "ui:title": "Why do you want to help us?",
+    "ui:bc-helperText": "",
+    "ui:bc-required": true
+  },
+  "SkbLy-_aG": {
+    "ui:widget": "WidgetToggle",
+    "ui:title": "Volunteered Before?"
+  },
+  "B1UwJWOaM": {
+    "ui:widget": "WidgetTickbox",
+    "ui:title": "What days would you like to volunteer"
+  },
+  "BkgcybupG": {
+    "ui:widget": "WidgetRadio",
+    "ui:title": "Gender",
+    "ui:bc-helperText": "",
+    "ui:bc-required": true
+  },
+  "r139kWOpz": {
+    "ui:widget": "WidgetDate",
+    "ui:title": "When can you start?"
+  },
+  "Goh1che2u": {
+    "ui:widget": "WidgetLocation",
+    "ui:title": "Where do you want to volunteer?"
+  },
+  "r1v5wcI0M": {
+    "ui:widget": "WidgetDateRange",
+    "ui:title": "What date range would you prefer?",
+    "ui:field": "dateRange"
+  },
+  "BkNCKH9CM": {
+    "ui:widget": "WidgetPhone",
+    "ui:title": "Phone Number"
+  },
+  "SyDtPZrkm": {
+    "ui:title": "",
+    "ui:widget": "WidgetSpacer"
+  },
+  "cSCgS2dlE": {
+    "ui:widget": "WidgetTextParagraph",
+    "ui:title": "Paragraph"
+  },
+  "HyIyAz3X7": {
+    "ui:widget": "WidgetSkillsRequired",
+    "ui:title": "Skills Required"
+  },
+  "Bie7ohXee": {
+    "ui:widget": "WidgetFile",
+    "ui:title": "Your resume"
+  },
+  "Bie7ohXef": {
+    "ui:widget": "WidgetCountry",
+    "ui:title": "Country of Birth"
+  },
+  "Bie7ohXeg": {
+    "ui:widget": "WidgetTextParagraph",
+    "ui:title": ""
+  }
+}