diff --git a/CHANGELOG.md b/CHANGELOG.md index 6be7a51c..4fcfdf93 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +## [9.0.8](https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/compare/v9.0.7...v9.0.8) (2024-07-25) + + +### Bug Fixes + +* **deps:** bump idna-uts46-hx from 6.0.4 to 6.0.5 ([59ddf2f](https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/commit/59ddf2fd575a6596476c4c8309d1993e659fe98a)) + ## [9.0.7](https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/compare/v9.0.6...v9.0.7) (2024-04-24) diff --git a/docs/assets/icons.js b/docs/assets/icons.js index b79c9e89..e88e8ca7 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -1,15 +1,18 @@ -(function(svg) { - svg.innerHTML = ``; - svg.style.display = 'none'; - if (location.protocol === 'file:') { - if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); - else updateUseElements() - function updateUseElements() { - document.querySelectorAll('use').forEach(el => { - if (el.getAttribute('href').includes('#icon-')) { - el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); - } - }); - } +(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 = `""`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); } -})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file + + 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/docs/assets/icons.svg b/docs/assets/icons.svg index 7dead611..e371b8b5 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index d6f13886..35728810 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,8 +1,9 @@ "use strict"; -"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(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,u],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[u+1]*i[d+1],u+=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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=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 se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;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){re.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&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");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&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").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&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}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="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.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",()=>{le(e,t)}),le(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");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ve(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=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(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),e.blur()}}function ce(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(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,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 te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{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()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.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 Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(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-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(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 u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; +"use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(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,u],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[u+1]*i[d+1],u+=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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,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 ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;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){se.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&&!Ve(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 Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.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",()=>{ce(e,t)}),ce(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",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(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(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(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=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${he(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=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(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 Be(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),te(e)}}function he(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(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,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 re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{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()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.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 Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(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='',be(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 u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 3347753c..8da5e811 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52WXUvDMBSG/0u8HX7MIbo7Kbso1LXUKoqMEdNsC6ZJaVIZiP9d3PqRj6Zrd5tzzvO+p28W9vEDJN5LMAcwJ4gSzCSYgBzKHZiDjKclxeKqKV3uZEbBBHwRloL5dALQjtC0wAzMPxrQY+R7BghRKIQGapp05M30/nfSkPzn6DHy1164XC68xA+X65c4WAf+66JFf8OCwE/dpXtOV7udnhQLk7O0wmS8VBSHb+/niB0GLbmVIog4LTNmB3s8H5SqZyDqSCuE10H6D1NzUQrJM8q3W1x0eFGqwxwdBgID1/hScWprv0fCUry3zR2Oz739NuRC7TriZjcPs9vrmWIlxiLnTOBekNJ0ipPgLKdQ4ifIYGcCHVh7RldRP50r2BGRusKsEEMCLDDiRWq7OJ4PchEbiNpFhYg7SLYLV3Z1ZaATE9N6qTBxJ8/lJ4eF6MpIr4/yFhnI9t0yoPpA73tVT8rq+mWuK+toHLWA83dhfmtTxAEYloQsIBMUSt63VdMzbqEOtLVLi7bH+jcQHH1hiTjbkK3tXa0Ocv18GPAMXO1Xw6mtff8bNmSP05c4WDDUEjclQ5JwZjCVXh159/+6rf4A+KusdCAJAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52VXWuDMBSG/0uuZWPdGMO7Ir0QXBVrx8YoJYtpGxoTMXEURv/7mLVqPnTa2+Sc532OR/HzB0h8ksAFMCeIEswkcEAO5QG4IONpSbG4b67uDjKjwAFHwlLgzhyADoSmBWbA/WxA88j3NBCiUAgF1BSpyIfZy9lpSP4qmkf+1guXy4WX+OFyu46DbeC/LVr0NywI/FIt+/vUtMfZv2FhclNWmEyPiuLw/eOWsKrRiNt0AhGnZcbMxV7OR23V0xDXldYIz0L6W6ZiUQrJM8r3e1xYXDq344yqhkDDNV5dXLd02JGwFJ9MuepYs+p09c00YZq+OWrEGPcCI16kpsXlfJRFrCGuFjUitpBMC5FzJrDN43Iz0kTHtC41Jrby+nxyWAjbjtT7SW6Rhmw/WQ2qNgx+qtdOibOcQokzyKD13eopnDRAUve+6iH6s9ZDegDjNiELyASFkg9N1dRMG8iCNmZp0Wbb8ASCoyOWiLMd2Zvu3dtR1quqwdNwV18F1y0d+mXuyAmn6zhYMNQSdyVDknCmMTu1KvL56bw5b34BwykdExsIAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index cf58f7a4..ad92a79f 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8VdXW/cOLL9L8prb1bUt/yW8eRijc3EXscZ7IURBJpuui1Mf62k9iQI8t8XpKRWFVWlFlvyvU+ZcbOqDusUi2RRon44xf6v0rl6/OH8me9WzpW3cHbZVjpXTnbIl5tc7ipn4RyLjXPlbPer40aWfz/98va52m6chbPcZGUpS+fKcX4uWk1+p+rm0927u5uv17cfP76/fri5/fj18/2Hr3f3t//+35Pyl6zIsz+w+gE5wvTCOWSFwguxW+D5cPP7+wvgKLFXQHP7cAmY24cLsAgvOYF5d3dzjVlv9ADTpzYXmHK94GSr3C//lNVDvpX743h7b0yxM9Y7cYAjFJ3/l/tdWRXHZbUvxoPAQpdAQK44ZuNN67adxapc/S0v/3Yo8peskhfar336+f6DLQ21yKugud7vnvK1LaCT1MyYVvKP4/q3/UqOBwRFZkazPBab/aEqLQK2k5gZy2a/XkuLoXNqPx2H5wZd6ipldX0sq/32gyWgvuAl49nE8qt8yo6b6gIwpuRkNHKnZo9f7SO4LzgZyyovLwRDSE5Gs5bVJ1mW+X43HgeSmQOBVdpd93Pu5TH6uZTFu7XNbP/GkJql//Yo1jOjKGV1V+y/fbfyQysxhw8sra9ntF7K6l4+ycIyS3Uyc/TfGsF6bgS/y8I6D3Qy01nIXqR1KsJCkzEU8ljagzCkZslLVgvROTPi7cOdleW6/RyW7cmfdR7SI3q7r+TN3bvVqpClxdqSlJ0D0XUhV3JX5dnGDg2Wm8U3+428FE1fdjKizX6dW4RK23weu++/VXK3kitL+0BsDhxWNYNT+xly5H+OsrQw3QnMZfuj/Fbdy/Kw35XyLltbLKF5BXNhe7fZQM0WA4VXMNdK9/dc/mW90G2EZvDPRShMsck4jqX8R75+vpPF077YZrulvN7vdnJZ5fvdJ1kdDxaFqBGq5sDb7Ien4GRVzIHv9uH9p+9lJbdWkKDUHChUHfoCGEhslp3M7aeHX7PKoqCJhSZjeNpkVSV31/vtNttZTFI9uZnrU9mx2t/8+vF6v3uRhcUE0pObARcofm+O224l0R7x1H8ePN+BpwbXWEvbpUbLNacM4G1w2Ffo+zZG1eaRGFvZlLt19TzG5KnlBGt/yn4BgDBVNxsTA6OsrqihSphdmaPT3q6ZKf45rsOnlna+Na2ROYk2N5iJbOz98v1mt5LfLMx2EhOsP2el0jXattF+EsfgiEKV1I3DgVN+AT+OzzJD1X2kEbY8k3cgyguyz6BVNhM1fs13z7LIK70lIhEhlQN7IVtctch5j7D2T8ZzFGMtvfqvg7x6ED4VIZaxwURFo2VMJFwcA30bo2YgJGbDLWFviE/WDtiaLPfFqsdA/efRDNxjLS3aRss9pwwgbXDYM9C3MYoBJGY1PxIGLeZHzu6oGYswfW7GsrH3y3dqVuaNtu0nWG5mnzFGu6aT/Aw35brSQMR+/YNF9Buaul40mu55lQhzo+eSUUBZGjkSDFFuNBRZv3bB2K2bEjztK7k05rzR9p+zsr8eZwA0bWdGsGS2laz3bXaTFijUuutP+b1fYGOBAIlXwGIJZHYU9WCnl7xchCKRV0Az2idd86kozJx+TT1iwaDomttnid5cIstlkR8q6kSLN4+lpqO422TEMQlvv20/3fK/jvIoq3xr43woMx3BPyxSZdd8ut37486y353EROt5+b4oxs+MXfPJdj8dl0vqyJS13AlMtv2wPVh2G0hMtn4nd6t819+lsMY7gYm2s9WKqTsytqHAdNvsfoezfRKYPsbs+g0F5rJtNdH2pOZC8U+LBZApNBcGewBzWbdaiCKJ2azbTrCG2Aw4joWSUkfFH4/bP4gS0AAYQnY2RHbpgZCbjuR/8qJs9NkOV0J0Op4P2aVw+pIzoMlL2zUSEJluv34IwzJIkNA8GC4aOj3BGbBoVbdP9GMjA1AMuRl2Ddk632WWWxckNAOGQr7k+2N5ETuk8HyYrKO2JzjDLsMWw+y2bWL0ntjfT7R+vT8SD8yfhdCKzYbjYV9lmwvBINnZEH3It3llO3wp2YmInrOyTZMWJUsgMt0+TAQWGAyxiTgK+Ve+a3Y/agYdXxTryU33iN3OCQrMWplTii9ZJxJyc+OyX5eYQnMjumzeoQQnI+udHB2yoiROr/HPY9+T7x58RUq7178Ntbj9uIOlBvBQnyq5PWyySm6zXUYdzTPtrM/KHhr53ww7JrGmHUZ+XP/NzvHTyc2urNRDrbPgeoMVWmHkFHOHD/mswHMK9fnhY98H23NOq16ceRJn1o4gMlpxfrlo1Q+obu4gMgbAThZZdWo+1yjoaX3VXmSr1bwdwApfmYFqbudX/w/YZwp8Q+Oron/Oynk9jxW+Kva87BpWy+fBCpfdPEAq/r/sy3CxeUpnxtWjL+hNf21VZLtyk8F5rbesOjWxX1H1tffc1GnvS41cQnVWuIfmunP8e7mW337L+q/rjAf0hlZnNYkPGeHCrxUaSALnsUMlY91qgfEp3610CE/BCJXYPS41FrP12u48aJvn2ka7tntlUF8mtMRXELUjFf44OEajABD1Ta4+3394v1ue9D0dd/plNEMjaDo8IBFIOjN8GrpKCVmFLS8yO5bjYaujeGVVcAlJvXpd9Z9rPQPlJDUm1Vhjot/hPgOp/yb3jIj2VT9Nn8FTi7wKmkP/UdMzYA7ME6fTsRT6eoNstbIOZyT5KthK5uKIM8BK4u6IGVEdS6KicwZSIzMXntFvpp6BNeb91EvwcDd+nIdz7t6Pi9Dol4DfX5Qo++Iz4SqlugbNPk0CufmQUHfDnMcxdEPMJSjusrL8i6qDn4cCROfDU9/8wt0Zcx6UKT8fsgvH14h7dS5CM2F89cXnw/X5gkTdiV2OIxBp4LvdhNG/ebb/NuEb2Ig2Xb+QyJs5neoMWAFtphnhTjgGbPZFBiF8WTT/dfXDeWluI7tyvLf+29RZOE+53KzU9c41sIV+e0XJf2l++12qdbZqUTf5u+ssHt2Fn7xNg/jLl8VjK6F/0H/QzYSzeBSLIH4beKiVQK08Z/HoEa081Mp3Fo8+0cpHrQIOWICahc7iMSCUhahV5Cwew4WXvE0j3CxCzWJn8RgRymLUKnEWjzHRKkGtUmfxmFD4U+xY5eeU8qxBgGbApRpiDoRythCUZYF5EMrhguJLYCqEcrmgKBOYDKG8Lig6BOZDKL+LkGqIGRHK9SJaBN5bXxgtMStCuV9QvAhMjFAEiIRqiKnxFAOC4sbD3HiKAY/ixjPGhx4g1DjyMDWeIsAjhxKmxlMEeBQ1HqbGUwR4FDUepsZTBHgUNR6mxlP+96jh4mFmPOV/j2LGw8x4yv9eQpHtYWp8RYCXUi19zI2vGPApbnzMja8Y8ClufCN96fxFceNjbnzFgO+TIDE5vqLAp8jxMTm+osCnyPExOb6iwKfI8TE5vqLAp8jxMTm+YsCnho2PuQkUAT41bAJMTaAICChqAkxNoAgIKGoCTE2gCAgoagJjclH+D6hhE2BmAj2/UMwEmJlA+T8IKbIDTE2gCAgoagJMTaAICChqAkxNoAgIyHETYG5Cl20ZYnJCwU2ZISYn1ORQdIeYnFBREFJ0h5icUFEQChKkMfkrDkKK7xCzE+oFADkUQ8xOqDgIyRUFZidUHITUUAwxO6GiICSnsBCzE7lsywizE7HsRJidSHEQxqRKTE+k6aHGd4TpiQJ2gRFheqKQb2msz/gFGqYnivn+YH4izQ85RUSYoCjlW2KCYpeDGWN+YsGGcIwJij02MmNMUKxoiKjxE2OCYsVCRKXLGPMTKxIij+InxvzEEd/SWELHrIswP7EiIaJScIzpiRUHETUiY8xOojiIqBGZYHYSRUFEZeAEk5MoBiJyrY+5STQ31OBJMDeJ5obKlgnmJlEExBTbCaYmUf6PKbYTzEyi/B9TyTIx9jd6g0Mxk2BmEuX/mGImwcykyv8xxUyKmUmV/2OKmRQzkyr/xxQzKWYmVf6PKWZSzEyq/B9TzKSYmVT5P6GYSTEzqfJ/QjGTYmZS5f+EYibFzKTK/wnFTGpsPvXuk2ImNbefioCE3Im5xg7UVRQkFDn1T7CpIiEhN2OusQl1FQ0JuR1zjW2oq4hI6M2ysRF1FRUpuV12ja2oq8hIyeKGa2xGXUVHSu6YXWM36ipCUnLP7Br7UVdRkpK7Ztdgq64WkGz16gWKkpRky6wY6LpASrJllgx0ZSAl2TKLBro2kJJsmWWDum7g0tUNg666dOCSfJnFg7p64JKEmeWDun7gkoyZFYS6hOCSlBlFBFFXEVySM6OOILy6yEOS5pllHl3ncUnWjGqC0EUD4ZK0GQUFoesGwiV5M2oKwqsXeCRvRllB6OqBEOSaSBilBaErCGxjgzldRRCCXJ0Io8QgdCGBbWxwp2sJgq58GXUGocsJgi5+GaUGoSsK5CJJ+GaNTlNHl8qMeoPw65U5GT5GxUH4NXVk+BhFB+HX1JHhY9QdhF8zR4aPUXoQusIgyMKZMKoPQhcZBFk7E0YBQug6gyDLZ8KoQQhdahAeuQAXRh1C6HID29hgLqjLq2RABGaBVTNHVt2EUZEQuvAgyMKbMIoSImD3VcKoSghdfCAL1sKoS4ig5o2MHaM0IQK2Di6M2oQI2d2VMIoTIqxZIyPSqE8IXYagy3DCKFGIsOaMjF6jSiHCuipORm9o1sU1Z2R1URilCqELEoIsMAqjWCF0TUL4ZIIy6hVClyXoCpUwShZCFyaYsrtRtBC6NCHI6qUwyhZCVycEWcAURuVC6PoEXQ0WRu1C6BKFIOudwihfiLp+QZY8hVHAELpMQdeZRWQeadS8kTFpVDFEVPNGxplRxxC6WkGehAmjkCF0uYLepgujlCFid2AibMoZ+rBRXUIum3sY1LFhtlq1l4j/cL42h5GJ256F/nDS0Ln68fNnd/io/k+pVw9FNW/mAUkBJCNesjo9T9/JqvnrJKymLUa6+7JtJwsAu6rlwgnqf5RXGT3Hap+vdsv2YvZOWQBwBJx432vdwfwPJ0hr86E7KF5f6NepiKJORSIGRbEcQJx4rFxzgQyQC4EcDxU80tnJAtGo6ayo/43af5u/xw0lcdxw4nvNfwRNC8H76fThSxAogG3BegldYA1gAxeHDUsRZ72+FhYIg/AOmwiLOQT6A6JbfSVfpyEF0Fmr3QPzhXpgfqsemAfd757T++GoxQejpf7gIolCAPIEN0zrz0fS8hABN1Db528h8gTKcY5TD7Rv6wfaoWwEe80Z1U9fH4uNVA9qQ2mYW9hB3XxEghgpAbAexIx4+34cnd0gfj9gVVRLw9kxCPeE67eW6+VxD2RjHnQj2VwGDsR9IM657CRu5rIExEianpPGojA8XW6YaNkeUQl0s8uFWCd7qF8eAgpgpLhcMlUK6lf5D9la7pprWoAWGOkuN0Y7LcRUilLFQLz0khSgLWxT8EA/lPwf33vsh4C/cCB4anH9XQswsYCYjQd6v4JXhoKQB3k24fLTWlZP6qKr2nU9/CmcJdyBcVPfNAyMg44nA4HbvVoNR7kPR/lA6BoOC8FQDQfAbjK+wwJ2eMBrm7zsdTr1oPAA3Tv5jQn5FE4K7oDjlIp+vKfQc+5Auqkt758O9ZVRQANMG+zsupYK/+m2JyAOMwe7rlDiZsqIgfOSAd8d9mVvtAYAdLccGuj+obkWgyEBZi8xMOpbNQQRMHWJgcF7qL9h20l6IAK9Adv/6a7KBU4E/CcD/ScAw0wpBjLl6aJmuJZEi8mBkdcIL+sLj6AGOO7Y1VSnYQNuKYJqYPyLsw4oK3X9EoEGDmQxEIxF+/1dwB+A4A35sb3yF7AHwjgdGHqn91YAZDju2i1COJA/Sv0wNbG89GEGYhf1a1nRCzQY9/4Aj+AWBygOo9AfcLx6iBgKwhE7QLt6vSZbG/teaNQb6HD7cDEkGzjL4+L+OSv7y0p1TtFBZge6kuUWN+r4AqjgksxzVpr5MgKjLeZitJHrr2lAlLI51pwaI+ComAvL56xsZ0bcTxiS4ow05ScYVeyYfM5KOC1gDXBWZGMEaCBQoB33ULCQA8uD0j7n9j5ZIEQiLkLoRRh0us/N5Hkp62u0QRYDqSjl5Q7ZIf+6PH2N8uux2Hzd5C8IBEjD3AChFe2x90BKZn1A6unNznCa4jW193sDp4AQTLkIzMuyvRMdSII8kfJe6G5mqJbP5ugTcFGhDodGaekt0dQBEigAcMMgL6vtoR8WIBJTjgVzQQ+CPuRk2g8PguUgcHbIuUx/MAqYAm6OmtJaxE1A/YqYgA5uxZviVsSN9eZNZhCnMFDb4utQD3KV8ZpPSgM1YOiyJeD2e9BADCQ5durWbzvDkIC5leVIvZYM1xgwmYXccNCfzwFTCHBOzCXAft4NAcC6jr1wIm4EMLvCCMRuwvWRWBhHwHbCdhO8Hg19BCOK3c2ePq0NaAT5l11CNXLZZtPdimfsBH3QaTZlNHrqibdThPSAkcVOXPojz2p19qI/8gzGMgiVgEu5xeltNeB7kKvisOY9bveGAwGALzWEIxwN8VaTx3uYuUoQqoT51EtalU1FXcRchqWu0oFjEu6CguYgQZ3Gc9qOpST2FLBYPNBNdUVpHfubvDT2UXBX4nHsldkLaR6kI49LR9RWyIdeDXnJalnIldoBZRsc+IBon3OaEmdORxCrXLYoVd1Of5GbUID44xX05g/hozMJ1uGyMtI4PFM4hV800PfD6T1qaB3Sza42S6roAUY5Hyf0fhsuEgdsdmnWWGAJmKBENODvWkV+IJTAGY1dLCsV+43kwg50xB/oCDVUwDzjuy193JxRDu3+4ZYyGhg7xgYcHg15XJJvUjw2CNcP7IKr5LbuEC6X05mZBVpm17L4EiRwsAAWs21+bcsuAQtEK1NVH2PlBU8JBmUNr8MTa0aOqbPAPMEGG7i4C2Y3KBtww+WICw5gLuYEStkkxG4PpphDeSoAY4Q9tD2W8jlfPx9k8bQvtmpjO6QRJHt2hjyWUm1N61GDpAFz7HHqsZT7ihIGaZ73Y2/AwMmBPlP6snAO+UFu8p10rh6//Pz5XwHnG9rkmAAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8WdWY/cuBGA/4v82vGK1D1vzqyDGPF6JuPxIsHAMLTdnB5h+4qk9gHD/z2gjlaRVeoptuTkyca06iD5sUhW6fjulfsvlXf18N37s9itvCu58Hb5VnlXXn4olptC7Wpv4R3LjXflbfer40ZVv5x+eflUbzfewltu8qpSlXfleT8WvaZgUPXm/e2r2zefrm/evXt9ff/m5t2nD3dvP93e3fzr3yfln/OyyP8w1Z+RI0wvvENean+h7w7+vH3z++sL3NFiP8Gbm/tLnLm5v8AXIdOTM69u31ybo97pAaZP11xgypfhyVa1X/6p6vtiq/ZHvr0Xttgz1gdx4Eckhv5f7ndVXR6X9b7kO2EKXeKC9MOh2ytVXx+rer99u1+vlYMfWHAOX35Vj/lxU1/gjC052Ru10+T/qv44rn/brxTfGSw42ZdVUV3oDCE52Zu1qt+rqir2O74fhswcHny4e+tkvb1+DkY/VKp8tXaJVC8sqVna7+7FemYvKlXflvuv35z6oZeYow8cra9ntF6p+k49qtIxSg0yc7Tf2YP13B78rkrnODDITB+F/LNyDkWm0GQfSnWs3J2wpGaJSy4RsZozIt7c3zpZbq+fw7L74M+6DjUzeruv1ZvbV6tVqarKMRrYsrPs50q1Uru6yDdu3phys/TNfqMu9QbLTvZos18XDqj0l89j9/XXWu1WauVoH4jN4YfTeed0/Qwx8j9HVTmYHgTmsv1Ofa3vVHXY7yp1m68dttDjCuby7dVmAzU7TJRxBXPtdH8v1BfnjW4nNEP/XOSFLTbZj2Ol/l6sn25V+bgvt/luqa73u51a1sV+917VxwPfN46qOfztzsNT/BxVMYd/N/ev33+rarV1cglKzeGFzqFd4IYhNstJ5ub9/a95nbsdZgahi3wAiajNcTusjH26tf3z2VwrzOBdm1r6FnRarseUAX87P9yzZdgGK09miI0lCzdqt66fOCZPV7pZs1n4h8JnWsLa6cpp1kjqaHNnWXOx99dvb3Yr9dXB7CDhaH3Ap0lWbszE4ol08COf93N5U0MjvPKZGQC9vGAenLXKmxNjKs7sKl39aEUm2D8ZLwyO+uFs/np2HCV0nyLCkYURCjotnJG/eMyxDdY4G2IuY0vYOzeeo3bAJm+5L1doBNo/s0fgztTSe9tpuRtTBjzt/HAfAWyDNQKGmGuEJmw+F6Fd7P31G7UKjRvtr3e0DDf6zemFoKD9wYEDS9PgfKfpblyl4XOn5xIeKEtMJizRsV1JmePz0Ijd9tLBXl2t/lJUfzmU+1ot6ya14G7/Ka/wnmjEge7a6R7YpF5TpbARJ4bL3XsezRBVLcviUFOZx3HzptR0L243OZHOGrffXz/d8j+P6qjqYuvS+VBmugd/d8BvuHy63bvjzrHdg8RE60X1uiz50Wa4fLLd98flkkptj1oeBCbbvt8eHJsNJCZbv1W7VbHDe6BR44PARNv5ajVynh6xDQWm2x7dTY3ZPglMn2Nu7YYCc9mmT6fPOXD+hOruxT/UN/acs4Xm8sHdgbmsb7f5jg2gITGbddcF1hKbwY9jqaV0Sv/dcfsHccA84wwhO5tHbuGBkJvuyd+Ksur0uU5XQnS6P2/zS93BkjN4U1SueyQgMt1+WyxzhMQQmseHi6YOEpzBl0bVzSNd3jvjiiU3w6khXxe73PHoYgjN4EOpPhf7Y3XR6JDC8/nkTC0SnOGU4erD7LZdGB0kZrN+vT8SNzY+60IvNpsf9/s631zojCE7m0dvi21Ru05fSnaiR0951YdJhzQQEJluHwYCBx8ssYl+lOpLsetOP3oFZSflsNwFnqD86SEvK6KaYf7MfXpmuKXEUDo8FGKpNa/npVc7h8+1qVbbwyav1Tbf5VSpZuQ654zxfSf/m2XHHknbzog8r/1248YDwJtdVevbRWbx64Wp0MnHMcVjqeJefHxNcfIcqpvbb6vPd6rM69Plc3U80vpTW5GvVvM2wFT4k0egnrvz6/+D7zOBb2n8qd4/5dW8PW8q/Km+F9VwYb18OnsMdmoDrfh/2ZbzGakpjeElrS5oDV7Oy3xXbXJYOEUr+ekS90Uca0fdNGjHUsxVe7AyMnD9FWemz7NuvIBKuA4RysZ8fCx2q2bwp/gIlbhVeLk+u5bdGU67lOLZXWs9Xrzc7x6LNWIc/niW7jgEA/VVrT7cvX29W570PR53zT25lkZw6XmUDSfpOfW+ueTabEff24ZVeOVFZrljfN4qa1xHVVxye+4z/nBu0r3En7HHnp5357mHny7yprkT+vWuLmp8zxDDJVN8Jr8qpZ8FJ1bLZxwCcvN5Qj0g97wf5x6Tu8SL27yqvlCJxeddAaLz+dM+/jb24NzzTtny83l24fxiPFx4kTcT5hcWn8+vDxWRJXnen07scj9CkYWBPyyP+NUh+EbgF/Ai2nR7L/G4GXRnIWEFXDPNyFgy6oxNLHLWhY+L7n9X373P3SPZV558GbzMvIX3WKjNSr+fp3Vs4S33223be6v98tj892N32e9KL7j64vbqX3xv8eAvgvhlmmYfPy4eeuHmh+YPvY7hL42g8BYPYhFGL4NYGoICCQpDUHqLB0kJSiQoDcHAWzwElGCABANDMBxrY4gEQ0Mw8hYPIWUxQoKRIRh7i4doIdOXvogNwRgJxoZg4i0eYspiggQTQzD1Fg8JJZgiwdQQzLzFQ0oJZkgwMwHQPGQkAZgdYcHT0OMvQv+ljEJTmODHBEhoLATNHmZImBAJjYYg+ROYI2GCJDQegmRQYJaECZPQiAgSJ4F5EiZQQmMiIlIYMyVMqIRGRZBYCcyVMMESGhdBoiUwW8KES2hkBImXwHwJEzCpmREkYRITJk3CpGZG+qQwJkxaIaqJUSRhkohSJmFSMyMlxbbEhEmTMKmZkQEpjAmTJmFSMyNJwiQmTJqESc2MJAmTmDBpEiY1M5IkTGLCpEmY1MxIkjCJCZMmYVIzI0nCJCZMmoQFmhlJEhZgwgKTsEAzE5CEBZiwwCQs0MwEJGEBJiywFsJmJSRjWECshSZhgWYmoNdRTFhgEhZoZgKSsAATFpiEBZqZgCQswIQFJmGBZiYgCQswYYFJWKCZCUjCAkxYYBIWaGYCkrAAExaYhIWamSCj5nOICQtNwkLNTEiukiEmLDQJC+W4MCYsNAkLg7ENTIgBC63dlkYmJNEOiQ2XCVjYbLlItEMMWGgCFmpkQjJ4hhiw0AQs1MiEJNohBiw0AQs1MmFEWsaAhSZgYTYujAELTcAif2ykIsxXZPIVNXzFlOEI8xWZfEUNX+ScijBfkclXpJEJU9IyBiwyAYvCcWEMWGRt6aPR/iI29SZfUTzeX5ivyOQravgiI0GE+YpMvqJ0XBjzFZl8RdlokzFekYlX7I9OqRjzFZt8xZqYiFwhY8xXbPIVa2IiQR3bYsxXbPIVB+PCmK/Y5CsOR09vGK/YxCtu8CLjV4z5iq1TY3NsJJfmmDg4mnzFmpiIjF8x5is2+Yo1MRG5NMeYr9jkK274IpfmGAMWm4AlTfwiw0iCAUtMwJIGMHJpTjBgiQlY0gBGbv4SDFhiApZoZGIS7QQDlpiAJZqZmFwhE0xYYhKWaGZikrAEE5aYhCWamZgkLMGEJVZuoklOkIQlRHrCJCzRzMQkYQkmLDEJSzQzMZ0XwYQlJmGpZiamcyOYsNQkLNXMxCRhKSYsNQlLNTMxSViKCUtNwlLNTEISlmLCUpOwVDOTkISlmLDUJCzVzCQkYSkmLDUJSzUzCUlYiglLTcJSzUxCEpZiwlIrA9akwEjCUiIJZhKWamYSkrAUE5aahGWamYQkLMOEZSZhmWYmoTNwmLDMJCzTzCQkYRkmLDMJyzQzKUlYhgnLTMIyzUxKEpZhwjKTsEwzk5KEZZiwzCQs08ykJGEZJiwzCcs0MylJWIYJy0zCMs1MShKWYcIyK8/aJFpJwjIi1WrnWjU0KZ2F86l0q5Vv9TU3KZ2I84mMq2+lXH2NTjqS7SWSrr6VdfU1PRnJWvubLW8lXn0NUCbIhLFPpF59K/fqR2fkieyrb6VffY1RJqkNZfubLW9lYP3kjDyRg/WtJKyvYcrozLNPpGF9Kw/ra54yOvnsE5lY3+KvTfbT+Wcq3Y/y/ZqnjE5Bkxl/i78mi5/R/FNJfzvr3yTyM5p/Ku9vJ/6bXH5G80+l/u3cf5v89+kJQKX/7fx/WwDw6aoHVQKwawBtEcAn89KCKgPYdYC2EDCmgGDQrgW0xQCfhpgqB1j1ANEWBHyaYqIkIKyagGjS/OTJThBFAWFVBUST6Bc+makRRGFAWJUB0ST7hU9PA6I4IKzqgGgS/qMeEBxaFQIhR9MfgigRCKtGIJq0P53OFESVQFhlAiGT8bofUSgQVqVAyJZBOg4QxQJhVQuEbBmkAwFRMBBWxUC0JQN6EhA1A2EVDUTQVj7pSELUDYRVOBBBW/2kIwlROxBW8UA09QC6xCSI8oGw6geiKQmIkforUUIQVg1BNGUBMVaDJSi06giiKQ2QBX1BFBKEVUkQTXGATg4JopYgrGKCaOoDI2s5UU7o/9bcxPFZlbXqHh7X92Dkq1X/Rs/v3qfuJo/hdtLvXpJ4V99//Bhu6rj6/gPc16F/09ZyfWdV+2Ap0BMBPSlXT32693/QlMWDJr02s1QN34YaFPmDHr+VC9t/9ChxtOLeCoHOUHRKJVMZuAd10Ai6Le70Be2/Ued0FHX/Zu2/cd8KKfr/RDwPjFddgkYBH8K0cyJjqew+I7PSn5HZNq/RAuMIhtFnaWu/kEMqSwdlPM/0/efb9v7zQYvwAe16xeZp+qpWx3Kj9F3WUBfkVAYsXf1TXiT3EeSe59ta3xNn9lQEmhjzJnSjBQUG0LyE1+cnPd3rN4GyZFCWOjRNK/uzeXUN0AVYSHnh4aTLVAQITXmTuFHUvVBmUJSAqJByQegVHdonbIA2AbSFbG3tm1QO+VrturcfAJUSqOQFi0EljvVJANTxQula1avmbncQdoCWsIt9MZsNre2Pbwi0ENAfsulvlf2pX1UJJhIY1ZjN2Qq+zQ8og3GetzyuVf2o30jT9j9qaQJamrJb2r5zEfgFJlPCbmRxekQYhK8Axnt2E61ODwGpIZvUTT7eTaDjU7ZXm6JCXZWAgJiyA+JOfR2blHBNY3e91kfMSBBfM/Ycan3aPx7at8gAdSAyZuzIeABvgwErN5hGGTs4oqgYgd6P2b1/2Fco7gSgcaHfb6HYYezQvSeCHtQUBO+MHbx7nXhgUzAfMvZ8OLSfMwObFbi3YDf1P8O7OcFAANQSNmpEy0C8yNgulf1LZYAiEAgzdiDsFC3bF7EAbaCnMna86LRtwJtUgMoERkbHLqtq/b4Y7CaYDhl7OpT9R94AGdA5fnv7t5cCLsC0Stgxo+qfi4Eba7gP7ucne2Cr5rEW1T3WAtXClkp2U8mtOlQl2I0Fr6gAulKoix0g9WMfsHUCNo6tpFJlvraOzQIu5OwQ1j8qAhXBlvEYRdsT4EvMCxJPedWvucaEgc74vOX2Ka9gtDfUGadbXoc/5RUJE1TF7HC87wVERjx3ikq178MFJyIw9RIeikV1yA/Fp+XpY0CfjuXm06b4bLQRrGJc5yi1e7PnABxTnMWrJRgQrt7+Bb+gM4F7CY/doqr6VyQDPcCdhIlHNbyRoV4+2bNK14YAcrxthaUTbdB0vQgo5Ta43h4whgCXhOdd/40dMCOAOyGv25rvVQANYI2NuoUo4rWLSLKB+BP1GT62W2ZXSzDZmQtZo0OdPhoIdAG/JC9I99//A0pACAt4G5zm6wMg0IMhj3lDjreUIXAjSro+5vXP6cOCILqASRLw4kCnJd9shveYWUerADQ04EWtTmt78hvUGloB7AEvwjYfw9MbgM/Nx/CALrCfDrhD0T/eCkYUuBTLVjDuwNdlDhe9/evrwKIJg43fZ8R9N3fRG+SAfgn1x73+pPefSxV+tw2MmNCI6HUzd+HNl4KJ7bME2Eoutvqlg+182hTmLMjgUuHzgNVfUqY29mB6MnPvlaqX8GOvoJngnMY8vGtlIyUQmOvm6lq1n0HEymCum6sMxXhdNwY7el5krlS9rw9GN8Gd12n2sTv/cHq/A/QMbliZkbGikhKwGMObuRV9hoWVGPb4lc1rIvL+NRHwLAWZZ4bTk8LiQKiUoKnMap1WuN+oMfxBk5ln44o8bUuwS5Wn+ihznp85bRsH0oC30anQsVYCLZI9EEdrsRACBlrmmlaNHY8NXS6q0EILzy/MHjJeIQXnJEzwyW65FdJFq07oWPs6QC2v0+gMB5znPi+SgVecwVbC1AQzpXCsVBeph2Nf1X6wFgwFmE7MvcmxUk/F+ukwfLD3nH4wPMybD46V0qfoqvucLNAFFoaA3Qf7mlIFlirOlubjwjsUB7Updsq7evj448d/AeI6RK6viwAA"; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 778b9492..9d619a64 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -10,6 +10,7 @@ --light-color-text: #222; --light-color-text-aside: #6e6e6e; --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; --light-color-ts-keyword: #056bd6; --light-color-ts-project: #b111c9; @@ -35,6 +36,7 @@ --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-external-icon: url("data:image/svg+xml;utf8,"); --light-color-scheme: light; @@ -50,6 +52,7 @@ --dark-color-text: #f5f5f5; --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; --dark-color-ts-keyword: #3399ff; --dark-color-ts-project: #e358ff; @@ -75,6 +78,7 @@ --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-external-icon: url("data:image/svg+xml;utf8,"); --dark-color-scheme: dark; @@ -92,6 +96,7 @@ --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); @@ -116,6 +121,7 @@ --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); --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); @@ -134,6 +140,7 @@ --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); @@ -158,6 +165,7 @@ --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); --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); @@ -183,6 +191,7 @@ body { --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); @@ -207,6 +216,7 @@ body { --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); --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); @@ -223,6 +233,7 @@ body { --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); @@ -247,11 +258,17 @@ body { --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); --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; @@ -266,16 +283,6 @@ h6 { line-height: 1.2; } -h1 > a:not(.link), -h2 > a:not(.link), -h3 > a:not(.link), -h4 > a:not(.link), -h5 > a:not(.link), -h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); -} - h1 { font-size: 1.875rem; margin: 0.67rem 0; @@ -306,10 +313,6 @@ h6 { margin: 2.33rem 0; } -.uppercase { - text-transform: uppercase; -} - dl, menu, ol, @@ -333,7 +336,7 @@ footer { padding-bottom: 1rem; max-height: 3.5rem; } -.tsd-generator { +footer > p { margin: 0 1em; } @@ -421,6 +424,9 @@ a.external[target="_blank"] { background-repeat: no-repeat; padding-right: 13px; } +a.tsd-anchor-link { + color: var(--color-text); +} code, pre { @@ -580,13 +586,13 @@ dl.tsd-comment-tag-group p { } .tsd-filter-input { display: flex; - width: fit-content; width: -moz-fit-content; + width: fit-content; align-items: center; - user-select: none; -webkit-user-select: none; -moz-user-select: none; -ms-user-select: none; + user-select: none; cursor: pointer; } .tsd-filter-input input[type="checkbox"] { @@ -609,11 +615,8 @@ dl.tsd-comment-tag-group p { Don't remove unless you know what you're doing. */ opacity: 0.99; } -.tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); -} -.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); +.tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); } .tsd-checkbox-background { fill: var(--color-accent); @@ -630,13 +633,18 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { stroke: var(--color-accent); } -.tsd-theme-toggle { - padding-top: 0.75rem; +.settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; } -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; + +.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 { @@ -769,6 +777,9 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { padding: 0; max-width: 100%; } +.tsd-navigation .tsd-nav-link { + display: none; +} .tsd-nested-navigation { margin-left: 3rem; } @@ -782,6 +793,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { 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; } @@ -812,10 +832,10 @@ a.tsd-index-link { } .tsd-accordion-summary, .tsd-accordion-summary a { - user-select: none; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; + user-select: none; cursor: pointer; } @@ -828,8 +848,9 @@ a.tsd-index-link { padding-top: 0; padding-bottom: 0; } -.tsd-index-accordion .tsd-accordion-summary > svg { +.tsd-accordion .tsd-accordion-summary > svg { margin-left: 0.25rem; + vertical-align: text-top; } .tsd-index-content > :not(:first-child) { margin-top: 0.75rem; @@ -877,7 +898,7 @@ a.tsd-index-link { } .tsd-panel-group { - margin: 4rem 0; + margin: 2rem 0; } .tsd-panel-group.tsd-index-group { margin: 2rem 0; @@ -885,6 +906,9 @@ a.tsd-index-link { .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; @@ -1034,6 +1058,12 @@ a.tsd-index-link { 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; } @@ -1347,6 +1377,12 @@ img { .has-menu .tsd-navigation { max-height: 100%; } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } } /* one sidebar */ diff --git a/docs/classes/apiclient.APIClient.html b/docs/classes/apiclient.APIClient.html index 39de7904..1aed544f 100644 --- a/docs/classes/apiclient.APIClient.html +++ b/docs/classes/apiclient.APIClient.html @@ -1,16 +1,8 @@ -APIClient | @hexonet/ispapi-apiconnector

