diff --git a/api/.nojekyll b/api/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/api/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/api/assets/hierarchy.js b/api/assets/hierarchy.js new file mode 100644 index 0000000..d135ad7 --- /dev/null +++ b/api/assets/hierarchy.js @@ -0,0 +1 @@ +window.hierarchyData = "H4sIAAAAAAAAA62YXXObOBSG/4uuT1l9guS7ZO0mnnHbfNh70U7HQw2pmcUfa/DObDv57zsytiOjtBwINw42vOd5IUfSi36S3WZTFmTwxUQguATGohAizb8C2aVPeboos826IIOfRIT2cx2vUjIgV4tFlqTr8iqJt2W6I0D+ztYJGTCugex3ORmQRR4XRVr8UewW87i6rJjXdEH9+7Jc5QQqLRmQskje2cLvqh+egYTSdbEvl7Mi3bV2cakL6t8bXZjIcXEdF2lbB44mcI9/TwayWGZ5skvXZPBFhBBKYFwBUxEwI4Cz8OszEMaV424Yl3Fbd44mcI8bnwtT7oP5uCmzp2wR2xZ63H8rFrtsa4/b2mmoEzSdb7ZthGN7uszW3/9ra/JCFVx+azTAmTu4urS0276tWpkL89q43maN6G02dy4P3ONmakRfG8dI6svlgXvcSBVc1sctjni8NDj9bTFMuTDAIwpChSA0BUklSK5BKg4yCkFRCopLUFKDijgoE0LIGYSKQhgpO6CFCmsDen5z94i0fhi/2yxwZIgHpWmd+D7Ptl2QR10zU1JZZ17vy3Kz7kI9KxFcruvcabrqdK9HHYKpeJ15u19lSRfoSYigRl4fXWW7+d0uLYouZFfcTFfU6ylb4H4f513hRy2Czb3e+vMTH/2zz/7twna0CLb0+muSfV9ip9gL8EmIoEZeh03STv1VyRBE43XX9f7HD/SsXhu/RyUiEXKGyRw4E7+R/zpmoFwq6kcMnKfzxcHLUTMvUvVEgaOdFlP0ohpdvBgk6VO8z8smUhKX8be4SOfLeJ3k7pvBbfVDcCyE4CvTC/8YJNrzNe+Db6NFO/ZFzIhECJEyoKkBRkMOjGoFjFENjAlmY4SmpjZAj7z2Zh1x4B63MKwFA6046EiANhIMU2BECEZFYCINxtgb4RQYlZV9wV5JQb3dglOs+X+u/fX7/WR8158ZpxrCTSS8mXc2nX762J+fi3oIR8Zbb6ejDz0+H6ca4m2d1V+I57ezD+Nhf3bccgg/ws9h44f53cPoscd+rpdE+Lp4ez8XuZ9dTfq15VTE7LV4+cnmr/vZ+K/+XNUqIlyZ+mQ6n4xvbqf9WXLLIbYwKPfi9WTUY4u/FMOYkd5cfT37/Hn00OeM5NTDWAq9KXtYLbP9ebosiDGlFSK7djbYUPCXiRZ/A4zqPsJPFWxbRy+bbPrAd8p9dqe81lFo8mqTpHnVQIfOaROcGNMcGNM22Bm7AUyp/QiBccbthwbG7U4+F/aEsCekPSH1YXeYaW8g3Nw9drZuxZiHpb1Z3Gac7lirxnD9JFJlme7kSo9gc3/Hw+aW7mSrRnG9fHEIKN3BBzmGzLzeOseQ7vRzCZQDr89OieNtBmwFDP/1nSabLbrzTxUwfOHHABskusMPchTZ67rJ6A09NxmhOk56HVclg7eMb6tHsb1eG7Zcgjz4ELf8PD//D+XGCJK6HQAA" \ No newline at end of file diff --git a/api/assets/highlight.css b/api/assets/highlight.css new file mode 100644 index 0000000..5674cf3 --- /dev/null +++ b/api/assets/highlight.css @@ -0,0 +1,22 @@ +:root { + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --code-background: var(--dark-code-background); +} + +pre, code { background: var(--code-background); } diff --git a/api/assets/icons.js b/api/assets/icons.js new file mode 100644 index 0000000..58882d7 --- /dev/null +++ b/api/assets/icons.js @@ -0,0 +1,18 @@ +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/api/assets/icons.svg b/api/assets/icons.svg new file mode 100644 index 0000000..50ad579 --- /dev/null +++ b/api/assets/icons.svg @@ -0,0 +1 @@ +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/api/assets/main.js b/api/assets/main.js new file mode 100644 index 0000000..d26cd1d --- /dev/null +++ b/api/assets/main.js @@ -0,0 +1,60 @@ +"use strict"; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse"}; +"use strict";(()=>{var De=Object.create;var le=Object.defineProperty;var Fe=Object.getOwnPropertyDescriptor;var Ne=Object.getOwnPropertyNames;var Ve=Object.getPrototypeOf,Be=Object.prototype.hasOwnProperty;var qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var je=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ne(e))!Be.call(t,i)&&i!==n&&le(t,i,{get:()=>e[i],enumerable:!(r=Fe(e,i))||r.enumerable});return t};var $e=(t,e,n)=>(n=t!=null?De(Ve(t)):{},je(e||!t||!t.__esModule?le(n,"default",{value:t,enumerable:!0}):n,t));var pe=qe((de,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,c],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[c+1]*i[d+1],c+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof de=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse"};var ce=[];function G(t,e){ce.push({selector:e,constructor:t})}var J=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){ce.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!ze(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function ze(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var ge=$e(pe(),1);async function H(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).text();return JSON.parse(i)}async function fe(t,e){if(!window.searchData)return;let n=await H(window.searchData);t.data=n,t.index=ge.Index.load(n.index),e.classList.remove("loading"),e.classList.add("ready")}function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:document.documentElement.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{fe(e,t)}),fe(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{re(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),We(t,i,r,e)}function We(t,e,n,r){n.addEventListener("input",ue(()=>{Ue(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Je(e,t):i.key=="ArrowUp"?(me(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(me(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),re(t))})}function re(t){t.classList.remove("has-focus")}function Ue(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ye(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ye(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=c+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function me(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Je(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),re(e)}}function ye(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ne(t.substring(s,o)),`${ne(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ne(t.substring(s))),i.join("")}var Ge={"&":"&","<":"<",">":">","'":"'",'"':"""};function ne(t){return t.replace(/[&<>"'"]/g,e=>Ge[e])}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var A="mousedown",Ee="mousemove",B="mouseup",X={x:0,y:0},xe=!1,ie=!1,Xe=!1,D=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Xe=!0,A="touchstart",Ee="touchmove",B="touchend");document.addEventListener(A,t=>{ie=!0,D=!1;let e=A=="touchstart"?t.targetTouches[0]:t;X.y=e.pageY||0,X.x=e.pageX||0});document.addEventListener(Ee,t=>{if(ie&&!D){let e=A=="touchstart"?t.targetTouches[0]:t,n=X.x-(e.pageX||0),r=X.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var Y=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(A,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var se;try{se=localStorage}catch{se={getItem(){return null},setItem(){}}}var C=se;var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var Z=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=C.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){C.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var oe=new Map,ae=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;C.setItem(this.key,e.toString())}},K=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(oe.has(i))s=oe.get(i);else{let o=C.getItem(i),a=o?o==="true":this.el.open;s=new ae(i,a),oe.set(i,s)}s.add(this.el)}};function Se(t){let e=C.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{C.setItem("tsd-theme",t.value),we(t.value)})}function we(t){document.documentElement.dataset.theme=t}var ee;function Ce(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Te),Te())}async function Te(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await H(window.navigationData);ee=document.documentElement.dataset.base,ee.endsWith("/")||(ee+="/"),t.innerHTML="";for(let n of e)Ie(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ie(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',ke(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let c of t.children)Ie(c,l,i)}else ke(t,r,t.class)}function ke(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=ee+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span"));r.innerHTML='',r.appendChild(document.createElement("span")).textContent=t.text}}var te=document.documentElement.dataset.base;te.endsWith("/")||(te+="/");function Pe(){document.querySelector(".tsd-full-hierarchy")?Ye():document.querySelector(".tsd-hierarchy")&&Ze()}function Ye(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=tt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function Ze(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Qe),Qe())}async function Qe(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await H(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),Ke(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function Ke(t,e,n){let r=e.roots.filter(i=>et(e,i,n));for(let i of r)t.appendChild(Oe(e,i,n))}function Oe(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let l=t.reflections[a],c=s.appendChild(document.createElement("a"));c.textContent=l.name,c.href=te+l.url,c.className=l.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=te+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let l=Oe(t,a,n,r);l&&o.appendChild(l)}}return r.delete(e),s}function et(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function tt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}G(Y,"a[data-toggle]");G(K,".tsd-accordion");G(Z,".tsd-filter-item input[type=checkbox]");var _e=document.getElementById("tsd-theme");_e&&Se(_e);var nt=new J;Object.defineProperty(window,"app",{value:nt});ve();Ce();Pe();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/api/assets/navigation.js b/api/assets/navigation.js new file mode 100644 index 0000000..0263a1c --- /dev/null +++ b/api/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "H4sIAAAAAAAAA7WbUW/bNhDHv4ueg23N1m7LW1p7qYGkcWK5A1oUAi3RMVFZUkQqWDv0uw8SJYukeOQxWt4C+O73vzvRPB6tfP43EvQfEV1EvE6jsyg9sDyraRFdfD59QjJSCVpz4OPLNGUZLcSlNIvOooqIQ3QRHcusySn/mddpMjASw/qngzjm0Vn0lRVZdHEeqJDmhHOfglPx1fkfP778OBulGnHYclojk9GtcclACvZkDAWnYpvMmMqGPRTbqjVeEEFGHVYIWu9J6pPS/Y3cXr/RyvaWcIormWKJKpeVbC2VSgZVzOfdpoYLXLFEBW4lWwNXyaCKLfCbR4H81hnWqAT2OavWJRfrukwp56WisW+KVLCy8KhMCLrum9+UfFq/G8o5eaDvSZHlNFxuipjoqRX8UAq2ZylpyZtmx9OaVe3fuIp6vFEVRkdgXTa+CIIiNJdXfGDFwzdcKTRbVOIA3ZqmTndomSngt/HQLRy/fatk57b9RQudVMzXbDsLW1IVSxSjsP6qQrV8DCgoALZTZ7ijUVgHdYarQEEBM9yubbhC7Q3wncsV4gCzQq2NyhVab4DuTcklq5N1TTl3BjlgJy6uo8fJ+K4heRi+9/DS3zZClAWefbJHkL9/9ywug9zbe8nvbs+Xjw17wrMVDy/9r5xVeHJv7aVerTd4qDT2Mt83R5bhqYO5l3tNA6jS2M9kDwf3xqhTe3MvN6bHgKfVW7u3CPoPOVa5ewMbbVAbxQMVS+kBnsZ06OjwvLOXK3aH07zjlusxuETRAZlPqi4bQTmcqfwclRSx9e4nUjOysxAJ1Lh/PVePH6yeNgaYOVq7mZNm4EJa+4BOtB0DYCR0BtCYu2lXAYk7e0cxeJNe4uBZ+4jGS8tzHEwaOkh7s1uAqL2tU2ishwq5VKShg3SYdAaQdbB2BY2WUyQrt/QCnTTpAjDL2gE0WoHZiEABh7dDs3OuEXhp6CAJs3OBKGHrWjpLjnM42mDr4DXo/aAB9gLLEOzqSbE9KPfc6+o3IxBAW8dcV4gho5V3rBpgjnFKH2QrKLDKCEjb5QouSCGADnn6GJXS6nZ9ex9DK2JkSTvH2sJhrBC1JBkRZEc4BQb8g7y58l22T+7I1AINEskASww3VOEyuidNLuxrwS/Ru+PuB0LT0d1eJB1DApVOO8kHpqK4vEQaKh6VQjtuBKaguATcPqzuk/X9crOZiLkTUsWsIP+9xOo+udteXv8fwgrHf6+wjePbD3NVNQpC89On5f18TYWCuuW4264+zlU1OF7dhVzec2V1jP/W5Xq1niupMDD3MXPlRoT/pmZ7s1rM1VMh/vuW5Wy9EeFXW129j2frKRD/vc/yZvZ6URg+vZlSoArmMiewjXgws654AsvgCyUoVPtPa4HF0Zxe4qCgC6COCs84uL3woQ15YFOTuCkzmnvC72xQ8XL62NCcfafJUefq44JBNrxc9z81JYJu0gM9Km906DeyBlx1cfz+ntVlFcQdHRzUmma0ystvQWTdyUnf15QfAuGKj/OOunsWvjnMs3Ik4zQbBf0a61n0JtquoXeEwWYR34508a3CshfxrZHCL3/+/ur1uXWmQ5amtw765RdZmgFt1zBK09tgS2OyUaXRX8RylcXyyhU8TOHK0SGnXGBC6kaqQPDoiB7CnqPQ+iGnrVC89EKOVeHw1gs9P4XiBz/soBTKX0AN1TIRhbJbH8zoE8q9WvuXYjeehII7J8wwEwq+XiKw7cARDG6dUONJKLn18YGR2+oJCm6nClaux2C65ubfs6GzPm4fh7xnTTO4BwRK42LSnyHkg6x8cCyoRyNnFtyDkLYBv9LgitxjbXS9gNICWS6NiioF/sCFPmzhD1od0nfACjhcnXiO1PUp7vgoBHBSb98KflcWBU3hb23rnuiGqBLd3MWxja0Wy8bW/dxTdusalxVLPaF3Nriop0RrwJIIsKeTNKf1E0upb2JaUEFTUQKrdYAkpnnQyzCDUyKMr7I+GsJiAMgxi048Gu3r82zhZvK1MsbU9vlsJM9TUsUSeZlRZN37bHFpbolAOqrCxNtRvNZ2UzZF9mwlzdupJJoK2hJQWhN/l5rsaDu6oQUvax4mZTg7V8HfdMfL9CtFLgXTHLUe6JGJYcFuq4wI8KVAWGfKcJSPFUww0l6MbTpIuJxJsNRQrWLXkuyl6z5ClemKFrRmKdDrJGe08Z1y5cNvG0b/ry0wdGLqZSsHrvv2DpILB31qHMKPy6+0wNE7U/+RpxEsBx5W9xHuRqliy7ougYOO5Aw2rtPNE8lZu5qXxdPH/qoXWq0SanGwLs4v/wFNHzJjojkAAA==" \ No newline at end of file diff --git a/api/assets/search.js b/api/assets/search.js new file mode 100644 index 0000000..ecec2a6 --- /dev/null +++ b/api/assets/search.js @@ -0,0 +1 @@ +window.searchData = "H4sIAAAAAAAAA82dXZPbNtat/8qpzm2PI3yRUu4yE593UjWZZCbOnKrXlXLJEm2r0i0p+nDGmZr/fooEoQY2FkCABDu+iuImgQVwYW8QD0j+5+50+O1899Xr/9z9sttv777i93f79WNz99Xd+bT5cn083t3fXU8Pd1/dPR6214fm/OX5tHmzPh5ffLg8Ptzd320e1udzc7776u7uv/e4lM1hf76s95czLOv212iJ4qnIH77/56tbSR/Xp936rV9WexAo8P7uuD41+4unDNb07fdJdenDxtXm9tTl07HBvdT9Jd7ni1XN1FN5/9Psm9Nu882r728FdoVYxT0dMixeS3uqrlJKVLfK3nQlplb0xe3wgfqsE62q2YLLW827bWat3Qnp9b7otQaq35ya9aXZfn3JVNGft76UFHM9bkeJ6c+bLIZa8Mdmfz6cvvvHq1ffNefz+n3YIN6RMxsS15fuS79lgUuyPh6/DTs0KmN9PCZ51S8k7pLt+rIep6g/s7SgR33Uq9EXrC9g7LUbkGflrSxV3XkFxHij6vr2vDntjpfdYf/P5tdrcw6Pd3Ds3CMrUGPG2ALtC1yas3Xoq8MvzX6sLLugS1/QCJ1DI6/5uNs0k4TqIopKjPkrXWt35DN666m+cc7SLQsN+RHNNqN+xKXRhfgXxpkbXi+7Bzw37P4SnRtWT037uH7Ytdn+5f7jv/r57K3Qd9f9ptVjFwuOH77KWqvVuXx5E/D1cffydDqcbrX2xVh1mkPyK1LsqdO66fbpurmk1/WFe85Avbdzg+Hpsr5cz385bJtkAfqUjT5lav2PZNY1VPnT8SNqJneO2/Xx0pzOX3692ey2zf7ytf4HfDvZH/yGHBz1tOOpQCV2g4OVDFdKuiDYtnE+zBKW7NCQSFpqMFe9/et6v30o0ZlfbN9+uJX1pPhy3v5pd/7T8XS4NJtLs/0//T/s9h+a0+7SbAs0iS/kk0veN5cCjdGleM2YU/Wb9cNDGeV9Sc+n/ngt0ee6lGdUfTgXka2LeT7d2+ahueB4nzliTUHPrb2Q1Z3C5m1DIO1dLx9+OjentLTnHhxf5lNP0+Ufd+/3Px3bM7+x7+l3+0tzerfeDFXjnp6T90jjAinkuD6ffzuctiWEfWEVlq+QlBhcPzs3p7+3P0sIbgvb68JmE/xudzpfiinuSptb8sO6oOK2sDkE21PLwEDGsYnUMDyw84fYuKllgrARU8t4qZEZzZ8//fQ0PKbqft9c3n6aNtwSletV+/bAEt3dFXY9N/P2dsJcJkWtN5cpoHPUDUeK2OI3HKONXsbeIycxo1UnzMISlU+Ygo20++ANR5LbR99wjFOdNHFPcv6UifsU7YUsM3nint4GPHH/8/rcJE3arQOT16lQ4bCv7MLjFYU6wq5q4uQhJiY4aaDBNkXoCyx6TJqIar6lhz+xuTTn5YGoWhr/C6oaHrRDyryRWkrdYByPKqPxu5iqwclUXFbyJCpTV0r+iA8JP2+U1TbRaoG8MEUjjv/trWBS/LcOTI7/qHDYF3bh8YpCHWBXNTH+x8Tk3zQGShsdO6PqkmNnvqphQw8pS3fzsLoxOTKqr/QtVGYHD4b/qPjR0/dclYPpIC5zNB/I1JmSHuJumHBbMUrrxNE19TYiQXM4fXz36yUNd5ODU7dwtKf0u8XoOHd3cAQr8kvIzCx2E6HGdw+74w+H8+WH02HTnM+HbIleAUUUBq7a3w+X3bvdZt3qsjfmJF3FgZOTJwepIuBoGBKRLzLUuUMyJ042SjQkf1Iysdb4evHfm9/Ce+pm7ISu8n3zW97mxrn7ZL3d2kc/Q0est9uzW+Mf1/pzs9/apz5D89sq926Vz9r+MVPTIg0vPYWdyRKDdzhFOmM0RZiv1cNzvFItHz8RnKn1g7c3RVo++jZorlYP3i6Vafbo26qZ2p1y+1Um4k24TZu17c801Kfe9hXsA3yj8erDbv/+U9JthXNo8k0ErgD2uFvBUHWhLnMrnDj5H5KUP7GPlDhxijKotfT0I60peVOLwUaMnjaMUzscJ1IUjw8AI1QPpvJBxaPT9Bi1gyl4WO7o9DpCb0rqHB6JE9LiaM0FrDw1nSVqx6kqefdy6s5lO00l76i0Cx+3k7LgLsqYmPzUFChtYlqKaiydkoabkJeOouJHp6J8lcNjd0jp+EGbqXYw/USVjk49uSoH005c5uiUk6kzJd3ER9iEVDNK60SrTk0xCZrJG4V2Tw/XHHeBtwvt3ljH5D8FapXr9AgpN14HbTERPjKVDEhIzyKunBdYGvFLG967i9QfPE6iLqfdt75+KmcGpf18pYDWS1dSQbXuK15i85ghgU8nT8nH+V0cTMVDgrOzcL62YEob0padzUZoCyayQXHZOWzMwAmnr+Ghkp+58hXq+Wf/EqnweyAG1epy3utymr6cWZWbF2H8+bD9NE6zKeGtLqG4Wj/Rms3vsUT7dEx6ogXlej1hlRuvAzXWqmBCoo1IyEu0uKAg4929338bILtDstpzdwOIdpyin47jFV2PpRV9bE67d58iWyGGZOkCErYzJGnLS+gxXeUSel6HRhN6TPCohJ6nLZrQY9pGJfRMbdGEHhU3KqHnqRtK6DF9YxN6nsKchB5TWyKhZ4agpIQejUGTEvqwWi+hd08yRJJ5//e859EiSdyUFy4XNMwUOj5xo2rHP2j2JOmFLy0r8ENd/Um5j5JFVSVHdqho8KGH9LpjkRvWPfjgVUbdsciMKx98vCq99oHIC+tPeYgqXUFGZIVqBiLqBGVJkRNqCkbMTDVeZOw26UciY//3rCe13vzPDz/GoqMp0zo2LUIaseMjZKjqrNsaUMjYyBjUU2w6HBebHDCDQsdMgzM0xQJpUNOY6W+OpliADYsaM+3NUDUQeIO6Rk53M5RlBOSgygLT3AzFSYE6qHXS9HYguNBQ+38fdsfkWNsf/IcEW7vu8dHWNLdEuHUUzRNvfbnjAq4jdXLEHVCVHHIdVZNj7pCq5KDrypocdQd05YRdR1mJuDugbWzgdXSWjrwDmvNDr6O2XOwFoYYG3z9fL5fDPjn83g7/QwKwW/v4EPzU6BJBmKiaJwwjyeMCMZE7ORQPKksOxkTZ5HA8rCw5IFNpk0PyoLacoEzUlQjLg/rGBmaitXRoHtSdH5yJ4nLhGYYhGqBfNY/ps+P+4D8kONt1jw/NprklArOjaJ6w7MsdF5QdqZND8oCq5IDsqJocjodUJQdjV9bkUDygKycQO8pKhOEBbWODsKOzdAge0JwfgB215cIvCDU0+P71+rjbJkdfc/QfEn6dysfH31uLSwRgV9M8ERgIHheCXbGTY/CQruQg7OqaHIUHdSWHYSJschweUpYTiF1tJSLxkLqxodhVWjoWD6nOD8au3nLRGAUeGo6/3p3e/HBqzufkkGyf8YeEZU/A+NDstL5EePa1zROiA8LHhWlf9ORQnaIvOVz7+iaH7CR9yWEbCJwculMU5oRvX2OJEJ6icmwY9xWXDuUp6vPDua+7XEgPBSwU1v9xXT9kRfX+hD8sqNv1T4vppumlQrqjbL6I7sseH9AdyUXi+YC6rHDuqCsSzYfUZQVzV16RWD6gLzeUOwpLRfIBjVMCuaN3jjg+oH1cGHdUl43iIETRIP6X7/nLX6+7j8lB3DrhDwnitP7xQdxueokg7imbJ4hj2eOCuCd5chBPUJccxD11k4N4irrkIO7LmxzEE/TlBHFPYYkgnqBxbBD39JYO4gna84O4p7pcEA+EKBrE/7Z7/yH6DgWnUHP0HxK+ncrHx+5bi0sEblfTPFEbCB4Xsl2xk+P1kK7kYO3qmhypB3Ulh2kibHKMHlKWE6BdbSWi85C6saHZVVo6Lg+pzg/Krt5yERkFHi8cN+nwUR/7x4TipgB47NtaJAw3c0NHT+zIENwUBI5xTenhtykIGwc0pYfepiRojKvKCrtNWcgYVzY65DbzAca44hHhtpkDLvrBxd8H/fvv8beaOAXeDv9DAq5b+5R90KbRZfZBO6rm2gftSx67D9qRW2Af9ICyjH3QjrIC+6CHlGXsg3alFdgHPaAtbx+0o67MPugBfeP3QTtay++DHtA9Zh+0o7jkPmig1XvMO/gC/sij35FzQODG6SGlXtpvsXrzNIG+iwkan2CmSM7KQCMrCvlYf+oq/japaW3rKkh721ThtkXj8qRGJb0uY3prsiYTkxpUbLZR+BLGpiOTGjxmvlLanpEJzTR3jpjxFG7bwLRjUvNGzksKtzBj4jKptQVmNoVbnjT1mdTmSXOjAq31Jk/9C5UjU6XbEckTI79M2odPZcZKB13wVPT4CU2o8qzJCihkbHoL6imWuuJik9NSUOiYlJOhKZZOgprGpIocTbEZWFjUmNviDFUDySmoa2TiyVCWkVSCKgskjAzFSckgqHVSoB9Q6QXxofc5577Leeg9zqa8rPc3T393M6o2K2iTAsYGbKijWLAOi0wO1FDgmCCdqCUWoKGWMcE5VUssMGMxY4JyopqBgAz1jAzGiYoyAjFUVyAIJypNCsBQ46TgG1HnBd7m3+vH40P09btPh0TDbyXtkf1Sn3Qr9N11v2ln87DYp+PTArElOta20+F6ac7Bduk/R9skngrtjn5y2sf1abd+C4rTx6W1oxcI67uSDBas8JqTwmI1rsH3D4K1rslboyfVvI/c+g0qiZw8XdnFuxEM6rg406dJtb4/npOq1MdNr+8deU1hsMJ3Oa8ojNX41ns3V7DOt3nv5YpeTfLCmfC1zHnZTKzGD/QtC8EqP2S9YSE6jncn70ni8Dh+OrhIzfRht1jFWc+5xerdHHhSnfq46fU90L3EwRofsvYRR+ts0nz0kLFZLj5C6a6RyAjN2jESdRD42F3YQrlfuvNqducM2/Vl/XZ9br787rBtHuC8wRzypjskdT60PR2OP24+NI/rwHyIFPt0/HC7iGhY/6l5d2rOH3IkOKeUUaFpY44I+4xSPbFtjg+HT3ldYZ8zQYfl83Pz67V52P3evHl0vOZ6nQghJ01QEvB9/xnd8+2zXPTbvHAomLPekLOSF2u2zbv19QHf8w7X0p+d0RvBZo5b2MmTmLzcMyjXFBtaBNo8nIvo7YqZsCQ0piFJC0WZDcldPiqhO/gd23zt2V+znaxfh98iHjIlPaP663FbSP2tpGdUH1l2y1Q/YjGukPpS5h/5NedRrRhKjP2yR2ZidM+aKzGSWqYkRtLMYokxInFKYsTFFkiMUb0zJMbBhoxNjLGGFEiM2bpzYsOA9hKBIU9/XmKMeqhIYsxTn5cYY+rLJMY89XmJMaa+TGIco76U+cslxuFWDCTG9mtmeUnROmOmhGjXMCEZ2k0rlQhD0iYkQVDk9AQY1jmQ/KbqHZnngnqHvh45VV/GkI5p9MZyUZ1ZeSt86f2cVVRlVn4KqgS5qajKrDwUVJnwbc0CKkuYM5BrJqsdyCvtU1R5ecU6IzmvoFri/WTXEq9xsIPsykvll5i80d8cjkp/gZsxMo5H9efH8mGdI/NjvJ/L3yDmd3jG2B/q9AITzUz9WQkrfi1K3Ghlqs9KZFH1RW60MtVnJbio+iI3WqPUlzJ/sRuthEAEPtc8LTVZJXyu6YlKnHAbFCm6fFrydE9fSkvTXyhd+f0+f8pKuyATRi66KDMM3YR2TEpf/rWZI4UltGJSGvNaMUsqS2jFpHTmtWKWlJbcipKDY7bUFghc3iey//btDxPzm1XEZ5vgqMaSGc7uwvIpzlM+Q47DLSiV5Py+f4Ysl3ZRpoxkdGHmGMcJLZmW6PzrM0umS2jHtFTntWOeXJfQjmnJzmvHPNkuuR1FB8l8+S4QxLzX8f306tX3f5+Y8pxCPtuk56ssmfbcjiyf+ID6GVJfqBWlkh+6Bs+Q/lIvzpSxjS/QHEM7qTXTkiC6TrOkwaS2TEuEoC3zpMKktkxLhqAt86TDjLYUHjTzpcRgcPM+Bf/yu6l3gVYRn21CpBpLpkO7C8snQ0/5DKkQt6BUIvT7/hnSYNpFmTKe0YWZYygntGRaAvSvzyzpL6Ed05Kf1455Ul9CO6YlPq8d86S95HYUHSTzpbxAEKMJ768/ffftNxMznl3GZ5vyPJElc57Ti+WTnq99hqwXaEOptAf6/xnyXuKFmTKm4cWZY0SntGVa6gPXaJbcl9KSacnPb8k82S+lJdPSn9+SefJfekvKDpb5MmAooHnfxv72n29++OfLH6dub6HlfLapEAotmQ69Hi2fEnEbZkiLkbaUSo2B6/EM6THjQk0Z9cGLNcewT23TtFQZuGazpMvUFk1LmbhF86TN1BZNS524RfOkz7wWlR9M86XRWABEqfQfP339twKZ1Crms06kVGfpPGp35zxp1GvBTFkUt6RkEvWvxTPl0LSLNHXUows114hPaNH0BOpfr9nyZ0J7pqdPrz3zZc+E9kxPnl575sudye0pPojmzZyBoEcTZ/vx+H/89O2/JiZOUsxnmziRzpKJk3Zn+cQJWzBD4gy3pFTixNfiGRJn+kWaMuZDF2qOAZ/YommJE1+vWRJnYnumJU7YnnkSZ2J7piVO2J55EmdWe4oPovkSZyTo0cT5t2//56+vJmZNu4zPNmV6IkvmS6cXyydLX/sMmTLQhlJpEvT/M+TIxAszZWzDizPHqE5py7TUCK7RLHkxpSXTkqLfknkyYkpLpqVDvyXz5ML0lpQdLPNlwVBA81Lgy6kbeJ5K+HzT38vZNu9Y/TdD6ns5+8YdqL9Y2qP9/hxJL+WCTBrF/kWZZQAPtmNiuqPXZp5kN9iKianu5XNs1BluxcQ09/I5NumktqLk4JgxwcHA5T+n+L//+/KfEzOcU8hnm+R8lWWfU7Q7co7nFD31szyniFtR7jlF/xo8y3OKaRdn2iNX6ALN87xVQmumPqfoX6eZnlNMaMvU5xS9tsz1nGJCW6Y+p+i1Za7nFJPbUnjQzPmcYiC40aT4jX6B6cSs6Jby2aZFILNkXiR9WT6lQP3PkFOCDSuV8VHDZkj5ye2YMs4DbZljlKe1Z1p6hJ6bJT+mtWZagkStmSdDprVmWopErZknR+a0pvTgmS9Lhls18BLvvwc+0UzTaPzF3gOlJL/sO1VN/FoMqclXO3hBhoSXmgiUaNqEicLE6qdPJMq0v/xEo1zHjJyIFOmY6ROV+fohIxaX6osCgXqm/siaCJUZMyUmSjP1RtZEqkhvFJlozdQbWROxIr1RZKI2a288d/AoNtEr2CsDE8FXH3b795/ypn3OOcmTvLwvhbl1TPhWmNvAUhOysLwJ0yxY6PTJU0xr+SnRUCNGTnQijZg+fcnVnBFX4roLhIos7VkTiJhvSkwLspRnJfuI8iIpPEt5VmKOKC+SbkcoL2P2YqlxsAUDCS//W9Hzfye60Dei5/g+9Azfhp7lu9DP+U3oWb4HPeO3oGf7DvTM34Ce6/vP8377ea7vPs/7zee5vvc877ee5/zO8/zfeB71fefHw7Z5OH/59Waz27aFR3OYPviNOTg5fXmlw66ipUeqCfUFbc3EtBVVlJ+yiLoXQKaTrnbbKfK6s2dQdelmTN9O0qbLKKiQL1Y1U9xz3Devvr/pvHw6pqr85tX3RVw3MOj6j7KnDbr+4PRBR0uPXidTeqSaoeab+goNOqho/KCjxU0ddFherqVTVV3Pzenv7c8J2toy9rqMGRQe1+fzb4fT9q/r84cpKk05H3Q5ZZR64aE/JDE80JLHhQcgKxoeWiSfFBraA5PDglNq7Pp0pQaKHmhqV0eZMOCqGD38b8UUyWpE1KhsNqjo4/rhmjbeiRxzYsneGbhvDvTLeboK8LHcPCntGZ+Hg29Kpru464aiTn4SB92cfDeSo3SEw59k+i6fRWOu861+hAtF09Wh72tmamxP+UzGxE1KgUHR9UTZUfEkr/CwiGkdMy6ehJYcGNEezR0ZVl+WGhpUH/4UX6ZOfdJnMj4sMQVGSN8fZceILbHwKInrHTNObLElR8pAz+aOFadPS40WXyP6Slem0vaUz2Ss3KQUGCldT5QdJ0/yCo+SmNYxY+RJaMkREu3R3PFh9WWp0UH1wQ/6ZMrszvlMRseTlgLDQ3dG2fFhCSw8QKJqx4wQS2rJIRLv1dwxYvdnqUHiKQx+8yNT7O28z2S0uHoKjJinjik7aojQwiNnUPWY0UMklxxBw72cO4po/5YaSVBp6LX/IzS3p31GY+kmp9BQ6nql/Eh6kjnDQIppHjuOngSXHkbRHh4ziqy+LTmIqM7QG8AzFZvTPpMx5MgpMIZuvVJ2DLkyC4+hIc1jxpAruOQYGuzh3DFE+rbUGEI64cuAM+V253wmo+dJS4Ghozuj7LixBBYeNFG1Y0aMJbXkcIn3au5Ysfuz1EDxFIL3hebKfPm5rA4YJSXGx8vSKwM3caXHRljpqJHxcoY1gVhvZo+Kl6XXA4g6/IrB7LXv9qTPZFxYYorwl64/SvOXJ4nF+UtM7zj+8iS2LH+J9mw+f7H6tBx/oRoDbx/LFPtN9jM+c46YbyY91uN12jfxR3rWx2P2gHEUro/HsTu3hrSNHM+OvMIDekDxmBHtyC05pId6N3dMu/1aalD7Kulm0/awtI2mt1JHbTAlo9mToYXmqnHOmi4quuM19B6CpF2woZMnvzYqyWbB2jNkDXRlUF+ZCD6uBaMjfHZ1Ezfsj2xeZm4o1qp2s35i5hjZsraGP6p12+bjbtO8OvzSzDm6vtDVXPpqnqedNOyGTkmLwdlKRgXplGZFA7d+ij4pTOtDk4MyKTlmkr7kYAUDndDXVCaY+lpGB0qnqIlBEMjKDAFJavapTyoBPdlPKCUpyginQNOIUJmkat0/MZg2kwXC7AKma6OhSx+QFqicMkcFIV9ONOQkPziZ9dBk8gOTXanjHpQs+JCkq2J0iLkVMzG8EDmZQ2ZQRXJYITqyQ8qgkne70/mS/DwmkdOdXF7Tw3q8pPbc8op253/utrv9+1HeOZ/MuQUV6dWUtHBLBD2dWtLRgYnXKIV2YWdS2DTNNDGkPzp7K21USog+Lvv46+Xy5Xe/Xi5/Oez3zSa4TtAe98Y9LjkdfPePV69A8fZFQcW7pw23GzVlXIJIVJOcKYAyUl7I2u2Zf3nYhd76kSq0PW5jiplDZz9S3jbbV4fjboNHXqrap8IuprBCmp2Xz9yq6SSXUXzpi5pFb7Pfftecz+v3ODsli23228dbOaWU4qjidi0MKN0h6bHEKxR2gS40VnyosbrwiXEDVZ8fLUgpIV88ri8b/LKIuB5zXjkl+iVKI6TcTpympeJMWtOUcTb5ImMMR7Q44+HcnNo1tKe323zTtC+6O+B7L3P0G3p0dJRU/h2xOe/NxV3/eXfdd+N3qLpAOcOjKdzeNL1X+wZytNpr0o1litbA1Wwv/I/6f+IX0jow9Rqem8v1GJiYBXrErgWcntEVdsOwOpPwfmz258PpnCWNnFtUV7Pf/ni47revDq+SPO/2GTm5tLK/7d5/uIxV5pw8WVnA0f+veXs+bH5p0mxNj0719m6/u+zWD7vfmx+704e6wquHFpDRHV4LocLmcXcx8eAn94WQqRr9Iiap/Pn+brffNv++++o/dx+b07mNB1/d8Rfixeru/u7drnnYnu++em2WdzaHx0c93d8eNtfu58/9Yf/qolt7sD76y8Xd/evFfbV4wSr+88/3r83J3R+6fzBlPP1LdyK7u3/N0InMO5E5J/K7+9ccnci9E7lzori7fy3QicI7UTgnyrv71xKdKL0TpXOiurt/rdCJyjtROSdWd/evq3u5esFq5ZxYeSdWzon13f3r+l6qF3K1dE6svRNr58Tl3f3rJZK69E5cOieu7u5fr9CJK+/ElWuA1g8Meof55mHEPSzUQwz4xzUQa23B2L1SLxZKuCf7HmKuiVhrDcbhyb6PmGsk1tqDQQ8y30vMNRNrLcLkvahfSNpm30/MNRRrbcKgF5nvKeaaitXBzvZtxVxfsdYtrIL95VuLud5irWNYDU/27cVcf/FFsGbu+4u7/uJBf3HfX5wEqM5fcDBxEKNcf/HOX3BAcd9f3PUXbx3D4ZDivr+46y/eOobDkMx9f3HXX7x1DOf3nL9QpL98e3HXXrx1DIejgvv+4q6/eOsYDqMz9/3FXX/x1jEcjgru+4u7/hKtY3gFE4rvL+H6S7BQfwnfX8L1l+gyYH0v5YtFVbsn+/4SJAm2juHLe169kMuVezLIg66/ROev1b1gL6Qksn1/CddfonWMWNwL/oJzUrPvL+H6S7SWEQye7BtMuAYTrWUEh232DSZcg4nWMkLANvsGE67BRGsZAd0pfIMJ12CytYyA7pS+waRrMNl6RkB3St9h0nWYbD0jYNyVvsOk6zDZzbOW8GTfYZJMtVrPiBU8Gcy2XIfJ1jMShj/pO0y6DpPBCCZ9g0nXYLK1jIShU/oGk67BZGsZCWe00jeYdA0mV8FxIX2DSddgahEMJMo3mHINplgwkCjfYMo1mOLBQKJ8gynXYEoEA4nyDaZcgykZjAXKN5gi83kVjAUKTOldg6nWMxKmOeU7TLkOU53DYCBRvsOU6zC1DFlb+QZTrsHUKuwR32DKNVi1CHqk8g1WuQarWNAjlW+wyjVYxYMeqXyDVa7BKhEcVJVvsMo1WBU2WOUbrHINVoUNVvkGq8hNY2cwmC8qcN/oGqzqDAbzReUbrHINVgUNVvkGq1yDVauwR3yDVa7B6kXQI7VvsNo1WM2C1q59g9WuweqwwWrfYLVrsDpssNo3WO0arA4brPYNVrsGq8MGq32D1a7B6s5gNfJI7RusJisTncHgXVENFidcg9VdjoR3RbXvsNp1WN16RsFpQe07rHYdtmw9o2BqX/oOW7oOWwZn+UvfYEvXYMvWMgpOC5a+wZauwZatZRTMNUvfYEvXYMvWMgrmmqVvsKVrsKUKDqqlb7Cla7BlFYwFS99gS9dgyzoYC5a+wZZk+WsZHM5LsALmGmwZnoQtfYMtXYOtFsHhvPINtnINtmLB4bzyHbZyHbbqHAbzxcp32Mp12KpzGMwXK99hK9dhKxkaFyvfYCvXYKuwwVa+wVauwVZhg618g61cg63CBlv5Blu5BluFDbbyDbYia6xhg63AMitdZw07TP/NPd36t/78sMn03+j5ZLl10fkMpg39N3o+WXFddFaDmUP/jZ5PFl0XQbfpP9HTybLrImw4/Td6Pll5XYQ9p/9GzyeLr4uw7fTf6PlkAXYRdp7+Gz2frMEuwubTf6PnE/uxiP3QQr+30h+xH1zsJ/brFvAVnDswtN5PF/y7NfxqAReh0ZI/XfNnYfuhRX+66t8t5FeYlKF1f7rw363lV3AewdDSP13714v/4l6oF2olyfnAfnT9v1vSD9gfEQCKALpV/YB9EQQgFIB1C/sB+wIOwAgIYN3ifsC+gAUwAgNYt75fSdh/AAcwwgNYt8RfKXw+sB9BAqxb5a9gomYACjBCBVi30F9hBgO4ACNggIXJAANogBE2wLrl/goHf0AHGMEDrFvxr/DoB4CAEULAukX/GlNKwAgYgQSsW/cPDB+ACRjhBEyEl9kYQAWMsAImwvepDNACRnABE+FbVQaAASPEgInw3SoDzIARaMA6DhAYPgAbMMINWIcCAsMHkANG0AHraECNwy+AB4zQA9YBgRqHX8APGAEIrGMCePgAgsAIQmAyYj8AERihCExG7Ac4AiMggcmI/QBKYIQlMBmxH6AJjOAEJiP2A0CBEaLAZMR+gCkwAhWYjNgPcAVGwALrWEEd2DEA7EfYAutwQQ3v5RmgC4zgBSbD9gN8gRHAwFTEfgAxMMIYWAQyMEAZGMEMTEXsB0ADI6SBqYj9AGtgBDawCG1gADcwwhuYitgPEAdGkANTEfsB6MAIdWAdSKjxthHAHRgBDyxMHhhAD4ywB9bhhJB9gP0IfmAR/sAAgGCEQLAOKgTsAxgEIxCCaQqB7QMwBCMcgmkQge0DSAQjKIJ1dCFgHwAjGKERrAMMAfsAHsEIkGAdY6jx3BMgCUaYBOswA7YPgBKMUAnWkYaAfQCYYIRMsAiaYIBNMAInWMcbAvYBeIIRPsE65BCwDyAUjCAKphkFtg+AFIxQCtaBh4B9AKdgBFSwjj0E7ANQBSOsgnX4ocYLR4BWMIIrWB2+9QC8ghFgwerInS9AFowwC1ZH7nwBtWAEW7A6cucLwAUj5IItI3e+gF0wAi/YMnLnC/gFIwCDLSN3vgBhMMIw2DJy5wsoBiMYg3Vkosa3jgBkMEIymEYZ0D4AZTDCMliHJwL2ATSDEZzBNM/A9gFAgxGiwSJIgwGmwQjUYBGqwQDWYIRrsAjYYIBsMII2WEcrAvYBcIMRusE6YBGwD+AbjAAO1jGLGq8cAMTBCONgYcjBAOVgBHOwjlwE7ANAByOkg0VQBwOsgxHYwTp+EbAPwB2M8A6mgQe2DyAejCAPpplHwD5o8y/d/bsI2ocD6sEJ9eAdxcD24YB6cEI9eEcxlngvLqAenFAP3lEMvKMWQA9OoAfvKAa2DwfUgxPqwTX1gPbhgHpwQj14RzGwfTigHpxQD95RDGwfDqgHJ9SDa+oB7cMB9eCEevCOYoTsA/YGE+rBO4oRsA+gHpxQD95RjCXejQ2oByfUg3cUA9sHQA9OoAfX0APbB0APTqAH19AD2wdQD06oB2fhzcIcUA9OqAdn4f3CHFAPTqgHZ+EtwxxQD06oB+8oRsA+gHpwQj14RzFC9gH2o88+dBRjiR+TQk8/0McfeHDnCkcPQHhPQPCwfeAzEMR+PLxLnaPHIOhzEB3ECNgHPQlBH4XoIEbAPuhhCPo0REcxAvZBD0TQJyI09cD2Qc9E0IciNPXA9kGPRdDnIjqKscSPZKAnIwj14PrZCGgfAD04gR68gxgB+wDowQn04PoJCWwfAD04gR5chHcYcwA9OIEeXEMPbB8APTiBHlw/KoHtA6AHJ9CDa+iB7QOgByfQg3cQI2AfAD04gR68gxhL/FAOgB6cQA8ehh4cQA9OoAePQA8OoAcn0INHoAcH0IMT6MEj0IMD6MEJ9OAR6MEB9OAEevAI9OAAenACPXgEenAAPTiBHjwCPTiAHpxAD95BjCV+LAtAD06gB+8gxhI/+QegByfQg4ehBwfQgxPowTuIsYTLVhxAD06gB1fhZT8OoAcn0IOrSPIF0IMT6MFVJPkC6MEJ9OAqknwB9OAEenAViX4AenACPbiKRD8APTiBHlxFoh+AHpxAD95RjCV+/hNQD06oB+8oxhI+A8UB9eCEevAqnHwB9OAEevAqknwB9OAEevAqknwB9OAEevAqknwB9OAEevAqknwB9OAEevAqYj8APTiBHryK2A9AD06gB68i9gPUgxPqwTuKscILD4B6cEI9eEcxVvDxeA6oByfUg9dh+wHowQn04HXEfgB6cAI9eB2xH4AenEAPXkfsB6AHJ9CD1xH7AejBCfTgdcR+AHpwAj14HbEfoB6cUA9eR+wHqAcn1IN3FGOF7zwB9eCEevCOYqwCT4MD+xHqwTuKsQo8EA78R6gH7yjGCk8+APXghHrwjmIEhg+gHpxQD66pB9xvxwH14IR68I5iBCY/gHpwQj14hzEC2QdgD06wB+8wxgoyXw6wByfYg3cYY4VnTwB7cII9eIcxVjj7AuzBCfbgHcZY4RcwAOzBCfbgK/1aExx/AffghHvwjmOwBV76A+CDE/DBO5DBFngIAvLBCfngHclgCzwGAfrgBH3wjmWwBR6EAH5wAj94BzPYIvBmBuBCQj94RzPYAtsQ4A9O8AfvcAbe9c0B/uAEf/AOZ7AF9jHgH5zwD97xDLbARgYAhBMAIhbaiNDJAhAQQQiI6IgGw2/oEQCBCIJAxEK/aAc6WQAGIggDER3UYAw6WQAKIggFER3VYPiNOwJgEEEwiOiwBmPyXtYvWEXeHQE4iCAcRCyCexAEwCCCYBDRYQ3G1L2QLxSjDQAvryAcRCzCmxAE4CCCcBDRcY3AKz8ABxGEgwj9lidWwQYAECIICBFMu7DGBaCXpRAXsvAuGAFQiCAoRHRoI/ACEIBCBEEhQr/0Cb8PSAAWIggLESzmQQBDBIEhgoU9CFiIICxEsJgHAQwRBIaIyCMgAsAQQWCIYBEPAhgiCAwRPOZBQEMEoSGCxzwIeIggPETwiAcBDxGEhwge8SDgIYLwEMG1B3EuAEBEECAieMyDgIgIQkRE+DEQAYCIIEBE8JgHARERhIgIHvEgICKCEBHBIx4ERETQl0WJmAfR+6LoC6NEzIPopVH0rVEi4kH03ijvxVERD8JXRxEPdpCD4beTCfT6KPr+qI5yMPyGMoFeIUXfISXCHkQvkaJvkRLhDVkCvUeKvkiqoxwhD6N3SdGXSYmIB9HrpAgXETLmQQBGBAEjQsY8CMiIIGREyIgHARkRhIwIGfEgICOCkBEhtQfxhBKgEUHQiJDBPYECkBFByIiQ4U1ZApARQciIkLEwCNCIIGhEdKgj9AY3YEGCRkTHOoIWAh4kcESoRcRCgI4IQkeECu9KFYCOCEJHhH4kBFsI0BFB6IhQ+gWg+JYC4BFB8IhQwX2BAtARQeiIUOGNWQLQEUHoiOhoR8hCAI8IgkeECj+PLgAeEQSPCLWMWAjwEUH4iFCrmIWABwkgEVV4Z6oAhEQQQiKq8BPpAhASQQiJ6IgHwy+tFACRCIJIRBXcGygAIRGEkIgqvDlLAEIiCCERlYpYCCASQRCJ6JBHwEIAkQiCSERVRywEGIkgjERUy4iFACQRBJKIKrw7VQBIIggkEfrREGwhQEkEoSSiox4Mv7pUAEwiCCYRdXB/oACURBBKIurIa0QBJRGEkohaRiwEMIkgmER02CNgIYBJBMEkoq4iFgKcRBBOIuo6YiEASgQBJaIO71AVAJQIAkqEfjwkYCFgQQJKRAc+WOAFtoCUCEJKRPjtVgKAEkFAiViGQZ0AoEQQUCKWImIhQEoEISViGXmbLSAlgpASsVQRCwFUIggqEcsqYiHASgRhJWIZebEtYCWCsBKxjL3bFr3clliwYx+Mw0VuAWCJILBErIKsWABUIggqEavwRi0BSIkgpERoUhKwECAlgpAS0YGPgIUAKBEElAgNSgIWAqBEEFAiNCgJWAiAEkFAiViFd6oKwEkE4SRCPyaCLQQ4iSCcRGhOwvHqKOAkgnASsQpu1hKAkghCSeQi/IiwBJBEEkgie0gCLSQBJJEEkshF+FW4EjASSRiJ7BkJtJAEjEQSRiJ7RgItJAEjkYSRyEV4x4IEiEQSRCL1oyLQQhIwEkkYidSMhMPFTQkYiSSMRC6CT6lLgEgkQSRyEX5MWAJEIgkikT0iwRYCiEQSRCJZ+E25EhASSQiJ7D+IgS0EEIkkiETqj2IELAQYiSSMRLLwjlUJEIkkiESy8GtNJSAkkhASqT+PIfCrwwEjkYSRSBZ8Ul0CQiIJIZERQiIBIZGEkEj9oYyQhYAHCSKRPPwiXQkIiSSERPaEBFsIEBJJCInUH80IWAggEkkQieThdyVIgEgkQSRSPzKCLQQIiSSERGpCIvBL4AEhkYSQyDAhkYCQSEJIJA+vTksASCQBJJJHVqclICSSEBIZISQSEBJJCImMERIJCIkkhETGCIkEhEQSQiIjhEQCQiIJIZERQiIBIZGEkEhNSAT+FAAgJJIQEimCq9MS8BFJ+IgU4dVpCQCJJIBEisjqtASERBJCIkV4dVoCQCIJIJEisjotASGR9IsbMrI6LdFHN+hXN2R4dVqi727QD2/I8Oq0RJ/eoN/e6IAHE3B1WqLPb3jf3wiuTkv4AQ7iQBlZGpToIxz0KxwRQiLRhzjolzhkeHVaom9x0I9xyMjqtETf46Af5JCR1WmJvslBCIlU4dVpCQCJJIBEqvDqtASARBJAIjvgwfBHayQgJJIQEqkJSeDDNYCQSEJIZJiQSEBIJCEkUsU8CBCJJIhEqogHASGRhJDICCGRgJBIQkhkjJBIQEgkISQyRkgkICSSEBIZISQSEBJJCImMEBIJCIkkhERqQhL4fBEgJJIQElmJ8H4VCRiJJIxEVmEPAkQiCSKRMUQiASKRBJHIKuJBgEgkQSSyingQEBJJCImsYh4EhEQSQiKrmAcBIpEEkcg64kGASCRBJLKOeBAQEkkIiay1B+HipgSMRBJGIuuYBwEkkQSSyDrsQYBIJEEkso55EDASSRiJrCMeBIhEEkQi64gHASGRhJDIOuZBgEgkQSSyjnkQMBJJGIlcRjwIEIkkiEQuIx4EjEQSRiKX2oNwdVQCSCIJJJEakgi8NgYgiSSQRC7DHgSMxPq3/nQV+iCtBIREEkIiNSGRC/TRUwkIiSSERHbEgwU+zQYQiSSIRHbIg4U+zwY8SBiJ1IwEf/dLAkYiCSORYUYiASORhJHIjnngKwAQiSSIRHbEI/ApQEBIJCEkUj9Lgr9cJgEikQSRSI1I8GetJEAkkiASqREJ/rSVBIhEEkQi9bMk8JO/EiASSRCJXIXXBgEhkYSQSE1IAmMAEBJJCInUT5LI+l4sXzAaxQAjkYSRKP0kCfzysAKMRBFGojQjwd9+UoCRKMJI1CK4WUEBRKIIIlEakeAeVACRKIJIlEYkuAcVQCSKIBKlHyMJ9KBvQUUQiVroOAjDuAKMRBFGohZBDypASBQhJGoR8aACjEQRRqIWEQ8qAEkUgSSKRTwIGIkijETpx0jwV8AUgCSKQBIVfqGWAohEEUSiWMyDAJEogkgUi3kQMBJFGImKfD9cAUaiCCNR/SfEYSpVgJEowkhUmJEowEgUYSSKxTwIIIkikESxmAcBJFEEkige8SCAJIpAEqUhCf6mmwKQRBFIonjYgwCRKIJIFI95EDASRRiJ4jEPAkiiCCRRPOJBwEgUYSSKaw/ij6gCSqIIJVE87EEASRSBJIrHPAggiSKQRPGYBwElUYSSKBHxIIAkikASpSEJ/rqfApBEEUiiRNiDgJEowkiUiHkQQBJFIIkSMQ8CSKIIJFEi4kFASRShJEpoD8IJqQKYRBFMokTYgwCSKAJJlIh5EFASRSiJEjEPAkqiCCVRMuJBAEkUgSRKP0aCPx6oACVRhJIoGfYggCSKQBIlYx4EkEQRSKJkzIMAkyiCSZSMeBBQEkUoiZLag3BtSgFMoggmUTLsQUBJFKEkSsY8CCiJIpREyZgHASVR9NPlKuJB9PFy+vVypT2I70nQB8zpF8xV2IPoE+b0G+Yq5kH0GXP6HXMV8yD6lLn3LfOIB+HXzIkH9YMk+MN6Cn3RnH7SXIU9iL5pTj9q3lMSdFuu0HfN6YfNNSQJXQFgQQJJVLWIXAFASRShJKpi4SsAKIkilERpSlLhexpASRShJEpTEvxxQQUoiSKURHXYg+GvCyrASRThJEpzkgpP6AAnUYSTqCq4a0YBTKIIJlEd9oCrYwpQEkUoidKUpJLQhICSKEJJlKYkcHlNAUiiCCRRHfRgFZ6MAEqiCCVR+kES/H1ABTCJIphEaUxS4VQEMIkimETVwYeZFIAkikAS1VEPfAUBJFEEkigNSaolvAIAkigCSZR+kCRgAUBJFKEkSj9Igj9RqAAmUQSTKI1J8DcKFcAkimASpTEJ/sidAphEEUyi9KMk+Ct3CnASRTiJCj9KogAmUQSTqI56YA8ASKIIJFEakgQ8ACCJIpBEddRDBM4HJiSURHXYQ8B3bimASRTBJEpjEvyZOAUwiSKYRGlMgr8TpwAmUQSTKI1J8JfCFMAkimASpTEJ/laUAphEEUyi9Hu38NeCFAAlioASpd+7hb8XowAqUQSVqFV4RghIiSKkRGlSgj84ogApUYSUKE1K8CcnFCAlipASpUkJ/uiAAqREEVKiNCnBr51XAJUogkpUxz7YEhsZwBJFYInSsAS/eloBWKIILFHhx0kUQCWKoJJKoxL87uIKsJKKsJJKs5IlHAcVYCUVYSWVfukWfv1wBWhJRWhJpWkJfn9tBWhJRWhJpWnJEhq5ArSkIrSk0rQEv8K0ArikIrik0rhkBY1cAVxSEVxS6UdK8FssKwBMKgJMKg1M8GssKwBMKgJMKg1M8HssKwBMKgJMKg1M8IssK0BMKkJMKk1M8JscK0BMKkJMKv1YCX6VYwWYSUWYSaWZCX6XYwWYifm3n+/vdvuPzenSbL/db5t/3331+vXdmzeXT8fm7v4/d292+h+r+66eu6/+c1fdffWf/97fMdb/t9b/5d3///fe1Kr/1dTX/a0VsN5sdtv2H6zC2z0Xt+LbXRU5Ba236+OlOdnlcUutWOSVdtw5zV48ldR+rF63dFVnlbltLs3mcji9uXzY7d9/clq+tFreju1R5V7PbvvbcGCVqvJKvRycsiSzr01ey89OSZXV1nZinlSSf3UrYV+T3n1MX+f7u/arzPqHuv1Y9T+qpbGsOWtpzLxS/bXV16C1s7nanPc/RO94bqpo3wavf1TmT3XiKNhuz9e3581pd7zsDnu7ecpqXupQ2J2Op+Z8JuZt34t6K6p982liWb9e1w9eUdwuiqcVddw1p9PBHZq2pERjHo+7rSPGKoP1V6BdsUoq7Hr54A0XKWyLr7IKAgaV1uiTiW00pZHwU9stNRZNdUVfpjeglSVvlRZy3q7PDWqptEd0ekluK2vLW+033ZOKuV4uhz0paLW0zLVMLej3371+b1+Ga9m9Sipp8+CGO6bsLNRHHGECVvvSPf1D9FGpff+U/qH6qNS+C0b/qPuoJJZ9VBKr3vjtM9L6B1uYH328a5860z9EX7KUfYHtNn79w1TRbmhNauWBe50l7M5KM+fmsD9fTtc2fTnhwQ4zphdMA/v/V32rTDRf9n9f9X3ETAhnzPwwRTFhUoE0P0xp7QeR++RgDl4qkxxMTliYnGDCDucm8Jv8w00V3FTRfjSiTw79j/bNtX3TzI9bY4X5YS5V+1Kr3g3m2tfcuIEZN5iSV+baL8y1N4aTpor2UbbeDdK4wfyozA9juHaTqv5hqpCrvsB261j/w/zLLRqbSpVJnsrYvYXc/Q/zL9L8ixkASt2iuvmXylz8WhgX9G1XZiSoVVrk3pya9aVxh6o9YTTjqH2zaX9NzA95+7EyF8cMXmMfYewjjH2EsY809pGmn6SxjzRVSGOf9lmp/uKYH8bw7dbt9IZu185c2wqROaXsm9/sCcvl8EvjzlqsgbtMmx7ogs+bD83j2r0aCztwpk1bdGGerGVtTzfSbgV0UXSSILk9R0gqaLu+uA1z8pwZTWnJpS3rzXp3etNN9JxS7Qmj4mOKo/nYmqezxHjuFvhhvd8+kEkWty6FSJxk3Uptp6Ruo+2Zh0jziFMaafPS8hxfpBnYKQ822Rps7btYkgvVsxu3wZZAxTIaDGdKtRXwWJXhGV0abKx1RdqX8GUU2c7A3MZaHdduJsgsi15bSxlPnF9apaHGCjsaiLQ5dFfk5sCbX6+7j25zlW3mjKthSqMNtm+ycrxiyoPX116jWaRN9rtCt8279fXBXfBR9lKAymhxXxi8JvZdnMwIW+8edkf3DslWt8hQ15ZER5p1bVniPdKtLHgdrGa270tNLvD90c0b0h5kiWnWFEQbaY0wlpEd26JgG63hJWTG8PpwfSRrBfbERCWuUT4VRdtpdRlb5uqCLbVnnsu0CUpX4kND2mmlVyUzPPvQ0FYu7fs5npGpHxrYRmGvICYu+ujydu8/kLhR2a3MuJpdUbSd9s0mz+n7tjDYUnvlh2VchEvz6IYgxex0n1kSda29ipR4m38rC5rWXtlIXPFsC0QrSDZYSI+OdE3LXqdXGZMP2Dqr64VI7K63oCRnxnu7V+7/29/m1f0NoLlZNOvQLHHVHiVXZs/EFuYulJkf/Lb0Y+5B6sQsouuC/W/btUot7qFx78PtWdXT6oD+r1mZMAsTZjmCLcwPc9/OzE01E2b9xyx0MFMaM21nZi2FmfUEdivZrKVws5bCb6zLrKVws5bCTRXcrKxxs7LG69slMOs2ZlVEGFsIswYilFnSMatG7euQ+5UFs9awNGsNK7OkY66yNEte7Su7+gUFs9YgzVqD8aA0VUizMCVTM1B36d6sH5ybMnsCZhY1TW+YzjB9sTK9bZYvmeGJwtwaC9OE9usYfS+ZH2aBSBjwIm5ra7XprqXpLrNgJc2ymzRjoX0xWd9LprvMhZDqtuxofpixKpeJIa/jcxr6IexZ2esBqTG+K7NDBahEm4yw1AjycbfxV06YnTT6LlVV4mTgdDiCdZ2FvTyfuFjXPO4upqXX45Yu3Nkr/hVLizvvdqfzpTvJ9q5VkLwtMabN8MCsf2WvOyVC07aY4+F8OZ4Om+Z8dhfG7VuSxOW/982+Oe02JFTbt5qJxTgWc9Y0TEf1A8PEExOxDF01YYotbnsHzKq7WdxnJjoxUxgzpTFTHDMBkJkAyEzJ3ARAbgIgN9GDmwDITRVcmT9V5k+3FXUT6oVRKAxEESYjCQMihAluwiQnYVanxdIUaAKdNHmqfaVpH4XMeq5ZG5dm8V+aKqRBQdIsgMs6LVC8by40Ptt38CY1mkBqgpwJo6aHTexkN4Bl5AsTFQQ3P8zatTBr18Ks3wsjX9ySoQELYmVCr+EJ0qQCaVbgpalCmrwiDSuQpgppVuBl4taC983l7ac2ktJY4Ox4SC6r+ff68fjgFLSyb6TqtIDn31yvbBa5TLv6ejbq7jSxZ9qJt/u6mD6QeCy/su/6zZSGmRkRMwCLmWHCzDBhZpgwM0yYGSbcDBNufMbNMOFmmHAzTLipgpthwo3PeOIwQXf57QdprUSVNiVylx2s8G9caWb40jRVGcMqM6dVieRkt99dduuH3e/N+bD5xY3PzE49FUss8HA8nJxi7KlcWhHn026727935xA2mki07sMaZGd77fHWWWn5y1/faL+Va13fxGLAAkL71V6roLTZwuP6svngjkxlj8w0uz222Oa900n2AjxPmyL0pdDNfszeYZXYql8vl83DjsxHmY2SVCJK6oo67PfNhm6NYvb6m0rc0NQW17cT3KPbi6CJeaMt8HI47jbuRbSBVCLroTZvH6uw9tMoY/S0ftsfLrt3u8267bXQ5jJmb55TVZr1QwWD5Rx72SrxXjJYOlmss7OgmV/wxBl6qA5vGcOeHdfT9MP1QXvrVeLafah8dzHfxgwqcevTcX0+/3Y4OYlLWN2cuL5qivmwPrtxzd4dJhMHP81D9hJtYgFnN5HZq3lmDt1PLcwikJmOLPt/Nws/zMxBmJmIMnPLw8xNIjM3E8zcTDCzTsCW5ixTMFsZ45rpNDc7gPhte5+ZmnNTBTe3RNxMoHid5vvj1e0Le2OFiS59JUa9uRMyqydGMTN3RszM+5m5sWJmzYSZuwlmbieYuZ9gZlmGmYKZubXg5q6Qm2UZbpZluOlubqrgZgWPm4vHE1cvT822OT4cPqENJ7ZHEuH/qXl3as4f0DKHfZuVmM5PhyuJpCt7jpK44HRu9ttunnI5gK3mdokVS9PVlgimGsxGJypxC0tblh3MnLxhhYrEmN4Wdz5c2xiOGivtOVXarde52Z8PJ2u+4F5Wa06U2nm/Xpt2lv7m8bBt3P0r9l4gsUhz8Lm5XI+R2dGK221Om8ycd+/3O6cYew7CeHopVwdg2Xv9WeJsVJfSbVkmO6ecvJnY+afNl/0E5fxl7FkR515gRNHhfeDC5jAjig5tunamcPnFhkicHR5GFtuaExVt3w6PKDpnAmoN08QVF6eqfrUeFGx1T+LzD07BAY/Y2J4lpp6u3OPuy8AzS/beGpa4AHArMvAcgr1djCfG575ItOHfxhQiMcT0xXXuJcU5t6t5xfWrdnTJzZ52Ji63mxJT72fsuJMpupstOPP/lXPvnxEhjztjeSLPZjWJz9aYAoGB7AfSeJVTnJNVrFLS29g9arCmD6NZlkkuqfVea+cv+3u7p8SCbvbsVRSR+GhfoJZ+VMJabB6TuFiDa2n/D9Zgz2czBr9fQ3DHhX1fkribEteQdTNu356q9Djp16pHEKzDvp1O3JeC6whdf2ElEFmPqMGfmy5seJm4lOUX+TQ4XL02aE1c74aFwwf5nE3645V7O/ftbUoyccUYFZy2RmffXFUjhkNfGbgtshO5Sty5hYr2et5O6Spj4tXOGL+Mrfja2xoTUYxTLliptefPiY9yt0Wem1O7U+LJ1+b5a7d0e0dC6o2dXXoruv8f9+6O2QWnz6JvBf/WvNW4CJZu08HELeNt6S06cBKrHVSTS7leduThSSvn8MROvKwv1/PmsHWhiINg0wrS4/Jts+284+qynxNRicTnVqBeYCANFfZlTQxZpkBgbnscpgYqKxCd2jWLM9l0a82VEn0Xe1TMftjuxnbTRjbY3LqynZL4WBEKjHacSUyj4XtFq4WJ6954Em63zewY5YncU5dICUdt+zfxzkaXRPbVOw+5L28L62bbn3nUUZllY8Vum4XMv5gdOspssVG3DUW37YO3vVgG+SizYK1UzsUmtMSGdYnbs3wf27dIiY7xx6tN6xPv/8mdjL0Lwyzqm10UyuyLUmZ3rLodY5iG4jcUYP7lBgfMA6/K7LRQtw3MZleHqtKyBdi9Z+8xFLf9n2b7rjB7w4TZuCVM5cIMBmGeiRXmlR7CeFGYrdTSPA8ubw9dms0q8vZsuWmoNGxImiqk2X4mE6c1uqHksVtrJCeW4s2w7Flh4i1+aNHJXuJNnKOgm3r7MbPqFp7STIzeTGE/lagSY3lbDglN9r4kZQyiEhce0YYw5x7LWCdxEfDj+mHX+uHtYetkHBs1MxMJmSGUzGwAZGZnEzM7qJnZLcTMuyCYeQKem83U3Ix2bmAdNzGWm22M3FTBzQ46bjYk8cSdEKZtzf7jx/Vpt37rbjmzb+sT1w0+rh+uboyw146lAbPKDGllCK0y+z7VbbMyv21xNP9y2/RoNiqq22YiM+yV4YuqShtiH5vT7t0nLznYeZalcIWf7++Ou2PzsNs3d1+9/vm///3/4ae+rzV4AgA="; \ No newline at end of file diff --git a/api/assets/style.css b/api/assets/style.css new file mode 100644 index 0000000..7f80f3d --- /dev/null +++ b/api/assets/style.css @@ -0,0 +1,1610 @@ +@layer typedoc { + :root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: #9f5f30; + --light-color-ts-method: #be3989; + --light-color-ts-reference: #ff4d82; + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var( + --light-color-ts-constructor + ); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: #c73c3c; + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-color-alert-note: #0969d9; + --light-color-alert-tip: #1a7f37; + --light-color-alert-important: #8250df; + --light-color-alert-warning: #9a6700; + --light-color-alert-caution: #cf222e; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: #ff6060; + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-color-alert-note: #0969d9; + --dark-color-alert-tip: #1a7f37; + --dark-color-alert-important: #8250df; + --dark-color-alert-warning: #9a6700; + --dark-color-alert-caution: #cf222e; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; + } + + @media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var( + --light-color-background-secondary + ); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + + --color-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-alert-note: var(--light-color-alert-note); + --color-alert-tip: var(--light-color-alert-tip); + --color-alert-important: var(--light-color-alert-important); + --color-alert-warning: var(--light-color-alert-warning); + --color-alert-caution: var(--light-color-alert-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + } + + @media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var( + --dark-color-background-secondary + ); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + + --color-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-alert-note: var(--dark-color-alert-note); + --color-alert-tip: var(--dark-color-alert-tip); + --color-alert-important: var(--dark-color-alert-important); + --color-alert-warning: var(--dark-color-alert-warning); + --color-alert-caution: var(--dark-color-alert-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + } + + html { + color-scheme: var(--color-scheme); + } + + body { + margin: 0; + } + + :root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-note: var(--light-color-note); + --color-tip: var(--light-color-tip); + --color-important: var(--light-color-important); + --color-warning: var(--light-color-warning); + --color-caution: var(--light-color-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + + :root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-note: var(--dark-color-note); + --color-tip: var(--dark-color-tip); + --color-important: var(--dark-color-important); + --color-warning: var(--dark-color-warning); + --color-caution: var(--dark-color-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + + *:focus-visible, + .tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); + } + + .always-visible, + .always-visible .tsd-signatures { + display: inherit !important; + } + + h1, + h2, + h3, + h4, + h5, + h6 { + line-height: 1.2; + } + + h1 { + font-size: 1.875rem; + margin: 0.67rem 0; + } + + h2 { + font-size: 1.5rem; + margin: 0.83rem 0; + } + + h3 { + font-size: 1.25rem; + margin: 1rem 0; + } + + h4 { + font-size: 1.05rem; + margin: 1.33rem 0; + } + + h5 { + font-size: 1rem; + margin: 1.5rem 0; + } + + h6 { + font-size: 0.875rem; + margin: 2.33rem 0; + } + + dl, + menu, + ol, + ul { + margin: 1em 0; + } + + dd { + margin: 0 0 0 34px; + } + + .container { + max-width: 1700px; + padding: 0 2rem; + } + + /* Footer */ + footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; + } + footer > p { + margin: 0 1em; + } + + .container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); + } + + @keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } + } + @keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } + } + @keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } + } + @keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } + } + @keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } + } + @keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } + } + body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); + } + + a { + color: var(--color-link); + text-decoration: none; + } + a:hover { + text-decoration: underline; + } + a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; + } + a.tsd-anchor-link { + color: var(--color-text); + } + + code, + pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; + } + + pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); + margin-bottom: 8px; + } + pre code { + padding: 0; + font-size: 100%; + } + pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; + } + pre:hover > button, + pre > button.visible { + opacity: 1; + } + + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; + } + + .tsd-typography { + line-height: 1.333em; + } + .tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; + } + .tsd-typography .tsd-index-panel h3, + .tsd-index-panel .tsd-typography h3, + .tsd-typography h4, + .tsd-typography h5, + .tsd-typography h6 { + font-size: 1em; + } + .tsd-typography h5, + .tsd-typography h6 { + font-weight: normal; + } + .tsd-typography p, + .tsd-typography ul, + .tsd-typography ol { + margin: 1em 0; + } + .tsd-typography table { + border-collapse: collapse; + border: none; + } + .tsd-typography td, + .tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); + } + .tsd-typography thead, + .tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); + } + + .tsd-alert { + padding: 8px 16px; + margin-bottom: 16px; + border-left: 0.25em solid var(--alert-color); + } + .tsd-alert blockquote > :last-child, + .tsd-alert > :last-child { + margin-bottom: 0; + } + .tsd-alert-title { + color: var(--alert-color); + display: inline-flex; + align-items: center; + } + .tsd-alert-title span { + margin-left: 4px; + } + + .tsd-alert-note { + --alert-color: var(--color-alert-note); + } + .tsd-alert-tip { + --alert-color: var(--color-alert-tip); + } + .tsd-alert-important { + --alert-color: var(--color-alert-important); + } + .tsd-alert-warning { + --alert-color: var(--color-alert-warning); + } + .tsd-alert-caution { + --alert-color: var(--color-alert-caution); + } + + .tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); + } + .tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; + } + .tsd-breadcrumb a:hover { + text-decoration: underline; + } + .tsd-breadcrumb li { + display: inline; + } + .tsd-breadcrumb li:after { + content: " / "; + } + + .tsd-comment-tags { + display: flex; + flex-direction: column; + } + dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; + } + dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; + } + dl.tsd-comment-tag-group dd { + margin: 0; + } + code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; + } + h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; + } + + dl.tsd-comment-tag-group dd:before, + dl.tsd-comment-tag-group dd:after { + content: " "; + } + dl.tsd-comment-tag-group dd pre, + dl.tsd-comment-tag-group dd:after { + clear: both; + } + dl.tsd-comment-tag-group p { + margin: 0; + } + + .tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; + } + .tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; + } + + .tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; + } + .tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; + } + .tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + } + .tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; + } + .tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; + } + .tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; + } + .tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); + } + .tsd-checkbox-background { + fill: var(--color-accent); + } + input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); + } + + .settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; + } + + .tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; + } + + .tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; + } + + .tsd-hierarchy h4 label:hover span { + text-decoration: underline; + } + + .tsd-hierarchy { + list-style: square; + margin: 0; + } + .tsd-hierarchy-target { + font-weight: bold; + } + .tsd-hierarchy-toggle { + color: var(--color-link); + cursor: pointer; + } + + .tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); + } + .tsd-full-hierarchy, + .tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; + } + .tsd-full-hierarchy ul { + padding-left: 1.5rem; + } + .tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-full-hierarchy svg[data-dropdown] { + cursor: pointer; + } + .tsd-full-hierarchy svg[data-dropdown="false"] { + transform: rotate(-90deg); + } + .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul { + display: none; + } + + .tsd-panel-group.tsd-index-group { + margin-bottom: 0; + } + .tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; + } + @media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } + } + @media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } + } + .tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; + } + + .tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; + } + + .tsd-anchor { + position: relative; + top: -100px; + } + + .tsd-member { + position: relative; + } + .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; + } + + .tsd-navigation.settings { + margin: 1rem 0; + } + .tsd-navigation > a, + .tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; + } + .tsd-navigation a, + .tsd-navigation summary > span, + .tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; + } + .tsd-navigation a.current, + .tsd-page-navigation a.current { + background: var(--color-active-menu-item); + } + .tsd-navigation a:hover, + .tsd-page-navigation a:hover { + text-decoration: underline; + } + .tsd-navigation ul, + .tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; + } + .tsd-navigation li, + .tsd-page-navigation li { + padding: 0; + max-width: 100%; + } + .tsd-navigation .tsd-nav-link { + display: none; + } + .tsd-nested-navigation { + margin-left: 3rem; + } + .tsd-nested-navigation > li > details { + margin-left: -1.5rem; + } + .tsd-small-nested-navigation { + margin-left: 1.5rem; + } + .tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; + } + + .tsd-page-navigation-section { + margin-left: 10px; + } + .tsd-page-navigation-section > summary { + padding: 0.25rem; + } + .tsd-page-navigation-section > div { + margin-left: 20px; + } + .tsd-page-navigation ul { + padding-left: 1.75rem; + } + + #tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; + } + #tsd-sidebar-links a:last-of-type { + margin-bottom: 0; + } + + a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ + } + .tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ + } + .tsd-accordion-summary, + .tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; + } + .tsd-accordion-summary a { + width: calc(100% - 1.5rem); + } + .tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; + } + .tsd-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; + vertical-align: text-top; + } + /* + We need to be careful to target the arrow indicating whether the accordion + is open, but not any other SVGs included in the details element. +*/ + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h1 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h2 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h3 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h4 > svg:first-child { + transform: rotate(-90deg); + } + .tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; + } + .tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; + } + + .tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + .tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; + } + .tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; + } + + .tsd-panel { + margin-bottom: 2.5rem; + } + .tsd-panel.tsd-member { + margin-bottom: 4rem; + } + .tsd-panel:empty { + display: none; + } + .tsd-panel > h1, + .tsd-panel > h2, + .tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; + } + .tsd-panel > h1.tsd-before-signature, + .tsd-panel > h2.tsd-before-signature, + .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; + } + + .tsd-panel-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group details { + margin: 2rem 0; + } + .tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; + } + + #tsd-search { + transition: background-color 0.2s; + } + #tsd-search .title { + position: relative; + z-index: 2; + } + #tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; + } + #tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); + } + #tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; + } + #tsd-search .field input, + #tsd-search .title, + #tsd-toolbar-links a { + transition: opacity 0.2s; + } + #tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + #tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; + } + #tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); + } + #tsd-search .results li.state { + display: none; + } + #tsd-search .results li.current:not(.no-results), + #tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); + } + #tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; + } + #tsd-search .results a:before { + top: 10px; + } + #tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; + } + #tsd-search.has-focus { + background-color: var(--color-accent); + } + #tsd-search.has-focus .field input { + top: 0; + opacity: 1; + } + #tsd-search.has-focus .title, + #tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; + } + #tsd-search.has-focus .results { + visibility: visible; + } + #tsd-search.loading .results li.state.loading { + display: block; + } + #tsd-search.failure .results li.state.failure { + display: block; + } + + #tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; + } + #tsd-toolbar-links a { + margin-left: 1.5rem; + } + #tsd-toolbar-links a:hover { + text-decoration: underline; + } + + .tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; + } + + .tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; + } + + .tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; + } + + .tsd-signature-type { + font-style: italic; + font-weight: normal; + } + + .tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; + } + .tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; + } + .tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; + } + .tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; + } + .tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; + } + + ul.tsd-parameter-list, + ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; + } + ul.tsd-parameter-list > li.tsd-parameter-signature, + ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; + } + ul.tsd-parameter-list h5, + ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; + } + .tsd-sources { + margin-top: 1rem; + font-size: 0.875em; + } + .tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; + } + .tsd-sources ul { + list-style: none; + padding: 0; + } + + .tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; + } + .tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; + } + .tsd-page-toolbar a.title { + font-weight: bold; + } + .tsd-page-toolbar a.title:hover { + text-decoration: underline; + } + .tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; + } + .tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; + } + .tsd-page-toolbar .table-cell:first-child { + width: 100%; + } + .tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; + } + + .tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; + } + .tsd-widget:hover { + opacity: 0.9; + } + .tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); + } + .tsd-widget.no-caption { + width: 40px; + } + .tsd-widget.no-caption:before { + margin: 0; + } + + .tsd-widget.options, + .tsd-widget.menu { + display: none; + } + input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; + } + input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; + } + + img { + max-width: 100%; + } + + .tsd-member-summary-name { + display: inline-flex; + align-items: center; + padding: 0.25rem; + text-decoration: none; + } + + .tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + color: var(--color-text); + } + + .tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; + } + + .tsd-member-summary-name:hover > .tsd-anchor-icon svg, + .tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; + } + + .deprecated { + text-decoration: line-through !important; + } + + .warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); + } + + .tsd-kind-project { + color: var(--color-ts-project); + } + .tsd-kind-module { + color: var(--color-ts-module); + } + .tsd-kind-namespace { + color: var(--color-ts-namespace); + } + .tsd-kind-enum { + color: var(--color-ts-enum); + } + .tsd-kind-enum-member { + color: var(--color-ts-enum-member); + } + .tsd-kind-variable { + color: var(--color-ts-variable); + } + .tsd-kind-function { + color: var(--color-ts-function); + } + .tsd-kind-class { + color: var(--color-ts-class); + } + .tsd-kind-interface { + color: var(--color-ts-interface); + } + .tsd-kind-constructor { + color: var(--color-ts-constructor); + } + .tsd-kind-property { + color: var(--color-ts-property); + } + .tsd-kind-method { + color: var(--color-ts-method); + } + .tsd-kind-reference { + color: var(--color-ts-reference); + } + .tsd-kind-call-signature { + color: var(--color-ts-call-signature); + } + .tsd-kind-index-signature { + color: var(--color-ts-index-signature); + } + .tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); + } + .tsd-kind-parameter { + color: var(--color-ts-parameter); + } + .tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); + } + .tsd-kind-accessor { + color: var(--color-ts-accessor); + } + .tsd-kind-get-signature { + color: var(--color-ts-get-signature); + } + .tsd-kind-set-signature { + color: var(--color-ts-set-signature); + } + .tsd-kind-type-alias { + color: var(--color-ts-type-alias); + } + + /* if we have a kind icon, don't color the text by kind */ + .tsd-kind-icon ~ span { + color: var(--color-text); + } + + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); + } + + *::-webkit-scrollbar { + width: 0.75rem; + } + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); + } + + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); + } + + /* mobile */ + @media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } + } + + /* one sidebar */ + @media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } + } + @media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } + } + + /* two sidebars */ + @media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax( + 0, + 20rem + ); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } + } +} diff --git a/api/classes/src_adapters_AccidentAdapter.AccidentAdapter.html b/api/classes/src_adapters_AccidentAdapter.AccidentAdapter.html new file mode 100644 index 0000000..17d7924 --- /dev/null +++ b/api/classes/src_adapters_AccidentAdapter.AccidentAdapter.html @@ -0,0 +1,22 @@ +AccidentAdapter | orange-api

Class AccidentAdapter

Implementation of the AccidentAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

dbHandler +

Methods

delete +delete_all +get +get_all +post +put +

Constructors

constructor

Properties

ProtecteddbHandler

dbHandler: default

Methods

delete

delete_all

get

get_all

  • get_all(query?: any): Promise<any[]>

  • Processing and adapting of a get_all request

    +

    Parameters

    • query: any = {}

      The query provided in the url. +Default is empty dictionary

      +

    Returns Promise<any[]>

post

put

  • put(id: number, data: any): Promise<any>

  • Processing and adapting of a put request

    +

    Parameters

    • id: number

      The id of the object to update

      +
    • data: any

      The data to update the object with

      +

    Returns Promise<any>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_adapters_AuthUserAdapter.AuthUserAdapter.html b/api/classes/src_adapters_AuthUserAdapter.AuthUserAdapter.html new file mode 100644 index 0000000..96321b6 --- /dev/null +++ b/api/classes/src_adapters_AuthUserAdapter.AuthUserAdapter.html @@ -0,0 +1,30 @@ +AuthUserAdapter | orange-api

Class AuthUserAdapter

Implementation of the AuthUserAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

dbHandler +

Methods

createUser +delete +delete_all +get +get_all +getByUsername +post +put +

Constructors

constructor

Properties

ProtecteddbHandler

dbHandler: default

Methods

createUser

delete

delete_all

get

get_all

getByUsername

  • getByUsername(username: string): Promise<AuthUserDTO>

  • Get a AuthUser by its Username.

    +

    Parameters

    • username: string

      username of the user

      +

    Returns Promise<AuthUserDTO>

    returns the AuthUserDTO or undefined if no user with this username exists. The username should be unique.

    +

post

put

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_adapters_BaseAdapter.BaseAdapter.html b/api/classes/src_adapters_BaseAdapter.BaseAdapter.html new file mode 100644 index 0000000..6a30a12 --- /dev/null +++ b/api/classes/src_adapters_BaseAdapter.BaseAdapter.html @@ -0,0 +1,25 @@ +BaseAdapter | orange-api

Class BaseAdapter<DataType, DbHandler>Abstract

BaseAdapter +Basic abstract implementation of a Adapter between Api and Database

+

Type Parameters

Hierarchy (View Summary)

Constructors

constructor +

Properties

dbHandler +

Methods

delete +delete_all +get +get_all +post +put +

Constructors

Protectedconstructor

Properties

ProtecteddbHandler

dbHandler: DbHandler

Methods

delete

  • delete(id: number): Promise<void>

  • Processing and adapting of a delete request

    +

    Parameters

    • id: number

      The id of the object to be deleted

      +

    Returns Promise<void>

delete_all

get

get_all

  • get_all(query?: any): Promise<DataType[]>

  • Processing and adapting of a get_all request

    +

    Parameters

    • query: any = {}

      The query provided in the url. +Default is empty dictionary

      +

    Returns Promise<DataType[]>

post

put

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_adapters_DataAdapter.DataAdapter.html b/api/classes/src_adapters_DataAdapter.DataAdapter.html new file mode 100644 index 0000000..fd24318 --- /dev/null +++ b/api/classes/src_adapters_DataAdapter.DataAdapter.html @@ -0,0 +1,26 @@ +DataAdapter | orange-api

Class DataAdapter

Implementation of the UserAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

dbHandler +

Methods

delete +delete_all +get +get_all +post +put +

Constructors

constructor

Properties

ProtecteddbHandler

dbHandler: DataHandler

Methods

delete

delete_all

get

get_all

  • get_all(query?: any): Promise<DataDTO[]>

  • Processing and adapting of a get_all request +This specific implementation rewrites the query

    +

    Parameters

    • query: any = {}

      The query provided in the url. +Default is empty dictionary

      +

    Returns Promise<DataDTO[]>

post

put

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_adapters_NotificationSubscriptionAdapter.NotificationSubscriptionAdapter.html b/api/classes/src_adapters_NotificationSubscriptionAdapter.NotificationSubscriptionAdapter.html new file mode 100644 index 0000000..38ae81c --- /dev/null +++ b/api/classes/src_adapters_NotificationSubscriptionAdapter.NotificationSubscriptionAdapter.html @@ -0,0 +1,34 @@ +NotificationSubscriptionAdapter | orange-api

Class NotificationSubscriptionAdapter

Implementation of the NotificationSubscriptionAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

dbHandler +

Methods

addSubscription +createNewSubscriptionToken +delete +delete_all +get +get_all +post +put +sendNotification +

Constructors

constructor

Properties

ProtecteddbHandler

dbHandler: NotificationSubscriptionHandler

Methods

addSubscription

createNewSubscriptionToken

delete

delete_all

get

get_all

post

put

sendNotification

  • sendNotification(
        userId: number,
        messageTitle: string,
        messageBody: string,
    ): Promise<void>

  • Sends a notification to all devices, which have subscribed to the provided User

    +

    Parameters

    • userId: number

      User whose subscribers should receive the notification

      +
    • messageTitle: string

      title of the notification

      +
    • messageBody: string

      body of the notification

      +

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_adapters_ThingyAdapter.ThingyAdapter.html b/api/classes/src_adapters_ThingyAdapter.ThingyAdapter.html new file mode 100644 index 0000000..a9e39a7 --- /dev/null +++ b/api/classes/src_adapters_ThingyAdapter.ThingyAdapter.html @@ -0,0 +1,22 @@ +ThingyAdapter | orange-api

Class ThingyAdapter

Implementation of the ThingyAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

dbHandler +

Methods

delete +delete_all +get +get_all +post +put +

Constructors

constructor

Properties

ProtecteddbHandler

dbHandler: default

Methods

delete

delete_all

get

get_all

  • get_all(query?: any): Promise<any[]>

  • Processing and adapting of a get_all request

    +

    Parameters

    • query: any = {}

      The query provided in the url. +Default is empty dictionary

      +

    Returns Promise<any[]>

post

put

  • put(id: number, data: any): Promise<any>

  • Processing and adapting of a put request

    +

    Parameters

    • id: number

      The id of the object to update

      +
    • data: any

      The data to update the object with

      +

    Returns Promise<any>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_adapters_UserAdapter.UserAdapter.html b/api/classes/src_adapters_UserAdapter.UserAdapter.html new file mode 100644 index 0000000..62a7cb2 --- /dev/null +++ b/api/classes/src_adapters_UserAdapter.UserAdapter.html @@ -0,0 +1,22 @@ +UserAdapter | orange-api

Class UserAdapter

Implementation of the UserAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

dbHandler +

Methods

delete +delete_all +get +get_all +post +put +

Constructors

constructor

Properties

ProtecteddbHandler

dbHandler: default

Methods

delete

delete_all

get

get_all

post

put

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_AccidentApi.AccidentApi.html b/api/classes/src_api_AccidentApi.AccidentApi.html new file mode 100644 index 0000000..05f11b8 --- /dev/null +++ b/api/classes/src_api_AccidentApi.AccidentApi.html @@ -0,0 +1,31 @@ +AccidentApi | orange-api

Class AccidentApi

Class for the AccidentDetectionApi

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +detectThingyAccident +detectUserAccident +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: AccidentAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

detectThingyAccident

  • detectThingyAccident(ctx: Context): Promise<void>

  • Checks if a thingy had an accident

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

detectUserAccident

  • detectUserAccident(ctx: Context): Promise<void>

  • Checks if a user (one of its thingys had an accident

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_AuthUserApi.AuthUserApi.html b/api/classes/src_api_AuthUserApi.AuthUserApi.html new file mode 100644 index 0000000..e413c7b --- /dev/null +++ b/api/classes/src_api_AuthUserApi.AuthUserApi.html @@ -0,0 +1,38 @@ +AuthUserApi | orange-api

Class AuthUserApi

Abstract for a Base Api that defines the basic properties

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +signIn +signUp +validateBody +verifyToken +

Constructors

constructor

Properties

Protectedadapter

adapter: AuthUserAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

signIn

  • signIn(ctx: Context): Promise<void>

  • Get a token for authentication

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

signUp

  • signUp(ctx: Context): Promise<void>

  • Endpoint to register a new user. +The token in the body can be used for authentication

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

verifyToken

  • verifyToken(ctx: Context, next: () => Promise<any>): Promise<void>

  • Verifies the token specified in the header. +Expected Header: key: Bearer, value: +The userId and the username are stored in the context for later use in the regular endpoint handlers: ctx.state.user

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • next: () => Promise<any>

      next method to call

      +

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_BaseApi.BaseApi.html b/api/classes/src_api_BaseApi.BaseApi.html new file mode 100644 index 0000000..e041a0e --- /dev/null +++ b/api/classes/src_api_BaseApi.BaseApi.html @@ -0,0 +1,26 @@ +BaseApi | orange-api

Class BaseApi<DataType, DbHandler, Adapter>Abstract

Abstract for a Base Api that defines the basic properties

+

Type Parameters

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

Protectedconstructor

Properties

Protectedadapter

adapter: Adapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_Air_PressApi.html b/api/classes/src_api_DataApi.Data_Air_PressApi.html new file mode 100644 index 0000000..e8fa902 --- /dev/null +++ b/api/classes/src_api_DataApi.Data_Air_PressApi.html @@ -0,0 +1,25 @@ +Data_Air_PressApi | orange-api

Class Data_Air_PressApi

Implementation of the Air Pressure Api

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_Air_QualApi.html b/api/classes/src_api_DataApi.Data_Air_QualApi.html new file mode 100644 index 0000000..6c665e6 --- /dev/null +++ b/api/classes/src_api_DataApi.Data_Air_QualApi.html @@ -0,0 +1,25 @@ +Data_Air_QualApi | orange-api

Class Data_Air_QualApi

Implementation of the Air Quality Api

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_ButtonApi.html b/api/classes/src_api_DataApi.Data_ButtonApi.html new file mode 100644 index 0000000..a9ae1c9 --- /dev/null +++ b/api/classes/src_api_DataApi.Data_ButtonApi.html @@ -0,0 +1,25 @@ +Data_ButtonApi | orange-api

Class Data_ButtonApi

Implementation of the Button Api

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_BuzzerApi.html b/api/classes/src_api_DataApi.Data_BuzzerApi.html new file mode 100644 index 0000000..4728f4b --- /dev/null +++ b/api/classes/src_api_DataApi.Data_BuzzerApi.html @@ -0,0 +1,25 @@ +Data_BuzzerApi | orange-api

Class Data_BuzzerApi

Implementation of the BuzzerApi

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_CO2EquivApi.html b/api/classes/src_api_DataApi.Data_CO2EquivApi.html new file mode 100644 index 0000000..f4150f5 --- /dev/null +++ b/api/classes/src_api_DataApi.Data_CO2EquivApi.html @@ -0,0 +1,25 @@ +Data_CO2EquivApi | orange-api

Class Data_CO2EquivApi

Implementation of the Co2Api

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_FlipApi.html b/api/classes/src_api_DataApi.Data_FlipApi.html new file mode 100644 index 0000000..6366835 --- /dev/null +++ b/api/classes/src_api_DataApi.Data_FlipApi.html @@ -0,0 +1,25 @@ +Data_FlipApi | orange-api

Class Data_FlipApi

Implementation of the FlipApi

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_GPSApi.html b/api/classes/src_api_DataApi.Data_GPSApi.html new file mode 100644 index 0000000..fc286b2 --- /dev/null +++ b/api/classes/src_api_DataApi.Data_GPSApi.html @@ -0,0 +1,25 @@ +Data_GPSApi | orange-api

Class Data_GPSApi

Implementation of the GPSApi

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_HumidApi.html b/api/classes/src_api_DataApi.Data_HumidApi.html new file mode 100644 index 0000000..01edceb --- /dev/null +++ b/api/classes/src_api_DataApi.Data_HumidApi.html @@ -0,0 +1,25 @@ +Data_HumidApi | orange-api

Class Data_HumidApi

Implementation of the GPS Api

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_LedApi.html b/api/classes/src_api_DataApi.Data_LedApi.html new file mode 100644 index 0000000..13abd2f --- /dev/null +++ b/api/classes/src_api_DataApi.Data_LedApi.html @@ -0,0 +1,25 @@ +Data_LedApi | orange-api

Class Data_LedApi

Implementation of the LedApi

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_LightApi.html b/api/classes/src_api_DataApi.Data_LightApi.html new file mode 100644 index 0000000..d3da13f --- /dev/null +++ b/api/classes/src_api_DataApi.Data_LightApi.html @@ -0,0 +1,25 @@ +Data_LightApi | orange-api

Class Data_LightApi

Implementation of the LightApi

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_DataApi.Data_TempApi.html b/api/classes/src_api_DataApi.Data_TempApi.html new file mode 100644 index 0000000..691b234 --- /dev/null +++ b/api/classes/src_api_DataApi.Data_TempApi.html @@ -0,0 +1,25 @@ +Data_TempApi | orange-api

Class Data_TempApi

Implementation of the Temp Api

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: DataAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_NotificationSubscriptionApi.NotificationSubscriptionApi.html b/api/classes/src_api_NotificationSubscriptionApi.NotificationSubscriptionApi.html new file mode 100644 index 0000000..3cfce64 --- /dev/null +++ b/api/classes/src_api_NotificationSubscriptionApi.NotificationSubscriptionApi.html @@ -0,0 +1,31 @@ +NotificationSubscriptionApi | orange-api

Class NotificationSubscriptionApi

Abstract for a Base Api that defines the basic properties

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

createToken +delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: NotificationSubscriptionAdapter

Methods

createToken

  • createToken(ctx: Context): void

  • creates a token that the user can give to a friend so that the friend can subscribe for the notifications. +The request body remains empty, but it is a post request +as the response cannot be cached as a new token is generated each time (it's not idempotent)

    +

    Parameters

    • ctx: Context

      HTTP Context from koa +*

      +

    Returns void

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_ThingyApi.ThingyApi.html b/api/classes/src_api_ThingyApi.ThingyApi.html new file mode 100644 index 0000000..25825cd --- /dev/null +++ b/api/classes/src_api_ThingyApi.ThingyApi.html @@ -0,0 +1,25 @@ +ThingyApi | orange-api

Class ThingyApi

Abstract for a Base Api that defines the basic properties

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: ThingyAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_api_UserApi.UserApi.html b/api/classes/src_api_UserApi.UserApi.html new file mode 100644 index 0000000..9295912 --- /dev/null +++ b/api/classes/src_api_UserApi.UserApi.html @@ -0,0 +1,25 @@ +UserApi | orange-api

Class UserApi

Abstract for a Base Api that defines the basic properties

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

adapter +

Methods

delete +get +handleGenericError +post +put +validateBody +

Constructors

constructor

Properties

Protectedadapter

adapter: UserAdapter

Methods

delete

  • delete(ctx: Context): Promise<void>

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

get

  • get(ctx: Context): Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

handleGenericError

  • handleGenericError(ctx: Context, error: Error): void

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

post

  • post(ctx: Context): Promise<void>

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

put

  • put(ctx: Context): Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

validateBody

  • validateBody(ctx: Context, validationSchema: ObjectSchema): object

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_AccidentHandler.default.html b/api/classes/src_database_handlers_AccidentHandler.default.html new file mode 100644 index 0000000..e7c252f --- /dev/null +++ b/api/classes/src_database_handlers_AccidentHandler.default.html @@ -0,0 +1,23 @@ +default | orange-api

Class default

Base Handler class for interacting with an Object in the database

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_AuthUserHandler.default.html b/api/classes/src_database_handlers_AuthUserHandler.default.html new file mode 100644 index 0000000..be3f279 --- /dev/null +++ b/api/classes/src_database_handlers_AuthUserHandler.default.html @@ -0,0 +1,23 @@ +default | orange-api

Class default

Base Handler class for interacting with an Object in the database

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_BaseHandler.default.html b/api/classes/src_database_handlers_BaseHandler.default.html new file mode 100644 index 0000000..74c2af8 --- /dev/null +++ b/api/classes/src_database_handlers_BaseHandler.default.html @@ -0,0 +1,25 @@ +default | orange-api

Class default<T>

Base Handler class for interacting with an Object in the database

+

Type Parameters

  • T

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

  • delete(id: number): Promise<void>

  • Delete a single entry from the table in the database

    +

    Parameters

    • id: number

      The id (Primary Key) of the object

      +

    Returns Promise<void>

delete_all

get

  • get(id: number): Promise<T>

  • Get the json representation of the object out of the database

    +

    Parameters

    • id: number

      The primary key of the object

      +

    Returns Promise<T>

get_all

  • get_all(query?: any): Promise<T[]>

  • Get all objects of a given type

    +

    Parameters

    • query: any = {}

      The query provided for filtering. +Default is empty dictionary

      +

    Returns Promise<T[]>

update

  • update(id: number, data: T): Promise<T>

  • Update a given entry in the database with the provided data

    +

    Parameters

    • id: number

      The identifier of the object

      +
    • data: T

      The data to be updated

      +

    Returns Promise<T>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.DataHandler.html b/api/classes/src_database_handlers_DataHandler.DataHandler.html new file mode 100644 index 0000000..502b105 --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.DataHandler.html @@ -0,0 +1,22 @@ +DataHandler | orange-api

Class DataHandlerAbstract

abstract class for the DataHandler to be inherited by the child classes

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

Protectedconstructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_AIR_PRESSHandler.html b/api/classes/src_database_handlers_DataHandler.Data_AIR_PRESSHandler.html new file mode 100644 index 0000000..5f2498c --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_AIR_PRESSHandler.html @@ -0,0 +1,22 @@ +Data_AIR_PRESSHandler | orange-api

Class Data_AIR_PRESSHandler

Implementation of the Handler class for Data_AIR_PRESS

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_AIR_QUALHandler.html b/api/classes/src_database_handlers_DataHandler.Data_AIR_QUALHandler.html new file mode 100644 index 0000000..09ecb2d --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_AIR_QUALHandler.html @@ -0,0 +1,22 @@ +Data_AIR_QUALHandler | orange-api

Class Data_AIR_QUALHandler

Implementation of the Handler class for Data_AIR_QUAL

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_BUTTONHandler.html b/api/classes/src_database_handlers_DataHandler.Data_BUTTONHandler.html new file mode 100644 index 0000000..852a5e6 --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_BUTTONHandler.html @@ -0,0 +1,22 @@ +Data_BUTTONHandler | orange-api

Class Data_BUTTONHandler

Implementation of the Handler class for Data_BUTTON

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_BUZZERHandler.html b/api/classes/src_database_handlers_DataHandler.Data_BUZZERHandler.html new file mode 100644 index 0000000..c726b34 --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_BUZZERHandler.html @@ -0,0 +1,22 @@ +Data_BUZZERHandler | orange-api

Class Data_BUZZERHandler

Implementation of the Handler class for Data_BUZZER

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_CO2EQUIVHandler.html b/api/classes/src_database_handlers_DataHandler.Data_CO2EQUIVHandler.html new file mode 100644 index 0000000..22bfd6d --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_CO2EQUIVHandler.html @@ -0,0 +1,22 @@ +Data_CO2EQUIVHandler | orange-api

Class Data_CO2EQUIVHandler

Implementation of the Handler class for Data_CO2EQUIV

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_DefaultHandler.html b/api/classes/src_database_handlers_DataHandler.Data_DefaultHandler.html new file mode 100644 index 0000000..b7b7557 --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_DefaultHandler.html @@ -0,0 +1,23 @@ +Data_DefaultHandler | orange-api

Class Data_DefaultHandler

Implementation of the Handler class for unknown Data

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_FLIPHandler.html b/api/classes/src_database_handlers_DataHandler.Data_FLIPHandler.html new file mode 100644 index 0000000..5fe5e8c --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_FLIPHandler.html @@ -0,0 +1,22 @@ +Data_FLIPHandler | orange-api

Class Data_FLIPHandler

Implementation of the Handler class for Data_FLIP

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_GPSHandler.html b/api/classes/src_database_handlers_DataHandler.Data_GPSHandler.html new file mode 100644 index 0000000..4b14c24 --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_GPSHandler.html @@ -0,0 +1,22 @@ +Data_GPSHandler | orange-api

Class Data_GPSHandler

Implementation of the Handler class for Data_GPS

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_HUMIDHandler.html b/api/classes/src_database_handlers_DataHandler.Data_HUMIDHandler.html new file mode 100644 index 0000000..8a0a22b --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_HUMIDHandler.html @@ -0,0 +1,22 @@ +Data_HUMIDHandler | orange-api

Class Data_HUMIDHandler

Implementation of the Handler class for Data_HUMID

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_LEDHandler.html b/api/classes/src_database_handlers_DataHandler.Data_LEDHandler.html new file mode 100644 index 0000000..4110738 --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_LEDHandler.html @@ -0,0 +1,22 @@ +Data_LEDHandler | orange-api

Class Data_LEDHandler

Implementation of the Handler class for Data_LED

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_LIGHTHandler.html b/api/classes/src_database_handlers_DataHandler.Data_LIGHTHandler.html new file mode 100644 index 0000000..b82330d --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_LIGHTHandler.html @@ -0,0 +1,22 @@ +Data_LIGHTHandler | orange-api

Class Data_LIGHTHandler

Implementation of the Handler class for Data_LIGHT

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_DataHandler.Data_TEMPHandler.html b/api/classes/src_database_handlers_DataHandler.Data_TEMPHandler.html new file mode 100644 index 0000000..0f2f2b3 --- /dev/null +++ b/api/classes/src_database_handlers_DataHandler.Data_TEMPHandler.html @@ -0,0 +1,22 @@ +Data_TEMPHandler | orange-api

Class Data_TEMPHandler

Implementation of the Handler class for Data_TEMP

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_NotificationSubscriptionHandler.NotificationSubscriptionHandler.html b/api/classes/src_database_handlers_NotificationSubscriptionHandler.NotificationSubscriptionHandler.html new file mode 100644 index 0000000..706750f --- /dev/null +++ b/api/classes/src_database_handlers_NotificationSubscriptionHandler.NotificationSubscriptionHandler.html @@ -0,0 +1,23 @@ +NotificationSubscriptionHandler | orange-api

Class NotificationSubscriptionHandler

Base Handler class for interacting with an Object in the database

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_ThingyHandler.default.html b/api/classes/src_database_handlers_ThingyHandler.default.html new file mode 100644 index 0000000..556c3fc --- /dev/null +++ b/api/classes/src_database_handlers_ThingyHandler.default.html @@ -0,0 +1,23 @@ +default | orange-api

Class default

Base Handler class for interacting with an Object in the database

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_handlers_UserHandler.default.html b/api/classes/src_database_handlers_UserHandler.default.html new file mode 100644 index 0000000..a63e82b --- /dev/null +++ b/api/classes/src_database_handlers_UserHandler.default.html @@ -0,0 +1,23 @@ +default | orange-api

Class default

Base Handler class for interacting with an Object in the database

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

cls +

Methods

create +delete +delete_all +get +get_all +update +

Constructors

constructor

Properties

Protectedcls

cls: any

Methods

create

delete

delete_all

get

get_all

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_database_models_Accident.Accident.html b/api/classes/src_database_models_Accident.Accident.html new file mode 100644 index 0000000..0afb11a --- /dev/null +++ b/api/classes/src_database_models_Accident.Accident.html @@ -0,0 +1,5 @@ +Accident | orange-api

Class Accident

Definition of the accident Model in the database

+

Hierarchy

Constructors

constructor +

Properties

id +thingyId +

Constructors

constructor

  • new Accident(): Accident

  • Returns Accident

Properties

id

id: CreationOptional<number>

thingyId

thingyId: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_AuthUser.AuthUser.html b/api/classes/src_database_models_AuthUser.AuthUser.html new file mode 100644 index 0000000..f149618 --- /dev/null +++ b/api/classes/src_database_models_AuthUser.AuthUser.html @@ -0,0 +1,9 @@ +AuthUser | orange-api

Class AuthUser

Definition of the User used for authentication

+

Use of a separate user model so that the password hash is not leaked during normal user handling. +This model should therefore only be used for authentication purposes. +As soon as the user is authenticated, the “normal” user model is used.

+

Hierarchy

Constructors

constructor +

Properties

id +passwordHash +userName +

Constructors

constructor

  • new AuthUser(): AuthUser

  • Returns AuthUser

Properties

id

id: CreationOptional<number>

passwordHash

passwordHash: string

userName

userName: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data.html b/api/classes/src_database_models_Data.Data.html new file mode 100644 index 0000000..94c616b --- /dev/null +++ b/api/classes/src_database_models_Data.Data.html @@ -0,0 +1,6 @@ +Data | orange-api

Class DataAbstract

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

  • new Data(): Data

  • Returns Data

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_AIR_PRESS.html b/api/classes/src_database_models_Data.Data_AIR_PRESS.html new file mode 100644 index 0000000..0d57c2c --- /dev/null +++ b/api/classes/src_database_models_Data.Data_AIR_PRESS.html @@ -0,0 +1,6 @@ +Data_AIR_PRESS | orange-api

Class Data_AIR_PRESS

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_AIR_QUAL.html b/api/classes/src_database_models_Data.Data_AIR_QUAL.html new file mode 100644 index 0000000..df1e52e --- /dev/null +++ b/api/classes/src_database_models_Data.Data_AIR_QUAL.html @@ -0,0 +1,6 @@ +Data_AIR_QUAL | orange-api

Class Data_AIR_QUAL

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_BUTTON.html b/api/classes/src_database_models_Data.Data_BUTTON.html new file mode 100644 index 0000000..884e2dc --- /dev/null +++ b/api/classes/src_database_models_Data.Data_BUTTON.html @@ -0,0 +1,6 @@ +Data_BUTTON | orange-api

Class Data_BUTTON

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_BUZZER.html b/api/classes/src_database_models_Data.Data_BUZZER.html new file mode 100644 index 0000000..8d15bce --- /dev/null +++ b/api/classes/src_database_models_Data.Data_BUZZER.html @@ -0,0 +1,6 @@ +Data_BUZZER | orange-api

Class Data_BUZZER

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_CO2EQUIV.html b/api/classes/src_database_models_Data.Data_CO2EQUIV.html new file mode 100644 index 0000000..7937f74 --- /dev/null +++ b/api/classes/src_database_models_Data.Data_CO2EQUIV.html @@ -0,0 +1,6 @@ +Data_CO2EQUIV | orange-api

Class Data_CO2EQUIV

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_Default.html b/api/classes/src_database_models_Data.Data_Default.html new file mode 100644 index 0000000..99a9f1d --- /dev/null +++ b/api/classes/src_database_models_Data.Data_Default.html @@ -0,0 +1,7 @@ +Data_Default | orange-api

Class Data_Default

Data Model for unforeseen Datavalues not specified on https://exascaleinfolab.github.io/ase2024-docs/

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

appId +thingyId +ts +value +

Constructors

constructor

Properties

appId

appId: string

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_FLIP.html b/api/classes/src_database_models_Data.Data_FLIP.html new file mode 100644 index 0000000..23b7654 --- /dev/null +++ b/api/classes/src_database_models_Data.Data_FLIP.html @@ -0,0 +1,6 @@ +Data_FLIP | orange-api

Class Data_FLIP

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_GPS.html b/api/classes/src_database_models_Data.Data_GPS.html new file mode 100644 index 0000000..3b3b548 --- /dev/null +++ b/api/classes/src_database_models_Data.Data_GPS.html @@ -0,0 +1,7 @@ +Data_GPS | orange-api

Class Data_GPS

Definition of all the Event Types for Tables in the database +For more information see: https://exascaleinfolab.github.io/ase2024-docs/

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_HUMID.html b/api/classes/src_database_models_Data.Data_HUMID.html new file mode 100644 index 0000000..856486d --- /dev/null +++ b/api/classes/src_database_models_Data.Data_HUMID.html @@ -0,0 +1,6 @@ +Data_HUMID | orange-api

Class Data_HUMID

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_LED.html b/api/classes/src_database_models_Data.Data_LED.html new file mode 100644 index 0000000..316bcee --- /dev/null +++ b/api/classes/src_database_models_Data.Data_LED.html @@ -0,0 +1,6 @@ +Data_LED | orange-api

Class Data_LED

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_LIGHT.html b/api/classes/src_database_models_Data.Data_LIGHT.html new file mode 100644 index 0000000..8b83146 --- /dev/null +++ b/api/classes/src_database_models_Data.Data_LIGHT.html @@ -0,0 +1,6 @@ +Data_LIGHT | orange-api

Class Data_LIGHT

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Data.Data_TEMP.html b/api/classes/src_database_models_Data.Data_TEMP.html new file mode 100644 index 0000000..636f218 --- /dev/null +++ b/api/classes/src_database_models_Data.Data_TEMP.html @@ -0,0 +1,6 @@ +Data_TEMP | orange-api

Class Data_TEMP

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

constructor +

Properties

thingyId +ts +value +

Constructors

constructor

Properties

thingyId

thingyId: number

ts

ts: bigint

value

value: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_NotificationSubscription.NotificationSubscription.html b/api/classes/src_database_models_NotificationSubscription.NotificationSubscription.html new file mode 100644 index 0000000..574241e --- /dev/null +++ b/api/classes/src_database_models_NotificationSubscription.NotificationSubscription.html @@ -0,0 +1,5 @@ +NotificationSubscription | orange-api

Class NotificationSubscription

Hierarchy

Constructors

constructor +

Properties

deviceToken +id +userId +

Constructors

constructor

Properties

deviceToken

deviceToken: string

id

id: CreationOptional<number>

userId

userId: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_Thingy.Thingy.html b/api/classes/src_database_models_Thingy.Thingy.html new file mode 100644 index 0000000..717e455 --- /dev/null +++ b/api/classes/src_database_models_Thingy.Thingy.html @@ -0,0 +1,7 @@ +Thingy | orange-api

Class Thingy

Definition of the Thingy Model

+

Hierarchy

  • unknown<InferAttributes<Thingy>, InferCreationAttributes<Thingy>>
    • Thingy

Constructors

constructor +

Properties

accidents? +id +name +userId +

Constructors

constructor

  • new Thingy(): Thingy

  • Returns Thingy

Properties

Optionalaccidents

accidents?: NonAttribute<Accident[]>

id

id: CreationOptional<number>

name

name: string

userId

userId: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_database_models_User.User.html b/api/classes/src_database_models_User.User.html new file mode 100644 index 0000000..7fd7ab1 --- /dev/null +++ b/api/classes/src_database_models_User.User.html @@ -0,0 +1,10 @@ +User | orange-api

Class User

Definition of the User Model

+

Hierarchy

  • unknown<InferAttributes<User>, InferCreationAttributes<User>>
    • User

Constructors

constructor +

Properties

firstName +id +isRiding +lastName +name +notificationSubscriptions? +thingys? +

Constructors

constructor

  • new User(): User

  • Returns User

Properties

firstName

firstName: string

id

id: CreationOptional<number>

isRiding

isRiding: boolean

lastName

lastName: string

name

name: string

OptionalnotificationSubscriptions

notificationSubscriptions?: NonAttribute<NotificationSubscription[]>

Optionalthingys

thingys?: NonAttribute<Thingy[]>

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/src_mqtt_MqttConnection.MQTTConnection.html b/api/classes/src_mqtt_MqttConnection.MQTTConnection.html new file mode 100644 index 0000000..7b96c5b --- /dev/null +++ b/api/classes/src_mqtt_MqttConnection.MQTTConnection.html @@ -0,0 +1,12 @@ +MQTTConnection | orange-api

Class MQTTConnection

Constructors

constructor +

Properties

mqttClient +subscribedTopics +

Methods

sendMessage +subscribeTopic +

Constructors

constructor

Properties

ReadonlymqttClient

mqttClient: MqttClient

ReadonlysubscribedTopics

subscribedTopics: MqttTopic<any>[] = []

Methods

sendMessage

  • sendMessage(topic: string, message: string): void

  • Sends a message to a topic on the given mqtt connection

    +

    Parameters

    • topic: string

      the topic to send to

      +
    • message: string

      the message to send

      +

    Returns void

subscribeTopic

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/src_mqtt_MqttTopic.MqttTopic.html b/api/classes/src_mqtt_MqttTopic.MqttTopic.html new file mode 100644 index 0000000..822de92 --- /dev/null +++ b/api/classes/src_mqtt_MqttTopic.MqttTopic.html @@ -0,0 +1,9 @@ +MqttTopic | orange-api

Class MqttTopic<T>

Type Parameters

  • T

Constructors

constructor +

Accessors

topic +

Methods

handle +match +

Constructors

constructor

  • new MqttTopic<T>(
        topic: string,
        handler: (topic: string, message: T) => any,
        ...postProcessors: (prev: any, message: T) => any[],
    ): MqttTopic<T>

  • Type Parameters

    • T

    Parameters

    • topic: string
    • handler: (topic: string, message: T) => any
    • ...postProcessors: (prev: any, message: T) => any[]

    Returns MqttTopic<T>

Accessors

topic

Methods

handle

  • handle(topic: string, message: T): void

  • Calls the corresponding handler method

    +

    Parameters

    • topic: string
    • message: T

    Returns void

match

  • match(receivedTopic: string): boolean

  • Check if the topic matches

    +

    Parameters

    • receivedTopic: string

      Topic to check

      +

    Returns boolean

    boolean true if the topic match

    +

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/src_utils.ApiError.html b/api/classes/src_utils.ApiError.html new file mode 100644 index 0000000..01811a9 --- /dev/null +++ b/api/classes/src_utils.ApiError.html @@ -0,0 +1,4 @@ +ApiError | orange-api

Class ApiError

Constructors

constructor +

Properties

message +statusCode +

Constructors

constructor

Properties

Readonlymessage

message: string

ReadonlystatusCode

statusCode: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/functions/src_adapters_DataMqttAdapter.MqttMessageHandler.html b/api/functions/src_adapters_DataMqttAdapter.MqttMessageHandler.html new file mode 100644 index 0000000..128b2e4 --- /dev/null +++ b/api/functions/src_adapters_DataMqttAdapter.MqttMessageHandler.html @@ -0,0 +1,4 @@ +MqttMessageHandler | orange-api

Function MqttMessageHandler

Settings

Member Visibility
diff --git a/api/functions/src_adapters_DataMqttAdapter.flipPostProcessor.html b/api/functions/src_adapters_DataMqttAdapter.flipPostProcessor.html new file mode 100644 index 0000000..c1f302c --- /dev/null +++ b/api/functions/src_adapters_DataMqttAdapter.flipPostProcessor.html @@ -0,0 +1,3 @@ +flipPostProcessor | orange-api

Function flipPostProcessor

Settings

Member Visibility
diff --git a/api/functions/src_api_exampleApi.getExample.html b/api/functions/src_api_exampleApi.getExample.html new file mode 100644 index 0000000..50ee280 --- /dev/null +++ b/api/functions/src_api_exampleApi.getExample.html @@ -0,0 +1 @@ +getExample | orange-api

Function getExample

  • getExample(ctx: Context): Promise<void>

  • Parameters

    • ctx: Context

    Returns Promise<void>

Settings

Member Visibility
diff --git a/api/functions/src_database_Model.createSchema.html b/api/functions/src_database_Model.createSchema.html new file mode 100644 index 0000000..68da421 --- /dev/null +++ b/api/functions/src_database_Model.createSchema.html @@ -0,0 +1,3 @@ +createSchema | orange-api

Function createSchema

  • createSchema(sequelize: Sequelize): Promise<void>

  • Create the schema in the database

    +

    Parameters

    • sequelize: Sequelize

      The schema/model with database connection

      +

    Returns Promise<void>

Settings

Member Visibility
diff --git a/api/functions/src_database_Model.dropSchema.html b/api/functions/src_database_Model.dropSchema.html new file mode 100644 index 0000000..128212b --- /dev/null +++ b/api/functions/src_database_Model.dropSchema.html @@ -0,0 +1,3 @@ +dropSchema | orange-api

Function dropSchema

  • dropSchema(sequelize: Sequelize): Promise<void>

  • Dropping the sequelize schema in the database

    +

    Parameters

    • sequelize: Sequelize

      The schema/model with database connection

      +

    Returns Promise<void>

Settings

Member Visibility
diff --git a/api/functions/src_database_Model.redeploySchema.html b/api/functions/src_database_Model.redeploySchema.html new file mode 100644 index 0000000..aa7889c --- /dev/null +++ b/api/functions/src_database_Model.redeploySchema.html @@ -0,0 +1,3 @@ +redeploySchema | orange-api

Function redeploySchema

  • redeploySchema(sequelize: Sequelize): Promise<void>

  • Redeploy a schema in the database (drop and recreate)

    +

    Parameters

    • sequelize: Sequelize

      The sequelize schema with connection

      +

    Returns Promise<void>

Settings

Member Visibility
diff --git a/api/functions/src_database_Model.refreshSchema.html b/api/functions/src_database_Model.refreshSchema.html new file mode 100644 index 0000000..e3241dc --- /dev/null +++ b/api/functions/src_database_Model.refreshSchema.html @@ -0,0 +1,4 @@ +refreshSchema | orange-api

Function refreshSchema

  • refreshSchema(sequelize: Sequelize): Promise<void>

  • Function to refresh a schema +Creates it if it does not exist +Updates it if it exists

    +

    Parameters

    • sequelize: Sequelize

    Returns Promise<void>

Settings

Member Visibility
diff --git a/api/functions/src_services_AccidentDetector.accidentDetector_thingy.html b/api/functions/src_services_AccidentDetector.accidentDetector_thingy.html new file mode 100644 index 0000000..3a60023 --- /dev/null +++ b/api/functions/src_services_AccidentDetector.accidentDetector_thingy.html @@ -0,0 +1,3 @@ +accidentDetector_thingy | orange-api

Function accidentDetector_thingy

  • accidentDetector_thingy(thingyId: number): Promise<boolean>

  • Function to handle accidents if an accident has been detected

    +

    Parameters

    • thingyId: number

      The id of the thingy.

      +

    Returns Promise<boolean>

Settings

Member Visibility
diff --git a/api/functions/src_services_AccidentDetector.accidentDetector_user.html b/api/functions/src_services_AccidentDetector.accidentDetector_user.html new file mode 100644 index 0000000..dff39a4 --- /dev/null +++ b/api/functions/src_services_AccidentDetector.accidentDetector_user.html @@ -0,0 +1,3 @@ +accidentDetector_user | orange-api

Function accidentDetector_user

  • accidentDetector_user(userId: number): Promise<boolean>

  • Function to handle accident if a user (so the thingys of the user) has been involved in an accident

    +

    Parameters

    • userId: number

      The id of the user.

      +

    Returns Promise<boolean>

Settings

Member Visibility
diff --git a/api/functions/src_services_MqttService.sendLightToThingy.html b/api/functions/src_services_MqttService.sendLightToThingy.html new file mode 100644 index 0000000..b47b763 --- /dev/null +++ b/api/functions/src_services_MqttService.sendLightToThingy.html @@ -0,0 +1,4 @@ +sendLightToThingy | orange-api

Function sendLightToThingy

  • sendLightToThingy(deviceUuid: string, enable?: boolean): void

  • Function to make the thingy flash the light

    +

    Parameters

    • deviceUuid: string

      the identifier of the thingy.

      +
    • enable: boolean = true

      boolean to describe if it should be set or reset

      +

    Returns void

Settings

Member Visibility
diff --git a/api/functions/src_services_MqttService.sendSoundToThingy.html b/api/functions/src_services_MqttService.sendSoundToThingy.html new file mode 100644 index 0000000..2bbd545 --- /dev/null +++ b/api/functions/src_services_MqttService.sendSoundToThingy.html @@ -0,0 +1,4 @@ +sendSoundToThingy | orange-api

Function sendSoundToThingy

  • sendSoundToThingy(deviceUuid: string, enable?: boolean): void

  • Function to make the thingy beep

    +

    Parameters

    • deviceUuid: string

      the identifier of the thingy.

      +
    • enable: boolean = true

      boolean to describe if it should be set or reset

      +

    Returns void

Settings

Member Visibility
diff --git a/api/functions/src_services_MqttService.setupMqttConnection.html b/api/functions/src_services_MqttService.setupMqttConnection.html new file mode 100644 index 0000000..38eeb03 --- /dev/null +++ b/api/functions/src_services_MqttService.setupMqttConnection.html @@ -0,0 +1,2 @@ +setupMqttConnection | orange-api

Function setupMqttConnection

Settings

Member Visibility
diff --git a/api/functions/src_services_MqttService.subscribeSensors.html b/api/functions/src_services_MqttService.subscribeSensors.html new file mode 100644 index 0000000..e824a30 --- /dev/null +++ b/api/functions/src_services_MqttService.subscribeSensors.html @@ -0,0 +1,3 @@ +subscribeSensors | orange-api

Function subscribeSensors

  • subscribeSensors(deviceUuid: string): void

  • Subcribe to a specific device/Sensor

    +

    Parameters

    • deviceUuid: string

      the identifier of the Thingy

      +

    Returns void

Settings

Member Visibility
diff --git a/api/functions/src_services_WebsocketService.emitAccidentUpdate.html b/api/functions/src_services_WebsocketService.emitAccidentUpdate.html new file mode 100644 index 0000000..33f7df7 --- /dev/null +++ b/api/functions/src_services_WebsocketService.emitAccidentUpdate.html @@ -0,0 +1,2 @@ +emitAccidentUpdate | orange-api

Function emitAccidentUpdate

Emit the update to the websocket which is saved in the userSocketMap

+

Settings

Member Visibility
diff --git a/api/functions/src_services_WebsocketService.initializeSocket.html b/api/functions/src_services_WebsocketService.initializeSocket.html new file mode 100644 index 0000000..651d592 --- /dev/null +++ b/api/functions/src_services_WebsocketService.initializeSocket.html @@ -0,0 +1,2 @@ +initializeSocket | orange-api

Function initializeSocket

Initialize the websocket and listen for register

+

Settings

Member Visibility
diff --git a/api/functions/src_utils.validateEnvVariable.html b/api/functions/src_utils.validateEnvVariable.html new file mode 100644 index 0000000..bd06c75 --- /dev/null +++ b/api/functions/src_utils.validateEnvVariable.html @@ -0,0 +1 @@ +validateEnvVariable | orange-api

Function validateEnvVariable

  • validateEnvVariable(envVariableName: string): string | undefined

  • Parameters

    • envVariableName: string

    Returns string | undefined

Settings

Member Visibility
diff --git a/api/hierarchy.html b/api/hierarchy.html new file mode 100644 index 0000000..dd4d096 --- /dev/null +++ b/api/hierarchy.html @@ -0,0 +1 @@ +orange-api

orange-api

Hierarchy Summary

Settings

Member Visibility
diff --git a/api/index.html b/api/index.html new file mode 100644 index 0000000..532d0d9 --- /dev/null +++ b/api/index.html @@ -0,0 +1,74 @@ +orange-api

orange-api

API

Environment variables

To run this application, several environment variables are required. +Since these may include sensitive credentials, do not push your .env file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
environment Variablemandatorydefault Value
MQTT_USERNAMEtrueorange
MQTT_PASSWORDtrue< secret >
MQTT_PROTOCOLfalsemqtt
MQTT_HOSTtrue163.172.151.151
MQTT_PORTfalse1889
DATABASE_HOSTtruedocker: database, local: 127.0.0.1
DATABASE_PORTtrue5432
POSTGRES_PASSWORDtrue< secret >
POSTGRES_USERtrue< secret >
POSTGRES_DBtruethingyDB
API_CERT_KEYtrue< secret >
API_SALT_ROUNDSfalsee.g. 3
+

Settings

Member Visibility

On This Page

API
diff --git a/api/interfaces/src_adapters_AuthUserAdapter.SignUpUserData.html b/api/interfaces/src_adapters_AuthUserAdapter.SignUpUserData.html new file mode 100644 index 0000000..e26b354 --- /dev/null +++ b/api/interfaces/src_adapters_AuthUserAdapter.SignUpUserData.html @@ -0,0 +1,5 @@ +SignUpUserData | orange-api

Interface SignUpUserData

interface SignUpUserData {
    firstName: string;
    lastName: string;
    password: string;
    userName: string;
}

Properties

firstName +lastName +password +userName +

Properties

firstName

firstName: string

lastName

lastName: string

password

password: string

userName

userName: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/modules.html b/api/modules.html new file mode 100644 index 0000000..8f32277 --- /dev/null +++ b/api/modules.html @@ -0,0 +1 @@ +orange-api

orange-api

Modules

src/adapters/AccidentAdapter
src/adapters/AuthUserAdapter
src/adapters/BaseAdapter
src/adapters/DataAdapter
src/adapters/DataMqttAdapter
src/adapters/NotificationSubscriptionAdapter
src/adapters/ThingyAdapter
src/adapters/UserAdapter
src/api/AccidentApi
src/api/AuthUserApi
src/api/BaseApi
src/api/DataApi
src/api/exampleApi
src/api/NotificationSubscriptionApi
src/api/routes
src/api/ThingyApi
src/api/UserApi
src/app
src/constants
src/database/handlers/AccidentHandler
src/database/handlers/AuthUserHandler
src/database/handlers/BaseHandler
src/database/handlers/DataHandler
src/database/handlers/NotificationSubscriptionHandler
src/database/handlers/ThingyHandler
src/database/handlers/UserHandler
src/database/Model
src/database/models/Accident
src/database/models/AuthUser
src/database/models/Data
src/database/models/NotificationSubscription
src/database/models/Thingy
src/database/models/User
src/mqtt/MqttConnection
src/mqtt/MqttTopic
src/services/AccidentDetector
src/services/MqttService
src/services/WebsocketService
src/types
src/utils

Settings

Member Visibility

On This Page

Modules
src/adapters/AccidentAdaptersrc/adapters/AuthUserAdaptersrc/adapters/BaseAdaptersrc/adapters/DataAdaptersrc/adapters/DataMqttAdaptersrc/adapters/NotificationSubscriptionAdaptersrc/adapters/ThingyAdaptersrc/adapters/UserAdaptersrc/api/AccidentApisrc/api/AuthUserApisrc/api/BaseApisrc/api/DataApisrc/api/exampleApisrc/api/NotificationSubscriptionApisrc/api/routessrc/api/ThingyApisrc/api/UserApisrc/appsrc/constantssrc/database/handlers/AccidentHandlersrc/database/handlers/AuthUserHandlersrc/database/handlers/BaseHandlersrc/database/handlers/DataHandlersrc/database/handlers/NotificationSubscriptionHandlersrc/database/handlers/ThingyHandlersrc/database/handlers/UserHandlersrc/database/Modelsrc/database/models/Accidentsrc/database/models/AuthUsersrc/database/models/Datasrc/database/models/NotificationSubscriptionsrc/database/models/Thingysrc/database/models/Usersrc/mqtt/MqttConnectionsrc/mqtt/MqttTopicsrc/services/AccidentDetectorsrc/services/MqttServicesrc/services/WebsocketServicesrc/typessrc/utils
diff --git a/api/modules/src_adapters_AccidentAdapter.html b/api/modules/src_adapters_AccidentAdapter.html new file mode 100644 index 0000000..724c6fb --- /dev/null +++ b/api/modules/src_adapters_AccidentAdapter.html @@ -0,0 +1 @@ +src/adapters/AccidentAdapter | orange-api

Module src/adapters/AccidentAdapter

Classes

AccidentAdapter

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_adapters_AuthUserAdapter.html b/api/modules/src_adapters_AuthUserAdapter.html new file mode 100644 index 0000000..5d83ea3 --- /dev/null +++ b/api/modules/src_adapters_AuthUserAdapter.html @@ -0,0 +1 @@ +src/adapters/AuthUserAdapter | orange-api

Module src/adapters/AuthUserAdapter

Classes

AuthUserAdapter

Interfaces

SignUpUserData

Settings

Member Visibility

On This Page

Classes
Interfaces
diff --git a/api/modules/src_adapters_BaseAdapter.html b/api/modules/src_adapters_BaseAdapter.html new file mode 100644 index 0000000..233e397 --- /dev/null +++ b/api/modules/src_adapters_BaseAdapter.html @@ -0,0 +1 @@ +src/adapters/BaseAdapter | orange-api

Module src/adapters/BaseAdapter

Classes

BaseAdapter

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_adapters_DataAdapter.html b/api/modules/src_adapters_DataAdapter.html new file mode 100644 index 0000000..5a5ea95 --- /dev/null +++ b/api/modules/src_adapters_DataAdapter.html @@ -0,0 +1 @@ +src/adapters/DataAdapter | orange-api

Module src/adapters/DataAdapter

Classes

DataAdapter

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_adapters_DataMqttAdapter.html b/api/modules/src_adapters_DataMqttAdapter.html new file mode 100644 index 0000000..69c95c5 --- /dev/null +++ b/api/modules/src_adapters_DataMqttAdapter.html @@ -0,0 +1 @@ +src/adapters/DataMqttAdapter | orange-api

Module src/adapters/DataMqttAdapter

Functions

flipPostProcessor
MqttMessageHandler

Settings

Member Visibility

On This Page

Functions
diff --git a/api/modules/src_adapters_NotificationSubscriptionAdapter.html b/api/modules/src_adapters_NotificationSubscriptionAdapter.html new file mode 100644 index 0000000..bc336e8 --- /dev/null +++ b/api/modules/src_adapters_NotificationSubscriptionAdapter.html @@ -0,0 +1 @@ +src/adapters/NotificationSubscriptionAdapter | orange-api

Module src/adapters/NotificationSubscriptionAdapter

Classes

NotificationSubscriptionAdapter

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_adapters_ThingyAdapter.html b/api/modules/src_adapters_ThingyAdapter.html new file mode 100644 index 0000000..bb67963 --- /dev/null +++ b/api/modules/src_adapters_ThingyAdapter.html @@ -0,0 +1 @@ +src/adapters/ThingyAdapter | orange-api

Module src/adapters/ThingyAdapter

Classes

ThingyAdapter

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_adapters_UserAdapter.html b/api/modules/src_adapters_UserAdapter.html new file mode 100644 index 0000000..2ca4660 --- /dev/null +++ b/api/modules/src_adapters_UserAdapter.html @@ -0,0 +1 @@ +src/adapters/UserAdapter | orange-api

Module src/adapters/UserAdapter

Classes

UserAdapter

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_api_AccidentApi.html b/api/modules/src_api_AccidentApi.html new file mode 100644 index 0000000..6443c76 --- /dev/null +++ b/api/modules/src_api_AccidentApi.html @@ -0,0 +1 @@ +src/api/AccidentApi | orange-api

Module src/api/AccidentApi

Classes

AccidentApi

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_api_AuthUserApi.html b/api/modules/src_api_AuthUserApi.html new file mode 100644 index 0000000..7562f22 --- /dev/null +++ b/api/modules/src_api_AuthUserApi.html @@ -0,0 +1 @@ +src/api/AuthUserApi | orange-api

Module src/api/AuthUserApi

Classes

AuthUserApi

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_api_BaseApi.html b/api/modules/src_api_BaseApi.html new file mode 100644 index 0000000..83a5a4d --- /dev/null +++ b/api/modules/src_api_BaseApi.html @@ -0,0 +1 @@ +src/api/BaseApi | orange-api

Module src/api/BaseApi

Classes

BaseApi

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_api_DataApi.html b/api/modules/src_api_DataApi.html new file mode 100644 index 0000000..88aa562 --- /dev/null +++ b/api/modules/src_api_DataApi.html @@ -0,0 +1 @@ +src/api/DataApi | orange-api

Module src/api/DataApi

Classes

Data_Air_PressApi
Data_Air_QualApi
Data_ButtonApi
Data_BuzzerApi
Data_CO2EquivApi
Data_FlipApi
Data_GPSApi
Data_HumidApi
Data_LedApi
Data_LightApi
Data_TempApi

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_api_NotificationSubscriptionApi.html b/api/modules/src_api_NotificationSubscriptionApi.html new file mode 100644 index 0000000..3ce49ca --- /dev/null +++ b/api/modules/src_api_NotificationSubscriptionApi.html @@ -0,0 +1 @@ +src/api/NotificationSubscriptionApi | orange-api

Module src/api/NotificationSubscriptionApi

Classes

NotificationSubscriptionApi

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_api_ThingyApi.html b/api/modules/src_api_ThingyApi.html new file mode 100644 index 0000000..6f2869c --- /dev/null +++ b/api/modules/src_api_ThingyApi.html @@ -0,0 +1 @@ +src/api/ThingyApi | orange-api

Module src/api/ThingyApi

Classes

ThingyApi

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_api_UserApi.html b/api/modules/src_api_UserApi.html new file mode 100644 index 0000000..283591b --- /dev/null +++ b/api/modules/src_api_UserApi.html @@ -0,0 +1 @@ +src/api/UserApi | orange-api

Module src/api/UserApi

Classes

UserApi

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_api_exampleApi.html b/api/modules/src_api_exampleApi.html new file mode 100644 index 0000000..90ebf36 --- /dev/null +++ b/api/modules/src_api_exampleApi.html @@ -0,0 +1 @@ +src/api/exampleApi | orange-api

Module src/api/exampleApi

Functions

getExample

Settings

Member Visibility

On This Page

Functions
diff --git a/api/modules/src_api_routes.html b/api/modules/src_api_routes.html new file mode 100644 index 0000000..84ae9ac --- /dev/null +++ b/api/modules/src_api_routes.html @@ -0,0 +1 @@ +src/api/routes | orange-api

Module src/api/routes

Variables

accidentApi
airPressApi
airQualApi
authUserApi
buttonApi
buzzerApi
co2Api
flipApi
gpsApi
humidApi
ledApi
lightApi
notificationSubscriptionApi
router
tempApi
thingyApi
userApi

Settings

Member Visibility

On This Page

Variables
diff --git a/api/modules/src_app.html b/api/modules/src_app.html new file mode 100644 index 0000000..e760ce1 --- /dev/null +++ b/api/modules/src_app.html @@ -0,0 +1 @@ +src/app | orange-api

Module src/app

Settings

Member Visibility
diff --git a/api/modules/src_constants.html b/api/modules/src_constants.html new file mode 100644 index 0000000..bd8608a --- /dev/null +++ b/api/modules/src_constants.html @@ -0,0 +1 @@ +src/constants | orange-api

Module src/constants

Variables

IOPORT
PORT

Settings

Member Visibility

On This Page

Variables
diff --git a/api/modules/src_database_Model.html b/api/modules/src_database_Model.html new file mode 100644 index 0000000..292e78f --- /dev/null +++ b/api/modules/src_database_Model.html @@ -0,0 +1 @@ +src/database/Model | orange-api

Module src/database/Model

Variables

sequelize_model

Functions

createSchema
dropSchema
redeploySchema
refreshSchema

Settings

Member Visibility

On This Page

Variables
Functions
diff --git a/api/modules/src_database_handlers_AccidentHandler.html b/api/modules/src_database_handlers_AccidentHandler.html new file mode 100644 index 0000000..ec964c7 --- /dev/null +++ b/api/modules/src_database_handlers_AccidentHandler.html @@ -0,0 +1 @@ +src/database/handlers/AccidentHandler | orange-api

Module src/database/handlers/AccidentHandler

Classes

default

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_database_handlers_AuthUserHandler.html b/api/modules/src_database_handlers_AuthUserHandler.html new file mode 100644 index 0000000..079bfdb --- /dev/null +++ b/api/modules/src_database_handlers_AuthUserHandler.html @@ -0,0 +1 @@ +src/database/handlers/AuthUserHandler | orange-api

Module src/database/handlers/AuthUserHandler

Classes

default

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_database_handlers_BaseHandler.html b/api/modules/src_database_handlers_BaseHandler.html new file mode 100644 index 0000000..d6c5a39 --- /dev/null +++ b/api/modules/src_database_handlers_BaseHandler.html @@ -0,0 +1 @@ +src/database/handlers/BaseHandler | orange-api

Module src/database/handlers/BaseHandler

Classes

default

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_database_handlers_DataHandler.html b/api/modules/src_database_handlers_DataHandler.html new file mode 100644 index 0000000..cbcf438 --- /dev/null +++ b/api/modules/src_database_handlers_DataHandler.html @@ -0,0 +1 @@ +src/database/handlers/DataHandler | orange-api

Module src/database/handlers/DataHandler

Classes

Data_AIR_PRESSHandler
Data_AIR_QUALHandler
Data_BUTTONHandler
Data_BUZZERHandler
Data_CO2EQUIVHandler
Data_DefaultHandler
Data_FLIPHandler
Data_GPSHandler
Data_HUMIDHandler
Data_LEDHandler
Data_LIGHTHandler
Data_TEMPHandler
DataHandler

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_database_handlers_NotificationSubscriptionHandler.html b/api/modules/src_database_handlers_NotificationSubscriptionHandler.html new file mode 100644 index 0000000..9609e13 --- /dev/null +++ b/api/modules/src_database_handlers_NotificationSubscriptionHandler.html @@ -0,0 +1 @@ +src/database/handlers/NotificationSubscriptionHandler | orange-api

Module src/database/handlers/NotificationSubscriptionHandler

Classes

NotificationSubscriptionHandler

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_database_handlers_ThingyHandler.html b/api/modules/src_database_handlers_ThingyHandler.html new file mode 100644 index 0000000..3a5b58a --- /dev/null +++ b/api/modules/src_database_handlers_ThingyHandler.html @@ -0,0 +1 @@ +src/database/handlers/ThingyHandler | orange-api

Module src/database/handlers/ThingyHandler

Classes

default

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_database_handlers_UserHandler.html b/api/modules/src_database_handlers_UserHandler.html new file mode 100644 index 0000000..bad6c6c --- /dev/null +++ b/api/modules/src_database_handlers_UserHandler.html @@ -0,0 +1 @@ +src/database/handlers/UserHandler | orange-api

Module src/database/handlers/UserHandler

Classes

default

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_database_models_Accident.html b/api/modules/src_database_models_Accident.html new file mode 100644 index 0000000..f42d7d7 --- /dev/null +++ b/api/modules/src_database_models_Accident.html @@ -0,0 +1 @@ +src/database/models/Accident | orange-api

Module src/database/models/Accident

Classes

Accident

Type Aliases

AccidentDTO

Settings

Member Visibility

On This Page

Classes
Type Aliases
diff --git a/api/modules/src_database_models_AuthUser.html b/api/modules/src_database_models_AuthUser.html new file mode 100644 index 0000000..112ce33 --- /dev/null +++ b/api/modules/src_database_models_AuthUser.html @@ -0,0 +1 @@ +src/database/models/AuthUser | orange-api

Module src/database/models/AuthUser

Classes

AuthUser

Type Aliases

AuthUserDTO

Settings

Member Visibility

On This Page

Classes
Type Aliases
diff --git a/api/modules/src_database_models_Data.html b/api/modules/src_database_models_Data.html new file mode 100644 index 0000000..410c691 --- /dev/null +++ b/api/modules/src_database_models_Data.html @@ -0,0 +1 @@ +src/database/models/Data | orange-api

Module src/database/models/Data

Classes

Data
Data_AIR_PRESS
Data_AIR_QUAL
Data_BUTTON
Data_BUZZER
Data_CO2EQUIV
Data_Default
Data_FLIP
Data_GPS
Data_HUMID
Data_LED
Data_LIGHT
Data_TEMP

Type Aliases

DataDTO
DefaultDataDTO

Settings

Member Visibility

On This Page

Classes
Type Aliases
diff --git a/api/modules/src_database_models_NotificationSubscription.html b/api/modules/src_database_models_NotificationSubscription.html new file mode 100644 index 0000000..a7567f3 --- /dev/null +++ b/api/modules/src_database_models_NotificationSubscription.html @@ -0,0 +1 @@ +src/database/models/NotificationSubscription | orange-api

Module src/database/models/NotificationSubscription

Classes

NotificationSubscription

Type Aliases

NotificationSubscriptionDTO

Settings

Member Visibility

On This Page

Classes
Type Aliases
diff --git a/api/modules/src_database_models_Thingy.html b/api/modules/src_database_models_Thingy.html new file mode 100644 index 0000000..5dd2289 --- /dev/null +++ b/api/modules/src_database_models_Thingy.html @@ -0,0 +1 @@ +src/database/models/Thingy | orange-api

Module src/database/models/Thingy

Classes

Thingy

Type Aliases

ThingyDTO

Settings

Member Visibility

On This Page

Classes
Type Aliases
diff --git a/api/modules/src_database_models_User.html b/api/modules/src_database_models_User.html new file mode 100644 index 0000000..cc2c39d --- /dev/null +++ b/api/modules/src_database_models_User.html @@ -0,0 +1 @@ +src/database/models/User | orange-api

Module src/database/models/User

Classes

User

Type Aliases

UserDTO

Settings

Member Visibility

On This Page

Classes
Type Aliases
diff --git a/api/modules/src_mqtt_MqttConnection.html b/api/modules/src_mqtt_MqttConnection.html new file mode 100644 index 0000000..5f604fe --- /dev/null +++ b/api/modules/src_mqtt_MqttConnection.html @@ -0,0 +1 @@ +src/mqtt/MqttConnection | orange-api

Module src/mqtt/MqttConnection

Classes

MQTTConnection

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_mqtt_MqttTopic.html b/api/modules/src_mqtt_MqttTopic.html new file mode 100644 index 0000000..90c84c4 --- /dev/null +++ b/api/modules/src_mqtt_MqttTopic.html @@ -0,0 +1 @@ +src/mqtt/MqttTopic | orange-api

Module src/mqtt/MqttTopic

Classes

MqttTopic

Settings

Member Visibility

On This Page

Classes
diff --git a/api/modules/src_services_AccidentDetector.html b/api/modules/src_services_AccidentDetector.html new file mode 100644 index 0000000..cd21c5c --- /dev/null +++ b/api/modules/src_services_AccidentDetector.html @@ -0,0 +1 @@ +src/services/AccidentDetector | orange-api

Module src/services/AccidentDetector

Functions

accidentDetector_thingy
accidentDetector_user

Settings

Member Visibility

On This Page

Functions
diff --git a/api/modules/src_services_MqttService.html b/api/modules/src_services_MqttService.html new file mode 100644 index 0000000..276d990 --- /dev/null +++ b/api/modules/src_services_MqttService.html @@ -0,0 +1 @@ +src/services/MqttService | orange-api

Module src/services/MqttService

Functions

sendLightToThingy
sendSoundToThingy
setupMqttConnection
subscribeSensors

Settings

Member Visibility

On This Page

Functions
diff --git a/api/modules/src_services_WebsocketService.html b/api/modules/src_services_WebsocketService.html new file mode 100644 index 0000000..6c099f5 --- /dev/null +++ b/api/modules/src_services_WebsocketService.html @@ -0,0 +1 @@ +src/services/WebsocketService | orange-api

Module src/services/WebsocketService

Functions

emitAccidentUpdate
initializeSocket

Settings

Member Visibility

On This Page

Functions
diff --git a/api/modules/src_types.html b/api/modules/src_types.html new file mode 100644 index 0000000..d0370eb --- /dev/null +++ b/api/modules/src_types.html @@ -0,0 +1 @@ +src/types | orange-api

Module src/types

Type Aliases

GenericDTO
SensorMQTTMessage
SubscriptionRequest
SubscriptionToken

Settings

Member Visibility

On This Page

Type Aliases
diff --git a/api/modules/src_utils.html b/api/modules/src_utils.html new file mode 100644 index 0000000..f893be2 --- /dev/null +++ b/api/modules/src_utils.html @@ -0,0 +1 @@ +src/utils | orange-api

Module src/utils

Classes

ApiError

Functions

validateEnvVariable

Settings

Member Visibility

On This Page

Classes
Functions
diff --git a/api/types/src_database_models_Accident.AccidentDTO.html b/api/types/src_database_models_Accident.AccidentDTO.html new file mode 100644 index 0000000..51656a4 --- /dev/null +++ b/api/types/src_database_models_Accident.AccidentDTO.html @@ -0,0 +1,2 @@ +AccidentDTO | orange-api

Type Alias AccidentDTO

AccidentDTO: Partial<GenericDTO> & { id: number; thingy: ThingyDTO }

Definition of the Thingy Model as data transfer object

+

Settings

Member Visibility
diff --git a/api/types/src_database_models_AuthUser.AuthUserDTO.html b/api/types/src_database_models_AuthUser.AuthUserDTO.html new file mode 100644 index 0000000..6beb5dc --- /dev/null +++ b/api/types/src_database_models_AuthUser.AuthUserDTO.html @@ -0,0 +1,2 @@ +AuthUserDTO | orange-api

Type Alias AuthUserDTO

AuthUserDTO: Partial<GenericDTO> & {
    passwordHash: string;
    user?: UserDTO;
    userName: string;
}

Definition of the AuthUser Model as plain data transfer object

+

Settings

Member Visibility
diff --git a/api/types/src_database_models_Data.DataDTO.html b/api/types/src_database_models_Data.DataDTO.html new file mode 100644 index 0000000..b7c171e --- /dev/null +++ b/api/types/src_database_models_Data.DataDTO.html @@ -0,0 +1,2 @@ +DataDTO | orange-api

Type Alias DataDTO

DataDTO: Partial<GenericDTO> & { thingyId: number; ts: number; value: string }

Definition of the Event Model as data transfer object

+

Settings

Member Visibility
diff --git a/api/types/src_database_models_Data.DefaultDataDTO.html b/api/types/src_database_models_Data.DefaultDataDTO.html new file mode 100644 index 0000000..eece091 --- /dev/null +++ b/api/types/src_database_models_Data.DefaultDataDTO.html @@ -0,0 +1 @@ +DefaultDataDTO | orange-api

Type Alias DefaultDataDTO

DefaultDataDTO: Partial<DataDTO> & { appId: string }

Settings

Member Visibility
diff --git a/api/types/src_database_models_NotificationSubscription.NotificationSubscriptionDTO.html b/api/types/src_database_models_NotificationSubscription.NotificationSubscriptionDTO.html new file mode 100644 index 0000000..1058d85 --- /dev/null +++ b/api/types/src_database_models_NotificationSubscription.NotificationSubscriptionDTO.html @@ -0,0 +1 @@ +NotificationSubscriptionDTO | orange-api

Type Alias NotificationSubscriptionDTO

NotificationSubscriptionDTO: Partial<GenericDTO> & {
    deviceToken: string;
    userId: number;
}

Settings

Member Visibility
diff --git a/api/types/src_database_models_Thingy.ThingyDTO.html b/api/types/src_database_models_Thingy.ThingyDTO.html new file mode 100644 index 0000000..fe10b24 --- /dev/null +++ b/api/types/src_database_models_Thingy.ThingyDTO.html @@ -0,0 +1,2 @@ +ThingyDTO | orange-api

Type Alias ThingyDTO

ThingyDTO: Partial<GenericDTO> & {
    accidents: AccidentDTO[];
    name: string;
    userId: number;
}

Definition of the Thingy Model as data transfer object

+

Settings

Member Visibility
diff --git a/api/types/src_database_models_User.UserDTO.html b/api/types/src_database_models_User.UserDTO.html new file mode 100644 index 0000000..037b573 --- /dev/null +++ b/api/types/src_database_models_User.UserDTO.html @@ -0,0 +1,2 @@ +UserDTO | orange-api

Type Alias UserDTO

UserDTO: Partial<GenericDTO> & {
    firstName: string;
    isRiding: boolean;
    lastName: string;
    name: string;
    notificationSubscriptions?: NotificationSubscriptionDTO[];
    thingys: ThingyDTO[];
}

Definition of the User Model as plain data transfer object

+

Settings

Member Visibility
diff --git a/api/types/src_types.GenericDTO.html b/api/types/src_types.GenericDTO.html new file mode 100644 index 0000000..3d3ca82 --- /dev/null +++ b/api/types/src_types.GenericDTO.html @@ -0,0 +1,2 @@ +GenericDTO | orange-api

Type Alias GenericDTO

GenericDTO: { createdAt?: string; id?: number; updatedAt?: string }

Definition of the Generic Data Transfer Object

+

Settings

Member Visibility
diff --git a/api/types/src_types.SensorMQTTMessage.html b/api/types/src_types.SensorMQTTMessage.html new file mode 100644 index 0000000..fc819f0 --- /dev/null +++ b/api/types/src_types.SensorMQTTMessage.html @@ -0,0 +1 @@ +SensorMQTTMessage | orange-api

Type Alias SensorMQTTMessage

SensorMQTTMessage: {
    appId: string;
    data: string;
    messageType: string;
    ts: number;
}

Settings

Member Visibility
diff --git a/api/types/src_types.SubscriptionRequest.html b/api/types/src_types.SubscriptionRequest.html new file mode 100644 index 0000000..2167b6a --- /dev/null +++ b/api/types/src_types.SubscriptionRequest.html @@ -0,0 +1 @@ +SubscriptionRequest | orange-api

Type Alias SubscriptionRequest

SubscriptionRequest: { deviceToken: string; subscriptionToken: string }

Settings

Member Visibility
diff --git a/api/types/src_types.SubscriptionToken.html b/api/types/src_types.SubscriptionToken.html new file mode 100644 index 0000000..609b5cb --- /dev/null +++ b/api/types/src_types.SubscriptionToken.html @@ -0,0 +1 @@ +SubscriptionToken | orange-api

Type Alias SubscriptionToken

SubscriptionToken: { token: string }

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.accidentApi.html b/api/variables/src_api_routes.accidentApi.html new file mode 100644 index 0000000..ee3846d --- /dev/null +++ b/api/variables/src_api_routes.accidentApi.html @@ -0,0 +1 @@ +accidentApi | orange-api

Variable accidentApiConst

accidentApi: AccidentApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.airPressApi.html b/api/variables/src_api_routes.airPressApi.html new file mode 100644 index 0000000..8054f12 --- /dev/null +++ b/api/variables/src_api_routes.airPressApi.html @@ -0,0 +1 @@ +airPressApi | orange-api

Variable airPressApiConst

airPressApi: Data_Air_PressApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.airQualApi.html b/api/variables/src_api_routes.airQualApi.html new file mode 100644 index 0000000..357888c --- /dev/null +++ b/api/variables/src_api_routes.airQualApi.html @@ -0,0 +1 @@ +airQualApi | orange-api

Variable airQualApiConst

airQualApi: Data_Air_QualApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.authUserApi.html b/api/variables/src_api_routes.authUserApi.html new file mode 100644 index 0000000..c6850fa --- /dev/null +++ b/api/variables/src_api_routes.authUserApi.html @@ -0,0 +1 @@ +authUserApi | orange-api

Variable authUserApiConst

authUserApi: AuthUserApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.buttonApi.html b/api/variables/src_api_routes.buttonApi.html new file mode 100644 index 0000000..53af594 --- /dev/null +++ b/api/variables/src_api_routes.buttonApi.html @@ -0,0 +1 @@ +buttonApi | orange-api

Variable buttonApiConst

buttonApi: Data_ButtonApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.buzzerApi.html b/api/variables/src_api_routes.buzzerApi.html new file mode 100644 index 0000000..61682a8 --- /dev/null +++ b/api/variables/src_api_routes.buzzerApi.html @@ -0,0 +1 @@ +buzzerApi | orange-api

Variable buzzerApiConst

buzzerApi: Data_BuzzerApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.co2Api.html b/api/variables/src_api_routes.co2Api.html new file mode 100644 index 0000000..2472c08 --- /dev/null +++ b/api/variables/src_api_routes.co2Api.html @@ -0,0 +1 @@ +co2Api | orange-api

Variable co2ApiConst

co2Api: Data_CO2EquivApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.flipApi.html b/api/variables/src_api_routes.flipApi.html new file mode 100644 index 0000000..150d87a --- /dev/null +++ b/api/variables/src_api_routes.flipApi.html @@ -0,0 +1 @@ +flipApi | orange-api

Variable flipApiConst

flipApi: Data_FlipApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.gpsApi.html b/api/variables/src_api_routes.gpsApi.html new file mode 100644 index 0000000..88db0b8 --- /dev/null +++ b/api/variables/src_api_routes.gpsApi.html @@ -0,0 +1 @@ +gpsApi | orange-api

Variable gpsApiConst

gpsApi: Data_GPSApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.humidApi.html b/api/variables/src_api_routes.humidApi.html new file mode 100644 index 0000000..db9ec96 --- /dev/null +++ b/api/variables/src_api_routes.humidApi.html @@ -0,0 +1 @@ +humidApi | orange-api

Variable humidApiConst

humidApi: Data_HumidApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.ledApi.html b/api/variables/src_api_routes.ledApi.html new file mode 100644 index 0000000..b551019 --- /dev/null +++ b/api/variables/src_api_routes.ledApi.html @@ -0,0 +1 @@ +ledApi | orange-api

Variable ledApiConst

ledApi: Data_LedApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.lightApi.html b/api/variables/src_api_routes.lightApi.html new file mode 100644 index 0000000..42dd78b --- /dev/null +++ b/api/variables/src_api_routes.lightApi.html @@ -0,0 +1 @@ +lightApi | orange-api

Variable lightApiConst

lightApi: Data_LightApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.notificationSubscriptionApi.html b/api/variables/src_api_routes.notificationSubscriptionApi.html new file mode 100644 index 0000000..e6cb29b --- /dev/null +++ b/api/variables/src_api_routes.notificationSubscriptionApi.html @@ -0,0 +1 @@ +notificationSubscriptionApi | orange-api

Variable notificationSubscriptionApiConst

notificationSubscriptionApi: NotificationSubscriptionApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.router.html b/api/variables/src_api_routes.router.html new file mode 100644 index 0000000..5eeed8d --- /dev/null +++ b/api/variables/src_api_routes.router.html @@ -0,0 +1 @@ +router | orange-api

Variable routerConst

router: any = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.tempApi.html b/api/variables/src_api_routes.tempApi.html new file mode 100644 index 0000000..9d5408a --- /dev/null +++ b/api/variables/src_api_routes.tempApi.html @@ -0,0 +1 @@ +tempApi | orange-api

Variable tempApiConst

tempApi: Data_TempApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.thingyApi.html b/api/variables/src_api_routes.thingyApi.html new file mode 100644 index 0000000..7ee28bd --- /dev/null +++ b/api/variables/src_api_routes.thingyApi.html @@ -0,0 +1 @@ +thingyApi | orange-api

Variable thingyApiConst

thingyApi: ThingyApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_api_routes.userApi.html b/api/variables/src_api_routes.userApi.html new file mode 100644 index 0000000..ee5855c --- /dev/null +++ b/api/variables/src_api_routes.userApi.html @@ -0,0 +1 @@ +userApi | orange-api

Variable userApiConst

userApi: UserApi = ...

Settings

Member Visibility
diff --git a/api/variables/src_constants.IOPORT.html b/api/variables/src_constants.IOPORT.html new file mode 100644 index 0000000..fb4d41f --- /dev/null +++ b/api/variables/src_constants.IOPORT.html @@ -0,0 +1 @@ +IOPORT | orange-api

Variable IOPORTConst

IOPORT: number = 4100

Settings

Member Visibility
diff --git a/api/variables/src_constants.PORT.html b/api/variables/src_constants.PORT.html new file mode 100644 index 0000000..98bd943 --- /dev/null +++ b/api/variables/src_constants.PORT.html @@ -0,0 +1 @@ +PORT | orange-api

Variable PORTConst

PORT: number = 3000

Settings

Member Visibility
diff --git a/api/variables/src_database_Model.sequelize_model.html b/api/variables/src_database_Model.sequelize_model.html new file mode 100644 index 0000000..0e607c7 --- /dev/null +++ b/api/variables/src_database_Model.sequelize_model.html @@ -0,0 +1,2 @@ +sequelize_model | orange-api

Variable sequelize_modelConst

sequelize_model: any = ...

Creating and exporting the model to be used by all the classes

+

Settings

Member Visibility