@becollective/utils 1.10.2 → 2.0.0

package/lib/src/locality.d.ts

@@ -0,0 +1,5 @@
+/**
+ *
+ * @param {Array} locationList
+ */
+export declare const getHomeLocalityFromLocationList: (locationList: any) => any;

package/lib/src/locality.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHomeLocalityFromLocationList = void 0;
+/**
+ *
+ * @param {Array} locationList
+ */
+const getHomeLocalityFromLocationList = (locationList) => {
+    const homeLocation = Array.isArray(locationList) && locationList.find((location) => location.name === 'Home');
+    if (homeLocation && homeLocation.locality && homeLocation.locality.long) {
+        return homeLocation.locality.long;
+    }
+    return null;
+};
+exports.getHomeLocalityFromLocationList = getHomeLocalityFromLocationList;

package/lib/src/money.d.ts

@@ -0,0 +1,7 @@
+export declare const getCurrencyFromCurrencyCode: (currencyCode: any) => any;
+export declare const makeMoneyString: ({ amount: inputAmount, currencyCode, rounded, showCurrencyCode }: {
+    amount: any;
+    currencyCode: any;
+    rounded?: boolean | undefined;
+    showCurrencyCode?: boolean | undefined;
+}) => string;

package/lib/src/money.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeMoneyString = exports.getCurrencyFromCurrencyCode = void 0;
+const { currencies } = require('@becollective/constants');
+// We should probably throw and error on bad input instead of falling back to a default.
+// We're making an assumption that whoever is calling this function can safely work
+// with AUD. But this assumption removes a lot of error handling elsewhere.
+const getCurrencyFromCurrencyCode = (currencyCode) => {
+    if (typeof currencyCode !== 'string' || !currencies[currencyCode]) {
+        console.error(new Error(`Invalid currencyCode: ${currencyCode}. Falling back to 'AUD'.`));
+        return currencies.AUD;
+    }
+    return currencies[currencyCode];
+};
+exports.getCurrencyFromCurrencyCode = getCurrencyFromCurrencyCode;
+const makeMoneyString = ({ amount: inputAmount, currencyCode, rounded = false, showCurrencyCode = false }) => {
+    let amount = Number(inputAmount);
+    if (isNaN(amount)) {
+        console.error(new Error(`Invalid amount: ${inputAmount}. Falling back to 0.`));
+        amount = 0;
+    }
+    const currency = (0, exports.getCurrencyFromCurrencyCode)(currencyCode);
+    const { minorUnit, symbol } = currency;
+    const decimalPlaces = rounded ? 0 : minorUnit;
+    const localeAmount = amount.toLocaleString(undefined, {
+        minimumFractionDigits: decimalPlaces,
+        maximumFractionDigits: decimalPlaces,
+    });
+    const currencyCodeString = showCurrencyCode ? ` ${currency.code}` : '';
+    return `${symbol}${localeAmount}${currencyCodeString}`;
+};
+exports.makeMoneyString = makeMoneyString;

package/lib/src/opportunity.d.ts

@@ -0,0 +1 @@
+export declare const readableOpportunityType: (type: any) => string | null;

package/lib/src/opportunity.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readableOpportunityType = void 0;
+const { opportunities } = require('@becollective/constants');
+const { typesMapV2: opportunityTypes } = opportunities;
+const TYPE_MAP = {
+    [opportunityTypes.shift]: 'Shifts',
+    [opportunityTypes.flexible]: 'Flexible',
+};
+const readableOpportunityType = (type) => TYPE_MAP[type] || null;
+exports.readableOpportunityType = readableOpportunityType;

package/lib/src/opportunityUser.d.ts

@@ -0,0 +1,8 @@
+/**
+ *
+ * @param {*} opportunityUser
+ * @param {*} opportunity
+ */
+export declare const getTimeInfo: (opportunityUser: any, opportunity?: null) => {
+    [k: string]: unknown;
+};

