@qikdev/sdk 0.1.168 → 0.1.169
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/sdk.js +2 -0
- package/dist/sdk.js.LICENSE.txt +8 -0
- package/package.json +12 -2
- package/.gitlab-ci.yml +0 -24
- package/.husky/pre-commit +0 -5
- package/eslint.config.js +0 -6
- package/jsdoc.conf +0 -10
- package/public/docs/access.html +0 -3826
- package/public/docs/api.html +0 -1356
- package/public/docs/auth.html +0 -2180
- package/public/docs/cache.html +0 -351
- package/public/docs/content.html +0 -2560
- package/public/docs/files.html +0 -779
- package/public/docs/filter.html +0 -1355
- package/public/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
- package/public/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
- package/public/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
- package/public/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
- package/public/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
- package/public/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
- package/public/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
- package/public/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
- package/public/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
- package/public/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -978
- package/public/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
- package/public/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
- package/public/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
- package/public/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
- package/public/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -1049
- package/public/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
- package/public/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
- package/public/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
- package/public/docs/index.html +0 -96
- package/public/docs/qik.access.js.html +0 -790
- package/public/docs/qik.api.js.html +0 -511
- package/public/docs/qik.auth.js.html +0 -1006
- package/public/docs/qik.cache.js.html +0 -131
- package/public/docs/qik.content.js.html +0 -918
- package/public/docs/qik.core.js.html +0 -301
- package/public/docs/qik.files.js.html +0 -219
- package/public/docs/qik.filter.js.html +0 -611
- package/public/docs/qik.socket.js.html +0 -416
- package/public/docs/qik.system.js.html +0 -117
- package/public/docs/qik.utils.js.html +0 -1467
- package/public/docs/scripts/collapse.js +0 -20
- package/public/docs/scripts/linenumber.js +0 -25
- package/public/docs/scripts/nav.js +0 -12
- package/public/docs/scripts/polyfill.js +0 -4
- package/public/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
- package/public/docs/scripts/prettify/lang-css.js +0 -2
- package/public/docs/scripts/prettify/prettify.js +0 -28
- package/public/docs/scripts/search.js +0 -83
- package/public/docs/socket.html +0 -810
- package/public/docs/styles/jsdoc.css +0 -765
- package/public/docs/styles/prettify.css +0 -79
- package/public/docs/system.html +0 -197
- package/src/api/qik.access.js +0 -825
- package/src/api/qik.api.js +0 -431
- package/src/api/qik.auth.js +0 -881
- package/src/api/qik.cache.js +0 -63
- package/src/api/qik.content.js +0 -839
- package/src/api/qik.core.js +0 -245
- package/src/api/qik.files.js +0 -186
- package/src/api/qik.filter.js +0 -543
- package/src/api/qik.geo.js +0 -895
- package/src/api/qik.socket.js +0 -358
- package/src/api/qik.system.js +0 -49
- package/src/api/qik.utils.js +0 -1412
- package/src/index.js +0 -20
- package/src/version.js +0 -1
- package/test/index.spec.js +0 -41
- package/test/mocha.opts +0 -0
- package/yarn-error.log +0 -3598
|
@@ -1,131 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
|
|
5
|
-
<meta charset="utf-8">
|
|
6
|
-
<title>qik.cache.js - Documentation</title>
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
<script src="scripts/prettify/prettify.js"></script>
|
|
10
|
-
<script src="scripts/prettify/lang-css.js"></script>
|
|
11
|
-
<!--[if lt IE 9]>
|
|
12
|
-
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
13
|
-
<![endif]-->
|
|
14
|
-
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
|
15
|
-
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
|
16
|
-
<script src="scripts/nav.js" defer></script>
|
|
17
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
18
|
-
</head>
|
|
19
|
-
<body>
|
|
20
|
-
|
|
21
|
-
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
|
22
|
-
<label for="nav-trigger" class="navicon-button x">
|
|
23
|
-
<div class="navicon"></div>
|
|
24
|
-
</label>
|
|
25
|
-
|
|
26
|
-
<label for="nav-trigger" class="overlay"></label>
|
|
27
|
-
|
|
28
|
-
<nav >
|
|
29
|
-
|
|
30
|
-
<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>
|
|
31
|
-
</nav>
|
|
32
|
-
|
|
33
|
-
<div id="main">
|
|
34
|
-
|
|
35
|
-
<h1 class="page-title">qik.cache.js</h1>
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
<section>
|
|
44
|
-
<article>
|
|
45
|
-
<pre class="prettyprint source linenums"><code>import _ from 'lodash';
|
|
46
|
-
|
|
47
|
-
import {Cache} from 'axios-extensions';
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
51
|
-
|
|
52
|
-
var caches = {};
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* @classdesc A static service that provides tools for caching api requests and other information
|
|
57
|
-
* @alias cache
|
|
58
|
-
* @class
|
|
59
|
-
* @hideconstructor
|
|
60
|
-
*/
|
|
61
|
-
var QikCache = {
|
|
62
|
-
|
|
63
|
-
///////////////////////////////////////////////////
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
/**
|
|
67
|
-
* A helper function to reset all caches, useful if changing organisation or logging in or out as another user
|
|
68
|
-
* @alias cache.reset
|
|
69
|
-
*/
|
|
70
|
-
reset() {
|
|
71
|
-
_.each(caches, function(cache, key) {
|
|
72
|
-
// console.log(`Reset ${key} cache`, cache);
|
|
73
|
-
if(cache.clear) {
|
|
74
|
-
cache.clear()
|
|
75
|
-
} else if(cache.reset) {
|
|
76
|
-
cache.reset()
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
})
|
|
80
|
-
},
|
|
81
|
-
|
|
82
|
-
///////////////////////////////////////////////////
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
* A helper function to retrieve a specific cache
|
|
86
|
-
* @alias cache.get
|
|
87
|
-
* @param {string} key The key for the cache you want to retrieve
|
|
88
|
-
* @return {LRUCache} The cache store for the specified key
|
|
89
|
-
*/
|
|
90
|
-
get(key, options) {
|
|
91
|
-
options = options || {max:5};
|
|
92
|
-
|
|
93
|
-
if (caches[key]) {
|
|
94
|
-
return caches[key];
|
|
95
|
-
}
|
|
96
|
-
caches[key] = new Cache(options)
|
|
97
|
-
|
|
98
|
-
// console.log('Created new cache', key);
|
|
99
|
-
return caches[key];
|
|
100
|
-
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
106
|
-
|
|
107
|
-
export default QikCache;</code></pre>
|
|
108
|
-
</article>
|
|
109
|
-
</section>
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
</div>
|
|
117
|
-
|
|
118
|
-
<br class="clear">
|
|
119
|
-
|
|
120
|
-
<footer>
|
|
121
|
-
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.
|
|
122
|
-
</footer>
|
|
123
|
-
|
|
124
|
-
<script>prettyPrint();</script>
|
|
125
|
-
<script src="scripts/polyfill.js"></script>
|
|
126
|
-
<script src="scripts/linenumber.js"></script>
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
</body>
|
|
131
|
-
</html>
|