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/icons.js b/assets/icons.js new file mode 100644 index 000000000..b79c9e89f --- /dev/null +++ b/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/assets/icons.svg b/assets/icons.svg new file mode 100644 index 000000000..7dead6118 --- /dev/null +++ b/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 000000000..d6f138860 --- /dev/null +++ b/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ve(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! 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..1449e7311 --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WaTW/jNhCG/4vOQdMETdrmFtje7CabxrWz6KHogZHGNhGZdEkqXqPof19I/uLHcEhe/b7zSBxyyBGTv/+rDHw31V01ZgbmUpnqotows6ruKhDdWl8ef/9pZdZtdVG9c9FUd7/9f3GO3IqJUlKNZANBtKWRhC/CgFqwGv5ga4zi6CTpGcxKNhHMWYwzJqJWu43hUty3S6m4Wa19EmKJ855gNwbFP1jvn9crCN8MscR5/WyMuYK6N/skR4wz7ttWbu/b9hUEE+aBGeuV6pZpDfoy9Li8q2ubOOJNiBjxhooZM8PmRir4Ch/QhuGuniYpYOsYpddIwlYgoVuRiBlJoQ0TBo09ignGUCEoYFCo6ImoZQNI8EFIxB4WMRp+0EjCBwgzWXNjQMWyH3qSxK9yGVkQjpzk6AdA5uUkpeP/7EDtYoRBTDPm3ZuuFX9DCswzUKzPzRMgbzL8TMU9bnUY9bjVVMwzaM2WyPsehIxYqqgDSwYPn0lLpBhTUGuuNZdCT5U0spbIWyEmkjls1vAEuzlfCqwAfQdN2z8RmauTlBU/kmLBl51CJi/0ZBEjJeDqFGkGtVQNMrKDkBE7hhawA8qRMziRsdhqBmUGDDnpLDGDQWwKviOD9pfiRHoGlaLMod5c39y+X4WIk5QRr+Lxiox/BW36M/oBBChmsKMwsJA8vkay0f+a1YucQ/mx57Q6ERdxfXOLHF4o4SgmAf5B6jOwQ9TF2DssyrENuaCXoRvQSd7Bl4PdL3GvA0Gwlo/C+juxRcK2YDcYa4QtQKwHdiH3teEfsPeOVlC/z0B3rXVymd2mb6xxm0f++fdfr26u7Q5bATPwScl1MBd7bmBIEU+r+gEM/qqhI5s57VLMkyPJ7L+NoDkcqY/b9wDpG5LEoTlf8GVAOgopwrlD/iI2XTBIT86nTZXcgDK7OPDoSDL/7Vj7ibfGLooD7CwlKcOeY5XgZyaaFkFGfFn8voUL2k6La+nZvEiR+Ho2bwabNpwVR81jDY0GOVrbUcAkR2w7CpjEqM96Hu/U0oxhv0gkvogwY+ETyOz6rkI2mWXfVcgmsu16Uly87PMqfmiyeB3JoauWsdDhIZYU9Ql2ie03dGQwn5kBxVmLwI5SinIYxTBlPsbWMjnuhayDCe9koxRidw0dBcxIJYSOAia6RHy9lDcRRiWhgylFfhHwssCLy5JSlClbcsHcvncPOSv5jFGndLiV+nqSd7oAGUnRcHRmMU8+d17LTbAAPTmDpqVgCKX/ORkdbSDzO8fjzccYFlxwdA4DRy5z1rUwh6DiPTmX9toHx1iDmEs63xnFj27KW/6cyHYVNZY/IbJ5RY3ZTxjaInyLwDxl3FReSjpHNyiVj5L+0Q1Ct3TEkqR2by2vseI9CikCNdCS8R3euf90RY8WX0/xZkwsYdTf0ylkP3HVLBa+/CwpSbGvViOLDvMUcSMzgXkyuVSNIJYSKv2yJavHDkFrIzAUE9FVibsy2f3FNp1Yy1HApNNqOQqYVFJPeiYv46M17ix9Bp3g0u9WP4xOdemXqx9GJb3s29X+u0Uy656rhE1n27aUUOks25YU1b5MQ7MbGFLEb4JLQX2LB4YUkXVmBcLw2rk4X3Ri+P8TfWnrLuv2FwsD36HuDHwTLWh9/yaVgQbDYb4A+88PTkImwtUkAAA=" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 000000000..aa1d485e8 --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8W9XZPcNrKg/V9ae6npaeKDZPlOI9le2ce21rLnxBuOiYlSFbubo2qyzGJJ6pk4/32DAMFKJDNBkEXte6WPAjKTBAgkHiQS/7lp6s+nm2/++M/Nx7La33wj7jZZosXLm2r7VNx8c/Pmc/W6ru7Lh5uXN+fmcPPNTft8LE5/Hf7/9rF9Oty8vNkdtqdTcbr55ubmf146aanWMh1k/fOfXd2goBdDGSDv5c1x2xRV65lzUZLcCTXo2Jf7X4tTffhUNDGKbv3yE0pve+sY3W1Rbav2+20b9Yy3XvHrNBefiqp93zbF9ilKtV/+Ot1Pxem0fSjet3UT99yownXa99t2G68all7hjf9XHf4svNdtC8/WKvTlA/oWKy2rtmjut7vi9Ff3W/B7FHcqH6TVx6KalPSiL0XbPRjEqNgd6lMxrcMVW6ZkezwW1X5ay1BumZqHojVFTtOaYNFlyv48F81zrDq/8DKF++JQtIUV8rfn12XE+6SqLO0mxbaJ6Sa22Awl/mRmbf2+aH+yQxD6ePHPE58SI/vX4nh45iSbHxfI/T9dE4eshgWWyuctv/y8QPb784fTrik/FG+K7s9jW+OpmS13rXMRFjzlbPDmM5PC0HOXmHELa880aHKKbh/r/SKjhqprW2R66m/lU3Fqt0/HhbaNhKxr5X15aIvmtMi4S92rbZr4rELDAi608gcFpc78mpzVzKvfntvHuin/vW3LupptxC2uPsekKY8zchSjzPLqXmfTRKfgx3K/yPzxvK9/7N7s/95W+8NopcUVW6XzcXKjuh9le8DVRisq7JjYn+Md7pN78zESX8DSoUeyNjIqi6eyjdLWF1ysKLiYgIqm1xNhReElBdQUsaogVPk9vv/8TGHUG+FP1/bskayp3uzZFZ5jI1XdXopPq5wYIsuqbMvt4b+bcoRCWPWozhIbcOPBr50aD0e/zxoMvy+qoil39Ozr/3ht9yCkTXUQZN3cuYzXGDOHodrhzhKa6QNmxM3wU5aEG5XqNESJdZv3InJeG1tjmZd8arftGTuyE3pvh0rR6qdfcF/6fd0w42n3y0rD6SAqcjQ1RvGcsXjdFNu2wOsoRtmtX2NS8TTnLN6dPxzK0+MsC2Cda22YWLRxZkQv04KWQOfMFQTjN+UREMWCPcufw0gCxol8EaBflLWMUta5YfWGnZyw6uCXFK38NvLjgrWt1fwo8W77UFbUhHD54doxAkmaGiKARVzbnZvTaB6ltdwOZaeUTXyRhxL690GVruh8jbhxehh4Oh/ab6u2wRMk/nmWU9V3Fp7RjgsslU9N7vjnq2RTL4css9J0RwiNnPiQyeHhH+4NROq/9arOMCVuQlpqzqq2FNWu3hf7N9t2O9sev+6KNjXNaESKsKavdZUd+OP4zuBQZIv9z2u7P5Ay1d97KwKE68/z9kDaCn6ZNSr8UhW/3JMSwS+zJP66rR4KUiL4Zb7E193KuxlPuf6P1zYWIW2q0ZB1HKtvahz7wOu67UvHKJwK+qjjtZqyy3TyHtLrsN9hf17PWwLy4n2m3sa5E0tIa8ycMqofbspP28N5zoPfugpLtZOe1S/GRcZrdfjTtY05kjXVkJ5dHGGom/ZdUx+LpiU9QkLfLaozrXyiATt5b8qm2BErh6ARsNLVVlBOOas97JbP0EouP1i1EwuQsN7RWFQ0T+Xp1HX0utqXVPelilw9JnEyJ8clyl7mtR47frIjl6IT6m/9qvGmzHnh73d14L2YX2d5Au+auq139eFkw9HODR+0ESp6ddNOyZ5s4tBzzIzeiDUmIoAjKGpBDEe0aRNhHFfZFYSCMyyMpIRX2Lov7s020/hbjrXSk7CGfdwH+GbK1EuBtT42JDH2EwOWcmNoX3KW3ltQK9aAieY/Mvx8ypBJhD7bEqN3nhWuykoWnNrmvGvPo7jpCStgteWWXN0pL3b0wv+SzDcIPMz09/hboMXMb2t9hRdhsR+gNW36EX49H4r3xQgX+7+u9RhQXOyDOAOZLvu/imrXPB8DYyKh9PafXq0oAyY+nf+13ZEubsiIS5VVLGjqw4wXf/vPvvwquk/lv2fp7ssv1H1dl7Pa48cI34xb+6yc41PO6oaeIbe28nxjppyx7ZcrbDKV17CJXVWYdSWJLqkiq60isMzo1QO0d5lzw+mOd288CfGvevA+6X00ttyy5WLgfAJZ5got1L4dUWJeYOswRzAIa1zg6mBWWuJkGOvYUi6u6vBQN2X7iKl4WPEtrBZrQlw4YB+r9fdiR8ROh41iJKxk38fi+VvOtZgwDFddbtFoT6bY1c3+9MYcsqK/LKrIvH0fKyDw8RIlFmugPtzR79dJp7bc6UJL9PxabPfB1wQKXL1PRkuc3CsbW7og7DKsPDL0khAyRWcY0jhhTkRAaowtgUYP9Nzh5yUdavpkHF9wpQ629Gxc4Alm4tU4QyLgakDQArQaadYEWL3CpiBWjbYuEqoutvOejEOIs26oe71NUx9YcNiedUhuSlNgrLji5FUvwZyOmBosUKGVBgpKauQgga1eNkAEDIgfHLCQ5QNDyJy4QWGeLcw6M8KayZXmVfa827aPy23qa69oV1PsymM5Pq4VYRSsuqJFp91j8YSDAiPMGeqtaEu7fcDcMsKSvtaavcfUfrvg2wI1V7SnSwwzjj+KMOdScWVr3o8xa6Q570PAdak9zOGXOJMmz8EsHJ1jXKTwOD3PPZrZx5ntxphOPrnluLgduUNEkS05fZ5ocY//rm6etguGba/udTaF3K6gCwlLrOlwLVj7e8YuX/xz6uet/j0pkxN33eyDUwJlDqi2liW7umqLL+HZiTIF1lvLlikowhoTT0VmWLNt226kXNJrvJpr2cPuCE+ZE7EpHGVN6n9TRdV2EX+XL/r+XNmd37/Cn2ct/V7t2vJT8ZtJFvj6sdh9tGer0AMzpa4di0Jip8YjznBu+XeCFebbcTsSMMusye+w3ZZ48RVj1VDxWmvEJQfGq8Oh/vzqcPhtnHCy1/LXcZFgV9CJgMOfjYwBY86E2Bd+HeZRx1bDXg9yfDBdYcqI2A4QtAMcMyZeLzgVG/lmYx6Mlxr7TOSzwC4DFzfuPb4u9/Gm7+qn47ktQnJeeGVoQ7vfGA3HbXMKywclZkvvbXuzfXj34XW5/66pn/723IKYLu5pqBpraEfJhWLUT2Rs9fXHftJA4fQ37KuAHQxus410wB/ju5xp7mlZL1y54DxuDeOax6xPI1QNBZfrcv5z0e3bPsSpperMsyAVieIPzvKaqaOy7Wn/l/L0l7J6LDrnaD9f/6l8qIpxVxyrHwquqd2+zejX/hWefdtFnb7bPh/q7Xi4o98CqnKdRbA/tvUP73/5OcKKoeCVuvk9fProG1FipSX27INwlLFX0Sn2gNZcNDXjpFhoy461J26vboYVHUwisgBN2QGqrWXJkUs2MmWLV3Eta9DQGGcJMUxe+U5cvOc40HjyrfhVV+sv/cy3/74ZLw8new2ufIVVcIXwZpR9Hrjyw4/xHg+XRdEXFc6heLGJc3a4JENISzi10KSa45lc4CAlttRCFQ9FjApbaqEKm+Q8QstQcHGrMDnQR60SSoJOq0FXergy784tyZLGBa6dbxmJk7d9jC2dt2MW1ju9W0bUn9wzGOqYDCmh1zsUWO31+hKjX+/F0oWvl9Q74/Ve6kdsjJLXnERYMnHdSYwtYL37ZmyKc50vP8WP/G1N0wgk68WlXOgxQgl02/qXD/8qdmOsNlY1FFyq656lLFjZ/SRdidMW+Wxe0aX69uejOeBfxPeFF3SdGRbEYh2sOIbukAq9Lu+77EV1fjKaprN2JpchrA8GeHXaFdW+rB5C4l4QhVnbRwk8Rzq7vd94pV7pJVqHzfK4ZyWLX6U38nnp8tGaRzNg0ZSfiv27pvy0bYsfPn/EgzX+/er5jxQ4Of2NzOR2puu6/bF4Hu0HB9XewlqRBkwugUxJk9jjsXia9RZuicprW0WEAsbaFIwDXGTRUP7HAofjRhiFai+3C3gM/3sPTXHjtPnfeD/BWkc82ljeC6Is/SDWsrBGk8wmTiEoGqcvdk4DqmKmM6zm8kw/Fs9vuI/JDpBEidj57c0Qj3SKFPrCr0I/DWUzPfr3AOa1DUeJtWFcbSU7vGEh0ojgeBBtgfltG90Kl+KL9MLFwedq7JB9DmdqidmQcjKm9qE6/VH0Zyw4DH14ucem3hWnE46SGykYlZut6dP2UHYYmIkOGDSNyi3W1Bv7tmqLh6Zsx2PgSCdRI0Y76kOvu0GOeUb3W3hUQskB3vQrchMCUex/q/9WfGtzz06qeDFVnX2+4SkWLGKwEVGrGFIlerXfeqlxgT7zwyqxMp6wWMutXWxg4p78sjw1++BHheWPX8prqKRfLYCfYmfBVyDe7YfPp5+6jHTjZQgW/IKtFn4iY/SkHZfQ39fl/qfy9LRtd3hqCpvESVjBurKufqqb4rfHbfVLVbx3W74/1+378/FYNzD4PsLUOHHX2D0EAdt//Fy3v3yGW1chI/m6q1j0c92anZ5ujHrl7/ZHWUXWX2rZ6yEqqiuzm9Wg4brXW/TT+dCWj9vT40KruPpLLXtT7n8yh+dm2cPVusKKTlLbxIxYqPB1Ov/e+Q+RKl3ZKzSaq8/PXY//blse4t40UWepBd/uhdbJ5m1l3CYIijj9VI3F2rtbxL59Ktu2aCz17IahY4F8A9aUqepX2XU5LAwuqvu9Kp+Oh+KpqGK+ing5Sy01N0BtDz98Pv29aMr7smi+L9ph+f9z3X5Xn6tpQ6PFrGdn34GGaXGBjYSIxfZ1c403AZn/+fbLsWwiGnqy+sp2xfpyk9VXtuvX4lP9cfn7ulRfz663bh8/2tuMk7GehXbivMK8kYD1bLu4Yd/VDVruxxtIS/kaVkY7m5FCVv4+fq7b/69o7XmCpR8JkrHUQoNm33j4vx9PJw0LVl1qjxvXn4fh/Pfq5DzJ182nSasiBCy17W21L770j2hvkvh7d+/Eb3AfjDMrXHc9i95Ttz/EG/U+5iKIeXZBkW+rn4qnuplnGSPgKtv6qc/8ffvhUMx7ZYHaV/T7N0XHjN4dtmVlIyL6IPPY7zFKxFL7eo76fdG6/hJhEVNpqQ3v+lNH81fvoZrXWrNs5T5Ve7FVw50TJ7eF8/cehdtdld+r4sux2LXF3gbZTlu6QOJXsb4+Fq/dwe53Tf1YfuhOOvTfXlng3aWZTxIh/Ws9lX2NX+WRgqIXP8+wkf3ehLv/XnWD4G/1m2J/3hWvRulOWeOj5XwdS/1QkmVWTgSWLLDw4qycmwj3MELActtsj/I58a73kvu9pwgD46R8BSu7JNmnaPoxQ9Cqtr6tdnXTXXv1Zpx7ZZattKCvY+vrUWqOZaa+nkzVca2lgeiHucZGBUUstPeNi0ftjuv8OsqdNstgVtbKb9i6535WtZlv1hfxNeyLWp5FCFjVtp86RFNWD30D1c3+umEqKG9ly790kQexi5I4GetaWFbXW4hlrGyhWT9eOYYSUr6Glfi2miU2XmSsauE7U/9QnE4rjvbTQld9hs4H8g53zjIW1P4Kb9aNIa9dyExZPbyqdsWpC7t43IJ7Vxa84Rjh6z5T/5/XjbSElFWtNGde/7tsH+tzu7xfEFJWtbKT6b7t63wVRtK11oJL/5wz9KoL+XpbzR3PYiR9BWu797KKsVjQerYOG6//ju+lXO3VrbILt75n/XK/3MCxoK9k6y/3C1bVcbK+ksX2wpN+mHntR0ovNJwW+ZXs//3YgbJV7adFrm7/MFT+cv/Kv2R7tt2UqPXttcOPXZrMWpFFiVrPXjNxXvUdjiWsZ12/tCtOnbP0pji2j99+2RXFfpGhQWEr2lwfije1wWfffilP7av2+/JTUc1y0GOlrWf179WQ6mvJu0XVr7bLdKplNlFVl9rT52WxDtwbL5fLq2r/dm+apKhmRNkskfgVrJ8Thh4t5ivYeQlNqfYmUHuIcljD/CjpX+GputHyDZ1WaMFTkNKutPpNYdIU/1w70PbjcN9cF80Us5qcI+lqazsnyltmRYYVRwi40jYzHFnHyF6lOZx57+I8YqHdTGFr2Gx27FcyeVrWlRaPg8Ze19XeXLpt43kdy+j3hWOtXyD3/8mT/Fr8eY4K0V0qdfWnsJ+Ym6XNZv3cIXyu0NWfweZna4bI9pWfJlb86s/lR4Nc/yCsvK9jec8q3Ou60u6xtK9j9c91v6abjnqZIejr2OpexkpdgxD3de3ulksr245Efh37I/eaI4Vc7WX5WT1+r97PC92Jl3OlpY5Q9bsrfvqE4uEpBt7PEnWlvWbtsebyco7A9W1fsLiclLK+lestLZcKX/+Zli8sY4VdaTPK9YKzmswOFFgsdqXn6GYBRttcd2SeyDVWeHZBNmxGWt9/RjDuPFlXWmzvu27PTVXYIPJjxF5xuO4KFl3BHPjqV9p1/QHeGYLWsnWlvjhD3rWW25xNzJc6z3GLlHWlxeZCsVeX69CGHEFUuo5Y0+cK/VrPsCzDylKpX+spem+zP8UUfUhrsdhVnmP5EBiov4ZlFpS6r8i/3iDGMrr+epZ1Yeuvqv0be5PvT+f2vD0cnr/9sjucTzEnZZdIXNf6193KaO+yczl9b6vrnmBa6npPMcRoVXtvZb/Co8wQvcbzuEZfMvaN665lkWnBpSahymvY9H3Rflu1zfPb/e/Vvrgvq2IfeXQ+VspKVr6tyrbcHsw/oyM442SsYeHbp6dzC88Cv37cVg8zh/6AkDVsXD7yf40xv5fZ9eu31bum+FTW52i/NihhRev6rIrXG8kJWvlNouT3M9/iVBr8JVbNXfYzddfs/7PWImTNNawxhOlVtbeJUBbNCayINezrPvZXPgf7vfpY1Z+rBRNEhLCVbV7F1q9hozufPaxGwAplUS+IFPhVbF+8SRov7uva/XPdvq3svPaeuw/yukcJa/gqT9ddDdFfnbFOu9ACv4rt3w4Xwi913qNFfhX77Y+dIzwjWHOJxKXW20ms11I3r/Y27GV7cE7njOjnebJWsrhjIjFEjq22kh32n9FrkanaK1n1e1V82h7O20uyjysadErYYpuL3VHo9GNi00rGJVtlKl1pQ7PEBlxpqQ3DrbKxQYREhaW6f28O4Czjz126iEPUYBWouK4t3Up4oTV91SvsGb7PeW+GrramHbFvhas4yxYvK/2Q//Ln7eiaFvyzMcPXRj6hzY0bI+zFUJR9At/AUB6zOI2g8DU6h6MYUUph6Wu0ssF0hM6IeDlOo9dD+uTfZPe4/BbbN4bTNJPCXsCi7CMA62h9zAnAkbLJY31Tmr6njvRiNd+Hj+tO6qDDXUZapgJZpvTYe+Un9bhii/V08QHTavpSV2j581ycIt7bpeAVuro8xzGq+nKLNZmFxbQiV2yxnjf+Jc2sojcTdzRPaxoCG6aVwaIz9YGraizAHV8u0/9/cEzz7jL6sD0Vqfq9OfzG3DQLJb4gStPP4Oyb1srczMqpnbiddUpvZ/Rv9d+cvAm149LXaEUXR4RUTlwbEacv6s2ioov01aZ2VAfCRRfpO5m3E92MVPHr9E4/Jy4aqy/2EilPWcwdUmNV3nBinFnoBwyK3C/xQ8qxO042IeiFK8RYO9jD6GAuwkNKJq7DI7WkIlHgcjTm3jqk6Im4tq497f9Snv5SVo9F0x8+m6P55O+LMopP4z3QK/Vu/S0KRu92vAexwvOSvDvw5Cy9nm2LfxP6D+9/+XlK/1DqGq3+BclDmV8MHr4MMfZ+Wvxz8IuMuB6ZlDd1O/LIRjCgeHfSmQTuMzTeDjXiFE9c9os+nwj9xKd0hf5+RBgI2RxLiLqLbRoN8v4Cye/c5rd1BvqLqKih3lq1ZLAHiqKG+5GmOQM+ULZsyJ/QHhz0gfJFw/6E7uDAD3QvGvojnjti8Edv4IrhP9jfghMAsGHRFDDWTE0C9rBxYBqABdaZCEYS46YCz9L5gzGnNW449mqHB+R7c+Qg8mU6Iy6VVrIiMC2yRkRNjDNsiJqaWGtmTk4Tdo2mpzFJ8T+/4fd1pilfXNRUdbFwyXSFFEZNWaTGOdMWUrps6oqwIjh9ISMWTWERNgSnMWTDoqks8j1ETGfEG7liSpvsl8FpDdmyaGqjLaCmt6FkaIrDhdaZ5kipcVPdyOr5011Ie9yUN5KwwmAftGrmgD/TvtC0HDQrbmqOsMan6n1oFgXc+p/iJ55tcRI6fd02feUpoS+ICizNc4ZO6e4zfMXrvlRYqrvYlcVpiI+JfXiu1jpWxL4GrtYcK/zJoDx9e+zOizbbw4/Fc3dHdlOcTgUxKSBTAhVnWDODKHvaI6HyWCH1OXG3MBElYrfjX7n+GinyBaww9TgXe+kwEa+TxBowqrXEitF8OpR+Wx3PLR5H/V+vnkEJcZNTJzKQmQe2ox4yqfJ2O3knF64dnotKeyCrP+z698L7TqbNYaqvYdnH4nmGIbb0SnpRhdFMHbaDqL3QLtzxfxwJR5aNC1zb/RmJU18AYSnzuvcoxcAs/bdE7ViDJrrB0V26DnK+RJnkV1zbmoW2rGcJN2hNWDI9bkVZAhxXGLE/mtnhj9dSk5GsCWTiGTaPl4xVTcCSeF3fNfVTtL6+8HKdD8Nx5Aidl8J/EVdpLU/wfHGEZr/CldofivYVDWLIR5440hbfsuCwWXQD+3WutQCdrYq2Ylzvqrc/s/HHNZZr/2QuPP/2z/P2ULbPv9zjc+QlETwztihOynU91DQ8pA/hTgqKL9d7X7S7x/5dzxu2XwSqzrMnjh2PDaDA8Xx9DKEdqyPw7Hxtkyx2rDcIYudbUH+moPhYrSt3tS726OiE7ugDoXG2lCczpu3/9uznxY+ai9iq61jknf2eZRCueW3fjOoaE2R4Sd94H6ubqTbLEt9rnjHsblcZc5mdj7E6Yttjrq7C+u3vn5+eirYpdxc/Hq5YeBOm6i+3rOtEkX3taj19xoJIdZfSq2id8V3Ttf6f+/r/f3r61/m8jhK/rfbFlyjHjqiyXP9wBn32FMPXXMGaud2QrTjTFh+ReclZyI1WosS1kIwTOUXJKGOZCaQZ3fEZpfq2mbzRk5IwAaNwQqE4U45TuYSWW+JdZTbPmuC9Zcst8i6OnWdR8LbY+Rad/GRLcbacwnmW5lvRbh9iP0RnQ19lLQuaPonH/A/IVVutj5iq45Tikd1kVHstu/bbdm4/6ausacHrcu4budRa0w7vUt14Q4K36S6yxOX9mW8MqLmWPROxNVNGRQfWLPiq3DVec78nUG/NVnu30B5cd80+/V2XiGKuC+FVXG1WouLFJmel+IV45Duhb6aIfC9xN1HMt2p7gfMWPcydOUkBa1lXBHegp0wb117t+y+apy5JZF2Z9pg/rxL1r7ANL0xeDxtr9LJk9Pu1ixJa4NSSZGxm0J2yL+EnRNMjDLil60caNd+RCRsTdGOWaCcH2mkbJobZuZZwU2LYkOkJca4dhPMfNiHo+s/VPuGyhC2JdlgW9BLWRZjsKBEOwlx7yAk5bMjEdDz7jYQm44lXEjcVz7VociIOWzVjGp5rWXgSDpsVOwXPHm149DEx4MSAjwhrUvB+vhS7c5fh+FCcTq8+mKv8Bpvuz9XOiPgrVSwcjAsCkH74PEa/P3wOz9sYnP9YjqG5k/Fi+J1+I51+XrLtcW8m5MNSs7XYcAU+7GNQNC44W9e+6HJ5vDtsy8ombuH2eQelgRqztRdf2ma7a4Nv0yszWwMMiOG71Qtc7Co9cWoitcTG3F90RATb4wcZhcP+tG2LptxiFA1+WSEA1hMVEfk6GMVHGFNBpZSa249TcaRDrcmo5nfbEs/vAa196QV6l79Up7eX+Rf+wMDYgMHmYATtD58/LjTlFgqYa9TkzGlunr3GOCjheuvwl/aOM/Dyw8S0h+QxjTH8f/QkjJeebpjp/z9+Mv7UJ/3+4dTHkm+DMl+Q5ek372ycmqzDCmGxpXpeExMYVhIi6RMadvVTV3RSi1dumSYbxQovaptQSVa4Qjfv9hB6p12f6bb7ufhcnNqY/v6CKL1U6y+H/QytuPQireWpM37ia7gUWqijM3VShyu0UEdkLCBSOjMMMNqKcIAGY0RccEbcuPATB2JCgwRRaZENbry+RPUZ53PyAw7Wi7Uk1jlGL2DaQR6rIiZHMskh+O3aAzJY1MT5GGjVvOMxI0UTp2MYTXGh4CNlc1OIRGlnwmFHymemDonSzQSlj3TPTBkS/dzBeG3yDSxKFRLR35hg2ZENM1OEcJp9ZxiUoreGxgWuXdQyEqfWtoSlYeb+utxHPgzi7X3FWDOWsO0JQybg9mwbJnYh4l5L9CwYtAt3wN+r7p4yW/HX4njAh0xHv4cnDD266+F9W4NptnT3GAxPbX6Pn4XqY1FFSXvRlwy+KmscNxEd6lOc5S9c0eXKIMgPqgpR+xhFD0WkoofABQgxiv70Em8GVf0ZvJ0gRtneT30f1LYPp7+P6xrFtontGrboPGXMd4TnCEZzzEwxGiQBSI0Q+2KoMv1gxHwBHNV3Q+zFaXRbqZuMiTLxD3duymiBL2xh+pkoS9kICXM/hRebPKnbr3S1DQ/dfug8C2CVFd7Bp3pnaMvc14DqXW2JuRS7JEERa4VXZ4kF48UTvt1k0gZU62or7JJpthm42kp2+Fv9kVaEN/kXvAvX1+a/DlDzamsG0kDTZ9aWUb2rLTGHrmc2jVdniQWxjIRvkwheMjFgwCnJ7mz8WDwzcB4XCE5G0Q9HCY17Mmxv1OZjWG948zFW4zhjTFjrdKqYgObp05+00uAJ0NCTel0G3zJ30dn/Er/IMZmNilfV/m1lghfMzph3MHZKzYs4Edwju2dZ0ok9M+J671gd+WrHN9KNtA5FruWajMQJvEmYOo9ycmonYGdYbxzz5FTPRZ9zbGEIKGfKTBA6xxKGh3KWzMSic99JkI6G3s4iSBrfaxlWylk0E5lO2IHDEnBhGqCy5a7lqGHBUziVN38ZQ4yyJh4l8uKm4nhHK6059sUsuhZaRnLgOKsmcPBSi6YOrcQZF390ZY6d1PRL36Tj/7zatBt9nw4yb+F0G3+rTpy+yt0//Z1J2x2leFznGguGFAtRumHpuVpnuhdX3CkUa8OUW7H8ZqFYC6bcieX3C815B3FuxBq3DMX1ySn3YfldQwH9jNsQuHGILLOauzD73iHa5CvdhOvvu6FFhae8e380jLXpfs6AuIY7sPSWpiWWRLsBrFELXID4a4rwRfbuo+3/fw7UoG8kgIJe7CcuIHDWsMFmPW74sXh+M6SHJrcfPLXBeitb8vuprB7eDAc+Tyj19Uz7WGlfw2rXfbr/WMFsUtzXtLtPnLKi6Vji17Desv01+gmWtMhaSxYvWHTqgx6VXqTVbXS8qnbFqa2bH4vnV9X+TXHaFdX4aU8/bdvdxDe/UOIi6x+K9h1M3WOOMt6PswCRhk5XXmTT1BLFsyF2bTKhszy9b7dNe/rvsn2MUUuWX6T5w7k87H/bPkzk7bNqx4WXftefiqaNeVBc9Kpv5I13IvrX4r7o6pfbw9uqLR6asp34ZmfJWWTp6bE+H/ZuEH3FLlU9s/hKi2ywTuXbanc474vTcKg+xt95MVl3BYt+r45X2ETWjrUqdrOHnnumU1iHXc03fiwXUmZ/vZYzjYXFXezQ2zaPMhHK4q52mNAWmYvU0zszGWnYgoEaTaX+hCZQlWbaMCufO9Q9FzhFWhDOaw0NmImbIvWHM8yPX/7XeP6YBOz4TSxCTVE9M5wBG9oxEzTx2slctLZcMBmtV+RaysTKjExH69vLBvaFsmmyuqPTafoS1shJyNs0NynhHNum88Hyds1JCDvHplDuPd6auOR7c+yIyb7H2zMv/d6UXWMX5NeCH8S631ZyPwZRcc6HsWqR63FRFOd4hDRFT/oXpbOnfKx/1oR/0btwug9rD0/2F+XLpvqw7vBEj1/4+s8dM8n7b+CaKT7UC8MT/MWGZdP7SDM5uXelglM7KLDSxI4lRk7r0NI5WzNhrVP7MkTtNSZzzpq5U3m8XaFJk7MmbsqMtyEyxSlnzuwMpzMsm3RzWKNmODnx9sS4FpxF8xyLsE1jt2K4nZ0bt4YCKzkYvrw4L+Ni5CJXA6mM8zcmdUY7HUj9bM+DtGSW+4EsWOiDRNgRdkSQGcu8kQgrwi4J2Rxf6V3EOCfEW7nGQ5nst2E3BVmzzFehbSAdlqFo0GvBpVZyXUixkf7LyPCrHIiQJbO9iJGwBREwMXbF+VozrQk5NkFr4rybmdZMOxJBm+Z4EzMti3EpgrbN8ysirAPOxftidxQ6/ZiMhpnhl3h3wu39URv7vrgXflH6gS62ce6Lu6X8txqmBGRUjkov1TrEI8SpHRW/6ml/+Pzxt/pvzy2xZUM+r1f+uieeoZqosFA3eRQPqQuewZvUYJMMT3ZYV2qhloeiKhrbD7x8qoy6cfF19P66/TxTta2xWHt/ejBiSEBlr9UY8Wmisgs19lFKsY85Ln6dXj6WilY8HU0Vqfn1Y9lFVMxTP64Ub0NsZAFSHBNbQKkjpsmGnSabdafJZv402Vw5TTaLpsmA1thJo1k6afC6Q5NGM2PS4DWEJ41m1qTBa4mcNJplkwav90P3+n+r/1Y+vCVSOSCtuHC8zpkfdDP/g/YfESRGQrkZQNKiiKQMgbwItKCJhAhz0yAwSqbzH8zIesDoCH81WDwYQOumfVM2xc473llU56fTX73fwi/+0oA21nZfVg+T0l54ZRnTPftIja/iFb5arg9MOh1GGH0L3X/GTzWnQ1GM0+UOMl6432kjjQGM5KeyKp+2h/cTClCx+Xq6xOLnpivIp/+9qKNLz9dqyXOMxnHJpdp+ub8/FVFPyZWfr9n5FzFaqbJRGmOHefCAESM8UgI/nO5Ii0ke91/Fp2KcEM7/OfgxxZpOiIx6CGQpMwPszJnrWKW26DX6Phzq3ceTl3szpNMrPlMvn58zpDGYnjNOl5+gM/hKg/k547TBDJ0hXaEEnXGaHoiU3ZSmUIbOOE0obWZI2UTWzNgWg3kzwy0WSpvJfwNgCPn2U1G1/1U/0COI9+sqA8hYYtT44ZvJfM7nQ7n/btvJGS9YCL1+8Sv0ll2YeIxGV3Cerumhg1AVHDmiNNEDB9V+wXEjUhfV5UldoR4fpWt7PBbVeO+TUDaUvEKbydprSo65AKHSL36F3oeijdcKC1+h045+VtLfnqlLbgjdVKWZ3+L4QoeAUzQqEb/IMCfeyJQIYeEvqIr0M47tnz/EMkbMuC1jsafGqw45a9FaA/4a9+anXbZo7fQwzygOD/UhndPDPaMyOpf7gmGfa9jolO6zfTlGY2zC9elBOVZjfN71JV4ko3RG+vXZ/jijMjZn/oKJnO09sVnfJz3Yb5/Kti2a921TbMdpVMdF1vNlx2LjHVrfag5tsfGQnH5Y41rtvL9JKJ52OqN0BjxP6m1Pu59RWouncvytcEr7wot0olxLRXOqq0s26z6fjf3fa6PKoJjJDEq9IVx0T4mDqQnht/uA/+bKT97DOs7uQ2iaSL0cq4u485XRFtxpYvUta6T4e159xUvveI0xIeJ+V9qYpXe7xhk1fa/rIqvo1FeERVPJrtiOCDdAilPb0Zrv7b4mhYxxifhVi9ssxQNNWPSLcTUGT49sn7JjOlP1lEmUhLWtoxN5xlr2f4JO42yr+pDH/+7Cm+fahOqu/J76bOlDAo1FJk4JW8nmLifQNWYS9ddt30V9DtVd1yL+ME6cVe8nXdGlljEJUOLMehNeXs22yeIr6hbRCXtgxVVtWdSV/Kqr2rO4I42rr2RX6O7XCZv8qivZE76re8KiuHu7r7OJv9B7jnHTN31HW9lsq339BO8dhkErE8ZxldexaYkpq1pARyIGDQjHIs7U//pD3bx/3AqdUvsAQTtw1VXsoeL7glaEYvxm6g4EnYQsiIg/ibXDBtK8Kfe/Fqf6cO6+w1+L0/kQ/U5CAlYaa96U+y6ec9kqBVeeb1N08A7zgmIiecbq//Gy31b45j9dqG139PzmmxtxK283Ny9v7svisD/dfPOHNexld0/8UyfrH/1vfy86hV0JW+Svdzcv/7h7mcpblf/jHy//cBXM/5v/MKWSm5d/JC9FfisT7RVLvGLi5uUfghAmvFLy5uUf8qXOb2WWeMWkV0zdvPxDUcWUV0zfvPxDU8W0Vyy9eflHShVLvWLZzcs/MqpY5hXLuWK5V2xz8/KP/KVKbxOpvGIb/+12L3vzUqnbO+GLS1AzmHa4oxQnfksk3StPErKk3xpJ99YTQZb0GyTpXnxCtlzit0nSvftEvVT5bZ6kfkm/WZLu9Sea6DOJ3zBJ1wBJShX0mybpmiDJqIJ+4yRdIyQ5VdBvHtE1QrKh+rXfPIL9TAT6TsyHcvdSi1u18XuG8FtHdE0gErKk3zqiawIhXsr8dpMIv6TfOqJrAiFfan17d5f5Jf3WEV0bCEU9ud86ImOf3G8d0bWB0OTz+M0jukYQKVnSbx/ZtYKgWlz67SO7VhBUi0u/faTgHkeioUxyg5T0W0ea1tlQ71z6rSO7JpDkNy791pEpN7xIv3Vkxo0v0m8d2TWBTKgX5DeO3LAvyG8b1bWAFC/V3W22kf4w7jeO6ppASkK38htHdU0gqU6p/MZRZqKhxhaFZhrFPY3y20Zptk8qv21UyvZz5TeO6ppAUgOb8htH5ayVfuOorgkk9T0ov3G0aRzqe9B+22h2YNN+22jTNmQ3137jaPPlkEOg9ltH8wObRq5A1waK6r7abx3dNYGiPBXtN45mvxztN45mG0f7jaO7JlDkJKr91knvOJGp3zpp1wZKUa8y9Zsn7dpAkd5S6jdPapqH6pWp3zqpcdOozpb6jZOaxqE6W4o8NdM41HSb+o2TspNO6jdO2jWBJofU1G+ddMMOV6nfOlnXBprqa5nfOlnXBJrqa5nfOFnXAlpSTlPmN04muQfP/MbJuibQ1FCZ+Y2TGS+aGiozv3Gyrgk01S8y5Eh3TaCpfpH5jZOxX07mt03WNYCmOlDmN01umobqQLnfNHnXACm1+sn9pslZfyD3WyaXbE/L/abJuwZIqf6T+02Tdw2QUv0n95smT1kj/abJuwZIqZk2R6ucrgFS0r3J/bbJN+zAkvuNs7ljB6uN3zob0zpUn9z4rbNhW2fjt86ma4KU6rwbv3E2pnGozrvxG2djGofqkxu/cTZs42z8xtlk7NJg47fOJmeXBhu0DN2wM+gGr0S7NkjJCdz+Bst2zZBRn4/9CRZlm8j+BIt2TZGRj2V/g2W71sgEXRYtSe+6BsmoXm9/gkW7JsmoYdP+BIuyc5D9CRY10IBc6t6hlekd617bn0BRQwgycl08ggc8xcH0wDCCLCO7AeYHhhJk5DoaAwSDCTJqZE4wQTCcICc7F0YICfttJRgiGFaQU6NugjGCoQU5Ne4mGCQYXpCTXQuhhESwTl2CYEJimAHzIQhMe7o2yckei4BCYrBBTnZDRBQSww1ysm8hpJAYcJCT1AUxhUTwzYWoQmLgQZ6/1He3KkfdEIGFxOCDfEMTL9RgBiBsyM6F2EJiEMKG7DGILiQGImzIHoP4QmIwwobsMRLjua5RNmTTIsaQGJKwIZsWQYbEoAS6ERBlSCS/lE0QaEgMT6AXyAliDYlBChuydyHakBiosCF7F+INieI/MAQcEsMV6Kk2QcwhMWiBnmwThB0SQxfo6TZRGKkq1ulPEHxIDGLYkAMtog+JYQwbcqBF+CExlCG5Iz8GRCASHkEkiEEkBjVwLxe1maENzMtFJCLRgVERwYjEIIfkLiGnMcQjEkMdkjsahCMkkRjwkNzRLFxjGG6+tTtFm4FazgCI5I78iBGcSLRtOnJbI0GAIrGE4i6j3xxqPYMiaI6TIEyRGBrBdHdEKhLDIxiHDbGKxMIKugchWpGktvFy0mBELJLUNh49VSBqkaT8QJnirYzAQInQRWLZRbeVQxmMms5AiiQhJyEEMJKUx+YJQhiJIRVJQs5YiGIkBlYwHiECGUlmN5/I6Q2hjMSyjISc3xDNSDKW0yaIZyQGWySJpu1FDWfQRcJsLuFtKNtw5FyEyEZi0UaSv5TprdxsUGHUcAZisBajljMggx59EONIDMrg5CLOkVjQQe51JQh1JLndOCQnDgQ7EsM0EkH2YMQ7EoM1EkH2SoQ8Ess8BNnTEPVI8izQGoh8JIZvJOTWV4LYR2IIRyL0SyVvkwQ3B2o5AzkSkb5Uya3GzYEISGJARyLoMRtRkMTADppdJgiEJBvbdvlLqW+T0e4naryNbbwN+XwIiCSGeyTyji6Mms9SEZnQhVH7GfyRSLJfIDSSbHhHBbGRJABHEkRHhCEgtLcmEB0RBoEkkvxIBeIjwkAQeldAIEAi7gJtJxAhEXd2z57cihcIkYg723aaLoy2hu/YiAqBIIkwJITcqBQIkghDQsgNF4EgibCQRNI7xAiTCMNCEplRS0mBQImwoESS606BUImwkRb0C0aoRNhYC0mGEiBWIhJ2shOIlQgbbkG7dgLREmFpiaKGbYFwiUj4bX2ES0QScC8FAibChl4oMjxF4OgLi0yYwjgCw4ZgkFt7YhSEYVuOmjwEDsMwaKRLjU+VRS1n2EiiKBde4FAMYSNlKNdD4GAMC07oCUzggAwbkcEMPzgow/CRhNzFEzgsQ9i2o5ahAsETIW3Tkf0d0RNhEEmiyX6J8Imw8Rnk7ptA/ERIdrNMIH4iDCRJyL06gQCKsABF0+8XIRQhbZQT2XsQQhEGkyTkXpxACEUYTpKQ23ECMRRhQzY06cELRFGEpSg6J58OcRShkkC/RCBFKNt0ZJdAIEUYWJKQG3QCgRRhYzjIDTWBQIpQmucCAqEUYXhJQm7ACcRShGUp5NaaQCxFWJZCO4IC0RRhiAk9LSKYIgwwSVKyryGYImxcB7nHJhBMERamkLtnArEUYVkKuYEmEEoRFqWQe2gCkRRhSQrT0xBJEZakpGRPQyRF6MDaQCCSIixJITe+BAIpwsCSJCO7JQIpwgZ8ZGRPQyBFGFiSkNtZAoEUYWBJQu5nCQRShAUp5C6VQBxFWI5C7j0JhFGExSgZ2SMQRxGGlSTkjpJAHEVYjkJuKQmEUYTFKOSekkAYRaQ2OJRsN4RRhMUo5FaRQBhFGFSS5GS7IYwiLEYhd3UEwijCYhRyW0cgjCIsRiH3dQTiKMJyFHJjRyCMIixGycl2QxhFWIySk+2GMIqwGIXcrhGIoghLUcj9GoEgishtXC/ZboiiCEtRyB0bgSCKsBCF3LIRCKIIC1HIPRuBIIqwEIXcMREIoggLUcgtE4EgirAQhdxYEAiiCAtRyJ0FgRiKMJxEkDsLAjEUkdvtArLdEEIRhpKIO7LdEEERG7vHQ7YbAihiY6OyyXZDAEUYRiJITC8QPxEGkYg7st0QPhGGkIg7st0QPREGkIg7st0QPBF9WAnZbgieiD6whGw3RE+EpSckmhaInsg7u81DtZtE9EQaQCJIhCwRPJF3dm+OajeJ4Im8s/H0VLtJxE6kwSOCxMISoRNp6IggsbBE5EQaPCLIkwcSoRNp+IgggaxE7EQaQCJIICsRPJF3lnqRod6IncjEbvCQ7YbQiTR0RJBAViJyIg0dESRjlYicyMTuqZLthsiJTGzAMNluCJ1IQ0cEfXgAkRNp6Ihgzg+gdjN4RAiy3RA6kYaOCEm2GyIn0sARQYfoI3AiDRsRJDCViJtIw0YEGX4vETeR9vQKGYEvETeR9vwKGYQvETeR9gQLGQovETeR/RkWst0QN5H2FAsZ5y4RNpGGjAiS0ElETaQ9y0KSNImoibSnWcjYdImPs9jzLCTDkvhEiz3SQjIsiQ+1GDIiSIYlR+daTLuRDEvioy32bAvJsCQ+3GLIiCBJk8THW2zgCUmaJD7hYgNPSNIk8SEXac8gke2Gz7kYMCJI0iQRNJGGiwgSH0nETKSNPdFkuyFkIm3sCUmPJEIm0saekPRIImQiDRYRJD2SCJlIe/KFjOeWiJjI/uwL2W6ImEhDRQSJgyQiJtJAEUHiIImAibThJyQOkoiYSBt+QhIeiYiJNFREkIRHImIiDRURJImRiJhIQ0UESWIkIibSHoghSYxExERqe2KJbDcETKSBIoIkMRIBE6ltoBfZboiXSMNEBMlLJOIl0jARQfISiXiJtIEnJC+RiJdIw0QEyUsk4iXSMBFB8hKJeIk0TESQvEQiXiINExEkL5GIl0jDRATJSyTiJdLGnZC8RCJeIg0TESQvkYiXSMNEBMlLJOIl0oadkLxEIl4iDRMRJC+RiJfIzB7ZJNsN8RJpmIggeYlEvEQaJiJIXiIRL5GGiQiSl0jES6RhIoLkJRLxEmmYiCB5iUS8RBomIkheIhEvkYaJCJKXSMRLpGEiguQlEvESaZiIIHmJRLxEGiYiSF4iES+RhokIkpdIxEukYSKC5CUS8RKZ2zO3ZLshXiINExEkL5GIl0jDRATJSyTiJdIwEUHyEol4iTRMRJK8RCJeIg0TkSQvkYiXSMNEJMlLJOIl0jARSfISiXiJtAEnJC+RiJdIw0QkyUsk4iXSMBFJ8hKJeInc2NPSZLshXiINE5EkL5GIl0jDRCTJSyTiJXJjT02T7YZ4iTRMRJK8RCJeogwTkSQvUYiXKMNEJMlLFOIlyjARSfIShXiJMkxEkrxEIV6iDBORJC9RiJcow0QkyUsU4iXKMBFJ8hKFeIkyTEQmZGynQsBEGSgiBXlcTyFiou7s0VCq5RQiJiqxp97JlkPERNlgE3ofUCFkomywCR3GohAzUYaLSJLFKMRMlOEiUpAxygpBE2XAiCRhjELQRBkwIkkYoxA0UQaMSBLGKARNVGLbjuwUCJooG25Cx/MoRE2UpSZk6LNC1EQZMiJJyqMQNVGGjEiS8ihETZQhI5KkPApRE2XIiCQpj0LURBkyIukkC4iaKENGJJNnATWcISOSTrWAqIkyZETSCQ8QNVGGjEg6lQGiJsrGmtBbuAphEyVtsgmy9yBsomywCR3eqRA3UTbahPmaEThRUvHJMRA4UTbehI76U4icKBtvQkdsKoROlA04oSM2FWInykac0BGbCsETJW3zkZ8HzhPCn9tROFGI4vMdKJwrxIabMK8N5wsJHNxRo5Qhpu1I+Kdw1hAbb8L0IJw4xMabMD0I5w6xyUPoHoTTh/QBJ8yrQE2nNoEehACKsiEnTA9CBEXZmBOmByGEomw+ERKbKoRQlGYDvRQiKMrGnDCvAiEUpfl0SQohFGUTi9BdEyEUZREK3dsQQlEGk0gSCSuEUJQOhKMrxFBUGghHVwiiqDThexuCKCoNfXiIoigbdcL0NoRRlA07YXob4ijKxp0wvQ2BFGVgiSRhukIgRfHJRxTiKCoNfXgIpKiUD0dXCKQoC1LonolAigqc31EIpKjMfnXk1I9AijKwRJIbBQqBFJXZMZPOdYQazsASSW4UKARSVGbbjZzNEUhRWSDSSyGSojL72ZETGCIpytASSe4qKERSlD2+Q+4qKERSlKElUguy5RBKUXyiEoVIijK0hD5brRBJUYaW0GerFSIpytASSe5sKERSlKElktzZUIikKENLJLmzoRBJUXkgVRZqNnt4h47jVYikKEtSyB0ThUiKsiSF3DFRiKQoQ0uYtkAkRVmSQu6uKERSVH9yh54KEEpR9uQOMxUglqIsSyH3bRRiKcqylJReZiOYoixMSclof4VoirI0hdy5UYimaEtTyJ0bjWiKtjSF3LnRiKZoS1PInRuNaIq2NIXcudGIpmhLU8idG41oirY0hdy50YimaEtTyElcI5qibXYTel7WiKbou5yflzWiKdrSFHL/SCOaoi1NIfePNKIp2gATmZHdRyOaog0wkRl55FsjmqKTwLErjXCKtjiF3G7SiKZoS1PI7SaNaIpOAgfmNMIp2uIUcm9KI5yiLU7JUmoI0oin6MQmGCS7JsIpWtjGI7smwina4hR6oNCIp2jLU+iBQiOgoi1QycgZTCOioi1RIfe9NCIq2hIVct9LI6KiLVEh9700IiqaT6iqEVDR9vAOnbhAI6KiDTWh0ydoRFS0JSr0MQmNiIq2x3fog4YaIRVtkQqdPkEjpKItUqHTJ2iEVLQ9wkOfq9eIqWibajUnv1KEVLS0jUcmQ9MIqWgZSMygEVLRMnByTiOkoiWfmEEjpKIVn5hBI6aiFZ+YQSOmohWfmEEjpKJVIDGDRkxFq8CyXCOoolXgsKpGUEUr23p0nnAEVbSFKrTHrRFV0QacyJw8haoRVdE2Myu5O6xxblbNAjGNs7NapEIntNA4Q6tFKkxHxkladaj5cJ5WzWdj06NMrYGcKBpna7WBKXRHxglbDTlhOifO2aoDC3ON87ZarML0N4RVdHoX6G8Iq+g0sMLTiKtoy1WYcRZxFW3QiSQjDDTCKjq1sx7pkSGqog04kWSEgUZQRVuoQkYYaARVtCEnkoww0IiqaANOJBlhoBFU0TatKxlhoBFU0QacSDLCQCOoog04kWSEgUZQRfdJUUjwoBFV0ZaqkOEIGlEVzWdF0QiqaAtVNjn5dSCqoi1V2dCjCsIqOuP9FQRVtAEn6o6eohFV0YacKMYHQVhFG3TCFUZcRRt0wpmBuIrO+dwaGoEVndvM1mQnRmBFG3iiyHALjcCKNvBEkeEWGoEVbeCJIsMtNAIrOrcjJtmJEVjRuW07sl8isqJtTlgy3EIjsKJtVlgy3EIjsKINPFFkuIVGYEUbeKLIcAuNwIq2YIVZOiKyom2MCrN0RGRFb2xecrJHILCiDTxRZCCHRmBFbwIsUyOwog07UWTUh0ZcRW8CWwgagZX0LrCFkCKykt7xWwgpIivpXWALIUVoJb0LbCGkiK2kd4EthBTBlfQusIWQIrqS3tnmoz68FNGVlM8dmyK2kt7ZxiPzsSO0ktq8KNxrQ42X8GuEFLGVNLEfHpnrHaGV1NATOtE8AiupYSdkdpgUYZXUoBPyGHyKqEpqc6LQ2WFShFXSHquQYTUpwippH6VCuq4p4iqpTYtCh56kiKukfVoUyrVLEVdJDTtRZFBUirhKKmzDkSn1EVZJDTlR5CGyFFGV1IATRYZEpQiqpAacKDIkKkVQJTXgRJGBSymCKqmwVzlQw1qKoEpqyAmd3DpFVCU14ESRMU4pgiqpASeKjHFKEVRJDTdRZIxTiphKarCJImOcUoRUUmnbjWxjRFRSe2sNGYqUIqCS9kCFnGNSBFRSA00UGbeUIqCSykA2mxQBlVRmvOOaIqCSGmZC76akiKeklqfQ3DNFQCW1l9nQwYUpIiqpjVIh47JSRFRSFVgbpAippMq2Hvl1IKKSqsAGUIqISqoCG0ApIiqp4rcRUgRUUpsWhZmREFBJ+zAVeiJHQCW1YSrMRI6IStqHqdATOWIqqbbNR44rCKmkmt11TRFQSTUfYpQinpIaZsIMV4inpDoQHpYinpLqlGdWKQIqqQUqZGxfioBK2gMVurshoJL2cSp0d8N34RhmoiR9gx++D8deiEOGDab4RpyUX9ml+E6cNLAFlOJ7cdJA1sQU342TBrImpqP7cQKbQCm+Iye1zUfOIfianJTdNk/xPTmBMJUUEZU047MmpoiopDY/CvOKEVJJbZwK048RUkktUqGDvVPEVFIDThQZuZgiqJIabqLISMAUMZU0s/Fh5ASJkEpquIkiY75SxFRSy1TIyKUUIZXUIhUyuidFRCW1KVLopGEpIiqpJSpkKFCKgEpqoImiL5hCQCW1QIX59hFRSS1RoS+kQkQltUSFvpMKEZXUEhX6WipEVFJLVMhQoBQRldQSFTIUKEVEJe1v2SF7BCIqqSUqZBhOiohKugkkcEsRUkktUiFjdlKEVNI+zSw9HyCkkvbBKvR8gJBKas/90Bu6KWIqqU0zS6fRTRFUSTd8SG2KmEq6CWwgpAiqpJtASG2KoEp2FwipzRBUye4CIbUZoiqZTTVL3/WFoEp2x180hpBKdhfYeM0QUslsthRy9sgQUcnuUn7DI0NIJbsLeJoZgipZH7BC7uhkiKpkd/bbI28+Q1Als8lm6W6fIaqShc7/ZAirZPb8D92TMwRWsv78D9WTM0RWsiSw9ZohtpJZtkL35AyxlaxnK3RPRmwlswlnmZ6M2EqW2KGTvGMOoZUsYW9UyhBZyQTvrmSIrGQ2bQrdkRFZyUQAZ2YIrWQ2YIV2bTLEVjIRSPKcIbiSicC+eYboSmbpCn3pHqIrmQ1ZYXo9wiuZCGS/zBBfyWzKWabXI8CSyTu+1yPAksmAt5khwpL154DoXo8QS2aDVphejxhLZhkL0+sRY8ksYyEjLzPEWDLJXrWUIcKSSf40QoYAS2YgCvOFIMCSyQCNzhBgyewhIKYjI8CS2bSzTEdGhCWzMStk7pAMAZbMAhY6sixDhCUzEEWl5EZQhghLZiCKImNQMwRYMgNRFBmDmiHAkhmGolKSt2cIsGQqEOqXIcCSGYaiUtL3zhBgyQxDUWlGFkaAJbOAhYxZzRBgybRtPbLPI8KS2YuFyWjRDBGWzJ4DotMcZwixZBax0GuhDCGWzB4EIvOYZIiwZKHksxlCLJmhKIpMepIhwpLZu4aZjowIS2YJC9OREWHJLGFhOhxCLJlFLEyHQ4wl6y8epjscYiyZvXyY6XCIsWT2AmIyJjdDiCVLA3A6Q4glS0NOJ2IsWR+2QpLsDFGWzJAUmmRn+D5iG7fCvGV8J7EhKfTNrhm+ltiAFEXGJ2f4YuLMfnzk4gLfTWwZC5kOJ8PXE1vGQkYcZ/iGYstYyIjjbHRJsRk4yXQ4Gb6n2DIWMiw4w1cVW8ZChgVniLFkNmqFDAvOEGLJ8sBKPUOMJbOMJSc7PGIsmc1DywlGLWcZCx1CmCHIklnIQofCZYiyZIakkHvBGYIsmQEp5F5whhhLZo8D0XvBGYIsmT0QRO8FZ4iyZPY2H3p7N0OYJbOYhXZuEGXJLGUhcw5liLJkm1DbIcqSbWzbkV8SgiyZjVvJ6ekRQZZswzcdQizZhm86RFgyS1iYd4ZazgIWEvBmiK/kfdAKeWE1wiu5xSvkLJojupLbmBUysD1HdCU3CEWREZc5wiu5ISiKjLjMEV3J7wJZ8nOEV3IbsEJ/yznCK7khKMy3nCO8ktuYFbr35Aiv5AahkL0nR3QlNwCF7D05Yit5f5EP+S3niK3k9jQQHdeRI7aS9zf5kB9+juBKbuEKPf7kCK7kFq6QPT5HbCU3+ESRsbU5Qit5EvAyc4RWcpuSltx6zBFayRO+6RBayQXfdIis5PYsEPkx54is5DZmhQwbzhFYyQWLNHOEVXIbskJGGOeIquQiEFmbI6qSi0BkbY6wSs6fBMoRVMlFILI2R1AlF4HI2hxBldweBaJd3BxRldyGrZDR1jmCKrkNWyGjrXPEVHIbtkJGW+cIqeTSth01zeWIqOSWqJD53HJEVHJpvzhyzEZIJTfYRJP53HKEVHKLVMh8bjlCKrmhJpoMMM4RUckNNNFkgHGOgEpumIkmA4xzxFNyw0w0GWCcI56SG2SiyQDjHOGU3N6HTAYY54im5IaYaDLAOEc0JTfERJMBxjmiKbkBJpoMMM4RTMkNL9FkgHGOWEpucIkmw4BzhFJyQ0s0GQacI5KSG1qiycjeHJGU3NASTcan5oik5IaWaDLoNEckJTewRJOxoTkCKXnoFp+8Byn/eHlTVp+Kpi32b6t98eXmmz/+uPnnP9vnY3Hz8j83/yztfyYvjcybb/5zk9x885//eXkj3J+Z/VOK/s+N/VOp/s/c/qn78rr/d3rX/9nXz2T/Z/973svLU/vnpv/3pv93cifcXzL3l151kiTuL66wuHN/cf8jdf8X5X5ylnb3Ddu/ZP0zdHdZ9g+t3F96pd3dZv3z9nK6JDj2L+7RlHuWLimCfQnurXVHzOxfnK7uGEf/gtxfdF+9Cw6x7+jOvaxk495e6l6bdH8x1f/npWty86+uC2x3bVlXJ9i8WQ7aN5GBip+Ktqi2Vbt7LHYfm+J0PrReP0kUkJSxkoqT0OmubWDdLqfHULdL5TFRd1/smuejp77LjwJETKovKkKEgiIEJ+LwUDdl+/gE6+bwNYqh9V1/cF24C460rZayD3k41J+3h4N92Q/b1v8akwy+Zbahj8ei2nsV72A790ZsWCNOu6Lal9UDFNFBp0FGxr/iti1O7bbrab7lAlp+N137VD5UReP11u683yCkO1VqP5w0LA0LyUA7d+f/mbrn9rGo2nI3agIJH4TtJqD6vjjtmvLY1s2u3D+Vp6dtu3v0ZGZAZne72LTMf30+PZWnE2qj7m4zIIh9LxdBZV091U3RPm6ruiq6d75tz01R1e3pfDzW3fTgK1BQQejpa+8b77b1Lq9t4+YIN3p1Gc/6sbP/aPQwCroxL3XjdBfcZ/+ycaNgot1wGDap/PeoZwrQp0TurHCThftLmsbItf+o6rb+XBX+88OvR6Ts1wOlVXX70Gyrtti3NfFGsxRKVBMSvU7chW4OddNghzN17V/2xaHAI1KXxeHyNYlJKygZ3cYz6BuJa9zUNW4/fHY70RPizXun7UygndxX/2F7KlJ1bg5t/eG5LfyBQ8JpSnAdDYioP/yr2PmTjEygDK4bfDjUu4+ntm78VoPDX0d27Xx/x00DH87lYf/nuWie6+No5u9Q1yCsI1wBGe32wdTy30cX13fpRDn7Srv32NbDa/Ffh4CvgzWiF1E+lFXrz0lg4MzSCROo5oBzvuC+8b7+qW3QeNtlegX1Of270h9EEzgW5lxH2h2Krf/FQxdLO3/U+RaDR7gZ5nfnUbOT3O5Qn7wuBg3rHVTpPFbn+N45n9iN2alzjrt9gV515lTfOa+Um4x29d4fDTLQMYVdNZDVno7bpkCvtjuRe/nMc65B+8pPxem0fSja8qlzOp6OniTosHSHSHlJ5xabkQjob+XcZ36p3L2EHT/pZnCknzbl6Xxoy8ft6ZGXmEOJodd0bov99uH4YVfu75v6aTQqJgI6duwoQIg6tU2xffJlQd8q0HrVfen7prmCI6NyI2NYwtkfXiV8EpXw/bU6tc151xJDYhcvC2YZ57gEek8v62PxvC+a8pOZ94/b9tEfaEFv6iLe5wo7d37ifttu7+vmadueTrvH4smfWlQCVQTeW0jFsanbelcfdnXVFl9aSo2EavhvO0pN9x+UDgF1cJPjhA4jd0u+KQXFcx7JIB45bQlcKTrkkbhxUzhK0d3qbf+i3UDvxt8u1bb9SzaMzP0coN2w250b7P+SOufZzRPD9OAEZqlztHL3k1u5dpub/afkvA3HP3Id6Idd6+M5D5KkNNDyHZO6Lw+t7z93BwOAs8F20KYYOZfATU42d+79Ok/frYbVhee4NYkjVWrTP3x32L5/m+5/tJsD3ZImG5bXgn1IYySzUO4SKF6GkDt2FLIyuEVNl20CzIPsR2Ck7Mn1fqLgrDPxMPtujUvJgPMM6773Msp9U5zqw7l7mDFh6jjpxWHV7JxqZHXzi4+YQPdRm3D36SoTHnOXVgrQh/DDmIWb1yJwkZPKcLvW9/enoqX9EriQyfjxx8hpij/PxQnZAV5jOtEkTfGp3o07l4COv+RWj1bEgBT87glfZR7uWxYEeS2xgb07mzYAI6AN9BJZGOXVpx6jS2AKvtWwHUxr3sHWZF/EuTnVaDwETdCPOG5wU27y6DKi0wI7Z8Dv2/BJ3KShNbc26epjnxcOOYmbXLTkxp6LP+JLgRPkAIOU+wv73QP3xpOXwtWECtU+IUiSwE6a6GEnYFh5OaYvuWYzUvEqHn5+vSTWTx0EPBQtwdyhXyiSSSGH4lNx8HsfXD6zC9FBwPFMWSE30IrgGx57/NDvFG4JK9jF4n7bFv1s4X/Q0O3unSo3NWvJDXKdtOP5w6E8PRZoGQm/hl5e6rws50ppHejbxalu0HuCkPfO+Xfsbs2+6BaFx8O2rCy4OG6fD/UWPTd0FlivitgwUfCVpRlHXvbFfVmVeAJIPUzgfCIxbFvx0iyY249mx+6UAXg52r1p9xfXlpmDD5lwxFdxw26nDfmCErojg+eXDBzDCXcjac53ZyO8+FRU7enDMx4K4TJ2WIyynxe78Es0pO2S/cAHAePlSpd4HYjoX1qXdz0gq9h2npzpc93Xset3y8q6+lg8+wwQArw00BSd1N1jedgfja3Fx+LZB3nQq+GnLSPHyfjX54/+o8KxhN0I8GUgOxIN+yE/dxkZnAjoN7td8e4sd7/s4tZNvVDzxkcyYcdVgyj+Q6N38CAlYbeuLttV3jYJ3G1wmzVuv9wxwoTd19wX7bb0Jp8E+vMJixz2CPDBES9nifG+3D8V7WO95wkYnLVStqFLI2EEfhPotwl+4DXVP20PaHyAPrzg3xlcEN1vywN6hBxu9rFerJPyyfehYV2u5vl4sBuYzNwNuwQLv/ef/Y1guL4Vin3xn6sx5gPvnH1aU+/U4vklhR8l70R220cNQjZwthP80NRXHeNs2NaabevPVVm1RXO/3RWmNJzl4Zei2K2a/eeq7/O4voCbTnecCcWuLE6nYncUOv2Y+KtnKCDn3r0vgIzSAK2gWJDpyyFDNeALYZ2XYi+0TjZlZT5APFtA31ewa8jiqfRVgz7oZtNcsLWrrjvs8WoLvk72u7V1/XUv3ERXIa39dO2F+sDVjNs1SjLnBPFvYJBGhr5ICOYUu4K9SCmr49l/pRpyd8cgtXIrSHZ7+iLz2NTHomm9ORPSmoQdnXoZp+enp6JtkKvjo33IDBJu3Cr+PG8PY3wJHTm+v+KhB74Yvn06H7Trpl2gy2iQ7mLXL/Mlu0YcC+mCGI4FMRxCUiBYJ8IIPNTe8A0axEHkidrEihV8+dkmqN1HPjBySt2x3cFUfCjQLjHwvhTLu4a6/bai78BBqjElgIKPcL2m2BXtIKIpjgffhfS8rWB1EzLgf+Mw8kGx/fdSm3oF8HsMNvyJi1mQkBYoFk4BIePXAPFS+C2ezh86R/iDP5fC3SXF7k4jCbRLDcMAWOKBJNl/mi/0XJVPx0PRlcaOIVzEsJF6SDLRZMIL9ooTQzYbjJJgd5uRoFHTQYDO8nPwfrxxAxhghx4Zfi3WCvMsj9tqf0DOM+hF/Hjwpdid2+JcHbo3+2G0BJEwalSzIWHFl7bZ7lq0Dupy7YPKXE++L9rd43gvAnoxKfsmTGWDf7aHptjVzf70uSlRXFUKH4IdV4kZEaJH54242HExQKXMrXVdIHfG0laro6x2h/O+OA1cr7fce344saYsC/EFnquwSLizveG6pxXp1YQxDw5qKbfrq1j3EO9wQULA7grRERxwL0GwMWlmV2wUQZXAwGvBrscfOk9ie/jX59Onoinvy6J5KNoBdVR1e1+fUcQynOkF6zONBffuPrlhk0CnULALECs0sL2q4S5FrmbJIQ3rDs4AgdwQ6QTuy/3H4vlYNKe6QisL8IA5y4ecHNLd6Q4oAVu44c2XMfIZNIzEyhU3V/tSyClXw42lnN3CcZK6fsqNVt1ZsYsoFu85Ud073pb+vhsECZk7xJGx4bdIVLP97EuDX62eetX9FD1uMNjorHvmpBDdRsEN0ZxFp4OEPgCnXywNA+LofXfn+IDcqW7t5J7I+CwFd31zdtYaCRt1ze7UIhA09b76hxtvJ3Sn/sB750ZqJIf4UuASjZ3ekBjmUxFQFDcNIFFEs8HhTQaHt3JHOI5wNyf8wQ7VR+6e9BgPKwNtI8Hx3cWeqkuM7BDp1BPsPOG/uZY+PgIHAM3CuK76KGS/u0gVRKHwzdOOwlqht8cGWXYVz01TVEzoCGTeGRsZ99Cd9GqbZ+Rwwo105QLNNAuhOimjVbgXBObO+bFxE11krvU+CbcT0hh2a+2haD9ivxlu7bKxtA9FWxWfixO1lldw8tes99it4w97TgTcsGa9xc5H2nbN2YfUGRfsnoyvUxCJpuxW/uB1IRqqYNB1xvJx6LT58xjsWezC/KFox8E8Co6iOg98ULbuaCEED3awi8vRGkhCv1ux+7ymnue/2SM5X45lg1fdcI+O3c9iBFKHuXLIB/jPlRZY1e1z0dqTmz508M47zXzuLiDsI3pu+EUJFgCPBQ77HeSRONisgl3QjKXaLRBaJNzzYncxxiIv57Duu0V8hfeW4JakyNnRLCCXPN8FV/iC/6I7CaOIcdi5UxZ+P+5H+8xw0cW6IqaeH7bQr7r8B4DC2A8bjWPw1AX3DdmyHhb2Vr/DySjuAUy13mQbW9dF61C7CAn0YAUbSDsW+Gl7OBej0/TQsRJsFDOUBg0rq6fiqfa9RwGXNIINpTSl+0HG/H374VBQDyygNyrY2a2fmPue/KnAge5w7EqGY5V8J+DmeW+QZiv3A4n/HJBLWP3Oa0lcgGTCRvGWJ3jo3fdhIMvPhpQBLgcBOwCUp+LYhec028PH4rk7ENN025z+bAYDphU7iZQn3jGCiNydANPsacXy1Pk5/oQMD4vrDf84nXuDasK5mN2d6XrhQ1XsPzwHzpXCbXPtQrX0hpuvLjL5I6DwcLROhjMTbJ88ndpt054+l+0jdSABxnOzHftfn1EMOXT8WGrwr88nLvyPGGgFXPUJ1pt0jOx5IFDnaoiN2TWf/IEKLqTYBQfeI4UQVIVqhUPW4JDLkqOPxTO90Q39kYQNcPeqE3vScAXLDvtjIX5rw21fxQ73Hwu81oLThHZDTCqHAztDqpTAK37qFvjl1j9vC5tVsztDBPeScB7U2ZB0hHumQ4kCJyAndpG07OzytPWmdxjolLB7h0/bLy6M22TR6NyqD0UfguFvhcJZmIWkFNeA63e3ReEGfpflQ7nDV8qFMCgXoa/vXGS9ywyTukDg1B07StPhpJZr78Qdx2K3vXpbETaAeVWGPsM1+kWEv7EBN45T1qPqa5slv7/vDnbKJiqb9b51ofAABz1sdkZyeNTXDydUNtCeIasKHrnWmwn7mb1/b6KY6GzM7r+CPkca8xQjnOYd1ueGDSzAcCCfDAIpU2agAHjp7RRO1MWnJiDu6T+PhJsZoAwiggQi6buJr8HIIBsEvk52895JAbvJvhTwVBNtQhI9eGJZuDxS/Z8uN0qihgMMLuGV+0m5n9RwuNSNZtoNb1q7ccnh1NSdiEjTISrfBeO75GAZu7di1+feQ3hh273x7mSsGk5zsO+49N4pDK1N2ECXp7Iqn7aH06EoECKFC0nW/666g0aH8t8F4RdCbp0Oyc7YYdc6d2S6EeiCsMdE6qo7LTjeXoepQriu1QV4ee/uUqdvWTkcUXKHO4a5yOVny1yelvxugOrcvD5KiyMhONRsaKqpN7it1EEYyC81e3bfl0McLIT5RHTCDdbHLh/K+FgkrOtOMrFo+iJjfLgPonZ2OemRYeQ/wthWze7fWAn4FB9c3bIE5rht/MQhCUyjlLjtFeWSAyo1RDa4n9yBae1Go9RFf6RDqkB3/DxLhjAQ7jswFo3ScMDBgF2juarBJBwCbsEIdm3rZE2m4BDwRQt2XWvkkcd4PX+a80yORWOgT91Fxe/L0TwGt1FYv+oixMBG3NfgWdwhRdcwa7jYnowNLLmIP+1qn5fBvTZ2nQ7quz1f/01BL5gFIYQU44p2J/lMLohzVXw5Frtht9tvTO90zAxLLzrqYzF8zMemfiw/lG13TMkgutKfGwTc8RdsepEpffbBppXB5RJ7dp4MK4Db0fyrJ49zKQgitcNr2p2jytmV/UUcMasq2OMzNayo2b4/nPEidq7g4iblh1kk4lx17LXtVqXnXUEG1Qu4Pyg27JgXlDzCCgKCPcGuZsZSL5To3Pi7SQISP8HuaF9EtjVuZngeKGNDqY5NvStOJyquGB7CF6ybSA0NkDEmLs1g4nzYZMhcG+hqVqifBHDXb+70FMJ/X+CLkGx2j4Dc5nwoTlTAnICnTiW7qU6KHk56NfWhiwopjyVax4vEi74NNNNYelnt6qYpdrSzIuDaVrILsrBkOpmAgMt3ybtiQdEw25AvPIXC2TGfFm73dsz46wuFkcXsQj8kFO85CRhmLtlkgaRIs4daVg99t6ibPdnz4AwrWUTEaPjSATuKakPnTbJLA1pqWbFS4QfILhQYqWb7jO7FcMdVslFFIbnmy/b5k4AR+JIFHqTUbgDq2s2XB/ssv76h5NnVQhfLPv1pQOdUsrEVATWum4Fkaw/bamd4zO5x6y/5hXcygE12SKvr/5Pu116Y/6yP0UT5dTtH9bkdtwL8IllGQcrtZLn+Qo7T3gFFlpWjTG3+fAqndDaa1EmgM0TA5XgyOReN8h5A1y9xCT3EkA2CxeBOIH7jCczzKe7cylO6Cd4h98zx+czRtIwN6xx0jT9bmJk3mRxjEK+G57wG6jJpBRMyC/fPUzYScyyEPrAE9034RcdYmPMutl2UQFlRA523T8Dyo4DsrskZ0XDEZ1HtWHQ/e1i3y0b/9h/0OMucgNRPsscgJpT0H3Z974uGc0BgERUUXd8zDimkjJJfo4eln4/dmjLwduAAzW5askqGka6+t/p84XCUZjckeeG2y1j3ZuQ8wWOXkodPnHCcU0rAD1KywbNjecTCBx7ETWb0C2o7A/axlD2HMJZlpjmmZ8FDo5InVCOZvaNZnLpJf18c28fiy64o9lg8HDEmV2hAfH0o9rVZQxVfyi4D40P5qRjl3hEwEk1OzjgX+efqkuzcFwibnj01GDi2AD/VlM095QsY7wxANpxMj7TccV54xjSZHjfYNOTw603ZPCy+nNHmJmSQyfToa4Tw7QTHW/YsjBPWjRj+lSrwxfCLIRNGPdpDSMGD8EyYjOCGcYDaZZbVLp1Czn+AThpJy7y8BezYSsWES5gHSfFw2dVFWBlGoio2pmmoTXAlmDzBbS1k7J0YZB44GDGWOLcxGaI5XBihZmNIBqlMilWI+fgxxglhkqzCMA/BDyxndFQGImu3dZcOF2m4G4tydpU4ThMAV6vKJT5Lh4zB7PrVSCJOi8C3PyQi5t4SN8LAfsCGpPXDSpfbcBzzADd0uW+y2VZ74myths+Qs9GmtvbuQ92cHrfdDUUojgeivZxFnFYKuiJBQwaWs1O7rXvZGh1lvNIQHufsgaxeDlEdHnJT3GBkq5OxDhpywpw9Y9Jsq4di14XFNvjQLjy5GbD/gdjVh6MRGxXQFGhTGmIQxXIJch2fwJjOxEVcaHYUt04TzrkNV+HuUjLtwtMyllkS59slZHzKZWFM2RDCXoQf4GvzPnbJBffG9Soq+vCHgMGCkj3pGdDBXLQk4Lcs2ZOfAcGXAxvV3o8moPXBhQ+7QxTQ1/nWfNpMAaO6JHu+djjBakJVq9ph3Uv4ane0BdMvODlJNp6HPR2rYPBrym6Ye/U91DXOeCfgTCfZcEJPJOG6wqNFCTvrelIoz9ULsWE3FwYxfsbI4KYa3BKT/JBtJY/PFQ1b/cDJvGzy+i8UamIPWMzS1C0K8dk4AfuCZEO6WT22EcBa60h/brBJJIu7WDXWhWiGo9URCuF4wrJSVqG/609rgCMIuz0a1tBzJWoLVMC8IZL18MPyq7olpgwB4/gl7zEERTubyXcD46Qk71NEKejW/7QSyBl4Dy6ohNjog26p5F06K9bBtn4HxD9AUTw84U0AuGyTvKtkhXsHZqKnaBhHIdkDw7wKboaGK2DJrqt4uTMnaBhhJNkYXF7dxPwMiblko+l68WhTBp+RCW4/wjhKybIhpKjr84wWcqzIvOSXE9/baHmYwOVhwp5UhNX7+ziMOz6sgru4cmpnF2bVlGzuCyjeCh620+y8xQRBwVgRyaZxhdIpz8Nb0U5Mt9yCNoEbGgkbHASlmCjC2NcIByZ23wlKH+E4eCA6YQnaSMRo5Q1PQCdTywC8+lLemo2NHwC1p7xPGBws2YgxIJDqAZAOTi1AOhmk5wlXsuweLxAybiEITKccaSuhPTdVYeNaj2g/G2IyyRI2l7jG3qzFjDvETAl3UyV7gCaUFkd5ydHYLSIsgt4EhUfokqlhZlbeRgHzs0v2cl0setYoBmdtHmYhDVQ/hnk0p9zSUHJIBb3EbGqJzGeHhOcTkyk/dnxsGvYQxZJ3WB3c39UdQH9oyvZ58qZnAc+XSPYE1ZSeftzuD0KQx/hhrh/J7qtMKaLuhvbVQP+JPVfmqZkYZWFmfclm1ocS3S1m7XZb7fubiZ7O7Xl7ODwXX3aH8wnlQBHwQKlkUyzSOnadH753J02dHpMlcqwHzhhsBuexHjcYjkKOBTzeJNm0n2OJQzBRtfdWPGHz4XjEpnqGytzbp7o+3DGUU+BwkGZeMikOTgtsfkhPHJ2FF26cJVPLVCPokiHrXJn4p2I/zt8iYK5JyZ7BQnJhXgcyJg1mOpEBFH2RWj49nVuY7mP32EFuJBYOFzwdB2KpUGwYtp64W9r1FMGy4myX75q8rI5N8amsz/7cBbGdZDMCMTLHKYEF9FIle8yKkAey+nOmwvGFzTREiCaXXdANlmwiIEIa4UxB/1OyhxIpWeOxCCZakGziJyiLvFURZuWY8s2slG4Zvq32NjcLOThA/1ayB7+gUDO9+Sv8c/Wxqj9XxKcNfUDJbioy4gNi4bfNpouAYt1xnmHCBpM4/WLgd87mtQiqCPJKCUdTObXIn1BQ1W1ZofsXqcOfd16SgZiRYaQTXCxHPxb8otlwhKCKS6YQZoaUMM2BZCMmgkrcPiAX3SLhMUYZ2JUZnTiUMHZcsdHQfc1xRjKYcpsN0blcODoWALeTAuNEl6DOtxvGobDR1jhkGPrPCRsD0dR1O4pdSSBCEewifzw6J7ADJHoIU+ZaqV9KeyJSLyUA95pszb731M12b7dxtgfnI9AxfRIeWpXsMglJ75x8fHMqPDAp2QOTSJD9J+UWSXggUrKxyUjeueo+oPP2cvSRfW44MrNHIMnLkxTcpcjYva+hrs2HPuJyEvpWkqV+vZjGNwECmowFt0NdzgQYTyDZ84Onx/p8GFYZwzDkL/rhyUl2lugGfc8AiIK0u60xdXfsZe70cTbE87NrOzOf+OeEYeR9yobmgoncNw1mVmLDKgkvw5cCc6SwseqhyTCBB0ASlwpRudxRyqUsV4N7PgRzuAC3VLlosNRFg7n7GLIhgzKLY8eOYgLP0STuTL9wBy7VcCulGrIFuISBbgxUrkWVy2OkXUSYVsM6Y3iQIbnSkFpguJvUZY9xVwun7gas1OUcye6GvEsuUsYlEMzkkN/E9TkXVpOzgQQ4BhwCjoSNCiJSk3jxS2y9umn3ZXc6C4eWwjgw96gsk+DyYcLQBNZ97BxQf0UkvVhQtloXNdbWH7anIlXnxk9d5uUDZ+OgBhnjdCrQBDZe3J42Q7MV5LIJeyiTRM/eUS/Xmd1dJjnL7mHGoHFmdBhmyc0n7fbBdwyg45fo4SjVcLE216HsKms0UoHHshISdp3brUi6xXKfdh5dZA5Xtzm7J9aFBPpfA9zdYfHPEElI7HRJGJIo2bPrbe0FAnrZo9gqxCUr0C9jZ5e2/tfJ/2wTeDIqcbl2lBxGSHeBnxurtRuiU5eVKXVjfpq60dtlnctccG7GuqltTd36AhOysWdPxrHx0L9lD5GfD+X+3pwVQxnM4ADI+oznymSBpi8VUPAYe8oe0z03pb/2gO4Ke9jh3BzAcVKXI6ojb363g0ky2bORtDDkliZePkKuO56bw+A581bBWFX2FD4lCtsERyc2LM4tXEFIS0fVTYB7O8ouPV4rKy+fJEvvnBo/RKMp7guT+mh7GBbOvnvqJU7kpjknvPtkx4s5BZGBZlGbEzLKqA/vCHV52jI28MCJ6Ts++VgJjK0RbFiQn/bG/w6gi8wuSwcBIJp8PKmqxMuXxc2qThiRiBmGIAkWMg8CyCsxIH3M2AG9WyX6iYm8aHaulsm267cqnLXU4EOyncNIMHeKlu1zfY9RPtrelVC8Zj9ilAXYkwDJtWa3Dcf7p9DFV7Rb84+XN8fyWBzKqrj55o9//M///F+xTFP9vt4CAA=="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 000000000..778b94927 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1412 @@ +: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 */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +.tsd-generator { + margin: 0 1em; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +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..833165f18 --- /dev/null +++ b/classes/AllowAllTenantGate.html @@ -0,0 +1,5 @@ +AllowAllTenantGate | DWN-SDK Documentation - v0.2.23

Class AllowAllTenantGate

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

+

Implements

Constructors

constructor +

Methods

isActiveTenant +

Constructors

constructor

Methods

isActiveTenant

Settings

Member Visibility

Theme

On This Page

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

Class Cid

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

+

Constructors

constructor +

Methods

computeCid +computeDagPbCidFromBytes +computeDagPbCidFromStream +parseCid +

Constructors

constructor

Methods

Static computeCid

  • computeCid(payload, codecCode?, multihashCode?): Promise<string>

  • 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

    +

Static computeDagPbCidFromBytes

  • computeDagPbCidFromBytes(content): Promise<string>

  • Parameters

    • content: Uint8Array

    Returns Promise<string>

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

    +

Static computeDagPbCidFromStream

  • computeDagPbCidFromStream(dataStream): Promise<string>

  • Parameters

    • dataStream: Readable

    Returns Promise<string>

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

    +

Static parseCid

  • parseCid(str): CID<unknown, number, number, Version>

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

    +

    Parameters

    • str: string

    Returns CID<unknown, number, number, Version>

Settings

Member Visibility

Theme

On This Page

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

Class DataStoreLevel

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

constructor +

Properties

blockstore +config +

Methods

clear +close +delete +get +open +put +

Constructors

constructor

Properties

blockstore

blockstore: BlockstoreLevel

config

config: DataStoreLevelConfig

Methods

clear

close

delete

  • delete(tenant, recordId, dataCid): 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>

get

  • get(tenant, recordId, dataCid): Promise<undefined | DataStoreGetResult>

  • 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.

    +

open

put

Settings

Member Visibility

Theme

On This Page

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

Class DataStream

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

+

Constructors

constructor +

Methods

duplicateDataStream +fromBytes +fromObject +toBytes +toObject +

Constructors

constructor

Methods

Static duplicateDataStream

  • duplicateDataStream(dataStream, count): Readable[]

  • 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[]

Static fromBytes

  • fromBytes(bytes): Readable

  • Creates a readable stream from the bytes given.

    +

    Parameters

    • bytes: Uint8Array

    Returns Readable

Static fromObject

  • fromObject(object): Readable

  • Creates a readable stream from the object given.

    +

    Parameters

    • object: Record<string, any>

    Returns Readable

Static toBytes

  • toBytes(readableStream): Promise<Uint8Array>

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

    +

    Parameters

    • readableStream: Readable

    Returns Promise<Uint8Array>

Static toObject

  • toObject(readableStream): Promise<object>

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

    +

    Parameters

    • readableStream: Readable

    Returns Promise<object>

Settings

Member Visibility

Theme

On This Page

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

Class Dwn

Methods

close +processMessage +validateMessageIntegrity +validateTenant +create +

Methods

close

processMessage

validateMessageIntegrity

  • validateMessageIntegrity(rawMessage): Promise<undefined | GenericMessageReply>

  • Validates structure of DWN message

    +

    Parameters

    • rawMessage: any

    Returns Promise<undefined | GenericMessageReply>

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

    +

validateTenant

  • validateTenant(tenant): Promise<undefined | GenericMessageReply>

  • 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.

    +

Static create

Settings

Member Visibility

Theme

On This Page

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

Class DwnConstant

Constructors

constructor +

Properties

maxDataSizeAllowedToBeEncoded +

Constructors

constructor

Properties

Static Readonly maxDataSizeAllowedToBeEncoded

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.

+

Settings

Member Visibility

Theme

On This Page

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

Class DwnError

A class that represents a DWN error.

+

Hierarchy

  • Error
    • DwnError

Constructors

constructor +

Properties

code +

Constructors

constructor

Properties

code

code: string

Settings

Member Visibility

Theme

On This Page

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

Class Encoder

Utility class for encoding/converting data into various formats.

+

Constructors

constructor +

Methods

base64UrlToBytes +base64UrlToObject +bytesToBase64Url +bytesToObject +bytesToString +objectToBytes +stringToBase64Url +stringToBytes +

Constructors

constructor

Methods

Static base64UrlToBytes

  • base64UrlToBytes(base64urlString): Uint8Array

  • Parameters

    • base64urlString: string

    Returns Uint8Array

Static base64UrlToObject

  • base64UrlToObject(base64urlString): any

  • Parameters

    • base64urlString: string

    Returns any

Static bytesToBase64Url

Static bytesToObject

Static bytesToString

Static objectToBytes

  • objectToBytes(obj): Uint8Array

  • Parameters

    • obj: Record<string, any>

    Returns Uint8Array

Static stringToBase64Url

Static stringToBytes

Settings

Member Visibility

Theme

On This Page

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

Class Encryption

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

+

Constructors

constructor +

Accessors

isEphemeralKeyCompressed +

Methods

aes256CtrDecrypt +aes256CtrEncrypt +eciesSecp256k1Decrypt +eciesSecp256k1Encrypt +

Constructors

constructor

Accessors

Static isEphemeralKeyCompressed

Methods

Static aes256CtrDecrypt

  • aes256CtrDecrypt(key, initializationVector, cipherStream): Promise<Readable>

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

    +

    Parameters

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

    Returns Promise<Readable>

Static aes256CtrEncrypt

  • aes256CtrEncrypt(key, initializationVector, plaintextStream): Promise<Readable>

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

    +

    Parameters

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

    Returns Promise<Readable>

Static eciesSecp256k1Decrypt

  • eciesSecp256k1Decrypt(input): Promise<Uint8Array>

  • 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>

Static eciesSecp256k1Encrypt

  • eciesSecp256k1Encrypt(publicKeyBytes, plaintext): Promise<EciesEncryptionOutput>

  • 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>

Settings

Member Visibility

Theme

On This Page

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

Class EventEmitterStream

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

+

Implements

Constructors

constructor +

Methods

close +emit +open +subscribe +

Constructors

constructor

Methods

close

emit

open

subscribe

Settings

Member Visibility

Theme

On This Page

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

Class EventLogLevel

Implements

Constructors

constructor +

Properties

index +ulidFactory +

Methods

append +clear +close +deleteEventsByCid +getEvents +open +queryEvents +

Constructors

constructor

Properties

index

index: IndexLevel

ulidFactory

ulidFactory: ULIDFactory

Methods

append

  • append(tenant, messageCid, indexes): Promise<void>

  • 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>

clear

close

deleteEventsByCid

  • deleteEventsByCid(tenant, messageCids): 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

    +

getEvents

  • getEvents(tenant, cursor?): Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>

  • 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[];
    }>

open

queryEvents

  • queryEvents(tenant, filters, cursor?): 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[];
    }>