package/lib/src/opportunityUser.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTimeInfo = void 0;
+const pick = (obj, keysToPick = []) => {
+    return Object.fromEntries(Object.entries(obj).filter(([key]) => keysToPick.includes(key)));
+};
+/**
+ *
+ * @param {*} opportunityUser
+ * @param {*} opportunity
+ */
+const getTimeInfo = (opportunityUser, opportunity = null) => {
+    const opp = opportunity || opportunityUser.opportunity;
+    const isEoi = (opportunityUser && opportunityUser.eoi) || (opp && opp.eoi);
+    const record = isEoi ? opportunityUser : opp;
+    const fields = pick(record, [
+        'startDate',
+        'endDate',
+        'type',
+        'dates',
+        'recurrenceRule',
+        'timezone',
+        'location',
+        'locationOther',
+        'locationVirtual',
+    ]);
+    return fields;
+};
+exports.getTimeInfo = getTimeInfo;

package/lib/src/password.d.ts

@@ -0,0 +1,8 @@
+export declare const password: {
+    hasUppercase: (input: any) => boolean;
+    hasLowerCase: (input: any) => boolean;
+    hasNumeral: (input: any) => boolean;
+    validate: (input: any) => boolean;
+    isValid: (input: any) => boolean;
+};
+export default password;

package/lib/src/password.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.password = void 0;
+exports.password = {
+    hasUppercase: (input) => {
+        return !!input.match(/[A-Z]/);
+    },
+    hasLowerCase: (input) => {
+        return !!input.match(/[a-z]/);
+    },
+    hasNumeral: (input) => {
+        return !!input.match(/[0-9]/);
+    },
+    validate: (input) => {
+        if (typeof input !== 'string') {
+            throw new Error('not-string');
+        }
+        else if (input.length < 12) {
+            throw new Error('invalid-length');
+        }
+        let rules = 0;
+        if (exports.password.hasUppercase(input))
+            rules++;
+        if (exports.password.hasLowerCase(input))
+            rules++;
+        if (exports.password.hasNumeral(input))
+            rules++;
+        if (rules < 3) {
+            throw new Error('invalid-minimum-rules');
+        }
+        return true;
+    },
+    isValid: (input) => {
+        try {
+            exports.password.validate(input);
+            return true;
+        }
+        catch (e) {
+            return false;
+        }
+    },
+};
+exports.default = exports.password;

package/package.json

@@ -1,46 +1,32 @@
 {
   "name": "@becollective/utils",
-  "version": "1.10.2",
+  "version": "2.0.0",
   "description": "Common utilities",
   "main": "bundle.js",
   "scripts": {
     "test": "npm run build && NODE_ENV=localtest jest --config jestconfig.json --detectOpenHandles --verbose --forceExit",
-    "build": "rollup -c",
+    "build": "tsc",
     "prepare": "npm run build"
   },
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@babel/core": "^7.1.6",
-    "@babel/preset-env": "^7.1.6",
-    "@rollup/plugin-commonjs": "^18.1.0",
-    "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-typescript": "^8.2.1",
-    "@types/jest": "^24.0.19",
-    "@types/mongodb": "^3.5.16",
-    "@types/node": "^15.0.1",
-    "@types/pino": "^5.8.12",
-    "jest": "^24.9.0",
-    "prettier": "^1.18.2",
-    "rollup": "^2.47.0",
-    "rollup-plugin-babel": "^4.0.3",
-    "rollup-plugin-node-resolve": "^3.4.0",
-    "ts-jest": "^24.3.0",
-    "tslint": "^5.20.0",
+    "@types/jest": "^30.0.0",
+    "@types/mongodb": "^4.0.7",
+    "@types/node": "^25.6.0",
+    "@types/pino": "^7.0.5",
+    "jest": "^30.3.0",
+    "prettier": "^3.8.3",
+    "ts-jest": "^29.4.9",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.6.4"
+    "typescript": "^6.0.3"
   },
   "dependencies": {
     "@becollective/constants": "^3.11.0",
-    "axios": "^0.21.1",
-    "lodash": "^4.17.15",
-    "moment": "^2.24.0",
-    "moment-timezone": "^0.5.26"
-  },
-  "peerDependencies": {
-    "axios": "^0.21.1",
-    "lodash": "^4.17.15",
-    "moment": "^2.24.0",
-    "moment-timezone": "^0.5.26"
+    "ajv": "^8.20.0",
+    "libphonenumber-js": "^1.13.5",
+    "luxon": "^3.7.2",
+    "rrule": "^2.8.1"
   }
 }

