sumba 2.37.0 → 2.38.0
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/docs/Sumba.html +1 -1
- package/docs/data/search.json +1 -1
- package/docs/index.js.html +229 -243
- package/extend/waibuMpa/route/your-stuff/download/get.js +2 -2
- package/index.js +225 -239
- package/package.json +1 -1
- package/wiki/CHANGES.md +5 -0
package/docs/Sumba.html
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Class: Sumba</title><!--[if lt IE 9]>
|
|
2
2
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
3
|
-
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Sumba API</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Sumba.html">Sumba</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#TConfig">TConfig</a></div><div class="sidebar-section-children"><a href="global.html#TTokenBody">TTokenBody</a></div><div class="sidebar-section-children"><a href="global.html#TTokenData">TTokenData</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/sumba" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/sumba" target="">Github</a></div><div class="navbar-item"><a id="" href="https://sumba.bajo.app/" target="">Sumba</a></div><div class="navbar-item"><a id="" href="https://bajo.app/" target="">Bajo</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="Sumba-title" class="has-anchor">Sumba</h1><div class="class-description"><p>Sumba class definition.</p></div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="Sumba"><span class="type-signature"></span>new Sumba<span class="signature">()</span></h3><div class="description"><p>Constructor</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line24">line 24</a></li></ul></dd></div></dl></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="adminMenu"><span class="type-signature">(async) </span>adminMenu<span class="signature">(locals, req)</span><span class="type-signature"> → {array}</span></h3><div class="description"><p>Build admin menu based on locals and request.</p><ul><li>If multi-site is enabled, it will include the cross-site menu with options to manage all sites and site settings.</li><li>If caching is enabled, it will include the cache storage menu in the appropriate section.</li><li>Session management menu is also included in the appropriate section.</li></ul></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>locals</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The locals object.</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line218">line 218</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The admin menu items.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">array</span></dd></dl></div><h3 class="name has-anchor" id="applyActionHook"><span class="type-signature">(async) </span>applyActionHook<span class="signature">(opts<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Apply action hook to the provided model.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>The options object.</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The model object.</p></td></tr><tr><td class="name"><code>teamIds</code></td><td class="type"><span class="param-type">array</span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>The team IDs.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options.</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1695">line 1695</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="applyQueryHook"><span class="type-signature">(async) </span>applyQueryHook<span class="signature">(model, id, options)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Apply query hook to the provided model.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The model object.</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the model.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Additional options.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1672">line 1672</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The result of the model hook.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="checkIconset"><span class="type-signature">(async) </span>checkIconset<span class="signature">(req, reply)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Check and set the iconset for a request.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The reply object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line833">line 833</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves when the iconset is checked and set.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="checkRoute"><span class="type-signature">(async) </span>checkRoute<span class="signature">(req)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Check the route for a request.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line992">line 992</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves when the route is checked.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="checkRouteGuard"><span class="type-signature"></span>checkRouteGuard<span class="signature">(guards, paths)</span><span class="type-signature"> → {string|undefined}</span></h3><div class="description"><p>Check route guard</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>guards</code></td><td class="type"><span class="param-type">Array</span></td><td class="description last"><p>The array of guard objects.</p></td></tr><tr><td class="name"><code>paths</code></td><td class="type"><span class="param-type">Array</span></td><td class="description last"><p>The array of paths to check.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line457">line 457</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The matched path or undefined if no match is found.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span> |<wbr> <span class="param-type">undefined</span></dd></dl></div><h3 class="name has-anchor" id="checkTeam"><span class="type-signature">(async) </span>checkTeam<span class="signature">(req, reply)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Check and set the team for a request.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The reply object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line875">line 875</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves when the team is checked and set.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="checkTheme"><span class="type-signature">(async) </span>checkTheme<span class="signature">(req, reply)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Check and set the theme for a request.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The reply object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line854">line 854</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves when the theme is checked and set.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="checkUser"><span class="type-signature">(async) </span>checkUser<span class="signature">(req, reply, source)</span><span class="type-signature"> → {Promise.<(boolean|void)>}</span></h3><div class="description"><p>Check and set the user for a request.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The reply object.</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The source object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line907">line 907</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to a boolean indicating the result of the check or void.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<(boolean|void)></span></dd></dl></div><h3 class="name has-anchor" id="checkXSite"><span class="type-signature">(async) </span>checkXSite<span class="signature">(req, reply)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Check and set the Cross-site settings for a request.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The reply object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line976">line 976</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves when the XSite is checked and set.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="clearCacheSite"><span class="type-signature">(async) </span>clearCacheSite<span class="signature">(id, result)</span></h3><div class="description"><p>Clear the cache for a specific site.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the site.</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The result object containing site data.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1424">line 1424</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="clearCacheUser"><span class="type-signature">(async) </span>clearCacheUser<span class="signature">(id, result)</span></h3><div class="description"><p>Clear the cache for a specific user.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the user.</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The result object containing user data.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1441">line 1441</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="createJwtFromUserRecord"><span class="type-signature">(async) </span>createJwtFromUserRecord<span class="signature">(rec)</span><span class="type-signature"> → {Promise.<object>}</span></h3><div class="description"><p>Create JWT from user record</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>rec</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The user record object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line293">line 293</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The JWT token and its expiration date.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<object></span></dd></dl></div><h3 class="name has-anchor" id="createNewSite"><span class="type-signature">(async) </span>createNewSite<span class="signature">(alias, hostname<span class="signature-attributes">opt</span>, verbose<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Create a new site with the specified alias and optional hostname, using fixtures for initial data.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>alias</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The alias for the new site.</p></td></tr><tr><td class="name"><code>hostname</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>The hostname for the new site.</p></td></tr><tr><td class="name"><code>verbose</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>Whether to log verbose output.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1138">line 1138</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="createRefs"><span class="type-signature">(async) </span>createRefs<span class="signature">(site, data, options, verbose)</span></h3><div class="description"><p>Create references for the specified site using the provided data, options, and verbosity settings.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>site</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The site object for which to create references.</p></td></tr><tr><td class="name"><code>data</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The data object containing fixtures for the site.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options to pass to the createRecord method.</p></td></tr><tr><td class="name"><code>verbose</code></td><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>Whether to log verbose output.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1107">line 1107</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="filterModelFromSetting"><span class="type-signature"></span>filterModelFromSetting<span class="signature">(opts)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Filter model data based on settings.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The options object.</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The model object.</p></td></tr><tr><td class="name"><code>field</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The field to filter.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options.</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1460">line 1460</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The filtered results and operation values.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="generatePassword"><span class="type-signature"></span>generatePassword<span class="signature">(req)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Generate a random password based on the configuration settings</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line523">line 523</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The generated password.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getActionGuards"><span class="type-signature">(async) </span>getActionGuards<span class="signature">(reread<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array>}</span></h3><div class="description"><p>Get action guards, optionally reloading them from the database.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>reread</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to reload the guards from the database.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line776">line 776</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of action guards.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array></span></dd></dl></div><h3 class="name has-anchor" id="getAllFixtures"><span class="type-signature">(async) </span>getAllFixtures<span class="signature">(alias<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<object>}</span></h3><div class="description"><p>Get all fixtures for the specified alias, replacing any occurrences of '{alias}' in the fixture data with the provided alias.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>alias</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>The alias for the fixtures.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1045">line 1045</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to the fixtures data.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<object></span></dd></dl></div><h3 class="name has-anchor" id="getAnonymousGuards"><span class="type-signature">(async) </span>getAnonymousGuards<span class="signature">(reread<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array>}</span></h3><div class="description"><p>Get anonymous guards, optionally reloading them from the database.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>reread</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to reload the guards from the database.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line731">line 731</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of anonymous guards.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array></span></dd></dl></div><h3 class="name has-anchor" id="getApiKeyFromUserId"><span class="type-signature">(async) </span>getApiKeyFromUserId<span class="signature">(id)</span><span class="type-signature"> → {Promise.<string>}</span></h3><div class="description"><p>Get API key from user ID by hashing the user's salt</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The user ID.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line563">line 563</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to the API key.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<string></span></dd></dl></div><h3 class="name has-anchor" id="getAttribGuards"><span class="type-signature">(async) </span>getAttribGuards<span class="signature">(reread<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array>}</span></h3><div class="description"><p>Get attribute guards, optionally reloading them from the database.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>reread</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to reload the guards from the database.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line791">line 791</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of attribute guards.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array></span></dd></dl></div><h3 class="name has-anchor" id="getCountriesValues"><span class="type-signature">(async) </span>getCountriesValues<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<{value: (string|number), text: string}>>}</span></h3><div class="description"><p>Get a list of countries with their values and names</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line576">line 576</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of country values and names.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array.<{value: (string|number), text: string}>></span></dd></dl></div><h3 class="name has-anchor" id="getModelNames"><span class="type-signature"></span>getModelNames<span class="signature">(asValue<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array}</span></h3><div class="description"><p>Get all loaded model names, optionally returning them as value-text pairs.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>asValue</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to return the model names as value-text pairs.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line805">line 805</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>An array of model names or value-text pairs.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array</span></dd></dl></div><h3 class="name has-anchor" id="getQueryGuards"><span class="type-signature">(async) </span>getQueryGuards<span class="signature">(reread<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array>}</span></h3><div class="description"><p>Get query guards, optionally reloading them from the database.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>reread</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to reload the guards from the database.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line761">line 761</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of query guards.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array></span></dd></dl></div><h3 class="name has-anchor" id="getSecureGuards"><span class="type-signature">(async) </span>getSecureGuards<span class="signature">(reread<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array>}</span></h3><div class="description"><p>Get secure guards, optionally reloading them from the database.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>reread</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to reload the guards from the database.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line746">line 746</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of secure guards.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array></span></dd></dl></div><h3 class="name has-anchor" id="getSite"><span class="type-signature">(async) </span>getSite<span class="signature">(input, byId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Get site information based on the provided input, which can be either a hostname or an ID. If multi-site is enabled, it will fetch the site based on the hostname or ID; otherwise, it will return the default site.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>input</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The input value, which can be either a hostname or an ID.</p></td></tr><tr><td class="name"><code>byId</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>Whether to fetch the site by ID.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1231">line 1231</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The site information.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="getTeamIdsAndAliases"><span class="type-signature"></span>getTeamIdsAndAliases<span class="signature">(req)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Get the team IDs and aliases for the user in the request.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1577">line 1577</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>An object containing the team IDs and aliases.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="getUserById"><span class="type-signature">(async) </span>getUserById<span class="signature">(id, req)</span><span class="type-signature"> → {object|null}</span></h3><div class="description"><p>Get a user by their ID.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the user to retrieve.</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1354">line 1354</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The user object if found, otherwise null.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span> |<wbr> <span class="param-type">null</span></dd></dl></div><h3 class="name has-anchor" id="getUserByToken"><span class="type-signature">(async) </span>getUserByToken<span class="signature">(token, req)</span><span class="type-signature"> → {object|null}</span></h3><div class="description"><p>Get a user by their token.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>token</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The token of the user to retrieve.</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1381">line 1381</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The user object if found, otherwise null.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span> |<wbr> <span class="param-type">null</span></dd></dl></div><h3 class="name has-anchor" id="hash"><span class="type-signature">(async) </span>hash<span class="signature">(item)</span><span class="type-signature"> → {Promise.<string>}</span></h3><div class="description"><p>Hash the given item using the specified algorithm from the configuration.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>item</code></td><td class="type"><span class="param-type">*</span></td><td class="description last"><p>The item to be hashed.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line667">line 667</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to the hashed value.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<string></span></dd></dl></div><h3 class="name has-anchor" id="init"><span class="type-signature">(async) </span>init<span class="signature">()</span></h3><div class="description"><p>Plugin initialization method. This method is called by the <a href="https://ardhi.github.io/bajo">Bajo framework</a> during plugin initialization.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line47">line 47</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="isActionAllowed"><span class="type-signature">(async) </span>isActionAllowed<span class="signature">(action, model, req)</span><span class="type-signature"> → {Promise.<boolean>}</span></h3><div class="description"><p>Check if the specified action is allowed for the given model and request. It retrieves the action guards, filters them based on the site ID, model name, and team IDs, and checks if the action is included in the allowed values. If any guard denies the action, it returns false; otherwise, it returns true.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>action</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The action to check. Available actions are: 'READ', 'CREATE', 'UPDATE', 'REMOVE' and 'EXPORT'.</p></td></tr><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The model object.</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1723">line 1723</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>Returns true if the action is allowed, otherwise false.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<boolean></span></dd></dl></div><h3 class="name has-anchor" id="mergeTeam"><span class="type-signature">(async) </span>mergeTeam<span class="signature">(user, req)</span></h3><div class="description"><p>Merge team information into the user object.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>user</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The user object to merge team information into.</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1308">line 1308</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="parseNsSettings"><span class="type-signature"></span>parseNsSettings<span class="signature">(ns, setting, items)</span></h3><div class="description"><p>Parse namespace settings for a request.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>ns</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The namespace.</p></td></tr><tr><td class="name"><code>setting</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The setting object.</p></td></tr><tr><td class="name"><code>items</code></td><td class="type"><span class="param-type">Array</span></td><td class="description last"><p>The items to parse.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1010">line 1010</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="passwordRule"><span class="type-signature">(async) </span>passwordRule<span class="signature">(req)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Generate a password validation rule based on the configuration settings.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line639">line 639</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The Joi password validation rule.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="pathsToCheck"><span class="type-signature"></span>pathsToCheck<span class="signature">(req)</span><span class="type-signature"> → {Array}</span></h3><div class="description"><p>Gather all paths to check for a request.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line817">line 817</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>An array of paths to check.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array</span></dd></dl></div><h3 class="name has-anchor" id="populateRouteGuards"><span class="type-signature">(async) </span>populateRouteGuards<span class="signature">(sites<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Populate route guards at start</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>sites</code></td><td class="type"><span class="param-type">array</span></td><td class="attributes"><optional><br></td><td class="description last"><p>List of sites to populate route guards for. If not provided, it will fetch all active sites.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line82">line 82</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="rebuildFilter"><span class="type-signature">(async) </span>rebuildFilter<span class="signature">(model, filter<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<object>}</span></h3><div class="description"><p>Rebuild the filter for the provided model.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The model object.</p></td></tr><tr><td class="name"><code>filter</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>The filter object.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1595">line 1595</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The rebuilt filter.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<object></span></dd></dl></div><h3 class="name has-anchor" id="removeRefs"><span class="type-signature">(async) </span>removeRefs<span class="signature">(site, options, verbose)</span></h3><div class="description"><p>Remove references for the specified site using the provided options and verbosity settings.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>site</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The site object for which to remove references.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options to pass to the removeRecord method.</p></td></tr><tr><td class="name"><code>verbose</code></td><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>Whether to log verbose output.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1176">line 1176</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="removeSite"><span class="type-signature">(async) </span>removeSite<span class="signature">(alias, verbose<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Remove a site with the specified alias, along with its references, using the provided verbosity settings.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>alias</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The alias of the site to remove.</p></td></tr><tr><td class="name"><code>verbose</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>Whether to log verbose output.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1204">line 1204</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="resetToken"><span class="type-signature">(async) </span>resetToken<span class="signature">(text<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<{salt: string, token: string}>}</span></h3><div class="description"><p>Reset token by generating a new salt and hashing it twice to create a new token.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>text</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Optional text to use as the salt. If not provided, a new salt will be generated.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line624">line 624</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an object containing the salt and token.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<{salt: string, token: string}></span></dd></dl></div><h3 class="name has-anchor" id="runAttribGuard"><span class="type-signature">(async) </span>runAttribGuard<span class="signature">(opts<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Apply attribute guards to the provided model.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>The options object.</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The model object.</p></td></tr><tr><td class="name"><code>teamIds</code></td><td class="type"><span class="param-type">array</span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>The team IDs.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options.</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1550">line 1550</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="runQueryGuard"><span class="type-signature">(async) </span>runQueryGuard<span class="signature">(opts<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Apply query guards to the provided query.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>The options object.</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The model object.</p></td></tr><tr><td class="name"><code>q</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>The query object.</p></td></tr><tr><td class="name"><code>teamIds</code></td><td class="type"><span class="param-type">array</span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>The team IDs.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options.</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1498">line 1498</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="sendMail"><span class="type-signature">(async) </span>sendMail<span class="signature">(tpl, params<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Method to send mail through Masohi Messaging System. It is a thin wrapper for <a href="https://github.com/ardhi/masohi-mail">masohi-mail</a> send method.</p><p>If both masohiMail and waibu are not loaded, nothing is delivered.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>tpl</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">Array</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Mail's template to use. If a string is given, the same template will be used for html & plaintext versions. Otherwise, the first template will be used for html mail, and the second one is for it's plaintext version</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p><a href="https://github.com/ardhi/masohi-mail">masohi-mail</a>'s params object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line594">line 594</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="signin"><span class="type-signature">(async) </span>signin<span class="signature">(options)</span></h3><div class="description"><p>Sign in user and redirect to the specified URL</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The options object.</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The reply object.</p></td></tr><tr><td class="name"><code>user</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The user object.</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line498">line 498</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="signout"><span class="type-signature">(async) </span>signout<span class="signature">(options)</span></h3><div class="description"><p>Sign out user and redirect to the specified URL</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The options object.</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="description last"><p>The reply object.</p></td></tr><tr><td class="name"><code>reason</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>The reason for signing out.</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line474">line 474</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="start"><span class="type-signature">(async) </span>start<span class="signature">()</span></h3><div class="description"><p>Plugin start method. This method is called by the <a href="https://ardhi.github.io/bajo">Bajo framework</a> during plugin start.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line62">line 62</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="verifyApiKey"><span class="type-signature">(async) </span>verifyApiKey<span class="signature">(req, reply, source, payload)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Verify API key</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The reply object.</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The source of the authentication setting.</p></td></tr><tr><td class="name"><code>payload</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The payload object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line348">line 348</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>True if the API key is valid, otherwise false.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="verifyBasic"><span class="type-signature">(async) </span>verifyBasic<span class="signature">(req, reply, source, payload)</span><span class="type-signature"> → {boolean|string}</span></h3><div class="description"><p>Verify basic authentication</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The reply object.</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The source of the authentication setting.</p></td></tr><tr><td class="name"><code>payload</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The payload object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line374">line 374</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>True if the basic authentication is valid, otherwise false or an error message.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span> |<wbr> <span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="verifyJwt"><span class="type-signature">(async) </span>verifyJwt<span class="signature">(req, reply, source, payload)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Verify JWT authentication</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The reply object.</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The source of the authentication setting.</p></td></tr><tr><td class="name"><code>payload</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The payload object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line422">line 422</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>True if the JWT authentication is valid, otherwise false.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="verifySession"><span class="type-signature">(async) </span>verifySession<span class="signature">(req, reply, source, payload)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Verify user session</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object.</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The reply object.</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The source of the authentication setting.</p></td></tr><tr><td class="name"><code>payload</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The payload object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line323">line 323</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>True if the session is valid, otherwise false.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Sumba API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/sumba" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/sumba" target="">Github</a></div><div class="navbar-item"><a id="" href="https://sumba.bajo.app/" target="">Sumba</a></div><div class="navbar-item"><a id="" href="https://bajo.app/" target="">Bajo</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Sumba.html">Sumba</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#TConfig">TConfig</a></div><div class="sidebar-section-children"><a href="global.html#TTokenBody">TTokenBody</a></div><div class="sidebar-section-children"><a href="global.html#TTokenData">TTokenData</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>
|
|
3
|
+
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Sumba API</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Sumba.html">Sumba</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#TConfig">TConfig</a></div><div class="sidebar-section-children"><a href="global.html#TTokenBody">TTokenBody</a></div><div class="sidebar-section-children"><a href="global.html#TTokenData">TTokenData</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/sumba" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/sumba" target="">Github</a></div><div class="navbar-item"><a id="" href="https://sumba.bajo.app/" target="">Sumba</a></div><div class="navbar-item"><a id="" href="https://bajo.app/" target="">Bajo</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="Sumba-title" class="has-anchor">Sumba</h1><div class="class-description"><p>Sumba class definition.</p></div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="Sumba"><span class="type-signature"></span>new Sumba<span class="signature">()</span></h3><div class="description"><p>Constructor</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line24">line 24</a></li></ul></dd></div></dl></div><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="actionGuards"><span class="type-signature"></span>actionGuards<span class="type-signature"> :Array</span></h3><div class="description"><p>Action guards container</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line47">line 47</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="anonymousGuards"><span class="type-signature"></span>anonymousGuards<span class="type-signature"> :Array</span></h3><div class="description"><p>Anonymous guards container</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line65">line 65</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="attribGuards"><span class="type-signature"></span>attribGuards<span class="type-signature"> :Array</span></h3><div class="description"><p>Attribute guards container</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line59">line 59</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="config"><span class="type-signature"></span>config<span class="type-signature"> :Sumba.TConfig</span></h3><div class="description"><p>Configuration object</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Sumba.<wbr>TConfig</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line35">line 35</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="downloadDir"><span class="type-signature"></span>downloadDir<span class="type-signature"> :string</span></h3><div class="description"><p>Download directory path for storing exported files.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">string</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line71">line 71</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="queryGuards"><span class="type-signature"></span>queryGuards<span class="type-signature"> :Array</span></h3><div class="description"><p>Query guards container</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line53">line 53</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="secureGuards"><span class="type-signature"></span>secureGuards<span class="type-signature"> :Array</span></h3><div class="description"><p>Secure guards containers</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line41">line 41</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="unsafeUserFields"><span class="type-signature"></span>unsafeUserFields<span class="type-signature"> :Array.<string></span></h3><div class="description"><p>Unsafe user fields that should not be exposed or returned in API responses.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array.<string></span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line77">line 77</a></li></ul></dd></div></dl><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="_getAuthSetting"><span class="type-signature"></span>_getAuthSetting<span class="signature">(type<span class="signature-attributes">opt</span>, source<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Get authentication setting based on type and source</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>type</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>The type of authentication setting to retrieve. If not provided, it will use parent setting</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>The source of the authentication setting. If not provided, it will use the default setting</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line204">line 204</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The authentication setting object</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="_getAuthToken"><span class="type-signature"></span>_getAuthToken<span class="signature">(type, req, source<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string|boolean}</span></h3><div class="description"><p>Get authentication token based on type, request, and source</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>type</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The type of authentication setting</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>The source of the authentication setting. If not provided, it will use the default setting</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line225">line 225</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The token if found, otherwise false</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span> |<wbr> <span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="adminMenu"><span class="type-signature">(async) </span>adminMenu<span class="signature">(locals, req)</span><span class="type-signature"> → {array}</span></h3><div class="description"><p>Build admin menu based on locals and request.</p><ul><li>If multi-site is enabled, it will include the cross-site menu with options to manage all sites and site settings</li><li>If caching is enabled, it will include the cache storage menu in the appropriate section</li><li>Session management menu is also included in the appropriate section.</li></ul></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>locals</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The locals object</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line250">line 250</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The admin menu items</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">array</span></dd></dl></div><h3 class="name has-anchor" id="applyActionHook"><span class="type-signature">(async) </span>applyActionHook<span class="signature">(opts<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Apply action hook to the provided model.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>The options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The model object</p></td></tr><tr><td class="name"><code>teamIds</code></td><td class="type"><span class="param-type">array</span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>The team IDs</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1682">line 1682</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="applyQueryHook"><span class="type-signature">(async) </span>applyQueryHook<span class="signature">(model, id, options)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Apply query hook to the provided model.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The model object</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the model</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Additional options</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1660">line 1660</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The result of the model hook</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="checkIconset"><span class="type-signature">(async) </span>checkIconset<span class="signature">(req, reply)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Check and set the iconset for a request</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The reply object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line843">line 843</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A promise that resolves when the iconset is checked and set</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="checkRoute"><span class="type-signature">(async) </span>checkRoute<span class="signature">(req)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Check the route for a request</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line997">line 997</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A promise that resolves when the route is checked</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="checkRouteGuard"><span class="type-signature"></span>checkRouteGuard<span class="signature">(guards, paths)</span><span class="type-signature"> → {string|undefined}</span></h3><div class="description"><p>Check route guard</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>guards</code></td><td class="type"><span class="param-type">Array</span></td><td class="description last"><p>The array of guard object</p></td></tr><tr><td class="name"><code>paths</code></td><td class="type"><span class="param-type">Array</span></td><td class="description last"><p>The array of paths to check</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line483">line 483</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The matched path or undefined if no match is found</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span> |<wbr> <span class="param-type">undefined</span></dd></dl></div><h3 class="name has-anchor" id="checkTeam"><span class="type-signature">(async) </span>checkTeam<span class="signature">(req, reply)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Check and set the team for a request</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The reply object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line883">line 883</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A promise that resolves when the team is checked and set</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="checkTheme"><span class="type-signature">(async) </span>checkTheme<span class="signature">(req, reply)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Check and set the theme for a request</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The reply object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line863">line 863</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A promise that resolves when the theme is checked and set</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="checkUser"><span class="type-signature">(async) </span>checkUser<span class="signature">(req, reply, source)</span><span class="type-signature"> → {Promise.<(boolean|void)>}</span></h3><div class="description"><p>Check and set the user for a request</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The reply object</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The source object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line914">line 914</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A promise that resolves to a boolean indicating the result of the check or void</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<(boolean|void)></span></dd></dl></div><h3 class="name has-anchor" id="checkXSite"><span class="type-signature">(async) </span>checkXSite<span class="signature">(req, reply)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Check and set the Cross-site settings for a request</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The reply object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line982">line 982</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A promise that resolves when the XSite is checked and set</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id="clearCacheSite"><span class="type-signature">(async) </span>clearCacheSite<span class="signature">(id, result)</span></h3><div class="description"><p>Clear the cache for a specific site.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the site</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The result object containing site data</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1419">line 1419</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="clearCacheUser"><span class="type-signature">(async) </span>clearCacheUser<span class="signature">(id, result)</span></h3><div class="description"><p>Clear the cache for a specific user.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the user</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The result object containing user data</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1435">line 1435</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="createJwtFromUserRecord"><span class="type-signature">(async) </span>createJwtFromUserRecord<span class="signature">(rec)</span><span class="type-signature"> → {Promise.<object>}</span></h3><div class="description"><p>Create JWT from user record</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>rec</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The user record object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line324">line 324</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The JWT token and its expiration date</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<object></span></dd></dl></div><h3 class="name has-anchor" id="createNewSite"><span class="type-signature">(async) </span>createNewSite<span class="signature">(alias, hostname<span class="signature-attributes">opt</span>, verbose<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Create a new site with the specified alias and optional hostname, using fixtures for initial data.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>alias</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The alias for the new site</p></td></tr><tr><td class="name"><code>hostname</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>The hostname for the new site</p></td></tr><tr><td class="name"><code>verbose</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>Whether to log verbose output</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1139">line 1139</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="createRefs"><span class="type-signature">(async) </span>createRefs<span class="signature">(site, data, options, verbose)</span></h3><div class="description"><p>Create references for the specified site using the provided data, options, and verbosity settings.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>site</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The site object for which to create references</p></td></tr><tr><td class="name"><code>data</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The data object containing fixtures for the site</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options to pass to the createRecord method</p></td></tr><tr><td class="name"><code>verbose</code></td><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>Whether to log verbose output</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1109">line 1109</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="filterModelFromSetting"><span class="type-signature"></span>filterModelFromSetting<span class="signature">(opts)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Filter model data based on settings.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The model object</p></td></tr><tr><td class="name"><code>field</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The field to filter</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1453">line 1453</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The filtered results and operation values</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="generatePassword"><span class="type-signature"></span>generatePassword<span class="signature">(req)</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Generate a random password based on the configuration settings</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line547">line 547</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The generated password</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="getActionGuards"><span class="type-signature">(async) </span>getActionGuards<span class="signature">(reread<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array>}</span></h3><div class="description"><p>Get action guards, optionally reloading them from the database</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>reread</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to reload the guards from the database</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line790">line 790</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of action guards</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array></span></dd></dl></div><h3 class="name has-anchor" id="getAllFixtures"><span class="type-signature">(async) </span>getAllFixtures<span class="signature">(alias<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<object>}</span></h3><div class="description"><p>Get all fixtures for the specified alias, replacing any occurrences of '{alias}' in the fixture data with the provided alias</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>alias</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>The alias for the fixtures</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1048">line 1048</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A promise that resolves to the fixtures data</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<object></span></dd></dl></div><h3 class="name has-anchor" id="getAnonymousGuards"><span class="type-signature">(async) </span>getAnonymousGuards<span class="signature">(reread<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array>}</span></h3><div class="description"><p>Get anonymous guards, optionally reloading them from the database</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>reread</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to reload the guards from the database</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line748">line 748</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of anonymous guards</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array></span></dd></dl></div><h3 class="name has-anchor" id="getApiKeyFromUserId"><span class="type-signature">(async) </span>getApiKeyFromUserId<span class="signature">(id)</span><span class="type-signature"> → {Promise.<string>}</span></h3><div class="description"><p>Get API key from user ID by hashing the user's salt</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The user ID</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line587">line 587</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to the API key</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<string></span></dd></dl></div><h3 class="name has-anchor" id="getAttribGuards"><span class="type-signature">(async) </span>getAttribGuards<span class="signature">(reread<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array>}</span></h3><div class="description"><p>Get attribute guards, optionally reloading them from the database</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>reread</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to reload the guards from the database</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line804">line 804</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of attribute guards</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array></span></dd></dl></div><h3 class="name has-anchor" id="getCountriesValues"><span class="type-signature">(async) </span>getCountriesValues<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<{value: (string|number), text: string}>>}</span></h3><div class="description"><p>Get a list of countries with their values and names</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line600">line 600</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of country values and names</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array.<{value: (string|number), text: string}>></span></dd></dl></div><h3 class="name has-anchor" id="getModelNames"><span class="type-signature"></span>getModelNames<span class="signature">(asValue<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array}</span></h3><div class="description"><p>Get all loaded model names, optionally returning them as value-text pairs</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>asValue</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to return the model names as value-text pairs</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line817">line 817</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>An array of model names or value-text pairs</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array</span></dd></dl></div><h3 class="name has-anchor" id="getQueryGuards"><span class="type-signature">(async) </span>getQueryGuards<span class="signature">(reread<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array>}</span></h3><div class="description"><p>Get query guards, optionally reloading them from the database</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>reread</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to reload the guards from the database</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line776">line 776</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of query guards</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array></span></dd></dl></div><h3 class="name has-anchor" id="getSecureGuards"><span class="type-signature">(async) </span>getSecureGuards<span class="signature">(reread<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array>}</span></h3><div class="description"><p>Get secure guards, optionally reloading them from the database</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>reread</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Whether to reload the guards from the database</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line762">line 762</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of secure guards</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<Array></span></dd></dl></div><h3 class="name has-anchor" id="getSite"><span class="type-signature">(async) </span>getSite<span class="signature">(input, byId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Get site information based on the provided input, which can be either a hostname or an ID. If multi-site is enabled, it will fetch the site based on the hostname or ID; otherwise, it will return the default site.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>input</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The input value, which can be either a hostname or an ID</p></td></tr><tr><td class="name"><code>byId</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>Whether to fetch the site by ID</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1229">line 1229</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The site information</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="getTeamIdsAndAliases"><span class="type-signature"></span>getTeamIdsAndAliases<span class="signature">(req)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Get the team IDs and aliases for the user in the request.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1567">line 1567</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>An object containing the team IDs and aliases</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="getUserById"><span class="type-signature">(async) </span>getUserById<span class="signature">(id, req)</span><span class="type-signature"> → {object|null}</span></h3><div class="description"><p>Get a user by their ID.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the user to retrieve</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1351">line 1351</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The user object if found, otherwise null</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span> |<wbr> <span class="param-type">null</span></dd></dl></div><h3 class="name has-anchor" id="getUserByToken"><span class="type-signature">(async) </span>getUserByToken<span class="signature">(token, req)</span><span class="type-signature"> → {object|null}</span></h3><div class="description"><p>Get a user by their token.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>token</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The token of the user to retrieve</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1377">line 1377</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The user object if found, otherwise null</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span> |<wbr> <span class="param-type">null</span></dd></dl></div><h3 class="name has-anchor" id="hash"><span class="type-signature">(async) </span>hash<span class="signature">(item)</span><span class="type-signature"> → {Promise.<string>}</span></h3><div class="description"><p>Hash the given item using the specified algorithm from the configuration</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>item</code></td><td class="type"><span class="param-type">*</span></td><td class="description last"><p>The item to be hashed</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line687">line 687</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to the hashed value</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<string></span></dd></dl></div><h3 class="name has-anchor" id="init"><span class="type-signature">(async) </span>init<span class="signature">()</span></h3><div class="description"><p>Plugin initialization method</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line85">line 85</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="isActionAllowed"><span class="type-signature">(async) </span>isActionAllowed<span class="signature">(action, model, req)</span><span class="type-signature"> → {Promise.<boolean>}</span></h3><div class="description"><p>Check if the specified action is allowed for the given model and request. It retrieves the action guards, filters them based on the site ID, model name, and team IDs, and checks if the action is included in the allowed values. If any guard denies the action, it returns false; otherwise, it returns true.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>action</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The action to check. Available actions are: 'READ', 'CREATE', 'UPDATE', 'REMOVE' and 'EXPORT'</p></td></tr><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The model object</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1709">line 1709</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>Returns true if the action is allowed, otherwise false</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<boolean></span></dd></dl></div><h3 class="name has-anchor" id="mergeTeam"><span class="type-signature">(async) </span>mergeTeam<span class="signature">(user, req)</span></h3><div class="description"><p>Merge team information into the user object</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>user</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The user object to merge team information into</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1306">line 1306</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="parseNsSettings"><span class="type-signature"></span>parseNsSettings<span class="signature">(ns, setting, items)</span></h3><div class="description"><p>Parse namespace settings for a request</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>ns</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The namespace</p></td></tr><tr><td class="name"><code>setting</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The setting object</p></td></tr><tr><td class="name"><code>items</code></td><td class="type"><span class="param-type">Array</span></td><td class="description last"><p>The items to parse</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1014">line 1014</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="passwordRule"><span class="type-signature">(async) </span>passwordRule<span class="signature">(req)</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Generate a password validation rule based on the configuration settings</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line660">line 660</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>The Joi password validation rule</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id="pathsToCheck"><span class="type-signature"></span>pathsToCheck<span class="signature">(req)</span><span class="type-signature"> → {Array}</span></h3><div class="description"><p>Gather all paths to check for a request</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p>The request object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line828">line 828</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>An array of paths to check</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array</span></dd></dl></div><h3 class="name has-anchor" id="populateRouteGuards"><span class="type-signature">(async) </span>populateRouteGuards<span class="signature">(sites<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Populate route guards at start</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>sites</code></td><td class="type"><span class="param-type">array</span></td><td class="attributes"><optional><br></td><td class="description last"><p>List of sites to populate route guards for. If not provided, it will fetch all active sites</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line118">line 118</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="rebuildFilter"><span class="type-signature">(async) </span>rebuildFilter<span class="signature">(model, filter<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<object>}</span></h3><div class="description"><p>Rebuild the filter for the provided model.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The model object</p></td></tr><tr><td class="name"><code>filter</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>The filter object</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1584">line 1584</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The rebuilt filter</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<object></span></dd></dl></div><h3 class="name has-anchor" id="removeRefs"><span class="type-signature">(async) </span>removeRefs<span class="signature">(site, options, verbose)</span></h3><div class="description"><p>Remove references for the specified site using the provided options and verbosity settings.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>site</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The site object for which to remove references</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options to pass to the removeRecord method</p></td></tr><tr><td class="name"><code>verbose</code></td><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>Whether to log verbose output</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1176">line 1176</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="removeSite"><span class="type-signature">(async) </span>removeSite<span class="signature">(alias, verbose<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Remove a site with the specified alias, along with its references, using the provided verbosity settings.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>alias</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The alias of the site to remove</p></td></tr><tr><td class="name"><code>verbose</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes"><optional><br></td><td class="default">false</td><td class="description last"><p>Whether to log verbose output</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1203">line 1203</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="resetToken"><span class="type-signature">(async) </span>resetToken<span class="signature">(text<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<{salt: string, token: string}>}</span></h3><div class="description"><p>Reset token by generating a new salt and hashing it twice to create a new token</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>text</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>Optional text to use as the salt. If not provided, a new salt will be generated</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line646">line 646</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an object containing the salt and token</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<{salt: string, token: string}></span></dd></dl></div><h3 class="name has-anchor" id="runAttribGuard"><span class="type-signature">(async) </span>runAttribGuard<span class="signature">(opts<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Apply attribute guards to the provided model.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>The options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The model object</p></td></tr><tr><td class="name"><code>teamIds</code></td><td class="type"><span class="param-type">array</span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>The team IDs</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1541">line 1541</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="runQueryGuard"><span class="type-signature">(async) </span>runQueryGuard<span class="signature">(opts<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Apply query guards to the provided query.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>The options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The model object</p></td></tr><tr><td class="name"><code>q</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>The query object</p></td></tr><tr><td class="name"><code>teamIds</code></td><td class="type"><span class="param-type">array</span></td><td class="attributes"><optional><br></td><td class="default">[]</td><td class="description last"><p>The team IDs</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line1490">line 1490</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="sendMail"><span class="type-signature">(async) </span>sendMail<span class="signature">(tpl, params<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Method to send mail through Masohi Messaging System. It is a thin wrapper for <a href="https://github.com/ardhi/masohi-mail">masohi-mail</a> send method</p><p>If both masohiMail and waibu are not loaded, nothing is delivered</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>tpl</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">Array</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Mail's template to use. If a string is given, the same template will be used for html & plaintext versions. Otherwise, the first template will be used for html mail, and the second one is for it's plaintext version</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p><a href="https://github.com/ardhi/masohi-mail">masohi-mail</a>'s params object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line617">line 617</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="signin"><span class="type-signature">(async) </span>signin<span class="signature">(options)</span></h3><div class="description"><p>Sign in user and redirect to the specified URL</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The reply object</p></td></tr><tr><td class="name"><code>user</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The user object</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line522">line 522</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="signout"><span class="type-signature">(async) </span>signout<span class="signature">(options)</span></h3><div class="description"><p>Sign out user and redirect to the specified URL</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="description last"><p>The reply object</p></td></tr><tr><td class="name"><code>reason</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="description last"><p>The reason for signing out</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line499">line 499</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="start"><span class="type-signature">(async) </span>start<span class="signature">()</span></h3><div class="description"><p>Plugin start method</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line99">line 99</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="verifyApiKey"><span class="type-signature">(async) </span>verifyApiKey<span class="signature">(req, reply, source, payload)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Verify API key</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The reply object</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The source of the authentication setting</p></td></tr><tr><td class="name"><code>payload</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The payload object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line377">line 377</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>True if the API key is valid, otherwise false</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="verifyBasic"><span class="type-signature">(async) </span>verifyBasic<span class="signature">(req, reply, source, payload)</span><span class="type-signature"> → {boolean|string}</span></h3><div class="description"><p>Verify basic authentication</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The reply object</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The source of the authentication setting</p></td></tr><tr><td class="name"><code>payload</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The payload object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line402">line 402</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>True if the basic authentication is valid, otherwise false or an error message</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span> |<wbr> <span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="verifyJwt"><span class="type-signature">(async) </span>verifyJwt<span class="signature">(req, reply, source, payload)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Verify JWT authentication</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The reply object</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The source of the authentication setting</p></td></tr><tr><td class="name"><code>payload</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The payload object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line449">line 449</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>True if the JWT authentication is valid, otherwise false</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="verifySession"><span class="type-signature">(async) </span>verifySession<span class="signature">(req, reply, source, payload)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Verify user session</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The reply object</p></td></tr><tr><td class="name"><code>source</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The source of the authentication setting</p></td></tr><tr><td class="name"><code>payload</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The payload object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line353">line 353</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>True if the session is valid, otherwise false</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Sumba API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/sumba" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/sumba" target="">Github</a></div><div class="navbar-item"><a id="" href="https://sumba.bajo.app/" target="">Sumba</a></div><div class="navbar-item"><a id="" href="https://bajo.app/" target="">Bajo</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Sumba.html">Sumba</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#TConfig">TConfig</a></div><div class="sidebar-section-children"><a href="global.html#TTokenBody">TTokenBody</a></div><div class="sidebar-section-children"><a href="global.html#TTokenData">TTokenData</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>
|