Settings

Member Visibility

Theme

On This Page

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

Class EventsGet

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

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

Class EventsQuery

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

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

Class EventsSubscribe

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

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

Class HdKey

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

+

Constructors

constructor +

Methods

derivePrivateKey +derivePublicKey +

Constructors

constructor

Methods

Static derivePrivateKey

Static derivePublicKey

  • derivePublicKey(ancestorKey, subDerivationPath): Promise<PublicJwk>

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

    +

    Parameters

    Returns Promise<PublicJwk>

Settings

Member Visibility

Theme

On This Page

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

Class Jws

Utility class for JWS related operations.

+

Constructors

constructor +

Methods

createSigner +createSigners +decodePlainObjectPayload +extractDid +getKid +getSignerDid +verifySignature +

Constructors

constructor

Methods

Static createSigner

Static createSigners

Static decodePlainObjectPayload

  • decodePlainObjectPayload(jws): any

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

    +

    Parameters

    • jws: GeneralJws

    Returns any

Static extractDid

  • extractDid(kid): string

  • Extracts the DID from the given kid string.

    +

    Parameters

    • kid: string

    Returns string

Static getKid

  • getKid(signatureEntry): string

  • Gets the kid from a general JWS signature entry.

    +

    Parameters

    • signatureEntry: SignatureEntry

    Returns string