package/src/FeatureFlag.ts

@@ -1,20 +1,35 @@
-import axios from 'axios';
-import { memoize, get as lodashGet } from 'lodash';
+type Cache = {
+  store: Map<string, string>;
+  memoize: Function;
+}
+
+const cache: Cache = {
+  store: new Map(),
+  memoize: async (feature, options) => {
+    const stringified = JSON.stringify({ feature, options });
+    const response = cache.store.get(stringified);
+    if(response) {
+      return JSON.parse(response);
+    }
+    const fetchResponse = await fetchFeatureActive(feature, options);
+    cache.store.set(stringified, JSON.stringify(fetchResponse));
+    return fetchResponse;
+  },
+}
 
 const fetchFeatureActive = async (feature: string, options: { env: string; region?: string }): Promise<boolean> => {
   const getFlagByFeatureUrl = `https://lb-central.becollective.com/api/v2/feature-flags/${feature}`;
   let isFeatureActive = false;
-  const featureFlags = await axios.get(getFlagByFeatureUrl);
-  const environments = lodashGet(featureFlags, 'data.Environments');
+  const featureFlags = await fetch(getFlagByFeatureUrl, { method: 'get' });
+  const json: any = await featureFlags.json();
+  const environments = json.Environments;
   if (environments) {
     isFeatureActive = environments.includes(options.env);
   }
   return isFeatureActive;
 };
 