Class APIClient

APIClient class

-

Constructors

constructor -

Properties

curlopts -debugMode -logger -socketConfig -socketURL -ua -socketTimeout -

Methods

autoIDNConvert -disableDebugMode +APIClient | @hexonet/ispapi-apiconnector

Class APIClient

APIClient class

+

Constructors

constructor +

Properties

socketTimeout +

Methods

disableDebugMode enableDebugMode -flattenCommand getPOSTData getProxy getReferer @@ -43,114 +35,102 @@ useHighPerformanceConnectionSetup useLIVESystem useOTESystem -

Constructors

constructor

Properties

Private curlopts

curlopts: any

additional connection settings

-

Private debugMode

debugMode: boolean

activity flag for debug mode

-

Private logger

logger: null | Logger

logger function for debug mode

-

Private socketConfig

socketConfig: SocketConfig

Object covering API connection data

-

Private socketURL

socketURL: string

API connection url

-

Private ua

ua: string

User Agent string

-

Static Readonly socketTimeout

socketTimeout: number = 300000

API connection timeout setting

-

Methods

Private autoIDNConvert

  • autoIDNConvert(cmd): Promise<any>

  • Auto convert API command parameters to punycode, if necessary.

    -

    Parameters

    • cmd: any

      api command

      -

    Returns Promise<any>

    Promise resolving with api command with IDN values replaced to punycode

    -