Static getSignerDid

  • getSignerDid(signatureEntry): string

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

    +

    Parameters

    • signatureEntry: SignatureEntry

    Returns string

Static verifySignature

  • verifySignature(base64UrlPayload, signatureEntry, jwkPublic): Promise<boolean>

  • Verifies the signature against the given payload.

    +

    Parameters

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

    Returns Promise<boolean>

    true if signature is valid; false otherwise

    +

Settings

Member Visibility

Theme

On This Page

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

Class Message

A class containing utility methods for working with DWN messages.

+

Constructors

constructor +

Methods

compareCid +compareMessageTimestamp +createAuthorization +createSignature +getCid +getNewestMessage +getOldestMessage +getSigner +isNewer +isOlder +isSignedByAuthorDelegate +isSignedByOwnerDelegate +validateJsonSchema +validateSignatureStructure +

Constructors

constructor

Methods

Static compareCid

  • compareCid(a, b): Promise<number>

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

    +

    Parameters

    Returns Promise<number>

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

    +

Static compareMessageTimestamp

  • compareMessageTimestamp(a, b): Promise<number>

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

    +

    Parameters

    Returns Promise<number>

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

    +

Static createAuthorization

  • createAuthorization(input): Promise<AuthorizationModel>

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

    +

    Parameters

    • input: {
          delegatedGrant?: RecordsWriteMessage;
          descriptor: Descriptor;
          permissionGrantId?: string;
          protocolRole?: string;
          signer: Signer;
      }
      • Optional delegatedGrant?: RecordsWriteMessage
      • descriptor: Descriptor
      • Optional permissionGrantId?: string
      • Optional protocolRole?: string
      • signer: Signer

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    +

