diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 000000000..5674cf392 --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,22 @@ +:root { + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --code-background: var(--dark-code-background); +} + +pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 000000000..3092fea0e --- /dev/null +++ b/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Ie=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?Ie(_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),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,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.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}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()}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){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}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(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(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 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=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}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 Ve(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 C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",H="mouseup",J={x:0,y:0},fe=!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",pe="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(pe,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=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{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 ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{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()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.updateIndexHeadingVisibility()}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.updateIndexHeadingVisibility()}updateIndexHeadingVisibility(){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)}};var Z=class extends C{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,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(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.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.href===r.href&&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();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/assets/navigation.js b/assets/navigation.js new file mode 100644 index 000000000..f07947196 --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WaTXMiNxCG/wtnVxy7YifxzQVe79rr2AFv5ZDKQZ5pQMUgsZIGlkrlv6dmGEAfLal15X370aj11aPh739HBn6Y0d1owgzMpDKji9GGmeXobgSiXevL4+8/Lc26GV2MVlzUo7vf/rs4R+7Eg1JSjWUNQbSlJQlfhAE1ZxX8wdYYxdGTpBcwS1lHMGcxzngQldpvDJfivllIxc1y7ZMQS5z3DPsJKL5lnX9WLSF8MsQS53WjMeEKqs7skxwxzrhvGrm7b5p3EEyYR2asR6oapjXoy9Dj8q6ubeKY1yFizOtUzIQZNjNSwVfYQhOGu3qepICtY5ROSxJ2AgndiUzMWAptmDBo7FHMMPoVggJ6JRX9ICpZAxI8CJnYYRKj4YOWJGxBmIc1NwZULPuhJ0v8KheRCeHIWY5+BGRcTlI+/s8W1D5G6MU8Y9Z+6ErxD2SBeYYU63P9DMiT9D+n4p52Oox62ulUzAtozRbI8w4CITa1qAMLgYePpCWmGG+g1lxrLoV+VOhS9R1E2hS+t6DTvMFDJm7lCsl8YEny+oMEnmE/4wuBbQ6+I02TRlayQebRSSLFj6WY80WrsO4FHhIxsjxdPUWaQiVVjfRsEAixE2gAOzwdmcCJ9MVWCZQpMOQUtkQCI7Fh+Q4C7S/FE+np1RRlBtXm+uZ2dRUiTlIq/h206c7/RxCgmMGO2cCS5PE10pvuV1Kdcw7lx3rWqnJcxPXNLXIwooSjmAX4h7TPwA5oF2Pv3ijHNlBBr32lobO8wUfBHqaoV90gWMuXwvo7qUXCtlA3GCuyLUCsvnYh95XhWzh4x0uoVlPQbWMdPma/6Yp23OaRf/7916uba7t6V8AMfFJyHYzFgRsYcsTTrH4Egz9q6CAz39oc8+TIMrv3LqiHI/FptwqQviFL7Av/OV8EpKOQI5yr7y9i0wad9GQ67U3JDSizjwOPjizze8uaT7wx9qIYYGcpS+n3HGsJfmaibhBkxEfid+VhUNJaXEsn8yKLxNfJvClsmnBUHJXG6guFZG9tRwEz2WPbUcBM9Pqs03inkmQCh0ki8UmEGQtbSGbXdxWyk1n2XYXsRLZdT46LL3vaiu+LLF5FcuiqZSy0e4glR32GfWb7DR0E5gszoDhrENhRylGGXvRD5mNsjchxL3sdTHjfG6UkdtfQUcCMrITQUcBEp4ivl/IehFFZaG/KkV8FvM7xxWVJOcobW3DB3Lr3ADkrdMa4VTrcSn09yztdX4ylqDk6spiHzp1VchNMQE+m0w63QPGjJO4sbSOydCK2UnpkEUVsBfThVouUocBb3k4+S66xvIV8plxjUQvdhR0xVa61uBVKoixfMZ+SJstH4GspGILrfs5GR1/Z6O9qx7vCCcy54OiuGTiozGnbwAyCM9aTqbT3LjjG6kUq6XzLmpiUCW95O7FpGTOWtxCbmDEjuYX+RQQ/lDFPGTeXl5J3NTcol4+SNzY3CC2iEEuW2n40vMIW71HIEVIdLenf8MzdZRFazPl6jjdlYgHj7mZbIfuJq5JY+PSzpCzF/hgRmXSYp4gbGQnMQ+Sm1ghiKaGmH7Zk9tgh6NoIDMVEdFbiLiK7+xSUTqzlKGCm02o5CpippJ50Io9wTRR3lraRTnDpTZEflk516V2RH5ZKetltkf2lL5t1z1XCTmfbtpRQ01m2LTmqfX2NZjcw5IjfBJcidfsVGHJE1polCMMr51PVvBX9v8n0pa27rNtfLAz8gKo18E00oPX9h1QGagyH+QLsP/8D/Itqu6MoAAA=" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 000000000..52b2217eb --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA829WbPjNrIu+l9Wncfq1SIGkvJbucr2cXt7OC67d9xwdHSoJK612KVFyhJVQ3fs/36DAEElkpkgONS596kGAZkfMSY+ZCb+c3euP17uvvrjP3fvy+pw95XYbLNEi5d31e65uPvq7s3H6nVdPZSPdy/vrufj3Vd3zedTcflr///3T83z8e7l3f64u1yKy91Xd3f/89JJS7WWaS/rn/9s6wYFvejLAHkv7067c1E1HpybkmQjVK/jUB5+LS718UNxjlF075cfUXrfoWN0N0W1q5rvdk3UN957xZdpLj4UVfO2ORe75yjVfvllup+Ly2X3WLxt6nPcd6MKy7Qfds0uXjUsvUKL/1cdnhZec9vCk7UKfZtA32ClZdUU54fdvrj81f0WnI9io/JeWn0qqlFJL7pSNO4eEKNif6wvxbgOV2yekt3pVFSHcS19uXlqHovGFLmMa4JF5yn781qcP8eq8wvPU3gojkVTWCFff35dRrQnVWXuMCl255hhYotNUOJvZhbrd0Xzo12C0OTFP49MJUb2r8Xp+JmTbH6cIff/tF0cQg0LzJXPI7/9PEP22+u7y/5cviveFO2fp6bGWzNbbqlxERY8Zmzw8JlNoR+5c2Dcw9oTAY1u0c1TfZgFqq+6NiIzUn8rn4tLs3s+zcQ2ELIuyofy2BTnyyxwt7qLMY1Mq9CygAutPKGg1ImzyaFmmn53bZ7qc/nvXVPW1WQQ97j6FEhjFmfkKkbB8uouwzQyKPi13C8yfT3v6p/alv3fu+pwHJy0uGKrDD5ObtTwo7AHTG10osKGif053uC+uJaPkfgClg59ksXIqCyeyyZKW1dwtqLgYQIqGj9PhBWFjxRQU8SpglDlj/hu+pnCaDTCn5aO7IGssdHs4QrvsZGq7m/Fx1WOLJFlVTbl7vjf53JAhbDqUZ05GHDnwdlOrYeD3yctht8VVXEu9/Tu6/+4dHgQ0sYGCEI3dS/jNcbsYah2eLCEdvoAjLgdfgxJuFOpQUOUWLd7byKn9bEFyzTypdk1V2zIjui97ytFqx9v4K702/rMrKftLystp72oyNXUgOJ5xuL1udg1BT5HMcru/Rqjisd5zuKX67tjeXmahADWWYph5NDGwYg+pgWRQOPMFQTrN2UREMWCI8vfw0gGjBP5IsB+UWgZpaxxw+oNGzlh1cGZFK38PnJywdoWNb9K/LJ7LCtqQ7j9sHSNQJLGlgiAiOu76/ky2EdpLfd92TFlIzPyWEL7PqjSFZ2uEXdORwZersfmm6o54w0S/zzJqOoGC8/RDgvMlU9t7vjnRbKpxiHLrLTdEUIjNz4EObz8w7uBSP33XtUJUOI2pLlwVsVSVPv6UBze7JrdZDx+3RUxnc+DFSkCTVdrEQ48Ob41dCjCYv9z6fAHUsbGe4ciwHD9ed0dSazgl0mrws9V8fMDKRH8Mknir7vqsSAlgl+mS3zdnrzPwy3X/3FpZxHSxjoNoeO4+nONfR94Xfdd6RiFY04fdbxWU3aeTt5Ceh22O+zP61lLQF68zdRhnLqxhLTG7CmD+uGu/LA7Xqd8+L2rMFc7aVn9bExkfFaHPy3tzIGssY70cHEMQ31ufjnXp+LckBYhoe8e1RlXPtKBrbw35bnYEyeHIAhYaTEKyihntYfN8glayeMHq3bkABLWO1iLivNzebm0A72uDiU1fKkii9ckTuboukThZZr11PIne/IoOqL+3q8aD2VKg7/d14F2Mb9OsgRudS/fnXdVw7ps8AXX61ZScnznDr5gotdGHJAIt42AoBl+G5GwRhw3FmAKkoDR6CI5wdk4T7eKvxZ/XotL8/3MlmQkrYy3JWu/+XQqzwW/dgZh+gJWRvfYli4O305dBxw4r/6XwfYbNsSnQfuNt82XIvsaG0TTkH3N20bzR1txLB6Jy4zYsQaqr45syOlPxAYFrIzuEtxvg7hc1ZUR7cdNriAsr/5ybGMGBc3qMqXmmi7dMh1jvAyKrmi+0LInGDDD75hvwgTBTDNihqKWmTFhaPGGzHRcsabMGMLpxsxUrDEbcBjltC14Jr7QJhwFL24bnokutBFHoYvbiqeii9rywvgmbnpTEY5se2Fs0RvfVFQxW18Y2rTNLwLf+KY0ugH65eZvgR/q93zERaDkqhsgIXrS/oc+Ysn2x0OZuvshSUs3vwCwKXvfRFTxW18Q35ydbxJScPo2pmHoFB/ESgpaAe3oJIyY8aDYtAl/rpt6Xx8vNnr0eg7M+EDRxVN+TPbonA99x9RJHwkmZtaHRM2Z9rHQxub9ElzhiR+PMHbmz8d6KB6MV/jQLIpF6UlYAx83Ad+MQb0VWGuyIYmxUwwg5VbcruQkvfegViyAsZWfcXcdAzLq8ToZidE7DYWrshKCS3O+7pvrIM3BCApYbT6SxYPyhqMT/pdkOiDwMePz8bdAj5nf1pqFN2GxE9BCG/+EX6/H4m0x8O70f13rM6C42A9xAJkh+7+Kan/+TJ5qeaX3//RqRQEYmTr/a7cnz4ghELcqqyA418cJDX//z678Krov5b8n6e7Kz9S9bMhZ7fFrhA/j3n4rZ/iUk4ahB+TeVp4OZswY231agMlUXgMTe6owbiCkpyFVZLVTBJYZfXqAeOcZN5zuePPGkxDf1L31yZwWuXLzjouBdCJkmQVaKDd7osS0OPR+j2A8zoYFFsee0xJHo86HSLkwyONjfS6bJ+zEGlZ8D6vFQoiL3u1CK/9e7IlUB2FQjISV8L0vPn/DmRYjwHDV+YgGLtTFvj4fLm9MTiR6ZlFFprlpWwGByUuUmK2BmriD35dJpyJk6EJz9Pxa7A7BZgIFFru10xJHXduHSGdESYeVR0ZKE0Libq0Gi8MInIj48RgsgU4PjNz+5zkDajyRFV9wpQE2N5VV4Asm0qtxQCLI1YCgGdRqJKwRYnUBpiCtGo0uklSdjfOBDBuKQ9fXXY5pbIIFl+1JOa3GNAXWigWJkjoJJpnJ2GKBCq20UFBSIxcJjHreAhEAEL84YCHzF4YQnLhFYRoW5pwZgWb0pLkIzy+75mk+pq72irjOxb48lcPsShGgYNUVEV32T8UzjuGNgNPXW7PXTO3BlXdMj91qroinzZ88DNOLgHOruDKat0N6MxLO2xDRORcPkyMmDtJoupiZq2KMaRJeH6eZJRPHOHPNFzPIR6/6Zvcjl2snsifH0+7MHvHf1ufn3Yzl0qu7DFPI3AmabrBE2NDxT75F1bSRdDepD9fKXtH8Ff48yUZ7tW/KD8VvJgn/66di/97mLEHAmVJLrbSQ2DEzjQPO2WkXWGE6jvuBgEmwRlmEZldiKykGVV9xKRpxyy356nisP746Hn8bPuTQafnrsEhwKOjkNuD2dWWvsMFJYETsC78O86lD1HDUg9yZzFAYAxE7AII4QPouonlBtqnIlo35MF5q7DeR3wKHDLSGXDu+Lg/x0Pf18+naFCE5L7wyNND2N0bDaXe+hOWDEpOld9je7B5/efe6PHx7rp+//twA5wvua6gaa2hHSXtj1I+8hOLrj53SQOH4HPZVwAEG+fCBDvhj/JAz3T0u64UrFzQWLDCue4xBG6GqLzhfl6O5izddcGKEWqrONASpSBSfkIrXTKWgai6Hv5SXv5TVU9HaSYfp+i/lY1UMh+JQfV9wTe22NaOb/Qt8+651D/tl9/lY74bLHd0KqMoyRHA8NvXf3v78UwSKvuBC3fxlG51ShiixEvk4OcEMBXbRcZZNfDL1LDshA0uIW2fxxJHqE1C0p08iu+4YDlBtLSQnLonnGBav4lpo0NIYh4RYJhe2iXPMGnoEjraKX3W18eJC+U1QzNRRgysvQAVPCG8Gr7oBU77/Md7i4V4n8EWF3ya4YeKMHS55L9ISTtk7quZ0JQ84SIktNVPFYxGjwpaaqcI+HhahpS84u1eYt8UGvRJ6XIxWg57KdGV+uTYklzQssHS/ZSSObbcE0mkUe1jvOL1O1B8lGfs6JvNoqHn7Aqs1ry8xunlvSGc2L6l3QvPe6kfcpJDPh0YgGXlGNAYLOO++GUJxpvPtp/iVv6lpNgLJenErF/qM0MM0Tf3zu38V+yGtNlTVF5yr64FlWbCyh1F2JU5b5Ld5RefqO1xPJnFeET8WXtB1JiCIpXWw4hh2h1ToDXnfZC+q67PRNP4aRnJbwrrbw1eXfVEdyuoxJO4FUZjFPngYY6CzvSyKV+qVnqO1v12L+1ay+CK9kd9Ll4/WPNgBi3P5oTj8ci4/7Jribx/f48Ua/754/yMFjm5/A5ic70ddNz8UnwfuDUG197BWJIDRI5ApaRJmPhXPk1rhnqi8NirCZycWU9BhZxaivvwPBfabiwCFas/HBSyG/32AUNw6bf433k6w6IhPG8p7QZSlP8QiC2s0SWLjFIKicfpi9zSgKmY7w2pu3/RD8fkNN5nsAkmUiN3f3vQODJdIoS/8KvTXUJjp1b8jYF7XVVN8wrs1i2FYbSUc3rIQCSK4HkQjML/tonvhVnyWXng4+FgNDbKP4ZQKMRdSTsbYPVSrP4r9GQoOkz683NO53heXC3arGSgYlJus6cPuWLY0MOMd0GsalJutqQP7fdUUj+eyGa6BA51EjRjtaAy9bhc55hvdb+FVCUXxvulO5MYFok1i93XxjX3TZVTFi7Hq7Pf1XzHjEINBRJ1iSJWoab/xnpwB+swPq/jKeMJikVtcTA+2TT2q5hCcVFj+sFFeQyXdaQH8FLsLvgL+bn/7ePmxzSE1PIZgwS/YauEvMqBHcdx8BV+Xhx/Ly/Ou2eOtKQyJk7ACurKufqzPxW9Pu+rnqnjrrnx/qpu319OpPkNv3QioceKW4O5j9ew/fqqbnz/Cq6sQSL7uKoh+qpvvXJ7OV/5tfxQqsv5cZK97r6i2zH5Sh4brLkf04/XYlE+7y9NMVFz9ucjelIcfTZTLJDxcrQUoWknNOWbFQoWX6fx7az9EqnRlF2j8tbjUx2s74r/dlce4libqzEXwzUFonWy/r4zZBIkiTj9VY7b29nXub57LpinOlvVsl6FTgWwDFspY9UW4blF94AH436vy+XQsnosqZlbEy5mL1LysvDv+7ePl78W5fCiL83dF0x//f6qbb+trNQ40Wsx6OLsB1G+LMzASImbja/cabwMy/2NfyYhov7HqK+OKteVGq6+My+Ynnd1et+rr4fre3eNHW5txMtZDaDfOBfAGAtbDdjPDvq3P6LgfD5CW8iVQRhubkUJWnh8/1c3/UzQ2nmDuJEEy5iI01Owbj/7v1tNRYMGqc/G4df1zv5z/Xl2cJfn6/GEUVYSAudi+rw7Fp+4T7QuNf2/fc/wN3oNxsMJ110P0lnpVMR7U25gHFqfhgiK/r34snuvzNGSMgEXYuq3P/H337lhMa7JA7QXj/k3Rcka/HHdlZT0iOifz2PkYJWIuvo5H/a5o3HiJQMRUmovhly7qaPrpPVRzKZp5J/ex2rNRoaT137l3SKINixgJa6H7qW5evaH9iWPhkSLWwmfew+zu4b4/vKoOgau0cahj0lZFbe/QfjnXT+W7NiLk27I4HvANXCRmVtZaiH+v+sCqmcOAkrACuu6lBbveY51TQI4JWg0rbAj7P9NhkjJmI+zdHt6a4Ijfq3bL/K1+Uxyu++LVIIslizJazpdB6jsezUM54oY0A+HNtL2eIw4TEQLmY7OLmX+rsO/OVN1NZQTAOClfAGWb+/gSzZVNELQq1u+rfX1uHx9/M0ztMQkrLejLYO03vYVQoZwvg3TaBj9F1Kp43zjv5Ta469dBSqxJgFlZK7ewPcz5ybImtqwv4kvgizrMRwhYFduPrdldVo9dB9Xnw7JlKihvZeSfWj+V2CNsnIx1EZbVcoRYxsoIjdG4cA0lpHwJlPgRkjkYbzJWRfiLqX8sLpcVV/txoat+Q2sDeaHAk8CC2l+gZd0a8to5WJXV46tqX1xaJ52nHXhOY0YLxwhf95u6/1y20hJSVkVpIqT/u2ye6mszf1wQUlZF2cp0c3uZrcJIWor29kpGf5n87/i25GqvjsoeL7rv//lhPsChoC+E9eeHGWe/OFmrI+4H1M8PVuF8wJSo9fHabdIacJPs1ihR6+E1y8uicTCUsB66zgAuLu2W8qY4NU/ffNoXxWEW0KCwFTHXx+JNbUiGbz6Vl+ZV8135oagmmTGx0tZDDWnFGTBR9cW4zKCah4mqOhdP/8qLeUPmp9odzn7on55p/SViLJApkhajbZNseFtzpONihICF2Ezn2Mhh+6pWH1Xb3iTHHvQmClsDs7kTXAnyuKyFiIduKa/r6mDe37Qeg87+7e6MYtHPkPt/5Ut+Lf68RjkBzpW6+lfYKebWLHORF30JPFPo6t9gM0Cde9/Zlb8mVvzq3+VfBS//EFbel0H+U92zHAsx+5K+DFqnYKVmJsR9WdytIbYydiTyy+CP5PojhSy2WPwY/N+rt9OuTuPlLETqDr0du+UHOxePzzHkySRRC/GieHUcmT2Zvp4tdqXvaOcGo23qojdN5Bo2pDX5eorMWhedf2JZjPv/TJO1ELF9XK+5nqvCOsKdIhjMcN0VEC041fDVF+JaHoQ0QdBaWFcaixPkLUVu804wM3XadhYpayHiv3dpDvr8Br4r5Kvq8P3BcDpFNSH0ZaHwtb/pFo9RHazb0uIvCYpciN+8WfOqadp80S5syCilwsBjv2Cq0C/1DfMi9+dK/VJf0dlFnXd8tPP/bLGrfMf8bSlQfw1klh5zK5ufNjsGGV1/PWStg9ur6vDGPin347W57o7Hz9982h+vl5gIrDkS10X/urXhDy7ri9P3fbXsC8alrvcV/W2u7/W+xqdMEL3G97hOn7P2Deuuhcj04FxIqPIamL4rGvMO+/eH36tD8VBWxSEyJDNWykoov6/KptwdzT+jfT3iZKyB8Pvn52sDY8xeP+2qx4lLf0DIGhjnr/xfYs3vZLbj+vvql3Pxoayv0WeNoIQV0XXZupaD5ASt3JIoqfLEVhxLrzwH1VQqhqm75vifdD4ka66BxuRvelUdbID9rD2BFbEGvnayv7oYFb9X76v6YzVjYwgIWQPj4LwIrP1ZLRop8Itgn33NFC/uy+L+qW6+r+we8ZZ7s2vZp4Q1fJGve3N7vnmdfqEFfhHsnTdJe6c90xCOFvlF8NsfW6NygvPPHIlz0dsNodNSn+0/o63TsdqroOpIhBgKi683G0mxPwmdvk9sWqq4ZG1MpbkY+hfhYt1ziApzdf9+PgLP8p/a4L1j1CAOVFwXS3vamImmq7oATz/ip7UMXW1NHLGtwlWchMXLKNvnrvppN0ixjn82MHxtgfx4McJe9EXZL/ABhnKQxGkEhZfoBLHxUWr98os0O2fTOL2g9BKt3S4XpfNWdrJGb2x2KUPJgXn7LXZU9v7Co8JewKLsJwB0tD4/QzyvbDRT/Jim76i4Oqzmu3Dg3KgOOrHFQMtY2ooxPf7z1KweV2y2nvZGflxNV2qBlj+vxSWi3W4FF+iik3oMVY0l7hjTZEzdcUWu2Gw9b/ynHVlFb0ZedhzX1LsSjCuDRSfqAwnuLT03TEnf/X9wTfNeQHi3uxSp+v18/I15nw5KfEGUpr/B4RvXyrznxqkdedNtTG8L+rf6aydvRO2w9BKtKN10SOVIsuk4fVEti4rO0leb2lEDCBedpe9iWie6G6niy/SOfycuGqsv9ukJT1nMyxNDVd5yYsxoaAf0itwv8UvKqQ0RGRH0whVi0PZ4GB3M8zlIycgjOqSWVCRq8Mj7mKJn4rGb5nL4S3n5S1k9FecuoGSKZvRMOKOYeBd8od6dT5ozendDVnyF7yUZ2MCXs3zqZCz++6l/e/vzT2P6+1JLtPrPKvZluqfJewj2VTv8c3BGRjyqSMobe1NxgBEsKN5LNibt6wSN932NOMUjTwSi6ROhn5hKC/R3K0LPzU1BQtSdjWmwyPsHJH9wm9/WWehvoqKWeotqzmIPFEUt9wNNUxZ8oGzekj+iPbjoA+Wzlv0R3cGFH+ietfRHfHfE4o9aYMHyHxxvwQ0AYJi1BQw1U5uADSAMbAOwwDobwUBi3FbgIZ2+GHNa45Zjr3Z4QX4wTv6RjelA3CqthCKwLbIgojbGCRiitiYWzcTNaQTXYHsaMin+9Ot/X2eb8sVFbVU3hHO2K6QwassiNU7ZtpDSeVtXBIrg9oVAzNrCIjAEtzGEYdZWFtkOEdsZ0SILtrTRcRnc1hCWWVsbjYDa3vqSoS0OF1pnmyOlxm11A9TTt7uQ9rgtbyBhhcU+iGrigj8RX2hbDsKK25oj0PiseucsRBFu3U/xG8+uuAidvm7OXeUxoS+ICiyb54CO6e6y9sTrvlWYq7vYl8Wl94qJ/Xiu1jooYpuBqzUFhb8ZlJdvTm2E5nl3/KH43L6seS4uF+JBZgwlUHECmgmMsqc9klQeKqSmE5eNnygRex3/yo3XSJEvYIWxz7nhpR1UvEESC2BQaw6KwX7al/6+Ol0bvI76vy7eQQlxo1snAsjsA7vBCBlVeb8bfZsB1w7vRaUNt+lCGf9eePNkHA5TfQ1k74vPE4DY0ivpRRUGO3UYB1F7Ji488H8YCEfIhgWWDn9G4tgMIJAyzX1AQf2T9N8TtWMBjQyDk3uqFWRZiYLkV1wbzUws6yHhFq0RJOPrVhQSYLhCH/LBzg5/XMqaDGSNUCYesGl8yVDVCFkSr+vbc/0cra8rPF/nYx9sGqHzVvgvYpHW8gKjRyM0+xUWan8smlc0EUN+8kiQVXzPgvCn6A726yxFgKJ9olEM6y1q/YmdP6wxX/sH80zqN39ed8ey+fzzA44SLgnnmSGiOCnLRqjpeMg+hAcpKD5NbxxXO1RKEbXT9TGM6FAdQYdO1zbKfQ71BonP6QjqjxQJPVTryi3WxQYPjuiODgmMw1JezBpy+LrPpxS16hOVlvZ/VPOPsJ2MNt/+mjCBd7NnbwSHPlRHEOhTdRXWAnz7+fm5aM7l/mYRQtuXhzBWfz6ytusie3ixni4aO1LdrfT/dXvt/0trbaFua361i0An1FaLtuDGJSywqhwPaV7FjjIdiCrz9fdxtxMWVarORAQ+2eElUSCvzIgSS+kOTuQY30GBZRbw8+DVnijV9+fRN3ooCSO0Ak78EQflNJbzYz4S79mNaWiCb2zMR+Q9BTUNUfD9p+mILn5SlDgsl3A+lOkozl14/vTh66qt1kOm6jAZcmQnDWqvheuwa6b2UldlTQSvy6ktcqu1Jg7v+a94IMF3v2YhcRk9poMBNdfCM+KjMAYq2kFhxqxyT5xMnU+g3pq99stMPLjummMavRUdP6pH3oaesSdQfjeje0L8MTSyTbxkxlPbBVdeC9XuRnJapjHWgOwvLSgBa6Ergjd5Y9CGtVeb/7esC6ZDpm+slIAF6PDB4HV/RUEfCwa/Lz0U0ALHjgRDmEGDqktih3jSCAD3dP1IUNNNmTCYoCEzRzu51I5jGFlopyLhNsUwkPEtcSqOEbMhDCfaaJjRT+w2PdpVEZv0VDzkphgGMrIlTm6R0IY40iRx2+FURKObYRjVhK1wKrLwRhiGFbsNTp7v/OF/ZMrHHP0j0KSgfT4V+2tT/F61L6O/emeeR+oxPVwr8yju5a9UsbBjIXCm+NvHIcn4t4/hnRMTyD+UQ/LYyXjR/063SKufl2xH3JsR+bDUZC326pW/wu4VDQtO1nUo2rwEvxx3ZWWTUHB3aL3SQI3J2otPzXm3b4Kt6ZWZrAFe7vPD6gUutkhPnJpILbH+wzcdEY7D+EMGrn0/7priXO4wGQt+WcGZzxMV4cXXg+K9JSkHOUrN/fsxn7i+1qiH5i+7Eu/vAa1d6Rl65zeq09vJ/Avv/DwE0GMOegP+7eP7mVDuoYCpoEZ3TvOa3xJwUMJydHim/cIBvP0wsu0heUxn9P8fvQnjw59bZrr/j9+MP3Qpdf926fxid0GZL8jydMs7jGObdVghLDZXz2tiA8NKQmz2iIZ9/dwWHdXilZunyXrkwSeFRlSSFRbo5s0eQu+46TPedz8VH4tLEzPeXxCl52r9+XiYoBWXnqW1vLTgR2bDrdBMHS3UUR2u0Ewdo35WSF20i1XcPPyRIz5Ck5KoNAuDWx/7of/WGHujEyZYLxZJrDGKGmDcIB2qIjYjMkEa+G2pcz0WNeJbD1FNc60fKBrxrGc0xbm1DpRNTT8QpZ1xOxwon5h2IEo342A70D0x3UD0dwd9T8kWmJVmIGK8Me6RAwwT0wtwmn3jE5SiL0OGBZYeIhmJY2dJAmmY435dHiI/BvHbXcVYGHO45BEgI2TyZAwjrH9cs0TvgkFceAD+XrWv7tiKvxanIw5QG/we3jD0IEP926YG22zpcqD3X21+j9+F6lNRRUl70ZUMNpUFx21Ex/oSh/yFKzpfGSTOg6pCLHmMosciUtFjIHl6jKI/vaR9QVV/BjObxyg7+Gmzg9oO4dTZcUOj2J1jh4YtOk0ZM4/wHsFojtkpBoskIC4jxL7oq4x/GLFfAEP1F+RuMNiJcYGlJispb8RuHYCcZrzSKkcs2Fid7cPq5G1lWDuuFoienPb17b0YqIHfA4hpE1bEMnz9eW5fn2I7Cdf5/0VfLcfhvP1jAYDy0zXHHbpozVNPXvE4mOMXDWPiGSweBXMQC3XDF2qL4JGMb5VZ57LYccoczmg0E09oQQzojgAVpc9qTKmlB7aQ2LFTGwd83kElAkn8aYUTNu6q9M2nU3kuprQ+dFe61V4VV9HmbDt55P8EXF7tNXE9tkWLw2/1DFSw7hfA9DU+a07A9DV/XFiE6dtB9qQJoL4NkLVzR1W3688aU7e6a2IC7sGdXTZwIIiBx4hZE+nFM/PioV0mmXqRSZTr6lBO3TT6bMqw8qotRJFjUU0UZsji0dAHwYgzQ1dkxcMglBh/HHRQZx8IPbXxR0JC72Qz21O9wNAexTJuantQ5hvbo0jGzW0PyXyDO6pNYk3uQessNbpHRu242e0hmm94UzhY07srPGp8++VWNL8JwRMMcAR/sQnOo5llhCNxK5i7AYATDd5J2CJM3gCySUbvHFwhs3ccV5zhOwdX0PQdBxZp/E5CNmLABUBFm3CT8MQYcQFQ08y4aS01YsiFmiralBtFxBlz3iOt5GbSlljVlOsFTrHkDM4FhtxN6RQ7LqQ1iqeFiicRtUPdM0zIm+5FFmQYSYwBeQOyxH4M44gxH3FnfKn2iDce/ZZZbjuGRmyM6XjDs8RyHKAIGI5t2Qi7ERRb1WzEcidZjRD7CkYjg2WmzQilLYxLj0I5ITh9Js7xrZTDNmUnDeOBG6mNavih+Mw45uMCwYEb64xKCo3ySh3gjQo8CusNBx7Fahxmvg5rHU95HdA8nnuQVhrMPxj6Um/I2BjWYexe/0u8rWUytBevqsP3lQlcNFExXlrGMTUv4kRwn+y+Zc4g9mDEjd6hOrJpX9fVQ/lIeZAPiyw2bGmJY5btEOpE05ZRO2bbBvVGGpiM6skW5gQsnInJQJlqY05AwhmZDJKpVubENgmbmYHWmWdnRo9aztBkEE21NMM4cEgiLszYmly5xcZmUPCotcnCn2luxqCZYG+y4sY4ygfzvM2QoozC51VfFxltYkahGrMxZyIaN86j0E2xzicgpTZg+k1w/+fVNt7ol8ERvJkbbvz74HH6qjaZ0rH8d/GteYAwSvGwzhIEAR6L0B1BYrFaJxoYC15Hj8UwZljMfyM9FsGYQTH/pfQpbRBnSKzxXnrcmBwzIOa/mh7QzxgOgbfTyTKrGQyTX1CnIS80FJa/3E2LCm96D/5qGIvpYcqCuIZBMPe9+TlI4g0BFtUcIyD+yfUu5eRg2nb/P4XYoF9XhYJeHEYeU3Vo2OD3jnL4ofj8pn/qzsuRTqoN1lsZye+Xsnp806dcvKBn/CbiY6V9CdRu+LT/sQJsUtyXxN0lL18ROpb4JdDbDDNrjBMsaRZayy7eqNGxCT0oPUurCwt6Ve2LS1Offyg+v6oOb4rLvqiGX3v5cdfsR+b8TImz0D8WzS+maDdeTCrDh2EmfhLoeOVZmMYOKR6G2NPJ+Ej/UJybGI246KJR40dz/Vo8FG39cnf8vmqKx3PZjIziSXJmIb081dfjwS0rr9jjmweLrzQLgzW0vq/2x+uhuPRpZmMsgBejdVdA9Ht1WoCJrB2LKvYKhF6Nx583Chtfb/xoa6TM/rqUexkKi3u2tcM2jXkhlMU93DqiLfIdKE/vxIegwgiiX4KCECY/BTXEMOn1SKh7KgkTiSD8wh8EMJGCidQffs9y2Phf4vtjnnvELTGLfokameFXCSGOieQLr518n8yWo6kXqshS5oWVGflEmY+XOcWH33hidUc/8uRLWJT8ZhTT1KdypmAbfyOMxzXlkbApmEIvwvBo4p6EmYIj5k0YHs+0R2HGcA1NkF8LfhFrf1vJ/OhFxRkfBtUs0+OmKM7wCGmK3vRvSidv+Vj/pA3/pnfmdh/WHt7sb8rnbfVh3eGNHjf4+t8ds8n7LbBkiw+NwvAGf8Mwb3sfaCY397ZUcGsHBVba2LHEyG0dIp1yXRHWOnZXQdReYzPn0EzdyuNxhTZNDk3clhmPIfbhLQ7P9He3JmAbNXRYVBPMnHg8McYFh2iaaRHGNDQs3l7ftaGJ79jNqy+wkonhy4uzM24gZxkbSGWcxTGqM9rsQOon2x4kkkkGCEIw0wqJwBE2RRCMefZIBIqwUUJ2xxdqixjzhGiVJTbK6LgNGyoIzTxrhcZAmix90aDdgkutZLyQYiMtmAHwRSZECMlkO2IgbIZfSAyuOGtrIpqQaRNEE2ffTEQzbkgEMU2xJiYiizEpgtim2RUR6IBx8bbYn4RO3yeDZab/Jd6ccLd/1GW3L+6FX5T+oBs2znwxATs/FJ9/q+EzOYzKQem5Wvs7+ji1g+KLvvZvH9//Vn/9uSEubcjv9cov++IJqokKM3WTIWpIXTA2bVSDfXhvdMC6UjO1PBZVcbbjwHtjjFE3LL6O3l93HyeqtjVma++i6iKWBFR2qcaIqYnKztTYee7Efuaw+DK9vH8RrXjcwyhS8+unsvWpmKZ+WCkeQ6xvAVIc411AfjLIdY5CnEEe8ojY5kB4MS1oJK54ajQxo2Q8jHhC8DCjI7wyY/HALKnPzZvyXOy9KKmiuj5f/ur9Fm74Wwdad7VDWT2OSnvhlWWge/hIja/iFb6arw+Ycu2pYzAX2v+MN+Aux6IYvoDVy3jhfqdBGgCM5OeyKp93x7cjClCx6Xrat/mu57Yg/6LXTR1derpWS1TFaByWnKvt54eHSxH1lVz56Zqd1R6jlSobpTF2mQcfGLHCIyVw4rRe4eY9iP8qPhTHgR7/5+BkioVOiIz6CISU2QH2JnAxVqktukTfu2O9f3/xntMJ6fSKT9TLP7kT0hh8cSdOl//mTrBJg0/uxGmDj+6EdIXe3InT9Ei8wkdpCj26E6cJvYQTUjbyEE5sj8GncMI9FnoJh58DYAn55kNRNf9VP9IriPfrKgvIUGLU+uHDZKbz9Vgevt21coY2PaHXL75Ab9n6lcZodAWn6RpfOghVwZUjShO9cFD9F1w3InVRQ57UFRrxUbp2p1NRDa9KCGV9yQXazENcpuSQeyJU+sUX6H0smnitsPACnXb1s5K+/ky9E03opipNnIvDN1oDRtGgRPwh4921PB7IuOKw8BdURfobh/inL7EMiAkP4M621HjVIWMtWmvAXuNaftxki9ZOL/OM4vBSH9I5vtwzKqOfZ5yx7HMdG/1K42RbjtEY+4bi+KIcqzH+KcU5ViSjdMKLipPtcUZl7DOYMzZydvTEPuQ4asF+81w2TXF+25yL3TAb4bDIerbsUGy8Qeuj5qgt1n2K0w9rLNXO25uE4nGjM0pnwPKkWnvc/IzSWjyXw7nCKe0Kz9I5SKp7qasdul3v/nepEwoUE5Eh1wDhnAFK7HxJCL8/BOw3Vz7sdOBfM/CaRjKYxuryrjSD2oK3may+eZ3k9HXy/pJEKu5xcr4mgwvGeAj3p9EbRxrMqP+Lu3KfBQrWXhEVl7N4gGg8RTEzEOEFSHFpWrbmO3uBTVHGuET8qcXdiuOFJiz6xbAaQ08PsI/hGE/4OgaJkrA2OjobXiyy/xM0Giej6jyk/rv1hpyKCdVduZ26pMN9xP0siGPCVsLcptVYApOov27/zhpzqO66iHjf/ThUb0dN0bnImIwJcbDehI9X02fD+EN748ts7NvcS9DRT2THYws7ci5rN/JNmynN1glYCZulJL8jqIkRTLDiqlhmLQ9+1VXxzF4chtVXwtVxBnN6za+6Eh6XsGfneQNFIsKVvwSmty4UZBE4KGUhyvOuOtTPvcC3zRk6Io2A4yqvg2kOlFUR0B7MQQBhH+aJ+l+/q89vn3ZCp9TdThAHrroKnu/jtzJYYRXdAUeiEIIIn6JYHNY56k15+LW41MdrOw9/LS7XY3SbhASstNa8KQ+tM/a8kyeuPB1TtEMW00Ax3llD9f942V0VffWf1kW/NU7uvroT9/J+e/fy7qEsjofL3Vd/WGAv7/b183Mr6x/db38vWoVtCVvkr5u7l39sXqbqfrOR//jHyz9cDfOD+Q9TLLl7+UfyUmT3+dYvlnjFxN3LPwQlTXjF5N3LP+RLnd/nW+UVk14xdffyD0UVU14xfffyD00V016x9O7lHylVLPWKZXcv/8ioYplXLOeK5V6x7d3LP/KXKr1PdeYV2/rN27b29qVS91qh9kX9YDpiQylO/K5I2iZPErKk3xtJ2+qJIEv6HZK0DZ+QPZf4fZK0bZ+ol2p7L+XWL+l3S9I2f6KpQZP4PZO0PZCkZEm/c5K2E5KMLOn3T9L2Q5KTJf0uEm1HJFtycPt9JNjJItBsMdNl81Jl99tN7pf0u0i0/SASsqTfRaLtByFeyvRe5f6QE34XibYfhHyp9b1GMP0eEm03CEV+ud9DImO/3O8g0faC0JRuv39E2wkipQr63SPbPhBkl0u/e2TbCYLscun3jxTc50i0nklupZJ+70jTO1vic6TfObLtAknOc+n3jky5JUb6nSMzbo2RfufItgtkQjaQ3ztyyzaQ3zuq7QIpXsrtvZLaX8v93lFtF0hJKVd+76i2DyQ5LJXfPcrsN+QSo9COo7gPUn7/KM2NS+V3j0q5ka787lFtJ0hydVN+/6icBel3j2o7QZJzQvn9o03/kHNC+/2j2cVN+92jTfdQQ137vaPN5Nm81PJ+k6R+Sb93NL+2aWQStJ2gyCGs/f7RbS8o0mbRfgdpdv5ov3802z/a7x/ddoIit1Pt90+64USmfvekbScoRTVm6vdP2vaCIu2m1O+g1HQQOTJTv4NSY7GRAy71Oyg1HUQOuBSZbaaDyH039TsoZXef1O+gtO0GTS6uqd9D6ZZdt1K/h7K2HzQ54jK/i7K2HzQ54jK/i7K2H7SkjKjM76JMcp+e+T2Utd2gyUUz83soM2Y1uWhmfg9lbTdocnxkyLZu+0GT4yPzuyhj51Dm91DWdoMmB1Lm91BueogcSLnfQ3nbDSl5Ksr9HspZCyH3OyiX7JDL/R7K225IyYGU+z2Ut92QkgMp93soT1mYfgflbS+k5O6bo/NP2w0pafPkfg/lW3ahyf0e2m7YxWvr99DW9BA5OLd+D23ZHtr6PbRtuyElR/HW76Gt6SFyFG/9HtqaHiIH59bvoS3bQ1u/h7YZe2bY+j20zdkzwxYdUrfsvrrF59S2H9IteQLcoKPqpu2JjD6rbtBhddN2RpZQXW9/g2Xb7sgEXRYdWDdth2SSLouOrJu2SzJySNvfYNm2VzJNy0XH1o2hFFK6LDq4bgyvkNFl0dF10/ZNRp9dN6jfDI2QkYtfMqAYeLIHcwwJf4JNMMuQ8GfYBPMMCW/pJZhpMHwCM3Qw12AYBWboYLbBcArM0MF8g2EVmOGAGQfDKzDDAXEOiWEWmOGAWIfEkAs5uWslAnNDbd/k5CaTIOohEaxtkSDuIbHkAz0cEPuQWPqBHg6IgEgsA0EPB0RBJIZpyAXJPCEWIjFkQ05udwkiIhLDN+Sk5ZQgLiKRrLmeIDIisWwE3WSIjkgM68A0mcScnuSbDJESieEecnKHThAvkRj2IadJOMRMJJLd1BLETSSGgsjpgY7oicSQEHlOl0W9ZniInF73EEeRGCZiS08gxFIkil8jEU2RGDJiS881RFQkip9rClOxbcdsSesvQWRFYjgJRizqM8NKbBmKF3Wa4SW29JRAnEViqIktTfMi2iIx5MSWHmOIuEg0P9UQc5EYgmJLs8KIvEgMR7Gl91bEXySGpdjSYwwxGIlmCaZEYwZd81MCkRiJoSqSDT12EY+RGLoi2dAjEnEZiSUzNvQ4Q3xGYliLZEMvqIjSSHhOI0GkRpLaWw/1Uif3mwSVRT1nyItkQ69miNlIDH+RbOihhsiNxFAYyYYeQIjfSAyLkWzoEZTiKxDbffQQQixHYmmOhO5rxHQkhs9IErqvEdmRpCydmyC2IzGcBklrJojuSAypQVKlCeI7kszeWdGDDVEeieU8EnqwIdojyfh5h3iPxLAbzI6MmI/E8BvMjpzh26uM35ER+5EYkoNmfhJEgCSG5kgSehlGHEhimI6EuW5DNEhiyI6EuXFDTEjCUyEJ4kISw3gwLYzYkMRwHkwLIz4kyQMrJmJEEkuJJBk1LBEpkuR2xuXkkoJ4kSS3M44+IiNqJDEESCLouYzYkcRwIImgr3QRQZIYGiQR9FEHcSTJluXqE8SSJNuAXYl4ksSwIYyhhpiSxPAh9C1AgriSxJIl5NVlguiSxJAiiaBP9YgxSQwvkgh6diDSJNnavqNnB+JNxIbd7ASiTcTG9hw1MgWiTYShRhL6MlMg3kRs7D0/c4WNrpE39qp/81Jm9/kABrpJNuwIBxldJht2hLQvBSJOxCYLiEUXyoYcSehbS4GYE2HYkUTSniqIOhGGHknoK0mBuBNhuRP6VlIg9kRYFw36YlIg+kRYLw2mQxB/IjpHDXJsCkSgCOurIbOXKrmXaO4JxKAI664h85dqc78RqAMRhSKsx0a7sAzsNoEoFGFoEvqqRSAKRVivDbV5KeW9RrfeAvttWMcNlZCfh103rO+GEnRh7L5h+k9JujDqP0ujKHpkYCcOwZorAntxWB6FdvjAjhyGK6HNCoFdOawvB83bC+zOYcgS+iZTYI8OEeo8xKQIy6SolISMuBQhbedldGHUeYYwIf3BBOJShOFLSBcLgagUYegS8pJYICZFSOsiRW6PAlEpwlIpipxJiEsRhi9J2ssmoizqOMOX0H5aAnEpwnp70HecApEpQvEbHuJShAqYKgKxKcIwJgl9fSoQnSJ4OkUgOkVYzw8OBOo6y6doerwjRkWoNFQY9Z2yfUevEohTEdYRhL6jFYhUEcr2Hr0lIFZFWFaFvqkViFcR1iWEvoMViFgRWgS2McSsCC0DaxCiVoSlVugLXoHIFWEIlIS+4xWIXRGWXaHvZAViV4RlV+hrWYHYFWHZFfrCVSB2RWj2eC4QtyIst5IyPnuo/yy7ktKtjOgVYekV+p5UIHpFWHqFvioViF4Rll6hb0sFoleEpVdS6sgiELsiLLtCX0QKxK4Iy64w4xOxK8KyKxk9MBC7Iiy7ktEDA/ErwpAoSUYPDMSwiCxhz7ICUSzCUiwZPTIQxSIsxZLRCwyiWISlWBjLEJEswhAp9D6JOBaR2e6jRxwiWYQhUpKMHnGIZRHWyYS+QRWIZhGWZqGvUAWiWYSlWejLOIFoFmFpFmbIIZpFWJqFvroTiGgReejMgJgWYdiUJKfHJ6JahKFTkpwen4hrEZZroe/OBCJbhCVbcnrMIbJFWLKFvo4SiGwRlmzJ6bGByBZhyZacHhuIbBGWbKGvmQQiW4T1SKHvmQSiW4ShVBL69kggvkUYTiWh74QEIlyEIVWSLd2DiHERlnGhr3oEolyEpVzoux6BKBdhKRf6skcgykVYyoW+whGIcpGWcqHvcCQiXaQlXehLHIlYF7mxXg9kD0rEusiNJTtpd2rEusiNvUAne1Ai1kVuLFFN9qBEtIs03IrYkD0oEfEiN9bJiOxBiZgXacgVQd+hSMS8SEOuCPoORSLmRRpyRdB3KBIxLzKxF+l0DyLmRVq/FfoORSLmRXaOK3QPIuZFWs8V+gpDIuZFJtYHgu5BxLzIxN410D2ImBdp2BVB8/wSUS8ysZ5idA8i7kUaekXQwTUScS/S0CuCjq+RiHuRhl4RdIiNRNyLtLEzNHMuEfcibfiMoHsQcS+yi6ChexCxL7JjX+geRPSL7NxY6B5E/IsU9rqI7kHEv0gbT0Nz0RIRMNLG1DCxMjisxsbVMOEyOLLGOrPQDLPEwTXWm0XSPTgIsDE9yASl4CAbG2VD07sSB9pIGwZF9yCOtTFUi6DpXYnjbQzXImh6V+KYG0O2CJqxlTjsxpAtgo7skIiJkYZuEXRwh0RcjDR0i5B0DyIuRhq6RSi6BxEXIw3hIuiYDInYGGkIF0GHZUjExkgbi6PoHkRsjLTxODQNKxEbIw3hIhTdg4iNkYZwEXSchERsjDSEi6BDJSRiY6QhXAQdLSERGyMN4SLogAmJ2BhpCBeh6R5EbIw0hIug+T+J2BhpY3Vonk4iNkYawkVougcRGyO1jaiiexCxMdIQLoKmyCRiY6S2UYl0DyI2RhrKRdAUmUR8jEytuwTdg4iPkYZyETSRJREfIw3lImgiSyI+RhrKRdBElkR8jDSUi6CJLIn4GJnaeDi6BxEhIw3nImh2SiJCRhrORdC+/hIRMtJwLoJmpyQiZGRqY0vpHkSEjLQOLzQ7JREhIzuXF7oHESMjDekiMroHESMjDekiaMZJIkZGGtJF0IyTRIyMtG4vNOMkEScjrd8LzSJJxMlI6/hCs0gScTLS0C6CZnsk4mSkoV0EzfZIxMnI3EYI0z2IOBlpaBdBsz0ScTLS0C6CZnsk4mSkdX6hCRyJOBlpvV9oTkYiTkYa2kXQnIxEnIw0tIugORmJOBlpaBdBczIScTLS0C6C5mQk4mSkoV0EzclIxMlIQ7sImpORiJORWxvmTfcg4mSkoV0EzclIxMlI6wJDczIScTJyayO+6R5EnIw0tIugORmJOBlpaBdBczIScTLShg3RnIxEnIy0kUM0JyMRJyNt8BDNyUjEyShDuwiak1GIk1GGdhE0J6MQJ6MM7SJpTkYhTkYZ2kXSnIxCnIwytIukORmFOBm1sXH7dPw64mSUdYWhORmFOBllaBdJczIKcTLK0C6S5mQU4mSUoV0kzckoxMkoQ7tImpNRiJNRhnaRNCejECejDO0iaU5GIU5GGdpF0pyMQpyMMrSLpDkZhTgZZWgXSXMyCnEyytAukuZkFOJklKFdJM3JKMTJKOsOQ3MyCnEyytAukuZkFOJklKFdJM3JKMTJKEO7SJqTUYiTUYZ2kTQnoxAnowztImlvRoU4GWVoFynIHDUKcTLK0C6S5mQU4mSUoV0kzckoxMko6xNDX3EpxMkokbMuGwpRMkrYOHN6aCBKRkmbTINMPoEYGWVIF0lzPQoxMkra/qNHBmJklLT9R48MxMgoQ7pImutRiJFR1jGG9F9RiJBRlpChroEVomOUYVwkTSEpRMcomwOFppAUomOUYVwkk7QEZ0KxqVCYvCU4GUqXDYUeFzgfik2IwqQQwSlRbE4UJjnIICuK7T56YODMKIZxkTSFpHB2FOscQ99QKpwhxaZIofkmhZOkWOcY2qtR4UQp1jmGmdiIjlE6kMwGsTHK+sbQzm4KsTHK+sbQnooKsTGq840hPRUVYmOU9Y2hPRUVYmOUIVwkzdQpxMYozcb4KcTFKEO30OH9ClExyjrGcO2Gek/z8esKMTHKkC2SZhYVYmKU9YxhxhBiYpT1jGHGEGJiVCr5MYSIGGUdY5i2QESMso4xzBhCRIyynjHMGEJEjLKeMcwYQkSMMlyLpDlZhYgYxccdKUTDKOsXw7QFomGUpWGoMAGFSBhleBZmbCIORmV8CIRCFIwyLIuk6WaFKBiVBRyxFaJgVBZwxFaIglGGZWGGG2JgVBaaeoiBUdYrhhluiIFR1iuGGW6IgVHWK4YZboiBUbnNBUbvk4iBUTnrFaoQ/6Ly0NRD/IvKeU9shegXZekXcmgi8kUZfoWOyFWIe1G5nXa0CYC4F2XoFUnfQSjEvaitXTdpEwBxL8rQK5K+g1CIe1E2+Ii+g1CIe1HbgEeTQtyLMvSKpC8sFOJelKFXJH1hoRD3ogy9IukLC4W4F2XoFakV1dmIelFbPrcbIl6UdYYhg2IV4l209YWhg2I14l20oVYkfWeiEe+iLe9C35loxLtoy7vQdyYa8S56w8ZAaMS6aBt/RHuwasS6aMu60HcxGrEu2rIu9F2MRqyLtjFIZI9oRLpoS7rQ9zYakS66C0EiNwaNSBfdhSCRG4NGpIu2pAt9I6QR6aIt6ZKSp3CNSBdtSZeUzm6HSBdtSRf6Rkgj0kVb0oW+EdKIdNGWdKFvhDQiXbQlXegbIY1IF21JF/pGSCPSRVvShb4R0oh00ZZ0IXdrjTgXLQJnBo04Fy0CZwaNOBdtORf6XkojzkVbzoW+l9KIc9GWc8nocYQ4F93FIZFbsEaciza8iqQvsTQiXXQXiERaGBqRLtqSLvSNl0asi7asC50PSCPWRVvWhb7x0oh10TI0BRHromVoCiLWRduMs/Rdmka0i5a2B8mIaI2IFy35KECNeBdteRf63k0j3kXz6Wc1Yl20DUeiQ7g1Yl20IVboOHKNSBdt45FI33uNOBdtw5HoYDaNOBdtA5LoOHKNOBdtOZecDHHQiHPRhlaR9A2kRpyLtpxLTg84xLloy7nQnK5GnIu2nAsdcaVxflrLuZDZZHGCWusAQ2eJxTlqDalCR6hrnKY2lKcWJ6q1fAtp3+tBqlodWOBwtlpLt9AhjhonrNW27+j5j5PWGlKFtlI1zltrSBU6x5ZGhIu2hAt90awR4aJTPrswolu0pVvowH6N6BZt6RZmFCO+RaeBzkN0izaMCjOAENuiUz6LmUZkizZ8CjPYENei08CBXSOuRVuuhRlAiG3R2SYwgBDborOEH0CIbtE2ColZCRHfojPbebS9hwgXbQkX2vtAI8JFZ3bZpPc8RLjozC6btL2HCBdtCRfa+0AjxkUbUkXS3gcaMS7akCqS9j7QiHHRuV026fTWiHHRhlSRtPeBRoyLzgNxnBoxLtrQKpJ2VdCIc9E5f+5DjIs2rIrc0nYWoly04VXklgz51oh00TmbS1ojzkVbzmVLWgCIctGWctnmZFnUd5ZxocsiwkVbwoXGgPgWbfkW+nSB6Ba9tR1HD2NEt2jDqCjaBUMjukV3+V7oYYzoFm0YFUW7YGhEt+itXTrpYYz4Fm1IFUW7YGjEuGjDqijaBUMjyiU1rIqiXTBSRLmkhlVRtAtGiiiX1LAqinbBSBHlklrKhT5rpYhySTe2B+lk64h0STc2xz7Z3SkiXdJN4J4vRaRLangVRTt3pIh0STeBe74UsS7pJnDPlyLWJU34e74UkS5pErjnSxHpkiaBM3uKSJc0CZzZU0S6pEngni9FpEua2A4kZ1WKSJc0Ye/5UkS5pIntPnICpohySZOA8ZIiyiVN+Iu+FDEuqSFVFO2akyLGJTWsCvMWAn42QXDJQFJEt6SGUSGDnFNEtqQ24QudDCRFZEsqNOtZkiKuJe38WyhnkRRRLangE4ekiGlJBZ84JEVES2q4FEU7PqWIaEml7TfmuQnUb4ZLUbTjU4qIltQ+58OsFIhoSaUMrBSIaEkNl6JodiFFREsq7bSjF1lEtKTSPk9CL7KIaEllFoKBOtCQKao9qw8HBiJaUhl4BgMxLakK3NCmiGlJbeoXZiVEVEtqqRZmJURcS9pxLfRKiLiW1NApig75SxHXkvLJdFPEtKSKP/GliGhJDZdCJ6lIEc+SKj7deIpoltQwKXTK8xSxLKmhUuiU5ymiWVJDpdBp11NEs6SGSqEz66eIZkkNlUK/MJAimiU1VAqdSj1FNEtqmBQ6lXqKWJa0Y1noMYxYltS6tdDuhiliWVIdslYQzZLqkLWCXwhKA9YKfiQoDVkr+J2gNGSt4KeC0pC1gl8LSkPWCn4wyL4YRDtqpoM3g3hrBT8alPJpWVP8blAamHf45aA0MO8Qz5JmgXmHaJY0C8w7RLOkhklh5gdiWVJDpDDzA5EsaRZwi0gRyZJmtuPo3R+RLGnn1ULPD0SypFnAHTdFJEuaBfY7xLGkWWC/QxRLmof2O0SxpHlov0MUS5qH9jtEsaR5aL9DFEua2/2OtrEQyZLm/H6HKJY0D+x3iGFJc/6dhhRRLGkeOiQgjiW17w3RLs8pIllSm+aFOZciliXtWBZ6/iOaJbVpXkhngBTRLKmlWZiFBdEsqfVqoS9ZUkSzpJZmoV26U0SzpNvQIR3RLKmlWWj/7xTRLOk2tO0hmiXdhrY9RLNkG37byxDLkm0C216GWJZsE9j2MsSyZJvAtpchliXbBLa9DLEsmWVZaM/5DLEs2Ybd9jLEsWQbftvLEMWSGRaFfh8kQwxLtglk98wQw5IZFoVeAzLEsGSGRFG0+36GGJYsCRz1MsSwZEngqJchhiUzJIqSJJ+WIYYlswwLuedkiGDJrFcLPZARw5IlAZ+IDDEsWcew0AMZMSxZl1mXHsiIYsm6zLr0QEYUSyZs/5FmcoZIlkywyeQzRLJkgvfGzRDLkhkihXtQEfWdCFzLZohlyQyTwgxkxLJkIuNjmTJEs2RdYl36wUbEs2SWZ6GjRTLEs2SWZ6GjRTLEs2SWZ6GjRTLEs2SGSlF0tEiGeJbMPp1MR4tkiGfJpE0RSbkBZIhmySzNQgeLZIhmySzNQoc8ZIhmySzNwiwBiGbJLM1CxxtkiGfJDJeiaK/5DBEtmeFSFO1aniGiJTNciqIdpDNEtGTKOsPTQwMRLZkKeORmiGjJLNFCuxxniGjJVMAdPkNUS6YC7vAZ4loy69RCuy9liGzJukAiim3NENmSKf7gkCGyJdOBg0OG2JZMBw4OGaJbMh04OGSIb8l04OCQIcIl07b/6KmNGJdMsweHDBEumU55/6UMES6ZDpguiG/Jujgi0tEgQ3xLpkO2C+JbMptil3akyBDhknXPMtOrHCJcsjRkvCDCJUtDxgsiXDJLuNBDGfEtWar5oYzoliwN8GUZIlyyLo6IHsqIcck63xZ6KCPKJUsDDp0Zfq/Z8CqKDjvI8JPNGeuXlOE3m0OPNuNXmwORRBl+uDnEuWT47WZDqzD2CH692VIuzBQZPOCcBUY9fsPZUi7Mo9j4HWcbScSMekS6ZJZ0YUY9Il2yLr8uOeoR55LlvHNEhiiXrKNc6B5BlEvWRRLRox5RLpmlXJhRj0iXzGbXZUY9Yl0yw6wo5vVxRLtkORuMkiHSJcv5m9kMcS6ZoVWYGYIol2wbOrIjyiXbBrzKMsS5ZDaSiBnJiHPJrGsLHe+TIc4ls5wL88g64lwy69rCvLOOOJfMci7MU+uIc8msawvz2jriXDLr2sK9o+53YG45F5quyhHpklvXFu7d9QQVNpYn8/Q6Il1yw6so5ql0RLrk1rWFeS0dkS65JV2Yd9AR6ZJvAunlc0S75PZJI/IEkyPaJTfUiqKDYnLEu+SdZwtphueId8mTgOmZI+IlTwKsZ46IlzzhWc8c8S55EmA9c8S75IZaYd6bR7RLbmkXOkAoR7xLbrgVRQcI5Yh4ya1rCx0glCPiJU9s/5FzKkfES264FUUHCOWIeMmtbwsdmpMj4iW3xAsdmpMj4iU37IqiU8bliHrJDb2i6GibHHEvuQg8KJYj8iU3/Iqio21yRL7kIkBb54h9yQ3BojKSzMwR+5Jb9iUjXUZzxL7k9oFoyjEoR9xLbugV0jEoR8xL3r1pRDoG5Yh5ya2HC+kYlCPiJbcOLqSzT454l9zyLqSzT454l9zyLnQcUY54l1yGug7xLrnlXegEfjniXXLLu2SkH0GOeJdc8l2HWJdc8V2HOJe8c24hWw1RLrn1baH3EMS45JZxIemnHBEueRdFRJdFPdfxLXRZ1HGGUVF0ysMc0S25YVQUHXCUI7ol7+gWekggviU3nAo3mxHhkutNYDYjwiXXSWD8IMIl16xPYI7ollyzPoE5IlvyLmkLOZsR15LbnC2km1+OyJbcerfQMx9xLbl9zYhZfhDZkmveJzBHXEtu6BRFZ7bMEdeSp4Fb2hxxLblNn0taWIhpyVO+3xDPkqd8vyGWJU9twkBy5CCWJbdeLTm9hSKaJee9WnJEsuQ2foiOusoRyZLbZC2MhYdIljzd8mEUOSJZ8ox9BS5HFEue8SEMOeJYcsOj0KEROeJY8ixwSs8RyZIbHkXRoUY5Illy69hChxrliGXJM7tg0tsiYlnyzPYevdMhliW3LAsdapQjliU3RIqiQ41yxLLkhkhRdKhRjliW3DApig41yhHNkhsqRdGhRjniWXJDpSg6eihHPEtuXVvoRKc54llyQ6UoOtFpjniW3FApik50miOeJbc8C53oNEc8S27IFEVH2eSIackNm6LpKJscUS25pVroKJsccS25oVM0HWWTI64lN3SKpqNscsS15IZO0XSUTY64ltzQKZqOsskR15IbOkXTUTY54lpyQ6doOsomR1xLbugUTUfZ5IhryQ2dounAmRxxLbmhUzQdOJMjrmVr6BRNx8JsEdey3QReEtt2XMs/Xt6V1Yfi3BSH76tD8enuqz/+uPvnP5vPp+Lu5X/u/lna/0xeGpl3X/3nLrn76j//8/JOuD8z+6cU3Z9b+6dS3Z+5/VN35XX373TT/dnVz2T3Z/d73snLU/vntvv3tvt3knQCE9HVTOTG/cWVUa6McmWU7v6iXWHdAU0coiTtPiHJ3E8OTPs6t/2L6H5qny/t/tKpaF9ftF+uOxjKCWwTStm/bF2rbDo52rVbG9ncNZT7Ke+aqA2tsX9xX9G6r9q/5N3/tJ499i+iw9zertm/ZIlrYtfGrnq7/X71n//5n5dufJh/teNlt2/KurrAsbBVYDCoLFDxQ9EU1a5q9k/F/v25uFyPjTeoRAokbbecpOIidLpvzrBum5qpr9smZBqpeyj2588nT32b6+omIh9VX1SEiBSKyDkRx8f6XDZPz97Xb2A7ul5XWzcONm6iuJHfMmac/GP9cXc82tZ+3DX+3BXbm6L2ZXdGyOlUVAcfIQDY4WuPn0z9y76oDmX1CEW0TFovI7fjl6x7KI5FC/zweN5VXhu3ESy9iDZ8xraKZAde0xSXZmeGbflYFWdv8Lbh6720NuuBbWx+/BtpWEgGhQi226/NU1E15X7QIRqO+5jqh+KyP5enpj7vy8NzeXneNfsnT2YOZIqcbRwg818fL8/l5YJ6rH2YEQhie+wmqKyr5/pcNE+7qq6Kts13zfVcVHVzuZ5Odbu1+ApSqCD09bU35dvrsltFsXGrrHCrbLfOtYkGba+6JTBN3F/chtBGKnQLp1sUN269THK3cLqf+j3KLsks2vLfpjUgaOF1i0Pq9hd21EFx9h9V3dQfq8JvkTyD0tkVDEqr6sZMseLQ1EQb52CytQ9bhiV6w7r1bAQT1S1fbkNvXRxHpLlFwEMk4eqVuAkrXZc4+6L1WOg6KWH0vNtdilRdz8emfve5KfwpLeF+IrlRCUTU7/5V7P3dQEoog+uOd8d6//7S1Ge/9TK4UrqhkmuuC95dy+Phz2tx/lyfBlt0y67dhLF7tGmFpu4/yv8YsA4oxcKwIqjGgFsju2t09S/NGa1DbZprUJ/r033pLy4SrhEbrhv3x2KH1hawInfriOiHcN8bbvfJ3TqSa15FffE6GAzjpFu7ZL/9OI3OqsycgeeM29wZt7kzOFuCsLPiuC19Xx/8uZQLuF5wi9m+fj7tzgVq2jbhwm3T23IbQ1f5ubhcdo9FUz63m/HzyZcE2iLdhGBcGwwjgRNVbLhJdqvcNsKe34zg6rJlR1kv7fl6bMqn3eWJlbjdQIncuO8kHnaPp3f78vBwrp8Ha1ICp6BIRsBBUZfmXOx8axNOJ8Fakvu6OpSD5STL4NjtJkPiduDUHTDSjB+I1UPpG4aZhstd5gY335+thKu/ZrYPNdzWCMEPyerSnK/7xlRD634GNjztDo4Zu2T2st4Xnw/FufxgNtXTrvGsMQVbu/W1nirs2pplh12ze6jPz7vmctk/Fc/+fgHX10xy6/OIitO5bup9fdzXVVN8aig1OVQTGDcxatr/oHRkUAc/zoM6jNwd2VJbKD4wRq14ZBFJOJ/dcV0k/WnfUQPOSBTOohT9ad8ZfG1K4u5I78xPd1xPt242bfsx6Nb3TWfP5o50yIU7t7sBm6v+SN/JaQke9kNbwuehPDa+Odn6pYOGYne2czGw0aDV6FgK4egT5aa3Uo4IceZ3m5q8o4ecZe6+NpXSrS/ufzJHhLhDcua6IXNNnKU9j8ROCYMfHBO99SAFM1ezB9ZOBmf1t/mGwF7JLiZGyoE8OSca7kya3SStiPZ8SMhI4djVnP3dySgP5+JSH6/txwzJGg3ZgJwla6ysdg/yWzWBrcquIn1lwqaV8GCq03DvtjJOxdmcb+vqci7+vBYXRCtAI0SG26Z+eLgUDW3MZAJuZOFP6w/H/mCBH8bSATcJ/qxtU7TdqrOHH1jdb9cttOtGZk1Xn/oMCakenYTHPNOU8NQi2C+5ni81WrhAVyZu/etWGGdctw830ALbfdYfabBFlDPSWTO7rY+tVHgWThwWrbjOvW31vhQJpbil0jHWOuVWBWA5ePLgWBUpN4fb2hd0uG8zswIobotT/V8cJtaCM1LxqRcMGbdrsDZGL+CxaAgyGRLCgj1v9kKOxYfi6I8+BUcftyD0Ak5XEgU8f7IUgBUysNG1hJ/gjqGK24QOu6bo1m5/QkNysjPWHYmsWUKhlVZ8OpVn30DOIAm8cZs0ax+3Uk7Xd8fy8lSg4yO0sx0q7VA5wygNCb7UZ7+1FTzUOCtDaHaiFu1h8HTclZUlLE67z8d6h1oPAs3YCTu8T1DwuJaxrPCheCirElsMkL5NHA2QsQRGT5d7XQVJjI07lGl2KrCUewJvRoR0F1LuPku7+6zMGZuZs8yyLd/2xwJZjRpaJ44LUbKnPtyh0BmCuWZnghFefCiq5vLu84AxgPdVzl5m5zd7qEvgBidSvlmdgOFRJIHWpehv+jZBMMWuNezMcG0n1r67hyrr6n3x2af9BLwqYS/FrNT9U3k8nAzW4n3x2b+1gUthYBC2cpyMf318738qXMxYmsyXgXAkKRyH/P5rZHAioBntrgiynsjbsOuNFWpaHMuEa6Lo71A3/Oikr8YgA8KS4+7mB60XkD5JNv2duGMs3XGwzUMUlutbUvBGVvT32J30jLPIDkWzK4++uQBPhBt2riCKEZr4Ob8VlIfnonmqDzwHB3dhfkkqjYQB9ZxAi1hsWSPLVP+wO6LlBtrjgp+E8Lj1sCuP+BMg98eyrU7KB/9MAPFzNa+no71aZGwR2IGa7fmPlT8z4PrG0oGHj9WQEQRzijVRTL1Lg7erDM7xjDW62uuzM77vgiMlZxurqzok1GFf52xff6zKqinOD7t9YUpDeyOBXghJAHw35nF9eEZQrNla7Mvicin2J6HT94nvSQEFsCPNF0C6U2yhHG7E+HJIn4ocyuHGQnEQWifbsjITEG8+WzgOWf6leC591WAMOjMkZw9ZRdUOhwM+PcITAHvBa+v653h4daVY94bb7u9dLnk2jqMbWTeAmxDSNUXCb1DsAniTUlanq9+SGjLzW3eEds5fmt1KbjJP5/pUnBt/54W8WqK5ydIJuXx+fi6aM7KYfPYfUi8siV78ed0dh3wp/MaMbSS85MBzKt8MrSnbDs/W9WSwOCtIUOR8MwyEtE4Ep4JYBrfevs/ZDEbgsfaWbUjddzNmpDZx8gZCcpaKs+a9v3bCpUKw3WcqPhZomQGTXbHn2b5ud6Hp75FgMLLrphNAUZrQo0Wx/Gwv4lycjsi6BQjCn2BcBXzl0OOB5VNBbaoJ4M1gsOMvnK9C+ywswBEhZNgMYBiwO6gVcLm+a+3ed/4eCglExU9lXwJtQSees12cJPtPM0OvVfl8OhZtaWwQwrMQy78jyUSXwTtT9soUiSG7DfpnsJYTEjToOgG+il9/b+3jrRsAgF162Ms9K8GiMN/ytKsOR2Q0g1HEXkIWn4r9tSmu1bFt2XeDo4eERI5mLeDiU3Pe7Rt0/pHw3KJZQ5bYicAUyhzl5xyvhOhdgh2v5MpkrHlldZTV/ng9FJee0TsX+/p88EkHOBAy1lHHF3itwiLh3TbL5VqRXk3hkQ6dGeT8nhXrzYjvq+Dhh+8G0mdDw52UJcPNHdfAZyrRcI6zTO1ju4Pvjv/6ePlQnMuHsjg/Fk3PVFR181BfkSfvFo7tTbzgzrwmL3yS7RYK5TreCg1clmroWJSzBwdSDglMQysxZ11wnMBDeXhffD4V50tdIUseTMftSKs5+hGZGQq2fM4a5L6MwV6tYFPnrM+sL4Xc6tpQISCJG59OUjtOuwn68Vz6/K2Cq1XOXhw6UW0b70r/3g7eT+csS4QknHcffSEQBuve7oR0OyLupzYqCoyZsY8Bd8tDh3VoTOcsKUCIoq6p4Uk2Z132SGEf6veow6CdzS6GQBaeEQr6bufZ6Kd1bj/d+atf64mhBAcCu+JiuRfSK0xBr+g8G/1MJ2w466AzdJ6Nzd3u44YXHQpyeXk+NkI7OcQiANdJ9qIfiSFXAQX5gpw13pCoYbdB78mcvSszYso9YYt6Pr7BdumrDyxIz8+Y7yN0wQWtdOdEpUTv8OvIHxfVlrMOOI9FQ8eIpN41LL+gNEMvfAnvXzR7NfBYNAMfXWhAstxzW/F6PhcV59ICZ2MIelE158/Ihk2h84Tzz9KsZd5KGRzs4cbrYjdyFegCc6O6Ow5GqIQ3SJo9oT4WzXv0GXAR0YGVrqmKj8WFogfap+FAZ/CLWlMfD5wI6CARsECa1ue6ajo3TmNdPnT/QCMEUg6Z5BfHzqBExKqCt3o5e28J7VG/OlzCWM/vx6IZ+jkpaLlolpTs6+KzFVzMNb8r4N1cwggexbrymnqeaWqjbIxDhQdEwO+QvNFDCyQitgSc9JI3gGiBVd18LhobrelL9U7mE7/bGh/ouwUUyPbfQGB/dULFvQlo60t+QA6k2tsUWqSCIoMjhQmtemh5gQqNJAHXA8lePIfkUiFbAq4Rkr2s7yS88+YjjGNMnG9z4oKsUhcjnbL3GLfv9cTC5dvF1SVJ75HivIhY+rv/XE8q9EDbOBeiW0y08xJm/dqeDgPnAHjJyV70mHq+X0h3Lvb7weOPuBZDyzHcLLmRZst6GzS0u2QfK8Y1p6nWQbbek60nFXXBIuDOKxNuLRkK/LA7XgucNUBAn2HJuv1CaRBYWT0Xz/UZAYSrSMJ1mSndrZXm77t3x4L+YLh+sKZWZ190E/JDMYgS2Hh3Ac7Zjt2xWXsFcuF8d3YLoj/8wFB2uRIyN0ncHHQMYOKcuhIXaZaw55LyAmP5fS8PyFc550DhXM8Eu8aVF7uOtetR1xT2jEHYwvBySLOXQ+WlOLXeVufd8X3xuQ2JOrfXzL4JAB3OFMsLlRfemoSu1s6XTEt2FF5a4xBZMeBzUpY0Ky+tTYhqQucu1m5ox/xj1TYsFU0r4SKqHTGcskbDvz4iH3zo481elPzr44VztaQWThh8KdmLNMdKfu45v2vVe//szx/8yQCpSTZyDt8Ga2iws33jbQaEjx/c/QR7n/W++Exf5SdwP09YpzevPnH/DmcN271DIX53QzJbs0PufYHPgJC00i41Seq8xvM+mUSodZ5b4qHc+UHJkEnR7IpFUI0SknLaJZXJWVvhWCLfEHjL4dZ3lj593nn7NeSAE9Yf93n3yXnem4Qerf3zrui8TPzrTrjWs8QrxbfAK98+4KxbrZ3zoHJmn3KxVMq592qX9Uc7f/LUxTKnsre/eqvRuQm7rDmZM9Yy1XsQO49MloTqPgMxHXApT/vw7FER/jUT3PtT9v68q21YCt/7AKwx3EDuKhuKwppLePGDh4IxDMj7ATpcseEyDOGtoKWXsjs1qE3xE3Az43YDIIJKVQANupQ1wICQAQMIHcbSWAGGuvI5USCF24ScFBSIAOMf2Ws7VxfHwMC1sps5o51JR7DAdSFnw0agDLJDvJWOXeI6KeBO3ZcCvmqkT0gSUnjhPN2q0/3pwj8TZ4IlzpJJXKxA4pasxMXciv4+uE/Q5XKOKbdF6T5LWZ9YK3HLmvOqS12gb+p2kWzjoh9ctobMBZ1lt7RmfEO2RIS/JkByuvtkF3XvGNXEfU4i+wt/1wjsNdFz6XsNQu8d9vT4XFbl8+54ORaFTxNDhjtn/W6qNg7tWP67IAKOpecL57wTWN9Ha0mS2VugEy17k1BXbSTn0HsCOjBwY7X1m4OVwIzvRoi7RhB94LI7h+XOlT53m2TuArNyNo5kkO1HQlpeC66PTb3eRqYinKCBqlmP4dPusayGkc1eYLObWdzud5MxDNr07n65sefR2pjQhZ/BrnZWAo7OhEFt7Mw87c5+CpcEDjPh+Czlgi1Un8TNHap1bx312dzcbE37RIhu2qZujmfuuJ650IvMWZwZezdqwA4in6A7DEtJuarBTCkC+hpK9ibFyRrNkyKg66BkV4/bhTadmgQG0bCuI+BW3LeGIR/Ahm6D2vvaJ7jg7RJ7IxH0FYCtkLJeZ1gE7XoI2Uz27g+L6nlhkgqHnpWSvQnEMv1RCJ2VE9G7grt91WW3zNxcyXp/NXYxxgoJ0xTmdUnY6wssqKqbHR8XKaDFLVkjDQuljCxo3qTszSaWZAZgvxruqgNMrOJbT5B5jRnaN/k2kcrpXD+V78qW3C+Lo39wEtBCkYLbbrH0a3XL9DZsW9gikt3dRrxloP9fqjk7YiiEnlCQZk/45XMgzR//qZf5q0+aFNFqnThidENLP4kZiJ0ocijC7Ans+SnsWQQvSdOYadtdEJLNnnu3/xFj1wqjmgneb/FWykCSvTgILdwCjjTJG1FYNNkB8JKftd0HouB0GnaJgN0qWUdv0skL3vHzA4IM+5WQ69K5y8TpMmDkbBKOmzjCvle+Qy67mvchwIT7ALyrSHmbD4m4Vu3NUdNScNd9QUZLCTj4pWAXnaDkAYcq4KiQ/NgdSL1x4tczutL3nO3Zk/1NZFNj9w9ICGdsXN3pXO+Ly4WMF4Hu0awXhtvWvLkMD6suW0Ci++srZ3Kz12ZOqJ9cdd/dsHeUq99e0PphoxMCcs/XY3GhHLIFzMksebuPEt1H7p7rY+uaV55KxEwKaPdL9s6MlF5W+/p8Lvb0oUt4pCfr1BWWTCe7EV70JZsFJiyatYcg0yDZCztGuL2ZNmaRLxQusawvVUjo4MYcekRKlgghRRrrvaweu2FRnw/kyIP+kpLlrRkNn9rbCeoOD56MJZv3hpZaVqxUOAHZHLSMVLOHM6MYzr5pC0Yn18xsn1EXMKJQslErpNR2AWr7zZcHxyx/RqDkWdajjVEanxqQqpUsdxZQ44YZyLP5uKv2hmHeP+18zlFABkmyaVhodd1/kuMaxvBJng6i5BpX649l81Rfm2EvwBnJOhiTcltZbryQ6zSMc5JscjCUpNPfTyHDw7ppOQlM7iF44Ty6WwzS4vgxoH3yR8ekj04E3OIJbBXh8h5rlw5T98FrjkHLHIOWsT4dva7htIVe9cnoLEMEEozfdVR9yjNB4bgFaBOkIeMKCWFOUTAbVMDYw9K6ddgaMN3orR/8YQuXZfa+a0R0/cBYXfAiTrK3Eqz0fqbVD1aRJ1x7KR7GhstQuB0/dnsdbN4wbYLkD/iccJxzT8DrVcnGEg7lUYY39DpOWFfDoSzqwAottYz1uR3KMuss0+swLYJkoy2GMjtLp2VdqsdDcWqeik/7ojhg8XDXYS8kCfH1sTjUxogvPpVtwtjH8kMxyA0mYC4IOaF54SHeFwi3HZ7J4oOXoKWesS5QvoDh3RgMPEzGhzSbJwD6qCeRn0MOPS/SOe6rhvkCoCt6wuYm86XwPQU38VFh7aLhP6cEW4bfLE04xeA6DqakY/NckZEcEl7+avcilO59tFjf7F4aydPAdCBsHhEyNkTChMeadUjp66LbQO25YLAT0NUmqA14C8ymQSJzW8LQksS5Yydb57Xg7no1z6U5qXQqaBjhKvjFxQnhkkFDjwp+Cl5RpBx0kb/lZnT585wfcc4KHCYegcyWcvZd2uc0Z1dnI4kIFoOT2aWKZM8x3MriRSYFEdisr0P/IcjictrPu+pAZA3Q0OczZ+/ubO39u/p8edq1j5JhnzgY+MoOYSulrFD8M4x1ZY1PW7f3LhjmztMweCZnl6RODlEdhjuzhrStTvoNaej6m7NL0HlXPRb71sH7jNMRwCUs0A6PhEOLR4+y7V8gfwxIyyqWCyRPkImX+sZdpWqWKrHWEnakgH4lvcsBu84QCTskvLxTfZoRlgvvQ6WN73FVO+rq5o/cxhThEz7sGclmveLDsKE5nbEnPa++d5wfZmkUcNeRbA4lTyRpHcEjNOtI6YmhjCO4VmesDd2L8bOmBm8OoOuRZO9wOsnDCLbedwOYMbcLZk8T3Oskv45O0dQePAZRmHC9l2NNPtRjOwHY8yc6PBFGjEh2/2fV2N3q3AfxRyiEBxHWj5VV6HsY0BrgyYRN0hrWUNU9H+nLhrY0Gx0Qlu0E0+DhGsJ6/8cpaA+BtBK4KrCkXFgJcd0AHQkka593Yh3X0vGwftBK8fiMqUjoFCjZvFWdcMRI4nCYIPcOI5AkG0KEFLVNzWghxxGkRSXrj8Bl2kjgHYlggwxh9e7ZEWMR9IZ46yZOXWvAk45MRzoSHMx7LtmuZ108Y+nbkgLmtJQBK+QmndySoGExtnBxRnUCSXnBOgpBKcaBMLIdoQupZB1poXSCCoAEx9h6eZMxMP8T77XcsWUR24AKkp7Z2JBoa49ZJvCiXbKpWYBAahB4eTjGluNWCGWVQMo1G1sNWyHDTvKOeGPmhxXRXM9VYd1QT+hGByaplryJ3+XPsc+KMYsPsUpDpzHJOjYHs/N4KYTH+m4sH6X3/MHYwj4pJaWAobmS9UzGoietZXAnZSPdsAZyKMPrkGis5HiGQQtsRjcsiRjUMGR87NvsZt4Ubez347lsPvtequ0TEQdDUBcVkygDnvIkG23HqbsloKgO1tOIVuLFxI0MNiK+Gp5EWaddWB084waaZuSxbAE93CTL9ozp6bakLsSCzC4AL+Ekm3FtTBH1vLavBtpUrAehp2Zk+4BpTOXYIDcS3WN2zW5XHbonsZ6vzXV3PH4uPu2P1wvOMAM9uiTrkUfr2Bv3Zxcv6/SY9KJDPXARYVP7DfW4NX7gSyjgjblk0zEOJfZeAr7n9gh8uKGwMQ5QmWt9aujDTHuSvS/H0kwjk+LghOfpPiiO2aagE8LYtmkE3fKPXSvj2FAQ6SMEvN6XPKHoy4UJIEhnE5g/T/J8LZBaPj9fG5iFZP/UcohILFwueAIXiKW2Ouj5m/S598fsYyvODvm2y8vqdC4+lPXV35FhHL3k6VVa5jCHs4D+worNl0LIA88vcFDh+sI6DROiySMlvAlVbHIIQtrQRpTwMl6xeRUoWcO1COZakDxxD2RR2byh1apZr0BPShtnuKsONi0MtThIeOmr2CQUUKjZ3i5G9LV6X9UfKyIjzMbLYhAzpQfmDNhlaeQwDw/r4RBUESTRJLwmUex1ZZyCqm7KCr3MScV9wrsVxV6wBnWCJwfpz4JXe2wusqCKW0ISZguTkC1XUVbiQIm7B+Eu9SWkPxQb+kOEIEnoNK5YN+ZhwIaE7l+Kda3G3nJw+iesC+G5rpvBnXmSek8BcB85XL8SGAeX9L4D7JVKd4b2RECWSrBHeluz677OUsXvzkLiRbFJxjxJ9dn+k9rbJWSEFOs4M4gFhYRL4jICJH36AJe7IOW/lXqdSXmp/Vn7pa9rE8APqDIJmRzF5nW7PNXXY2+a9lPDZ6q8V2/YQVM++u9qQ9JFO6+B1CVnyF1cXM5ja5c2P99F4l25h6B0e4qPCGYEYidqaEVNoIe2cLlxlHvMVLkkEip3Tqy9j6hzVEiViwd3yXZS9zZ85nIcZm4QZc6TJHMpbzL28Dq0FBLony6SPni/f+avx9/Hs7sH3DOXEci9KaFy59xyC+h1ATgOW9o/6X57lrCPfuyTafS5IN38cG2VunUlc4nlMvc0fJb0CTf622oXPOziirO0jyJ219G5a89bIqo+LI0fdf7wh+ZvwrpkErkyoHsFGz3fEt2HsvXWx35eXgZxh55dDZjsjl7yXm7/b82iKzIOwdrBfrLx5Wjqd7tLkarr2c/bBQM5FL9POBnD/B5wTWaDBmz0Adof4IE34dcrioj1grTcXHBpPnKWpYc5cYbpyqHhxy061qYeJO8DaLrJy1qOrXnbHo26FO7ovXTI7uTsHVzrX+MPYuhfxOaq6t1yiCsbCZl8xQ5gP/ErvC5jeVJi1CTQKVewoRtN/a8LSsEHY1SEy+Ki3BauXAYglbsgB7eIpi6JTerCFdK0X9jc8rPp/WP6Rcv91L+szHKFTU29GwOfO2SNwIHrKWSWEjZo63osD60rPcrEqiA3n7OhatfKJFumc/cryMqnbH6J6/kIQn9cQqGWTPHHFpxabB5JWhgy/xMvDyu33lzPx96O5FHBIxG78lOiMCZ4fGNnnzvqgIv/lig1LqHNII/x8HSloJWQsdFATo1/DXEuHgqTbmd37I9avnBozbIjzglv5yXBnkAmRrOcoxOCU9B7rzay1J2r3Y1c8msSOAMEe0/nRA1ODAom6UjZ+NG+PvC6HG5zCh6DUpaycMKIZL7wNk+w16K9APrlCGhhsPf9H9pk0Z5hAh/f4TYFm/3V70tvZ+D2Y1vRPOJZNp/rB0zFoktHCW01zWYmQsloPQlwYdVsUxLZn+FRlo5S/sfLu1N5Ko5lVdx99cc//ud//l86lplcyAADAA=="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 000000000..98a437794 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1414 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +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; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/classes/AllowAllTenantGate.html b/classes/AllowAllTenantGate.html new file mode 100644 index 000000000..f5f797d85 --- /dev/null +++ b/classes/AllowAllTenantGate.html @@ -0,0 +1,5 @@ +AllowAllTenantGate | DWN-SDK Documentation - v0.2.18

A tenant gate that treats every DID as an active tenant.

+

Implements

Constructors

Methods

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Cid.html b/classes/Cid.html new file mode 100644 index 000000000..a4cbfeea2 --- /dev/null +++ b/classes/Cid.html @@ -0,0 +1,17 @@ +Cid | DWN-SDK Documentation - v0.2.18

Utility class for creating CIDs. Exported for the convenience of developers.

+

Constructors

Methods

  • Computes a V1 CID for the provided payload

    +

    Parameters

    • payload: any
    • codecCode: number = cbor.code

      the codec to use. Defaults to cbor

      +
    • multihashCode: number = sha256.code

      the multihasher to use. Defaults to sha256

      +

    Returns Promise<string>

    payload CID

    +

    Throws

    codec is not supported

    +

    Throws

    encoding fails

    +

    Throws

    if hasher is not supported

    +
  • Parameters

    • content: Uint8Array

    Returns Promise<string>

    V1 CID of the DAG comprised by chunking data into unixfs DAG-PB encoded blocks

    +
  • Parameters

    • dataStream: Readable

    Returns Promise<string>

    V1 CID of the DAG comprised by chunking data into unixfs DAG-PB encoded blocks

    +
  • Parses the given CID string into a {CID}.

    +

    Parameters

    • str: string

    Returns CID<unknown, number, number, Version>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/DataStoreLevel.html b/classes/DataStoreLevel.html new file mode 100644 index 000000000..9abea94ff --- /dev/null +++ b/classes/DataStoreLevel.html @@ -0,0 +1,27 @@ +DataStoreLevel | DWN-SDK Documentation - v0.2.18

A simple implementation of DataStore that works in both the browser and server-side. +Leverages LevelDB under the hood.

+

It has the following structure (+ represents an additional sublevel/partition): + 'data' + + + ->

+

Implements

Constructors

Properties

Methods

Constructors

Properties

blockstore: BlockstoreLevel
config: DataStoreLevelConfig

Methods

  • Deletes the specified data. No-op if the data does not exist.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<void>

  • Fetches the specified data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<undefined | DataStoreGetResult>

    the data size and data stream if found, otherwise undefined.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/DataStream.html b/classes/DataStream.html new file mode 100644 index 000000000..f34d8f62f --- /dev/null +++ b/classes/DataStream.html @@ -0,0 +1,13 @@ +DataStream | DWN-SDK Documentation - v0.2.18

Utility class for readable data stream, intentionally named to disambiguate from ReadableStream, readable-stream, Readable etc.

+

Constructors

Methods

  • Duplicates the given data stream into the number of streams specified so that multiple handlers can consume the same data stream.

    +

    Parameters

    • dataStream: Readable
    • count: number

    Returns Readable[]

  • Creates a readable stream from the bytes given.

    +

    Parameters

    • bytes: Uint8Array

    Returns Readable

  • Creates a readable stream from the object given.

    +

    Parameters

    • object: Record<string, any>

    Returns Readable

  • Reads the entire readable stream given into array of bytes.

    +

    Parameters

    • readableStream: Readable

    Returns Promise<Uint8Array>

  • Reads the entire readable stream and JSON parses it into an object.

    +

    Parameters

    • readableStream: Readable

    Returns Promise<object>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Dwn.html b/classes/Dwn.html new file mode 100644 index 000000000..5b8f6d587 --- /dev/null +++ b/classes/Dwn.html @@ -0,0 +1,14 @@ +Dwn | DWN-SDK Documentation - v0.2.18

Methods

  • Validates structure of DWN message

    +

    Parameters

    • rawMessage: any

    Returns Promise<undefined | GenericMessageReply>

    GenericMessageReply if the message has an integrity error, otherwise undefined.

    +
  • Checks tenant gate to see if tenant is allowed.

    +

    Parameters

    • tenant: string

      The tenant DID to route the given message to.

      +

    Returns Promise<undefined | GenericMessageReply>

    GenericMessageReply if the message has an integrity error, otherwise undefined.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/DwnConstant.html b/classes/DwnConstant.html new file mode 100644 index 000000000..1a460ce78 --- /dev/null +++ b/classes/DwnConstant.html @@ -0,0 +1,6 @@ +DwnConstant | DWN-SDK Documentation - v0.2.18

Constructors

Properties

maxDataSizeAllowedToBeEncoded: 30000 = 30_000

The maximum size of raw data that will be returned as encodedData.

+

We chose 30k, as after encoding it would give plenty of headroom up to the 65k limit in most SQL variants. +We currently encode using base64url which is a 33% increase in size.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/DwnError.html b/classes/DwnError.html new file mode 100644 index 000000000..99b2d71f8 --- /dev/null +++ b/classes/DwnError.html @@ -0,0 +1,4 @@ +DwnError | DWN-SDK Documentation - v0.2.18

A class that represents a DWN error.

+

Hierarchy

  • Error
    • DwnError

Constructors

Properties

Constructors

Properties

code: string

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Encoder.html b/classes/Encoder.html new file mode 100644 index 000000000..19f657ad7 --- /dev/null +++ b/classes/Encoder.html @@ -0,0 +1,11 @@ +Encoder | DWN-SDK Documentation - v0.2.18

Utility class for encoding/converting data into various formats.

+

Constructors

Methods

  • Parameters

    • base64urlString: string

    Returns Uint8Array

  • Parameters

    • base64urlString: string

    Returns any

  • Parameters

    • obj: Record<string, any>

    Returns Uint8Array

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Encryption.html b/classes/Encryption.html new file mode 100644 index 000000000..e51ff2789 --- /dev/null +++ b/classes/Encryption.html @@ -0,0 +1,17 @@ +Encryption | DWN-SDK Documentation - v0.2.18

Utility class for performing common, non-DWN specific encryption operations.

+

Constructors

Accessors

Methods

  • Decrypts the given cipher stream using AES-256-CTR algorithm.

    +

    Parameters

    • key: Uint8Array
    • initializationVector: Uint8Array
    • cipherStream: Readable

    Returns Promise<Readable>

  • Encrypts the given plaintext stream using AES-256-CTR algorithm.

    +

    Parameters

    • key: Uint8Array
    • initializationVector: Uint8Array
    • plaintextStream: Readable

    Returns Promise<Readable>

  • Decrypt the given plaintext using ECIES (Elliptic Curve Integrated Encryption Scheme) +with SECP256K1 for the asymmetric calculations, HKDF as the key-derivation function, +and AES-GCM for the symmetric encryption and MAC algorithms.

    +

    Parameters

    • input: EciesEncryptionInput

    Returns Promise<Uint8Array>

  • Encrypts the given plaintext using ECIES (Elliptic Curve Integrated Encryption Scheme) +with SECP256K1 for the asymmetric calculations, HKDF as the key-derivation function, +and AES-GCM for the symmetric encryption and MAC algorithms.

    +

    Parameters

    • publicKeyBytes: Uint8Array
    • plaintext: Uint8Array

    Returns Promise<EciesEncryptionOutput>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/EventEmitterStream.html b/classes/EventEmitterStream.html new file mode 100644 index 000000000..85e529176 --- /dev/null +++ b/classes/EventEmitterStream.html @@ -0,0 +1,7 @@ +EventEmitterStream | DWN-SDK Documentation - v0.2.18

The EventStream interface implements a pub/sub system based on Message filters.

+

Implements

Constructors

Methods

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/EventLogLevel.html b/classes/EventLogLevel.html new file mode 100644 index 000000000..6392fbe90 --- /dev/null +++ b/classes/EventLogLevel.html @@ -0,0 +1,28 @@ +EventLogLevel | DWN-SDK Documentation - v0.2.18

Implements

Constructors

Properties

index: IndexLevel
ulidFactory: ULIDFactory

Methods

  • adds an event to a tenant's event log

    +

    Parameters

    • tenant: string

      the tenant's DID

      +
    • messageCid: string

      the CID of the message

      +
    • indexes: KeyValues

      (key-value pairs) to be included as part of indexing this event.

      +

    Returns Promise<void>

  • deletes any events that have any of the messageCids provided

    +

    Parameters

    • tenant: string
    • messageCids: string[]

    Returns Promise<void>

    the number of events deleted

    +
  • Retrieves all of a tenant's events that occurred after the cursor provided. +If no cursor is provided, all events for a given tenant will be returned.

    +

    The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

    Returns Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>

  • retrieves a filtered set of events that occurred after a the cursor provided, accepts multiple filters.

    +

    If no cursor is provided, all events for a given tenant and filter combo will be returned. +The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

    Returns Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/EventsGet.html b/classes/EventsGet.html new file mode 100644 index 000000000..276f4120a --- /dev/null +++ b/classes/EventsGet.html @@ -0,0 +1,9 @@ +EventsGet | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/EventsQuery.html b/classes/EventsQuery.html new file mode 100644 index 000000000..4cd47d3da --- /dev/null +++ b/classes/EventsQuery.html @@ -0,0 +1,9 @@ +EventsQuery | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/EventsSubscribe.html b/classes/EventsSubscribe.html new file mode 100644 index 000000000..4a1f9b519 --- /dev/null +++ b/classes/EventsSubscribe.html @@ -0,0 +1,11 @@ +EventsSubscribe | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/HdKey.html b/classes/HdKey.html new file mode 100644 index 000000000..24847f44d --- /dev/null +++ b/classes/HdKey.html @@ -0,0 +1,9 @@ +HdKey | DWN-SDK Documentation - v0.2.18

Class containing hierarchical deterministic key related utility methods used by the DWN.

+

Constructors

Methods

  • Derives a descendant public key from an ancestor private key. +NOTE: currently only supports SECP256K1 keys.

    +

    Parameters

    Returns Promise<PublicJwk>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Jws.html b/classes/Jws.html new file mode 100644 index 000000000..2feb1af59 --- /dev/null +++ b/classes/Jws.html @@ -0,0 +1,18 @@ +Jws | DWN-SDK Documentation - v0.2.18

Utility class for JWS related operations.

+

Constructors

Methods

  • Decodes the payload of the given JWS object as a plain object.

    +

    Parameters

    • jws: GeneralJws

    Returns any

  • Extracts the DID from the given kid string.

    +

    Parameters

    • kid: string

    Returns string

  • Gets the kid from a general JWS signature entry.

    +

    Parameters

    • signatureEntry: SignatureEntry

    Returns string

  • Gets the signer DID from a general JWS signature entry.

    +

    Parameters

    • signatureEntry: SignatureEntry

    Returns string

  • Verifies the signature against the given payload.

    +

    Parameters

    • base64UrlPayload: string
    • signatureEntry: SignatureEntry
    • jwkPublic: PublicJwk

    Returns Promise<boolean>

    true if signature is valid; false otherwise

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Message.html b/classes/Message.html new file mode 100644 index 000000000..efe1aaecc --- /dev/null +++ b/classes/Message.html @@ -0,0 +1,44 @@ +Message | DWN-SDK Documentation - v0.2.18

A class containing utility methods for working with DWN messages.

+

Constructors

Methods

  • Compares message CID in lexicographical order according to the spec.

    +

    Returns Promise<number>

    1 if a is larger than b; -1 if a is smaller/older than b; 0 otherwise (same message)

    +
  • Compares the messageTimestamp of the given messages with a fallback to message CID according to the spec.

    +

    Returns Promise<number>

    1 if a is larger/newer than b; -1 if a is smaller/older than b; 0 otherwise (same age)

    +
  • Creates the authorization property to be included in a DWN message.

    +

    Parameters

    • input: {
          delegatedGrant?: DelegatedGrantMessage;
          descriptor: Descriptor;
          permissionsGrantId?: string;
          protocolRole?: string;
          signer: Signer;
      }
      • Optional delegatedGrant?: DelegatedGrantMessage
      • descriptor: Descriptor
      • Optional permissionsGrantId?: string
      • Optional protocolRole?: string
      • signer: Signer

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    +
  • Creates a generic signature from the given DWN message descriptor by including descriptorCid as the required property in the signature payload. +NOTE: there is an opportunity to consolidate RecordsWrite.createSignerSignature() wth this method

    +

    Parameters

    • descriptor: Descriptor
    • signer: Signer
    • Optional additionalPayloadProperties: {
          delegatedGrantId?: string;
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      • Optional delegatedGrantId?: string
      • Optional permissionsGrantId?: string
      • Optional protocolRole?: string

    Returns Promise<GeneralJws>

  • Gets the DID of the signer of the given message, returns undefined if message is not signed.

    +

    Parameters

    Returns undefined | string

  • Validates the given message against the corresponding JSON schema.

    +

    Parameters

    • rawMessage: any

    Returns void

    Throws

    if fails validation.

    +
  • Validates the structural integrity of the message signature given:

    +
      +
    1. The message signature must contain exactly 1 signature
    2. +
    3. Passes JSON schema validation
    4. +
    5. The descriptorCid property matches the CID of the message descriptor +NOTE: signature is NOT verified.
    6. +
    +

    Parameters

    • messageSignature: GeneralJws
    • messageDescriptor: Descriptor
    • payloadJsonSchemaKey: string = 'GenericSignaturePayload'

      The key to look up the JSON schema referenced in compile-validators.js and perform payload schema validation on.

      +

    Returns Promise<GenericSignaturePayload>

    the parsed JSON payload object if validation succeeds.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/MessageStoreLevel.html b/classes/MessageStoreLevel.html new file mode 100644 index 000000000..687bc8c9b --- /dev/null +++ b/classes/MessageStoreLevel.html @@ -0,0 +1,26 @@ +MessageStoreLevel | DWN-SDK Documentation - v0.2.18

A simple implementation of MessageStore that works in both the browser and server-side. +Leverages LevelDB under the hood.

+

Implements

Constructors

Properties

blockstore: BlockstoreLevel
config: MessageStoreLevelConfig
index: IndexLevel

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/MessagesGet.html b/classes/MessagesGet.html new file mode 100644 index 000000000..16155a7ee --- /dev/null +++ b/classes/MessagesGet.html @@ -0,0 +1,9 @@ +MessagesGet | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/PermissionsGrant.html b/classes/PermissionsGrant.html new file mode 100644 index 000000000..145ff771c --- /dev/null +++ b/classes/PermissionsGrant.html @@ -0,0 +1,23 @@ +PermissionsGrant | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

  • A convenience method for casting a PermissionsGrantMessage to a DelegatedGrantMessage if the delegated property is true.

    +

    Returns DelegatedGrantMessage

    Throws

    if the delegated property is not true.

    +
  • A convenience method for casting a PermissionsGrantMessage to a DelegatedGrantMessage if the delegated property is true.

    +

    Parameters

    Returns DelegatedGrantMessage

    Throws

    if the delegated property is not true.

    +
  • generates a PermissionsGrant using the provided PermissionsRequest

    +

    Parameters

    • permissionsRequest: PermissionsRequest
    • signer: Signer

      the private key and additional signature material of the grantor

      +
    • overrides: CreateFromPermissionsRequestOverrides

      overrides that will be used instead of the properties in permissionsRequest

      +

    Returns Promise<PermissionsGrant>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/PermissionsRequest.html b/classes/PermissionsRequest.html new file mode 100644 index 000000000..cb9d905c0 --- /dev/null +++ b/classes/PermissionsRequest.html @@ -0,0 +1,9 @@ +PermissionsRequest | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/PermissionsRevoke.html b/classes/PermissionsRevoke.html new file mode 100644 index 000000000..91d50d6f7 --- /dev/null +++ b/classes/PermissionsRevoke.html @@ -0,0 +1,10 @@ +PermissionsRevoke | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/PrivateKeySigner.html b/classes/PrivateKeySigner.html new file mode 100644 index 000000000..643da4ed1 --- /dev/null +++ b/classes/PrivateKeySigner.html @@ -0,0 +1,17 @@ +PrivateKeySigner | DWN-SDK Documentation - v0.2.18

A signer that signs using a private key.

+

Implements

Constructors

Properties

Methods

Constructors

Properties

algorithm: string

The name of the signature algorithm used by this signer. +This value will be used as the "alg" parameter in JWS produced. +This parameter is not used by the DWN but is unfortunately a required header property for a JWS as per: +https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.1 +Valid signature algorithm values can be found at https://www.iana.org/assignments/jose/jose.xhtml

+
keyId: string

The ID of the key used by this signer. +This needs to be a fully-qualified ID (ie. prefixed with DID) so that author can be parsed out for processing such as recordId computation. +Example: did:example:alice#key1 +This value will be used as the "kid" parameter in JWS produced. +While this property is not a required property per JWS specification, it is required for DWN authentication.

+

Methods

  • Signs the given content and returns the signature as bytes.

    +

    Parameters

    • content: Uint8Array

    Returns Promise<Uint8Array>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Protocols.html b/classes/Protocols.html new file mode 100644 index 000000000..7e0cc08be --- /dev/null +++ b/classes/Protocols.html @@ -0,0 +1,7 @@ +Protocols | DWN-SDK Documentation - v0.2.18

Class containing Protocol related utility methods.

+

Constructors

Methods

  • Derives public encryptions keys and inject it in the $encryption property for each protocol path segment of the given Protocol definition, +then returns the final encryption-enabled protocol definition. +NOTE: The original definition passed in is unmodified.

    +

    Parameters

    Returns Promise<ProtocolDefinition>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/ProtocolsConfigure.html b/classes/ProtocolsConfigure.html new file mode 100644 index 000000000..1a8d85bb8 --- /dev/null +++ b/classes/ProtocolsConfigure.html @@ -0,0 +1,9 @@ +ProtocolsConfigure | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/ProtocolsQuery.html b/classes/ProtocolsQuery.html new file mode 100644 index 000000000..b8872c62e --- /dev/null +++ b/classes/ProtocolsQuery.html @@ -0,0 +1,11 @@ +ProtocolsQuery | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Records.html b/classes/Records.html new file mode 100644 index 000000000..8220e3e8b --- /dev/null +++ b/classes/Records.html @@ -0,0 +1,43 @@ +Records | DWN-SDK Documentation - v0.2.18

Class containing useful utilities related to the Records interface.

+

Constructors

Methods

  • Constructs the full key derivation path using dataFormats scheme.

    +

    Parameters

    • schema: undefined | string
    • dataFormat: string

    Returns string[]

  • Constructs the full key derivation path using protocolContext scheme.

    +

    Parameters

    • contextId: undefined | string

    Returns string[]

  • Constructs the full key derivation path using protocolPath scheme.

    +

    Parameters

    Returns string[]

  • Constructs the full key derivation path using schemas scheme.

    +

    Parameters

    • schema: undefined | string

    Returns string[]

  • Converts an incoming RecordsFilter into a Filter usable by MessageStore.

    +

    Parameters

    • filter: RecordsFilter

      A RecordsFilter

      +
    • Optional dateSort: DateSort

    Returns Filter

    a generic Filter able to be used with MessageStore.

    +
  • Decrypts the encrypted data in a message reply using the given ancestor private key.

    +

    Parameters

    Returns Promise<Readable>

  • Derives a descendant private key given an ancestor private key and the full absolute derivation path. +NOTE: right now only ECIES-ES256K algorithm is supported for asymmetric encryption, + so we will only derive SECP256K1 key without additional conditional checks

    +

    Parameters

    Returns Promise<Uint8Array>

  • Checks if the filter supports returning published records.

    +

    Parameters

    • filter: RecordsFilter

    Returns boolean

  • Checks if the filter supports returning unpublished records.

    +

    Parameters

    • filter: RecordsFilter

    Returns boolean

  • Extracts the parent context ID from the given context ID.

    +

    Parameters

    • contextId: undefined | string

    Returns undefined | string

  • Normalizes the protocol and schema URLs within a provided RecordsFilter and returns a copy of RecordsFilter with the modified values.

    +

    Parameters

    • filter: RecordsFilter

      incoming RecordsFilter to normalize.

      +

    Returns RecordsFilter

    a copy of the incoming RecordsFilter with the normalized properties.

    +
  • Determines if signature payload contains a protocolRole and should be authorized as such.

    +

    Parameters

    • signaturePayload: GenericSignaturePayload

    Returns boolean

  • Validates that ancestor derivation path matches the descendant derivation path completely.

    +

    Parameters

    • ancestorKeyDerivationPath: string[]
    • descendantKeyDerivationPath: string[]

    Returns void

    Throws

    with DwnErrorCode.RecordsInvalidAncestorKeyDerivationSegment if fails validation.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/RecordsDelete.html b/classes/RecordsDelete.html new file mode 100644 index 000000000..5d8da9677 --- /dev/null +++ b/classes/RecordsDelete.html @@ -0,0 +1,13 @@ +RecordsDelete | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/RecordsQuery.html b/classes/RecordsQuery.html new file mode 100644 index 000000000..7aae5f90b --- /dev/null +++ b/classes/RecordsQuery.html @@ -0,0 +1,13 @@ +RecordsQuery | DWN-SDK Documentation - v0.2.18

A class representing a RecordsQuery DWN message.

+

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

  • Authorizes the delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/RecordsRead.html b/classes/RecordsRead.html new file mode 100644 index 000000000..c07778b1e --- /dev/null +++ b/classes/RecordsRead.html @@ -0,0 +1,14 @@ +RecordsRead | DWN-SDK Documentation - v0.2.18

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/RecordsSubscribe.html b/classes/RecordsSubscribe.html new file mode 100644 index 000000000..10c340679 --- /dev/null +++ b/classes/RecordsSubscribe.html @@ -0,0 +1,13 @@ +RecordsSubscribe | DWN-SDK Documentation - v0.2.18

A class representing a RecordsSubscribe DWN message.

+

Hierarchy

Accessors

  • get signaturePayload(): undefined | GenericSignaturePayload
  • Returns undefined | GenericSignaturePayload

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/RecordsWrite.html b/classes/RecordsWrite.html new file mode 100644 index 000000000..7158cd544 --- /dev/null +++ b/classes/RecordsWrite.html @@ -0,0 +1,65 @@ +RecordsWrite | DWN-SDK Documentation - v0.2.18

A class representing a RecordsWrite DWN message. +NOTE: Unable to extend AbstractMessage directly because the incompatible _message type, which is not just a generic <M> type.

+

Implements

Properties

attesters: string[]

Accessors

  • get ownerSignaturePayload(): undefined | GenericSignaturePayload
  • Decoded owner signature payload.

    +

    Returns undefined | GenericSignaturePayload

  • get signaturePayload(): undefined | RecordsWriteSignaturePayload
  • Returns undefined | RecordsWriteSignaturePayload

  • get signer(): undefined | string
  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

  • Authorizes the delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

  • Encrypts the symmetric encryption key using the public keys given and attach the resulting encryption property to the RecordsWrite.

    +

    Parameters

    Returns Promise<void>

  • Checks if the author of the RecordsWrite is the same as the author of the initial RecordsWrite for the record. +Returns true if this is the initial RecordsWrite.

    +

    Parameters

    Returns Promise<boolean>

  • Signs the RecordsWrite, commonly as author, but can also be a delegate.

    +

    Parameters

    • options: {
          delegatedGrant?: DelegatedGrantMessage;
          permissionsGrantId?: string;
          protocolRole?: string;
          signer: Signer;
      }
      • Optional delegatedGrant?: DelegatedGrantMessage
      • Optional permissionsGrantId?: string
      • Optional protocolRole?: string
      • signer: Signer

    Returns Promise<void>

  • Signs the RecordsWrite as the DWN owner. +This is used when the DWN owner wants to retain a copy of a message that the owner did not author. +NOTE: requires the RecordsWrite to already have the author's signature already.

    +

    Parameters

    • signer: Signer
    • Optional permissionsGrantId: string

    Returns Promise<void>

  • Creates the attestation property of a RecordsWrite message if given signature inputs; returns undefined otherwise.

    +

    Parameters

    • descriptorCid: string
    • Optional signers: Signer[]

    Returns Promise<undefined | GeneralJws>

  • Convenience method that creates a message by:

    +
      +
    1. Copying over immutable properties from the given source message
    2. +
    3. Copying over mutable properties that are not overwritten from the given source message
    4. +
    5. Replace the mutable properties that are given new value
    6. +
    +

    Parameters

    Returns Promise<RecordsWrite>

  • Creates the signature property in the authorization of a RecordsWrite message.

    +

    Parameters

    • input: {
          attestation: undefined | GeneralJws;
          contextId: undefined | string;
          delegatedGrantId?: string;
          descriptorCid: string;
          encryption: undefined | EncryptionProperty;
          permissionsGrantId?: string;
          protocolRole?: string;
          recordId: string;
          signer: Signer;
      }
      • attestation: undefined | GeneralJws
      • contextId: undefined | string
      • Optional delegatedGrantId?: string
      • descriptorCid: string
      • encryption: undefined | EncryptionProperty
      • Optional permissionsGrantId?: string
      • Optional protocolRole?: string
      • recordId: string
      • signer: Signer

    Returns Promise<GeneralJws>

  • Gets the DID of the author of the given message.

    +

    Parameters

    • message: InternalRecordsWriteMessage

    Returns string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Secp256k1.html b/classes/Secp256k1.html new file mode 100644 index 000000000..eaba8ce45 --- /dev/null +++ b/classes/Secp256k1.html @@ -0,0 +1,34 @@ +Secp256k1 | DWN-SDK Documentation - v0.2.18

Class containing SECP256K1 related utility methods.

+

Constructors

Methods

  • Derives a child private key using the given derivation path segment.

    +

    Parameters

    • privateKey: Uint8Array
    • derivationPathSegment: Uint8Array

    Returns Promise<Uint8Array>

  • Derives a hardened hierarchical deterministic private key.

    +

    Parameters

    • privateKey: Uint8Array
    • relativePath: string[]

    Returns Promise<Uint8Array>

  • Derives a hardened hierarchical deterministic public key.

    +

    Parameters

    • privateKey: Uint8Array
    • relativePath: string[]

    Returns Promise<Uint8Array>

    uncompressed public key

    +
  • Generates key pair in raw bytes, where the publicKey is compressed.

    +

    Returns Promise<{
        privateKey: Uint8Array;
        publicKey: Uint8Array;
    }>

  • Gets the compressed public key of the given private key.

    +

    Parameters

    • privateKey: Uint8Array

    Returns Promise<Uint8Array>

  • Creates a private key in raw bytes from the given SECP256K1 JWK.

    +

    Parameters

    Returns Uint8Array

  • Creates a compressed key in raw bytes from the given SECP256K1 JWK.

    +

    Parameters

    Returns Uint8Array

  • Signs the provided content using the provided JWK.

    +

    Parameters

    Returns Promise<Uint8Array>

  • Verifies a signature against the provided payload hash and public key.

    +

    Parameters

    • content: Uint8Array
    • signature: Uint8Array
    • publicJwk: PublicJwk

    Returns Promise<boolean>

    a boolean indicating whether the signature is valid.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/TestDataGenerator.html b/classes/TestDataGenerator.html new file mode 100644 index 000000000..c2ee5c1f3 --- /dev/null +++ b/classes/TestDataGenerator.html @@ -0,0 +1,65 @@ +TestDataGenerator | DWN-SDK Documentation - v0.2.18

Utility class for generating data for testing.

+

Constructors

Methods

  • Generates a dummy authorization property for a DWN message that only conforms to schema validation.

    +

    Returns AuthorizationModel

  • Generates a dummy authorization property for a DWN message that only conforms to schema validation.

    +

    Returns GeneralJws

  • Parameters

    • Optional input: GenerateEventsGetInput

    Returns Promise<GenerateEventsGetOutput>

  • Parameters

    • input: GenerateEventsQueryInput

    Returns Promise<GenerateEventsQueryOutput>

  • Generates a EventsSubscribe message for testing.

    +

    Parameters

    • Optional input: GenerateEventsSubscribeInput

    Returns Promise<GenerateEventsSubscribeOutput>

  • Generates a valid RecordsWrite that modifies the given an existing write. +Any mutable property is not specified will be automatically mutated. +e.g. if published is not specified, it will be toggled from the state of the given existing write.

    +

    Parameters

    • input: GenerateFromRecordsWriteInput

    Returns Promise<GenerateFromRecordsWriteOut>

  • Parameters

    • input: GenerateMessagesGetInput

    Returns Promise<GenerateMessagesGetOutput>

  • Generates a PermissionsGrant message for testing.

    +

    Parameters

    • Optional input: GeneratePermissionsGrantInput

    Returns Promise<GeneratePermissionsGrantOutput>

  • Generates a PermissionsRequest message for testing.

    +

    Parameters

    • Optional input: GeneratePermissionsRequestInput

    Returns Promise<GeneratePermissionsRequestOutput>

  • Generates a PermissionsRevoke message for testing.

    +

    Parameters

    • Optional input: GeneratePermissionsRevokeInput

    Returns Promise<GeneratePermissionsRevokeOutput>

  • Generates a encrypted RecordsWrite message for testing.

    +

    Parameters

    • input: {
          author: Persona;
          encryptSymmetricKeyWithProtocolContextDerivedKey: boolean;
          encryptSymmetricKeyWithProtocolPathDerivedKey: boolean;
          plaintextBytes: Uint8Array;
          protocolContextDerivedPublicJwk?: PublicJwk;
          protocolContextDerivingRootKeyId?: string;
          protocolDefinition: ProtocolDefinition;
          protocolParentContextId?: string;
          protocolPath: string;
          recipient?: string;
      }
      • author: Persona
      • encryptSymmetricKeyWithProtocolContextDerivedKey: boolean

        Set to true to attach the symmetric key encrypted by the protocol context derived public key

        +
      • encryptSymmetricKeyWithProtocolPathDerivedKey: boolean

        Set to true to attach the symmetric key encrypted by the protocol path derived public key

        +
      • plaintextBytes: Uint8Array
      • Optional protocolContextDerivedPublicJwk?: PublicJwk
      • Optional protocolContextDerivingRootKeyId?: string
      • protocolDefinition: ProtocolDefinition

        Protocol definition used to generate the RecordsWrite. + Must be the RECIPIENT's protocol definition if encryptSymmetricKeyWithProtocolPathDerivedKey is true, + because the recipient's public keys will be needed to encrypt the symmetric key.

        +
      • Optional protocolParentContextId?: string
      • protocolPath: string
      • Optional recipient?: string

    Returns Promise<{
        dataStream: Readable;
        encryptedDataBytes: Uint8Array;
        encryptionInput: EncryptionInput;
        message: RecordsWriteMessage;
        recordsWrite: RecordsWrite;
    }>

  • Generates a ProtocolsConfigure message for testing. +Optional parameters are generated if not given. +Implementation currently uses ProtocolsConfigure.create().

    +

    Parameters

    • Optional input: GenerateProtocolsConfigureInput

    Returns Promise<GenerateProtocolsConfigureOutput>

  • Generates a ProtocolsQuery message for testing.

    +

    Parameters

    • Optional input: GenerateProtocolsQueryInput

    Returns Promise<GenerateProtocolsQueryOutput>

  • Generates a RecordsDelete for testing.

    +

    Parameters

    • Optional input: GenerateRecordsDeleteInput

    Returns Promise<GenerateRecordsDeleteOutput>

  • Generates a RecordsQuery message for testing.

    +

    Parameters

    • Optional input: GenerateRecordsQueryInput

    Returns Promise<GenerateRecordsQueryOutput>

  • Generates a RecordsSubscribe message for testing.

    +

    Parameters

    • Optional input: GenerateRecordsSubscribeInput

    Returns Promise<GenerateRecordsSubscribeOutput>

  • Generates a RecordsWrite message for testing. +Implementation currently uses RecordsWrite.create().

    +

    Parameters

    • Optional input: GenerateRecordsWriteInput

    Returns Promise<GenerateRecordsWriteOutput>

  • Generates a random within a range (inclusive).

    +

    Parameters

    • min: number

      lowest potential value.

      +
    • max: number

      greatest potential value.

      +

    Returns number

  • Generates a random timestamp. Optionally allows you to set specific non-randomized values for the timestamp.

    +

    Parameters

    • Optional options: {
          day?: number;
          hour?: number;
          microsecond?: number;
          millisecond?: number;
          minute?: number;
          month?: number;
          second?: number;
          year?: number;
      }
      • Optional day?: number
      • Optional hour?: number
      • Optional microsecond?: number
      • Optional millisecond?: number
      • Optional minute?: number
      • Optional month?: number
      • Optional second?: number
      • Optional year?: number

    Returns string

    random UTC ISO-8601 timestamp

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Time.html b/classes/Time.html new file mode 100644 index 000000000..32edcfe9e --- /dev/null +++ b/classes/Time.html @@ -0,0 +1,24 @@ +Time | DWN-SDK Documentation - v0.2.18

Time related utilities.

+

Constructors

Methods

  • Creates a UTC ISO-8601 timestamp offset from now or given timestamp accepted by DWN.

    +

    Parameters

    • offset: {
          seconds: number;
      }

      Negative number means offset into the past.

      +
      • seconds: number
    • Optional timestamp: string

    Returns string

  • Creates a UTC ISO-8601 timestamp in microsecond precision accepted by DWN.

    +

    Parameters

    • options: {
          day?: number;
          hour?: number;
          microsecond?: number;
          millisecond?: number;
          minute?: number;
          month?: number;
          second?: number;
          year?: number;
      }

      Options for creating the timestamp.

      +
      • Optional day?: number
      • Optional hour?: number
      • Optional microsecond?: number
      • Optional millisecond?: number
      • Optional minute?: number
      • Optional month?: number
      • Optional second?: number
      • Optional year?: number

    Returns string

    string

    +
  • Returns an UTC ISO-8601 timestamp with microsecond precision accepted by DWN. +using @js-temporal/polyfill

    +

    Returns string

  • sleeps for the desired duration

    +

    Parameters

    • durationInMillisecond: number

      the desired amount of sleep time

      +

    Returns Promise<void>

    when the provided duration has passed

    +
  • Validates that the provided timestamp is a valid number

    +

    Parameters

    • timestamp: string

      the timestamp to validate

      +

    Returns void

    Throws

    DwnError if timestamp is not a valid number

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/DateSort.html b/enums/DateSort.html new file mode 100644 index 000000000..e814f5a1c --- /dev/null +++ b/enums/DateSort.html @@ -0,0 +1,5 @@ +DateSort | DWN-SDK Documentation - v0.2.18

Enumeration DateSort

Enumeration Members

CreatedAscending: "createdAscending"
CreatedDescending: "createdDescending"
PublishedAscending: "publishedAscending"
PublishedDescending: "publishedDescending"

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/DwnErrorCode.html b/enums/DwnErrorCode.html new file mode 100644 index 000000000..4e8a1b048 --- /dev/null +++ b/enums/DwnErrorCode.html @@ -0,0 +1,135 @@ +DwnErrorCode | DWN-SDK Documentation - v0.2.18

Enumeration DwnErrorCode

DWN SDK error codes.

+

Enumeration Members

AuthenticateDescriptorCidMismatch +AuthenticateJwsMissing +AuthenticationMoreThanOneSignatureNotSupported +AuthorizationAuthorNotOwner +AuthorizationNotGrantedToAuthor +ComputeCidCodecNotSupported +ComputeCidMultihashNotSupported +DidMethodNotSupported +DidNotString +DidNotValid +DidResolutionFailed +Ed25519InvalidJwk +EventEmitterStreamNotOpenError +EventsSubscribeEventStreamUnimplemented +GeneralJwsVerifierGetPublicKeyNotFound +GeneralJwsVerifierInvalidSignature +GrantAuthorizationGrantExpired +GrantAuthorizationGrantMissing +GrantAuthorizationGrantNotYetActive +GrantAuthorizationGrantRevoked +GrantAuthorizationInterfaceMismatch +GrantAuthorizationMethodMismatch +GrantAuthorizationNotGrantedForTenant +GrantAuthorizationNotGrantedToAuthor +HdKeyDerivationPathInvalid +IndexInvalidCursorSortProperty +IndexInvalidCursorValueType +IndexInvalidSortPropertyInMemory +IndexMissingIndexableProperty +JwsDecodePlainObjectPayloadInvalid +JwsVerifySignatureUnsupportedCrv +MessageGetInvalidCid +ParseCidCodecNotSupported +ParseCidMultihashNotSupported +PermissionsGrantGrantedByMismatch +PermissionsGrantNotADelegatedGrant +PermissionsGrantScopeContextIdAndProtocolPath +PermissionsGrantScopeSchemaProhibitedFields +PermissionsGrantUnauthorizedGrant +PermissionsRevokeMissingPermissionsGrant +PermissionsRevokeUnauthorizedRevoke +PrivateKeySignerUnableToDeduceAlgorithm +PrivateKeySignerUnableToDeduceKeyId +PrivateKeySignerUnsupportedCurve +ProtocolAuthorizationActionNotAllowed +ProtocolAuthorizationActionRulesNotFound +ProtocolAuthorizationDuplicateRoleRecipient +ProtocolAuthorizationIncorrectContextId +ProtocolAuthorizationIncorrectDataFormat +ProtocolAuthorizationIncorrectProtocolPath +ProtocolAuthorizationInvalidSchema +ProtocolAuthorizationInvalidType +ProtocolAuthorizationMatchingRoleRecordNotFound +ProtocolAuthorizationMaxSizeInvalid +ProtocolAuthorizationMinSizeInvalid +ProtocolAuthorizationMissingContextId +ProtocolAuthorizationMissingRuleSet +ProtocolAuthorizationNotARole +ProtocolAuthorizationParentNotFoundConstructingAncestorChain +ProtocolAuthorizationParentlessIncorrectProtocolPath +ProtocolAuthorizationProtocolNotFound +ProtocolAuthorizationQueryWithoutRole +ProtocolAuthorizationRoleMissingRecipient +ProtocolsConfigureInvalidActionMissingOf +ProtocolsConfigureInvalidActionOfNotAllowed +ProtocolsConfigureInvalidRecipientOfAction +ProtocolsConfigureInvalidRuleSetRecordType +ProtocolsConfigureInvalidSize +ProtocolsConfigureQueryNotAllowed +ProtocolsConfigureRecordNestingDepthExceeded +ProtocolsConfigureRoleDoesNotExistAtGivenPath +ProtocolsConfigureUnauthorized +ProtocolsQueryUnauthorized +RecordsDecryptNoMatchingKeyEncryptedFound +RecordsDeleteAuthorizationFailed +RecordsDerivePrivateKeyUnSupportedCurve +RecordsGrantAuthorizationConditionPublicationProhibited +RecordsGrantAuthorizationConditionPublicationRequired +RecordsGrantAuthorizationDeleteProtocolScopeMismatch +RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch +RecordsGrantAuthorizationScopeContextIdMismatch +RecordsGrantAuthorizationScopeNotProtocol +RecordsGrantAuthorizationScopeProtocolMismatch +RecordsGrantAuthorizationScopeProtocolPathMismatch +RecordsGrantAuthorizationScopeSchema +RecordsInvalidAncestorKeyDerivationSegment +RecordsProtocolContextDerivationSchemeMissingContextId +RecordsProtocolPathDerivationSchemeMissingProtocol +RecordsQueryCreateFilterPublishedSortInvalid +RecordsQueryFilterMissingRequiredProperties +RecordsQueryParseFilterPublishedSortInvalid +RecordsReadAuthorizationFailed +RecordsReadReturnedMultiple +RecordsSchemasDerivationSchemeMissingSchema +RecordsSubscribeEventStreamUnimplemented +RecordsSubscribeFilterMissingRequiredProperties +RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch +RecordsValidateIntegrityGrantedToAndSignerMismatch +RecordsWriteAttestationIntegrityDescriptorCidMismatch +RecordsWriteAttestationIntegrityInvalidPayloadProperty +RecordsWriteAttestationIntegrityMoreThanOneSignature +RecordsWriteAuthorizationFailed +RecordsWriteCreateDataAndDataCidMutuallyExclusive +RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive +RecordsWriteCreateMissingSigner +RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive +RecordsWriteDataCidMismatch +RecordsWriteDataSizeMismatch +RecordsWriteGetEntryIdUndefinedAuthor +RecordsWriteGetInitialWriteNotFound +RecordsWriteImmutablePropertyChanged +RecordsWriteMissingDataInPrevious +RecordsWriteMissingDataStream +RecordsWriteMissingEncodedDataInPrevious +RecordsWriteMissingProtocol +RecordsWriteMissingSchema +RecordsWriteMissingSigner +RecordsWriteOwnerAndTenantMismatch +RecordsWriteSignAsOwnerUnknownAuthor +RecordsWriteValidateIntegrityAttestationMismatch +RecordsWriteValidateIntegrityContextIdMismatch +RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload +RecordsWriteValidateIntegrityDateCreatedMismatch +RecordsWriteValidateIntegrityEncryptionCidMismatch +RecordsWriteValidateIntegrityRecordIdUnauthorized +SchemaValidationFailure +SchemaValidatorSchemaNotFound +Secp256k1KeyNotValid +TimestampInvalid +UrlProtocolNotNormalizable +UrlProtocolNotNormalized +UrlSchemaNotNormalizable +UrlSchemaNotNormalized +

Enumeration Members

AuthenticateDescriptorCidMismatch: "AuthenticateDescriptorCidMismatch"
AuthenticateJwsMissing: "AuthenticateJwsMissing"
AuthenticationMoreThanOneSignatureNotSupported: "AuthenticationMoreThanOneSignatureNotSupported"
AuthorizationAuthorNotOwner: "AuthorizationAuthorNotOwner"
AuthorizationNotGrantedToAuthor: "AuthorizationNotGrantedToAuthor"
ComputeCidCodecNotSupported: "ComputeCidCodecNotSupported"
ComputeCidMultihashNotSupported: "ComputeCidMultihashNotSupported"
DidMethodNotSupported: "DidMethodNotSupported"
DidNotString: "DidNotString"
DidNotValid: "DidNotValid"
DidResolutionFailed: "DidResolutionFailed"
Ed25519InvalidJwk: "Ed25519InvalidJwk"
EventEmitterStreamNotOpenError: "EventEmitterStreamNotOpenError"
EventsSubscribeEventStreamUnimplemented: "EventsSubscribeEventStreamUnimplemented"
GeneralJwsVerifierGetPublicKeyNotFound: "GeneralJwsVerifierGetPublicKeyNotFound"
GeneralJwsVerifierInvalidSignature: "GeneralJwsVerifierInvalidSignature"
GrantAuthorizationGrantExpired: "GrantAuthorizationGrantExpired"
GrantAuthorizationGrantMissing: "GrantAuthorizationGrantMissing"
GrantAuthorizationGrantNotYetActive: "GrantAuthorizationGrantNotYetActive"
GrantAuthorizationGrantRevoked: "GrantAuthorizationGrantRevoked"
GrantAuthorizationInterfaceMismatch: "GrantAuthorizationInterfaceMismatch"
GrantAuthorizationMethodMismatch: "GrantAuthorizationMethodMismatch"
GrantAuthorizationNotGrantedForTenant: "GrantAuthorizationNotGrantedForTenant"
GrantAuthorizationNotGrantedToAuthor: "GrantAuthorizationNotGrantedToAuthor"
HdKeyDerivationPathInvalid: "HdKeyDerivationPathInvalid"
IndexInvalidCursorSortProperty: "IndexInvalidCursorSortProperty"
IndexInvalidCursorValueType: "IndexInvalidCursorValueType"
IndexInvalidSortPropertyInMemory: "IndexInvalidSortPropertyInMemory"
IndexMissingIndexableProperty: "IndexMissingIndexableProperty"
JwsDecodePlainObjectPayloadInvalid: "JwsDecodePlainObjectPayloadInvalid"
JwsVerifySignatureUnsupportedCrv: "JwsVerifySignatureUnsupportedCrv"
MessageGetInvalidCid: "MessageGetInvalidCid"
ParseCidCodecNotSupported: "ParseCidCodecNotSupported"
ParseCidMultihashNotSupported: "ParseCidMultihashNotSupported"
PermissionsGrantGrantedByMismatch: "PermissionsGrantGrantedByMismatch"
PermissionsGrantNotADelegatedGrant: "PermissionsGrantNotADelegatedGrant"
PermissionsGrantScopeContextIdAndProtocolPath: "PermissionsGrantScopeContextIdAndProtocolPath"
PermissionsGrantScopeSchemaProhibitedFields: "PermissionsGrantScopeSchemaProhibitedFields"
PermissionsGrantUnauthorizedGrant: "PermissionsGrantUnauthorizedGrant"
PermissionsRevokeMissingPermissionsGrant: "PermissionsRevokeMissingPermissionsGrant"
PermissionsRevokeUnauthorizedRevoke: "PermissionsRevokeUnauthorizedRevoke"
PrivateKeySignerUnableToDeduceAlgorithm: "PrivateKeySignerUnableToDeduceAlgorithm"
PrivateKeySignerUnableToDeduceKeyId: "PrivateKeySignerUnableToDeduceKeyId"
PrivateKeySignerUnsupportedCurve: "PrivateKeySignerUnsupportedCurve"
ProtocolAuthorizationActionNotAllowed: "ProtocolAuthorizationActionNotAllowed"
ProtocolAuthorizationActionRulesNotFound: "ProtocolAuthorizationActionRulesNotFound"
ProtocolAuthorizationDuplicateRoleRecipient: "ProtocolAuthorizationDuplicateRoleRecipient"
ProtocolAuthorizationIncorrectContextId: "ProtocolAuthorizationIncorrectContextId"
ProtocolAuthorizationIncorrectDataFormat: "ProtocolAuthorizationIncorrectDataFormat"
ProtocolAuthorizationIncorrectProtocolPath: "ProtocolAuthorizationIncorrectProtocolPath"
ProtocolAuthorizationInvalidSchema: "ProtocolAuthorizationInvalidSchema"
ProtocolAuthorizationInvalidType: "ProtocolAuthorizationInvalidType"
ProtocolAuthorizationMatchingRoleRecordNotFound: "ProtocolAuthorizationMatchingRoleRecordNotFound"
ProtocolAuthorizationMaxSizeInvalid: "ProtocolAuthorizationMaxSizeInvalid"
ProtocolAuthorizationMinSizeInvalid: "ProtocolAuthorizationMinSizeInvalid"
ProtocolAuthorizationMissingContextId: "ProtocolAuthorizationMissingContextId"
ProtocolAuthorizationMissingRuleSet: "ProtocolAuthorizationMissingRuleSet"
ProtocolAuthorizationNotARole: "ProtocolAuthorizationNotARole"
ProtocolAuthorizationParentNotFoundConstructingAncestorChain: "ProtocolAuthorizationParentNotFoundConstructingAncestorChain"
ProtocolAuthorizationParentlessIncorrectProtocolPath: "ProtocolAuthorizationParentlessIncorrectProtocolPath"
ProtocolAuthorizationProtocolNotFound: "ProtocolAuthorizationProtocolNotFound"
ProtocolAuthorizationQueryWithoutRole: "ProtocolAuthorizationQueryWithoutRole"
ProtocolAuthorizationRoleMissingRecipient: "ProtocolAuthorizationRoleMissingRecipient"
ProtocolsConfigureInvalidActionMissingOf: "ProtocolsConfigureInvalidActionMissingOf"
ProtocolsConfigureInvalidActionOfNotAllowed: "ProtocolsConfigureInvalidActionOfNotAllowed"
ProtocolsConfigureInvalidRecipientOfAction: "ProtocolsConfigureInvalidRecipientOfAction"
ProtocolsConfigureInvalidRuleSetRecordType: "ProtocolsConfigureInvalidRuleSetRecordType"
ProtocolsConfigureInvalidSize: "ProtocolsConfigureInvalidSize"
ProtocolsConfigureQueryNotAllowed: "ProtocolsConfigureQueryNotAllowed"
ProtocolsConfigureRecordNestingDepthExceeded: "ProtocolsConfigureRecordNestingDepthExceeded"
ProtocolsConfigureRoleDoesNotExistAtGivenPath: "ProtocolsConfigureRoleDoesNotExistAtGivenPath"
ProtocolsConfigureUnauthorized: "ProtocolsConfigureUnauthorized"
ProtocolsQueryUnauthorized: "ProtocolsQueryUnauthorized"
RecordsDecryptNoMatchingKeyEncryptedFound: "RecordsDecryptNoMatchingKeyEncryptedFound"
RecordsDeleteAuthorizationFailed: "RecordsDeleteAuthorizationFailed"
RecordsDerivePrivateKeyUnSupportedCurve: "RecordsDerivePrivateKeyUnSupportedCurve"
RecordsGrantAuthorizationConditionPublicationProhibited: "RecordsGrantAuthorizationConditionPublicationProhibited"
RecordsGrantAuthorizationConditionPublicationRequired: "RecordsGrantAuthorizationConditionPublicationRequired"
RecordsGrantAuthorizationDeleteProtocolScopeMismatch: "RecordsGrantAuthorizationDeleteProtocolScopeMismatch"
RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch: "RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch"
RecordsGrantAuthorizationScopeContextIdMismatch: "RecordsGrantAuthorizationScopeContextIdMismatch"
RecordsGrantAuthorizationScopeNotProtocol: "RecordsGrantAuthorizationScopeNotProtocol"
RecordsGrantAuthorizationScopeProtocolMismatch: "RecordsGrantAuthorizationScopeProtocolMismatch"
RecordsGrantAuthorizationScopeProtocolPathMismatch: "RecordsGrantAuthorizationScopeProtocolPathMismatch"
RecordsGrantAuthorizationScopeSchema: "RecordsGrantAuthorizationScopeSchema"
RecordsInvalidAncestorKeyDerivationSegment: "RecordsInvalidAncestorKeyDerivationSegment"
RecordsProtocolContextDerivationSchemeMissingContextId: "RecordsProtocolContextDerivationSchemeMissingContextId"
RecordsProtocolPathDerivationSchemeMissingProtocol: "RecordsProtocolPathDerivationSchemeMissingProtocol"
RecordsQueryCreateFilterPublishedSortInvalid: "RecordsQueryCreateFilterPublishedSortInvalid"
RecordsQueryFilterMissingRequiredProperties: "RecordsQueryFilterMissingRequiredProperties"
RecordsQueryParseFilterPublishedSortInvalid: "RecordsQueryParseFilterPublishedSortInvalid"
RecordsReadAuthorizationFailed: "RecordsReadAuthorizationFailed"
RecordsReadReturnedMultiple: "RecordsReadReturnedMultiple"
RecordsSchemasDerivationSchemeMissingSchema: "RecordsSchemasDerivationSchemeMissingSchema"
RecordsSubscribeEventStreamUnimplemented: "RecordsSubscribeEventStreamUnimplemented"
RecordsSubscribeFilterMissingRequiredProperties: "RecordsSubscribeFilterMissingRequiredProperties"
RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch: "RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch"
RecordsValidateIntegrityGrantedToAndSignerMismatch: "RecordsValidateIntegrityGrantedToAndSignerMismatch"
RecordsWriteAttestationIntegrityDescriptorCidMismatch: "RecordsWriteAttestationIntegrityDescriptorCidMismatch"
RecordsWriteAttestationIntegrityInvalidPayloadProperty: "RecordsWriteAttestationIntegrityInvalidPayloadProperty"
RecordsWriteAttestationIntegrityMoreThanOneSignature: "RecordsWriteAttestationIntegrityMoreThanOneSignature"
RecordsWriteAuthorizationFailed: "RecordsWriteAuthorizationFailed"
RecordsWriteCreateDataAndDataCidMutuallyExclusive: "RecordsWriteCreateDataAndDataCidMutuallyExclusive"
RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive: "RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive"
RecordsWriteCreateMissingSigner: "RecordsWriteCreateMissingSigner"
RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive: "RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive"
RecordsWriteDataCidMismatch: "RecordsWriteDataCidMismatch"
RecordsWriteDataSizeMismatch: "RecordsWriteDataSizeMismatch"
RecordsWriteGetEntryIdUndefinedAuthor: "RecordsWriteGetEntryIdUndefinedAuthor"
RecordsWriteGetInitialWriteNotFound: "RecordsWriteGetInitialWriteNotFound"
RecordsWriteImmutablePropertyChanged: "RecordsWriteImmutablePropertyChanged"
RecordsWriteMissingDataInPrevious: "RecordsWriteMissingDataInPrevious"
RecordsWriteMissingDataStream: "RecordsWriteMissingDataStream"
RecordsWriteMissingEncodedDataInPrevious: "RecordsWriteMissingEncodedDataInPrevious"
RecordsWriteMissingProtocol: "RecordsWriteMissingProtocol"
RecordsWriteMissingSchema: "RecordsWriteMissingSchema"
RecordsWriteMissingSigner: "RecordsWriteMissingSigner"
RecordsWriteOwnerAndTenantMismatch: "RecordsWriteOwnerAndTenantMismatch"
RecordsWriteSignAsOwnerUnknownAuthor: "RecordsWriteSignAsOwnerUnknownAuthor"
RecordsWriteValidateIntegrityAttestationMismatch: "RecordsWriteValidateIntegrityAttestationMismatch"
RecordsWriteValidateIntegrityContextIdMismatch: "RecordsWriteValidateIntegrityContextIdMismatch"
RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload: "RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload"
RecordsWriteValidateIntegrityDateCreatedMismatch: "RecordsWriteValidateIntegrityDateCreatedMismatch"
RecordsWriteValidateIntegrityEncryptionCidMismatch: "RecordsWriteValidateIntegrityEncryptionCidMismatch"
RecordsWriteValidateIntegrityRecordIdUnauthorized: "RecordsWriteValidateIntegrityRecordIdUnauthorized"
SchemaValidationFailure: "SchemaValidationFailure"
SchemaValidatorSchemaNotFound: "SchemaValidatorSchemaNotFound"
Secp256k1KeyNotValid: "Secp256k1KeyNotValid"
TimestampInvalid: "TimestampInvalid"
UrlProtocolNotNormalizable: "UrlProtocolNotNormalizable"
UrlProtocolNotNormalized: "UrlProtocolNotNormalized"
UrlSchemaNotNormalizable: "UrlSchemaNotNormalizable"
UrlSchemaNotNormalized: "UrlSchemaNotNormalized"

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/DwnInterfaceName.html b/enums/DwnInterfaceName.html new file mode 100644 index 000000000..afd65bbef --- /dev/null +++ b/enums/DwnInterfaceName.html @@ -0,0 +1,6 @@ +DwnInterfaceName | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/DwnMethodName.html b/enums/DwnMethodName.html new file mode 100644 index 000000000..df1f6ac31 --- /dev/null +++ b/enums/DwnMethodName.html @@ -0,0 +1,12 @@ +DwnMethodName | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/EncryptionAlgorithm.html b/enums/EncryptionAlgorithm.html new file mode 100644 index 000000000..2d9c3d80f --- /dev/null +++ b/enums/EncryptionAlgorithm.html @@ -0,0 +1,3 @@ +EncryptionAlgorithm | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/KeyDerivationScheme.html b/enums/KeyDerivationScheme.html new file mode 100644 index 000000000..565759a91 --- /dev/null +++ b/enums/KeyDerivationScheme.html @@ -0,0 +1,7 @@ +KeyDerivationScheme | DWN-SDK Documentation - v0.2.18

Enumeration KeyDerivationScheme

Enumeration Members

DataFormats: "dataFormats"

Key derivation using the dataFormat value for Flat-space records.

+
ProtocolContext: "protocolContext"
ProtocolPath: "protocolPath"
Schemas: "schemas"

Key derivation using the schema value for Flat-space records.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/SortDirection.html b/enums/SortDirection.html new file mode 100644 index 000000000..b95625c0d --- /dev/null +++ b/enums/SortDirection.html @@ -0,0 +1,3 @@ +SortDirection | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/authenticate.html b/functions/authenticate.html new file mode 100644 index 000000000..160711765 --- /dev/null +++ b/functions/authenticate.html @@ -0,0 +1,3 @@ +authenticate | DWN-SDK Documentation - v0.2.18
  • Verifies all the signature(s) within the authorization property.

    +

    Parameters

    • authorizationModel: undefined | AuthorizationModel
    • didResolver: DidResolver

    Returns Promise<void>

    Throws

    if fails authentication

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/executeUnlessAborted.html b/functions/executeUnlessAborted.html new file mode 100644 index 000000000..a77adb309 --- /dev/null +++ b/functions/executeUnlessAborted.html @@ -0,0 +1,2 @@ +executeUnlessAborted | DWN-SDK Documentation - v0.2.18

Function executeUnlessAborted

  • Wraps the given Promise such that it will reject if the AbortSignal is triggered.

    +

    Type Parameters

    • T

    Parameters

    • promise: Promise<T>
    • signal: undefined | AbortSignal

    Returns Promise<T>

Generated using TypeDoc

\ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html new file mode 100644 index 000000000..7b21ae079 --- /dev/null +++ b/hierarchy.html @@ -0,0 +1 @@ +DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 000000000..d8150b3ff --- /dev/null +++ b/index.html @@ -0,0 +1,133 @@ +DWN-SDK Documentation - v0.2.18

DWN-SDK Documentation - v0.2.18

Index

Enumerations

Classes

Interfaces

Type Aliases

ActiveTenantCheckResult +CreateFromOptions +DataStoreGetResult +DataStorePutResult +DerivedPrivateJwk +DwnConfig +EncryptionInput +EncryptionProperty +EqualFilter +EventSubscriptionHandler +EventsGetMessage +EventsGetOptions +EventsGetReply +EventsQueryMessage +EventsQueryOptions +EventsQueryReply +EventsSubscribeDescriptor +EventsSubscribeMessage +EventsSubscribeOptions +EventsSubscribeReply +Filter +GenericMessage +GenericMessageReply +KeyEncryptionInput +KeyMaterial +MessageEvent +MessageSort +MessagesGetMessage +MessagesGetOptions +MessagesGetReply +MessagesGetReplyEntry +OneOfFilter +Pagination +PaginationCursor +PermissionConditions +PermissionScope +PermissionsGrantDescriptor +PermissionsGrantMessage +PermissionsGrantOptions +PermissionsRequestDescriptor +PermissionsRequestMessage +PermissionsRequestOptions +PermissionsRevokeDescriptor +PermissionsRevokeMessage +PermissionsRevokeOptions +Persona +PrivateJwk +ProtocolDefinition +ProtocolRuleSet +ProtocolTypes +ProtocolsConfigureDescriptor +ProtocolsConfigureMessage +ProtocolsConfigureOptions +ProtocolsQueryFilter +ProtocolsQueryMessage +ProtocolsQueryOptions +ProtocolsQueryReply +PublicJwk +QueryOptions +QueryResultEntry +RangeCriterion +RangeFilter +RecordsDeleteMessage +RecordsDeleteOptions +RecordsQueryMessage +RecordsQueryOptions +RecordsQueryReply +RecordsQueryReplyEntry +RecordsReadMessage +RecordsReadOptions +RecordsReadReply +RecordsSubscribeDescriptor +RecordsSubscribeMessage +RecordsSubscribeOptions +RecordsSubscribeReply +RecordsWriteDescriptor +RecordsWriteMessage +RecordsWriteOptions +SubscriptionReply +UnionMessageReply +

Functions

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/DataStore.html b/interfaces/DataStore.html new file mode 100644 index 000000000..429a80318 --- /dev/null +++ b/interfaces/DataStore.html @@ -0,0 +1,21 @@ +DataStore | DWN-SDK Documentation - v0.2.18

The interface that defines how to store and fetch data associated with a message.

+
interface DataStore {
    clear(): Promise<void>;
    close(): Promise<void>;
    delete(tenant, recordId, dataCid): Promise<void>;
    get(tenant, recordId, dataCid): Promise<undefined | DataStoreGetResult>;
    open(): Promise<void>;
    put(tenant, recordId, dataCid, dataStream): Promise<DataStorePutResult>;
}

Implemented by

Methods

Methods

  • Clears the entire store. Mainly used for testing to cleaning up in test environments.

    +

    Returns Promise<void>

  • Deletes the specified data. No-op if the data does not exist.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<void>

  • Fetches the specified data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<undefined | DataStoreGetResult>

    the data size and data stream if found, otherwise undefined.

    +
  • Stores the given data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +
    • dataStream: Readable

    Returns Promise<DataStorePutResult>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/EventLog.html b/interfaces/EventLog.html new file mode 100644 index 000000000..40d839c1c --- /dev/null +++ b/interfaces/EventLog.html @@ -0,0 +1,25 @@ +EventLog | DWN-SDK Documentation - v0.2.18
interface EventLog {
    append(tenant, messageCid, indexes): Promise<void>;
    clear(): Promise<void>;
    close(): Promise<void>;
    deleteEventsByCid(tenant, messageCids): Promise<void>;
    getEvents(tenant, cursor?): Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>;
    open(): Promise<void>;
    queryEvents(tenant, filters, cursor?): Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>;
}

Implemented by

Methods

  • adds an event to a tenant's event log

    +

    Parameters

    • tenant: string

      the tenant's DID

      +
    • messageCid: string

      the CID of the message

      +
    • indexes: KeyValues

      (key-value pairs) to be included as part of indexing this event.

      +

    Returns Promise<void>

  • Clears the entire store. Mainly used for cleaning up in test environment.

    +

    Returns Promise<void>

  • closes the connection to the underlying store

    +

    Returns Promise<void>

  • deletes any events that have any of the messageCids provided

    +

    Parameters

    • tenant: string
    • messageCids: string[]

    Returns Promise<void>

    the number of events deleted

    +
  • Retrieves all of a tenant's events that occurred after the cursor provided. +If no cursor is provided, all events for a given tenant will be returned.

    +

    The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

    Returns Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>

  • opens a connection to the underlying store

    +

    Returns Promise<void>

  • retrieves a filtered set of events that occurred after a the cursor provided, accepts multiple filters.

    +

    If no cursor is provided, all events for a given tenant and filter combo will be returned. +The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

    Returns Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/EventStream.html b/interfaces/EventStream.html new file mode 100644 index 000000000..9849cd454 --- /dev/null +++ b/interfaces/EventStream.html @@ -0,0 +1,6 @@ +EventStream | DWN-SDK Documentation - v0.2.18

The EventStream interface implements a pub/sub system based on Message filters.

+
interface EventStream {
    close(): Promise<void>;
    emit(tenant, event, indexes): void;
    open(): Promise<void>;
    subscribe(id, listener): Promise<EventSubscription>;
}

Implemented by

Methods

Methods

  • Parameters

    • id: string
    • listener: EventListener

    Returns Promise<EventSubscription>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/MessageStore.html b/interfaces/MessageStore.html new file mode 100644 index 000000000..91b7d5b55 --- /dev/null +++ b/interfaces/MessageStore.html @@ -0,0 +1,18 @@ +MessageStore | DWN-SDK Documentation - v0.2.18

Interface MessageStore

interface MessageStore {
    clear(): Promise<void>;
    close(): Promise<void>;
    delete(tenant, cid, options?): Promise<void>;
    get(tenant, cid, options?): Promise<undefined | GenericMessage>;
    open(): Promise<void>;
    put(tenant, message, indexes, options?): Promise<void>;
    query(tenant, filters, messageSort?, pagination?, options?): Promise<{
        cursor?: PaginationCursor;
        messages: GenericMessage[];
    }>;
}

Implemented by

Methods

Methods

  • Clears the entire store. Mainly used for cleaning up in test environment.

    +

    Returns Promise<void>

  • adds a message to the underlying store. Uses the message's cid as the key

    +

    Parameters

    Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/MessageStoreOptions.html b/interfaces/MessageStoreOptions.html new file mode 100644 index 000000000..466c97ea7 --- /dev/null +++ b/interfaces/MessageStoreOptions.html @@ -0,0 +1,2 @@ +MessageStoreOptions | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/MessageSubscription.html b/interfaces/MessageSubscription.html new file mode 100644 index 000000000..9327bfd48 --- /dev/null +++ b/interfaces/MessageSubscription.html @@ -0,0 +1,3 @@ +MessageSubscription | DWN-SDK Documentation - v0.2.18

Interface MessageSubscription

interface MessageSubscription {
    close: (() => Promise<void>);
    id: string;
}

Properties

Properties

close: (() => Promise<void>)

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

id: string

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/Signer.html b/interfaces/Signer.html new file mode 100644 index 000000000..0dbadcd73 --- /dev/null +++ b/interfaces/Signer.html @@ -0,0 +1,16 @@ +Signer | DWN-SDK Documentation - v0.2.18

A signer that is capable of generating a digital signature over any given bytes.

+
interface Signer {
    algorithm: string;
    keyId: string;
    sign(content): Promise<Uint8Array>;
}

Implemented by

Properties

Methods

Properties

algorithm: string

The name of the signature algorithm used by this signer. +This value will be used as the "alg" parameter in JWS produced. +This parameter is not used by the DWN but is unfortunately a required header property for a JWS as per: +https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.1 +Valid signature algorithm values can be found at https://www.iana.org/assignments/jose/jose.xhtml

+
keyId: string

The ID of the key used by this signer. +This needs to be a fully-qualified ID (ie. prefixed with DID) so that author can be parsed out for processing such as recordId computation. +Example: did:example:alice#key1 +This value will be used as the "kid" parameter in JWS produced. +While this property is not a required property per JWS specification, it is required for DWN authentication.

+

Methods

  • Signs the given content and returns the signature as bytes.

    +

    Parameters

    • content: Uint8Array

    Returns Promise<Uint8Array>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/TenantGate.html b/interfaces/TenantGate.html new file mode 100644 index 000000000..197054033 --- /dev/null +++ b/interfaces/TenantGate.html @@ -0,0 +1,4 @@ +TenantGate | DWN-SDK Documentation - v0.2.18

An interface that gates tenant access to the DWN.

+
interface TenantGate {
    isActiveTenant(did): Promise<ActiveTenantCheckResult>;
}

Implemented by

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ActiveTenantCheckResult.html b/types/ActiveTenantCheckResult.html new file mode 100644 index 000000000..ada9ce8bc --- /dev/null +++ b/types/ActiveTenantCheckResult.html @@ -0,0 +1,4 @@ +ActiveTenantCheckResult | DWN-SDK Documentation - v0.2.18

Type alias ActiveTenantCheckResult

ActiveTenantCheckResult: {
    detail?: string;
    isActiveTenant: boolean;
}

The result of the isActiveTenant() call.

+

Type declaration

  • Optional detail?: string

    An optional detail message if the given DID is not an active tenant of the DWN.

    +
  • isActiveTenant: boolean

    true if the given DID is an active tenant of the DWN; false otherwise.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CreateFromOptions.html b/types/CreateFromOptions.html new file mode 100644 index 000000000..858f7cf5a --- /dev/null +++ b/types/CreateFromOptions.html @@ -0,0 +1,4 @@ +CreateFromOptions | DWN-SDK Documentation - v0.2.18

Type alias CreateFromOptions

CreateFromOptions: {
    attestationSigners?: Signer[];
    data?: Uint8Array;
    dataFormat?: string;
    datePublished?: string;
    delegatedGrant?: DelegatedGrantMessage;
    encryptionInput?: EncryptionInput;
    messageTimestamp?: string;
    protocolRole?: string;
    published?: boolean;
    recordsWriteMessage: RecordsWriteMessage;
    signer?: Signer;
}

Type declaration

  • Optional attestationSigners?: Signer[]
  • Optional data?: Uint8Array
  • Optional dataFormat?: string

    The data format of the new data. If not given, the data format from the existing message will be used.

    +
  • Optional datePublished?: string
  • Optional delegatedGrant?: DelegatedGrantMessage

    The delegated grant to sign on behalf of the logical author, which is the grantor (grantedBy) of the delegated grant.

    +
  • Optional encryptionInput?: EncryptionInput
  • Optional messageTimestamp?: string
  • Optional protocolRole?: string
  • Optional published?: boolean
  • recordsWriteMessage: RecordsWriteMessage
  • Optional signer?: Signer

    Signer of the message.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DataStoreGetResult.html b/types/DataStoreGetResult.html new file mode 100644 index 000000000..df9625b2f --- /dev/null +++ b/types/DataStoreGetResult.html @@ -0,0 +1,3 @@ +DataStoreGetResult | DWN-SDK Documentation - v0.2.18

Type alias DataStoreGetResult

DataStoreGetResult: {
    dataSize: number;
    dataStream: Readable;
}

Result of a data store get() method call if the data exists.

+

Type declaration

  • dataSize: number

    The number of bytes of the data stored.

    +
  • dataStream: Readable

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DataStorePutResult.html b/types/DataStorePutResult.html new file mode 100644 index 000000000..d98023d29 --- /dev/null +++ b/types/DataStorePutResult.html @@ -0,0 +1,3 @@ +DataStorePutResult | DWN-SDK Documentation - v0.2.18

Type alias DataStorePutResult

DataStorePutResult: {
    dataSize: number;
}

Result of a data store put() method call.

+

Type declaration

  • dataSize: number

    The number of bytes of the data stored.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DerivedPrivateJwk.html b/types/DerivedPrivateJwk.html new file mode 100644 index 000000000..4a54f4a42 --- /dev/null +++ b/types/DerivedPrivateJwk.html @@ -0,0 +1 @@ +DerivedPrivateJwk | DWN-SDK Documentation - v0.2.18

Type alias DerivedPrivateJwk

DerivedPrivateJwk: {
    derivationPath?: string[];
    derivationScheme: KeyDerivationScheme;
    derivedPrivateKey: PrivateJwk;
    rootKeyId: string;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DwnConfig.html b/types/DwnConfig.html new file mode 100644 index 000000000..143219422 --- /dev/null +++ b/types/DwnConfig.html @@ -0,0 +1,2 @@ +DwnConfig | DWN-SDK Documentation - v0.2.18

Type alias DwnConfig

DwnConfig: {
    dataStore: DataStore;
    didResolver?: DidResolver;
    eventLog: EventLog;
    eventStream?: EventStream;
    messageStore: MessageStore;
    tenantGate?: TenantGate;
}

DWN configuration.

+

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EncryptionInput.html b/types/EncryptionInput.html new file mode 100644 index 000000000..594966b28 --- /dev/null +++ b/types/EncryptionInput.html @@ -0,0 +1,7 @@ +EncryptionInput | DWN-SDK Documentation - v0.2.18

Type alias EncryptionInput

EncryptionInput: {
    algorithm?: EncryptionAlgorithm;
    initializationVector: Uint8Array;
    key: Uint8Array;
    keyEncryptionInputs: KeyEncryptionInput[];
}

Input that describes how data is encrypted as spec-ed in TP18 (https://github.com/TBD54566975/technical-proposals/pull/6).

+

Type declaration

  • Optional algorithm?: EncryptionAlgorithm

    Algorithm used for encrypting the Data. Uses {EncryptionAlgorithm.Aes256Ctr} if not given.

    +
  • initializationVector: Uint8Array

    Initialization vector used for encrypting the data.

    +
  • key: Uint8Array

    Symmetric key used to encrypt the data.

    +
  • keyEncryptionInputs: KeyEncryptionInput[]

    Array of input that specifies how the symmetric key is encrypted. +Each entry in the array will result in a unique ciphertext of the symmetric key.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EncryptionProperty.html b/types/EncryptionProperty.html new file mode 100644 index 000000000..424e4135e --- /dev/null +++ b/types/EncryptionProperty.html @@ -0,0 +1 @@ +EncryptionProperty | DWN-SDK Documentation - v0.2.18

Type alias EncryptionProperty

EncryptionProperty: {
    algorithm: EncryptionAlgorithm;
    initializationVector: string;
    keyEncryption: EncryptedKey[];
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EqualFilter.html b/types/EqualFilter.html new file mode 100644 index 000000000..e44fd9d08 --- /dev/null +++ b/types/EqualFilter.html @@ -0,0 +1 @@ +EqualFilter | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventSubscriptionHandler.html b/types/EventSubscriptionHandler.html new file mode 100644 index 000000000..595de689b --- /dev/null +++ b/types/EventSubscriptionHandler.html @@ -0,0 +1 @@ +EventSubscriptionHandler | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventsGetMessage.html b/types/EventsGetMessage.html new file mode 100644 index 000000000..e636a5e95 --- /dev/null +++ b/types/EventsGetMessage.html @@ -0,0 +1 @@ +EventsGetMessage | DWN-SDK Documentation - v0.2.18

Type alias EventsGetMessage

EventsGetMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: EventsGetDescriptor;
}

Type declaration

  • authorization: AuthorizationModel
  • descriptor: EventsGetDescriptor

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventsGetOptions.html b/types/EventsGetOptions.html new file mode 100644 index 000000000..91959aa12 --- /dev/null +++ b/types/EventsGetOptions.html @@ -0,0 +1 @@ +EventsGetOptions | DWN-SDK Documentation - v0.2.18

Type alias EventsGetOptions

EventsGetOptions: {
    cursor?: PaginationCursor;
    messageTimestamp?: string;
    signer: Signer;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventsGetReply.html b/types/EventsGetReply.html new file mode 100644 index 000000000..a9d3ea338 --- /dev/null +++ b/types/EventsGetReply.html @@ -0,0 +1 @@ +EventsGetReply | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventsQueryMessage.html b/types/EventsQueryMessage.html new file mode 100644 index 000000000..2e9434740 --- /dev/null +++ b/types/EventsQueryMessage.html @@ -0,0 +1 @@ +EventsQueryMessage | DWN-SDK Documentation - v0.2.18

Type alias EventsQueryMessage

EventsQueryMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: EventsQueryDescriptor;
}

Type declaration

  • authorization: AuthorizationModel
  • descriptor: EventsQueryDescriptor

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventsQueryOptions.html b/types/EventsQueryOptions.html new file mode 100644 index 000000000..37c41b1e9 --- /dev/null +++ b/types/EventsQueryOptions.html @@ -0,0 +1 @@ +EventsQueryOptions | DWN-SDK Documentation - v0.2.18

Type alias EventsQueryOptions

EventsQueryOptions: {
    cursor?: PaginationCursor;
    filters: EventsFilter[];
    messageTimestamp?: string;
    signer: Signer;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventsQueryReply.html b/types/EventsQueryReply.html new file mode 100644 index 000000000..42ad2eb6b --- /dev/null +++ b/types/EventsQueryReply.html @@ -0,0 +1 @@ +EventsQueryReply | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventsSubscribeDescriptor.html b/types/EventsSubscribeDescriptor.html new file mode 100644 index 000000000..4872d0015 --- /dev/null +++ b/types/EventsSubscribeDescriptor.html @@ -0,0 +1 @@ +EventsSubscribeDescriptor | DWN-SDK Documentation - v0.2.18

Type alias EventsSubscribeDescriptor

EventsSubscribeDescriptor: {
    filters: EventsFilter[];
    interface: Events;
    messageTimestamp: string;
    method: Subscribe;
}

Type declaration

  • filters: EventsFilter[]
  • interface: Events
  • messageTimestamp: string
  • method: Subscribe

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventsSubscribeMessage.html b/types/EventsSubscribeMessage.html new file mode 100644 index 000000000..0e955c993 --- /dev/null +++ b/types/EventsSubscribeMessage.html @@ -0,0 +1 @@ +EventsSubscribeMessage | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventsSubscribeOptions.html b/types/EventsSubscribeOptions.html new file mode 100644 index 000000000..cfd56eab3 --- /dev/null +++ b/types/EventsSubscribeOptions.html @@ -0,0 +1 @@ +EventsSubscribeOptions | DWN-SDK Documentation - v0.2.18

Type alias EventsSubscribeOptions

EventsSubscribeOptions: {
    filters?: EventsFilter[];
    messageTimestamp?: string;
    signer: Signer;
}

Type declaration

  • Optional filters?: EventsFilter[]
  • Optional messageTimestamp?: string
  • signer: Signer

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EventsSubscribeReply.html b/types/EventsSubscribeReply.html new file mode 100644 index 000000000..5c8e35686 --- /dev/null +++ b/types/EventsSubscribeReply.html @@ -0,0 +1 @@ +EventsSubscribeReply | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/Filter.html b/types/Filter.html new file mode 100644 index 000000000..65f4460bf --- /dev/null +++ b/types/Filter.html @@ -0,0 +1 @@ +Filter | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GenericMessage.html b/types/GenericMessage.html new file mode 100644 index 000000000..3c976008d --- /dev/null +++ b/types/GenericMessage.html @@ -0,0 +1,2 @@ +GenericMessage | DWN-SDK Documentation - v0.2.18

Type alias GenericMessage

GenericMessage: {
    authorization?: AuthorizationModel;
    descriptor: Descriptor;
}

Intersection type for all concrete message types.

+

Type declaration

  • Optional authorization?: AuthorizationModel
  • descriptor: Descriptor

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GenericMessageReply.html b/types/GenericMessageReply.html new file mode 100644 index 000000000..c7cd9f16c --- /dev/null +++ b/types/GenericMessageReply.html @@ -0,0 +1 @@ +GenericMessageReply | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/KeyEncryptionInput.html b/types/KeyEncryptionInput.html new file mode 100644 index 000000000..5996938d1 --- /dev/null +++ b/types/KeyEncryptionInput.html @@ -0,0 +1,7 @@ +KeyEncryptionInput | DWN-SDK Documentation - v0.2.18

Type alias KeyEncryptionInput

KeyEncryptionInput: {
    algorithm?: EncryptionAlgorithm;
    derivationScheme: KeyDerivationScheme;
    publicKey: PublicJwk;
    publicKeyId: string;
}

Input that specifies how a symmetric key is encrypted.

+

Type declaration

  • Optional algorithm?: EncryptionAlgorithm

    Algorithm used for encrypting the symmetric key. Uses {EncryptionAlgorithm.EciesSecp256k1} if not given.

    +
  • derivationScheme: KeyDerivationScheme

    Key derivation scheme used to derive the public key to encrypt the symmetric key.

    +
  • publicKey: PublicJwk

    Public key to be used to encrypt the symmetric key.

    +
  • publicKeyId: string

    Fully qualified ID of root public key used derive the public key to be used to to encrypt the symmetric key. +(e.g. did:example:abc#encryption-key-id)

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/KeyMaterial.html b/types/KeyMaterial.html new file mode 100644 index 000000000..342931514 --- /dev/null +++ b/types/KeyMaterial.html @@ -0,0 +1,2 @@ +KeyMaterial | DWN-SDK Documentation - v0.2.18

Type alias KeyMaterial

KeyMaterial: {
    keyId: string;
    keyPair: {
        privateJwk: PrivateJwk;
        publicJwk: PublicJwk;
    };
}

Contains a public-private key pair and the associated key ID.

+

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/MessageEvent.html b/types/MessageEvent.html new file mode 100644 index 000000000..8e455f80f --- /dev/null +++ b/types/MessageEvent.html @@ -0,0 +1,3 @@ +MessageEvent | DWN-SDK Documentation - v0.2.18

Type alias MessageEvent

MessageEvent: {
    initialWrite?: RecordsWriteMessage;
    message: GenericMessage;
}

MessageEvent contains the message being emitted and an optional initial write message.

+

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/MessageSort.html b/types/MessageSort.html new file mode 100644 index 000000000..311ccf1e7 --- /dev/null +++ b/types/MessageSort.html @@ -0,0 +1 @@ +MessageSort | DWN-SDK Documentation - v0.2.18

Type alias MessageSort

MessageSort: {
    dateCreated?: SortDirection;
    datePublished?: SortDirection;
    messageTimestamp?: SortDirection;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/MessagesGetMessage.html b/types/MessagesGetMessage.html new file mode 100644 index 000000000..92743c011 --- /dev/null +++ b/types/MessagesGetMessage.html @@ -0,0 +1 @@ +MessagesGetMessage | DWN-SDK Documentation - v0.2.18

Type alias MessagesGetMessage

MessagesGetMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: MessagesGetDescriptor;
}

Type declaration

  • authorization: AuthorizationModel
  • descriptor: MessagesGetDescriptor

Generated using TypeDoc

\ No newline at end of file diff --git a/types/MessagesGetOptions.html b/types/MessagesGetOptions.html new file mode 100644 index 000000000..2bd18a349 --- /dev/null +++ b/types/MessagesGetOptions.html @@ -0,0 +1 @@ +MessagesGetOptions | DWN-SDK Documentation - v0.2.18

Type alias MessagesGetOptions

MessagesGetOptions: {
    messageCids: string[];
    messageTimestamp?: string;
    signer: Signer;
}

Type declaration

  • messageCids: string[]
  • Optional messageTimestamp?: string
  • signer: Signer

Generated using TypeDoc

\ No newline at end of file diff --git a/types/MessagesGetReply.html b/types/MessagesGetReply.html new file mode 100644 index 000000000..fe92a9938 --- /dev/null +++ b/types/MessagesGetReply.html @@ -0,0 +1 @@ +MessagesGetReply | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/MessagesGetReplyEntry.html b/types/MessagesGetReplyEntry.html new file mode 100644 index 000000000..cc131856b --- /dev/null +++ b/types/MessagesGetReplyEntry.html @@ -0,0 +1 @@ +MessagesGetReplyEntry | DWN-SDK Documentation - v0.2.18

Type alias MessagesGetReplyEntry

MessagesGetReplyEntry: {
    encodedData?: string;
    error?: string;
    message?: GenericMessage;
    messageCid: string;
}

Type declaration

  • Optional encodedData?: string
  • Optional error?: string
  • Optional message?: GenericMessage
  • messageCid: string

Generated using TypeDoc

\ No newline at end of file diff --git a/types/OneOfFilter.html b/types/OneOfFilter.html new file mode 100644 index 000000000..3e238f377 --- /dev/null +++ b/types/OneOfFilter.html @@ -0,0 +1 @@ +OneOfFilter | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/Pagination.html b/types/Pagination.html new file mode 100644 index 000000000..536a0c527 --- /dev/null +++ b/types/Pagination.html @@ -0,0 +1,3 @@ +Pagination | DWN-SDK Documentation - v0.2.18

Type alias Pagination

Pagination: {
    cursor?: PaginationCursor;
    limit?: number;
}

Pagination Options for querying messages.

+

The cursor is the messageCid of the message you would like to pagination from.

+

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PaginationCursor.html b/types/PaginationCursor.html new file mode 100644 index 000000000..3add0a7dd --- /dev/null +++ b/types/PaginationCursor.html @@ -0,0 +1 @@ +PaginationCursor | DWN-SDK Documentation - v0.2.18

Type alias PaginationCursor

PaginationCursor: {
    messageCid: string;
    value: string | number;
}

Type declaration

  • messageCid: string
  • value: string | number

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionConditions.html b/types/PermissionConditions.html new file mode 100644 index 000000000..237312401 --- /dev/null +++ b/types/PermissionConditions.html @@ -0,0 +1,4 @@ +PermissionConditions | DWN-SDK Documentation - v0.2.18

Type alias PermissionConditions

PermissionConditions: {
    publication?: PermissionsConditionPublication;
}

Type declaration

  • Optional publication?: PermissionsConditionPublication

    indicates whether a message written with the invocation of a permission must, may, or must not +be marked as public. +If undefined, it is optional to make the message public.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionScope.html b/types/PermissionScope.html new file mode 100644 index 000000000..cc2b85728 --- /dev/null +++ b/types/PermissionScope.html @@ -0,0 +1 @@ +PermissionScope | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionsGrantDescriptor.html b/types/PermissionsGrantDescriptor.html new file mode 100644 index 000000000..a3379876d --- /dev/null +++ b/types/PermissionsGrantDescriptor.html @@ -0,0 +1,8 @@ +PermissionsGrantDescriptor | DWN-SDK Documentation - v0.2.18

Type alias PermissionsGrantDescriptor

PermissionsGrantDescriptor: {
    conditions?: PermissionConditions;
    dateExpires: string;
    delegated?: boolean;
    description?: string;
    grantedBy: string;
    grantedFor: string;
    grantedTo: string;
    interface: Permissions;
    messageTimestamp: string;
    method: Grant;
    permissionsRequestId?: string;
    scope: PermissionScope;
}

Type declaration

  • Optional conditions?: PermissionConditions
  • dateExpires: string

    Timestamp at which this grant will no longer be active.

    +
  • Optional delegated?: boolean

    Whether this grant is delegated or not. If true, the grantedTo will be able to act as the grantedTo within the scope of this grant.

    +
  • Optional description?: string

    Optional string that communicates what the grant would be used for

    +
  • grantedBy: string

    The granter, who will be either the DWN owner or an entity who the DWN owner has delegated permission to.

    +
  • grantedFor: string

    The DID of the DWN which the grantee will be given access

    +
  • grantedTo: string

    The recipient of the grant. Usually this is the author of the PermissionsRequest message

    +
  • interface: Permissions
  • messageTimestamp: string
  • method: Grant
  • Optional permissionsRequestId?: string

    Optional CID of a PermissionsRequest message. This is optional because grants may be given without being officially requested

    +
  • scope: PermissionScope

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionsGrantMessage.html b/types/PermissionsGrantMessage.html new file mode 100644 index 000000000..c198a6f98 --- /dev/null +++ b/types/PermissionsGrantMessage.html @@ -0,0 +1 @@ +PermissionsGrantMessage | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionsGrantOptions.html b/types/PermissionsGrantOptions.html new file mode 100644 index 000000000..869a621e0 --- /dev/null +++ b/types/PermissionsGrantOptions.html @@ -0,0 +1 @@ +PermissionsGrantOptions | DWN-SDK Documentation - v0.2.18

Type alias PermissionsGrantOptions

PermissionsGrantOptions: {
    conditions?: PermissionConditions;
    dateExpires: string;
    delegated?: boolean;
    description?: string;
    grantedBy: string;
    grantedFor: string;
    grantedTo: string;
    messageTimestamp?: string;
    permissionsRequestId?: string;
    scope: PermissionScope;
    signer: Signer;
}

Type declaration

  • Optional conditions?: PermissionConditions
  • dateExpires: string
  • Optional delegated?: boolean
  • Optional description?: string
  • grantedBy: string
  • grantedFor: string
  • grantedTo: string
  • Optional messageTimestamp?: string
  • Optional permissionsRequestId?: string
  • scope: PermissionScope
  • signer: Signer

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionsRequestDescriptor.html b/types/PermissionsRequestDescriptor.html new file mode 100644 index 000000000..953cf24f8 --- /dev/null +++ b/types/PermissionsRequestDescriptor.html @@ -0,0 +1 @@ +PermissionsRequestDescriptor | DWN-SDK Documentation - v0.2.18

Type alias PermissionsRequestDescriptor

PermissionsRequestDescriptor: {
    conditions?: PermissionConditions;
    description?: string;
    grantedBy: string;
    grantedFor: string;
    grantedTo: string;
    interface: Permissions;
    messageTimestamp: string;
    method: Request;
    scope: PermissionScope;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionsRequestMessage.html b/types/PermissionsRequestMessage.html new file mode 100644 index 000000000..dc6a9bbdb --- /dev/null +++ b/types/PermissionsRequestMessage.html @@ -0,0 +1 @@ +PermissionsRequestMessage | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionsRequestOptions.html b/types/PermissionsRequestOptions.html new file mode 100644 index 000000000..52c0efb0b --- /dev/null +++ b/types/PermissionsRequestOptions.html @@ -0,0 +1 @@ +PermissionsRequestOptions | DWN-SDK Documentation - v0.2.18

Type alias PermissionsRequestOptions

PermissionsRequestOptions: {
    conditions?: PermissionConditions;
    description?: string;
    grantedBy: string;
    grantedFor: string;
    grantedTo: string;
    messageTimestamp?: string;
    scope: PermissionScope;
    signer: Signer;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionsRevokeDescriptor.html b/types/PermissionsRevokeDescriptor.html new file mode 100644 index 000000000..9fe095272 --- /dev/null +++ b/types/PermissionsRevokeDescriptor.html @@ -0,0 +1 @@ +PermissionsRevokeDescriptor | DWN-SDK Documentation - v0.2.18

Type alias PermissionsRevokeDescriptor

PermissionsRevokeDescriptor: {
    interface: Permissions;
    messageTimestamp: string;
    method: Revoke;
    permissionsGrantId: string;
}

Type declaration

  • interface: Permissions
  • messageTimestamp: string
  • method: Revoke
  • permissionsGrantId: string

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionsRevokeMessage.html b/types/PermissionsRevokeMessage.html new file mode 100644 index 000000000..9a44ce8ae --- /dev/null +++ b/types/PermissionsRevokeMessage.html @@ -0,0 +1 @@ +PermissionsRevokeMessage | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PermissionsRevokeOptions.html b/types/PermissionsRevokeOptions.html new file mode 100644 index 000000000..db6f28d36 --- /dev/null +++ b/types/PermissionsRevokeOptions.html @@ -0,0 +1 @@ +PermissionsRevokeOptions | DWN-SDK Documentation - v0.2.18

Type alias PermissionsRevokeOptions

PermissionsRevokeOptions: {
    messageTimestamp?: string;
    permissionsGrantId: string;
    signer: Signer;
}

Type declaration

  • Optional messageTimestamp?: string
  • permissionsGrantId: string
  • signer: Signer

Generated using TypeDoc

\ No newline at end of file diff --git a/types/Persona.html b/types/Persona.html new file mode 100644 index 000000000..d7db3729e --- /dev/null +++ b/types/Persona.html @@ -0,0 +1,2 @@ +Persona | DWN-SDK Documentation - v0.2.18
Persona: {
    did: string;
    keyId: string;
    keyPair: {
        privateJwk: PrivateJwk;
        publicJwk: PublicJwk;
    };
    signer: Signer;
}

A logical grouping of user data used to generate test messages.

+

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PrivateJwk.html b/types/PrivateJwk.html new file mode 100644 index 000000000..891c118b8 --- /dev/null +++ b/types/PrivateJwk.html @@ -0,0 +1,4 @@ +PrivateJwk | DWN-SDK Documentation - v0.2.18

Type alias PrivateJwk

PrivateJwk: PublicJwk & {
    d: string;
}

Type declaration

  • d: string

    the Elliptic Curve private key value. +It is represented as the base64url encoding of the octet string representation of the private key value +MUST be present to represent Elliptic Curve private keys.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolDefinition.html b/types/ProtocolDefinition.html new file mode 100644 index 000000000..cf5e0ffc0 --- /dev/null +++ b/types/ProtocolDefinition.html @@ -0,0 +1,2 @@ +ProtocolDefinition | DWN-SDK Documentation - v0.2.18

Type alias ProtocolDefinition

ProtocolDefinition: {
    protocol: string;
    published: boolean;
    structure: {
        [key: string]: ProtocolRuleSet;
    };
    types: ProtocolTypes;
}

Type declaration

  • protocol: string
  • published: boolean

    Denotes if this Protocol Definition can be returned by unauthenticated or unauthorized ProtocolsQuery.

    +
  • structure: {
        [key: string]: ProtocolRuleSet;
    }
  • types: ProtocolTypes

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolRuleSet.html b/types/ProtocolRuleSet.html new file mode 100644 index 000000000..f3c9d6373 --- /dev/null +++ b/types/ProtocolRuleSet.html @@ -0,0 +1,5 @@ +ProtocolRuleSet | DWN-SDK Documentation - v0.2.18

Type alias ProtocolRuleSet

ProtocolRuleSet: {
    $actions?: ProtocolActionRule[];
    $encryption?: ProtocolPathEncryption;
    $role?: boolean;
    $size?: {
        max?: number;
        min?: number;
    };
    [key: string]: any;
}

Type declaration

  • [key: string]: any
  • Optional $actions?: ProtocolActionRule[]
  • Optional $encryption?: ProtocolPathEncryption

    Encryption setting for objects that are in this protocol path.

    +
  • Optional $role?: boolean

    If true, this marks a record as a role that may used within a context. +The recipient of a $role record may invoke their role by setting protocolRole property to the protocol path of the $role record.

    +
  • Optional $size?: {
        max?: number;
        min?: number;
    }

    If $size is set, the record size in bytes must be within the limits.

    +
    • Optional max?: number
    • Optional min?: number

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolTypes.html b/types/ProtocolTypes.html new file mode 100644 index 000000000..d2584679c --- /dev/null +++ b/types/ProtocolTypes.html @@ -0,0 +1 @@ +ProtocolTypes | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolsConfigureDescriptor.html b/types/ProtocolsConfigureDescriptor.html new file mode 100644 index 000000000..a6ca399d3 --- /dev/null +++ b/types/ProtocolsConfigureDescriptor.html @@ -0,0 +1 @@ +ProtocolsConfigureDescriptor | DWN-SDK Documentation - v0.2.18

Type alias ProtocolsConfigureDescriptor

ProtocolsConfigureDescriptor: {
    definition: ProtocolDefinition;
    interface: Protocols;
    messageTimestamp: string;
    method: Configure;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolsConfigureMessage.html b/types/ProtocolsConfigureMessage.html new file mode 100644 index 000000000..a4728e083 --- /dev/null +++ b/types/ProtocolsConfigureMessage.html @@ -0,0 +1 @@ +ProtocolsConfigureMessage | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolsConfigureOptions.html b/types/ProtocolsConfigureOptions.html new file mode 100644 index 000000000..4d8db7ee9 --- /dev/null +++ b/types/ProtocolsConfigureOptions.html @@ -0,0 +1 @@ +ProtocolsConfigureOptions | DWN-SDK Documentation - v0.2.18

Type alias ProtocolsConfigureOptions

ProtocolsConfigureOptions: {
    definition: ProtocolDefinition;
    messageTimestamp?: string;
    permissionsGrantId?: string;
    signer: Signer;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolsQueryFilter.html b/types/ProtocolsQueryFilter.html new file mode 100644 index 000000000..32b456a04 --- /dev/null +++ b/types/ProtocolsQueryFilter.html @@ -0,0 +1 @@ +ProtocolsQueryFilter | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolsQueryMessage.html b/types/ProtocolsQueryMessage.html new file mode 100644 index 000000000..04a23949c --- /dev/null +++ b/types/ProtocolsQueryMessage.html @@ -0,0 +1 @@ +ProtocolsQueryMessage | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolsQueryOptions.html b/types/ProtocolsQueryOptions.html new file mode 100644 index 000000000..ba752f7c8 --- /dev/null +++ b/types/ProtocolsQueryOptions.html @@ -0,0 +1 @@ +ProtocolsQueryOptions | DWN-SDK Documentation - v0.2.18

Type alias ProtocolsQueryOptions

ProtocolsQueryOptions: {
    filter?: ProtocolsQueryFilter;
    messageTimestamp?: string;
    permissionsGrantId?: string;
    signer?: Signer;
}

Type declaration

  • Optional filter?: ProtocolsQueryFilter
  • Optional messageTimestamp?: string
  • Optional permissionsGrantId?: string
  • Optional signer?: Signer

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolsQueryReply.html b/types/ProtocolsQueryReply.html new file mode 100644 index 000000000..2c5c3c8dd --- /dev/null +++ b/types/ProtocolsQueryReply.html @@ -0,0 +1 @@ +ProtocolsQueryReply | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PublicJwk.html b/types/PublicJwk.html new file mode 100644 index 000000000..2f9005e21 --- /dev/null +++ b/types/PublicJwk.html @@ -0,0 +1,8 @@ +PublicJwk | DWN-SDK Documentation - v0.2.18

Type alias PublicJwk

PublicJwk: Jwk & {
    crv: "Ed25519" | "secp256k1";
    x: string;
    y?: string;
}

Type declaration

  • crv: "Ed25519" | "secp256k1"

    The "crv" (curve) parameter identifies the cryptographic curve used with the key. +MUST be present for all EC public keys

    +
  • x: string

    the x coordinate for the Elliptic Curve point. +Represented as the base64url encoding of the octet string representation of the coordinate. +MUST be present for all EC public keys

    +
  • Optional y?: string

    the y coordinate for the Elliptic Curve point. +Represented as the base64url encoding of the octet string representation of the coordinate.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/QueryOptions.html b/types/QueryOptions.html new file mode 100644 index 000000000..11d67a214 --- /dev/null +++ b/types/QueryOptions.html @@ -0,0 +1 @@ +QueryOptions | DWN-SDK Documentation - v0.2.18

Type alias QueryOptions

QueryOptions: {
    cursor?: PaginationCursor;
    limit?: number;
    sortDirection?: SortDirection;
    sortProperty: string;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/QueryResultEntry.html b/types/QueryResultEntry.html new file mode 100644 index 000000000..d9c3aba54 --- /dev/null +++ b/types/QueryResultEntry.html @@ -0,0 +1,6 @@ +QueryResultEntry | DWN-SDK Documentation - v0.2.18

Type alias QueryResultEntry

QueryResultEntry: GenericMessage & {
    encodedData?: string;
}

Message returned in a query result. +NOTE: the message structure is a modified version of the message received, the most notable differences are:

+
    +
  1. May include encoded data
  2. +
+

Type declaration

  • Optional encodedData?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RangeCriterion.html b/types/RangeCriterion.html new file mode 100644 index 000000000..0b6f496f8 --- /dev/null +++ b/types/RangeCriterion.html @@ -0,0 +1,3 @@ +RangeCriterion | DWN-SDK Documentation - v0.2.18

Type alias RangeCriterion

RangeCriterion: {
    from?: string;
    to?: string;
}

Type declaration

  • Optional from?: string

    Inclusive starting date-time.

    +
  • Optional to?: string

    Inclusive end date-time.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RangeFilter.html b/types/RangeFilter.html new file mode 100644 index 000000000..6767e4ca0 --- /dev/null +++ b/types/RangeFilter.html @@ -0,0 +1,2 @@ +RangeFilter | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsDeleteMessage.html b/types/RecordsDeleteMessage.html new file mode 100644 index 000000000..b954141ef --- /dev/null +++ b/types/RecordsDeleteMessage.html @@ -0,0 +1 @@ +RecordsDeleteMessage | DWN-SDK Documentation - v0.2.18

Type alias RecordsDeleteMessage

RecordsDeleteMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: RecordsDeleteDescriptor;
}

Type declaration

  • authorization: AuthorizationModel
  • descriptor: RecordsDeleteDescriptor

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsDeleteOptions.html b/types/RecordsDeleteOptions.html new file mode 100644 index 000000000..64186995d --- /dev/null +++ b/types/RecordsDeleteOptions.html @@ -0,0 +1,2 @@ +RecordsDeleteOptions | DWN-SDK Documentation - v0.2.18

Type alias RecordsDeleteOptions

RecordsDeleteOptions: {
    delegatedGrant?: DelegatedGrantMessage;
    messageTimestamp?: string;
    protocolRole?: string;
    recordId: string;
    signer: Signer;
}

Type declaration

  • Optional delegatedGrant?: DelegatedGrantMessage

    The delegated grant to sign on behalf of the logical author, which is the grantor (grantedBy) of the delegated grant.

    +
  • Optional messageTimestamp?: string
  • Optional protocolRole?: string
  • recordId: string
  • signer: Signer

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsQueryMessage.html b/types/RecordsQueryMessage.html new file mode 100644 index 000000000..356ac251f --- /dev/null +++ b/types/RecordsQueryMessage.html @@ -0,0 +1 @@ +RecordsQueryMessage | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsQueryOptions.html b/types/RecordsQueryOptions.html new file mode 100644 index 000000000..bcd77172a --- /dev/null +++ b/types/RecordsQueryOptions.html @@ -0,0 +1,2 @@ +RecordsQueryOptions | DWN-SDK Documentation - v0.2.18

Type alias RecordsQueryOptions

RecordsQueryOptions: {
    dateSort?: DateSort;
    delegatedGrant?: DelegatedGrantMessage;
    filter: RecordsFilter;
    messageTimestamp?: string;
    pagination?: Pagination;
    protocolRole?: string;
    signer?: Signer;
}

Type declaration

  • Optional dateSort?: DateSort
  • Optional delegatedGrant?: DelegatedGrantMessage

    The delegated grant to sign on behalf of the logical author, which is the grantor (grantedBy) of the delegated grant.

    +
  • filter: RecordsFilter
  • Optional messageTimestamp?: string
  • Optional pagination?: Pagination
  • Optional protocolRole?: string
  • Optional signer?: Signer

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsQueryReply.html b/types/RecordsQueryReply.html new file mode 100644 index 000000000..71744fb60 --- /dev/null +++ b/types/RecordsQueryReply.html @@ -0,0 +1 @@ +RecordsQueryReply | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsQueryReplyEntry.html b/types/RecordsQueryReplyEntry.html new file mode 100644 index 000000000..e862af80a --- /dev/null +++ b/types/RecordsQueryReplyEntry.html @@ -0,0 +1,9 @@ +RecordsQueryReplyEntry | DWN-SDK Documentation - v0.2.18

Type alias RecordsQueryReplyEntry

RecordsQueryReplyEntry: RecordsWriteMessage & {
    encodedData?: string;
    initialWrite?: RecordsWriteMessage;
}

Data structure returned in a RecordsQuery reply entry. +NOTE: the message structure is a modified version of the message received, the most notable differences are:

+
    +
  1. May include an initial RecordsWrite message
  2. +
  3. May include encoded data
  4. +
+

Type declaration

  • Optional encodedData?: string

    The encoded data of the record if the data associated with the record is equal or smaller than DwnConstant.maxDataSizeAllowedToBeEncoded.

    +
  • Optional initialWrite?: RecordsWriteMessage

    The initial write of the record if the returned RecordsWrite message itself is not the initial write.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsReadMessage.html b/types/RecordsReadMessage.html new file mode 100644 index 000000000..0de20fa7c --- /dev/null +++ b/types/RecordsReadMessage.html @@ -0,0 +1 @@ +RecordsReadMessage | DWN-SDK Documentation - v0.2.18

Type alias RecordsReadMessage

RecordsReadMessage: {
    authorization?: AuthorizationModel;
    descriptor: RecordsReadDescriptor;
}

Type declaration

  • Optional authorization?: AuthorizationModel
  • descriptor: RecordsReadDescriptor

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsReadOptions.html b/types/RecordsReadOptions.html new file mode 100644 index 000000000..63a5eea96 --- /dev/null +++ b/types/RecordsReadOptions.html @@ -0,0 +1,4 @@ +RecordsReadOptions | DWN-SDK Documentation - v0.2.18

Type alias RecordsReadOptions

RecordsReadOptions: {
    delegatedGrant?: DelegatedGrantMessage;
    filter: RecordsFilter;
    messageTimestamp?: string;
    permissionsGrantId?: string;
    protocolRole?: string;
    signer?: Signer;
}

Type declaration

  • Optional delegatedGrant?: DelegatedGrantMessage

    The delegated grant to sign on behalf of the logical author, which is the grantor (grantedBy) of the delegated grant.

    +
  • filter: RecordsFilter
  • Optional messageTimestamp?: string
  • Optional permissionsGrantId?: string
  • Optional protocolRole?: string

    Used when authorizing protocol records. +The protocol path to the role record type whose recipient is the author of this RecordsRead

    +
  • Optional signer?: Signer

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsReadReply.html b/types/RecordsReadReply.html new file mode 100644 index 000000000..bb13237b1 --- /dev/null +++ b/types/RecordsReadReply.html @@ -0,0 +1 @@ +RecordsReadReply | DWN-SDK Documentation - v0.2.18

Type alias RecordsReadReply

RecordsReadReply: GenericMessageReply & {
    record?: RecordsWriteMessage & {
        data: Readable;
        initialWrite?: RecordsWriteMessage;
    };
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsSubscribeDescriptor.html b/types/RecordsSubscribeDescriptor.html new file mode 100644 index 000000000..b062e7733 --- /dev/null +++ b/types/RecordsSubscribeDescriptor.html @@ -0,0 +1 @@ +RecordsSubscribeDescriptor | DWN-SDK Documentation - v0.2.18

Type alias RecordsSubscribeDescriptor

RecordsSubscribeDescriptor: {
    filter: RecordsFilter;
    interface: Records;
    messageTimestamp: string;
    method: Subscribe;
}

Type declaration

  • filter: RecordsFilter
  • interface: Records
  • messageTimestamp: string
  • method: Subscribe

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsSubscribeMessage.html b/types/RecordsSubscribeMessage.html new file mode 100644 index 000000000..ad1ecb85b --- /dev/null +++ b/types/RecordsSubscribeMessage.html @@ -0,0 +1 @@ +RecordsSubscribeMessage | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsSubscribeOptions.html b/types/RecordsSubscribeOptions.html new file mode 100644 index 000000000..105a54a09 --- /dev/null +++ b/types/RecordsSubscribeOptions.html @@ -0,0 +1,2 @@ +RecordsSubscribeOptions | DWN-SDK Documentation - v0.2.18

Type alias RecordsSubscribeOptions

RecordsSubscribeOptions: {
    delegatedGrant?: DelegatedGrantMessage;
    filter: RecordsFilter;
    messageTimestamp?: string;
    protocolRole?: string;
    signer?: Signer;
}

Type declaration

  • Optional delegatedGrant?: DelegatedGrantMessage

    The delegated grant to sign on behalf of the logical author, which is the grantor (grantedBy) of the delegated grant.

    +
  • filter: RecordsFilter
  • Optional messageTimestamp?: string
  • Optional protocolRole?: string
  • Optional signer?: Signer

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsSubscribeReply.html b/types/RecordsSubscribeReply.html new file mode 100644 index 000000000..6e148e0c4 --- /dev/null +++ b/types/RecordsSubscribeReply.html @@ -0,0 +1 @@ +RecordsSubscribeReply | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsWriteDescriptor.html b/types/RecordsWriteDescriptor.html new file mode 100644 index 000000000..4a1c1b0dc --- /dev/null +++ b/types/RecordsWriteDescriptor.html @@ -0,0 +1 @@ +RecordsWriteDescriptor | DWN-SDK Documentation - v0.2.18

Type alias RecordsWriteDescriptor

RecordsWriteDescriptor: {
    dataCid: string;
    dataFormat: string;
    dataSize: number;
    dateCreated: string;
    datePublished?: string;
    interface: Records;
    messageTimestamp: string;
    method: Write;
    parentId?: string;
    protocol?: string;
    protocolPath?: string;
    published?: boolean;
    recipient?: string;
    schema?: string;
}

Type declaration

  • dataCid: string
  • dataFormat: string
  • dataSize: number
  • dateCreated: string
  • Optional datePublished?: string
  • interface: Records
  • messageTimestamp: string
  • method: Write
  • Optional parentId?: string
  • Optional protocol?: string
  • Optional protocolPath?: string
  • Optional published?: boolean
  • Optional recipient?: string
  • Optional schema?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsWriteMessage.html b/types/RecordsWriteMessage.html new file mode 100644 index 000000000..f0508b593 --- /dev/null +++ b/types/RecordsWriteMessage.html @@ -0,0 +1 @@ +RecordsWriteMessage | DWN-SDK Documentation - v0.2.18

Type alias RecordsWriteMessage

RecordsWriteMessage: GenericMessage & {
    attestation?: GeneralJws;
    authorization: AuthorizationModel;
    contextId?: string;
    descriptor: RecordsWriteDescriptor;
    encryption?: EncryptionProperty;
    recordId: string;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RecordsWriteOptions.html b/types/RecordsWriteOptions.html new file mode 100644 index 000000000..b1d46081a --- /dev/null +++ b/types/RecordsWriteOptions.html @@ -0,0 +1,5 @@ +RecordsWriteOptions | DWN-SDK Documentation - v0.2.18

Type alias RecordsWriteOptions

RecordsWriteOptions: {
    attestationSigners?: Signer[];
    data?: Uint8Array;
    dataCid?: string;
    dataFormat: string;
    dataSize?: number;
    dateCreated?: string;
    datePublished?: string;
    delegatedGrant?: DelegatedGrantMessage;
    encryptionInput?: EncryptionInput;
    messageTimestamp?: string;
    parentContextId?: string;
    permissionsGrantId?: string;
    protocol?: string;
    protocolPath?: string;
    protocolRole?: string;
    published?: boolean;
    recipient?: string;
    recordId?: string;
    schema?: string;
    signer?: Signer;
}

Type declaration

  • Optional attestationSigners?: Signer[]
  • Optional data?: Uint8Array
  • Optional dataCid?: string
  • dataFormat: string
  • Optional dataSize?: number
  • Optional dateCreated?: string
  • Optional datePublished?: string
  • Optional delegatedGrant?: DelegatedGrantMessage

    The delegated grant to sign on behalf of the logical author, which is the grantor (grantedBy) of the delegated grant.

    +
  • Optional encryptionInput?: EncryptionInput
  • Optional messageTimestamp?: string
  • Optional parentContextId?: string

    Must be given if this message is for a non-root protocol record. +If not given, it either means this write is for a root protocol record or a flat-space record.

    +
  • Optional permissionsGrantId?: string
  • Optional protocol?: string
  • Optional protocolPath?: string
  • Optional protocolRole?: string
  • Optional published?: boolean
  • Optional recipient?: string
  • Optional recordId?: string
  • Optional schema?: string
  • Optional signer?: Signer

    Signer of the message.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/types/SubscriptionReply.html b/types/SubscriptionReply.html new file mode 100644 index 000000000..eca24dfe0 --- /dev/null +++ b/types/SubscriptionReply.html @@ -0,0 +1 @@ +SubscriptionReply | DWN-SDK Documentation - v0.2.18

Generated using TypeDoc

\ No newline at end of file diff --git a/types/UnionMessageReply.html b/types/UnionMessageReply.html new file mode 100644 index 000000000..2bf18d447 --- /dev/null +++ b/types/UnionMessageReply.html @@ -0,0 +1,10 @@ +UnionMessageReply | DWN-SDK Documentation - v0.2.18

Type alias UnionMessageReply

UnionMessageReply: GenericMessageReply & {
    cursor?: PaginationCursor;
    entries?: QueryResultEntry[] | ProtocolsConfigureMessage[] | MessagesGetReplyEntry[] | string[];
    record?: RecordsWriteMessage & {
        data: Readable;
        initialWrite?: RecordsWriteMessage;
    };
    subscription?: MessageSubscription;
}

Catch-all message reply type. It is recommended to use GenericMessageReply or a message-specific reply type wherever possible.

+

Type declaration

  • Optional cursor?: PaginationCursor

    A cursor for pagination if applicable (e.g. RecordsQuery). +Mutually exclusive with record.

    +
  • Optional entries?: QueryResultEntry[] | ProtocolsConfigureMessage[] | MessagesGetReplyEntry[] | string[]

    Resulting message entries or events returned from the invocation of the corresponding message. +e.g. the resulting messages from a RecordsQuery, or array of messageCid strings for EventsGet or EventsQuery +Mutually exclusive with record.

    +
  • Optional record?: RecordsWriteMessage & {
        data: Readable;
        initialWrite?: RecordsWriteMessage;
    }

    Record corresponding to the message received if applicable (e.g. RecordsRead). +Mutually exclusive with entries and cursor.

    +
  • Optional subscription?: MessageSubscription

    A subscription object if a subscription was requested.

    +

Generated using TypeDoc

\ No newline at end of file