@qikdev/sdk 0.1.134 → 0.1.136

package/public/docs/qik.utils.js.html

@@ -27,7 +27,7 @@
 
 <nav >
     
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.hashPermissions">hashPermissions</a></li><li data-type='method'><a href="access.html#.isAdministrator">isAdministrator</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li></ul></li><li><a href="api.html">api</a><ul class='methods'><li data-type='method'><a href="api.html#.delete">delete</a></li><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li><li data-type='method'><a href="api.html#.get">get</a></li><li data-type='method'><a href="api.html#.patch">patch</a></li><li data-type='method'><a href="api.html#.post">post</a></li><li data-type='method'><a href="api.html#.put">put</a></li></ul></li><li><a href="auth.html">auth</a><ul class='methods'><li data-type='method'><a href="auth.html#.changeOrganisation">changeOrganisation</a></li><li data-type='method'><a href="auth.html#.ensureValidToken">ensureValidToken</a></li><li data-type='method'><a href="auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.login">login</a></li><li data-type='method'><a href="auth.html#.logout">logout</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.set">set</a></li><li data-type='method'><a href="auth.html#.sync">sync</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="cache.html">cache</a><ul class='methods'><li data-type='method'><a href="cache.html#.get">get</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li></ul></li><li><a href="content.html">content</a><ul class='methods'><li data-type='method'><a href="content.html#.create">create</a></li><li data-type='method'><a href="content.html#.delete">delete</a></li><li data-type='method'><a href="content.html#.get">get</a></li><li data-type='method'><a href="content.html#.getFromSlug">getFromSlug</a></li><li data-type='method'><a href="content.html#.glossary">glossary</a></li><li data-type='method'><a href="content.html#.list">list</a></li><li data-type='method'><a href="content.html#.patch">patch</a></li><li data-type='method'><a href="content.html#.restore">restore</a></li><li data-type='method'><a href="content.html#.scopeGlossary">scopeGlossary</a></li><li data-type='method'><a href="content.html#.update">update</a></li><li data-type='method'><a href="content.html#.validateField">validateField</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li></ul></li><li><a href="files.html">files</a><ul class='methods'><li data-type='method'><a href="files.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="files.html#.filesize">filesize</a></li><li data-type='method'><a href="files.html#.getBinaryTypeFromMime">getBinaryTypeFromMime</a></li><li data-type='method'><a href="files.html#.mediaUrl">mediaUrl</a></li></ul></li><li><a href="filter.html">filter</a><ul class='methods'><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterOperators">activeFilterOperators</a></li><li data-type='method'><a href="filter.html#.activeFilters">activeFilters</a></li><li data-type='method'><a href="filter.html#.activeFilterValues">activeFilterValues</a></li><li data-type='method'><a href="filter.html#.filterChangeString">filterChangeString</a></li><li data-type='method'><a href="filter.html#.isValidFilter">isValidFilter</a></li></ul></li><li><a href="socket.html">socket</a><ul class='methods'><li data-type='method'><a href="socket.html#.channel">channel</a></li><li data-type='method'><a href="socket.html#.close">close</a></li><li data-type='method'><a href="socket.html#.connect">connect</a></li><li data-type='method'><a href="socket.html#.subscribe">subscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li></ul></li><li><a href="system.html">system</a><ul class='methods'><li data-type='method'><a href="system.html#.countries">countries</a></li></ul></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.hashPermissions">hashPermissions</a></li><li data-type='method'><a href="access.html#.isAdministrator">isAdministrator</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li></ul></li><li><a href="api.html">api</a><ul class='methods'><li data-type='method'><a href="api.html#.delete">delete</a></li><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li><li data-type='method'><a href="api.html#.get">get</a></li><li data-type='method'><a href="api.html#.patch">patch</a></li><li data-type='method'><a href="api.html#.post">post</a></li><li data-type='method'><a href="api.html#.put">put</a></li></ul></li><li><a href="auth.html">auth</a><ul class='methods'><li data-type='method'><a href="auth.html#.changeOrganisation">changeOrganisation</a></li><li data-type='method'><a href="auth.html#.ensureValidToken">ensureValidToken</a></li><li data-type='method'><a href="auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.login">login</a></li><li data-type='method'><a href="auth.html#.logout">logout</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.set">set</a></li><li data-type='method'><a href="auth.html#.sync">sync</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="cache.html">cache</a><ul class='methods'><li data-type='method'><a href="cache.html#.get">get</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li></ul></li><li><a href="content.html">content</a><ul class='methods'><li data-type='method'><a href="content.html#.create">create</a></li><li data-type='method'><a href="content.html#.delete">delete</a></li><li data-type='method'><a href="content.html#.get">get</a></li><li data-type='method'><a href="content.html#.getFromSlug">getFromSlug</a></li><li data-type='method'><a href="content.html#.glossary">glossary</a></li><li data-type='method'><a href="content.html#.list">list</a></li><li data-type='method'><a href="content.html#.patch">patch</a></li><li data-type='method'><a href="content.html#.restore">restore</a></li><li data-type='method'><a href="content.html#.scopeGlossary">scopeGlossary</a></li><li data-type='method'><a href="content.html#.update">update</a></li><li data-type='method'><a href="content.html#.validateField">validateField</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li></ul></li><li><a href="files.html">files</a><ul class='methods'><li data-type='method'><a href="files.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="files.html#.filesize">filesize</a></li><li data-type='method'><a href="files.html#.getBinaryTypeFromMime">getBinaryTypeFromMime</a></li><li data-type='method'><a href="files.html#.mediaUrl">mediaUrl</a></li></ul></li><li><a href="filter.html">filter</a><ul class='methods'><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterOperators">activeFilterOperators</a></li><li data-type='method'><a href="filter.html#.activeFilters">activeFilters</a></li><li data-type='method'><a href="filter.html#.activeFilterValues">activeFilterValues</a></li><li data-type='method'><a href="filter.html#.filterChangeString">filterChangeString</a></li><li data-type='method'><a href="filter.html#.isValidFilter">isValidFilter</a></li></ul></li><li><a href="socket.html">socket</a><ul class='methods'><li data-type='method'><a href="socket.html#.channel">channel</a></li><li data-type='method'><a href="socket.html#.close">close</a></li><li data-type='method'><a href="socket.html#.connect">connect</a></li><li data-type='method'><a href="socket.html#.reconnect">reconnect</a></li><li data-type='method'><a href="socket.html#.subscribe">subscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li></ul></li><li><a href="system.html">system</a><ul class='methods'><li data-type='method'><a href="system.html#.countries">countries</a></li></ul></li></ul>
 </nav>
 
 <div id="main">