Static createSignature

  • createSignature(descriptor, signer, additionalPayloadProperties?): Promise<GeneralJws>

  • 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;
          permissionGrantId?: string;
          protocolRole?: string;
      }
      • Optional delegatedGrantId?: string
      • Optional permissionGrantId?: string
      • Optional protocolRole?: string

    Returns Promise<GeneralJws>

Static getCid

Static getNewestMessage

Static getOldestMessage

Static getSigner

  • getSigner(message): undefined | string

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

    +

    Parameters

    Returns undefined | string

Static isNewer

Static isOlder

Static isSignedByAuthorDelegate

Static isSignedByOwnerDelegate

Static validateJsonSchema

  • validateJsonSchema(rawMessage): void

  • Validates the given message against the corresponding JSON schema.

    +

    Parameters

    • rawMessage: any

    Returns void

    Throws

    if fails validation.

    +

Static validateSignatureStructure

  • validateSignatureStructure(messageSignature, messageDescriptor, payloadJsonSchemaKey?): Promise<GenericSignaturePayload>

  • Validates the structural integrity of the message signature given:

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

    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.

    +

Settings

Member Visibility

Theme

On This Page

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

Class MessageStoreLevel

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

+

Implements

Constructors

constructor +

Properties

blockstore +config +index +

Methods

