npm - @qikdev/sdk - Versions diffs - 0.1.166 → 0.1.169 - Mend

@qikdev/sdk 0.1.166 → 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.

Files changed (74) hide show

package/dist/main.js +1 -1
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

package/public/docs/socket.html DELETED Viewed

@@ -1,810 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>socket - Documentation</title>
-    <script src="scripts/prettify/prettify.js"></script>
-    <script src="scripts/prettify/lang-css.js"></script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
-    <script src="scripts/nav.js" defer></script>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-</head>
-<body>
-<input type="checkbox" id="nav-trigger" class="nav-trigger" />
-<label for="nav-trigger" class="navicon-button x">
-  <div class="navicon"></div>
-</label>
-<label for="nav-trigger" class="overlay"></label>
-<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#.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">
-    <h1 class="page-title">socket</h1>
-<section>
-<header>
-        <h2>
-        socket
-        </h2>
-</header>
-<article>
-        <h3 class="subsection-title">Methods</h3>
-    <h4 class="name" id=".channel"><span class="type-signature">(static) </span>channel<span class="signature">(key)</span><span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line70">line 70</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    Create an event dispatcher instance and subscribe to a new socket channel.
-This can then be used to receive socket events for this channel
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>const socketChannel = await sdk.socket.channel('awesome:notifications')
-socketChannel.addEventListener('message', function(message) {
-   console.log('Received a new message from the socket')
-})
-// Disconnect from this channel and remove all listeners
-socketChannel.destroy();</code></pre>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>key</code></td>
-            <td class="type">
-<span class="param-type">String</span>
-            </td>
-            <td class="description last">The key or name of the channel to subscribe to</td>
-        </tr>
-    </tbody>
-</table>
-    <h4 class="name" id=".close"><span class="type-signature">(static) </span>close<span class="signature">()</span><span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line267">line 267</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    Close the connection to the socket service
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>const closed = await sdk.socket.close()</code></pre>
-    <h4 class="name" id=".connect"><span class="type-signature">(static) </span>connect<span class="signature">()</span><span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line202">line 202</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    Connect to the socket service
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>const connected = await sdk.socket.connect()</code></pre>
-    <h4 class="name" id=".reconnect"><span class="type-signature">(static) </span>reconnect<span class="signature">()</span><span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line238">line 238</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    Reconnect to the socket service
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>const connected = await sdk.socket.reconnect()</code></pre>
-    <h4 class="name" id=".subscribe"><span class="type-signature">(static) </span>subscribe<span class="signature">(key)</span><span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line297">line 297</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    Subscribe to a socket channel
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>const subscribed = await sdk.socket.subscribe('some:cool:alert')</code></pre>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>key</code></td>
-            <td class="type">
-<span class="param-type">String</span>
-            </td>
-            <td class="description last">The name of the channel to subscribe to</td>
-        </tr>
-    </tbody>
-</table>
-    <h4 class="name" id=".unsubscribe"><span class="type-signature">(static) </span>unsubscribe<span class="signature">(key)</span><span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="qik.socket.js.html">qik.socket.js</a>, <a href="qik.socket.js.html#line324">line 324</a>
-    </li></ul></dd>
-</dl>
-<div class="description usertext">
-    Unsubscribe from a socket channel
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>const unsubscribed = await sdk.socket.unsubscribe('some:cool:alert')</code></pre>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>key</code></td>
-            <td class="type">
-<span class="param-type">String</span>
-            </td>
-            <td class="description last">The name of the channel to unsubscribe from</td>
-        </tr>
-    </tbody>
-</table>
-</article>
-</section>
-</div>
-<br class="clear">
-<footer>
-    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>
-<script src="scripts/polyfill.js"></script>
-<script src="scripts/linenumber.js"></script>
-</body>
-</html>