disableDebugMode

  • disableDebugMode(): APIClient

  • Disable Debug Output

    +

Constructors

constructor

Properties

Static ReadonlysocketTimeout

socketTimeout: number = 300000

API connection timeout setting

+

Methods

disableDebugMode

enableDebugMode

enableDebugMode

Private flattenCommand

  • flattenCommand(cmd): any

  • Flatten nested arrays in command

    -

    Parameters

    • cmd: any

      api command

      -

    Returns any

    api command with flattended parameters

    -

getPOSTData

  • getPOSTData(cmd, secured?): string

  • Serialize given command for POST request including connection configuration data

    +

getPOSTData

  • getPOSTData(cmd, secured?): string

  • Serialize given command for POST request including connection configuration data

    Parameters

    • cmd: any

      API command to encode

    • secured: boolean = false

    Returns string

    encoded POST data string

    -

getProxy

  • getProxy(): null | string

  • Get the proxy server configuration

    +

getProxy

  • getProxy(): null | string

  • Get the proxy server configuration

    Returns null | string

    proxy server configuration value or null if not set

    -

getReferer

  • getReferer(): null | string

  • Get the referer configuration

    +

getReferer

  • getReferer(): null | string

  • Get the referer configuration

    Returns null | string

    referer configuration value or null if not set

    -