clear +close +delete +get +open +put +query +buildQueryOptions +

Constructors

constructor

Properties

blockstore

blockstore: BlockstoreLevel

config

config: MessageStoreLevelConfig

index

index: IndexLevel

Methods

clear

close

delete

get

open

put

query

Static buildQueryOptions

Settings

Member Visibility

Theme

On This Page

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

Class MessagesGet

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

authormessagesignaturePayloadsignertoJSONcreateparse
\ No newline at end of file diff --git a/classes/PermissionsProtocol.html b/classes/PermissionsProtocol.html new file mode 100644 index 000000000..5df2bdc44 --- /dev/null +++ b/classes/PermissionsProtocol.html @@ -0,0 +1,26 @@ +PermissionsProtocol | DWN-SDK Documentation - v0.2.23

Class PermissionsProtocol

This is a first-class DWN protocol for managing permission grants of a given DWN.

+

Constructors

constructor +

Properties

definition +grantPath +requestPath +revocationPath +uri +

Methods

createGrant +createRequest +createRevocation +fetchGrant +parseRequest +validateSchema +

Constructors

constructor

Properties

Static Readonly definition

definition: ProtocolDefinition = ...

The definition of the Permissions protocol.

+

Static Readonly grantPath

grantPath: "grant" = 'grant'

The protocol path of the grant record.

+

Static Readonly requestPath

requestPath: "request" = 'request'

The protocol path of the request record.

+

Static Readonly revocationPath

revocationPath: "grant/revocation" = 'grant/revocation'

The protocol path of the revocation record.

+

Static Readonly uri

uri: "https://tbd.website/dwn/permissions" = 'https://tbd.website/dwn/permissions'

The URI of the DWN Permissions protocol.

+

Methods

Static createGrant

  • createGrant(options): Promise<{
        dataEncodedMessage: DataEncodedRecordsWriteMessage;
        permissionGrantBytes: Uint8Array;
        permissionGrantData: PermissionGrantData;
        recordsWrite: RecordsWrite;
    }>

  • Convenience method to create a permission grant.

    +

    Parameters

    • options: PermissionGrantCreateOptions

    Returns Promise<{
        dataEncodedMessage: DataEncodedRecordsWriteMessage;
        permissionGrantBytes: Uint8Array;
        permissionGrantData: PermissionGrantData;
        recordsWrite: RecordsWrite;
    }>

Static createRequest

  • createRequest(options): Promise<{
        permissionRequestBytes: Uint8Array;
        permissionRequestData: PermissionRequestData;
        recordsWrite: RecordsWrite;
    }>

  • Convenience method to create a permission request.

    +

    Parameters

    • options: PermissionRequestCreateOptions

    Returns Promise<{
        permissionRequestBytes: Uint8Array;
        permissionRequestData: PermissionRequestData;
        recordsWrite: RecordsWrite;
    }>

Static createRevocation

  • createRevocation(options): Promise<{
        permissionRevocationBytes: Uint8Array;
        permissionRevocationData: PermissionRevocationData;
        recordsWrite: RecordsWrite;
    }>

  • Convenience method to create a permission revocation.

    +

    Parameters

    • options: PermissionRevocationCreateOptions

    Returns Promise<{
        permissionRevocationBytes: Uint8Array;
        permissionRevocationData: PermissionRevocationData;
        recordsWrite: RecordsWrite;
    }>

Static fetchGrant

  • fetchGrant(tenant, messageStore, permissionGrantId): Promise<PermissionGrant>

  • Fetches PermissionGrant with the specified recordID.

    +

    Parameters

    • tenant: string
    • messageStore: MessageStore
    • permissionGrantId: string

    Returns Promise<PermissionGrant>

    the PermissionGrant matching the recordId specified.

    +

    Throws

    if PermissionGrant does not exist

    +

Static parseRequest

  • parseRequest(base64UrlEncodedRequest): PermissionRequestData

  • Parameters

    • base64UrlEncodedRequest: string

    Returns PermissionRequestData

Static validateSchema

  • validateSchema(recordsWriteMessage, dataBytes): void

  • Validates the given Permissions protocol RecordsWrite. It can be a request, grant, or revocation.

    +

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

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

Class PrivateKeySigner

A signer that signs using a private key.

+

Implements

Constructors

constructor +

Properties

algorithm +keyId +

Methods

sign +

Constructors

constructor

Properties

algorithm

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

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

sign

  • sign(content): Promise<Uint8Array>

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

    +

    Parameters

    • content: Uint8Array

    Returns Promise<Uint8Array>

Settings

Member Visibility

Theme

On This Page

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

Class Protocols

Class containing Protocol related utility methods.

+

Constructors

constructor +

Methods

deriveAndInjectPublicEncryptionKeys +

Constructors

constructor

Methods

Static deriveAndInjectPublicEncryptionKeys

  • deriveAndInjectPublicEncryptionKeys(protocolDefinition, rootKeyId, privateJwk): Promise<ProtocolDefinition>

  • 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>

Settings

Member Visibility

Theme

On This Page

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

Class ProtocolsConfigure

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

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

Class ProtocolsQuery

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorize +toJSON +create +normalizeFilter +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorize

toJSON

Static create

Static normalizeFilter

Static parse

Settings

Member Visibility

Theme

On This Page

authormessagesignaturePayloadsignerauthorizetoJSONcreatenormalizeFilterparse
\ No newline at end of file diff --git a/classes/Records.html b/classes/Records.html new file mode 100644 index 000000000..143a8d4c4 --- /dev/null +++ b/classes/Records.html @@ -0,0 +1,48 @@ +Records | DWN-SDK Documentation - v0.2.23

Class Records

Class containing useful utilities related to the Records interface.

+

Constructors

constructor +

Methods

buildTagIndexes +constructKeyDerivationPath +constructKeyDerivationPathUsingDataFormatsScheme +constructKeyDerivationPathUsingProtocolContextScheme +constructKeyDerivationPathUsingProtocolPathScheme +constructKeyDerivationPathUsingSchemasScheme +convertFilter +decrypt +derivePrivateKey +filterIncludesPublishedRecords +filterIncludesUnpublishedRecords +getParentContextFromOfContextId +isStartsWithFilter +normalizeFilter +shouldProtocolAuthorize +validateAncestorKeyAndDescentKeyDerivationPathsMatch +validateDelegatedGrantReferentialIntegrity +

Constructors

constructor

Methods

Static buildTagIndexes

  • buildTagIndexes(tags): KeyValues

  • This will create individual keys for each of the tags that look like tag.tag_property

    +

    Parameters

    • tags: RecordsWriteTags

    Returns KeyValues

Static constructKeyDerivationPath

Static constructKeyDerivationPathUsingDataFormatsScheme

  • constructKeyDerivationPathUsingDataFormatsScheme(schema, dataFormat): string[]

  • Constructs the full key derivation path using dataFormats scheme.

    +

    Parameters

    • schema: undefined | string
    • dataFormat: string

    Returns string[]

Static constructKeyDerivationPathUsingProtocolContextScheme

  • constructKeyDerivationPathUsingProtocolContextScheme(contextId): string[]

  • Constructs the full key derivation path using protocolContext scheme.

    +

    Parameters

    • contextId: undefined | string

    Returns string[]

Static constructKeyDerivationPathUsingProtocolPathScheme

  • constructKeyDerivationPathUsingProtocolPathScheme(descriptor): string[]

  • Constructs the full key derivation path using protocolPath scheme.

    +

    Parameters

    Returns string[]

Static constructKeyDerivationPathUsingSchemasScheme

  • constructKeyDerivationPathUsingSchemasScheme(schema): string[]

  • Constructs the full key derivation path using schemas scheme.

    +

    Parameters

    • schema: undefined | string

    Returns string[]

Static convertFilter

  • convertFilter(filter, dateSort?): Filter

  • 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.

    +

Static decrypt

  • decrypt(recordsWrite, ancestorPrivateKey, cipherStream): Promise<Readable>

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

    +

    Parameters

    Returns Promise<Readable>

Static derivePrivateKey

  • derivePrivateKey(ancestorPrivateKey, fullDescendantDerivationPath): Promise<Uint8Array>

  • 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>

Static filterIncludesPublishedRecords

  • filterIncludesPublishedRecords(filter): boolean

  • Checks if the filter supports returning published records.

    +

    Parameters

    • filter: RecordsFilter

    Returns boolean

Static filterIncludesUnpublishedRecords

  • filterIncludesUnpublishedRecords(filter): boolean

  • Checks if the filter supports returning unpublished records.

    +

    Parameters

    • filter: RecordsFilter

    Returns boolean

Static getParentContextFromOfContextId

  • getParentContextFromOfContextId(contextId): undefined | string

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

    +

    Parameters

    • contextId: undefined | string

    Returns undefined | string

Static isStartsWithFilter

  • isStartsWithFilter(filter): filter is StartsWithFilter

  • Parameters

    • filter: string | number | boolean | {
          gt: RangeValue;
      } & {
          gte?: undefined;
      } & Partial<{
          gt: RangeValue;
      } & {
          gte?: undefined;
      }> & Partial<{
          lt: RangeValue;
      } & {
          lte?: undefined;
      }> | {
          gt: RangeValue;
      } & {
          gte?: undefined;
      } & Partial<{
          gt: RangeValue;
      } & {
          gte?: undefined;
      }> & Partial<{
          lt?: undefined;
      } & {
          lte: RangeValue;
      }> | never | never | never | never | {
          gt?: undefined;
      } & {
          gte: RangeValue;
      } & Partial<{
          gt?: undefined;
      } & {
          gte: RangeValue;
      }> & Partial<{
          lt: RangeValue;
      } & {
          lte?: undefined;
      }> | {
          gt?: undefined;
      } & {
          gte: RangeValue;
      } & Partial<{
          gt?: undefined;
      } & {
          gte: RangeValue;
      }> & Partial<{
          lt?: undefined;
      } & {
          lte: RangeValue;
      }> | {
          lt: RangeValue;
      } & {
          lte?: undefined;
      } & Partial<{
          gt: RangeValue;
      } & {
          gte?: undefined;
      }> & Partial<{
          lt: RangeValue;
      } & {
          lte?: undefined;
      }> | never | {
          lt: RangeValue;
      } & {
          lte?: undefined;
      } & Partial<{
          gt?: undefined;
      } & {
          gte: RangeValue;
      }> & Partial<{
          lt: RangeValue;
      } & {
          lte?: undefined;
      }> | never | never | {
          lt?: undefined;
      } & {
          lte: RangeValue;
      } & Partial<{
          gt: RangeValue;
      } & {
          gte?: undefined;
      }> & Partial<{
          lt?: undefined;
      } & {
          lte: RangeValue;
      }> | never | {
          lt?: undefined;
      } & {
          lte: RangeValue;
      } & Partial<{
          gt?: undefined;
      } & {
          gte: RangeValue;
      }> & Partial<{
          lt?: undefined;
      } & {
          lte: RangeValue;
      }> | StartsWithFilter

    Returns filter is StartsWithFilter

