@qikdev/sdk 0.1.180 → 0.1.182

package/src/api/qik.utils.js

@@ -1,12 +1,10 @@
-import _get from 'lodash/get.js';
-import _isDate from 'lodash/isDate.js';
-import _startsWith from 'lodash/startsWith.js';
-import _isObject from 'lodash/isObject.js';
-import _camelCase from 'lodash/camelCase.js';
-import axios from 'axios';
-import { isBrowser, isNode } from 'browser-or-node';
-
-
+import _get from "lodash/get.js";
+import _isDate from "lodash/isDate.js";
+import _startsWith from "lodash/startsWith.js";
+import _isObject from "lodash/isObject.js";
+import _camelCase from "lodash/camelCase.js";
+import axios from "axios";
+import { isBrowser, isNode } from "browser-or-node";
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -14,8 +12,7 @@ const service = {};
 
 ////////////////////////////////////
 
-const loadedExternalScripts = {}
-
+const loadedExternalScripts = {};
 
 /**
  * A function that dynamically include an external javascript resource
@@ -23,53 +20,46 @@ const loadedExternalScripts = {}
  * @alias utils.loadExternalScript
  * @param  {String} url The url of the external script
  * @return {Promise}    A promise that will be resolved once the script has been loaded
- * @example 
- * 
+ * @example
+ *
  * await sdk.utils.loadExternalScript('https://cdn.javascript.com/external/script.js');
  */
 