getSession

  • getSession(): null | string

  • Get the API Session that is currently set

    +

getSession

  • getSession(): null | string

  • Get the API Session that is currently set

    Returns null | string

    API Session or null

    -

getURL

  • getURL(): string

  • Get the API connection url that is currently set

    +

getURL

  • getURL(): string

  • Get the API connection url that is currently set

    Returns string

    API connection url currently in use

    -

getUserAgent

getUserAgent

  • getUserAgent(): string

  • Get the User Agent

    Returns string

    User Agent string

    -

getVersion

getVersion

  • getVersion(): string

  • Get the current module version

    Returns string

    module version

    -

login

login

  • login(otp?): Promise<Response>

  • Perform API login to start session-based communication

    Parameters

    • otp: string = ""

      optional one time password

    Returns Promise<Response>

    Promise resolving with API Response

    -

loginExtended

  • loginExtended(params, otp?): Promise<Response>

  • Perform API login to start session-based communication. +

loginExtended

  • loginExtended(params, otp?): Promise<Response>

  • Perform API login to start session-based communication. Use given specific command parameters.

    Parameters

    • params: any

      given specific command parameters

    • otp: string = ""

      optional one time password

    Returns Promise<Response>

    Promise resolving with API Response

    -

logout

logout

  • logout(): Promise<Response>

  • Perform API logout to close API session in use

    Returns Promise<Response>

    Promise resolving with API Response

    -