Static normalizeFilter

  • normalizeFilter(filter): RecordsFilter

  • 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.

    +

Static shouldProtocolAuthorize

  • shouldProtocolAuthorize(signaturePayload): boolean

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

    +

    Parameters

    • signaturePayload: GenericSignaturePayload

    Returns boolean

Static validateAncestorKeyAndDescentKeyDerivationPathsMatch

  • validateAncestorKeyAndDescentKeyDerivationPathsMatch(ancestorKeyDerivationPath, descendantKeyDerivationPath): void

  • 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.

    +

Static validateDelegatedGrantReferentialIntegrity

  • validateDelegatedGrantReferentialIntegrity(message, authorSignaturePayload, ownerSignaturePayload?): Promise<void>

  • Validates the referential integrity of both author-delegated grant and owner-delegated grant.

    +

    Parameters

    • message: RecordsWriteMessage | RecordsQueryMessage | RecordsDeleteMessage | RecordsSubscribeMessage | RecordsReadMessage
    • authorSignaturePayload: undefined | GenericSignaturePayload

      Decoded payload of the author signature of the message. Pass undefined if message is not signed. + Passed purely as a performance optimization so we don't have to decode the signature payload again.

      +
    • Optional ownerSignaturePayload: GenericSignaturePayload

      Decoded payload of the owner signature of the message. Pass undefined if no owner signature is present. + Passed purely as a performance optimization so we don't have to decode the owner signature payload again.

      +

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

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

Class RecordsDelete

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +constructIndexes +toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorizeDelegate

constructIndexes

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

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

Class RecordsQuery

A class representing a RecordsQuery DWN message.

+

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorizeDelegate

  • authorizeDelegate(messageStore): Promise<void>

  • Authorizes the delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

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

Class RecordsRead

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorizeDelegate

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

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

Class RecordsSubscribe

A class representing a RecordsSubscribe DWN message.

+

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorizeDelegate

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

authormessagesignaturePayloadsignerauthorizeDelegatetoJSONcreateparse
\ No newline at end of file diff --git a/classes/RecordsWrite.html b/classes/RecordsWrite.html new file mode 100644 index 000000000..8517012ba --- /dev/null +++ b/classes/RecordsWrite.html @@ -0,0 +1,83 @@ +RecordsWrite | DWN-SDK Documentation - v0.2.23

Class RecordsWrite

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 +

Accessors

author +isSignedByAuthorDelegate +isSignedByOwnerDelegate +message +owner +ownerSignaturePayload +ownerSignatureSigner +signaturePayload +signer +

Methods

authorizeAuthorDelegate +authorizeOwnerDelegate +constructIndexes +encryptSymmetricEncryptionKey +getEntryId +isInitialWrite +sign +signAsOwner +signAsOwnerDelegate +toJSON +create +createAttestation +createFrom +createSignerSignature +fetchInitialRecordsWrite +getAttesters +getAuthor +getEntryId +getInitialWrite +isInitialWrite +parse +verifyEqualityOfImmutableProperties +

Properties

Readonly attesters

attesters: string[]

Accessors

author

isSignedByAuthorDelegate

isSignedByOwnerDelegate

message

owner

  • get owner(): undefined | string

  • The owner DID of the message if owner signature is present in the message; undefined otherwise. +This is the logical owner of the message, not to be confused with the actual signer of the owner signature, +this is because the signer of the owner signature may not be the actual DWN owner, but a delegate authorized by the owner.

    +

    Returns undefined | string

ownerSignaturePayload

  • get ownerSignaturePayload(): undefined | GenericSignaturePayload

  • Decoded owner signature payload.

    +

    Returns undefined | GenericSignaturePayload

ownerSignatureSigner

  • get ownerSignatureSigner(): undefined | string

  • Gets the signer of owner signature; undefined if owner signature is not present in the message. +This is not to be confused with the logical owner #owner of the message, +this is because the signer of the owner signature may not be the actual DWN owner, but a delegate authorized by the owner. +In the case that the owner signature is signed by the actual DWN owner, this value will be the same as #owner.

    +

    Returns undefined | string

signaturePayload

  • get signaturePayload(): undefined | RecordsWriteSignaturePayload

  • Returns undefined | RecordsWriteSignaturePayload

signer

  • 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

authorizeAuthorDelegate

  • authorizeAuthorDelegate(messageStore): Promise<void>

  • Authorizes the author-delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

authorizeOwnerDelegate

  • authorizeOwnerDelegate(messageStore): Promise<void>

  • Authorizes the owner-delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

constructIndexes

encryptSymmetricEncryptionKey

  • encryptSymmetricEncryptionKey(encryptionInput): 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>

getEntryId

isInitialWrite

sign

  • sign(options): Promise<void>

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

    +

    Parameters

    • options: {
          delegatedGrant?: RecordsWriteMessage;
          permissionGrantId?: string;
          protocolRole?: string;
          signer: Signer;
      }

    Returns Promise<void>

signAsOwner

  • signAsOwner(signer): 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.

    +

    Parameters

    Returns Promise<void>

signAsOwnerDelegate

  • signAsOwnerDelegate(signer, delegatedGrant): Promise<void>

  • Signs the RecordsWrite as the DWN owner-delegate. +This is used when a DWN owner-delegate 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.

    +

    Parameters

    Returns Promise<void>

toJSON

Static create

Static createAttestation

  • createAttestation(descriptorCid, signers?): Promise<undefined | GeneralJws>

  • 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>

Static createFrom

  • createFrom(options): Promise<RecordsWrite>

  • Convenience method that creates a message by:

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

    Parameters

    Returns Promise<RecordsWrite>

Static createSignerSignature

  • createSignerSignature(input): Promise<GeneralJws>

  • 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;
          permissionGrantId?: string;
          protocolRole?: string;
          recordId: string;
          signer: Signer;
      }
      • attestation: undefined | GeneralJws
      • contextId: undefined | string
      • Optional delegatedGrantId?: string
      • descriptorCid: string
      • encryption: undefined | EncryptionProperty
      • Optional permissionGrantId?: string
      • Optional protocolRole?: string
      • recordId: string
      • signer: Signer

    Returns Promise<GeneralJws>

Static fetchInitialRecordsWrite

  • fetchInitialRecordsWrite(messageStore, tenant, recordId): Promise<undefined | RecordsWrite>

  • Fetches the initial RecordsWrite of a record.

    +

    Parameters

    Returns Promise<undefined | RecordsWrite>

    The initial RecordsWrite if found; undefined if the record is not found.

    +

Static getAttesters

  • getAttesters(message): string[]

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

    +

    Parameters

    • message: InternalRecordsWriteMessage

    Returns string[]

Static getAuthor

Static getEntryId

Static getInitialWrite

Static isInitialWrite

Static parse

Static verifyEqualityOfImmutableProperties

Settings

Member Visibility

Theme

On This Page

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

Class Secp256k1

Class containing SECP256K1 related utility methods.

+

Constructors

constructor +

Methods

deriveChildPrivateKey +derivePrivateKey +derivePublicKey +generateKeyPair +generateKeyPairRaw +getPublicJwk +getPublicKey +privateJwkToBytes +privateKeyToJwk +publicJwkToBytes +publicKeyToJwk +sign +validateKey +verify +

Constructors

constructor

Methods

Static deriveChildPrivateKey

  • deriveChildPrivateKey(privateKey, derivationPathSegment): Promise<Uint8Array>

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

    +

    Parameters

    • privateKey: Uint8Array
    • derivationPathSegment: Uint8Array

    Returns Promise<Uint8Array>

Static derivePrivateKey

  • derivePrivateKey(privateKey, relativePath): Promise<Uint8Array>

  • Derives a hardened hierarchical deterministic private key.

    +

    Parameters

    • privateKey: Uint8Array
    • relativePath: string[]

    Returns Promise<Uint8Array>

Static derivePublicKey

  • derivePublicKey(privateKey, relativePath): Promise<Uint8Array>

  • Derives a hardened hierarchical deterministic public key.

    +

    Parameters

    • privateKey: Uint8Array
    • relativePath: string[]

    Returns Promise<Uint8Array>

    uncompressed public key

    +

Static generateKeyPair

Static generateKeyPairRaw

  • generateKeyPairRaw(): Promise<{
        privateKey: Uint8Array;
        publicKey: Uint8Array;
    }>

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

    +

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

Static getPublicJwk

Static getPublicKey

  • getPublicKey(privateKey): Promise<Uint8Array>

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

    +

    Parameters

    • privateKey: Uint8Array

    Returns Promise<Uint8Array>