+service.loadExternalScript = function (url) {
+  // If we already have a promise
+  if (loadedExternalScripts[url]) {
+    // return the existing promise
+    return loadedExternalScripts[url];
+  }
 
-service.loadExternalScript = function(url) {
+  // Create a new promise
+  const promise = (loadedExternalScripts[url] = new Promise(createNewScript));
 
-    // If we already have a promise
-    if (loadedExternalScripts[url]) {
-        // return the existing promise
-        return loadedExternalScripts[url];
+  function createNewScript(resolve, reject) {
+    if (!document) {
+      delete loadedExternalScripts[url];
+      return reject("document is undefined");
     }
 
+    //////////////////////////////////////
 
-    // Create a new promise
-    const promise = loadedExternalScripts[url] = new Promise(createNewScript);
-
-    function createNewScript(resolve, reject) {
+    var script = document.createElement("script");
+    script.type = "text/javascript";
+    script.async = true;
+    script.onload = function () {
+      console.log("Loaded external script", url);
+      return resolve(url);
+    };
+    script.src = url;
 
-        if (!document) {
-            delete loadedExternalScripts[url];
-            return reject('document is undefined')
-        }
-
-        //////////////////////////////////////
-
-        var script = document.createElement('script');
-        script.type = 'text/javascript';
-        script.async = true;
-        script.onload = function() {
-            console.log('Loaded external script', url);
-            return resolve(url);
-        };
-        script.src = url;
+    // Inject it into the document's <head> tag
+    document.head.appendChild(script);
+  }
 
-        // Inject it into the document's <head> tag
-        document.head.appendChild(script);
-
-    }
-
-    return promise;
-}
-
-
-const loadedExternalStyles = {}
+  return promise;
+};
 
+const loadedExternalStyles = {};
 
 /**
  * A function that dynamically include an external css resource
@@ -77,606 +67,794 @@ const loadedExternalStyles = {}
  * @alias utils.loadExternalStyle
  * @param  {String} url The url of the external css
  * @return {Promise}    A promise that will be resolved once the css has been loaded
- * @example 
- * 
+ * @example
+ *
  * await sdk.utils.loadExternalStyle('https://cdn.css.com/external/style.css');
  */
-service.loadExternalStyle = function(url) {
-
-    const promise = new Promise(createNewScript);
-
-    function createNewScript(resolve, reject) {
-
-        if (!document) {
-            return reject('document is undefined')
-        }
-
-        if (loadedExternalStyles[url]) {
-            return resolve(url);
-        }
+service.loadExternalStyle = function (url) {
+  const promise = new Promise(createNewScript);
 
-        // Avoid duplicate scripts
-        loadedExternalStyles[url] = true;
+  function createNewScript(resolve, reject) {
+    if (!document) {
+      return reject("document is undefined");
+    }
 
-        //////////////////////////////////////
+    if (loadedExternalStyles[url]) {
+      return resolve(url);
+    }
 
-        var script = document.createElement('link');
-        script.setAttribute('rel', 'stylesheet')
-        script.setAttribute('type', 'text/css')
-        script.setAttribute('href', url)
-        script.onload = function() {
-            console.log('Loaded external stylesheet', url);
-            return resolve(url);
-        };
+    // Avoid duplicate scripts
+    loadedExternalStyles[url] = true;
 
-        // Inject it into the document's <head> tag
-        document.head.appendChild(script);
+    //////////////////////////////////////
 
-    }
+    var script = document.createElement("link");
+    script.setAttribute("rel", "stylesheet");
+    script.setAttribute("type", "text/css");
+    script.setAttribute("href", url);
+    script.onload = function () {
+      console.log("Loaded external stylesheet", url);
+      return resolve(url);
+    };
 
-    return promise;
-}
+    // Inject it into the document's <head> tag
+    document.head.appendChild(script);
+  }
 
+  return promise;
+};
 
 ///////////////////////////////////////////////////////////////////////////////
 
-service.exists = function(value) {
-    var isUndefinedOrNull;
-
-    ////////////////////////
-
-    if (Array.isArray(value)) {
-        return true;
-    }
+/**
+ * A helper function for checking whether a value is truthy/falsy
+ * @alias utils.exists
+ * @param  {Anything} value The value to check
+ * @return {Boolean}  whether the value is truthy
+ * @example
+ *
+ * sdk.utils.exists('undefined'); // false
+ * sdk.utils.exists([]); // true
+ * sdk.utils.exists(''); // false
+ * sdk.utils.exists(undefined); // false
+ */
+service.exists = function (value) {
+  var isUndefinedOrNull;
 
-    ////////////////////////
+  ////////////////////////
 
-    if (value === 0) {
-        return true;
-    }
+  if (Array.isArray(value)) {
+    return true;
+  }
 
-    ////////////////////////
-
-    switch (typeof value) {
-        case 'undefined':
-        case 'null':
-            isUndefinedOrNull = true;
-            break;
-        default:
-            var string = String(value).toLowerCase();
-            switch (string) {
-                case '':
-                case 'undefined':
-                case 'null':
-                    isUndefinedOrNull = true;
-                    break;
-            }
-            break;
-    }
+  ////////////////////////
 
-    return !!!isUndefinedOrNull;
-}
+  if (value === 0) {
+    return true;
+  }
+
+  ////////////////////////
+
+  switch (typeof value) {
+    case "undefined":
+    case "null":
+      isUndefinedOrNull = true;
+      break;
+    default:
+      var string = String(value).toLowerCase();
+      switch (string) {
+        case "":
+        case "undefined":
+        case "null":
+          isUndefinedOrNull = true;
+          break;
+      }
+      break;
+  }
+
+  return !!!isUndefinedOrNull;
+};
 
 //////////////////////////////////
 
-service.parseDate = function(input) {
-
-    if (!input) {
-        return;
-    }
-
-    if (_isDate(input)) {
-        return input;
-    }
-
-    //Attempt to create a date
-    var d = new Date(input);
-    var isValid = d instanceof Date && !isNaN(d);
-
-    if (isValid) {
-        return d;
-    }
-
+/**
+ * A helper function for getting a javascript date object from some input
+ * returns undefined if it can not be parsed
+ * @alias utils.parseDate
+ * @param  {String|Number} input The value to parse as a date
+ * @return {Date}  the javascript date object
+ * @example
+ *
+ * sdk.utils.parseDate(input);
+ */
+service.parseDate = function (input) {
+  if (!input) {
     return;
-}
-
-service.parseURL = function(string) {
-
-    if (!string) {
-        return false;
-    }
-
-    const relative = _startsWith(string, '/');
-    if (relative) {
-        return string;
-    }
-
-    if (_startsWith(string, '://')) {
-        return string;
-    }
-
-    if (_startsWith(string, 'mailto:')) {
-        return string;
-    }
-
-    if (_startsWith(string, 'tel:')) {
-        return string;
-    }
-
-    if (_startsWith(string, 'sms:')) {
-        return string;
-    }
-
-    //////////////////////////////////
-    //If someone entered an email by accident
-    var email = service.parseEmail(string);
-    //Convert it to a mailto link
-    if (email && email === string) {
-        return `mailto:${email}`
-    }
-
-    //////////////////////////////////
-
-    const withHttp = string => !/^https?:\/\//i.test(string) ? `http://${string}` : string;
-    string = withHttp(string);
-    //TODO: test this more.
-    string = string.replace(/\s/g, '');
-
-
-
-
+  }
 
+  if (_isDate(input)) {
+    return input;
+  }
 
-    var valid = RegExp('(https?:\\/\\/)?((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|((\\d{1,3}\\.){3}\\d{1,3}))(\\:\\d+)?(\\/[-a-z\\d%_.~+@]*)*(\\?[;&a-z\\d%_.~+=-@]*)?(\\#[-a-z\\d_@]*)?$', 'i').test(string);
-
-    if (!valid) {
-        return false;
-    }
-
+  //Attempt to create a date
+  var d = new Date(input);
+  var isValid = d instanceof Date && !isNaN(d);
 
+  if (isValid) {
+    return d;
+  }
 
-    ///////////////////////////
-
-    return withHttp(string)
-}
+  return;
+};
 
+/**
+ * A helper function for getting a full url string from some input
+ * @alias utils.parseURL
+ * @param  {String} input The input value
+ * @return {String}  the fully parsed URL
+ * @example
+ *
+ * sdk.utils.parseURL('google.com'); // Returns https://google.com
+ * sdk.utils.parseURL('mailto:hello@qik.dev'); // Returns 'mailto:hello@qik.dev'
+ * sdk.utils.parseURL('://hello.com'); // Returns '://hello.com'
+ * sdk.utils.parseURL('hello@email.com'); // Returns 'mailto:hello@email.com'
+ */
+service.parseURL = function (string) {
+  if (!string) {
+    return false;
+  }
+
+  const relative = _startsWith(string, "/");
+  if (relative) {
+    return string;
+  }
+
+  if (_startsWith(string, "://")) {
+    return string;
+  }
+
+  if (_startsWith(string, "mailto:")) {
+    return string;
+  }
+
+  if (_startsWith(string, "tel:")) {
+    return string;
+  }
+
+  if (_startsWith(string, "sms:")) {
+    return string;
+  }
+
+  //////////////////////////////////
+  //If someone entered an email by accident
+  var email = service.parseEmail(string);
+  //Convert it to a mailto link
+  if (email && email === string) {
+    return `mailto:${email}`;
+  }
+
+  //////////////////////////////////
+
+  const withHttp = (string) =>
+    !/^https?:\/\//i.test(string) ? `http://${string}` : string;
+  string = withHttp(string);
+  //TODO: test this more.
+  string = string.replace(/\s/g, "");
+
+  var valid = RegExp(
+    "(https?:\\/\\/)?((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|((\\d{1,3}\\.){3}\\d{1,3}))(\\:\\d+)?(\\/[-a-z\\d%_.~+@]*)*(\\?[;&a-z\\d%_.~+=-@]*)?(\\#[-a-z\\d_@]*)?$",
+    "i",
+  ).test(string);
+
+  if (!valid) {
+    return false;
+  }
+
+  ///////////////////////////
+
+  return withHttp(string);
+};
 
 ///////////////////////////////////////////////
 
-service.parseNumber = function(input, decimalPoints) {
-    if (!input) {
-        return 0;
-    }
-
-    input = Number(input);
-    if (isNaN(input)) {
-        return 0;
-    }
-
-    if (decimalPoints) {
-        var str = input.toFixed(decimalPoints);
-        input = service.parseNumber(str);
-    }
-
-    return input;
-}
-
-
-service.isValidEmailAddress = function(email) {
-
-    var tester = /^[-!#$%&'*+\/0-9=?A-Z^_a-z`{|}~](\.?[-!#$%&'*+\/0-9=?A-Z^_a-z`{|}~])*@[a-zA-Z0-9](-*\.?[a-zA-Z0-9])*\.[a-zA-Z](-?[a-zA-Z0-9])+$/;
+/**
+ * A helper function for getting a number from some input
+ * @alias utils.parseNumber
+ * @param  {String} value The input value
+ * @param  {Number} decimalPoints The number of decimal points to round to
+ * @return {Number}  the parsed number value
+ * @example
+ *
+ * sdk.utils.parseNumber('123'); // Returns 123
+ * sdk.utils.parseNumber('75.501', 2); // Returns 75.5
+ * sdk.utils.parseNumber(''); // Returns 0
+ * sdk.utils.parseNumber(null); // Returns 0
+ * sdk.utils.parseNumber(); // Returns 0
+ */
+service.parseNumber = function (input, decimalPoints) {
+  if (!input) {
+    return 0;
+  }
 
-    if (!email) return false;
+  input = Number(input);
+  if (isNaN(input)) {
+    return 0;
+  }
 
-    var emailParts = email.split('@');
+  if (decimalPoints) {
+    var str = input.toFixed(decimalPoints);
+    input = service.parseNumber(str);
+  }
 
-    if (emailParts.length !== 2) return false
+  return input;
+};
 
-    var account = emailParts[0];
-    var address = emailParts[1];
+/**
+ * A helper function for getting a number from some input
+ * @alias utils.isValidEmailAddress
+ * @param  {String} emailAddress The email to validate
+ * @return {Boolean} whether or not the input is a valid email address
+ * @example
+ *
+ * sdk.utils.isValidEmailAddress('123.com'); // Returns false
+ * sdk.utils.isValidEmailAddress('hello@world.com'); // Returns true
+ * sdk.utils.isValidEmailAddress('something@special.io'); // Returns true
+ */
+service.isValidEmailAddress = function (email) {
+  var tester =
+    /^[-!#$%&'*+\/0-9=?A-Z^_a-z`{|}~](\.?[-!#$%&'*+\/0-9=?A-Z^_a-z`{|}~])*@[a-zA-Z0-9](-*\.?[a-zA-Z0-9])*\.[a-zA-Z](-?[a-zA-Z0-9])+$/;
 
-    if (account.length > 64) return false
+  if (!email) return false;
 
-    else if (address.length > 255) return false
+  var emailParts = email.split("@");
 
-    var domainParts = address.split('.');
-    if (domainParts.some(function(part) {
-            return part.length > 63;
-        })) return false;
+  if (emailParts.length !== 2) return false;
 
+  var account = emailParts[0];
+  var address = emailParts[1];
 
-    if (!tester.test(email)) return false;
+  if (account.length > 64) return false;
+  else if (address.length > 255) return false;
 
-    return true;
-}
+  var domainParts = address.split(".");
+  if (
+    domainParts.some(function (part) {
+      return part.length > 63;
+    })
+  )
+    return false;
 
+  if (!tester.test(email)) return false;
 
-service.parseEmail = function(input) {
+  return true;
+};
 
-    if (!input) {
-        return false;
-    }
+/**
+ * A helper function for getting a formatted email address
+ * @alias utils.parseEmail
+ * @param  {String} emailAddress The input to parse as an email
+ * @return {String|Boolean} a valid email address in lowercase, or false if parse is not possible
+ * @example
+ *
+ * sdk.utils.parseEmail('ToMack@gmail.com'); // returns 'tomack@gmail.com'
+ * sdk.utils.isValidEmailAddress('hello.world.com'); // Returns false
+ */
+service.parseEmail = function (input) {
+  if (!input) {
+    return false;
+  }
 
-    var lowercase = String(input).toLowerCase();
-    var valid = service.isValidEmailAddress(lowercase);
+  var lowercase = String(input).toLowerCase();
+  var valid = service.isValidEmailAddress(lowercase);
 
-    if (!valid) {
-        return false;
-    } else {
-        return lowercase;
-    }
-}
+  if (!valid) {
+    return false;
+  } else {
+    return lowercase;
+  }
+};
 
 //////////////////////////////////
 
-service.parseInt = function(input) {
-    if (!input) {
-        return 0;
-    }
-
-    input = parseInt(input);
-    if (isNaN(input)) {
-        return 0;
-    }
-
-    return input;
-}
-
-
-
-service.cleanValue = function(data, type, options) {
+/**
+ * A helper function for getting an integer
+ * @alias utils.parseInt
+ * @param  {String|Number} input The input to parse as an integer
+ * @return {Integer} the resulting integer or 0
+ * @example
+ *
+ * sdk.utils.parseInt('134'); // returns 134
+ * sdk.utils.parseInt('cows'); // returns 0
+ * sdk.utils.parseInt(); // returns 0
+ */
+service.parseInt = function (input) {
+  if (!input) {
+    return 0;
+  }
 
-    if (!options) {
-        options = {};
-    }
+  input = parseInt(input);
+  if (isNaN(input)) {
+    return 0;
+  }
 
-    ////////////////////////
+  return input;
+};
 
-    var noInputValue = service.exists(data);
-    if (options.strict && noInputValue && type != 'boolean') {
+/**
+ * A helper function for cleaning an input value to match
+ * a required type
+ * @alias utils.cleanValue
+ * @param  {*} data The input to clean
+ * @param  {String} type The data type to parse
+ * @param  {Object} options Additional options for parsing
+ * @return {*} the resulting cleaned value
+ * @example
+ *
+ * sdk.utils.cleanValue({_id:'1234', title:'Item'...}, 'reference'); // returns '1234'
+ * sdk.utils.cleanValue('true', 'boolean'); // returns true
+ * sdk.utils.cleanValue('Mr Rogers House', 'key'); // returns 'mrRogersHouse';
+ * sdk.utils.cleanValue('Hello.World@email.COM', 'email'); // returns 'hello.world@email.com';
+ */
+service.cleanValue = function (data, type, options) {
+  if (!options) {
+    options = {};
+  }
+
+  ////////////////////////
+
+  var noInputValue = service.exists(data);
+  if (options.strict && noInputValue && type != "boolean") {
+    return data;
+  }
+
+  ////////////////////////
+
+  switch (type) {
+    case "reference":
+      return service.id(data, true);
+      break;
+    case "boolean":
+      return service.parseBoolean(data);
+      break;
+    case "url":
+      return service.parseURL(data);
+      break;
+    case "key":
+      return service.machineName(data);
+      break;
+    case "email":
+      return service.parseEmail(data);
+      break;
+    case "date":
+      var parsed = service.parseDate(data, options);
+
+      if (parsed === undefined) {
+        return;
+      } else {
+        return parsed;
+      }
+      break;
+    case "number":
+    case "decimal":
+    case "float":
+      var val = service.parseNumber(data);
+      if (String(val) == String(Number(data))) {
+        return val;
+      }
+      return;
+      break;
+    case "integer":
+      var val = service.parseInt(data);
+      if (String(val) == String(parseInt(data))) {
+        return val;
+      }
+      return;
+      break;
+    case "group":
+      return data;
+      break;
+    case "object":
+      if (_isObject(data) && !Array.isArray(data)) {
         return data;
-    }
-
-    ////////////////////////
-
-    switch (type) {
-        case 'reference':
-            return service.id(data, true);
-            break;
-        case 'boolean':
-            return service.parseBoolean(data);
-            break;
-        case 'url':
-            return service.parseURL(data);
-            break;
-        case 'key':
-            return service.machineName(data);
-            break;
-        case 'email':
-            return service.parseEmail(data);
-            break;
-        case 'date':
-            var parsed = service.parseDate(data, options);
-
-            if (parsed === undefined) {
-                return;
-            } else {
-                return parsed;
-            }
-            break;
-        case 'number':
-        case 'decimal':
-        case 'float':
-            var val = service.parseNumber(data);
-            if (String(val) == String(Number(data))) {
-                return val;
-            }
-            return;
-            break;
-        case 'integer':
-            var val = service.parseInt(data);
-            if (String(val) == String(parseInt(data))) {
-                return val;
-            }
-            return;
-            break;
-        case 'group':
-            return data;
-            break;
-        case 'object':
-            if (_isObject(data) && !Array.isArray(data)) {
-                return data
-            }
-
-            return;
-            break;
-        case 'string':
-            if (service.exists(data)) {
-                var stringed = String(data);
-                if (stringed == '[object Object]') {
-                    return;
-                }
-
-                return stringed
-            } else {
-                return;
-            }
-
-            // if(!data) {
-            //     return '';
-            // }
-
-            // if(Array.isArray(data)) {
-            //      return JSON.stringify(data);
-            // }
-
-            // if(Object.isObject(data)) {
-            //     return JSON.stringify(data);
-            // }
-
-            // return String(data);
-
-            // break;
-        default:
-            return String(data)
-            break;
-    }
-}
-
-
-
-service.isValidValue = function(value, dataType, strict) {
-
-    var isValue = service.exists(value);
-    var valueIsNumber = (typeof value == 'number')
-
-    ////////////////////////
+      }
+
+      return;
+      break;
+    case "string":
+      if (service.exists(data)) {
+        var stringed = String(data);
+        if (stringed == "[object Object]") {
+          return;
+        }
 
-    var isValidEntry = false;
+        return stringed;
+      } else {
+        return;
+      }
+
+    // if(!data) {
+    //     return '';
+    // }
+
+    // if(Array.isArray(data)) {
+    //      return JSON.stringify(data);
+    // }
+
+    // if(Object.isObject(data)) {
+    //     return JSON.stringify(data);
+    // }
+
+    // return String(data);
+
+    // break;
+    default:
+      return String(data);
+      break;
+  }
+};
+
+service.isValidValue = function (value, dataType, strict) {
+  var isValue = service.exists(value);
+  var valueIsNumber = typeof value == "number";
+
+  ////////////////////////
+
+  var isValidEntry = false;
+
+  if (!isValue) {
+    return false;
+  }
+
+  ////////////////////////
+
+  switch (dataType) {
+    case "url":
+      if (strict) {
+        isValidEntry =
+          _startsWith(value, "/") ||
+          _startsWith(value, "://") ||
+          _startsWith(value, "http://") ||
+          _startsWith(value, "https://");
+      } else {
+        isValidEntry = String(value) === service.parseURL(value);
+      }
+      break;
+    case "key":
+      isValidEntry = String(value) === service.machineName(value);
+      break;
+    case "date":
+      //If we are being strict
+      if (strict) {
+        //And the input is not a javascript date object
+        if (typeof value != "object" || !_isDate(value)) {
+          return false;
+        }
+      }
+
+      ///////////////////////////////
+      var parsed = service.parseDate(value);
+      return parsed !== undefined;
+      break;
+    case "email":
+      if (strict) {
+        isValidEntry = value === service.parseEmail(value);
+      } else {
+        isValidEntry =
+          String(value).toLowerCase() === service.parseEmail(value);
+      }
+
+      break;
+    case "number":
+    case "decimal":
+    case "float":
+      if (strict) {
+        isValidEntry =
+          valueIsNumber && Number(value) === service.parseNumber(value);
+      } else {
+        isValidEntry = Number(value) === service.parseNumber(value);
+      }
+      break;
+    case "integer":
+      if (strict) {
+        isValidEntry =
+          valueIsNumber && Number(value) === service.parseInt(value);
+      } else {
+        isValidEntry = Number(value) === service.parseInt(value);
+      }
+      break;
+    case "boolean":
+      var parsed = service.parseBoolean(value);
+
+      //Only accept true booleans
+      if (strict) {
+        if (value === true || value === false) {
+          isValidEntry = value === parsed;
+        }
+      } else {
+        isValidEntry = parsed === true || parsed === false;
+      }
+      break;
+    case "reference":
+      if (strict) {
+        isValidEntry = String(value) === service.id(value);
+      } else {
+        isValidEntry = !!service.id(value);
+      }
+      break;
+    case "string":
+      var checkString = String(value);
+      if (strict) {
+        if (typeof value != "string") {
+          return false;
+        }
+      }
 
-    if (!isValue) {
+      if (checkString == "[object Object]") {
         return false;
-    }
+      }
+
+      isValidEntry = true;
+      break;
+    // case 'group':
+    //     isValidEntry = _isObject(value);
+    //     break;
+    case "object":
+      isValidEntry = _isObject(value) && !Array.isArray(value);
+      break;
+    case "array":
+      isValidEntry = Array.isArray(value);
+      break;
+  }
+
+  ////////////////////////
+
+  return isValidEntry;
+};
 
-    ////////////////////////
-
-    switch (dataType) {
-
-        case 'url':
-            if (strict) {
-                isValidEntry = _startsWith(value, '/') || _startsWith(value, '://') || _startsWith(value, 'http://') || _startsWith(value, 'https://');
-            } else {
-                isValidEntry = String(value) === service.parseURL(value);
-            }
-            break;
-        case 'key':
-            isValidEntry = String(value) === service.machineName(value);
-            break;
-        case 'date':
-
-            //If we are being strict
-            if (strict) {
-                //And the input is not a javascript date object
-                if (typeof value != 'object' || !_isDate(value)) {
-                    return false;
-                }
-            }
-
-            ///////////////////////////////
-            var parsed = service.parseDate(value);
-            return parsed !== undefined;
-            break;
-        case 'email':
-
-            if (strict) {
-                isValidEntry = value === service.parseEmail(value);
-            } else {
-                isValidEntry = String(value).toLowerCase() === service.parseEmail(value);
-            }
-
-            break;
-        case 'number':
-        case 'decimal':
-        case 'float':
-            if (strict) {
-                isValidEntry = valueIsNumber && (Number(value) === service.parseNumber(value));
-            } else {
-                isValidEntry = Number(value) === service.parseNumber(value);
-            }
-            break;
-        case 'integer':
-            if (strict) {
-                isValidEntry = valueIsNumber && (Number(value) === service.parseInt(value));
-            } else {
-                isValidEntry = Number(value) === service.parseInt(value);
-            }
-            break;
-        case 'boolean':
-
-            var parsed = service.parseBoolean(value);
-
-            //Only accept true booleans
-            if (strict) {
-                if (value === true || value === false) {
-                    isValidEntry = value === parsed;
-                }
-            } else {
-                isValidEntry = parsed === true || parsed === false;
-            }
-            break;
-        case 'reference':
-            if (strict) {
-                isValidEntry = String(value) === service.id(value);
-            } else {
-                isValidEntry = !!service.id(value);
-            }
-            break;
-        case 'string':
-            var checkString = String(value);
-            if (strict) {
-                if (typeof value != 'string') {
-                    return false;
-                }
-            }
-
-            if (checkString == '[object Object]') {
-                return false;
-            }
-
-            isValidEntry = true;
-            break;
-            // case 'group':
-            //     isValidEntry = _isObject(value);
-            //     break;
-        case 'object':
-
-
-            isValidEntry = _isObject(value) && !Array.isArray(value);
-            break;
-        case 'array':
-            isValidEntry = Array.isArray(value);
-            break;
-    }
+/**
+ * A helper function for parsing input as boolean values
+ * @alias utils.parseBoolean
+ * @param  {*} value The input to parse
+ * @return {Boolean} the resulting true/false value
+ * @example
+ *
+ * sdk.utils.parseBoolean('true'); // returns true
+ * sdk.utils.parseBoolean('y'); // returns true
+ * sdk.utils.parseBoolean('YES'); // returns true
+ * sdk.utils.parseBoolean('1'); // returns true
+ * sdk.utils.parseBoolean('t'); // returns true
+ * sdk.utils.parseBoolean(''); // returns false
+ * sdk.utils.parseBoolean('0'); // returns false
+ * sdk.utils.parseBoolean('n'); // returns false
+ * sdk.utils.parseBoolean('no'); // returns false
+ * sdk.utils.parseBoolean('f'); // returns false
+ * sdk.utils.parseBoolean('null'); // returns false
+ */
+service.parseBoolean = function (value) {
+  switch (String(value).toLowerCase()) {
+    case "true":
+    case "y":
+    case "yes":
+    case "1":
+    case "t":
+      value = true;
+      break;
+    case "false":
+    case "n":
+    case "no":
+    case "0":
+    case "f":
+    case "undefined":
+    case "null":
+    case "":
+    case "-1":
+      value = false;
+      break;
+  }
+
+  return !!value;
+};
 
-    ////////////////////////
+///////////////////////////////////////////////////////////////////////////////
 
-    return isValidEntry
-}
+service.clone = function (input) {
+  return JSON.parse(JSON.stringify(input));
+};
 
-service.parseBoolean = function(value) {
-    switch (String(value).toLowerCase()) {
-        case 'true':
-        case 'y':
-        case 'yes':
-        case '1':
-        case 't':
-            value = true;
-            break;
-        case 'false':
-        case 'n':
-        case 'no':
-        case '0':
-        case 'f':
-        case 'undefined':
-        case 'null':
-        case '':
-        case '-1':
-            value = false;
-            break;
-    }
+///////////////////////////////////////////////////////////////////////////////
 
-    return !!value;
-}
+service.getAllFields = function (actualDefinition) {
+  const self = this;
+  const isProfile =
+    actualDefinition.definesType === "profile" ||
+    actualDefinition.key === "profile";
+  const isFormSubmission = actualDefinition.definesType === "submission";
+  var allFields = [...actualDefinition.fields];
+  var definedFields = actualDefinition.definedFields || [];
+
+  if (definedFields.length) {
+    if (isFormSubmission) {
+      var formDataFields = {
+        title: `Form Data`,
+        minimum: 1,
+        maximum: 1,
+        key: "formData",
+        asObject: true,
+        type: "group",
+        fields: definedFields,
+      };
+
+      allFields.push(formDataFields);
+
+      const cleanedDataFields = definedFields.map(function (field) {
+        if (field.type === "reference") {
+          field = JSON.parse(JSON.stringify(field));
+          delete field.fields;
+        }
 
+        return field;
+      });
 
+      var dataFields = {
+        title: `Data`,
+        minimum: 1,
+        maximum: 1,
+        key: "data",
+        asObject: true,
+        type: "group",
+        fields: cleanedDataFields,
+      };
 
+      allFields.push(dataFields);
+    } else {
+      var dataFields = {
+        title: `${actualDefinition.title}`,
+        minimum: 1,
+        maximum: 1,
+        key: "data",
+        asObject: true,
+        type: "group",
+        fields: definedFields,
+      };
+
+      allFields.push(dataFields);
+    }
+  }
+
+  if (isProfile) {
+    allFields.push({
+      title: "Age",
+      key: "_age",
+      minimum: 1,
+      maximum: 1,
+      type: "integer",
+    });
 
-///////////////////////////////////////////////////////////////////////////////
+    allFields.push({
+      title: "Date of birth",
+      key: "_dob",
+      minimum: 1,
+      maximum: 1,
+      type: "date",
+    });
+  }
+
+  var mapped = service
+    .mapFields(allFields)
+    .filter(function (field) {
+      var isObject =
+        field.type == "group" &&
+        field.asObject &&
+        field.minimum == 1 &&
+        field.maximum == 1;
+      return !isObject;
+    })
+    .map(function (field) {
+      field.title =
+        field.filterTitle || field.titles.filter(Boolean).join(" › ");
 
-service.clone = function(input) {
-    return JSON.parse(JSON.stringify(input));
-}
+      return field;
+    })
+    .sort(function (a, b) {
+      return a.title < b.title ? -1 : 1;
+    });
 
+  return mapped;
+};
 ///////////////////////////////////////////////////////////////////////////////
 
-service.mapFields = function(fields, options) {
-
-    if (!options) {
-        options = {};
-    }
+service.mapFields = function (fields, options) {
+  if (!options) {
+    options = {};
+  }
 
-    //////////////////////////////
+  //////////////////////////////
 
-    var output = [];
-    var trail = [];
-    var titles = [];
-    var currentDepth = 1;
-    var depthLimit = options.depth;
-    var delimiter = options.arrayDelimeter || '[]';
+  var output = [];
+  var trail = [];
+  var titles = [];
+  var currentDepth = 1;
+  var depthLimit = options.depth;
+  var delimiter = options.arrayDelimeter || "[]";
 
+  //Loop through each field
+  fields.forEach(mapField);
 
-    //Loop through each field
-    fields.forEach(mapField);
+  //////////////////////////////
 
-    //////////////////////////////
+  //Recursively map the fields
+  function mapField(field, i) {
+    var fieldKey = field.key;
+    var isGroup = field.type == "group";
+    var singleValue = field.minimum === field.maximum && field.minimum === 1;
+    var asObject = field.asObject; // || (isGroup && singleValue);
+    var isLayout = isGroup && !asObject;
 
-    //Recursively map the fields
-    function mapField(field, i) {
-        var fieldKey = field.key;
-        var isGroup = field.type == 'group';
-        var singleValue = (field.minimum === field.maximum) && field.minimum === 1;
-        var asObject = field.asObject; // || (isGroup && singleValue);
-        var isLayout = isGroup && !asObject;
+    //////////////////////////////////
 
-        //////////////////////////////////
+    // Whether to clone the field or use the existing reference
+    var mapped = options.original ? field : service.clone(field);
 
-        // Whether to clone the field or use the existing reference
-        var mapped = options.original ? field : service.clone(field);
+    mapped.trail = trail.slice();
+    mapped.trail.push(fieldKey);
 
-        mapped.trail = trail.slice();
-        mapped.trail.push(fieldKey)
+    mapped.path = mapped.trail.join(".");
+    mapped.titles = titles.slice();
+    mapped.titles.push(field.filterTitle || field.title || "");
 
-        mapped.path = mapped.trail.join('.');
-        mapped.titles = titles.slice();
-        mapped.titles.push(field.title || '')
+    const isNotLayoutOrIsAllowed = !isLayout || options.includeLayout;
 
+    //If its an actual element or we've asked to include
+    //layout only elements
+    if (isNotLayoutOrIsAllowed) {
+      //Add it to the mix
+      output.push(mapped);
+    }
 
-        const isNotLayoutOrIsAllowed = (!isLayout || options.includeLayout);
+    //////////////////////////////////
 
-        //If its an actual element or we've asked to include
-        //layout only elements
-        if (isNotLayoutOrIsAllowed) {
-            //Add it to the mix
-            output.push(mapped);
+    //Now see if there are child fields and should we go further
+    var limitHit = depthLimit && currentDepth >= depthLimit;
+
+    //If there are child fields for this field
+    if (field.fields && field.fields.length) {
+      //If it's just a group with no extra key
+      if (isLayout) {
+        //Loop through fields as if they are at the same depth
+        field.fields.forEach(mapField);
+      } else {
+        //We don't need to traverse any further
+        //because we hit the limit
+        if (limitHit) {
+          return;
         }
 
-        //////////////////////////////////
-
-        //Now see if there are child fields and should we go further
-        var limitHit = depthLimit && (currentDepth >= depthLimit);
-
-        //If there are child fields for this field
-        if (field.fields && field.fields.length) {
-            //If it's just a group with no extra key
-            if (isLayout) {
-                //Loop through fields as if they are at the same depth
-                field.fields.forEach(mapField)
-            } else {
-
-                //We don't need to traverse any further
-                //because we hit the limit
-                if (limitHit) {
-                    return;
-                }
-
-                //Move down a level and add to the object
-                //Include the key in the path trail
-                currentDepth++;
-
-                let injectKey = fieldKey;
-                if (options.includeArrayDelimeter) {
-                    if (!singleValue) {
-                        injectKey = `${fieldKey}${delimiter}`
-                    }
-                }
-                trail.push(injectKey)
-                titles.push(field.title);
-
-                //Loop through each field
-                field.fields.forEach(mapField)
-
-                //Move back up a level before we go to the next field
-                currentDepth--;
-                trail.pop();
-                titles.pop();
-            }
+        //Move down a level and add to the object
+        //Include the key in the path trail
+        currentDepth++;
 
+        let injectKey = fieldKey;
+        if (options.includeArrayDelimeter) {
+          if (!singleValue) {
+            injectKey = `${fieldKey}${delimiter}`;
+          }
         }
+        trail.push(injectKey);
+        titles.push(field.filterTitle || field.title);
 
+        //Loop through each field
+        field.fields.forEach(mapField);
+
+        //Move back up a level before we go to the next field
+        currentDepth--;
+        trail.pop();
+        titles.pop();
+      }
     }
+  }
 
-    return output;
-}
+  return output;
+};
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -685,36 +863,31 @@ service.mapFields = function(fields, options) {
  * @alias utils.mapParameters
  * @param  {Object} parameters The object you want to transalte
  * @return {String}            The query string
- * @example 
+ * @example
  * //Returns &this=that&hello=world
  * sdk.utils.mapParameters({"this":"that", "hello":"world"})
  */
-service.mapParameters = function(parameters) {
-
-    parameters = parameters || {}
-
-    var array = [];
-
-    Object.entries(parameters)
-    .forEach(function([key, value]) {
-
-        if (value === undefined || value === null || value == false) {
-            return;
-        }
+service.mapParameters = function (parameters) {
+  parameters = parameters || {};
 
-        if (Array.isArray(value)) {
-            value.forEach(function(v) {
-                array.push(`${key}=${encodeURIComponent(v)}`);
-            })
-        } else {
-            array.push(encodeURIComponent(key) + '=' + encodeURIComponent(value));
-        }
+  var array = [];
 
-    })
+  Object.entries(parameters).forEach(function ([key, value]) {
+    if (value === undefined || value === null || value == false) {
+      return;
+    }
 
-    return array.join('&');
+    if (Array.isArray(value)) {
+      value.forEach(function (v) {
+        array.push(`${key}=${encodeURIComponent(v)}`);
+      });
+    } else {
+      array.push(encodeURIComponent(key) + "=" + encodeURIComponent(value));
+    }
+  });
 
-}
+  return array.join("&");
+};
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -724,210 +897,197 @@ service.mapParameters = function(parameters) {
  * @param  {Integer} value The amount in cents
  * @param  {String} currency The currency to format
  * @return {String}            The formatted value
- * @example 
- * 
+ * @example
+ *
  * //Returns £10.00
  * sdk.utils.formatCurrency(1000, 'gbp');
- * 
+ *
  * //Returns $10.00
  * sdk.utils.formatCurrency(1000, 'usd');
- * 
+ *
  */
-service.formatCurrency = function(value, currency, decimalPoints) {
-
-    if (!value || isNaN(value)) {
-        value = 0;
-    }
-
-    decimalPoints = decimalPoints || 2;
-
-    var currencyPrefix = service.currencySymbol(currency);
-    return `${currencyPrefix}${parseFloat(Number(value) / 100).toFixed(decimalPoints)}`;
-
-}
+service.formatCurrency = function (value, currency, decimalPoints) {
+  if (!value || isNaN(value)) {
+    value = 0;
+  }
 
+  decimalPoints = decimalPoints || 2;
 
+  var currencyPrefix = service.currencySymbol(currency);
+  return `${currencyPrefix}${parseFloat(Number(value) / 100).toFixed(decimalPoints)}`;
+};
 
 /**
  * A function that will take an id and return the type key
  * @alias utils.getTypeFromID
  * @param  {String} id The id of an object
  * @return {String}    The key
- * @example 
- * 
+ * @example
+ *
  * // Returns 'user'
  * sdk.utils.getTypeFromID('52b523f775beea960013f6cd');
  *
  * // Returns 'role'
  * sdk.utils.getTypeFromID('62b59cb572fb4772e7b5fa93');
- * 
+ *
  */
-service.getTypeFromID = function(id) {
-
-    id = service.id(id);
-
-    if (!id) {
-        return;
-    }
-
-    const lookup = {
-        "21": "organisation",
-        "23": "comment",
-        "24": "persona",
-        "25": "audio",
-        "26": "campaign",
-        "28": "smartlist",
-        "29": "cache",
-        "40": "application",
-        "41": "action",
-        "42": "billinginvoice",
-        "43": "componentsnapshot",
-        "44": "diff",
-        "45": "email",
-        "46": "submission",
-        "49": "import",
-        "53": "socket",
-        "54": "timetrigger",
-        "61": "article",
-        "63": "component",
-        "65": "event",
-        "66": "file",
-        "67": "tag",
-        "69": "image",
-        "70": "profile",
-        "72": "role",
-        "73": "scope",
-        "74": "transaction",
-        "75": "user",
-        "76": "video",
-        "77": "workflowcard",
-        "78": "variable",
-        "3c": "patoken",
-        "7b": "uatoken",
-        "7d": "urtoken",
-        "2d": "systemtask",
-        "3d": "export",
-        "5f": "systemflag",
-        "2b": "batch",
-        "3a": "log",
-        "2e": "stat",
-        "2f": "unsubscribe",
-        "6b": "intent",
-        "7c": "upload",
-        "2c": "systemtrigger",
-        "6e": "interface",
-        "4e": "interfacesnapshot",
-        "4f": "notification",
-        "2a": "definition",
-        "7e": "definitionsnapshot",
-        "5e": "integration",
-        "4c": "listener",
-        "6d": "topic",
-        "7a": "code",
-        "4d": "paymentmethod",
-        "6c": "sslcertificate"
-    }
-
-    var hexKey = id.slice(8, 10);
-    return lookup[hexKey];
-}
+service.getTypeFromID = function (id) {
+  id = service.id(id);
 
+  if (!id) {
+    return;
+  }
+
+  const lookup = {
+    21: "organisation",
+    23: "comment",
+    24: "persona",
+    25: "audio",
+    26: "campaign",
+    28: "smartlist",
+    29: "cache",
+    40: "application",
+    41: "action",
+    42: "billinginvoice",
+    43: "componentsnapshot",
+    44: "diff",
+    45: "email",
+    46: "submission",
+    49: "import",
+    53: "socket",
+    54: "timetrigger",
+    61: "article",
+    63: "component",
+    65: "event",
+    66: "file",
+    67: "tag",
+    69: "image",
+    70: "profile",
+    72: "role",
+    73: "scope",
+    74: "transaction",
+    75: "user",
+    76: "video",
+    77: "workflowcard",
+    78: "variable",
+    "3c": "patoken",
+    "7b": "uatoken",
+    "7d": "urtoken",
+    "2d": "systemtask",
+    "3d": "export",
+    "5f": "systemflag",
+    "2b": "batch",
+    "3a": "log",
+    "2e": "stat",
+    "2f": "unsubscribe",
+    "6b": "intent",
+    "7c": "upload",
+    "2c": "systemtrigger",
+    "6e": "interface",
+    "4e": "interfacesnapshot",
+    "4f": "notification",
+    "2a": "definition",
+    "7e": "definitionsnapshot",
+    "5e": "integration",
+    "4c": "listener",
+    "6d": "topic",
+    "7a": "code",
+    "4d": "paymentmethod",
+    "6c": "sslcertificate",
+  };
+
+  var hexKey = id.slice(8, 10);
+  return lookup[hexKey];
+};
 
 /**
  * A function that will take a currency string and return the symbol
  * @alias utils.currencySymbol
  * @param  {String} currency The currency
  * @return {String}            The symbol
- * @example 
- * 
+ * @example
+ *
  * //Returns £
  * sdk.utils.currencySymbol('gbp');
- * 
+ *
  * //Returns $
  * sdk.utils.currencySymbol('usd');
- * 
+ *
  */
-service.currencySymbol = function(currency) {
-    //Ensure lowercase currency
-    currency = String(currency).toLowerCase();
-
-    switch (String(currency).toLowerCase()) {
-        case 'gbp':
-            return '£';
-            break;
-        case 'eur':
-            return '€';
-            break;
-        default:
-            return '$';
-            break;
-    }
-}
-
-
-
-service.getAvailableCurrencies = function(DefaultCountryID) {
-
-
-    var array = [];
-
-    array.push({
-        name: `USD (${service.currencySymbol("usd")})`,
-        value: "usd",
-        countryCode: { 'US': true },
-    });
-
-    array.push({
-        name: `GBP (${service.currencySymbol("gbp")})`,
-        value: "gbp",
-        countryCode: { 'GB': true, 'UK': true },
+service.currencySymbol = function (currency) {
+  //Ensure lowercase currency
+  currency = String(currency).toLowerCase();
+
+  switch (String(currency).toLowerCase()) {
+    case "gbp":
+      return "£";
+      break;
+    case "eur":
+      return "€";
+      break;
+    default:
+      return "$";
+      break;
+  }
+};
+
+service.getAvailableCurrencies = function (DefaultCountryID) {
+  var array = [];
+
+  array.push({
+    name: `USD (${service.currencySymbol("usd")})`,
+    value: "usd",
+    countryCode: { US: true },
+  });
+
+  array.push({
+    name: `GBP (${service.currencySymbol("gbp")})`,
+    value: "gbp",
+    countryCode: { GB: true, UK: true },
+  });
+
+  array.push({
+    name: `CAD (${service.currencySymbol("cad")})`,
+    value: "cad",
+    countryCode: { CA: true },
+  });
+
+  array.push({
+    name: `AUD (${service.currencySymbol("aud")})`,
+    value: "aud",
+    countryCode: { AU: true },
+  });
+
+  array.push({
+    name: `NZD (${service.currencySymbol("nzd")})`,
+    value: "nzd",
+    countryCode: { NZ: true },
+  });
+
+  array.push({
+    name: `SGD (${service.currencySymbol("sgd")})`,
+    value: "sgd",
+    countryCode: { SG: true },
+  });
+
+  if (DefaultCountryID) {
+    var findMatch = array.findIndex(function (currency) {
+      return currency.countryCode[DefaultCountryID];
     });
 
-    array.push({
-        name: `CAD (${service.currencySymbol("cad")})`,
-        value: "cad",
-        countryCode: { 'CA': true },
-    });
-
-    array.push({
-        name: `AUD (${service.currencySymbol("aud")})`,
-        value: "aud",
-        countryCode: { 'AU': true },
-    });
-
-
-    array.push({
-        name: `NZD (${service.currencySymbol("nzd")})`,
-        value: "nzd",
-        countryCode: { 'NZ': true },
-    });
-
-    array.push({
-        name: `SGD (${service.currencySymbol("sgd")})`,
-        value: "sgd",
-        countryCode: { 'SG': true },
-    });
-
-
-    if (DefaultCountryID) {
-
-        var findMatch = array.findIndex(function(currency) {
-            return currency.countryCode[DefaultCountryID];
-        })
+    const moveArrayItem = (array, fromIndex, toIndex) => {
+      const arr = [...array];
+      arr.splice(toIndex, 0, ...arr.splice(fromIndex, 1));
+      return arr;
+    };
 
-        const moveArrayItem = (array, fromIndex, toIndex) => {
-            const arr = [...array];
-            arr.splice(toIndex, 0, ...arr.splice(fromIndex, 1));
-            return arr;
-        }
-
-        if (findMatch != -1) {
-            array = moveArrayItem(array, findMatch, 0)
-        }
+    if (findMatch != -1) {
+      array = moveArrayItem(array, findMatch, 0);
     }
+  }
 
-    return array;
-}
+  return array;
+};
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -937,22 +1097,19 @@ service.getAvailableCurrencies = function(DefaultCountryID) {
  * @param  {Array} array The array of items to convert into a hash
  * @param  {String} key The key or path to the property on each item to use as the hashed key
  * @return {Object} A key/value paired object
- * @example 
+ * @example
  * //Returns { jimbo:{id:'jimbo', title:'Jim Jones'}, {id:'roger', title:'Roger Fellow'} }
  * sdk.utils.hash([{id:'jimbo', title:'Jim Jones'}, {id:'roger', title:'Roger Fellow'}], 'id');
- * 
+ *
  */
-service.hash = function(items, key) {
-    items = !Array.isArray(items) ? [] : items;
-    return items.reduce(function(memo, item) {
-        const k = _get(item, key);
-        memo[k] = item;
-        return memo;
-    }, {});
-}
-
-
-
+service.hash = function (items, key) {
+  items = !Array.isArray(items) ? [] : items;
+  return items.reduce(function (memo, item) {
+    const k = _get(item, key);
+    memo[k] = item;
+    return memo;
+  }, {});
+};
 
 //////////////////////////////////////////////////
 
@@ -967,67 +1124,74 @@ service.hash = function(items, key) {
  * @param  {Boolean} exclude Whether to exclude null or undefined values
  * @param  {Object} options Pass through extra options for how to extract the values
  * @return {Array} An array of all values retrieved from the array, unless provided arguments require otherwise
- * @example 
+ * @example
  * //Returns [12, 45] as all the values
  * sdk.utils.extractFromArray([{name:'Wendy', age:12}, {name:'Roger', age:45}], 'age');
- * 
+ *
  * //Returns 32
  * sdk.utils.extractFromArray([{name:'Wendy', age:12}, {name:'Roger', age:20}], 'age', {sum:true});
- * 
+ *
  */
-service.extractFromArray = function(array, key, sum, flatten, unique, exclude, options) {
-
-    options = options || {}
-
-    if (sum) {
-        options.sum = sum;
-    }
-
-    if (flatten) {
-        options.flatten = true;
+service.extractFromArray = function (
+  array,
+  key,
+  sum,
+  flatten,
+  unique,
+  exclude,
+  options,
+) {
+  options = options || {};
+
+  if (sum) {
+    options.sum = sum;
+  }
+
+  if (flatten) {
+    options.flatten = true;
+  }
+
+  if (unique) {
+    options.unique = true;
+  }
+
+  if (exclude) {
+    options.excludeNull = true;
+  }
+
+  /////////////////
+
+  //Filter the array options by a certain value and operator
+  var extractedValues = array.reduce(function (set, entry) {
+    //Get the value from the object
+    var retrievedValue = _get(entry, key);
+
+    var isNull =
+      !retrievedValue && retrievedValue !== false && retrievedValue !== 0;
+    if (options.excludeNull && isNull) {
+      return set;
     }
 
-    if (unique) {
-        options.unique = true;
-    }
-
-    if (exclude) {
-        options.excludeNull = true;
-    }
-
-    /////////////////
-
-    //Filter the array options by a certain value and operator
-    var extractedValues = array.reduce(function(set, entry) {
-        //Get the value from the object
-        var retrievedValue = _get(entry, key);
+    set.push(retrievedValue);
+    return set;
+  }, []);
 
-        var isNull = (!retrievedValue && (retrievedValue !== false && retrievedValue !== 0));
-        if (options.excludeNull && isNull) {
-            return set;
-        }
-
-        set.push(retrievedValue);
-        return set;
-    }, [])
+  if (options.flatten) {
+    extractedValues = _.flatten(extractedValues);
+  }
 
-    if (options.flatten) {
-        extractedValues = _.flatten(extractedValues);
-    }
+  if (options.unique) {
+    extractedValues = _.uniq(extractedValues);
+  }
 
-    if (options.unique) {
-        extractedValues = _.uniq(extractedValues);
-    }
-
-    if (options.sum) {
-        extractedValues = extractedValues.reduce(function(a, b) {
-            return a + b;
-        }, 0);
-    }
-
-    return extractedValues;
-}
+  if (options.sum) {
+    extractedValues = extractedValues.reduce(function (a, b) {
+      return a + b;
+    }, 0);
+  }
 
+  return extractedValues;
+};
 
 //////////////////////////////////////////////////////
 
@@ -1040,50 +1204,49 @@ service.extractFromArray = function(array, key, sum, flatten, unique, exclude, o
  * @param  {String} value The value to compare against
  * @param  {String} comparator The logical operator to use to compare the extracted value with the provided value ('>', '<', '>=', '<=', 'in', '==') Defaults to '==' (Is equal to)
  * @return {Array} Returns an array of matching values
- * @example 
+ * @example
  * //Returns [{name:'Michael', age:45}] as that is only item in the array that matches the criteria
  * sdk.utils.matchInArray([{name:'Wendy', age:12}, {name:'Michael', age:45}], 'age', 45, '>=');
- * 
+ *
  */
-service.matchInArray = function(array, key, v, comparator) {
-
-    //Filter the array options by a certain v and comparator
-    var matches = array.filter(function(entry) {
-        //Get the v from the object
-        var extracted = _get(entry, key);
-        var found;
-
-        switch (comparator) {
-            case 'in':
-                found = extracted.includes(v);
-                break;
-            case '>=':
-                found = (extracted >= v);
-                break;
-            case '<=':
-                found = (extracted <= v);
-                break;
-            case '<':
-                found = (extracted < v);
-                break;
-            case '>':
-                found = (extracted > v);
-                break;
-            case '==':
-            default:
-                if (v === undefined) {
-                    found = extracted;
-                } else {
-                    found = (extracted == v);
-                }
-                break;
+service.matchInArray = function (array, key, v, comparator) {
+  //Filter the array options by a certain v and comparator
+  var matches = array.filter(function (entry) {
+    //Get the v from the object
+    var extracted = _get(entry, key);
+    var found;
+
+    switch (comparator) {
+      case "in":
+        found = extracted.includes(v);
+        break;
+      case ">=":
+        found = extracted >= v;
+        break;
+      case "<=":
+        found = extracted <= v;
+        break;
+      case "<":
+        found = extracted < v;
+        break;
+      case ">":
+        found = extracted > v;
+        break;
+      case "==":
+      default:
+        if (v === undefined) {
+          found = extracted;
+        } else {
+          found = extracted == v;
         }
+        break;
+    }
 
-        return found;
-    })
+    return found;
+  });
 
-    return matches;
-}
+  return matches;
+};
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -1097,28 +1260,27 @@ service.matchInArray = function(array, key, v, comparator) {
  * @example
  * //Returns 'cat, dog, bird'
  * sdk.utils.comma(['cat', 'dog', 'bird']);
- * 
+ *
  * //Returns 'cat, dog, bird'
  * sdk.utils.comma([{title:'cat'}, {title:'dog'}, {title:'bird'}], 'title');
  */
-service.comma = function(array, path, limit) {
-
-    if (limit) {
-        array = array.slice(0, limit);
-    }
-
-    return _.chain(array)
-        .compact()
-        .map(function(item) {
-            if (path && path.length) {
-                return _get(item, path);
-            }
-
-            return item;
-        })
-        .value()
-        .join(', ');
-}
+service.comma = function (array, path, limit) {
+  if (limit) {
+    array = array.slice(0, limit);
+  }
+
+  return _.chain(array)
+    .compact()
+    .map(function (item) {
+      if (path && path.length) {
+        return _get(item, path);
+      }
+
+      return item;
+    })
+    .value()
+    .join(", ");
+};
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -1142,36 +1304,34 @@ service.comma = function(array, path, limit) {
  * //Returns true
  * typeof service.id({_id:'5cb3d8b3a2219970e6f86927'}, true) == 'object';
  */
-service.id = function(source) {
-
-    if (!source) {
-        return;
-    }
-
-    /////////////////////////////////
+service.id = function (source) {
+  if (!source) {
+    return;
+  }
 
-    var output;
+  /////////////////////////////////
 
-    if (source._id) {
-        output = String(source._id);
-    } else {
-        output = String(source);
-    }
+  var output;
 
+  if (source._id) {
+    output = String(source._id);
+  } else {
+    output = String(source);
+  }
 
-    var isValid = service.isValidID(output);
-    if (!isValid) {
-        return;
-    }
+  var isValid = service.isValidID(output);
+  if (!isValid) {
+    return;
+  }
 
-    return output;
-}
+  return output;
+};
 
 ///////////////////////////////////////////////////////////////////////////////
 
 /**
- * Cleans and maps an array of objects to an array of IDs  
- * @alias utils.ids      
+ * Cleans and maps an array of objects to an array of IDs
+ * @alias utils.ids
  * @param  {Array} array      An array of objects or object ids
  * @param  {Boolean} asObjectID Whether or not to map the ids as Mongo ObjectIds
  * @return {Array}            An array of Ids
@@ -1181,96 +1341,87 @@ service.id = function(source) {
  * sdk.utils.ids([{_id:'5cb3d8b3a2219970e6f86927'}, {_id:'5cb3d8b3a2219970e6f86927'}, null, '5cb3d8b3a2219970e6f86927'])
  */
 
-service.ids = function(array) {
-
-    if (!array) {
-        return [];
-    }
+service.ids = function (array) {
+  if (!array) {
+    return [];
+  }
 
-    /////////////////////////////////
+  /////////////////////////////////
 
-    var ids = Object.keys(array.reduce(function(set, entry) {
+  var ids = Object.keys(
+    array.reduce(function (set, entry) {
+      if (!entry) {
+        return set;
+      }
 
-        if (!entry) {
-            return set;
-        }
+      var cleaned = service.id(entry);
 
-        var cleaned = service.id(entry)
+      if (cleaned) {
+        set[cleaned] = 1;
+      }
 
-        if (cleaned) {
-            set[cleaned] = 1;
-        }
+      return set;
+    }, {}),
+  );
 
-        return set;
-    }, {}))
-
-    ///////////////////////////////
-
-    return ids;
-}
+  ///////////////////////////////
 
+  return ids;
+};
 
 ///////////////////////////////////////////////////////////////////////////////
 
-service.isValidID = function(input) {
-    var checkForHexRegExp = new RegExp("^[0-9a-fA-F]{24}$")
-    return checkForHexRegExp.test(String(input));
-
-}
+service.isValidID = function (input) {
+  var checkForHexRegExp = new RegExp("^[0-9a-fA-F]{24}$");
+  return checkForHexRegExp.test(String(input));
+};
 
 ///////////////////////////////////////////////////////////////////////////////
 
 /**
  * Helper function for retrieving a human readable error message from server error response objects
  * @alias utils.errorMessage
- * @param  {Object} error The error object to translate    
+ * @param  {Object} error The error object to translate
  * @return {String}     The resulting human readable error message
  */
-service.errorMessage = function(err) {
-
-    if (!err) {
-        return;
-    }
-
-
-    if (Array.isArray(err)) {
-        err = err[0];
-    }
-
-    ////////////////////////////////////
+service.errorMessage = function (err) {
+  if (!err) {
+    return;
+  }
 
+  if (Array.isArray(err)) {
+    err = err[0];
+  }
 
-    var candidates = [
-        'response.data.message',
-        'response.data',
-        'message',
-    ]
+  ////////////////////////////////////
 
-    var message;
+  var candidates = ["response.data.message", "response.data", "message"];
 
-    candidates.forEach(function(path) {
-        if (message) {
-            return;
-        }
+  var message;
 
-        var m = _get(err, path);
-        if (m) {
-            message = m;
-        }
-    })
+  candidates.forEach(function (path) {
+    if (message) {
+      return;
+    }
 
-    if (Array.isArray(message)) {
-        message = message[0];
+    var m = _get(err, path);
+    if (m) {
+      message = m;
     }
+  });
 
-    ////////////////////////////////////
+  if (Array.isArray(message)) {
+    message = message[0];
+  }
 
-    message = message || JSON.stringify(err);
+  ////////////////////////////////////
 
-    ////////////////////////////////////
+  message = message || JSON.stringify(err);
 
-    return message;
-}
+  ////////////////////////////////////
+
+  return message;
+};
 
 ////////////////////////////////////
 
@@ -1278,17 +1429,25 @@ service.errorMessage = function(err) {
  * Generates a globally unique ID, helpful for adding unique keys for iterable loops
  * @alias utils.guid
  * @return {String}            The new globally unique identifier
- * @example 
+ * @example
  * //Returns 4323a78br-z16h-289j-zwl1-938lda334asd
  * sdk.utils.guid()
  */
-service.guid = function() {
-    var u = (new Date()).getTime().toString(16) + Math.random().toString(16).substring(2) + "0".repeat(16);
-    return u.substr(0, 8) + '-' + u.substr(8, 4) + '-4000-8' + u.substr(12, 3) + '-' + u.substr(15, 12);
-}
-
-
-
+service.guid = function () {
+  var u =
+    new Date().getTime().toString(16) +
+    Math.random().toString(16).substring(2) +
+    "0".repeat(16);
+  return (
+    u.substr(0, 8) +
+    "-" +
+    u.substr(8, 4) +
+    "-4000-8" +
+    u.substr(12, 3) +
+    "-" +
+    u.substr(15, 12)
+  );
+};
 
 ////////////////////////////////////
 ////////////////////////////////////
@@ -1300,111 +1459,105 @@ service.guid = function() {
  * @param  {String} string The string to clean eg. (Awesome Event!)
  * @return {String}     A cleaned and formatted string eg. (awesomeEvent)
  */
-service.machineName = function(string) {
-
-    if (!string || !string.length) {
-        return;
-    }
+service.machineName = function (string) {
+  if (!string || !string.length) {
+    return;
+  }
 
-    var regexp = /[^a-zA-Z0-9-_]+/g;
-    var cleaned = String(string).replace(regexp, ' ').trim();
-    return _camelCase(cleaned);
-}
+  var regexp = /[^a-zA-Z0-9-_]+/g;
+  var cleaned = String(string).replace(regexp, " ").trim();
+  return _camelCase(cleaned);
+};
 
 /////////////////////////////////////////////
 /////////////////////////////////////////////
 /////////////////////////////////////////////
 
-
 export default service;
 
-
 /////////////////////////////////////////////
 
 //Export the event dispatcher
 export function EventDispatcher() {
+  var listeners = {};
 
-    var listeners = {};
+  /////////////////////////////////////////////
 
-    /////////////////////////////////////////////
+  var dispatcher = {};
 
-    var dispatcher = {}
-
-    /////////////////////////////////////////////
-
-    //Remove all listeners
-    dispatcher.removeAllListeners = function() {
-        listeners = {};
-    }
+  /////////////////////////////////////////////
 
-    /////////////////////////////////////////////
+  //Remove all listeners
+  dispatcher.removeAllListeners = function () {
+    listeners = {};
+  };
 
-    dispatcher.dispatch = function(event, details) {
+  /////////////////////////////////////////////
 
-        if (listeners[event]) {
-            //For each listener
-            listeners[event].forEach(function(callback) {
-                return callback(details);
-            });
-        }
+  dispatcher.dispatch = function (event, details) {
+    if (listeners[event]) {
+      //For each listener
+      listeners[event].forEach(function (callback) {
+        return callback(details);
+      });
     }
+  };
 
-    /////////////////////////////////////////////
-
-    dispatcher.addEventListener = function(event, callback) {
+  /////////////////////////////////////////////
 
-        if (!listeners[event]) {
-            listeners[event] = [];
-        }
-
-        const type = typeof callback;
-        if (type !== 'function') {
-            throw new Error(`addEventListener() requires a function but ${type} was added`);
-        } else {
-            if (listeners[event].indexOf(callback) == -1) {
-                //Add to the listeners
-                listeners[event].push(callback)
-            } else {
-                //A
-                //lready listening
-            }
-        }
+  dispatcher.addEventListener = function (event, callback) {
+    if (!listeners[event]) {
+      listeners[event] = [];
     }
 
-    /////////////////////////////////////////////
-
-    dispatcher.removeEventListener = function(event, callback) {
-
-        if (!listeners[event]) {
-            listeners[event] = [];
-        }
+    const type = typeof callback;
+    if (type !== "function") {
+      throw new Error(
+        `addEventListener() requires a function but ${type} was added`,
+      );
+    } else {
+      if (listeners[event].indexOf(callback) == -1) {
+        //Add to the listeners
+        listeners[event].push(callback);
+      } else {
+        //A
+        //lready listening
+      }
+    }
+  };
 
-        //Get the index of the listener
-        var index = listeners[event].indexOf(callback);
+  /////////////////////////////////////////////
 
-        if (index != -1) {
-            //Remove from the listeners
-            listeners[event].splice(index, 1);
-        }
+  dispatcher.removeEventListener = function (event, callback) {
+    if (!listeners[event]) {
+      listeners[event] = [];
     }
 
+    //Get the index of the listener
+    var index = listeners[event].indexOf(callback);
 
-    /////////////////////////////////////////////
+    if (index != -1) {
+      //Remove from the listeners
+      listeners[event].splice(index, 1);
+    }
+  };
 
-    //Wrap the event listener functionality
-    dispatcher.bootstrap = function(service) {
-        if (!service) {
-            // console.log('No service to bootstrap to')
-            return;
-        }
+  /////////////////////////////////////////////
 
-        service.dispatch = dispatcher.dispatch;
-        service.addEventListener = dispatcher.addEventListener;
-        service.removeEventListener = dispatcher.removeEventListener;
-        service.removeAllListeners = dispatcher.removeAllListeners;
+  //Wrap the event listener functionality
+  dispatcher.bootstrap = function (service) {
+    if (!service) {
+      // console.log('No service to bootstrap to')
+      return;
     }
 
-    /////////////////////////////////////////////
+    service.dispatch = dispatcher.dispatch;
+    service.addEventListener = dispatcher.addEventListener;
+    service.removeEventListener = dispatcher.removeEventListener;
+    service.removeAllListeners = dispatcher.removeAllListeners;
+  };
 
-    return dispatcher;
-}
+  /////////////////////////////////////////////
+
+  return dispatcher;
+}