@qikdev/sdk 0.1.134 → 0.1.136

package/public/docs/qik.auth.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">
@@ -59,7 +59,7 @@ import { EventDispatcher } from './qik.utils.js';
 var QikAuth = function(qik) {
 
     if (!qik.api) {
-        throw new Error(`Can't Instantiate QikAuth before QikAPI exists`);
+        throw new Error(`Please ensure that QikAPI exists before QikAuth`);
     }
 
     //Keep track of any refresh requests
@@ -67,14 +67,13 @@ var QikAuth = function(qik) {
 
     ///////////////////////////////////////////////////
 
-    var defaultStore = {};
-    var store = defaultStore;
+    var sessionStorage = {};
+    var store = sessionStorage;
     const tokenBufferSeconds = 10;
 
-    ///////////////////////////////////////////////////
     ///////////////////////////////////////////////////
 
-    var service = {
+    const service = {
         debug: false,
     }
 
@@ -83,13 +82,10 @@ var QikAuth = function(qik) {
         writable: false,
     });
 
-
     //Create a new dispatcher
-    var dispatcher = new EventDispatcher();
+    const dispatcher = new EventDispatcher();
     dispatcher.bootstrap(service);
 
-
-    ///////////////////////////////////////////////////
     ///////////////////////////////////////////////////
 
     function dispatch(parameters) {
@@ -114,22 +110,22 @@ var QikAuth = function(qik) {
      * @description Manually set current user session
      * @param  {Object} user The user session object to set as the current user session
      * @param  {Object} parameters Additional parameters to dispatch
-     * @param  {Boolean} ignoreEvent Whether to supress dispatching a 'change' event.
+     * @param  {Boolean} stopDispatch Whether to supress dispatching a 'change' event.
      * @example
      * 
      * const userSession = {_id:'61eca4746971e75c1fc670cf', firstName:'Daffy', lastName:'Duck' ...};
      * sdk.auth.set(userSession);
      */
 
-    service.set = function(user, parameters, ignoreEvent) {
+    service.set = function(user, parameters, stopDispatch) {
 
-        if(JSON.stringify(store.user) != JSON.stringify(user)) {
+        if (JSON.stringify(store.user) != JSON.stringify(user)) {
             store.user = user;
-            if(!ignoreEvent) {
+            if (!stopDispatch) {
                 return dispatch(parameters)
             }
         }
-        
+
     }
 
 
@@ -146,7 +142,6 @@ var QikAuth = function(qik) {
         delete store.user;
         qik.cache.reset();
         return dispatch()
-
     }
 
     ///////////////////////////////////////////////////
@@ -193,25 +188,21 @@ var QikAuth = function(qik) {
         return new Promise(function(resolve, reject) {
 
 
-        qik.api.post(`/user/switch/${organisationID}`)
-        .then(function(response) {
+            qik.api.post(`/user/switch/${organisationID}`)
+                .then(function(response) {
 
-            if (autoAuthenticate) {
-                qik.cache.reset();
-                service.set(response.data);
-            }
-
-            resolve(response.data);
-        })
-        .catch(reject)
+                    if (autoAuthenticate) {
+                        qik.cache.reset();
+                        service.set(response.data);
+                    }
 
-         })
-      
+                    resolve(response.data);
+                })
+                .catch(reject)
 
+        })
     }
 
-
-
     ///////////////////////////////////////////////////
 
     /**
@@ -269,8 +260,8 @@ var QikAuth = function(qik) {
     }
 
     ///////////////////////////////////////////////////
-   
-   /**
+
+    /**
      * @alias auth.login
      * @description Login and authenticate as a user
      * @param  {Object} credentials The credentials used to login
@@ -358,7 +349,7 @@ var QikAuth = function(qik) {
 
                 if (autoAuthenticate) {
                     service.set(res.data);
-                    
+
                 }
 
                 resolve(res);
@@ -503,30 +494,12 @@ var QikAuth = function(qik) {
             options = {};
         }
 
-        //////////////////////////////////////
-
-        return new Promise(function(resolve, reject) {
-
-            var postOptions = {
+        var postOptions = {
                 bypassInterceptor: true
             }
 
-            /////////////////////////////////////////////
-
-            //If a full fledged Qik User
-            //then send directly to the API auth endpoint
-            var url = `${qik.apiURL}/user/reset/${resetToken}`;
-
-            /////////////////////////////////////////////
-
-            //If we have a specified url
-            if (options.url) {
-                url = options.url;
-            }
-
-            /////////////////////////////////////////////
-
-            qik.api.get(url, postOptions).then(function(res) {
+        return new Promise(function(resolve, reject) {
+            qik.api.get(options.url || `${qik.apiURL}/user/reset/${resetToken}`, postOptions).then(function(res) {
                 return resolve(res.data);
             }, reject);
         });
@@ -574,22 +547,8 @@ var QikAuth = function(qik) {
                 bypassInterceptor: true
             }
 
-            /////////////////////////////////////////////
-
-            //If a full fledged user
-            //then send directly to the API auth endpoint
-            var url = `${qik.apiURL}/user/reset/${resetToken}`;
-
-            /////////////////////////////////////////////
-
-            //If we have a specified url
-            if (options.url) {
-                url = options.url;
-            }
-
-            /////////////////////////////////////////////
-
-            qik.api.post(url, body, postOptions).then(function(res) {
+            qik.api.post(options.url || `${qik.apiURL}/user/reset/${resetToken}`, body, postOptions)
+            .then(function(res) {
 
                 //If we should automatically authenticate
                 //once the request is successful
@@ -618,60 +577,32 @@ var QikAuth = function(qik) {
      * // Retrieve the user session by providing a reset token
      * const user = await sdk.auth.retrieveUserFromResetToken(resetToken);
      */
-    service.sendResetPasswordRequest = function(body, options) {
+    service.sendResetPasswordRequest = function(details, options) {
 
         if (!options) {
             options = {};
         }
 
-        //////////////////////////////////////
-
-        var promise = new Promise(signupCheck)
-
-        function signupCheck(resolve, reject) {
-
-            if (!body) {
-                return reject({
-                    message: 'No details provided',
-                })
-            }
-
-            if (!body.email || !body.email.length) {
-                return reject({
-                    message: 'Email was not provided',
-                })
-            }
+        if (!details) {
+            return Promise.reject({
+                message: 'No details were provided for password reset request',
+            })
+        }
 
-            //Set email as the email address
-            body.email = body.email;
+        if (!details.email || !details.email.length) {
+            return Promise.reject({
+                message: 'Email is required but was not provided',
+            })
+        }
 
-            /////////////////////////////////////////////
+        return new Promise(function(resolve, reject) {
 
             var postOptions = {
                 bypassInterceptor: true
             }
 
-            /////////////////////////////////////////////
-
-            //If a full fledged Qik User
-            //then send directly to the API
-            var url = `${qik.apiURL}/user/forgot`;
-
-            /////////////////////////////////////////////
-
-            //If we have a specified url
-            if (options.url) {
-                url = options.url;
-            }
-
-            /////////////////////////////////////////////
-
-            qik.api.post(url, body, postOptions).then(resolve, reject);
-        }
-
-        //////////////////////////////////////
-
-        return promise;
+            qik.api.post(options.url || `${qik.apiURL}/user/forgot`, details, postOptions).then(resolve, reject);
+        })
     }
 
 
@@ -692,46 +623,46 @@ var QikAuth = function(qik) {
      */
     service.ensureValidToken = async function(forceRefresh) {
 
-            var currentUser = service.getCurrentUser();
-            if (!currentUser) {
-                
-                return Promise.reject('No user');
-            }
+        var currentUser = service.getCurrentUser();
+        if (!currentUser) {
 
-            var { token } = currentUser;
-            if (!token) {
-                 
-                return Promise.reject('No token');
-            }
+            return Promise.reject('No user');
+        }
 
-            /////////////////////////////////////////////////////
+        var { token } = currentUser;
+        if (!token) {
 
-            //Check our date
-            var now = new Date();
+            return Promise.reject('No token');
+        }
 
-            //Give us a bit of buffer so that the backend doesn't beat us to
-            //retiring the token
-            now.setSeconds(now.getSeconds() + tokenBufferSeconds);
+        /////////////////////////////////////////////////////
 
-            /////////////////////////////////////////////////////
+        //Check our date
+        var now = new Date();
 
-            var expires = new Date(token.expires);
+        //Give us a bit of buffer so that the backend doesn't beat us to
+        //retiring the token
+        now.setSeconds(now.getSeconds() + tokenBufferSeconds);
 
-            if(forceRefresh) {
-                console.log('force refresh valid token', token.refreshToken)
-                return await service.refreshAccessToken(token.refreshToken);
-            }
+        /////////////////////////////////////////////////////
 
-            //If the token is still fresh
-            if (now &lt; expires) {
-                 
-                return token;
-            } else {
+        var expires = new Date(token.expires);
+
+        if (forceRefresh) {
+            console.log('force refresh valid token', token.refreshToken)
+            return await service.refreshAccessToken(token.refreshToken);
+        }
+
+        //If the token is still fresh
+        if (now &lt; expires) {
+
+            return token;
+        } else {
+
+            return await service.refreshAccessToken(token.refreshToken);
+        }
 
-                return await service.refreshAccessToken(token.refreshToken);
-            }
 
-        
     }
 
     ///////////////////////////////////////////////////
@@ -743,23 +674,23 @@ var QikAuth = function(qik) {
         // /////////////////////////////////////////////
 
         // if (appContext) {
-        
+
         // } else {
-        
+
         // }
 
         // /////////////////////////////////////////////
 
         //If there is already a request in progress
         if (refreshContext.inflightRefreshRequest) {
-            
+
             return refreshContext.inflightRefreshRequest;
         }
 
         /////////////////////////////////////////////////////
 
         //Create an refresh request
-        
+
         refreshContext.inflightRefreshRequest = new Promise(function(resolve, reject) {
 
             //Bypass the interceptor on all token refresh calls
@@ -776,14 +707,14 @@ var QikAuth = function(qik) {
                     //Update the user with any changes 
                     //returned back from the refresh request
                     if (!res) {
-                        
+
                         refreshContext.inflightRefreshRequest = null;
                         return reject();
 
                     } else {
                         //Update with our new session
                         service.set(res.data);
-                        
+
 
                         dispatch();
                     }
@@ -799,12 +730,12 @@ var QikAuth = function(qik) {
 
                 })
                 .catch(function(err) {
-                    
+
 
                     //TODO Check if invalid_refresh_token
-                    
 
-                    
+
+
                     setTimeout(function() {
                         refreshContext.inflightRefreshRequest = null;
                     });
@@ -845,7 +776,7 @@ var QikAuth = function(qik) {
                     service.set(null);
                 }
 
-                
+
                 retryCount = 0;
 
                 dispatch();
@@ -857,7 +788,7 @@ var QikAuth = function(qik) {
                 retryCount = 0;
                 dispatch();
                 // } else {
-                
+
                 // retryCount++;
                 // service.sync();
                 // }
@@ -897,7 +828,7 @@ var QikAuth = function(qik) {
         if (!user) {
 
             //But there is an application token
-            if(qik.applicationToken) {
+            if (qik.applicationToken) {
                 //use that instead
                 return qik.applicationToken;
             }
@@ -952,11 +883,11 @@ var QikAuth = function(qik) {
             if (accessToken) {
                 //Set the token of the request as the user's access token
                 originalRequest.headers['Authorization'] = `Bearer ${accessToken}`;
-                
+
 
             } else {
                 //Return the original request without a token
-                
+
                 return originalRequest;
             }
 
@@ -964,7 +895,7 @@ var QikAuth = function(qik) {
 
             //If no refresh token
             if (!refreshToken) {
-                
+
 
                 //Continue with the original request
                 return originalRequest;
@@ -997,14 +928,14 @@ var QikAuth = function(qik) {
                 //Refresh the token
                 await service.refreshAccessToken(refreshToken)
                     .then(function(newToken) {
-                        
+
                         //Update the original request with our new token
                         originalRequest.headers['Authorization'] = `Bearer ${newToken}`;
                         //And continue onward
                         return resolve(originalRequest);
                     })
                     .catch(function(err) {
-                        
+
                         return reject(err);
                     });
             });
@@ -1028,7 +959,7 @@ var QikAuth = function(qik) {
         //Get the response status
         var status = (err &amp;&amp; err.response &amp;&amp; err.response.status) || err.status;
 
-        
+
         switch (status) {
             case 401:
                 service.logout();
@@ -1062,7 +993,7 @@ export default QikAuth;</code></pre>
 <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>

package/public/docs/qik.cache.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">
@@ -118,7 +118,7 @@ export default QikCache;</code></pre>
 <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>