request

request

  • request(cmd): Promise<Response>

  • Perform API request using the given command

    Parameters

    • cmd: any

      API command to request

    Returns Promise<Response>

    Promise resolving with API Response

    -

requestAllResponsePages

  • requestAllResponsePages(cmd): Promise<Response[]>

  • Request all pages/entries for the given query command

    +

requestAllResponsePages

  • requestAllResponsePages(cmd): Promise<Response[]>

  • Request all pages/entries for the given query command

    Parameters

    • cmd: any

      API list command to use

    Returns Promise<Response[]>

    Promise resolving with array of API Responses

    -

requestNextResponsePage

  • requestNextResponsePage(rr): Promise<null | Response>

  • Request the next page of list entries for the current list query +

requestNextResponsePage

  • requestNextResponsePage(rr): Promise<null | Response>

  • Request the next page of list entries for the current list query Useful for tables

    Parameters

    • rr: Response

      API Response of current page

    Returns Promise<null | Response>

    Promise resolving with API Response or null in case there are no further list entries

    -

resetUserView

resetUserView

reuseSession

reuseSession

  • reuseSession(session): APIClient

  • Use existing configuration out of ClientRequest session to rebuild and reuse connection settings

    Parameters

    • session: any

      ClientRequest session instance

    Returns APIClient

    Current APIClient instance for method chaining

    -

saveSession

  • saveSession(session): APIClient

  • Apply session data (session id and system entity) to given client request session

    +

saveSession

  • saveSession(session): APIClient

  • Apply session data (session id and system entity) to given client request session

    Parameters

    • session: any

      ClientRequest session instance

    Returns APIClient

    Current APIClient instance for method chaining

    -

setCredentials

setCredentials

  • setCredentials(uid, pw): APIClient

  • Set Credentials to be used for API communication

    Parameters

    • uid: string

      account name

    • pw: string

      account password

    Returns APIClient

    Current APIClient instance for method chaining

    -

setCustomLogger

setCustomLogger

  • setCustomLogger(customLogger): APIClient

  • set custom logger to use instead of default one

    Parameters

    Returns APIClient

    Current APIClient instance for method chaining

    -

setDefaultLogger

setDefaultLogger

setOTP

setOTP

  • setOTP(value): APIClient

  • Set one time password to be used for API communication

    Parameters

    • value: string

      one time password

    Returns APIClient

    Current APIClient instance for method chaining

    -

setProxy

setProxy

  • setProxy(proxy): APIClient

  • Set the proxy server to use for API communication

    Parameters

    • proxy: string

      proxy server to use for communicatio

    Returns APIClient

    Current APIClient instance for method chaining

    -

setReferer

setReferer

  • setReferer(referer): APIClient

  • Set the referer to use for API communication

    Parameters

    • referer: string

      Referer

    Returns APIClient

    Current APIClient instance for method chaining

    -

setRemoteIPAddress

setRemoteIPAddress

  • setRemoteIPAddress(value): APIClient

  • Set an Remote IP Address to be used for API communication To be used in case you have an active ip filter setting.

    Parameters

    • value: string

      Remote IP Address

    Returns APIClient

    Current APIClient instance for method chaining

    -

setRoleCredentials

setRoleCredentials

  • setRoleCredentials(uid, role, pw): APIClient

  • Set Credentials to be used for API communication

    Parameters

    • uid: string

      account name

    • role: string

      role user id

    • pw: string

      role user password

    Returns APIClient

    Current APIClient instance for method chaining

    -

setSession

setSession

  • setSession(value): APIClient

  • Set an API session id to be used for API communication

    Parameters

    • value: string

      API session id

    Returns APIClient

    Current APIClient instance for method chaining

    -

setURL

setURL

  • setURL(value): APIClient

  • Set another connection url to be used for API communication

    Parameters

    • value: string

      API connection url to set

    Returns APIClient

    Current APIClient instance for method chaining

    -

setUserAgent

  • setUserAgent(str, rv, modules?): APIClient

  • Possibility to customize default user agent to fit your needs

    +

setUserAgent

  • setUserAgent(str, rv, modules?): APIClient

  • Possibility to customize default user agent to fit your needs

    Parameters

    • str: string

      user agent label

    • rv: string

      revision of user agent

    • modules: any = []

      further modules to add to user agent string, format: ["/", "/", ... ]

    Returns APIClient

    Current APIClient instance for method chaining

    -

setUserView

setUserView

  • setUserView(uid): APIClient

  • Set a data view to a given subuser

    Parameters

    • uid: string

      subuser account name

    Returns APIClient

    Current APIClient instance for method chaining

    -

useDefaultConnectionSetup

useDefaultConnectionSetup

  • useDefaultConnectionSetup(): APIClient

  • Activate Default Connection Setup (the default)

    Returns APIClient

    Current APIClient instance for method chaining

    -

useHighPerformanceConnectionSetup

useHighPerformanceConnectionSetup

useLIVESystem

useLIVESystem

  • useLIVESystem(): APIClient

  • Set LIVE System for API communication (this is the default setting)

    Returns APIClient

    Current APIClient instance for method chaining

    -

useOTESystem

useOTESystem

Settings

Member Visibility

Theme

On This Page

constructorcurloptsdebugModeloggersocketConfigsocketURLuasocketTimeoutautoIDNConvertdisableDebugModeenableDebugModeflattenCommandgetPOSTDatagetProxygetReferergetSessiongetURLgetUserAgentgetVersionloginloginExtendedlogoutrequestrequestAllResponsePagesrequestNextResponsePageresetUserViewreuseSessionsaveSessionsetCredentialssetCustomLoggersetDefaultLoggersetOTPsetProxysetReferersetRemoteIPAddresssetRoleCredentialssetSessionsetURLsetUserAgentsetUserViewuseDefaultConnectionSetupuseHighPerformanceConnectionSetupuseLIVESystemuseOTESystem
\ No newline at end of file +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/column.Column.html b/docs/classes/column.Column.html index fc109b64..c3006394 100644 --- a/docs/classes/column.Column.html +++ b/docs/classes/column.Column.html @@ -1,23 +1,15 @@ -Column | @hexonet/ispapi-apiconnector

Class Column

Column class

-

Constructors

constructor -

Properties

data -key -length +Column | @hexonet/ispapi-apiconnector

Class Column

Column class

+

Constructors

constructor +

Properties

length

Methods

getData getDataByIndex getKey -hasDataIndex -

Constructors

constructor

Properties

Private data

data: string[]

column data container

-

Private key

key: string

column key name

-

length

length: number

count of column data entries

-

Methods

getData

  • getData(): string[]

  • Get column data

    +

Constructors

constructor

Properties

length

length: number

count of column data entries

+

Methods

getData

  • getData(): string[]

  • Get column data

    Returns string[]

    column data

    -

getDataByIndex

  • getDataByIndex(idx): null | string

  • Get column data at given index

    +

getDataByIndex

  • getDataByIndex(idx): null | string

  • Get column data at given index

    Parameters

    • idx: number

      data index

    Returns null | string

    data at given index

    -

getKey

getKey

  • getKey(): string

  • Get column name

    Returns string

    column name

    -

Private hasDataIndex

  • hasDataIndex(idx): boolean

  • Check if column has a given data index

    -

    Parameters

    • idx: number

      data index

      -

    Returns boolean

    boolean result

    -

Settings

Member Visibility

Theme

On This Page

constructordatakeylengthgetDatagetDataByIndexgetKeyhasDataIndex
\ No newline at end of file +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/customlogger.CustomLogger.html b/docs/classes/customlogger.CustomLogger.html index 37a4ea08..3de70978 100644 --- a/docs/classes/customlogger.CustomLogger.html +++ b/docs/classes/customlogger.CustomLogger.html @@ -1,9 +1,9 @@ -CustomLogger | @hexonet/ispapi-apiconnector

Class CustomLogger

Logger class

-

Hierarchy (view full)

Constructors

constructor +CustomLogger | @hexonet/ispapi-apiconnector

Class CustomLogger

Logger class

+

Hierarchy (view full)

Constructors

constructor

Methods

log -

Constructors

constructor

Methods

log

Constructors

constructor

Methods

log

Settings

Member Visibility

Theme

On This Page

constructorlog
\ No newline at end of file +

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/logger.Logger.html b/docs/classes/logger.Logger.html index a93ffe6d..b01a916d 100644 --- a/docs/classes/logger.Logger.html +++ b/docs/classes/logger.Logger.html @@ -1,9 +1,9 @@ -Logger | @hexonet/ispapi-apiconnector

Class Logger

Logger class

-

Hierarchy (view full)

Constructors

constructor +Logger | @hexonet/ispapi-apiconnector

Class Logger

Logger class

+

Hierarchy (view full)

Constructors

constructor

Methods

log -

Constructors

constructor

Methods

log

  • log(post, r, error?): Logger

  • output/log given data

    +

Constructors

constructor

Methods

log

  • log(post, r, error?): Logger

  • output/log given data

    Parameters

    • post: string

      request string used

    • r: Response

      Response object

    • error: null | string = null

      error message or null

    Returns Logger

    current Logger instance for method chaining

    -

Settings

Member Visibility

Theme

On This Page

constructorlog
\ No newline at end of file +

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/record.Record.html b/docs/classes/record.Record.html index 6b99888e..94b9fb11 100644 --- a/docs/classes/record.Record.html +++ b/docs/classes/record.Record.html @@ -1,18 +1,12 @@ -Record | @hexonet/ispapi-apiconnector

Class Record

Record class

-

Constructors

constructor -

Properties

data +Record | @hexonet/ispapi-apiconnector

Class Record

Record class

+

Constructors

constructor

Methods

getData getDataByKey -hasData -

Constructors

constructor

  • new Record(data): Record

  • Constructor

    +

Constructors