-const memoizedFeatureActive = memoize(fetchFeatureActive, (feature, options) => JSON.stringify({ feature, options }));
-
-class FeatureFlag {
+export class FeatureFlag {
   ttl: number;
   expiry: number;
   constructor(ttl?) {
@@ -25,13 +40,14 @@ class FeatureFlag {
     // Lazy expiration upon function call
     const now = Date.now();
     if (now >= this.expiry) {
-      memoizedFeatureActive.cache.clear();
+      cache.store.clear();
       this.expiry = now + this.ttl;
     }
-    return await memoizedFeatureActive(feature, options);
+
+    return cache.memoize(feature, options);
   }
   clearCache() {
-    memoizedFeatureActive.cache.clear();
+    cache.store.clear();
   }
   setCacheTtl(ttl: number) {
     this.ttl = ttl;

package/src/constants/allowedHtmlTags.ts

@@ -0,0 +1,6 @@
+export default {
+  allowedTags: ['b', 'i', 'em', 'strong', 'a', 'p', 'u', 'del', 'div', 'ins', 'li', 'ul', 'ol', 'br'],
+  allowedAttributes: {
+    a: ['href', 'target', 'rel'],
+  },
+};

package/src/constants/avatarColours.ts

@@ -0,0 +1,34 @@
+export default {
+  watusi: {
+    backgroundColour: '#f5d0b9',
+    textColour: '#845235',
+  },
+  hawkesBlue: {
+    backgroundColour: '#f6dae4',
+    textColour: '#8b4960',
+  },
+  botticelli: {
+    backgroundColour: '#cedde9',
+    textColour: '#46637d',
+  },
+  surfCrest: {
+    backgroundColour: '#c8d8c2',
+    textColour: '#49623f',
+  },
+  quarterSpanishWhite: {
+    backgroundColour: '#e9e0d2',
+    textColour: '#7a6114',
+  },
+  buttermilk: {
+    backgroundColour: '#f1e0ab',
+    textColour: '#635429',
+  },
+  fog: {
+    backgroundColour: '#e0d8ee',
+    textColour: '#625082',
+  },
+  mabel: {
+    backgroundColour: '#c1e6e5',
+    textColour: '#426968',
+  },
+};

package/src/constants/countries.ts

@@ -0,0 +1,252 @@
+export default {
+  BD: 'Bangladesh',
+  BE: 'Belgium',
+  BF: 'Burkina Faso',
+  BG: 'Bulgaria',
+  BA: 'Bosnia and Herzegovina',
+  BB: 'Barbados',
+  WF: 'Wallis and Futuna',
+  BL: 'Saint Barthelemy',
+  BM: 'Bermuda',
+  BN: 'Brunei',
+  BO: 'Bolivia',
+  BH: 'Bahrain',
+  BI: 'Burundi',
+  BJ: 'Benin',
+  BT: 'Bhutan',
+  JM: 'Jamaica',
+  BV: 'Bouvet Island',
+  BW: 'Botswana',
+  WS: 'Samoa',
+  BQ: 'Bonaire, Saint Eustatius and Saba ',
+  BR: 'Brazil',
+  BS: 'Bahamas',
+  JE: 'Jersey',
+  BY: 'Belarus',
+  BZ: 'Belize',
+  RU: 'Russia',
+  RW: 'Rwanda',
+  RS: 'Serbia',
+  TL: 'East Timor',
+  RE: 'Reunion',
+  TM: 'Turkmenistan',
+  TJ: 'Tajikistan',
+  RO: 'Romania',
+  TK: 'Tokelau',
+  GW: 'Guinea-Bissau',
+  GU: 'Guam',
+  GT: 'Guatemala',
+  GS: 'South Georgia and the South Sandwich Islands',
+  GR: 'Greece',
+  GQ: 'Equatorial Guinea',
+  GP: 'Guadeloupe',
+  JP: 'Japan',
+  GY: 'Guyana',
+  GG: 'Guernsey',
+  GF: 'French Guiana',
+  GE: 'Georgia',
+  GD: 'Grenada',
+  GB: 'United Kingdom',
+  GA: 'Gabon',
+  SV: 'El Salvador',
+  GN: 'Guinea',
+  GM: 'Gambia',
+  GL: 'Greenland',
+  GI: 'Gibraltar',
+  GH: 'Ghana',
+  OM: 'Oman',
+  TN: 'Tunisia',
+  JO: 'Jordan',
+  HR: 'Croatia',
+  HT: 'Haiti',
+  HU: 'Hungary',
+  HK: 'Hong Kong',
+  HN: 'Honduras',
+  HM: 'Heard Island and McDonald Islands',
+  VE: 'Venezuela',
+  PR: 'Puerto Rico',
+  PS: 'Palestinian Territory',
+  PW: 'Palau',
+  PT: 'Portugal',
+  SJ: 'Svalbard and Jan Mayen',
+  PY: 'Paraguay',
+  IQ: 'Iraq',
+  PA: 'Panama',
+  PF: 'French Polynesia',
+  PG: 'Papua New Guinea',
+  PE: 'Peru',
+  PK: 'Pakistan',
+  PH: 'Philippines',
+  PN: 'Pitcairn',
+  PL: 'Poland',
+  PM: 'Saint Pierre and Miquelon',
+  ZM: 'Zambia',
+  EH: 'Western Sahara',
+  EE: 'Estonia',
+  EG: 'Egypt',
+  ZA: 'South Africa',
+  EC: 'Ecuador',
+  IT: 'Italy',
+  VN: 'Vietnam',
+  SB: 'Solomon Islands',
+  ET: 'Ethiopia',
+  SO: 'Somalia',
+  ZW: 'Zimbabwe',
+  SA: 'Saudi Arabia',
+  ES: 'Spain',
+  ER: 'Eritrea',
+  ME: 'Montenegro',
+  MD: 'Moldova',
+  MG: 'Madagascar',
+  MF: 'Saint Martin',
+  MA: 'Morocco',
+  MC: 'Monaco',
+  UZ: 'Uzbekistan',
+  MM: 'Myanmar',
+  ML: 'Mali',
+  MO: 'Macao',
+  MN: 'Mongolia',
+  MH: 'Marshall Islands',
+  MK: 'Macedonia',
+  MU: 'Mauritius',
+  MT: 'Malta',
+  MW: 'Malawi',
+  MV: 'Maldives',
+  MQ: 'Martinique',
+  MP: 'Northern Mariana Islands',
+  MS: 'Montserrat',
+  MR: 'Mauritania',
+  IM: 'Isle of Man',
+  UG: 'Uganda',
+  TZ: 'Tanzania',
+  MY: 'Malaysia',
+  MX: 'Mexico',
+  IL: 'Israel',
+  FR: 'France',
+  IO: 'British Indian Ocean Territory',
+  SH: 'Saint Helena',
+  FI: 'Finland',
+  FJ: 'Fiji',
+  FK: 'Falkland Islands',
+  FM: 'Micronesia',
+  FO: 'Faroe Islands',
+  NI: 'Nicaragua',
+  NL: 'Netherlands',
+  NO: 'Norway',
+  NA: 'Namibia',
+  VU: 'Vanuatu',
+  NC: 'New Caledonia',
+  NE: 'Niger',
+  NF: 'Norfolk Island',
+  NG: 'Nigeria',
+  NZ: 'New Zealand',
+  NP: 'Nepal',
+  NR: 'Nauru',
+  NU: 'Niue',
+  CK: 'Cook Islands',
+  XK: 'Kosovo',
+  CI: 'Ivory Coast',
+  CH: 'Switzerland',
+  CO: 'Colombia',
+  CN: 'China',
+  CM: 'Cameroon',
+  CL: 'Chile',
+  CC: 'Cocos Islands',
+  CA: 'Canada',
+  CG: 'Republic of the Congo',
+  CF: 'Central African Republic',
+  CD: 'Democratic Republic of the Congo',
+  CZ: 'Czech Republic',
+  CY: 'Cyprus',
+  CX: 'Christmas Island',
+  CR: 'Costa Rica',
+  CW: 'Curacao',
+  CV: 'Cape Verde',
+  CU: 'Cuba',
+  SZ: 'Swaziland',
+  SY: 'Syria',
+  SX: 'Sint Maarten',
+  KG: 'Kyrgyzstan',
+  KE: 'Kenya',
+  SS: 'South Sudan',
+  SR: 'Suriname',
+  KI: 'Kiribati',
+  KH: 'Cambodia',
+  KN: 'Saint Kitts and Nevis',
+  KM: 'Comoros',
+  ST: 'Sao Tome and Principe',
+  SK: 'Slovakia',
+  KR: 'South Korea',
+  SI: 'Slovenia',
+  KP: 'North Korea',
+  KW: 'Kuwait',
+  SN: 'Senegal',
+  SM: 'San Marino',
+  SL: 'Sierra Leone',
+  SC: 'Seychelles',
+  KZ: 'Kazakhstan',
+  KY: 'Cayman Islands',
+  SG: 'Singapore',
+  SE: 'Sweden',
+  SD: 'Sudan',
+  DO: 'Dominican Republic',
+  DM: 'Dominica',
+  DJ: 'Djibouti',
+  DK: 'Denmark',
+  VG: 'British Virgin Islands',
+  DE: 'Germany',
+  YE: 'Yemen',
+  DZ: 'Algeria',
+  US: 'United States',
+  UY: 'Uruguay',
+  YT: 'Mayotte',
+  UM: 'United States Minor Outlying Islands',
+  LB: 'Lebanon',
+  LC: 'Saint Lucia',
+  LA: 'Laos',
+  TV: 'Tuvalu',
+  TW: 'Taiwan',
+  TT: 'Trinidad and Tobago',
+  TR: 'Turkey',
+  LK: 'Sri Lanka',
+  LI: 'Liechtenstein',
+  LV: 'Latvia',
+  TO: 'Tonga',
+  LT: 'Lithuania',
+  LU: 'Luxembourg',
+  LR: 'Liberia',
+  LS: 'Lesotho',
+  TH: 'Thailand',
+  TF: 'French Southern Territories',
+  TG: 'Togo',
+  TD: 'Chad',
+  TC: 'Turks and Caicos Islands',
+  LY: 'Libya',
+  VA: 'Vatican',
+  VC: 'Saint Vincent and the Grenadines',
+  AE: 'United Arab Emirates',
+  AD: 'Andorra',
+  AG: 'Antigua and Barbuda',
+  AF: 'Afghanistan',
+  AI: 'Anguilla',
+  VI: 'U.S. Virgin Islands',
+  IS: 'Iceland',
+  IR: 'Iran',
+  AM: 'Armenia',
+  AL: 'Albania',
+  AO: 'Angola',
+  AQ: 'Antarctica',
+  AS: 'American Samoa',
+  AR: 'Argentina',
+  AU: 'Australia',
+  AT: 'Austria',
+  AW: 'Aruba',
+  IN: 'India',
+  AX: 'Aland Islands',
+  AZ: 'Azerbaijan',
+  IE: 'Ireland',
+  ID: 'Indonesia',
+  UA: 'Ukraine',
+  QA: 'Qatar',
+  MZ: 'Mozambique',
+};

package/src/constants/currencies.ts

@@ -0,0 +1,33 @@
+import getSymbol from 'currency-symbol-map';
+
+// ISO reference: https://www.currency-iso.org/en/home/tables/table-a1.html. This is what Intl.NumberFormat() uses.
+
+// These are the currently supported currencies on our platform
+export default {
+  AUD: {
+    code: 'AUD',
+    name: 'Australian Dollar',
+    minorUnit: 2, // The number of digits after the decimal separator.
+    symbol: getSymbol('AUD'),
+    prefix: 'A', // To identify which currency when use the same symbol
+  },
+  NZD: {
+    code: 'NZD',
+    name: 'New Zealand Dollar',
+    minorUnit: 2,
+    symbol: getSymbol('NZD'),
+    prefix: 'NZ',
+  },
+  GBP: {
+    code: 'GBP',
+    name: 'Pound Sterling',
+    minorUnit: 2,
+    symbol: getSymbol('GBP'),
+  },
+  EUR: {
+    code: 'EUR',
+    name: 'Euro',
+    minorUnit: 2,
+    symbol: getSymbol('EUR'),
+  },
+};

package/src/constants/customFields.ts

@@ -0,0 +1,10 @@
+export default {
+  maxMongoStringLength: 4096, // https://github.com/mongodb/mongo/blob/master/src/mongo/shell/linenoise.cpp#L145
+  maxFileSizeBytes: 16000000, // 16 MB https://docs.mongodb.com/manual/reference/limits/
+  emailReferenceHeadingString: 'Email (ref.)',
+  uploadBatchSize: 25,
+  fNameReferenceHeadingString: 'First name (ref.)',
+  lNameReferenceHeadingString: 'Last name (ref.)',
+  maxNumberOfRows: 501, // 500 rows + headings row
+  templateFileName: 'Custom_Fields_Template.csv', // should end in .csv
+};

package/src/constants/distancesUnits.ts

@@ -0,0 +1,11 @@
+// These align to https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#distance-units
+export default {
+  km: {
+    long: 'kilometers',
+    short: 'km',
+  },
+  mi: {
+    long: 'miles',
+    short: 'mi',
+  },
+};