Static privateJwkToBytes

  • privateJwkToBytes(privateJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

Static privateKeyToJwk

Static publicJwkToBytes

  • publicJwkToBytes(publicJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

Static publicKeyToJwk

Static sign

  • sign(content, privateJwk): Promise<Uint8Array>

  • Signs the provided content using the provided JWK.

    +

    Parameters

    Returns Promise<Uint8Array>

Static validateKey

Static verify

  • verify(content, signature, publicJwk): Promise<boolean>

  • 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.

    +

Settings

Member Visibility

Theme

On This Page

constructorderiveChildPrivateKeyderivePrivateKeyderivePublicKeygenerateKeyPairgenerateKeyPairRawgetPublicJwkgetPublicKeyprivateJwkToBytesprivateKeyToJwkpublicJwkToBytespublicKeyToJwksignvalidateKeyverify
\ No newline at end of file diff --git a/classes/Secp256r1.html b/classes/Secp256r1.html new file mode 100644 index 000000000..0dde00c66 --- /dev/null +++ b/classes/Secp256r1.html @@ -0,0 +1,20 @@ +Secp256r1 | DWN-SDK Documentation - v0.2.23

Class Secp256r1

Class containing SECP256R1 related utility methods.

+

Constructors

constructor +

Methods

bytesToBigInt +generateKeyPair +privateJwkToBytes +publicKeyToJwk +sign +validateKey +verify +

Constructors

constructor

Methods

Static bytesToBigInt

Static generateKeyPair

Static privateJwkToBytes

  • privateJwkToBytes(privateJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

Static publicKeyToJwk

Static sign

  • sign(content, privateJwk): Promise<Uint8Array>

  • Signs the provided content using the provided JWK. +Signature that is outputted is JWS format, not DER.

    +

    Parameters

    Returns Promise<Uint8Array>

Static validateKey

Static verify

  • verify(content, signature, publicJwk): Promise<boolean>

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

    +

    Parameters

    • content: Uint8Array
    • signature: Uint8Array

      the signature to verify. Can be in either DER or compact format. If using Oracle Cloud KMS, keys will be DER formatted.

      +
    • publicJwk: PublicJwk

    Returns Promise<boolean>

    a boolean indicating whether the signature is valid.

    +

Settings

Member Visibility

Theme

On This Page

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

Class TestDataGenerator

Utility class for generating data for testing.

+

Constructors

constructor +

Methods

createDidResolutionResult +generateAuthorization +generateAuthorizationSignature +generateDidKeyPersona +generateEventsGet +generateEventsQuery +generateEventsSubscribe +generateFromRecordsWrite +generateMessagesGet +generatePersona +generateProtocolEncryptedRecordsWrite +generateProtocolsConfigure +generateProtocolsQuery +generateRecordsDelete +generateRecordsQuery +generateRecordsSubscribe +generateRecordsWrite +randomBytes +randomCborSha256Cid +randomInt +randomSignatureString +randomString +randomTimestamp +

Constructors

constructor

Methods

Static createDidResolutionResult

Static generateAuthorization

  • generateAuthorization(): AuthorizationModel

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

    +

    Returns AuthorizationModel

Static generateAuthorizationSignature

  • generateAuthorizationSignature(): GeneralJws

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

    +

    Returns GeneralJws

Static generateDidKeyPersona

Static generateEventsGet

  • generateEventsGet(input?): Promise<GenerateEventsGetOutput>

  • Parameters

    • Optional input: GenerateEventsGetInput

    Returns Promise<GenerateEventsGetOutput>

Static generateEventsQuery

  • generateEventsQuery(input): Promise<GenerateEventsQueryOutput>

  • Parameters

    • input: GenerateEventsQueryInput

    Returns Promise<GenerateEventsQueryOutput>

Static generateEventsSubscribe

  • generateEventsSubscribe(input?): Promise<GenerateEventsSubscribeOutput>

  • Generates a EventsSubscribe message for testing.

    +

    Parameters

    • Optional input: GenerateEventsSubscribeInput

    Returns Promise<GenerateEventsSubscribeOutput>

Static generateFromRecordsWrite

  • generateFromRecordsWrite(input): Promise<GenerateFromRecordsWriteOut>

  • 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>

Static generateMessagesGet

  • generateMessagesGet(input): Promise<GenerateMessagesGetOutput>

  • Parameters

    • input: GenerateMessagesGetInput

    Returns Promise<GenerateMessagesGetOutput>

Static generatePersona

Static generateProtocolEncryptedRecordsWrite

  • generateProtocolEncryptedRecordsWrite(input): Promise<{
        dataStream: Readable;
        encryptedDataBytes: Uint8Array;
        encryptionInput: EncryptionInput;
        message: RecordsWriteMessage;
        recordsWrite: RecordsWrite;
    }>

  • 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;
    }>

Static generateProtocolsConfigure

  • generateProtocolsConfigure(input?): Promise<GenerateProtocolsConfigureOutput>

  • 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>

Static generateProtocolsQuery

  • generateProtocolsQuery(input?): Promise<GenerateProtocolsQueryOutput>

  • Generates a ProtocolsQuery message for testing.

    +

    Parameters

    • Optional input: GenerateProtocolsQueryInput

    Returns Promise<GenerateProtocolsQueryOutput>

Static generateRecordsDelete

  • generateRecordsDelete(input?): Promise<GenerateRecordsDeleteOutput>

  • Generates a RecordsDelete for testing.

    +

    Parameters

    • Optional input: GenerateRecordsDeleteInput

    Returns Promise<GenerateRecordsDeleteOutput>

Static generateRecordsQuery

  • generateRecordsQuery(input?): Promise<GenerateRecordsQueryOutput>

  • Generates a RecordsQuery message for testing.

    +

    Parameters

    • Optional input: GenerateRecordsQueryInput

    Returns Promise<GenerateRecordsQueryOutput>

Static generateRecordsSubscribe

  • generateRecordsSubscribe(input?): Promise<GenerateRecordsSubscribeOutput>

  • Generates a RecordsSubscribe message for testing.

    +

    Parameters

    • Optional input: GenerateRecordsSubscribeInput

    Returns Promise<GenerateRecordsSubscribeOutput>

Static generateRecordsWrite

  • generateRecordsWrite(input?): Promise<GenerateRecordsWriteOutput>

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

    +

    Parameters

    • Optional input: GenerateRecordsWriteInput

    Returns Promise<GenerateRecordsWriteOutput>

Static randomBytes

Static randomCborSha256Cid

Static randomInt

  • randomInt(min, max): number

  • Generates a random within a range (inclusive).

    +

    Parameters

    • min: number

      lowest potential value.

      +
    • max: number

      greatest potential value.

      +

    Returns number

Static randomSignatureString

Static randomString

Static randomTimestamp

  • randomTimestamp(options?): string

  • 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

    +

Settings

Member Visibility

Theme

On This Page

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

Class Time

Time related utilities.

+

Constructors

constructor +

Methods

createOffsetTimestamp +createTimestamp +getCurrentTimestamp +minimalSleep +sleep +validateTimestamp +

Constructors

constructor

Methods

Static createOffsetTimestamp

  • createOffsetTimestamp(offset, timestamp?): string

  • 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

Static createTimestamp

  • createTimestamp(options): 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

    +

Static getCurrentTimestamp

  • getCurrentTimestamp(): string

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

    +

    Returns string

Static minimalSleep

Static sleep

  • sleep(durationInMillisecond): Promise<void>

  • sleeps for the desired duration

    +

    Parameters

    • durationInMillisecond: number

      the desired amount of sleep time

      +

    Returns Promise<void>

    when the provided duration has passed

    +

Static validateTimestamp

  • validateTimestamp(timestamp): void

  • 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

    +

Settings

Member Visibility

Theme

On This Page

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

Enumeration DateSort

Enumeration Members

CreatedAscending +CreatedDescending +PublishedAscending +PublishedDescending +

Enumeration Members

CreatedAscending

CreatedAscending: "createdAscending"

CreatedDescending

CreatedDescending: "createdDescending"

PublishedAscending

PublishedAscending: "publishedAscending"

PublishedDescending

PublishedDescending: "publishedDescending"

Settings

Member Visibility

Theme

On This Page

CreatedAscendingCreatedDescendingPublishedAscendingPublishedDescending
\ No newline at end of file diff --git a/enums/DwnErrorCode.html b/enums/DwnErrorCode.html new file mode 100644 index 000000000..3398c8ff0 --- /dev/null +++ b/enums/DwnErrorCode.html @@ -0,0 +1,146 @@ +DwnErrorCode | DWN-SDK Documentation - v0.2.23

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 +PermissionsProtocolValidateSchemaUnexpectedRecord +PermissionsProtocolValidateScopeContextIdProhibitedProperties +PermissionsProtocolValidateScopeSchemaProhibitedProperties +PrivateKeySignerUnableToDeduceAlgorithm +PrivateKeySignerUnableToDeduceKeyId +PrivateKeySignerUnsupportedCurve +ProtocolAuthorizationActionNotAllowed +ProtocolAuthorizationActionRulesNotFound +ProtocolAuthorizationDuplicateRoleRecipient +ProtocolAuthorizationIncorrectContextId +ProtocolAuthorizationIncorrectDataFormat +ProtocolAuthorizationIncorrectProtocolPath +ProtocolAuthorizationInvalidSchema +ProtocolAuthorizationInvalidType +ProtocolAuthorizationMatchingRoleRecordNotFound +ProtocolAuthorizationMaxSizeInvalid +ProtocolAuthorizationMinSizeInvalid +ProtocolAuthorizationMissingContextId +ProtocolAuthorizationMissingRuleSet +ProtocolAuthorizationNotARole +ProtocolAuthorizationParentNotFoundConstructingAncestorChain +ProtocolAuthorizationParentlessIncorrectProtocolPath +ProtocolAuthorizationProtocolNotFound +ProtocolAuthorizationQueryWithoutRole +ProtocolAuthorizationRoleMissingRecipient +ProtocolsConfigureDuplicateActorInRuleSet +ProtocolsConfigureDuplicateRoleInRuleSet +ProtocolsConfigureInvalidActionDeleteWithoutCreate +ProtocolsConfigureInvalidActionMissingOf +ProtocolsConfigureInvalidActionOfNotAllowed +ProtocolsConfigureInvalidActionUpdateWithoutCreate +ProtocolsConfigureInvalidRecipientOfAction +ProtocolsConfigureInvalidRuleSetRecordType +ProtocolsConfigureInvalidSize +ProtocolsConfigureQueryNotAllowed +ProtocolsConfigureRecordNestingDepthExceeded +ProtocolsConfigureRoleDoesNotExistAtGivenPath +ProtocolsConfigureUnauthorized +ProtocolsQueryUnauthorized +RecordsAuthorDelegatedGrantAndIdExistenceMismatch +RecordsAuthorDelegatedGrantCidMismatch +RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch +RecordsAuthorDelegatedGrantNotADelegatedGrant +RecordsDecryptNoMatchingKeyEncryptedFound +RecordsDeleteAuthorizationFailed +RecordsDerivePrivateKeyUnSupportedCurve +RecordsGrantAuthorizationConditionPublicationProhibited +RecordsGrantAuthorizationConditionPublicationRequired +RecordsGrantAuthorizationDeleteProtocolScopeMismatch +RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch +RecordsGrantAuthorizationScopeContextIdMismatch +RecordsGrantAuthorizationScopeMissingProtocol +RecordsGrantAuthorizationScopeNotRecords +RecordsGrantAuthorizationScopeProtocolMismatch +RecordsGrantAuthorizationScopeProtocolPathMismatch +RecordsGrantAuthorizationScopeSchema +RecordsInvalidAncestorKeyDerivationSegment +RecordsOwnerDelegatedGrantAndIdExistenceMismatch +RecordsOwnerDelegatedGrantCidMismatch +RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch +RecordsOwnerDelegatedGrantNotADelegatedGrant +RecordsProtocolContextDerivationSchemeMissingContextId +RecordsProtocolPathDerivationSchemeMissingProtocol +RecordsQueryCreateFilterPublishedSortInvalid +RecordsQueryFilterMissingRequiredProperties +RecordsQueryParseFilterPublishedSortInvalid +RecordsReadAuthorizationFailed +RecordsReadReturnedMultiple +RecordsSchemasDerivationSchemeMissingSchema +RecordsSubscribeEventStreamUnimplemented +RecordsSubscribeFilterMissingRequiredProperties +RecordsWriteAttestationIntegrityDescriptorCidMismatch +RecordsWriteAttestationIntegrityInvalidPayloadProperty +RecordsWriteAttestationIntegrityMoreThanOneSignature +RecordsWriteAuthorizationFailed +RecordsWriteCreateDataAndDataCidMutuallyExclusive +RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive +RecordsWriteCreateMissingSigner +RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive +RecordsWriteDataCidMismatch +RecordsWriteDataSizeMismatch +RecordsWriteGetEntryIdUndefinedAuthor +RecordsWriteGetInitialWriteNotFound +RecordsWriteImmutablePropertyChanged +RecordsWriteMissingDataInPrevious +RecordsWriteMissingDataStream +RecordsWriteMissingEncodedDataInPrevious +RecordsWriteMissingProtocol +RecordsWriteMissingSchema +RecordsWriteMissingSigner +RecordsWriteOwnerAndTenantMismatch +RecordsWriteSignAsOwnerDelegateUnknownAuthor +RecordsWriteSignAsOwnerUnknownAuthor +RecordsWriteValidateIntegrityAttestationMismatch +RecordsWriteValidateIntegrityContextIdMismatch +RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload +RecordsWriteValidateIntegrityDateCreatedMismatch +RecordsWriteValidateIntegrityEncryptionCidMismatch +RecordsWriteValidateIntegrityRecordIdUnauthorized +SchemaValidatorAdditionalPropertyNotAllowed +SchemaValidatorFailure +SchemaValidatorSchemaNotFound +SchemaValidatorUnevaluatedPropertyNotAllowed +Secp256k1KeyNotValid +Secp256r1KeyNotValid +TimestampInvalid +UrlProtocolNotNormalizable +UrlProtocolNotNormalized +UrlSchemaNotNormalizable +UrlSchemaNotNormalized +

Enumeration Members

AuthenticateDescriptorCidMismatch

AuthenticateDescriptorCidMismatch: "AuthenticateDescriptorCidMismatch"

AuthenticateJwsMissing

AuthenticateJwsMissing: "AuthenticateJwsMissing"

AuthenticationMoreThanOneSignatureNotSupported

AuthenticationMoreThanOneSignatureNotSupported: "AuthenticationMoreThanOneSignatureNotSupported"

AuthorizationAuthorNotOwner

AuthorizationAuthorNotOwner: "AuthorizationAuthorNotOwner"

AuthorizationNotGrantedToAuthor

AuthorizationNotGrantedToAuthor: "AuthorizationNotGrantedToAuthor"

ComputeCidCodecNotSupported

ComputeCidCodecNotSupported: "ComputeCidCodecNotSupported"

ComputeCidMultihashNotSupported

ComputeCidMultihashNotSupported: "ComputeCidMultihashNotSupported"

DidMethodNotSupported

DidMethodNotSupported: "DidMethodNotSupported"

DidNotString

DidNotString: "DidNotString"

DidNotValid

DidNotValid: "DidNotValid"

DidResolutionFailed

DidResolutionFailed: "DidResolutionFailed"

Ed25519InvalidJwk

Ed25519InvalidJwk: "Ed25519InvalidJwk"

EventEmitterStreamNotOpenError

EventEmitterStreamNotOpenError: "EventEmitterStreamNotOpenError"

EventsSubscribeEventStreamUnimplemented

EventsSubscribeEventStreamUnimplemented: "EventsSubscribeEventStreamUnimplemented"

GeneralJwsVerifierGetPublicKeyNotFound

GeneralJwsVerifierGetPublicKeyNotFound: "GeneralJwsVerifierGetPublicKeyNotFound"

GeneralJwsVerifierInvalidSignature

GeneralJwsVerifierInvalidSignature: "GeneralJwsVerifierInvalidSignature"

GrantAuthorizationGrantExpired

GrantAuthorizationGrantExpired: "GrantAuthorizationGrantExpired"

GrantAuthorizationGrantMissing

GrantAuthorizationGrantMissing: "GrantAuthorizationGrantMissing"

GrantAuthorizationGrantNotYetActive

GrantAuthorizationGrantNotYetActive: "GrantAuthorizationGrantNotYetActive"

GrantAuthorizationGrantRevoked

GrantAuthorizationGrantRevoked: "GrantAuthorizationGrantRevoked"

GrantAuthorizationInterfaceMismatch

GrantAuthorizationInterfaceMismatch: "GrantAuthorizationInterfaceMismatch"

GrantAuthorizationMethodMismatch

GrantAuthorizationMethodMismatch: "GrantAuthorizationMethodMismatch"

GrantAuthorizationNotGrantedForTenant

GrantAuthorizationNotGrantedForTenant: "GrantAuthorizationNotGrantedForTenant"

GrantAuthorizationNotGrantedToAuthor

GrantAuthorizationNotGrantedToAuthor: "GrantAuthorizationNotGrantedToAuthor"

HdKeyDerivationPathInvalid

HdKeyDerivationPathInvalid: "HdKeyDerivationPathInvalid"

IndexInvalidCursorSortProperty

IndexInvalidCursorSortProperty: "IndexInvalidCursorSortProperty"

IndexInvalidCursorValueType

IndexInvalidCursorValueType: "IndexInvalidCursorValueType"

IndexInvalidSortPropertyInMemory

IndexInvalidSortPropertyInMemory: "IndexInvalidSortPropertyInMemory"

IndexMissingIndexableProperty

IndexMissingIndexableProperty: "IndexMissingIndexableProperty"

JwsDecodePlainObjectPayloadInvalid

JwsDecodePlainObjectPayloadInvalid: "JwsDecodePlainObjectPayloadInvalid"

JwsVerifySignatureUnsupportedCrv

JwsVerifySignatureUnsupportedCrv: "JwsVerifySignatureUnsupportedCrv"

MessageGetInvalidCid

MessageGetInvalidCid: "MessageGetInvalidCid"

ParseCidCodecNotSupported

ParseCidCodecNotSupported: "ParseCidCodecNotSupported"

ParseCidMultihashNotSupported

ParseCidMultihashNotSupported: "ParseCidMultihashNotSupported"

PermissionsProtocolValidateSchemaUnexpectedRecord

PermissionsProtocolValidateSchemaUnexpectedRecord: "PermissionsProtocolValidateSchemaUnexpectedRecord"

PermissionsProtocolValidateScopeContextIdProhibitedProperties

PermissionsProtocolValidateScopeContextIdProhibitedProperties: "PermissionsProtocolValidateScopeContextIdProhibitedProperties"

PermissionsProtocolValidateScopeSchemaProhibitedProperties

PermissionsProtocolValidateScopeSchemaProhibitedProperties: "PermissionsProtocolValidateScopeSchemaProhibitedProperties"

PrivateKeySignerUnableToDeduceAlgorithm

PrivateKeySignerUnableToDeduceAlgorithm: "PrivateKeySignerUnableToDeduceAlgorithm"

PrivateKeySignerUnableToDeduceKeyId

PrivateKeySignerUnableToDeduceKeyId: "PrivateKeySignerUnableToDeduceKeyId"

PrivateKeySignerUnsupportedCurve

PrivateKeySignerUnsupportedCurve: "PrivateKeySignerUnsupportedCurve"

ProtocolAuthorizationActionNotAllowed

ProtocolAuthorizationActionNotAllowed: "ProtocolAuthorizationActionNotAllowed"

ProtocolAuthorizationActionRulesNotFound

ProtocolAuthorizationActionRulesNotFound: "ProtocolAuthorizationActionRulesNotFound"

ProtocolAuthorizationDuplicateRoleRecipient

ProtocolAuthorizationDuplicateRoleRecipient: "ProtocolAuthorizationDuplicateRoleRecipient"

ProtocolAuthorizationIncorrectContextId

ProtocolAuthorizationIncorrectContextId: "ProtocolAuthorizationIncorrectContextId"

ProtocolAuthorizationIncorrectDataFormat

ProtocolAuthorizationIncorrectDataFormat: "ProtocolAuthorizationIncorrectDataFormat"

ProtocolAuthorizationIncorrectProtocolPath

ProtocolAuthorizationIncorrectProtocolPath: "ProtocolAuthorizationIncorrectProtocolPath"

ProtocolAuthorizationInvalidSchema

ProtocolAuthorizationInvalidSchema: "ProtocolAuthorizationInvalidSchema"

ProtocolAuthorizationInvalidType

ProtocolAuthorizationInvalidType: "ProtocolAuthorizationInvalidType"

ProtocolAuthorizationMatchingRoleRecordNotFound

ProtocolAuthorizationMatchingRoleRecordNotFound: "ProtocolAuthorizationMatchingRoleRecordNotFound"

ProtocolAuthorizationMaxSizeInvalid

ProtocolAuthorizationMaxSizeInvalid: "ProtocolAuthorizationMaxSizeInvalid"

ProtocolAuthorizationMinSizeInvalid

ProtocolAuthorizationMinSizeInvalid: "ProtocolAuthorizationMinSizeInvalid"

ProtocolAuthorizationMissingContextId

ProtocolAuthorizationMissingContextId: "ProtocolAuthorizationMissingContextId"

ProtocolAuthorizationMissingRuleSet

ProtocolAuthorizationMissingRuleSet: "ProtocolAuthorizationMissingRuleSet"

ProtocolAuthorizationNotARole

ProtocolAuthorizationNotARole: "ProtocolAuthorizationNotARole"

ProtocolAuthorizationParentNotFoundConstructingAncestorChain

ProtocolAuthorizationParentNotFoundConstructingAncestorChain: "ProtocolAuthorizationParentNotFoundConstructingAncestorChain"

ProtocolAuthorizationParentlessIncorrectProtocolPath

ProtocolAuthorizationParentlessIncorrectProtocolPath: "ProtocolAuthorizationParentlessIncorrectProtocolPath"

ProtocolAuthorizationProtocolNotFound

ProtocolAuthorizationProtocolNotFound: "ProtocolAuthorizationProtocolNotFound"

ProtocolAuthorizationQueryWithoutRole

ProtocolAuthorizationQueryWithoutRole: "ProtocolAuthorizationQueryWithoutRole"

ProtocolAuthorizationRoleMissingRecipient

ProtocolAuthorizationRoleMissingRecipient: "ProtocolAuthorizationRoleMissingRecipient"

ProtocolsConfigureDuplicateActorInRuleSet

ProtocolsConfigureDuplicateActorInRuleSet: "ProtocolsConfigureDuplicateActorInRuleSet"

ProtocolsConfigureDuplicateRoleInRuleSet

ProtocolsConfigureDuplicateRoleInRuleSet: "ProtocolsConfigureDuplicateRoleInRuleSet"

ProtocolsConfigureInvalidActionDeleteWithoutCreate

ProtocolsConfigureInvalidActionDeleteWithoutCreate: "ProtocolsConfigureInvalidActionDeleteWithoutCreate"

ProtocolsConfigureInvalidActionMissingOf

ProtocolsConfigureInvalidActionMissingOf: "ProtocolsConfigureInvalidActionMissingOf"

ProtocolsConfigureInvalidActionOfNotAllowed

ProtocolsConfigureInvalidActionOfNotAllowed: "ProtocolsConfigureInvalidActionOfNotAllowed"

ProtocolsConfigureInvalidActionUpdateWithoutCreate

ProtocolsConfigureInvalidActionUpdateWithoutCreate: "ProtocolsConfigureInvalidActionUpdateWithoutCreate"

ProtocolsConfigureInvalidRecipientOfAction

ProtocolsConfigureInvalidRecipientOfAction: "ProtocolsConfigureInvalidRecipientOfAction"

ProtocolsConfigureInvalidRuleSetRecordType

ProtocolsConfigureInvalidRuleSetRecordType: "ProtocolsConfigureInvalidRuleSetRecordType"

ProtocolsConfigureInvalidSize

ProtocolsConfigureInvalidSize: "ProtocolsConfigureInvalidSize"

ProtocolsConfigureQueryNotAllowed

ProtocolsConfigureQueryNotAllowed: "ProtocolsConfigureQueryNotAllowed"

ProtocolsConfigureRecordNestingDepthExceeded

ProtocolsConfigureRecordNestingDepthExceeded: "ProtocolsConfigureRecordNestingDepthExceeded"

ProtocolsConfigureRoleDoesNotExistAtGivenPath

ProtocolsConfigureRoleDoesNotExistAtGivenPath: "ProtocolsConfigureRoleDoesNotExistAtGivenPath"

ProtocolsConfigureUnauthorized

ProtocolsConfigureUnauthorized: "ProtocolsConfigureUnauthorized"

ProtocolsQueryUnauthorized

ProtocolsQueryUnauthorized: "ProtocolsQueryUnauthorized"

RecordsAuthorDelegatedGrantAndIdExistenceMismatch

RecordsAuthorDelegatedGrantAndIdExistenceMismatch: "RecordsAuthorDelegatedGrantAndIdExistenceMismatch"

RecordsAuthorDelegatedGrantCidMismatch

RecordsAuthorDelegatedGrantCidMismatch: "RecordsAuthorDelegatedGrantCidMismatch"

RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch

RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch: "RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch"

RecordsAuthorDelegatedGrantNotADelegatedGrant

RecordsAuthorDelegatedGrantNotADelegatedGrant: "RecordsAuthorDelegatedGrantNotADelegatedGrant"

RecordsDecryptNoMatchingKeyEncryptedFound

RecordsDecryptNoMatchingKeyEncryptedFound: "RecordsDecryptNoMatchingKeyEncryptedFound"

RecordsDeleteAuthorizationFailed

RecordsDeleteAuthorizationFailed: "RecordsDeleteAuthorizationFailed"

RecordsDerivePrivateKeyUnSupportedCurve

RecordsDerivePrivateKeyUnSupportedCurve: "RecordsDerivePrivateKeyUnSupportedCurve"

RecordsGrantAuthorizationConditionPublicationProhibited

RecordsGrantAuthorizationConditionPublicationProhibited: "RecordsGrantAuthorizationConditionPublicationProhibited"

RecordsGrantAuthorizationConditionPublicationRequired

RecordsGrantAuthorizationConditionPublicationRequired: "RecordsGrantAuthorizationConditionPublicationRequired"

RecordsGrantAuthorizationDeleteProtocolScopeMismatch

RecordsGrantAuthorizationDeleteProtocolScopeMismatch: "RecordsGrantAuthorizationDeleteProtocolScopeMismatch"

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch: "RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch"

RecordsGrantAuthorizationScopeContextIdMismatch

RecordsGrantAuthorizationScopeContextIdMismatch: "RecordsGrantAuthorizationScopeContextIdMismatch"

RecordsGrantAuthorizationScopeMissingProtocol

RecordsGrantAuthorizationScopeMissingProtocol: "RecordsGrantAuthorizationScopeMissingProtocol"

RecordsGrantAuthorizationScopeNotRecords

RecordsGrantAuthorizationScopeNotRecords: "RecordsGrantAuthorizationScopeNotRecords"

RecordsGrantAuthorizationScopeProtocolMismatch

RecordsGrantAuthorizationScopeProtocolMismatch: "RecordsGrantAuthorizationScopeProtocolMismatch"

RecordsGrantAuthorizationScopeProtocolPathMismatch

RecordsGrantAuthorizationScopeProtocolPathMismatch: "RecordsGrantAuthorizationScopeProtocolPathMismatch"

RecordsGrantAuthorizationScopeSchema

RecordsGrantAuthorizationScopeSchema: "RecordsGrantAuthorizationScopeSchema"

RecordsInvalidAncestorKeyDerivationSegment

RecordsInvalidAncestorKeyDerivationSegment: "RecordsInvalidAncestorKeyDerivationSegment"

RecordsOwnerDelegatedGrantAndIdExistenceMismatch

RecordsOwnerDelegatedGrantAndIdExistenceMismatch: "RecordsOwnerDelegatedGrantAndIdExistenceMismatch"

RecordsOwnerDelegatedGrantCidMismatch

RecordsOwnerDelegatedGrantCidMismatch: "RecordsOwnerDelegatedGrantCidMismatch"

RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch

RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch: "RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch"

RecordsOwnerDelegatedGrantNotADelegatedGrant

RecordsOwnerDelegatedGrantNotADelegatedGrant: "RecordsOwnerDelegatedGrantNotADelegatedGrant"

RecordsProtocolContextDerivationSchemeMissingContextId

RecordsProtocolContextDerivationSchemeMissingContextId: "RecordsProtocolContextDerivationSchemeMissingContextId"

RecordsProtocolPathDerivationSchemeMissingProtocol

RecordsProtocolPathDerivationSchemeMissingProtocol: "RecordsProtocolPathDerivationSchemeMissingProtocol"

RecordsQueryCreateFilterPublishedSortInvalid

RecordsQueryCreateFilterPublishedSortInvalid: "RecordsQueryCreateFilterPublishedSortInvalid"

RecordsQueryFilterMissingRequiredProperties

RecordsQueryFilterMissingRequiredProperties: "RecordsQueryFilterMissingRequiredProperties"

RecordsQueryParseFilterPublishedSortInvalid

RecordsQueryParseFilterPublishedSortInvalid: "RecordsQueryParseFilterPublishedSortInvalid"

RecordsReadAuthorizationFailed

RecordsReadAuthorizationFailed: "RecordsReadAuthorizationFailed"

RecordsReadReturnedMultiple

RecordsReadReturnedMultiple: "RecordsReadReturnedMultiple"

RecordsSchemasDerivationSchemeMissingSchema

RecordsSchemasDerivationSchemeMissingSchema: "RecordsSchemasDerivationSchemeMissingSchema"

RecordsSubscribeEventStreamUnimplemented

RecordsSubscribeEventStreamUnimplemented: "RecordsSubscribeEventStreamUnimplemented"

RecordsSubscribeFilterMissingRequiredProperties

RecordsSubscribeFilterMissingRequiredProperties: "RecordsSubscribeFilterMissingRequiredProperties"

RecordsWriteAttestationIntegrityDescriptorCidMismatch

RecordsWriteAttestationIntegrityDescriptorCidMismatch: "RecordsWriteAttestationIntegrityDescriptorCidMismatch"

RecordsWriteAttestationIntegrityInvalidPayloadProperty

RecordsWriteAttestationIntegrityInvalidPayloadProperty: "RecordsWriteAttestationIntegrityInvalidPayloadProperty"

RecordsWriteAttestationIntegrityMoreThanOneSignature

RecordsWriteAttestationIntegrityMoreThanOneSignature: "RecordsWriteAttestationIntegrityMoreThanOneSignature"

RecordsWriteAuthorizationFailed

RecordsWriteAuthorizationFailed: "RecordsWriteAuthorizationFailed"

RecordsWriteCreateDataAndDataCidMutuallyExclusive

RecordsWriteCreateDataAndDataCidMutuallyExclusive: "RecordsWriteCreateDataAndDataCidMutuallyExclusive"

RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive

RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive: "RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive"

RecordsWriteCreateMissingSigner

RecordsWriteCreateMissingSigner: "RecordsWriteCreateMissingSigner"

RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive

RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive: "RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive"

RecordsWriteDataCidMismatch

RecordsWriteDataCidMismatch: "RecordsWriteDataCidMismatch"

RecordsWriteDataSizeMismatch

RecordsWriteDataSizeMismatch: "RecordsWriteDataSizeMismatch"

RecordsWriteGetEntryIdUndefinedAuthor

RecordsWriteGetEntryIdUndefinedAuthor: "RecordsWriteGetEntryIdUndefinedAuthor"

RecordsWriteGetInitialWriteNotFound

RecordsWriteGetInitialWriteNotFound: "RecordsWriteGetInitialWriteNotFound"

RecordsWriteImmutablePropertyChanged

RecordsWriteImmutablePropertyChanged: "RecordsWriteImmutablePropertyChanged"

RecordsWriteMissingDataInPrevious

RecordsWriteMissingDataInPrevious: "RecordsWriteMissingDataInPrevious"

RecordsWriteMissingDataStream

RecordsWriteMissingDataStream: "RecordsWriteMissingDataStream"

RecordsWriteMissingEncodedDataInPrevious

RecordsWriteMissingEncodedDataInPrevious: "RecordsWriteMissingEncodedDataInPrevious"

RecordsWriteMissingProtocol

RecordsWriteMissingProtocol: "RecordsWriteMissingProtocol"

RecordsWriteMissingSchema

RecordsWriteMissingSchema: "RecordsWriteMissingSchema"

RecordsWriteMissingSigner

RecordsWriteMissingSigner: "RecordsWriteMissingSigner"

RecordsWriteOwnerAndTenantMismatch

RecordsWriteOwnerAndTenantMismatch: "RecordsWriteOwnerAndTenantMismatch"

RecordsWriteSignAsOwnerDelegateUnknownAuthor

RecordsWriteSignAsOwnerDelegateUnknownAuthor: "RecordsWriteSignAsOwnerDelegateUnknownAuthor"

RecordsWriteSignAsOwnerUnknownAuthor

RecordsWriteSignAsOwnerUnknownAuthor: "RecordsWriteSignAsOwnerUnknownAuthor"

RecordsWriteValidateIntegrityAttestationMismatch

RecordsWriteValidateIntegrityAttestationMismatch: "RecordsWriteValidateIntegrityAttestationMismatch"

RecordsWriteValidateIntegrityContextIdMismatch

RecordsWriteValidateIntegrityContextIdMismatch: "RecordsWriteValidateIntegrityContextIdMismatch"

RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload

RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload: "RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload"

RecordsWriteValidateIntegrityDateCreatedMismatch

RecordsWriteValidateIntegrityDateCreatedMismatch: "RecordsWriteValidateIntegrityDateCreatedMismatch"

RecordsWriteValidateIntegrityEncryptionCidMismatch

RecordsWriteValidateIntegrityEncryptionCidMismatch: "RecordsWriteValidateIntegrityEncryptionCidMismatch"

RecordsWriteValidateIntegrityRecordIdUnauthorized

RecordsWriteValidateIntegrityRecordIdUnauthorized: "RecordsWriteValidateIntegrityRecordIdUnauthorized"

SchemaValidatorAdditionalPropertyNotAllowed

SchemaValidatorAdditionalPropertyNotAllowed: "SchemaValidatorAdditionalPropertyNotAllowed"

SchemaValidatorFailure

SchemaValidatorFailure: "SchemaValidatorFailure"

SchemaValidatorSchemaNotFound

SchemaValidatorSchemaNotFound: "SchemaValidatorSchemaNotFound"

SchemaValidatorUnevaluatedPropertyNotAllowed

SchemaValidatorUnevaluatedPropertyNotAllowed: "SchemaValidatorUnevaluatedPropertyNotAllowed"

Secp256k1KeyNotValid

Secp256k1KeyNotValid: "Secp256k1KeyNotValid"

Secp256r1KeyNotValid

Secp256r1KeyNotValid: "Secp256r1KeyNotValid"

TimestampInvalid

TimestampInvalid: "TimestampInvalid"

UrlProtocolNotNormalizable

UrlProtocolNotNormalizable: "UrlProtocolNotNormalizable"

UrlProtocolNotNormalized

UrlProtocolNotNormalized: "UrlProtocolNotNormalized"

UrlSchemaNotNormalizable

UrlSchemaNotNormalizable: "UrlSchemaNotNormalizable"

UrlSchemaNotNormalized

UrlSchemaNotNormalized: "UrlSchemaNotNormalized"

Settings

Member Visibility

Theme

On This Page

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

Enumeration DwnInterfaceName

Enumeration Members

Events +Messages +Protocols +Records +

Enumeration Members

Events

Events: "Events"

Messages

Messages: "Messages"

Protocols

Protocols: "Protocols"

Records

Records: "Records"

Settings

Member Visibility

Theme

On This Page

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

Enumeration DwnMethodName

Enumeration Members

Configure +Create +Delete +Get +Grant +Query +Read +Request +Revoke +Subscribe +Write +

Enumeration Members

Configure

Configure: "Configure"

Create

Create: "Create"

Delete

Delete: "Delete"

Get

Get: "Get"

Grant

Grant: "Grant"

Query

Query: "Query"

Read

Read: "Read"

Request

Request: "Request"

Revoke

Revoke: "Revoke"

Subscribe

Subscribe: "Subscribe"

Write

Write: "Write"

Settings

Member Visibility

Theme

On This Page

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

Enumeration EncryptionAlgorithm

Enumeration Members

Aes256Ctr +EciesSecp256k1 +

Enumeration Members

Aes256Ctr

Aes256Ctr: "A256CTR"

EciesSecp256k1

EciesSecp256k1: "ECIES-ES256K"

Settings

Member Visibility

Theme

On This Page

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

Enumeration KeyDerivationScheme

Enumeration Members

DataFormats +ProtocolContext +ProtocolPath +Schemas +

Enumeration Members

DataFormats

DataFormats: "dataFormats"

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

+

ProtocolContext

ProtocolContext: "protocolContext"

ProtocolPath

ProtocolPath: "protocolPath"

Schemas

Schemas: "schemas"

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

+

Settings

Member Visibility

Theme

On This Page

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

Enumeration SortDirection

Enumeration Members

Ascending +Descending +

Enumeration Members

Ascending

Ascending: 1

Descending

Descending: -1

Settings

Member Visibility

Theme

On This Page

AscendingDescending
\ No newline at end of file diff --git a/functions/authenticate.html b/functions/authenticate.html new file mode 100644 index 000000000..362f7393d --- /dev/null +++ b/functions/authenticate.html @@ -0,0 +1,3 @@ +authenticate | DWN-SDK Documentation - v0.2.23

Function authenticate

  • authenticate(authorizationModel, didResolver): Promise<void>

  • Verifies all the signature(s) within the authorization property.

    +

    Parameters

    • authorizationModel: undefined | AuthorizationModel
    • didResolver: DidResolver

    Returns Promise<void>

    Throws

    if fails authentication

    +

Settings

Member Visibility

Theme

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

Function executeUnlessAborted

  • executeUnlessAborted<T>(promise, signal): Promise<T>

  • 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>

Settings

Member Visibility

Theme

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

DWN-SDK Documentation - v0.2.23

Class Hierarchy

Settings

Member Visibility

Theme

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

DWN-SDK Documentation - v0.2.23

Index

Enumerations

DateSort +DwnErrorCode +DwnInterfaceName +DwnMethodName +EncryptionAlgorithm +KeyDerivationScheme +SortDirection +

Classes

AllowAllTenantGate +Cid +DataStoreLevel +DataStream +Dwn +DwnConstant +DwnError +Encoder +Encryption +EventEmitterStream +EventLogLevel +EventsGet +EventsQuery +EventsSubscribe +HdKey +Jws +Message +MessageStoreLevel +MessagesGet +PermissionsProtocol +PrivateKeySigner +Protocols +ProtocolsConfigure +ProtocolsQuery +Records +RecordsDelete +RecordsQuery +RecordsRead +RecordsSubscribe +RecordsWrite +Secp256k1 +Secp256r1 +TestDataGenerator +Time +

Interfaces

DataStore +EventLog +EventStream +MessageStore +MessageStoreOptions +MessageSubscription +Signer +TenantGate +

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 +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

authenticate +executeUnlessAborted +

Settings

Member Visibility

Theme

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

Interface DataStore

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

clear +close +delete +get +open +put +

Methods

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

delete

  • delete(tenant, recordId, dataCid): 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>

get

  • get(tenant, recordId, dataCid): Promise<undefined | DataStoreGetResult>

  • 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.

    +

open

put

  • put(tenant, recordId, dataCid, dataStream): Promise<DataStorePutResult>

  • 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>

Settings

Member Visibility

Theme

On This Page

clearclosedeletegetopenput
\ No newline at end of file diff --git a/interfaces/EventLog.html b/interfaces/EventLog.html new file mode 100644 index 000000000..34b331b1e --- /dev/null +++ b/interfaces/EventLog.html @@ -0,0 +1,25 @@ +EventLog | DWN-SDK Documentation - v0.2.23

Interface EventLog

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

append +clear +close +deleteEventsByCid +getEvents +open +queryEvents +

Methods

append

  • append(tenant, messageCid, indexes): Promise<void>

  • 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>

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

  • close(): Promise<void>

  • closes the connection to the underlying store

    +

    Returns Promise<void>

deleteEventsByCid

  • deleteEventsByCid(tenant, messageCids): 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

    +

getEvents

  • getEvents(tenant, cursor?): Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>

  • 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[];
    }>

open

  • open(): Promise<void>

  • opens a connection to the underlying store

    +

    Returns Promise<void>

queryEvents

  • queryEvents(tenant, filters, cursor?): 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[];
    }>