constructor

  • new Record(data): Record

  • Constructor

    Parameters

    • data: any

      data object (use column names as object keys)

      -

    Returns Record

Properties

Private data

data: any

row data container

-

Methods

getData

  • getData(): any

  • get row data

    +

Returns Record

Methods

getData

  • getData(): any

  • get row data

    Returns any

    row data

    -

getDataByKey

  • getDataByKey(key): null | string

  • get row data for given column

    +

getDataByKey

  • getDataByKey(key): null | string

  • get row data for given column

    Parameters

    • key: string

      column name

    Returns null | string

    row data for given column or null if column does not exist

    -

Private hasData

  • hasData(key): boolean

  • check if record has data for given column

    -

    Parameters

    • key: string

      column name

      -

    Returns boolean

    boolean result

    -

Settings

Member Visibility

Theme

On This Page

constructordatagetDatagetDataByKeyhasData
\ No newline at end of file +

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/response.Response.html b/docs/classes/response.Response.html index 2747d1df..8e6085dd 100644 --- a/docs/classes/response.Response.html +++ b/docs/classes/response.Response.html @@ -1,12 +1,7 @@ -Response | @hexonet/ispapi-apiconnector

Class Response

Response Class

-

Constructors

constructor -

Properties

columnkeys -columns -command -hash +Response | @hexonet/ispapi-apiconnector

Class Response

Response Class

+

Constructors

constructor +

Properties

hash raw -recordIndex -records

Methods

addColumn addRecord getCode @@ -37,125 +32,102 @@ getRecordsLimitation getRecordsTotalCount getRuntime -hasColumn -hasCurrentRecord hasNextPage -hasNextRecord hasPreviousPage -hasPreviousRecord isError isPending isSuccess isTmpError rewindRecordList -

Constructors

constructor

  • new Response(raw, cmd?, ph?): Response

  • Constructor

    +

Constructors

constructor

  • new Response(raw, cmd?, ph?): Response

  • Constructor

    Parameters

    • raw: string

      API plain response

    • cmd: any = {}

      API command used within this request

    • ph: any = {}

      placeholder array to get vars in response description dynamically replaced

      -

    Returns Response

Properties

Private columnkeys

columnkeys: string[]

Column names available in this responsse -NOTE: this includes also FIRST, LAST, LIMIT, COUNT, TOTAL -and maybe further specific columns in case of a list query

-

Private columns

columns: Column[]

Container of Column Instances

-

Private command

command: any

The API Command used within this request

-

Protected hash

hash: any

hash representation of plain API response

-

Protected raw

raw: string

plain API response

-

Private recordIndex

recordIndex: number

Record Index we currently point to in record list

-

Private records

records: Record[]

Record List (List of rows)

-

Methods

addColumn

  • addColumn(key, data): Response

  • Add a column to the column list

    +

Returns Response

Properties

Protectedhash

hash: any

hash representation of plain API response

+

Protectedraw

raw: string

plain API response

+

Methods

addColumn

  • addColumn(key, data): Response

  • Add a column to the column list

    Parameters

    • key: string

      column name

    • data: string[]

      array of column data

    Returns Response

    Current Response Instance for method chaining

    -

addRecord

addRecord

  • addRecord(h): Response

  • Add a record to the record list

    Parameters

    • h: any

      row hash data

    Returns Response

    Current Response Instance for method chaining

    -

getCode

getCode

  • getCode(): number

  • Get API response code

    Returns number

    API response code

    -

getColumn

getColumn

  • getColumn(key): null | Column

  • Get column by column name

    Parameters

    • key: string

      column name

    Returns null | Column

    column instance or null if column does not exist

    -

getColumnIndex

  • getColumnIndex(colkey, index): null | string

  • Get Data by Column Name and Index

    +

getColumnIndex

  • getColumnIndex(colkey, index): null | string

  • Get Data by Column Name and Index

    Parameters

    • colkey: string

      column name

    • index: number

      column data index

    Returns null | string

    column data at index or null if not found

    -

getColumnKeys

getColumnKeys

  • getColumnKeys(): string[]

  • Get Column Names

    Returns string[]

    Array of Column Names

    -

getColumns

getColumns

getCommand

  • getCommand(): any

  • Get Command used in this request

    +

getCommand

  • getCommand(): any

  • Get Command used in this request

    Returns any

    command

    -

getCommandPlain

  • getCommandPlain(): string

  • Get Command used in this request in plain text format

    +

getCommandPlain

  • getCommandPlain(): string

  • Get Command used in this request in plain text format

    Returns string

    command as plain text

    -

getCurrentPageNumber

  • getCurrentPageNumber(): null | number

  • Get Page Number of current List Query

    +

getCurrentPageNumber

  • getCurrentPageNumber(): null | number

  • Get Page Number of current List Query

    Returns null | number

    page number or null in case of a non-list response

    -

getCurrentRecord

getCurrentRecord

  • getCurrentRecord(): null | Record

  • Get Record of current record index

    Returns null | Record

    Record or null in case of a non-list response

    -

getDescription

  • getDescription(): string

  • Get API response description

    +

getDescription

  • getDescription(): string

  • Get API response description

    Returns string

    API response description

    -

getFirstRecordIndex

  • getFirstRecordIndex(): null | number

  • Get Index of first row in this response

    +

getFirstRecordIndex

  • getFirstRecordIndex(): null | number

  • Get Index of first row in this response

    Returns null | number

    first row index

    -

getHash

getHash

  • getHash(): any

  • Get API response as Hash

    Returns any

    API response hash

    -

getLastRecordIndex

  • getLastRecordIndex(): null | number

  • Get last record index of the current list query

    +

getLastRecordIndex

  • getLastRecordIndex(): null | number

  • Get last record index of the current list query

    Returns null | number

    record index or null for a non-list response

    -

getListHash

  • getListHash(): any

  • Get Response as List Hash including useful meta data for tables

    +

getListHash

  • getListHash(): any

  • Get Response as List Hash including useful meta data for tables

    Returns any

    hash including list meta data and array of rows in hash notation

    -

getNextPageNumber

  • getNextPageNumber(): null | number

  • Get Page Number of next list query

    -

    Returns null | number

    page number or null if there's no next page

    -

getNextRecord

  • getNextRecord(): null | Record

  • Get next record in record list

    -

    Returns null | Record

    Record or null in case there's no further record

    -

getNumberOfPages

  • getNumberOfPages(): number

  • Get the number of pages available for this list query

    +

getNextPageNumber

  • getNextPageNumber(): null | number

  • Get Page Number of next list query

    +

    Returns null | number

    page number or null if there's no next page

    +

getNextRecord

  • getNextRecord(): null | Record

  • Get next record in record list

    +

    Returns null | Record

    Record or null in case there's no further record

    +

getNumberOfPages

  • getNumberOfPages(): number

  • Get the number of pages available for this list query

    Returns number

    number of pages

    -

getPagination

  • getPagination(): any

  • Get object containing all paging data

    +

getPagination

  • getPagination(): any

  • Get object containing all paging data

    Returns any

    paginator data

    -

getPlain

getPlain

  • getPlain(): string

  • Get Plain API response

    Returns string

    Plain API response

    -

getPreviousPageNumber

  • getPreviousPageNumber(): null | number

  • Get Page Number of previous list query

    -

    Returns null | number

    page number or null if there's no previous page

    -

getPreviousRecord

  • getPreviousRecord(): null | Record

  • Get previous record in record list

    -

    Returns null | Record

    Record or null if there's no previous record

    -

getQueuetime

  • getQueuetime(): number

  • Get Queuetime of API response

    +

getPreviousPageNumber

  • getPreviousPageNumber(): null | number

  • Get Page Number of previous list query

    +

    Returns null | number

    page number or null if there's no previous page

    +

getPreviousRecord

  • getPreviousRecord(): null | Record

  • Get previous record in record list

    +

    Returns null | Record

    Record or null if there's no previous record

    +

getQueuetime

  • getQueuetime(): number

  • Get Queuetime of API response

    Returns number

    Queuetime of API response

    -

getRecord

getRecord

  • getRecord(idx): null | Record

  • Get Record at given index

    Parameters

    • idx: number

      record index

    Returns null | Record

    Record or null if index does not exist

    -

getRecords

getRecords

getRecordsCount

  • getRecordsCount(): number

  • Get count of rows in this response

    +

getRecordsCount

  • getRecordsCount(): number

  • Get count of rows in this response

    Returns number

    count of rows

    -

getRecordsLimitation

  • getRecordsLimitation(): number

  • Get limit(ation) setting of the current list query +

getRecordsLimitation

  • getRecordsLimitation(): number

  • Get limit(ation) setting of the current list query This is the count of requested rows

    Returns number

    limit setting or count requested rows

    -

getRecordsTotalCount

  • getRecordsTotalCount(): number

  • Get total count of records available for the list query

    +

getRecordsTotalCount

  • getRecordsTotalCount(): number

  • Get total count of records available for the list query

    Returns number

    total count of records or count of records for a non-list response

    -

getRuntime

  • getRuntime(): number

  • Get Runtime of API response

    +

getRuntime

  • getRuntime(): number

  • Get Runtime of API response

    Returns number

    Runtime of API response

    -

Private hasColumn

  • hasColumn(key): boolean

  • Check if column exists in response

    -

    Parameters

    • key: string

      column name

      -

    Returns boolean

    boolean result

    -

Private hasCurrentRecord

  • hasCurrentRecord(): boolean

  • Check if the record list contains a record for the -current record index in use

    -

    Returns boolean

    boolean result

    -

hasNextPage

  • hasNextPage(): boolean

  • Check if this list query has a next page

    -

    Returns boolean

    boolean result

    -

Private hasNextRecord

  • hasNextRecord(): boolean

  • Check if the record list contains a next record for the -current record index in use

    -

    Returns boolean

    boolean result

    -

hasPreviousPage

  • hasPreviousPage(): boolean

  • Check if this list query has a previous page

    +

hasNextPage

  • hasNextPage(): boolean

  • Check if this list query has a next page

    Returns boolean

    boolean result

    -

Private hasPreviousRecord

  • hasPreviousRecord(): boolean

  • Check if the record list contains a previous record for the -current record index in use

    +

hasPreviousPage

  • hasPreviousPage(): boolean

  • Check if this list query has a previous page

    Returns boolean

    boolean result

    -

isError

  • isError(): boolean

  • Check if current API response represents an error case +

isError

  • isError(): boolean

  • Check if current API response represents an error case API response code is an 5xx code

    Returns boolean

    boolean result

    -

isPending

  • isPending(): boolean

  • Check if current operation is returned as pending

    +

isPending

  • isPending(): boolean

  • Check if current operation is returned as pending

    Returns boolean

    boolean result

    -

isSuccess

  • isSuccess(): boolean

  • Check if current API response represents a success case +

isSuccess

  • isSuccess(): boolean

  • Check if current API response represents a success case API response code is an 2xx code

    Returns boolean

    boolean result

    -