@@ -60,17 +60,32 @@ const service = {};
 
 const loadedExternalScripts = {}
 
+
+/**
+ * A function that dynamically include an external javascript resource
+ * ensuring that it will only be included once
+ * @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 
+ * 
+ * await sdk.utils.loadExternalScript('https://cdn.javascript.com/external/script.js');
+ */
+
 service.loadExternalScript = function(url) {
-    return new Promise(function(resolve, reject) {
+
+    const promise = new Promise(createNewScript);
+
+    function createNewScript(resolve, reject) {
 
         if (!document) {
-            return reject('This function can only be run in a browser')
+            return reject('document is undefined')
         }
 
         if (loadedExternalScripts[url]) {
             return resolve(url);
         }
-        
+
         // Avoid duplicate scripts
         loadedExternalScripts[url] = true;
 
@@ -85,13 +100,64 @@ service.loadExternalScript = function(url) {
         };
         script.src = url;
 
-        // Inject it in the document's &lt;head> tag
-        document.getElementsByTagName('head')[0].appendChild(script);
+        // Inject it into the document's &lt;head> tag
+        document.head.appendChild(script);
 
-    })
+    }
+
+    return promise;
 }
 
 
+const loadedExternalStyles = {}
+
+
+/**
+ * A function that dynamically include an external css resource
+ * ensuring that it will only be included once
+ * @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 
+ * 
+ * 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);
+        }
+
+        // Avoid duplicate scripts
+        loadedExternalStyles[url] = true;
+
+        //////////////////////////////////////
+
+        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);
+        };
+
+        // Inject it into the document's &lt;head> tag
+        document.head.appendChild(script);
+
+    }
+
+    return promise;
+}
+
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -585,14 +651,14 @@ service.mapFields = function(fields, options) {
 
         mapped.trail = trail.slice();
         mapped.trail.push(fieldKey)
-        
+
         mapped.path = mapped.trail.join('.');
         mapped.titles = titles.slice();
-        mapped.titles.push(field.title || fieldKey)
+        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) {
@@ -624,13 +690,13 @@ service.mapFields = function(fields, options) {
                 currentDepth++;
 
                 let injectKey = fieldKey;
-                if(options.includeArrayDelimeter) {
-                    if(!singleValue) {
+                if (options.includeArrayDelimeter) {
+                    if (!singleValue) {
                         injectKey = `${fieldKey}${delimiter}`
                     }
                 }
                 trail.push(injectKey)
-                titles.push(field.title || fieldKey);
+                titles.push(field.title);
 
                 //Loop through each field
                 field.fields.forEach(mapField)
@@ -657,15 +723,16 @@ service.mapFields = function(fields, options) {
  * @return {String}            The query string
  * @example 
  * //Returns &amp;this=that&amp;hello=world
- * qik.utils.mapParameters({"this":"that", "hello":"world"})
+ * sdk.utils.mapParameters({"this":"that", "hello":"world"})
  */
 service.mapParameters = function(parameters) {
 
-    var array = [];
+    parameters = parameters || {}
 
-    for (var key in parameters) {
+    var array = [];
 
-        var value = parameters[key];
+    Object.entries(parameters)
+    .forEach(function([key, value]) {
 
         if (value === undefined || value === null || value == false) {
             return;
@@ -678,7 +745,8 @@ service.mapParameters = function(parameters) {
         } else {
             array.push(encodeURIComponent(key) + '=' + encodeURIComponent(value));
         }
-    }
+
+    })
 
     return array.join('&amp;');
 
@@ -695,10 +763,10 @@ service.mapParameters = function(parameters) {
  * @example 
  * 
  * //Returns £10.00
- * qik.utils.formatCurrency(1000, 'gbp');
+ * sdk.utils.formatCurrency(1000, 'gbp');
  * 
  * //Returns $10.00
- * qik.utils.formatCurrency(1000, 'usd');
+ * sdk.utils.formatCurrency(1000, 'usd');
  * 
  */
 service.formatCurrency = function(value, currency) {
@@ -713,6 +781,92 @@ service.formatCurrency = function(value, currency) {
 }
 
 
+
+/**
+ * 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 
+ * 
+ * // 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];
+}
+
+
 /**
  * A function that will take a currency string and return the symbol
  * @alias utils.currencySymbol
@@ -721,10 +875,10 @@ service.formatCurrency = function(value, currency) {
  * @example 
  * 
  * //Returns £
- * qik.utils.currencySymbol('gbp');
+ * sdk.utils.currencySymbol('gbp');
  * 
  * //Returns $
- * qik.utils.currencySymbol('usd');
+ * sdk.utils.currencySymbol('usd');
  * 
  */
 service.currencySymbol = function(currency) {
@@ -812,78 +966,52 @@ service.getAvailableCurrencies = function(DefaultCountryID) {
 ///////////////////////////////////////////////////////////////////////////////
 
 /**
- * A helpful function for creating a fast hash object that can be used for more efficient loops
+ * Creates a fast keyed hash object from an array of items
  * @alias utils.hash
- * @param  {Array} array The array to reduce
- * @param  {String} key The key or path to the property to group by
- * @return {Object}            A hash object literal
+ * @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 
- * //Returns {something:[{title:'test', definition:'something'}]}
- * qik.utils.mapReduce([{title:'test', definition:'something'}], 'definition');
+ * //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(array, key) {
-    if (!Array.isArray(array)) {
-        array = [];
-    }
-    return array.reduce(function(set, item) {
-
-        var val = _get(item, key);
-
-        set[val] = item;
-        return set;
+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;
     }, {});
 }
 
 
 
 
-///////////////////////////////////////////////////////////////////////////////
-
-/**
- * A helpful function that can create a globally unique id
- * @alias utils.guid
- * @return {String}            The new guid
- * @example 
- * //Returns 20354d7a-e4fe-47af-8ff6-187bca92f3f9
- * qik.utils.guid()
- */
-service.guid = function() {
-    var u = (new Date()).getTime().toString(16) +
-        Math.random().toString(16).substring(2) + "0".repeat(16);
-    var guid = u.substr(0, 8) + '-' + u.substr(8, 4) + '-4000-8' +
-        u.substr(12, 3) + '-' + u.substr(15, 12);
-
-    return guid;
-}
-
 //////////////////////////////////////////////////
 
 /**
- * A helpful function that can return a subset of an array compared to specified criteria, This is usually used
- * to evaluate expressions on Qik forms
+ * Returns a subset of values in an array that match a provided rule
  * @alias utils.extractFromArray
- * @param  {Array} array The array you want to filter
- * @param  {String} path The path to the property you want to compare on each item in the array
- * @param  {Boolean} sum Whether to sum the resulting values together as a number
- * @param  {Boolean} flatten Whether to flatten nested arrays
+ * @param  {Array} array The array you want to extract values from
+ * @param  {String} key The path to the child property you want to extract
+ * @param  {Boolean} sum Whether to sum the extracted values together in total
+ * @param  {Boolean} flatten Whether to flatten nested child arrays
  * @param  {Boolean} unique Whether to only return unique values
  * @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 options specifies otherwise
+ * @return {Array} An array of all values retrieved from the array, unless provided arguments require otherwise
  * @example 
- * //Returns [26, 19] as all the values
- * qik.utils.extractFromArray([{name:'Jerry', age:26}, {name:'Susan', age:19}], 'age');
+ * //Returns [12, 45] as all the values
+ * sdk.utils.extractFromArray([{name:'Wendy', age:12}, {name:'Roger', age:45}], 'age');
  * 
- * //Returns 45
- * qik.utils.extractFromArray([{name:'Jerry', age:26}, {name:'Susan', age:19}], 'age', {sum:true});
+ * //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) {
 
-    if (!options) {
-        options = {}
-    }
+    options = options || {}
 
     if (sum) {
         options.sum = sum;
@@ -904,12 +1032,10 @@ service.extractFromArray = function(array, key, sum, flatten, unique, exclude, o
     /////////////////
 
     //Filter the array options by a certain value and operator
-    var matches = array.reduce(function(set, entry) {
+    var extractedValues = array.reduce(function(set, entry) {
         //Get the value from the object
         var retrievedValue = _get(entry, key);
 
-        ///////////////////////
-
         var isNull = (!retrievedValue &amp;&amp; (retrievedValue !== false &amp;&amp; retrievedValue !== 0));
         if (options.excludeNull &amp;&amp; isNull) {
             return set;
@@ -919,91 +1045,75 @@ service.extractFromArray = function(array, key, sum, flatten, unique, exclude, o
         return set;
     }, [])
 
-    /////////////////
-
     if (options.flatten) {
-        matches = _.flatten(matches);
+        extractedValues = _.flatten(extractedValues);
     }
 
-    /////////////////
-
     if (options.unique) {
-        matches = _.uniq(matches);
+        extractedValues = _.uniq(extractedValues);
     }
 
-    /////////////////
-
     if (options.sum) {
-        matches = matches.reduce(function(a, b) {
+        extractedValues = extractedValues.reduce(function(a, b) {
             return a + b;
         }, 0);
     }
 
-
-
-    /////////////////
-
-    return matches;
+    return extractedValues;
 }
 
 
 //////////////////////////////////////////////////////
 
 /**
- * A helpful function that can return a subset of an array compared to specified criteria, This is usually used
- * to evaluate expressions on Qik forms
+ * A function that can return a selection of values that were found in an array that match a specific rule,
+ * This is often used to evaluate expressions within form fields
  * @alias utils.matchInArray
- * @param  {Array} array The array you want to filter
- * @param  {String} path The path to the property you want to compare on each item in the array
- * @param  {String} value The value to compare with
- * @param  {String} operator Can be Possible options are ('>', '&lt;', '>=', '&lt;=', 'in', '==') Defaults to '==' (Is equal to)
- * @return {Array}           An array that contains all items that matched
+ * @param  {Array} array The array to check
+ * @param  {String} key The javascript dot notation path to extract
+ * @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 ('>', '&lt;', '>=', '&lt;=', 'in', '==') Defaults to '==' (Is equal to)
+ * @return {Array} Returns an array of matching values
  * @example 
- * //Returns [{name:'Jerry', age:26}] as that is only item in the array that matches the criteria
- * qik.utils.matchInArray([{name:'Jerry', age:26}, {name:'Susan', age:19}], 'age', 26, '>=');
+ * //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, value, operator) {
+service.matchInArray = function(array, key, v, comparator) {
 
-    //Filter the array options by a certain value and operator
+    //Filter the array options by a certain v and comparator
     var matches = array.filter(function(entry) {
-        //Get the value from the object
-        var retrievedValue = _get(entry, key);
-        var isMatch;
+        //Get the v from the object
+        var extracted = _get(entry, key);
+        var found;
 
-        ///////////////////////
-
-        //Check how to operate
-        switch (operator) {
-            case '>':
-                isMatch = (retrievedValue > value);
-                break;
-            case '&lt;':
-                isMatch = (retrievedValue &lt; value);
+        switch (comparator) {
+            case 'in':
+                found = extracted.includes(v);
                 break;
             case '>=':
-                isMatch = (retrievedValue >= value);
+                found = (extracted >= v);
                 break;
             case '&lt;=':
-                isMatch = (retrievedValue &lt;= value);
+                found = (extracted &lt;= v);
                 break;
-            case 'in':
-                isMatch = retrievedValue.includes(value);
+            case '&lt;':
+                found = (extracted &lt; v);
+                break;
+            case '>':
+                found = (extracted > v);
                 break;
+            case '==':
             default:
-                //operator is strict equals
-                if (value === undefined) {
-                    isMatch = retrievedValue;
+                if (v === undefined) {
+                    found = extracted;
                 } else {
-                    isMatch = (retrievedValue == value);
+                    found = (extracted == v);
                 }
                 break;
         }
 
-        ///////////////////////
-
-        // console.log('MATCH IN ARRAY', isMatch, key, value, retrievedValue,operator)
-        return isMatch;
+        return found;
     })
 
     return matches;
@@ -1020,10 +1130,10 @@ service.matchInArray = function(array, key, value, operator) {
  * @return {String}       The resulting comma seperated string
  * @example
  * //Returns 'cat, dog, bird'
- * qik.utils.comma(['cat', 'dog', 'bird']);
+ * sdk.utils.comma(['cat', 'dog', 'bird']);
  * 
  * //Returns 'cat, dog, bird'
- * qik.utils.comma([{title:'cat'}, {title:'dog'}, {title:'bird'}], 'title');
+ * sdk.utils.comma([{title:'cat'}, {title:'dog'}, {title:'bird'}], 'title');
  */
 service.comma = function(array, path, limit) {
 
@@ -1058,7 +1168,7 @@ service.comma = function(array, path, limit) {
  * @example
  *
  * //Returns '5cb3d8b3a2219970e6f86927'
- * qik.utils.id('5cb3d8b3a2219970e6f86927')
+ * sdk.utils.id('5cb3d8b3a2219970e6f86927')
  *
  * //Returns true
  * typeof service.id({_id:'5cb3d8b3a2219970e6f86927', title, ...}) == 'string';
@@ -1102,7 +1212,7 @@ service.id = function(source) {
  *
  * @example
  * //Returns ['5cb3d8b3a2219970e6f86927', '5cb3d8b3a2219970e6f86927', '5cb3d8b3a2219970e6f86927']
- * qik.utils.ids([{_id:'5cb3d8b3a2219970e6f86927'}, {_id:'5cb3d8b3a2219970e6f86927'}, null, '5cb3d8b3a2219970e6f86927'])
+ * sdk.utils.ids([{_id:'5cb3d8b3a2219970e6f86927'}, {_id:'5cb3d8b3a2219970e6f86927'}, null, '5cb3d8b3a2219970e6f86927'])
  */
 
 service.ids = function(array) {
@@ -1196,6 +1306,22 @@ service.errorMessage = function(err) {
     return message;
 }
 
+////////////////////////////////////
+
+/**
+ * Generates a globally unique ID, helpful for adding unique keys for iterable loops
+ * @alias utils.guid
+ * @return {String}            The new globally unique identifier
+ * @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);
+}
+
+
 
 
 ////////////////////////////////////
@@ -1249,12 +1375,8 @@ export function EventDispatcher() {
     dispatcher.dispatch = function(event, details) {
 
         if (listeners[event]) {
-
-            // console.log('Listeners', event, listeners[event]);
             //For each listener
             listeners[event].forEach(function(callback) {
-                //Fire the callback
-                // console.log('Fire listener', event, details);
                 return callback(details);
             });
         }
@@ -1268,11 +1390,17 @@ export function EventDispatcher() {
             listeners[event] = [];
         }
 
-        if (listeners[event].indexOf(callback) == -1) {
-            //Add to the listeners
-            listeners[event].push(callback)
+        const type = typeof callback;
+        if (type !== 'function') {
+            throw new Error(`addEventListener() requires a function but ${type} was added`);
         } else {
-            //Already listening
+            if (listeners[event].indexOf(callback) == -1) {
+                //Add to the listeners
+                listeners[event].push(callback)
+            } else {
+                //A
+                //lready listening
+            }
         }
     }
 
@@ -1326,7 +1454,7 @@ export function EventDispatcher() {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Feb 20 2023 18:41:00 GMT+1100 (Australian Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Thu Sep 28 2023 07:24:39 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>