Settings

Member Visibility

Theme

On This Page

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

Interface EventStream

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(tenant, id, listener): Promise<EventSubscription>;
}

Implemented by

Methods

close +emit +open +subscribe +

Methods

close

emit

open

subscribe

  • subscribe(tenant, id, listener): Promise<EventSubscription>

  • Parameters

    • tenant: string
    • id: string
    • listener: EventListener

    Returns Promise<EventSubscription>

Settings

Member Visibility

Theme

On This Page

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

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

clear +close +delete +get +open +put +query +

Methods

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

delete

get

open

put

  • put(tenant, message, indexes, options?): Promise<void>

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

    +

    Parameters

    Returns Promise<void>

query

Settings

Member Visibility

Theme

On This Page

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

Interface MessageStoreOptions

interface MessageStoreOptions {
    signal?: AbortSignal;
}

Properties

signal? +

Properties

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

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

Interface MessageSubscription

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

Properties

close +id +

Properties

close

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

id

id: string

Settings

Member Visibility

Theme

On This Page

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

Interface Signer

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

algorithm +keyId +

Methods

sign +

Properties

algorithm

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

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

sign

  • sign(content): Promise<Uint8Array>

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

    +

    Parameters

    • content: Uint8Array

    Returns Promise<Uint8Array>

Settings

Member Visibility

Theme

On This Page

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

Interface TenantGate

An interface that gates tenant access to the DWN.

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

Implemented by

Methods

isActiveTenant +

Methods

isActiveTenant

Settings

Member Visibility

Theme

On This Page

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

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.

    +

Settings

Member Visibility

Theme

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

Type alias CreateFromOptions

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

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?: RecordsWriteMessage

    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

    The signer of the message, which is commonly the author, but can also be a delegate.

    +
  • Optional tags?: RecordsWriteTags

Settings

Member Visibility

Theme

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

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

Settings

Member Visibility

Theme

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

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.

    +

Settings

Member Visibility

Theme

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

Type alias DerivedPrivateJwk

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

Type declaration

Settings

Member Visibility

Theme

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

Type alias DwnConfig

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

DWN configuration.

+

Type declaration

Settings

Member Visibility

Theme

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

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.

    +

Settings

Member Visibility

Theme

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

Type alias EncryptionProperty

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

Type declaration

Settings

Member Visibility

Theme

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

Type alias EqualFilter

EqualFilter: string | number | boolean

Settings

Member Visibility

Theme

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

Type alias EventSubscriptionHandler

EventSubscriptionHandler: ((event) => void)

Type declaration

Settings

Member Visibility

Theme

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

Type alias EventsGetMessage

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

Type declaration

  • authorization: AuthorizationModel
  • descriptor: EventsGetDescriptor

Settings

Member Visibility

Theme

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

Type alias EventsGetOptions

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

Type declaration

Settings

Member Visibility

Theme

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

Type alias EventsGetReply

EventsGetReply: GenericMessageReply & {
    cursor?: PaginationCursor;
    entries?: string[];
}

Type declaration

Settings

Member Visibility

Theme

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

Type alias EventsQueryMessage

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

Type declaration

  • authorization: AuthorizationModel
  • descriptor: EventsQueryDescriptor

Settings

Member Visibility

Theme

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

Type alias EventsQueryOptions

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

Type declaration

Settings

Member Visibility

Theme

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

Type alias EventsQueryReply

EventsQueryReply: GenericMessageReply & {
    cursor?: PaginationCursor;
    entries?: string[];
}

Type declaration

Settings

Member Visibility

Theme

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

Type alias EventsSubscribeDescriptor

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

Type declaration

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

Settings

Member Visibility

Theme

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

Type alias EventsSubscribeMessage

EventsSubscribeMessage: {
    authorization: AuthorizationModel;
    descriptor: EventsSubscribeDescriptor;
}

Type declaration

Settings

Member Visibility

Theme

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

Type alias EventsSubscribeOptions

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

Type declaration

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

Settings

Member Visibility

Theme

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

Type alias EventsSubscribeReply

EventsSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Type declaration

Settings

Member Visibility

Theme

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

Type alias Filter

Filter: {
    [property: string]: FilterValue;
}

Type declaration

  • [property: string]: FilterValue

Settings

Member Visibility

Theme

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

Type alias GenericMessage

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

Intersection type for all concrete message types.

+

Type declaration

  • Optional authorization?: AuthorizationModel
  • descriptor: Descriptor

Settings

Member Visibility

Theme

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

Type alias GenericMessageReply

GenericMessageReply: {
    status: Status;
}

Type declaration

  • status: Status

Settings

Member Visibility

Theme

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

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)

    +

Settings

Member Visibility

Theme

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

Type alias KeyMaterial

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

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

+

Type declaration

Settings

Member Visibility

Theme

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

Type alias MessageEvent

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

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

+

Type declaration

Settings

Member Visibility

Theme

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

Type alias MessageSort

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

Type declaration

Settings

Member Visibility

Theme

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

Type alias MessagesGetMessage

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

Type declaration

  • authorization: AuthorizationModel
  • descriptor: MessagesGetDescriptor

Settings

Member Visibility

Theme

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

Type alias MessagesGetOptions

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

Type declaration

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

Settings

Member Visibility

Theme

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

Type alias MessagesGetReply

MessagesGetReply: GenericMessageReply & {
    entries?: MessagesGetReplyEntry[];
}

Type declaration

Settings

Member Visibility

Theme

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

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

Settings

Member Visibility

Theme

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

Type alias OneOfFilter

OneOfFilter: EqualFilter[]

Settings

Member Visibility

Theme

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

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

Settings

Member Visibility

Theme

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

Type alias PaginationCursor

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

Type declaration

  • messageCid: string
  • value: string | number

Settings

Member Visibility

Theme

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

Type alias PermissionConditions

PermissionConditions: {
    publication?: PermissionConditionPublication;
}

Type declaration

  • Optional publication?: PermissionConditionPublication

    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.

    +

Settings

Member Visibility

Theme

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

Type alias PermissionScope

PermissionScope: {
    interface: DwnInterfaceName;
    method: DwnMethodName;
} | RecordsPermissionScope

The data model for a permission scope.

+

Type declaration

Settings

Member Visibility

Theme

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

Type alias Persona

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

Settings

Member Visibility

Theme

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

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.

    +

Settings

Member Visibility

Theme

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

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

Settings

Member Visibility

Theme

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

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

Settings

Member Visibility

Theme

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

Type alias ProtocolTypes

ProtocolTypes: {
    [key: string]: ProtocolType;
}

Type declaration

  • [key: string]: ProtocolType

Settings

Member Visibility

Theme

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

Type alias ProtocolsConfigureDescriptor

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

Type declaration

Settings

Member Visibility

Theme

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

Type alias ProtocolsConfigureMessage

ProtocolsConfigureMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: ProtocolsConfigureDescriptor;
}

Type declaration

Settings

Member Visibility

Theme

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

Type alias ProtocolsConfigureOptions

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

Type declaration

Settings

Member Visibility

Theme

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

Type alias ProtocolsQueryFilter

ProtocolsQueryFilter: {
    protocol: string;
}

Type declaration

  • protocol: string

Settings

Member Visibility

Theme

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

Type alias ProtocolsQueryMessage

ProtocolsQueryMessage: GenericMessage & {
    descriptor: ProtocolsQueryDescriptor;
}

Type declaration

  • descriptor: ProtocolsQueryDescriptor

Settings

Member Visibility

Theme

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

Type alias ProtocolsQueryOptions

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

Type declaration

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

Settings

Member Visibility

Theme

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

Type alias ProtocolsQueryReply

ProtocolsQueryReply: GenericMessageReply & {
    entries?: ProtocolsConfigureMessage[];
}

Type declaration

Settings

Member Visibility

Theme

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

Type alias PublicJwk

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

Type declaration

  • crv: "Ed25519" | "secp256k1" | "P-256"

    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.

    +

Settings

Member Visibility

Theme

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

Type alias QueryOptions

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

Type declaration

Settings

Member Visibility

Theme

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

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

Settings

Member Visibility

Theme

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

Type alias RangeCriterion

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

Type declaration

  • Optional from?: string

    Inclusive starting date-time.

    +
  • Optional to?: string

    Inclusive end date-time.

    +

Settings

Member Visibility

Theme

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

Type alias RangeFilter

RangeFilter: (GT | LT) & Partial<GT> & Partial<LT>

Ranger filter. 1 condition is required.

+

Settings

Member Visibility

Theme

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

Type alias RecordsDeleteMessage

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

Type declaration

  • authorization: AuthorizationModel
  • descriptor: RecordsDeleteDescriptor

Settings

Member Visibility

Theme

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

Type alias RecordsDeleteOptions

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

Type declaration

  • Optional delegatedGrant?: RecordsWriteMessage

    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

Settings

Member Visibility

Theme

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

Type alias RecordsQueryMessage

RecordsQueryMessage: GenericMessage & {
    descriptor: RecordsQueryDescriptor;
}

Type declaration

  • descriptor: RecordsQueryDescriptor

Settings

Member Visibility

Theme

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

Type alias RecordsQueryOptions

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

Type declaration

  • Optional dateSort?: DateSort
  • Optional delegatedGrant?: RecordsWriteMessage

    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

Settings

Member Visibility

Theme

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

Type alias RecordsQueryReply

RecordsQueryReply: GenericMessageReply & {
    cursor?: PaginationCursor;
    entries?: RecordsQueryReplyEntry[];
}

Type declaration

Settings

Member Visibility

Theme

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

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. +
  2. May include encoded data
    3. +
+

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.

    +

Settings

Member Visibility

Theme

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

Type alias RecordsReadMessage

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

Type declaration

  • Optional authorization?: AuthorizationModel
  • descriptor: RecordsReadDescriptor

Settings

Member Visibility

Theme

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

Type alias RecordsReadOptions

RecordsReadOptions: {
    delegatedGrant?: RecordsWriteMessage;
    filter: RecordsFilter;
    messageTimestamp?: string;
    permissionGrantId?: string;
    protocolRole?: string;
    signer?: Signer;
}

Type declaration

  • Optional delegatedGrant?: RecordsWriteMessage

    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 permissionGrantId?: 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

Settings

Member Visibility

Theme

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

Type alias RecordsReadReply

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

Type declaration

Settings

Member Visibility

Theme

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

Type alias RecordsSubscribeDescriptor

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

Type declaration

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

Settings

Member Visibility

Theme

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

Type alias RecordsSubscribeMessage

RecordsSubscribeMessage: GenericMessage & {
    descriptor: RecordsSubscribeDescriptor;
}

Type declaration

Settings

Member Visibility

Theme

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

Type alias RecordsSubscribeOptions

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

Type declaration

  • Optional delegatedGrant?: RecordsWriteMessage

    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

Settings

Member Visibility

Theme

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

Type alias RecordsSubscribeReply

RecordsSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Type declaration

Settings

Member Visibility

Theme

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

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;
    tags?: RecordsWriteTags;
}

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
  • Optional tags?: RecordsWriteTags

Settings

Member Visibility

Theme

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

Type alias RecordsWriteMessage

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

Type declaration

Settings

Member Visibility

Theme

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

Type alias RecordsWriteOptions

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

Type declaration

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

    The delegated grant invoked to sign on behalf of the logical author, which is the grantor 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 permissionGrantId?: 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

    The signer of the message, which is commonly the author, but can also be a delegate.

    +
  • Optional tags?: RecordsWriteTags

Settings

Member Visibility

Theme

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

Type alias SubscriptionReply

SubscriptionReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Type declaration

Settings

Member Visibility

Theme

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

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.

    +

Settings

Member Visibility

Theme

\ No newline at end of file