isTmpError

  • isTmpError(): boolean

  • Check if current API response represents a temporary error case +

isTmpError

  • isTmpError(): boolean

  • Check if current API response represents a temporary error case API response code is an 4xx code

    Returns boolean

    boolean result

    -

rewindRecordList

rewindRecordList

  • rewindRecordList(): Response

  • Reset index in record list back to zero

    Returns Response

    Current Response Instance for method chaining

    -

Settings

Member Visibility

Theme

On This Page

constructorcolumnkeyscolumnscommandhashrawrecordIndexrecordsaddColumnaddRecordgetCodegetColumngetColumnIndexgetColumnKeysgetColumnsgetCommandgetCommandPlaingetCurrentPageNumbergetCurrentRecordgetDescriptiongetFirstRecordIndexgetHashgetLastRecordIndexgetListHashgetNextPageNumbergetNextRecordgetNumberOfPagesgetPaginationgetPlaingetPreviousPageNumbergetPreviousRecordgetQueuetimegetRecordgetRecordsgetRecordsCountgetRecordsLimitationgetRecordsTotalCountgetRuntimehasColumnhasCurrentRecordhasNextPagehasNextRecordhasPreviousPagehasPreviousRecordisErrorisPendingisSuccessisTmpErrorrewindRecordList
\ No newline at end of file +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/responsetemplatemanager.ResponseTemplateManager.html b/docs/classes/responsetemplatemanager.ResponseTemplateManager.html index 2cf09806..32c310df 100644 --- a/docs/classes/responsetemplatemanager.ResponseTemplateManager.html +++ b/docs/classes/responsetemplatemanager.ResponseTemplateManager.html @@ -1,7 +1,5 @@ -ResponseTemplateManager | @hexonet/ispapi-apiconnector

Class ResponseTemplateManager

ResponseTemplateManager Singleton Class

-

Constructors

constructor -

Properties

templates -instance +ResponseTemplateManager | @hexonet/ispapi-apiconnector

Class ResponseTemplateManager

ResponseTemplateManager Singleton Class

+

Properties

templates

Methods

addTemplate generateTemplate getTemplate @@ -10,32 +8,31 @@ isTemplateMatchHash isTemplateMatchPlain getInstance -

Constructors

Private constructor

Properties

templates

templates: any

template container

-

Static Private instance

instance: ResponseTemplateManager

ResponseTemplateManager Instance

-

Methods

addTemplate

Properties

templates

templates: any

template container

+

Methods

addTemplate

generateTemplate

  • generateTemplate(code, description): string

  • Generate API response template string for given code and description

    +

generateTemplate

  • generateTemplate(code, description): string

  • Generate API response template string for given code and description

    Parameters

    • code: string

      API response code

    • description: string

      API response description

    Returns string

    generate response template string

    -

getTemplate

getTemplate

getTemplates

getTemplates

  • getTemplates(): any

  • Return all available response templates

    Returns any

    all available response template instances

    -

hasTemplate

hasTemplate

  • hasTemplate(id): boolean

  • Check if given template exists in template container

    Parameters

    • id: string

      template id

    Returns boolean

    boolean result

    -

isTemplateMatchHash

  • isTemplateMatchHash(tpl2, id): boolean

  • Check if given API response hash matches a given template by code and description

    +

isTemplateMatchHash

  • isTemplateMatchHash(tpl2, id): boolean

  • Check if given API response hash matches a given template by code and description

    Parameters

    • tpl2: any

      api response hash

    • id: string

      template id

    Returns boolean

    boolean result

    -

isTemplateMatchPlain

  • isTemplateMatchPlain(plain, id): boolean

  • Check if given API plain response matches a given template by code and description

    +

isTemplateMatchPlain

  • isTemplateMatchPlain(plain, id): boolean

  • Check if given API plain response matches a given template by code and description

    Parameters

    • plain: string

      API plain response

    • id: string

      template id

    Returns boolean

    boolean result

    -

Static getInstance

StaticgetInstance

Settings

Member Visibility

Theme

On This Page

constructortemplatesinstanceaddTemplategenerateTemplategetTemplategetTemplateshasTemplateisTemplateMatchHashisTemplateMatchPlaingetInstance
\ No newline at end of file +

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/classes/responsetranslator.ResponseTranslator.html b/docs/classes/responsetranslator.ResponseTranslator.html index 8ea731c0..8ce620c7 100644 --- a/docs/classes/responsetranslator.ResponseTranslator.html +++ b/docs/classes/responsetranslator.ResponseTranslator.html @@ -1,10 +1,8 @@ -ResponseTranslator | @hexonet/ispapi-apiconnector

Class ResponseTranslator

ResponseTranslator class

-

Constructors

constructor -

Properties

descriptionRegexMap +ResponseTranslator | @hexonet/ispapi-apiconnector

Class ResponseTranslator

ResponseTranslator class

+

Constructors

constructor

Methods

findMatch translate -

Constructors

constructor

Properties

Static Private descriptionRegexMap

descriptionRegexMap: Object = ...

Regular Expression Mapping for API DESCRIPTION Property translation

-

Methods

Static Protected findMatch

  • findMatch(regex, newraw, val, cmd?, ph?): string

  • Finds a match in the given text and performs replacements based on patterns and placeholders.

    +

Constructors

constructor

Methods

Protected StaticfindMatch

  • findMatch(regex, newraw, val, cmd?, ph?): string

  • Finds a match in the given text and performs replacements based on patterns and placeholders.

    This function searches for a specified regular expression pattern in the provided text and performs replacements based on the matched pattern, command data, and placeholder values.

    Parameters

    • regex: string

      The regular expression pattern to search for.

      @@ -13,9 +11,9 @@
    • cmd: any = {}

      The command data containing replacements, if applicable.

    • ph: any = {}

      An array of placeholder values for further replacements.

    Returns string

    Returns non-empty string if replacements were performed, empty string otherwise.

    -

Static translate

Statictranslate

  • translate(raw, cmd, ph?): string

  • translate a raw api response

    Parameters

    • raw: string

      API raw response

    • cmd: any

      requested API command

    • ph: any = {}

      list of place holder vars

    Returns string

    new translated raw response

    -

Settings

Member Visibility

Theme

On This Page

constructordescriptionRegexMapfindMatchtranslate
\ No newline at end of file +

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/socketconfig.SocketConfig.html b/docs/classes/socketconfig.SocketConfig.html index 196f7a42..70272e58 100644 --- a/docs/classes/socketconfig.SocketConfig.html +++ b/docs/classes/socketconfig.SocketConfig.html @@ -1,12 +1,5 @@ -SocketConfig | @hexonet/ispapi-apiconnector

Class SocketConfig

SocketConfig Class

-

Constructors

constructor -

Properties

entity -login -otp -pw -remoteaddr -session -user +SocketConfig | @hexonet/ispapi-apiconnector

Class SocketConfig

SocketConfig Class

+

Constructors

constructor

Methods

getPOSTData getSession getSystemEntity @@ -17,39 +10,32 @@ setSession setSystemEntity setUser -

Constructors

constructor

Properties

Private entity

entity: string

API system entity. "54cd" for LIVE system; "1234" for OT&E system

-

Private login

login: string

account name

-

Private otp

otp: string

one time password (2FA)

-

Private pw

pw: string

account password

-

Private remoteaddr

remoteaddr: string

remote ip address (ip filter)

-

Private session

session: string

API session id

-

Private user

user: string

subuser account name (subuser specific data view)

-

Methods

getPOSTData

  • getPOSTData(): string

  • Create POST data string out of connection data

    +

Constructors

constructor

Methods

getPOSTData

  • getPOSTData(): string

  • Create POST data string out of connection data

    Returns string

    POST data string

    -

getSession

getSession

  • getSession(): string

  • Get API Session ID in use

    Returns string

    API Session ID

    -

getSystemEntity

getSystemEntity

  • getSystemEntity(): string

  • Get API System Entity in use

    Returns string

    API System Entity

    -

setLogin

setLogin

setOTP

setOTP

setPassword

setPassword

setRemoteAddress

setRemoteAddress

setSession

setSession

setSystemEntity

setSystemEntity

  • setSystemEntity(value): SocketConfig

  • Set API System Entity to use This is set to 54cd / LIVE System by default

    Parameters

    • value: string

      API System Entity

    Returns SocketConfig

    Current SocketConfig instance for method chaining

    -

setUser

setUser

  • setUser(value): SocketConfig

  • Set subuser account name (for subuser data view)

    Parameters

    • value: string

      subuser account name

    Returns SocketConfig

    Current SocketConfig instance for method chaining

    -

Settings

Member Visibility

Theme

On This Page

constructorentityloginotppwremoteaddrsessionusergetPOSTDatagetSessiongetSystemEntitysetLoginsetOTPsetPasswordsetRemoteAddresssetSessionsetSystemEntitysetUser
\ No newline at end of file +

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/functions/socketconfig.fixedURLEnc.html b/docs/functions/socketconfig.fixedURLEnc.html index a4a26164..4ee75e2b 100644 --- a/docs/functions/socketconfig.fixedURLEnc.html +++ b/docs/functions/socketconfig.fixedURLEnc.html @@ -1 +1 @@ -fixedURLEnc | @hexonet/ispapi-apiconnector

Function fixedURLEnc

  • fixedURLEnc(str): string

  • Parameters

    • str: string

    Returns string

Settings

Member Visibility

Theme

\ No newline at end of file +fixedURLEnc | @hexonet/ispapi-apiconnector

Function fixedURLEnc

  • fixedURLEnc(str): string

  • Parameters

    • str: string

    Returns string

Settings

Member Visibility
diff --git a/docs/hierarchy.html b/docs/hierarchy.html index b0c3886f..85939c83 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@hexonet/ispapi-apiconnector

@hexonet/ispapi-apiconnector

Class Hierarchy

Settings

Member Visibility

Theme

\ No newline at end of file +@hexonet/ispapi-apiconnector

@hexonet/ispapi-apiconnector

Class Hierarchy

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 696b327c..a73bd2ed 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -@hexonet/ispapi-apiconnector

@hexonet/ispapi-apiconnector

node-sdk

Contributor Covenant +@hexonet/ispapi-apiconnector

@hexonet/ispapi-apiconnector

node-sdk

Contributor Covenant npm version node semantic-release @@ -6,14 +6,14 @@ License: MIT PRs welcome

This module is a connector library for the insanely fast HEXONET Backend API. For further informations visit our homepage and do not hesitate to contact us.

-

Resources

Settings

Member Visibility

Theme

On This Page

node-sdk
\ No newline at end of file +

FAQ / Notes

ESM/CJS Support: We followed the ESM-NODE Guide of TypeScript.

+

License

MIT

+

Settings

Member Visibility

On This Page

node-sdk
diff --git a/docs/modules/apiclient.html b/docs/modules/apiclient.html index 01ede017..a3041227 100644 --- a/docs/modules/apiclient.html +++ b/docs/modules/apiclient.html @@ -1,5 +1,5 @@ -apiclient | @hexonet/ispapi-apiconnector

Module apiclient

Index

Classes

APIClient +apiclient | @hexonet/ispapi-apiconnector

Module apiclient

Index

Classes

APIClient

Variables

ISPAPI_CONNECTION_URL_LIVE ISPAPI_CONNECTION_URL_OTE ISPAPI_CONNECTION_URL_PROXY -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility
diff --git a/docs/modules/column.html b/docs/modules/column.html index 40f3da88..5b14668c 100644 --- a/docs/modules/column.html +++ b/docs/modules/column.html @@ -1,2 +1,2 @@ -column | @hexonet/ispapi-apiconnector

Module column

Index

Classes

Column -

Settings

Member Visibility

Theme

\ No newline at end of file +column | @hexonet/ispapi-apiconnector

Module column

Index

Classes

Column +

Settings

Member Visibility
diff --git a/docs/modules/customlogger.html b/docs/modules/customlogger.html index 4b886be5..220e1b09 100644 --- a/docs/modules/customlogger.html +++ b/docs/modules/customlogger.html @@ -1,2 +1,2 @@ -customlogger | @hexonet/ispapi-apiconnector

Module customlogger

Index

Classes

CustomLogger -

Settings

Member Visibility

Theme

\ No newline at end of file +customlogger | @hexonet/ispapi-apiconnector

Module customlogger

Index

Classes

CustomLogger +

Settings

Member Visibility
diff --git a/docs/modules/index.html b/docs/modules/index.html index ce3f3d5d..b46ec149 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -index | @hexonet/ispapi-apiconnector

Module index

References

APIClient +index | @hexonet/ispapi-apiconnector

Module index

References

APIClient Response ResponseTemplateManager -

References

APIClient

Re-exports APIClient

Response

Re-exports Response

ResponseTemplateManager

Re-exports ResponseTemplateManager

Settings

Member Visibility

Theme

On This Page

APIClientResponseResponseTemplateManager
\ No newline at end of file +

References

APIClient

Re-exports APIClient

Response

Re-exports Response

ResponseTemplateManager

Re-exports ResponseTemplateManager

Settings

Member Visibility

On This Page

References
diff --git a/docs/modules/logger.html b/docs/modules/logger.html index 4bfae3cf..8f0541f3 100644 --- a/docs/modules/logger.html +++ b/docs/modules/logger.html @@ -1,2 +1,2 @@ -logger | @hexonet/ispapi-apiconnector

Module logger

Index

Classes

Logger -

Settings

Member Visibility

Theme

\ No newline at end of file +logger | @hexonet/ispapi-apiconnector

Module logger

Index

Classes

Logger +

Settings

Member Visibility
diff --git a/docs/modules/record.html b/docs/modules/record.html index 4f7e88f7..cadd5445 100644 --- a/docs/modules/record.html +++ b/docs/modules/record.html @@ -1,2 +1,2 @@ -record | @hexonet/ispapi-apiconnector

Module record

Index

Classes

Record -

Settings

Member Visibility

Theme

\ No newline at end of file +record | @hexonet/ispapi-apiconnector

Module record

Index

Classes

Record +

Settings

Member Visibility
diff --git a/docs/modules/response.html b/docs/modules/response.html index 56f75f7d..c2bc6db7 100644 --- a/docs/modules/response.html +++ b/docs/modules/response.html @@ -1,2 +1,2 @@ -response | @hexonet/ispapi-apiconnector

Module response

Index

Classes

Response -

Settings

Member Visibility

Theme

\ No newline at end of file +response | @hexonet/ispapi-apiconnector

Module response

Index

Classes

Response +

Settings

Member Visibility
diff --git a/docs/modules/responseparser.html b/docs/modules/responseparser.html index afa8af54..f0b774c3 100644 --- a/docs/modules/responseparser.html +++ b/docs/modules/responseparser.html @@ -1,2 +1,2 @@ -responseparser | @hexonet/ispapi-apiconnector

Module responseparser

Index

Variables

ResponseParser -

Settings

Member Visibility

Theme

\ No newline at end of file +responseparser | @hexonet/ispapi-apiconnector

Module responseparser

Index

Variables

ResponseParser +

Settings

Member Visibility
diff --git a/docs/modules/responsetemplatemanager.html b/docs/modules/responsetemplatemanager.html index ada67af3..72dcff46 100644 --- a/docs/modules/responsetemplatemanager.html +++ b/docs/modules/responsetemplatemanager.html @@ -1,2 +1,2 @@ -responsetemplatemanager | @hexonet/ispapi-apiconnector

Module responsetemplatemanager

Index

Classes

ResponseTemplateManager -

Settings

Member Visibility

Theme

\ No newline at end of file +responsetemplatemanager | @hexonet/ispapi-apiconnector

Module responsetemplatemanager

Index

Classes

ResponseTemplateManager +

Settings

Member Visibility
diff --git a/docs/modules/responsetranslator.html b/docs/modules/responsetranslator.html index dd68e64f..2007b2a5 100644 --- a/docs/modules/responsetranslator.html +++ b/docs/modules/responsetranslator.html @@ -1,2 +1,2 @@ -responsetranslator | @hexonet/ispapi-apiconnector

Module responsetranslator

Index

Classes

ResponseTranslator -

Settings

Member Visibility

Theme

\ No newline at end of file +responsetranslator | @hexonet/ispapi-apiconnector

Module responsetranslator

Index

Classes

ResponseTranslator +

Settings

Member Visibility
diff --git a/docs/modules/socketconfig.html b/docs/modules/socketconfig.html index 836ab2a1..35f32e0f 100644 --- a/docs/modules/socketconfig.html +++ b/docs/modules/socketconfig.html @@ -1,3 +1,3 @@ -socketconfig | @hexonet/ispapi-apiconnector

Module socketconfig

Index

Classes

SocketConfig +socketconfig | @hexonet/ispapi-apiconnector

Module socketconfig

Index

Classes

SocketConfig

Functions

fixedURLEnc -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility
diff --git a/docs/variables/apiclient.ISPAPI_CONNECTION_URL_LIVE.html b/docs/variables/apiclient.ISPAPI_CONNECTION_URL_LIVE.html index 8a496db3..bfb433a2 100644 --- a/docs/variables/apiclient.ISPAPI_CONNECTION_URL_LIVE.html +++ b/docs/variables/apiclient.ISPAPI_CONNECTION_URL_LIVE.html @@ -1 +1 @@ -ISPAPI_CONNECTION_URL_LIVE | @hexonet/ispapi-apiconnector

Variable ISPAPI_CONNECTION_URL_LIVEConst

ISPAPI_CONNECTION_URL_LIVE: "https://api.ispapi.net/api/call.cgi" = "https://api.ispapi.net/api/call.cgi"

Settings

Member Visibility

Theme

\ No newline at end of file +ISPAPI_CONNECTION_URL_LIVE | @hexonet/ispapi-apiconnector

Variable ISPAPI_CONNECTION_URL_LIVEConst

ISPAPI_CONNECTION_URL_LIVE: "https://api.ispapi.net/api/call.cgi" = "https://api.ispapi.net/api/call.cgi"

Settings

Member Visibility
diff --git a/docs/variables/apiclient.ISPAPI_CONNECTION_URL_OTE.html b/docs/variables/apiclient.ISPAPI_CONNECTION_URL_OTE.html index 22af3daf..32002d19 100644 --- a/docs/variables/apiclient.ISPAPI_CONNECTION_URL_OTE.html +++ b/docs/variables/apiclient.ISPAPI_CONNECTION_URL_OTE.html @@ -1 +1 @@ -ISPAPI_CONNECTION_URL_OTE | @hexonet/ispapi-apiconnector

Variable ISPAPI_CONNECTION_URL_OTEConst

ISPAPI_CONNECTION_URL_OTE: "https://api-ote.ispapi.net/api/call.cgi" = "https://api-ote.ispapi.net/api/call.cgi"

Settings

Member Visibility

Theme

\ No newline at end of file +ISPAPI_CONNECTION_URL_OTE | @hexonet/ispapi-apiconnector

Variable ISPAPI_CONNECTION_URL_OTEConst

ISPAPI_CONNECTION_URL_OTE: "https://api-ote.ispapi.net/api/call.cgi" = "https://api-ote.ispapi.net/api/call.cgi"

Settings

Member Visibility
diff --git a/docs/variables/apiclient.ISPAPI_CONNECTION_URL_PROXY.html b/docs/variables/apiclient.ISPAPI_CONNECTION_URL_PROXY.html index 5f4aff60..1ea4347d 100644 --- a/docs/variables/apiclient.ISPAPI_CONNECTION_URL_PROXY.html +++ b/docs/variables/apiclient.ISPAPI_CONNECTION_URL_PROXY.html @@ -1 +1 @@ -ISPAPI_CONNECTION_URL_PROXY | @hexonet/ispapi-apiconnector

Variable ISPAPI_CONNECTION_URL_PROXYConst

ISPAPI_CONNECTION_URL_PROXY: "http://127.0.0.1/api/call.cgi" = "http://127.0.0.1/api/call.cgi"

Settings

Member Visibility

Theme

\ No newline at end of file +ISPAPI_CONNECTION_URL_PROXY | @hexonet/ispapi-apiconnector

Variable ISPAPI_CONNECTION_URL_PROXYConst

ISPAPI_CONNECTION_URL_PROXY: "http://127.0.0.1/api/call.cgi" = "http://127.0.0.1/api/call.cgi"

Settings

Member Visibility
diff --git a/docs/variables/responseparser.ResponseParser.html b/docs/variables/responseparser.ResponseParser.html index 18d6bea5..fc679a47 100644 --- a/docs/variables/responseparser.ResponseParser.html +++ b/docs/variables/responseparser.ResponseParser.html @@ -1 +1 @@ -ResponseParser | @hexonet/ispapi-apiconnector

Variable ResponseParserConst

ResponseParser: any = ...

Settings

Member Visibility

Theme

\ No newline at end of file +ResponseParser | @hexonet/ispapi-apiconnector

Variable ResponseParserConst

ResponseParser: any = ...

Settings

Member Visibility
diff --git a/package-lock.json b/package-lock.json index b183a986..cff74e40 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@hexonet/ispapi-apiconnector", - "version": "9.0.7", + "version": "9.0.8", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@hexonet/ispapi-apiconnector", - "version": "9.0.7", + "version": "9.0.8", "license": "MIT", "dependencies": { "cross-fetch": "^4.0.0", diff --git a/package.json b/package.json index 639d3e23..1a2d6cf5 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@hexonet/ispapi-apiconnector", "description": "Node.js SDK for the insanely fast HEXONET API", - "version": "9.0.7", + "version": "9.0.8", "private": false, "author": { "name": "Kai Schwarz",