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..1daeb6900 --- /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.scrollToHash(),this.updateIndexVisibility())}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&&(document.body.style.removeProperty("display"),this.scrollToHash(),this.updateIndexVisibility())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!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(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let 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 Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var 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..f07947196 --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WaTXMiNxCG/wtnVxy7YifxzQVe79rr2AFv5ZDKQZ5pQMUgsZIGlkrlv6dmGEAfLal15X370aj11aPh739HBn6Y0d1owgzMpDKji9GGmeXobgSiXevL4+8/Lc26GV2MVlzUo7vf/rs4R+7Eg1JSjWUNQbSlJQlfhAE1ZxX8wdYYxdGTpBcwS1lHMGcxzngQldpvDJfivllIxc1y7ZMQS5z3DPsJKL5lnX9WLSF8MsQS53WjMeEKqs7skxwxzrhvGrm7b5p3EEyYR2asR6oapjXoy9Dj8q6ubeKY1yFizOtUzIQZNjNSwVfYQhOGu3qepICtY5ROSxJ2AgndiUzMWAptmDBo7FHMMPoVggJ6JRX9ICpZAxI8CJnYYRKj4YOWJGxBmIc1NwZULPuhJ0v8KheRCeHIWY5+BGRcTlI+/s8W1D5G6MU8Y9Z+6ErxD2SBeYYU63P9DMiT9D+n4p52Oox62ulUzAtozRbI8w4CITa1qAMLgYePpCWmGG+g1lxrLoV+VOhS9R1E2hS+t6DTvMFDJm7lCsl8YEny+oMEnmE/4wuBbQ6+I02TRlayQebRSSLFj6WY80WrsO4FHhIxsjxdPUWaQiVVjfRsEAixE2gAOzwdmcCJ9MVWCZQpMOQUtkQCI7Fh+Q4C7S/FE+np1RRlBtXm+uZ2dRUiTlIq/h206c7/RxCgmMGO2cCS5PE10pvuV1Kdcw7lx3rWqnJcxPXNLXIwooSjmAX4h7TPwA5oF2Pv3ijHNlBBr32lobO8wUfBHqaoV90gWMuXwvo7qUXCtlA3GCuyLUCsvnYh95XhWzh4x0uoVlPQbWMdPma/6Yp23OaRf/7916uba7t6V8AMfFJyHYzFgRsYcsTTrH4Egz9q6CAz39oc8+TIMrv3LqiHI/FptwqQviFL7Av/OV8EpKOQI5yr7y9i0wad9GQ67U3JDSizjwOPjizze8uaT7wx9qIYYGcpS+n3HGsJfmaibhBkxEfid+VhUNJaXEsn8yKLxNfJvClsmnBUHJXG6guFZG9tRwEz2WPbUcBM9Pqs03inkmQCh0ki8UmEGQtbSGbXdxWyk1n2XYXsRLZdT46LL3vaiu+LLF5FcuiqZSy0e4glR32GfWb7DR0E5gszoDhrENhRylGGXvRD5mNsjchxL3sdTHjfG6UkdtfQUcCMrITQUcBEp4ivl/IehFFZaG/KkV8FvM7xxWVJOcobW3DB3Lr3ADkrdMa4VTrcSn09yztdX4ylqDk6spiHzp1VchNMQE+m0w63QPGjJO4sbSOydCK2UnpkEUVsBfThVouUocBb3k4+S66xvIV8plxjUQvdhR0xVa61uBVKoixfMZ+SJstH4GspGILrfs5GR1/Z6O9qx7vCCcy54OiuGTiozGnbwAyCM9aTqbT3LjjG6kUq6XzLmpiUCW95O7FpGTOWtxCbmDEjuYX+RQQ/lDFPGTeXl5J3NTcol4+SNzY3CC2iEEuW2n40vMIW71HIEVIdLenf8MzdZRFazPl6jjdlYgHj7mZbIfuJq5JY+PSzpCzF/hgRmXSYp4gbGQnMQ+Sm1ghiKaGmH7Zk9tgh6NoIDMVEdFbiLiK7+xSUTqzlKGCm02o5CpippJ50Io9wTRR3lraRTnDpTZEflk516V2RH5ZKetltkf2lL5t1z1XCTmfbtpRQ01m2LTmqfX2NZjcw5IjfBJcidfsVGHJE1polCMMr51PVvBX9v8n0pa27rNtfLAz8gKo18E00oPX9h1QGagyH+QLsP/8D/Itqu6MoAAA=" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 000000000..1ae34dde6 --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA829bbPbNrIu+l/s89GzRsQLCeWbYyc5nuy8nDiZXbdSU1OyxLUWx1qUIlF21kzt/36LAEE1mt0gSNHn3k9xloDuh3htPOhu/OfF6fD5/OKr3//z4mNV7158JVbrItPi1Yt681S++OrF28/1m0N9Xz28ePXictq/+OpF83wsz3/t/3732DztX7x6sd1vzufy/OKrFy/+55WXlmst817WP//Z1o0KetmXAfJevThuTmXdBHCuSrKVUL2OXbX7pTwf9p/KU4qiu7D8iNK7Dh2juynrTd18t2mSvvEuKH6b5vJTWTfvm1O5eUpSHZa/TfdTeT5vHsr3zeGU9t2owm3ad5tmk64all6gxf/rEJ8WQXO7wpO1Cn2dQN9gpVXdlKf7zbY8/9X/Fp2PYqVML+1wLOtRSS+7UjTuHhCjYrs/nMtxHb7YPCWb47Gsd+Na+nLz1DyUjS1yHtcEi85T9selPD2nqgsLz1O4K/dlUzohXz+/qRLak6oyd5iUm1PKMHHFJigJNzOH9buy+cEtQWjy4p9HphIj+5fyuH/mJNsfZ8j9P20Xx1DDAnPl88ivP8+Q/f7y4bw9VR/Kt2X732NzwFszW+5W4yIueMzY4OEzm0I/cufAuIO1JwIa3aKbx8NuFqi+6tKI7Ej9tXoqz83m6TgT20DIsijvq31Tns6zwF3r3oxpZFrFlgVcaOEJBaVOnE0eNdP0m0vzeDhV/9401aGeDOIOV58CacziTFzFKFhB3dswjQwKfi0Pi0xfz7v6x7Zl//em3u0HJy2u2CKDj5ObNPwo7BFTG52osGHifk43uM++5VMkvoSlY5/kMDIqy6eqSdLWFZytKHqYgIrGzxNxRfEjBdSUcKogVIUjvpt+tjAajfCnW0f2QNbYaA5wxffYRFV31+LjKkeWyKqummqz/+9TNaBCWPWozhwMuPPgbKfWw8HvkxbD78q6PFVbevcNf7x1eBDSxgYIQjd1L+M1puxhqHZ8sMR2+giMtB1+DEm8U6lBQ5RYtnuvIqf1sQPLNPK52TQXbMiO6L3rKyWrH2/grvT7w4lZT9tfFlpOe1GJq6kFxfOM5ZtTuWlKfI5ilN2FNUYVj/Oc5c+XD/vq/DgJAaxzK4aRQxsHI/mYFkUCjTNfEKzflEVAFIuOrHAPIxkwTuTLCPtFoWWUssYNqzdu5MRVR2dSsvK7xMkFazvU/Crx8+ahqqkN4frDrWsEkjS2RABEXN9dTufBPkpruevLjikbmZH7Ctr3UZW+6HSNuHM6MvB82Tff1M0Jb5D450lGVTdYeI52WGCufGpzxz/fJJtqHLLMQtsdITRx40OQ48s/vBtI1H8XVJ0AJW1DmgtnUSxlvT3syt3bTbOZjCesuyCm02mwIiWg6WrdhANPjm8tHYqwuD/eOvyBlLHx3qGIMFx/XDZ7Eiv4ZdKq8FNd/nRPSgS/TJL4y6Z+KEmJ4JfpEt+0J+/TcMsNf7y1swhpY52G0HFc/emAfR94XXdd6RSFY04fh3Sttuw8nbyF9CZud7ifl7OWgLx0m6nDOHVjiWlN2VMG9eNd+Wmzv0z58DtfYa520rL6yZrI+KwOf7q1MweyxjoywMUxDIdT8/PpcCxPDWkREvruUJ1x5SMd2Mp7W53KLXFyiIKAlW5GQRnlrPa4WT5BK3n8YNWOHEDiegdrUXl6qs7ndqAf6l1FDV+qyM1rEidzdF2i8DLNemz5ky15FB1RfxdWTYcypcHfbw+RdrG/TrIErnXP3502dcO6bPAFl+tWUnJ65w6+YKLXRhqQBLeNiKAZfhuJsEYcN27AFCUBk9ElcoKzcR6vFX8p/7iU5+bdzJZkJC2MtyVrv/nzWJ1Kfu2MwgwFLIzuoS1d7r6dug54cEH9L4PtV2yIT4P2K2+b34rsa2wQTUP2NW8bzR9t5b58IC4zUscaqL44siGnPxEbFLAwunN0v43i8lUXRrQdN7misIL6t2MbMyhoVpcpNdd06ZbpFONlUHRB84WWPcGAGX7HfBMmCmaaETMUdZsZE4eWbshMx5VqyowhnG7MTMWasgHHUU7bgmfii23CSfDStuGZ6GIbcRK6tK14KrqkLS+Ob+KmNxXhyLYXx5a88U1FlbL1xaFN2/wS8I1vSqMbYFhu/hb46fCRj7iIlFx0AyRET9r/0Efcsv3xUKbufkjSrZtfBNiUvW8iqvStL4pvzs43CSk4fVvTMHaKj2IlBS2AdnQSJsx4UGzahD8dmsP2sD+76NHLKTLjI0VvnvJjskfnfOw7pk76RDApsz4mas60T4U2Nu9vwRWf+OkIU2f+fKy78t56hQ/NolSUgYQl8HET8O0Y1GuBpSYbkpg6xQBSbsXtSk7SewdqpQIYW/kZd9cxIKMer5ORWL3TUPgqCyE4N6fLtrkM0hyMoIDV5iO5eVBecXTC/5JNBwQ+Znw+/hrpMfvbUrPwKix1Ajpo45/wy2Vfvi8H3p3hr0t9BhSX+iEeIDNk/1dZb0/P5KmWV3r3z6BWEoCRqfO/NlvyjBgDca2yCILTYT+h4e/+2ZVfRPe5+vck3V35mbpvG3JOe/oaEcK4c9/KGT7VpGEYALlzlaeDGTPGNn/egMlWXgITe6qwbiCkpyFVZLFTBJaZfHqAeOcZN5zudPMmkJDe1L31yZwWuXLzjouRdCJkmRu0UG72RIlpcej9HsF4nA0L3Bx7TkscjTofIuXCIPcPh1PVPGIn1rjiO1gtFUJa9G4XWvn3ckukOoiDYiQshO9j+fwNZ1qMAMNV5yMauFCX28Npd35rcyLRM4sqMs1N2wmITF6ixGwN1MQd/H6bdCpChi40R88v5WYXbSZQ4Ga3dlriqGv7EOmMKOm48sRIaUJI2q3VYHEYgZMQP56CJdLpkZHb/zxnQI0nsuILLjTA5qayinzBRHo1DUgCuRoRNINaTYQ1QqzegClKqyajSyRVZ+O8J8OG0tD1dW/HNDbBosv2pJxWY5oia8UNiZI6CTaZydhigQottFBQUhMXCYx63gIRAZC+OGAh8xeGGJy0RWEaFuacmYBm9KR5E56fN83jfExd7QVxncptdayG2ZUSQMGqCyI6bx/LJxzDmwCnr7dkr9nagyvvlB671lwQT5s/eRimlwDnWnFhNO+H9GYinPcxonMuHiZHTBqk0XQxM1fFFNMkvj5OM0smjnHmmi9lkI9e9c3uRy7XTmJPjqfdmT3ivz2cnjYzlsug7m2YYuZO1HSDJeKGTnjyLeumjaS7Sr2/1O6K5q/w50k22uttU30qf7VJ+N88ltuPLmcJAs6UutVKi4kdM9M44JyddoYVpuO4GwiYBGuURWg2FbaSUlD1FW9FI665JV/v94fPr/f7X4cPOXRa/josEh0KOrsOuO2hdlfY4CQwIvZlWIf51CFqOOpB7kxmKIyBSB0AURwgfRfRvCDbVGLLpnwYLzX1m8hvgUMGWkO+Hd9Uu3To28PT8dKUMTkvgzI00PY3RsNxczrH5YMSk6V32N5uHn7+8KbafXs6PH393ADnC+5rqBpLaEdJe1PUj7yEEupPndJA4fgcDlXAAQb58IEO+GP6kLPdPS7rpS8XNRYcMK57rEGboKovOF+Xp7nLt11wYoJaqs40BLnIFJ+QitdMpaBqzru/VOe/VPVj2dpJu+n6z9VDXQ6H4lB9X3BJ7a41k5v9C3z7pnUP+3nzvD9shssd3Qqoym2I4HhsDn97/9OPCSj6gjfq5i/b6JQyRImFyMfJCWYosDcdZ9nEJ1PPshMysMS4dRZPGqk+AUV7+iSy647hANWWQnLkkniOYQkqLoUGLY1pSIhl8sY28Y5ZQ4/A0VYJqy42Xnwovw2KmTpqcOUbUMETwtvBq27AlO9/TLd4uNcJQlHxtwmumDhjh0vei7TEU/aOqjleyAMOUuJKzVTxUKaocKVmqnCPhyVo6QvO7hXmbbFBr8QeF6PVoKcyfZmfLw3JJQ0L3LrfMhLHtlsC6TSKPa53nF4n6o+SjH0dm3k01rx9gcWaN5SY3LxXpDObl9Q7oXmv9RNuUsjnQxOQjDwjmoIFnHffDqF40/n6U/rK3xxoNgLJenktF/uM2MM0zeGnD/8qt0NabaiqLzhX1z3LsmBl96PsSpq2xG8Lis7Vt7scbeK8Mn0svKTrTECQSutgxSnsDqkwGPKhyV7Wlyerafw1jOy6hHW3h6/P27LeVfVDTNxLojCLffAwxkBne1mUrjQoPUdrf7uW9q1k8Zv0Jn4vXT5Z82AHLE/Vp3L386n6tGnKv33+iBdr/PvN+x8pcHT7G8DkfD8Oh+b78nng3hBVewdrJQIYPQLZkjZh5mP5NKkV7ojKS6MifHZSMUUddmYh6st/X2K/uQRQqPZ8XMBi+N87CMWv0/av6XaCQ0d82lDeS6Is/SEOWVyjTRKbphAUTdOXuqcBVSnbGVZz/abvy+e33GRyCyRRInV/e9s7MJwThb4Mq9BfQ2GmV/+OgHlzqJvyT7xbsxiG1RbCESwLiSCi60EyAvvbJrkXrsVn6YWHg8/10CD7HE+pkHIh5WWM3UO1+pPYn6HgOOnDyz2eDtvyfMZuNQMFg3KTNX3a7KuWBma8A3pNg3KzNXVg39VN+XCqmuEaONBJ1EjRjsbQm3aRY77R/xZflVAU79vuRG5dINokdl+X37g3XUZVvByrzn5f/xUzDjEYRNIphlSJmvab4MkZoM/+sIivTCAsFbnDxfRg29SjanbRSYXlDxvlDVTSnRbAT6m74Gvg7/a3z+cf2hxSw2MIFvySrRb/Igt6FMfVV/BNtfuhOj9tmi3emuKQOAkLoKsO9Q+HU/nr46b+qS7f+yvfHw/N+8vxeDhBb90EqGnibsHdx+q5//nx0Pz0GV5dxUDydRdB9OOh+c7n6Xwd3vYnoSLrz0X2pveKastsJ3VovO7tiH647JvqcXN+nImKqz8X2dtq94ONcpmEh6t1A4pWUnNKWbFQ4dt0/r21HxJV+rI3aPylPB/2l3bEf7up9mktTdSZi+CbndA6W7+rrdkEiSJOP1Vjtvb2de5vnqqmKU+O9WyXoWOJbAMWylj1m3Bdo/rAA/C/1dXTcV8+lXXKrEiXMxepfVl5s//b5/Pfy1N1X5Wn78qmP/7/eGi+PVzqcaDJYpbD2Q2gflucgZEQMRtfu9cEG5D9i3slI6H9xqovjCvVlhutvjAul590dntdqy+H652/x0+2NtNkLIfQbZw3wBsIWA7b1Qz79nBCx/10gLSUL4Ey2dhMFLLw/Pjx0Pw/ZePiCeZOEiRjLkJLzb4N6P9uPR0FFq06F49f15/75fy3+uwtyTenT6OoEgTMxfau3pV/dp/oXmj8e/ue46/wHoyDFa+7HKL31KuK6aDepzywOA0XFPmu/qF8OpymIWME3ISt2/rsvzcf9uW0JovUvmHcvy1bzujn/aaqnUdE52SeOh+TRMzF1/Go35WNHy8JiJhKczH83EUdTT+9x2reimbeyX2s9mxUKGn9d/4dkmTDIkXCUuh+PDSv39L+xKnwSBFL4bPvYXb3cO92r+td5CptHOqYtEVRuzu0n0+Hx+pDGxHybVXud/gGLhEzK2spxL/VfWDVzGFASVgAXffSglvvsc4pIMcELYYVNoT7y3SYpIzZCHu3h/c2OOK3ut0yfz28LXeXbfl6kMWSRZks58sgDR2P5qEccUOagfBq2l5OCYeJBAHzsbnFLLxV2HZnqu6mMgFgmpQvgLLNfXxO5somCFoU67t6ezi1j4+/Hab2mISVFvRlsPab3o1QoZwvg3TaBj9F1KJ433rv5Ta465dBSqxJgFlZC7ewO8yFybImtmwo4kvgSzrMJwhYFNsPrdld1Q9dBx1Ou9uWqai8hZH/2fqppB5h02Qsi7Cqb0eIZSyM0BqNN66hhJQvgRI/QjIH41XGogh/tvX35fm84Go/LnTRb2htoCAUeBJYUPsLtKxfQ954B6uqfnhdb8tz66TzuAHPacxo4RThy35T98fbVlpCyqIobYT0f1fN4+HSzB8XhJRFUbYy/dy+zVZhJN2KFrzl5o2h162D4Lt66nqWIukLoG3bZRGwWNByWPtr+n+nj1Ku9uKo3MGtG1k/3c8HOBT0hbD+dD/jVJ0m6wshdu9YdMvMm9CvfiZwWuQXwv/bsXUoXxQ/LXJx/P1S+dO90zsfNyVqebxu+XFHk0knsiRRy+G1G+dN83AoYTl03dGuPLfG0tvy2Dx+8+e2LHezgEaFLYj5sC/fHix99s2f1bl53XxXfSrrSQZ6qrTlUEPCfAZMVP1mXHZQzcNEVZ2Lp3+/yL6O9OPB0w7f948qtZ5AKbb1FEk3o223lMDoTHTJTRBwIzbbOW6bcO/F9fHirY9EKoUxUdgSmO1t90KQx2XdiHjocPXmUO/sy7LOF9af7Lrb0FT0M+T+X/mSX8o/LknurXOlLv4Vbor5NcteUSe7N8wUuvg3uNxmp94rfOGvSRW/+HeFTg63fwgr78sg//HQ83c3Yg4lfRm0XsFCzUyI+7K4W0NsYexI5JfBn3iLlSjkZoslzC7xW/1+mlNAupwbkfqzb8fbhmH85cNTCi04SdSNeFEmBpxzYPLFzGyxC31HOzcYbVMXvWkil7AhncnXk7/Ouug8b6ty3LNtmqwbEbtnI5vLqS6di+cxgZuP110A0Q2nGr76jbhuD6+bIGgprAuNxQnybkXuMqowM3XadpYo60bEf+8SePSZO0In39f17t3OcjplPSGo60bhS3/TNdKo3jmHvJu/JCryRvz2NabXTdNmQvcBcVYpleAg9QumCv1S3zAvJ8VcqV/qKzq7qIv7SA5rmS12ke+Yvy1F6i+BzNFjfmULE8KnIKPrL4esdd18Xe/euscSf7g0l81+//zNn9v95ZwSWzhH4rLo37Q2/M7nM/L63tW3fcG41OW+ovdTCOM5lviUCaKX+B7f6XPWvmHdpRDZHpwLCVVeAtN3ZfNN3Zye3+1+q3flfVWXu8Rg41QpC6F8V1dNtdnb/032YkqTsQTCd09PlwZGT7553NQPE5f+iJAlMM5f+b/Emt/JbMf1u/rnU/mpOlySzxpRCQui6/LQ3Q6SE7RwS6J04RNbcSxx+BxUU6kYpu6S43/S+ZCsuQQam5nsdb1zqSNm7QmsiCXwtZP99dmq+K3+WB8+1zM2hoiQJTAOzovA2p/VookCvwj22ddM6eK+LO4fD8272u0R77nX6G77lLiGL/J1b68Pky/TL7TAL4K98yZp77RnGsLJIr8Ifvdja1ROcP6ZI3EuerchdFoOJ/e/ydbpWO1FUHUkQgqFxdebjaTcHoXOP2Yu4VpaGkKm0lwM/VuHqe45RIW5un877UHMxI9tWOo+aRBHKi6LpT1tzETTVb0BTz/ip7UMXW1JHKmtwlWchCXIldxnZftxM3g8AP9sYYTaIpkfU4S97IuyXxACjGXXSdMICt+iE2R9SFIblr9Js3c2TdMLSt+itdvlknRey07WGIzNLhkuOTCvv6WOyt5feFTYS1iU/QSAjtbHxDgMlI0GLoxp+o4KWsJqvosHJI3qoFO2DLSMJWQZ0xM+vM7q8cVm62lv5MfVdKVu0PLHpTwntNu14A266HQ1Q1VjKWnGNFlTd1yRLzZbz9vw0VJW0duRN0vHNfWuBOPKYNGJ+sDTDY6eGz620P09uqYFb3t82JzLXP122v/KvLwIJb4kStPf4PGNa2VeKuTUjrxWOKa3Bf3r4Wsvb0TtsPQtWlEi9ZjKkTTqafqSWhYVnaXvYGsnDSBcdJa+s22d5G6kit+md/w7cdFUfamPqgTKUt5UGaoKlhNrRkM7oFfkf0lfUo5tiMiIoJe+EIO2x8PoYB6GQkpGnociteQiU+CxIOYdJ6ToiXjGqTnv/lKd/1LVj+WpCyiZovkc3noxiokX72/UuwlJc0bvZsiKL/C9JAMb+XKWT52MJXwZ+G/vf/pxTH9f6hat4YOhfZmfLGF5XWLce4345+iMTHgulJQ39lroACNYUII3mmxC4wka7/oaaYpHHr9E0ydBPzGVbtDfrQg9NzcFCVF3NqbBIh8ekMLBbX9bZqG/ikpa6h2qOYs9UJS03A80TVnwgbJ5S/6I9uiiD5TPWvZHdEcXfqB71tKf8N0Jiz9qgRuW/+h4i24AAMOsLWComdoEXABhZBuABZbZCAYS07aCAOn0xZjTmrYcB7XjC/K9dfJPbEwP4lppIRSRbZEFkbQxTsCQtDWxaCZuTiO4BtvTkEkJp1//+zLbVCguaau6IpyzXSGFSVsWqXHKtoWUztu6ElBEty8EYtYWloAhuo0hDLO2ssR2SNjOiBa5YUsbHZfRbQ1hmbW10Qio7a0vGdvicKFltjlSatpWN0A9fbuLaU/b8gYSFljso6gmLvgT8cW25SistK05AU3IqnfOQhTh1v2UvvFsyrPQ+Zvm1FUeE/qSqMCyeR7omO4ua0+67muFubrLbVWee6+Y1I/nai2DIrUZuFpTUISbQXX+5thGaJ42++/L5/bN2FN5PhNPjWMokYoT0ExglAPtiaTyUCE1nbh3JogSqdfxr/14TRT5ElYY+5wrXtpBJRgkqQAGteagGOynfel39fHS4HU0/PXmHZQQN7p1IoDMPrAZjJBRlXeb0VdHcO34XlS5cJsulPHvZTBPxuEw1ZdA9rF8ngDElV5IL6ow2KnjOIjaM3Hhgf/9QDhCNixw6/BnJI7NAAIp09w7FNQ/Sf8dUTsV0MgwOPpHiEGWlSRIYcWl0czEshwSbtEaQTK+biUhAYYr9CEf7Ozwx1tZk4GsEcokADaNLxmqGiFL0nV9ezo8JevrCs/X+dAHmybovBb+i7hJa3WG0aMJmsMKN2p/KJvXNBFDfvJIkFV6z4Lwp+QODuvcigBF+ySjGNa7qfUndv6wxnztn+wDwN/8cdnsq+b5p3scJVwRzjNDRGlSbhuhtuMh+xAfpKD4fL33ZbN97Np62rL9MlJ1Gp407ngIgCKOp+tjGNqhOoKena5tlIsd6o0SsdMRHD5TpPhQrS93sy42mHFEd3KIYhqW6mzXtN3XfX6npF2IqHRr/yc1/wj7ymgL7cEJC8pmkdWE4fSH6ghCf6qu0lmk75+fnsrmVG2vFiq0xXkIY/XnI2u7LrGHb9bTRYcnqruW/r9uP/5/aT3eZkd55tG+8J5kLBBV5uvvI20nLFtUnYkIQnojSJtAXpIRJW4lODiRYwwHBZZZIk+DF6iSVN+dRt+boiSMEAk41UcalONYlo/5SIKHNqahib6qMR9R8KzZNETRt8ymIzqHaVDSsJzjGVCmozh1AfnTh6+vtlgP2arD9MeJnTSovRSu3aaZ2ktdlSURvKmmtsi11pI4ggfX0oFEX1qbhcTn8JgOBtRcCs+IV8IYqGSXhBmzyj9qMnU+gXpL9trPM/HgukuOafTuefqoHnnnfMaeQHnajO4J6Qe9xDYJ0hdPbRdceSlUmyut6bjFVAOyv6agBCyFroze3Y1BG9ZebP5f8yzYDpm+sVICbkCHDwZv+ksJ+lgw+P3WQwEtcOxIMIQZNai6tHWIiUwAcEfXTwQ13ZSJg4kaMnO0k0vtOIaRhXYqEm5TjAMZ3xKn4hgxG+Jwko2GGf3EbtOjXZWwSU/FQ26KcSAjW+LkFoltiCNNkrYdTkU0uhnGUU3YCqcii2+EcVip2+Dk+c4f/kemfMrRPwFNDtrnz3J7acrf6n15Pr/+YB9E6jHdX2r7DO75r1SxuCshcJ/42+chyfi3z/GdE1O031dDetbLeNn/TrdIq5+X7Ebc2xH5sNRkLe6ylb+07hUNC07WtSvbTAQ/7zdV7dJOcLdUvdJIjcnayz+b02bbRFszKDNZA7zO54fVS1zsJj1pahK1pHoMX3UkuArjDxk48/2wacpTtcFkLPhlAfe9QFSC314PivePpFziKDV3H8e84Ppaoz6ZP28qvL9HtHalZ+id36hebyfzL7y78xBAjznq//e3zx9nQrmDAqaCGt057ft9t4CDEm5Hh2fazxzA6w8j2x6Sx3RG//fkTRgf/vwy0/09fTP+1CXR/du584TdRGW+JMvTLe8xjm3WcYWw2Fw9b4gNDCuJsdkjGraHp7boqJag3DxNzgcPPiI0opKscINu3uwh9I6bPuN992P5uTw3KeP9JVF6rtaf9rsJWnHpWVqrcwt+ZDZcC83U0UId1eELzdQx6smE1CU7MaXNwx844iM2KYlKszD49bEf+u+tsTc6YaL1UpGkGqOoAcYN0qEqYjMiU6KB3251p8eiRrzpIappzvQDRSO+9IymNMfRgbKpCQeStDOOfQPlExMNJOlmXFgHuicmGEj+7qh3J9kCsxILJIw3xgFxgGFiQgFOc2h8glL0ZciwwK2HSEbi2FmSQBrnuN9Uu8SPQfx2VzEVxhwueQTICJk8GcMI65/WLMm7YBQXHoC/1e07O67iL+Vxj0PSBr/HNww9yEn/vjmAbbbyWc/7r7a/p+9Ch2NZJ0l72ZWMNpUDx21E+8M5DflLX3S+MkicR1XFWPIURQ9loqKHSLr0FEV/BGn6oqr+iOYyT1G2CxNlR7Xt4smy04ZGuTmlDg1XdJoyZh7hPYLRnLJTDBZJQFwmiH3ZVxn/MGK/AIbqz8jdYLAT4wK3mqykvBG7dQBymvFKqxyxYFN1tk+pk7eVce24WiRectrXt/dioAZ+ASClTVgRt+Hrz3PbwzG1k3Cd/1/01e04vLd/KgBQfrrmtEMXrXnqySsdB3P8omFMPIOlo2AOYrFu+EJtET2S8a0y61yWOk6ZwxmNZuIJLYoB3RGgovRZjSl164EtJnbs1MYBn3dQSUCSflrhhI27Kn3z57E6lVNaH7orXWsviqtss7QdA/J/Aq6g9pK4Htqi5e7XwwxUsO4XwPQ1PmtOwPQ1f1y4CdO3g3xJE0B9GyFr546qbtefNaaudZfEBNyDO7ts4ECQAo8RsyTSc2DmpUM7TzL1EtMmH+pdNXXT6PMnw8qLthBFjiU1UZwhS0dDHwQTzgxdkQUPg1Bi+nHQQ519IAzUph8JCb2TzexA9Q2G9iiWcVM7gDLf2B5FMm5uB0jmG9xJbZJqcg9a51aje2TUjpvdAaL5hjeFgzW9u8KjxndYbkHzmxA8wQBH8G82wXk0s4xwJG4BczcCcKLBOwlbgskbQTbJ6J2DK2b2juNKM3zn4IqavuPAEo3fSchGDLgIqGQTbhKeFCMuAmqaGTetpUYMuVhTJZtyo4g4Yy54lpXcTNoSi5pyvcAplpzFeYMhd1U6xY6LaU3iaaHiSUTtUPcME/Kq+yYLMo4kxYC8ArnFfozjSDEfcWd8qfZINx7DlrnddoyN2BTT8YrnFstxgCJiOLZlE+xGUGxRsxHLnWQ1QuwLGI0Mlpk2I5R2Y1x6EsoJwekzcY5vpRy2KTtpHA/cSF1Uw/flM+OYjwtEB26qMyopNMkrdYA3KfAorjceeJSqcZjrOq51PMl1RPN4dj9aaTTDX+xLgyHjYliHsXv9L+m2ls3JXr6ud+9qG7hoo2KCxIdjal6mieA+2X/LnEEcwEgbvUN1ZNO+OdT31QPlQT4scrNhS0scs2yHUCeatozaMds2qjfRwGRUT7YwJ2DhTEwGylQbcwISzshkkEy1Mie2SdzMjLTOPDszedRyhiaDaKqlGceBQxJxYcbW5MrdbGxGBY9amyz8meZmCpoJ9iYrboyjvLcP2gwpyiR8QfVlkdEmZhKqMRtzJqJx4zwJ3RTrfAJSagOmXwEPf15s401+CxzBm7nhpr8InqavbpMp7at/l9/aJweTFA/r3IIgwmMRuhNILFbrRAPjhvfQUzGMGRbzX0VPRTBmUMx/G31KG6QZEku8kJ42JscMiPnvpEf0M4ZD5LV0ssxiBsPkN9NpyDcaCre/1U2Lim969+FqmIrpfsqCuIRBMPeF+TlI0g0BFtUcIyD9kfUu5eRg2nZ/n0Js0O+pQkEvdyPPp3o0bPB7Rzl8Xz6/7R+3C3Kkk2qj9RZG8tu5qh/e9ikXz+jhvon4WGlfArUfPu0fFoBNivuSuLvk5QtCxxK/BHqXYWaJcYIlzULr2MUrNTo2oQelZ2n1YUGv6215bg6n78vn1/XubXnelvXwa88/bJrtyJyfKXEW+oey+dkW7caLTWV4P8zETwIdrzwL09ghJcCQejoZH+mfylOTohEXvWnUhNFcv5T3ZVu/2uzf1U35cKqakVE8Sc4spOfHw2W/88vKa/b4FsDiK83C4Aytd/V2f9mV5z7NbIoF8HK07gKIfquPN2Aia6eiSr0CoVfj8Sfp4sbX2zDaGilzv97KvQyFpT3U2mGbxrwQytKeah3RlvgOVKB34kNQcQTJL0FBCJOfghpimPQ+I9Q9lYRJRBB/Qw8CmEjBJOqPvxg5bPwv8f0pDyrilphFvySNzPi7fxDHRPKF106+T+bK0dQLVeRW5oWVmfhEWYiXOcXH33hidSc/8hRKuCn5zSimqU/lTME2/kYYj2vKI2FTMMVehOHRpD0JMwVHypswPJ5pj8KM4RqaIL+U/CLW/raQ+dGLSjM+LKpZpsdVUZrhEdOUvOlflU7e8rH+SRv+Ve/M7T6uPb7ZX5XP2+rjuuMbPW7w5b87ZZMPW+CWLT42CuMb/BXDvO19oJnc3NtS0a0dFFhoY8cSE7d1iHTKdUVc69hdBVF7ic2cQzN1K0/HFds0OTRpW2Y6htSHtzg809/dmoBt1NBhUU0wc9LxpBgXHKJppkUc09CweH/50IYmfmA3r77AQiZGKC/NzriCnGVsIJVpFseozmSzA6mfbHuQSCYZIAjBTCskAUfcFEEw5tkjCSjiRgnZHV+oLVLME6JVbrFRRsdt3FBBaOZZKzQG0mTpi0btFlxqIeOFFJtowQyA32RCxJBMtiMGwmb4haTgSrO2JqKJmTZRNGn2zUQ044ZEFNMUa2IishSTIoptml2RgA4YF+/L7VHo/GM2WGb6X9LNCX/7R112h+JehkXpD7pi48wXG7Dzffn86wE+k8OoHJSeq7W/o09TOyh+09f+7fPHXw9fPzfEpQ35vUH52754gmqiwkzdZIgaUheNTRvV4B7eGx2wvtRMLQ9lXZ7cOAjeGGPUDYsvo/eXzeeJql2N2dq7qLqEJQGVvVVjwtREZWdq7Dx3Uj9zWPw2vbx/Ea143MMoUfObx6r1qZimflgpHUOqbwFSnOJdQH4yyHWOQpxBHvKE2OZIeDEtaCSueGo0MaNkPIx4QvAwoyO+MmPxwCw5nJq31ancBlFSZX15Ov81+C3e8NcOdO5qu6p+GJX2MijLQA/wkRpfpyt8PV8fMOXaU8dgLrR/TDfgzvuyHL6A1ct46X+nQVoAjOSnqq6eNvv3IwpQsel62rf5Lqe2IP+i11UdXXq6VkdUpWgclpyr7af7+3OZ9JVc+emavdWeopUqm6QxdZkHH5iwwiMlcOK0XuH2PYj/Kj+V+4Ge8OfoZEqFTohM+giElNkBtjZwMVWpK3qLvg/7w/bjOXhOJ6YzKD5RL//kTkxj9MWdNF3hmzvRJo0+uZOmDT66E9MVe3MnTdMD8QofpSn26E6aJvQSTkzZyEM4qT0Gn8KJ91jsJRx+DoAl5JtPZd381+GBXkGCXxdZQIYSk9aPECYznS/7avftppUztOkJvWHxG/RWrV9pikZfcJqu8aWDUBVdOZI00QsH1X/RdSNRFzXkSV2xEZ+ka3M8lvXwqoRQ1pe8QZt9iMuWHHJPhMqw+A16H8omXSssfINOt/o5SV8/U+9EE7qpShPn4vCN1ohRNCiRfsj4cKn2OzKuOC78JVWR/sYh/ulLLANiwgO4sy01XnXMWEvWGrHXuJYfN9mStdPLPKM4vtTHdI4v94zK5OcZZyz7XMcmv9I42ZZjNKa+oTi+KKdqTH9KcY4VySid8KLiZHucUZn6DOaMjZwdPakPOY5asN88VU1Tnt43p3IzzEY4LLKcLTsUm27Qhqg5aot1n+L0wxq3auftTULxuNGZpDNieVKtPW5+Jmktn6rhXOGUdoVn6Rwk1T0f6g26Xe/+eqsTChSTkCHXAuGcASrsfEkIv9tF7DdfPu50EF4z8JpGMpim6gquNKPaoreZrL55neT1dfL+kiUq7nFyviaDC8Z0CHfH0RtHGsyo/4u/cp8FCtZeEBWXs3iAaDxFMTMQ4QVIeW5atuY7d4FNUca4RPqpxd+K44UmLvrlsBpDTw+wj+EYT/g6BomSsDQ6OhteKrL/EzUaJ6PqPKT+u/WGnIoJ1V24nbqkw33E/SyIY8IWwtym1bgFJlF/2f6dNeZQ3WUR8b77aajej5qic5ExGRPSYL2NH6+mz4bxh/bGl9nUt7lvQUc/kZ2OLe7IeVu7kW/aTGm2TsBC2Bwl+R1BTYxgghUXxTJreQirLopn9uIwrL4Qro4zmNNrYdWF8PiEPZvAGygREa78JTC996EgN4GDUm5EedrUu8NTL/B9c4KOSCPguMrLYJoDZVEEtAdzFEDch3mi/jcfDqf3jxuhc+puJ4oDV10Ez7v0rQxWWER3xJEohiDBpygVh3OOelvtfinPh/2lnYe/lOfLPrlNYgIWWmveVrvWGXveyRNXno4p2SGLaaAU76yh+n+86q6KvvpP66LfGicvvnoh7uTd+sWrF/dVud+dX3z1uwP26sX28PTUyvpH99vfy1ZhW8IV+evqxavfV69ydbdSxT/+8ep3X8P+YP9gi2UvXv2evRLF3VqaoFgWFBMvXv0uKGkiKCZfvPpdvtLmbi3XQTEZFFMvXv2uqGIqKKZfvPpdU8V0UCx/8er3nCqWB8WKF69+L6hiRVDMcMVMUGz94tXv5pXK74pVFhRbh83btvb6lVJ32qD2Rf1gO2JFKc7CrsjaJs8ysmTYG1nb6pkgS4YdkrUNn5E9l4V9krVtn6lXan0njQxLht2Stc2faWrQZGHPZG0PZDlZMuycrO2ErCBLhv2Ttf2QGbJk2EWi7YhsTQ7usI8EO1kEmi12uqxeqeJurUVYMuwi0faDyMiSYReJth+EeCXzOy3DISfCLhJtPwj5Sus7XaiwZNhFou0HochPD7tIFOynhz0k2m4QmlQe9pBou0HkZMmwh2TbDYLsdRn2kGz7QZC9LsMukoL7IImWNMktVjLsIGk7aE19jww7SLa9IMm5LsMOkjm3zMiwf2TBrTMy7B/ZdoLMyBYK+0eu2RYKu0e1fSDFK7m+UwVaz8PuUW0fSEkpV2H3qLYTJDkyVdg/yu455DKj0K6juA9SYf8ozY5MFfaPytnRrsIOUm03SHKNU2EPKcPCDDtItd0gyWmhwh7StofIaaHDHtLsEqfDDtK2g8jRrsMO0nYCrV5pebfKw0Gsww7S/BKnkWXQdoMiR7EOe0i33aBI00WHPaTZKaTDDtJsB+mwg3TbC4rcVXXYQfmKE5mH/ZO3vaAU1Zh52EF52wuKNJ/ysINy20Hk0MzDDsqt4UaOuDzsoNx2EDnicmS92Q4it9887KCc3YPysIPyths0ub7mYQ/la3bpysMeKtp+0OSIK8IuKtp+0OSIK8IuKtp+0JKypYqwiwrJfXoR9lDRdoMm180i7KHCWtfkulmEPVS03aDJ8VEgE7vtB02OjyLsooKdQ0XYQ0XbDZocSEXYQ8b2EDmQTNhDpu2GnDwcmbCHDGslmLCDjGSHnAl7yLTdkJMDyYQ9ZNpuyMmBZMIeMjkLM+wg0/ZCTm7ABh2D2m7ISbvHhD1k1uxCY8IeWq/YxWsd9tDa9hA5ONdhD63ZHlqHPbRuuyEnR/E67KG17SFyFK/DHlrbHiIH5zrsoTXbQ+uwh9YFe3RYhz20NuzRYY3Oqmt2X13j42rbD/maPAiu0Il11fZEQR9ZV+jMumo7o8iorne/wbJtdxSCLovOrau2QwpJl0Un11XbJQU5pN1vsGzbK4Wm5aLT68oyCzldFp1fV5ZeKOiy6AS7avumoI+wK9Rvlk0oyMUvGzANPOeDqYaMP8hmmGzI+KNshumGjLf0Mkw4WFqBGTqYcrDEAjN0MOlgqQVm6GDawZILzHDAxIOlF5jhgKiHzBIMzHBA5ENmOQZD7lqZwBRR2zeG3GQyxEBkgrUtMkRBZI6DoIcDIiEyx0LQwwHREJnjIejhgIiIzPINRpAEFOIiMss4GHK7yxAbkVnOwZCWU4b4iEyy5nqGCInMMRJ0kyFKIrPMA9NkElN7km8yRExkln4w5A6dIWoiswSEobk4RE5kkt3UMkRPZJaFMPRARwxFZnkIY+iyqNcsFWHodQ/RFJklI9b0BEJERab4NRIxFZnlI9b0XENcRab4uaYwI9t2zJq0/jLEV2SWlWDEoj6ztMSaYXpRp1liYk1PCURaZJabWNNsL+ItMstOrOkxhpiLTPNTDVEXmWUo1jQ5jNiLzHIUa3pvRfxFZlmKNT3GEIORaZZjyjQm0jU/JRCJkVmqIlvRYxfxGJmlK7IVPSIRl5E5MmNFjzPEZ2SWtchW9IKKKI2M5zQyRGpkubv8UK90drfSChVGXWfZi2xFL2eI2sgsgZGt6LGG2I3MchjZih5BiODILI2RreghlOOrENd/9BhCNEfmeI6M7mxEdWSW0MgyurMR25HlLKWbIbojs6QGzWxmiPDILK1B86UZojyywt1e0eMNsR6Zoz0yerwh5iMr+KmHqI/MEhzMpozIj8xSHMymXOB7rILflBEBklmegyZ/MsSBZJbpyDJ6JUY0SGbJjoy5eENMSGb5joy5e0NkSMazIRmiQzJLejAtjAiRzNIeTAsjSiQzkUUTkSKZY0WyghyXiBjJjJt0hlxVEDeSGTfp6GMyokcyS4Jkgp7OiCHJLA+SCfp2F5EkmaVCMkEfdxBPkq15wj5DVEm2jhiXiCzJLCXCWGuILsksKUJfBWSIMMkcY0JfY2aINMksNZIJ+myPeJPMsiOZoCcIok6ytes9eoIg9kSs2C1PIPJErFzfkYNTIPZEWIYko+81BaJPxMrd+jMX2uhSeeUu/levZHFn1rgwule2JAmLGV0tW5aEtDMFIlDEqojJRffLliXJ6BtMgSgUYWmSTNKeK4hDEZYnyejrSYFIFOFIFPqGUiAaRTiXDfqSUiAeRTivDaZLEJEiOscNcngKxKQI57shi1cqu5M5Kou6z3lvSPNKre5WOfZ2QB3oHDjaxWVovwnEpQjLl9B3LgJxKcJ5cajVKynv8hXyj8B+HM6RQ2XU52FPDufKoQRZFjtz2N5TkiyLOs+RKYoeFtijQ7AWi8AuHY5Nob0/sFOHZUxoy0Jgtw7n10Gz9wK7dljKhL7PFNi5Q8R6DvEpwvEpKichI0ZFSNd1BV0Y9Z2lTUjnMIEYFWFZE9LXQiBCRVjShLwqFohPEdL5S5H7o0CEinCEiqLnEaJUhKVNsvbOiSqMus7yJrTblkCcinCOH/Rdp0CkilD8loc4FaEi5opArIqwzElGX6MKRKsInlYRiFYRzgmEA4E6z/Eqmh7xiFkRKo8VRp2nXOfR6wTiVoTzCKHvagUiV4RyvUfvCIhdEY5doW9sBeJXhPMNoe9iBSJYhBaRXQwxLELLyCqEKBbhKBb6olcgkkVYIiWj73oFYlmEY1nou1mBWBbhWBb6elYglkU4loW+eBWIZRGaPaULxLEIx7HkjAcf6j/HsuR0KyOWRTiWhb4vFYhlEY5loa9MBWJZhGNZ6FtTgVgW4ViWnDy2CMSyCMey0DeSArEswrEszABFLItwLEtBjwzEsgjHshT0yEA8i7BcSlbQIwMRLaLI+BOtQEyLcExLQY8NxLQIx7QU9BKDmBbhmBbGNkRci7B8Cr1XIqpFFK7/6DGHuBZh+ZSsoMccIluEczeh71IFYluEY1voy1SB2Bbh2Bb6Wk4gtkU4toUZc4htEY5toS/xBOJbhIkdGhDhIiypkhl6gCLGRVhWJTP0AEWUi3CUC32LJhDlIhzlYugxhygX4SgX+mJKIMpFOMrF0GMDUS7CUS6GHhuIchGOcqEvnASiXITzTaFvnATiXITlVTL6Hkkg0kVYYiWjb4cEYl2EZVayNd2DiHYRjnahL30Eol2Eo13oWx+BaBfhaBf62kcg2kU42oW+zBGIdpGOdqFvcyQiXqQjXujrHImIF7ly/g9kD0pEvMiV4zxp32pEvMiVu0one1Ai4kWuHF9N9qBExIu07IpYkT0oEfUiV87diOxBiagXadkVQV+mSES9SMuuCPoyRSLqRVp2RdCXKRJRLzJzV+p0DyLqRToPFvoyRSLqRXYuLHQPIupFOh8W+iZDIupFZs4bgu5BxL3IzF050D2IuBdp6RVB0/0ScS8ycz5jdA8i8kVafkXQ0TYSkS/SEiyCDriRiH2RlmERdMyNRPSLdME0NH8uEf8iXTyNoHsQ8S+yC6mhexAxMLJjYOgeRBSM7Bxa6B5EHIwU7taI7kHEwUgXX0Pz0RKRMNKF2DCRMzjIxkXZMMEzOM7GubXQJLPEoTbOr0XSPTgIt7E9yESo4JAbF3ND87sSR91IFxdF9yAOvLFsi6D5XYmDbyzbImh+V+IAHEu3CJqylTgGx9Itgg7ykIiLkZZwEXSch0RsjLSEi5B0DyI2RlrCRSi6BxEbIy3lIujoDIn4GGkpF0EHaEjEx0gXmKPoHkR8jHSxOTQVKxEfIy3lIhTdg4iPkZZyEXTEhER8jLSUi6CDJiTiY6SlXAQdNyERHyMt5SLo0AmJ+BhpKReh6R5EfIy0lIugGUCJ+BjponZopk4iPkZaykVougcRHyO1i66iexDxMdJSLoImySTiY6R2UYp0DyI+RlrSRdAkmUSMjMyd3wTdg4iRkZZ0ETSVJREjIy3pImgqSyJGRlrSRdBUlkSMjLSki6CpLIkYGZm74Di6BxEjIy3pImh+SiJGRlrSRdBe/xIxMtKSLoLmpyRiZGTuQk3pHkSMjHSeLzQ/JREjIzvXF7oHESMjLekiCroHESMjLekiaMpJIkZGWtJF0JSTRIyMdN4vNOUkEScjnfsLzSJJxMlI5/9Cs0gScTLS0i6CZnsk4mSkpV0EzfZIxMlI4+KF6R5EnIy0tIug2R6JOBlpaRdBsz0ScTLS+cDQBI5EnIx0TjA0JyMRJyMt7SJoTkYiTkZa2kXQnIxEnIy0tIugORmJOBlpaRdBczIScTLS0i6C5mQk4mSkpV0EzclIxMnItQv6pnsQcTLS0i6C5mQk4mSk84OhORmJOBm5dvHfdA8iTkZa2kXQnIxEnIy0tIugORmJOBnpAohoTkYiTka6GCKak5GIk5EujIjmZCTiZJSlXQTNySjEyShLuwiak1GIk1GWdpE0J6MQJ6Ms7SJpTkYhTkZZ2kXSnIxCnIxauSB+OpgdcTLKOcPQnIxCnIyytIukORmFOBllaRdJczIKcTLK0i6S5mQU4mSUpV0kzckoxMkoS7tImpNRiJNRlnaRNCejECejLO0iaU5GIU5GWdpF0pyMQpyMsrSLpDkZhTgZZWkXSXMyCnEyytIukuZkFOJklPOHoTkZhTgZZWkXSXMyCnEyytIukuZkFOJklKVdJM3JKMTJKEu7SJqTUYiTUZZ2kTQnoxAnoyztImlORiFORlnaRdKcjEKcjLK0i6Q5GYU4GWVpFynIu1KFOBklnEcT6WaiECejhAs5p3sQcTJKutQadA8iTkY5xxj6Wk4hTka5/Ce0q4lCnIySrgfpsYE4GWVpF9mmNyGSYiBORrlUKDTboxAnoyztImm2RyFORlnaRTLJRhAno1xWFCbfCOJkVOcfQzreKJwbxXEy5P21wtlRuvQo9LKBE6S4DClMRhGcI8UlSWFyhQzSpLgOpAcdTpWiXAfSQwNnS7Gsi6RpJIUTpriMKTSNpHDOFMu6SJpGUjhvikucQtNIClEyyrnI0DerClEyyrIukuacFKJkVOciQ7ljKsTIKOchw8xtxMgorfiEPIiQUc5BhvbTU4iQUc5BhvSwVIiPUc4/hvSwVIiOUc49hvSwVIiNUdp1Hj1JEBuj+BgkhbgYFcmsohAVo5xzDNNoiIpROe9MrxAToyzZImlmUSEmRuW8O69CRIzKI+68ChExKi/48YN4GOU8Y7imQH3nPGPo8YNoGOUcY+jxg1gY5fxi6PGDSBhVuMxS9FKISBjF511RiIJRzimGaQhEwaiCT9GmEAOjLMnCDExEwKhIAJJC/Isq3JJJL/OIf1HOJ4Yea4h+Uc4lhhlriH5RlmFhxhpiX5SJTTvEvijnEUOPNUS+KOcQQ481xL0o5w9DjzVEvSjj9jt6c0TUizJseiOFiBdlYpMOES/K8Nk/FOJdlONd6HGJaBdlmRU6klgh1kW54CP69kEh1kWtXUY3euNHrIuyxIqkbx8UYl2UJVYkffugEOuiLLEi6dsHhVgXtY54EyrEuihLrEj6qkIh1kVZYkXSVxUKsS7aEiuSvqrQiHXRlliR2pA53BDrolds7J9GnIt2AUh0NK9GnIt2AUh0NK9GnIt2nAt9X6IR56Id50Lfl2jEuWjHudD3JRpxLnrFJ4BDjIt2AUi0z61GjIt2jAt9D6MR46Id40Lfw2jEuGgXgMR0CWJctGNc6EsbjRgX3QUgURuDRoSL7uKPyI1BI8JFO8KFvg3SiHDRjnDJyRO4RoSLdoRLTib51Yhw0Y5woW+DNCJctCNc6NsgjQgX7QgX+jZII8JFO8KFvg3SiHDRjnChb4M0Ily0I1zo2yCNCBftCBf6NkgjwkV3hAu1tWvEt+guDonarTWiW7Qw7G6tEduiHdtC30hpxLZox7bQN1IasS1auu6jRxFiW7SMWC4asS3asS309ZVGbIuWijVHNCJbtCNb6KsujcgW7cgWw+TtRN3nyBb6qksjskU7soWZrIhs0XIdmayIbNEuE60hM15rxLZoF45EBy1qxLZox7YYepYgtkXz4UgacS3ahSPRYecacS1a8cHvGlEtWkWC3zWiWrSLRqLj7zSiWrSKBL9rRLVoR7UYMjBb4yy1XZpaerLiRLWOajH0KMLJah3VQofVa5yv1nEtdIiYxilrHddC58EdJK3lgzg1Tltr6RQ6rF7jxLWWTmEy7OLctY5qoU18jfPX6kgQp0Zci3ZcCx2XqRHbonPXe/S0RnSLzkXEUEV0i7aUCp0fTCO6RTu6hb5m1ohu0TmbZEkjtkU7toVOR6AR26Id28IMZES36DzWfYhu0ZZSYcYQolu083qhxyaiW7SlVJjxhugWXcR2PkS3aEe3MEMIES66UJEhhAgXXejIEEKMi3ZxSMxyiCgXXbjuozdVxLlox7nQ3gcacS7a8iqS9j7QiHTRlleRtPeBRqSLdqQL7X2gEeuijUscQtt8iHXRllmRtPeBRrSLNm7tpO0txLtoy61I2vtAI+JFuzgk+jiuEfGiLbsiaVcFjagXbSLJv1H/Gdd/a3KeIOZFu9y4KzJ2USPqRa/5LO2IedGWXFGrjBz4iHnRa5eqXdCFUe9ZcoUtjHqvy/zCwEC9t44cHBDxotdu76OHMiJetOVWFO2GoRHxoi23omg3DI2Il3zluo9Ooo6Il3zl1k86jzoiXvKV60A6lTqiXvKV60A6mzqiXnLLrijaDSNH1Eu+chn3ycUoR9RLbtkVRbth5Ih6yR31Qh+kckS95JZfUbTPRo7Il9zyK4r22cgR+ZJnkXu+HJEvueVXFO3gkSPyJc/4e74ccS95FrnnyxH3kmf8PV+OuJc8i9zz5Yh7yTP+ni9H1Eue8fd8OWJe8oy/58sR8ZJnrvPoGYWIl1zw7ycg2iUXruvoyYdol1xErJcc0S654C/6csS65MLNPXpWI9YlF+xDWDniXHLBPhiTI8olF+x7FzliXPKOcSEtyRxRLnmX+YU8V+eIcskd5UI7i+SIcsmdgwvteJEjyiXvKBfKhssR45K7N35o36ccMS65ZVUU7fuUI8olt6yKon2fckS55C79C71QIMYld9lfmIUCMS65JVWUIHmRHDEuuSVVFO1UlSPGJbekiqKdqnLEuOSWVOFgIMYlt6SKojNQ5ohxyZ1/C70SIsolV5GL2hxRLrnLAEOvhIhyyR3lQq+EiHHJO8aFXAkR4ZIr13v0SogIl1yxyUNyRLfkmj/y5YhtyTWf6z9HZEtu+RQ6WXqOuJZc87n+c0S15JrP9Z8jqiXXfNL4HFEtuaVT6HcBckS15JZOod9HyBHVkls2hU4EnyOmJbdkCp0IPsdvBXVECz2A8XtBzq2FdjfM8ZNBecRSwY8G5TFLBb8blEcsFfxyUB6zVAaPB0UsFfx8UB6xVPALQnnEUsFvCOVuwaT3csSz5AVvqSCaJXexRfT8RDRLXkTmHGJZ8iIy5xDJkheROYc4lryIzDlEseSWRWHmBmJYckuiMHMDESx5EfGMyBHBkheu4+htHxEseefVQs4NxK/kJuKJmyN+JTexjQ7xK7mJbHSIXslNbKND9EpuIhsdYldyE9noELmSm8hGh7iV3Lj8grRlhdiV3PAbHeJW8nVko0PUSm75E5o+zhG3kq9jpwPEreSOW6E9nXPEreTrSFrWHHErufNqoXmmHHErucvvQnsC5IhcydcFfweYI3Ild14ttMt8jsiV3JErtCt3jsiVYhU5mheIXCkcuUL7fReIXClW/IZXIG6lWEU2vAJxK8WK3/AKRK0Uq8iGVyBqpVjxG16BmJVixW94BSJWihW/4RWIVykcr0J7yxeIVykydsMrEKtSZPyGVyBSpbDECf2mSYFIlcKRKkwDI1KlsMQJvQAUiFQpLG+iaIf9ApEqRcaf7gpEqhRZ5HRXIFalyNyySV4gFYhWKRytQu82BaJVCufPQo9ixKsUXUZdupERr1J0vAo5ihGtUnQpdclRjGiVQvDeEAViVQrhOo9+rRDxKoVgn7opEK9SCN4Ht0DESiH4RwAKxKsUsYy6BeJVCkudMKMY0SqF82Shw5cKRKsUljpRdHBIgXiVwvEqdHBIgXiVwvEqdHBIgXiVwvEqdHBIgXiVQjoPavpJTkSsFJY7UXRwSIGIlcKl1aXTUxaIWCkcsUIHhxSIWCkcsUKHORSIWCkcscKsAIhYKRyxQscYFIhYKSx5omhv+QIxK4VyPUiPDcSsFMr1ID02ELVSWPpE0f7DBeJWChXxxS0QuVI4coV52BWRK4XiveALxK4UOuIFXyB6peicWUhmrED8StHFDZEEa4EIlkLzB4YCESyFjhwYCsSwFJo/MBSIYSk0f2AoEMNSaP7AUCCGpdCu8+iJjSiWgk+rWyCGpchXvNdSgRiWIo9YLYhgKbrAIdKzoEAMS5HHzBbEsBQuqy7tOlEgiqVwrzPTfvAFoliKPGK3IIqlyGN2C+JYCsexMOMYkSxF5KXmAj/VXEQIsgK/1tzFDpHjGL/X3DmzkOMYv9jc+bKQ4xg/2myZFMU824zfbS5YP6QCP9xc8C8BFIOnmyNmC368OcayFPgBZ0ukMKYIIlkKE3kIoEAsS2EiDwEUiGUpHMvCvHeNWJaiy6ZLDnnEshQmkgy5QCxL4VgWZsgjmqUwvBtEgWiWoqNZ6B5BPEvRhQ+RQx7RLIWjWeghj3iWwmXSpYc84lkKy6Uo5lVxRLQU/CPPBaJZisjTRQViWQpLpDDTA5EsxTp2SEckS7GOOJAViGQpXOgQM4wRyVI4DxbmiXVEshSOZOEeTw87zzgPFu799BUqbHuPeUIdkSzGebAwT54jlsU4Dxbm1XPEshjHstD8lEE0i3EeLMzj54hmMc6DhY6BMYhnMZZLUXSoikFEi3EeLHTiMoOYFuOYFjpxmUFMi3FMC31JZxDXYtz7RfTJxSCyxWSuB8mBZBDbYmLvFxnEtpgsYnIaRLeYLEJ0GkS3mCxCdBrEt5gsQnQaxLcYS6nkpHFoEN1iHN1CRwQZRLcYS6koOiLIIL7FOD8WOiLIIL7FWE5F0RFBBhEuxpIqio4IMohxMc6RhY4IMohyMY5yoaNxDKJcjOVVFB2NYxDpYiyxouj8cAaxLsa5szAjFNEuxjIrio7GMYh2MTLCVBvEuxjpepC8TDaIdzGOdzH05Ea8i+GfMjKIdTH8U0YGcS4m9pSRQZyLiT1lZBDnYmJPGRnEuZjIU0YGUS7GUS50XJJBlItRsc5DlItxlAudr88gysU4ysWQsdIGUS5G8Z2HCBej+M5DdIvpHFnIVkNsi3GOLPRQQ2SLcWQLSVwYxLWYLnKILot6rqNa6LKo4yybougMhwZRLUa7jqPXIES1mNgrRgZRLUbLyHxGXIuxdAo3nxHXYiyfwo0fRLYYzboAGsS1GM26ABpEtZguRQs9nxHVYlyOFtqrzyCyxTh3FmbyI7LFuDeMmDUIsS0m510ADSJbjOVTFJ3L0iCyxeSR61mDyBbjEubShhbiWkzO9x2iWkzO9x0iWkzucgSSowfxLMY5s9BpOg0iWgzvzGIQzWJczBAdamUQz2JcjhbG0ENEiykkHzlhENNi+EeiDeJZTBEJWTCIaTEuSQsdDGEQ1WKKyGHdIK7FWDpF0fFFBnEtxnm00PFFBpEtxvIpio4vMohsMZZPUXR8kUFki3FkCx1fZBDZYiyhouj4IoPYFmMJFUXHFxnEthhLqCg6vsggtsVYRkXR8UUG0S3GMiqKDhkyiG4xzq2Fzm5qEN9iLKei6eymBhEuxpIqms5uahDjYiypounspgYxLsbSKpoOqzGIczGWV9F0WI1BpItxpAsdVmMQ62IssaLpsBqDWBdjiRVNh9UYxLoYS6xoOqzGINbFWGJF02E1BrEuxhIrmg6rMYh1WVtiRdNhNWvEuqwtsaLpsJo1Yl3WlljRdKTMGrEua0usaDpSZo1Yl7UlVjQd/LJGrMvaObfQW+W6Y13+8epFVX8qT025e1fvyj9ffPX77y/++c/m+Vi+ePWfF/+s3B+zV1bmi6/+8yJ78dV//ufVC+H/W7j/StH9d+3+q1T3X+P+q7vyuvv/fNX9t6tfyO6/3e+mk2dy99919//r7v+zrBOYia5mJlf+H76M8mWUL6N09w/tC+sOaOYRZXn3CVnhf/Jg2qfE3T9E91P70mr3j05F+1Ck+3IvUPlva5NJuUZYCf8P3zy+ehvQ3DWU/2ndfUUbT+P+oda+8fxfTPeX1rHH/UN0jVB4PO0VhfuHb0vjqxv3pf/zyo8P+3/teNlsm+pQn+FYWCswGFQRqfipbMp6Uzfbx3L78VSeL/smGFQiB5LWa05SeRY63zYnWLfNytTXVeN1d+X29HxsQhEZFCHHRJQ1IWIFRQhOxP7hcKqax6fg61ewHXM/PVZ+HGRdJ+V+xLfMGSd/f/i82e9daz9smnDuivVVkVix33k8lvUuRAgAdvjaQyhT/7wt611VP0ARLaPWyzBu/JJ1d+W+bIHvHk6bOmjjNmilF9FGzHRTIONkNU15bjZ22FYPdXkKBm8btN5L032r8+PfSsNCCgOESLZFL81jWTfVdtAhGo57k1B9V563p+rYHE7bavdUnZ82zfYxkGmATGHYWQlk/uvz+ak6n1GPtS9IAkFsb18FVYf66XAqm8dNfajLts03zeVU1ofmfDkeD+3WEirIoYLY1x+CKd/eml0r+rWwTX7aLbd+3TV+Cvm9Kc9yP2q6JbANUOgWTr8orvx6KYRfOP1PReb3pjja6t+2NSBoEXSLR+r3F3Y+QHHuf+pDc/hcl2GLwMEsDLsIQmn1obFTrNw1B6KNDRjZ7QuccYllOFHBt7ZhYl0D++bMxvCVfhEIEEm4emV+A/U7e+t04/6RG99JmtHzYXMuc3U57ZvDh+emDKe0hPuJ4lZyIOLw4V/lNtwNZAFlcMvCh/1h+/HcHE5h6xm4UnprymhuYfpwqfa7Py7l6flwHGzRCq4GRnNLpW2F5tB/VPgxBn4MC8OJIBpDwa2R3TW6+ufmhNYhCftdKa5Pt1W4uEi4Rqy46brdlxu0toAVuZv2ot9r+t7wfzF+HWm5LE7F4Rx0MPgcb6NJP5oLr9Fbld5Uy/0SZvxPxhvWxtcyObfabw+7cC4ZAdcLrk+3h6fj5lSipm0zLFyn94pbGrrKT+X5vHkom+qp3YyfjoGkTEJJbCcdno6XBsPIJPyGFbemXCu3jbDlNyO4uqy5iXKV9nTZN9Xj5vzISlyvoER2eDiJu83D8cO22t2fDk+DNSmTcCvORsBBUefmVG5Ca1PCjSjjYdW7arCcFAUcu90cyPrTiO5PI/xArO8rZBiu4XLnrUvNLZpOwiVcM9vXGa5rhOSHZH1uTpdtY6uhdR9OCe0PcwW7ZPayPpbPu/JUfbKb6nHTBNaYgotXwRqIvLBLa5btNs3m/nB62jTn8/axfAr3C7i+FpKfy1EVx9OhOWwP++2hbso/G0qNgGq4ZTxRTfsHSkcGdbBLfVyHlbshW0pC8ZEx6sQji0jC+bzyC3TWn/Y9NeCJjPYx+e4f/tjvuYY2G3F3tvfmp98K2siyzg71Y1D59d3rMt6ANJ7pMH7AGt3TJZ2cluBhP7QlfO6rfROak61j+rWhWBtoeyoHNhq0Gr2xLTx9ovz0Vtq3iDe/25zk3XHX73j+a3O/O7YRzZ0p6Y0+f0guvD1Y+CYuej6J394sfnBMDNaDHMxczR5YOxmc1d8mGAI7HLuYWCk78uScabgzsWZgJ6I9HxIycjh2NTsgnIxqdyrPh/2l/ZghWaOhibRmWQQnq92DwlYFu49meYxrZcKmlfBoovN4g7QyjuXJnm8P9flU/nEpz4hWgEaIZO0IK+5wf38uG9qYKcCkMSL+af3hOBwsBg6W+LRzlEbQLmvIaLCHH1g9bNd1DuvH27WrT32GhFSPFvExzzQlPLUI9ksup/MBLVygATO//vmlxi8+Bdc37T4bjjTYIj1xzZrZbX1spQrImHssWnOde93qQykSSsm9FE8M55zpDCyHQF4BbeecG/Nt7TM63GeQhcs8Iy1U/w/lwXErg5WKT73wSNFJkrE2sgIeyoYgkzX8Nnbz6oXsy0/lPhx9Bo6+aOO0Ao4XEgU8f7KrihMysNG1hJ/gj6Hs2Xm3acpu7Q4nNJyHnbHuKX/N7iSttPLPY3UKDWQ4q7OVv4lg7eNWyvHyYV+dH0t0fISUqUfl7zp0fxKOCT4fTmFrK3io8UdlwQ/Bsj0MHvebqnaExXHzvD9sUOspuByy42h4n6CgFVTww7i8r+oKWwyQsMn8Wb9gz2k9XR50FSQxVt6e0uzwYSn31iMejOJ+AfTLWH9X543NorfM1uwiWe5LZDXCyxPhrT3lLxDz/lAoe6KDM8ec8PJTWTfnD88DxgDeV3nDmZ2a7KEuyyFxzRI/VwHDo0gG7SBxvfOJgik3rWFnh2s7sbbdPVR1qD+WzyHtB7mRnL0Uc1K3j9V+d7RYy4/lcyAnh0thZBC2cryMf33+GH4qXMw0u1MFMhCOLIfjMOendSuDEwHNaH+3WvREHsuqdEJti2OZcE0UeX89x49O8moMIjMsOe5vftB6AU2lbNXfiXvG0q/7bQKiuNzQkoI3ssLfp/grc35tLptNtQ/NBXgiZG3aHaIYoYlveHXV7qlsHg87noODuzB7s7urrIQB9ZytoSmxZjdMW/3TZo+WmzUc+GvOig2OW/ebao8/AXJ/a3YN76R8Cs8EED9X83Lcu6tFxhaBHchv95/rcGbA9a1gG/5zPWQEwZxiJ5Ktd27wdgW5RFGwM6m9Pjvh+y44Uvjdvqs6JNRhX7Nnr93nuqqb8nS/2Za2dMBhQi8EEWmybswP6sNLJ9ZsLbdVeT6X26PQ+ccs9GGA50eW1w8FkO4UoC0UO+5DOaRPhYByuNlX7oTW2bqq7QTEm88ajkPWJimfqlA1GIOyv+Hhtq6ybofDDp8e4QmAveB1dcNzPGToFevecN39g8ulwMbx5Bp7n3EVQrqmtO+jgS6INEAnpaqPF9SJkKxZ9RakP4UU7PDoZR5Ph2N5asKddwW/U7OD3Qk5Pz89lc0JWUwhZwHPSizzXP5x2eyHfKkGSzTrQDJYcuDwZrc4a8q2w7N1PRkszgoSFIa1i4ZCWieCY0ksg+tg32c7vBW4PwTLNlg8vJk+Unt48oaLsGEPzc68D9c+uFQItgtsxYcS3U+D3lPsBtfX7S40wz0SDEZuh+4FUJQmPL8qfjh7EafyuEfWLUDArnK2unUVCJVDjweWTwW1qSaAN4PRjj9zvgoSHjYVa68CIcNmAIsNa0g7AefLh9bu/RDuoQreIxbx7+gl0BZ0FjjbpUly/2tn6KWuno77si2NDUJ4FmLPdkgy0WUCGpbxUduLIbsN+mewfmJI0KDroPXCXuCC9gnWDQDALT3sTauT4FDYb3nc1Ls9MprBIJDsevBnub005aXety37YXD0kNChQLMX4uWfzWmzbdD5R0KzRRvuY+7LZvtoOaTN/lRuD6fd+fOpahAbD2kslksnNjV4WerZQ++ULXqnYn8VWRT+L6yl5nRU9XZ/2ZXnnhzskIc8Prw2Z31+QoGXOioSkkwFS6U6kUFNEfAXnUXl/XIU6xqHr76gIcQeTWj3D+jiLFjCyl6XDdyvMmjVC82hfWiNgc3+X5/Pn8pTdV+Vp4ey6UmP+tDcHy7IKXgNpwl7XBgK7ix18u4oW6+hUG7yOaGRe1cNfZQMewYh5ZDANLzINewx3AvcVbuP5fOxPJ0PNToUgJm9XnFTxcshLZY2fghgGWskZtvX0IQ2rH9SKIXcNTV0YDcsy+IlteOUW60UXPgMewfpRbVtvKnCK8AcglmNdVQn4bT5HAqBMFbc4u2FdJvrsJ+gFHZZ9FLANfWAiG+D0UC7cEsAIYq68YaTzLCuzKSwT4ePqO+hyc4uhkAWnhEK+skZdmXsJXQeRN1Rrl/riaEEBwK7h2K5Z9LBTEEi0ZjRz/TCBrNOQUrRmLG5233c8M5EwdXXsG7+SA4BB66TLG+FxJCrgIJ2qWHtQCSK6Da4LLFEnBVTbQmzNmBPor3eVx8Yo4EPON+26K4MGvw+8kx5l+Hcs+jG/2TYu5CHsmHCTUDbaPaY21YfOPRLeJWj2cPRQ9kM3H2hLcqeN9qKl9OprDnvGDgbY9DLujk9I3MYXrjp3vVfRtpvyBFk0BHDO8mpiIjOsCYs6gz2Aj9Cm4/YqocVIytdU5efyzPFNLTPyl0v9ljnq5Zl2O8YETCaK49YIE3rvl03nUeotS7vu/9BIwSyF4XiF8fOoEQcrYKXe4a9AoX2aFgdLmGsE/lD2QxdphS0XDRLd/V1B8c06DPM7wp4N5cwEE+xZ1VbLzBNXcCO9c0IgAhoHkj2lo0RSAR/CbitS36c0QLrQ/NcNi7wM5QaHPLZnqalOuMDfbeAAtmxPBDY38JQIXQCWsaSdZ8dSnUXM7RIBUWym+NA5DVK676lGGo0kgRcnCVvqEbkUtFfAh6fJD+nnIQPwXyEe1Tm3aQzv2jnPso6Z4ny6/cGYuHy7aOms95Z2Ifo5eyFQv+5gVTozOadibM+StD7J+XsDebjbuBnAO9LWTbV1gtdTLpzcdgPARXFLTBoOYaLEjfSXNmAe4d2lw/aM6yvsK3WQXaOmK1TFnVXI+DOKzOuJYcCP232lxInIBBw+5KsSwqUBoFV9VP5dDghgHAVybgus6W7tdL+e/NhX9IfDNePjG9Ba190E/JTOQg4WAXXCn2iAB4fY6/A61juwNEviOHwA0PZp10o/CTxc9BnQMi8n1bmybGMPXVVZ5gWIHQYgXyVvzAU3otNsGtcdS6PrZvVabP/WD63sVCn9n453LDhTZ1iWZzqzLYltFW097LR7FVVdW5NudDmgNMhZ3eX6txacKgm9OpiN5F2hD7U7bJMhdFKGMOlfZflbLP+6zNyEofum+wNyb8+nzkfS2qZgyEFkr1B8xzic8/QXere7Wd7+hQOXUgkss5d+BoYxlpotm+CpZtw7oN7lWDdBj6Wz/QdfgZ334y91Q3qDy/ec3jYYLt3KCTsbhg4otkh97HEJzZIMWmfkyT3br7G79uGveb7WD4/tTRBtQmjkSHvoVnegyIGoY2svSe+YXf2fYWcQuApx6/GLBP3tAl2V4g6Y53/nzZ/epd7m8mjtVY+lJ17SXjPCVdm9uBBsSPworwPOevWVr+eKW+kKR9Epbxfr/YXP9pHIeTelTb3mWty7w2c+8C3wtuBhegDK3vXYZ+VhqWMus9AvAS8z8n7eLhREeGlELy2ztlQla625RSCxoSGDTfNu8qWUHDGDV78oAnPXt57jjnsTLi1s3d7DD2toOKcXSJBbYpNgA3IWSZABJWjADov5CwzBYQM+Dp4bZ8nNIMVYImmkHoEUkYGI45AkIGb00hdHPwCCbZu5ox2Jh26AnO2mCQcZIfAhmDpCS8FXKaHUsBXjXwNSRmKII6nW3V8UKvPzOUXn8yvS5n0p7jCW6prH6Lb3976QFJV9OtbJ1D7g6TuM2r5tGK5Dy3NfRqY3O8ihc+KVPjYk8L79BdeRcFejDnaIFwTIJXcfbIPt/dxsZn/nEz21/O+Edibs6cqdBeEbjus79NTVVdPm/15X5aI1IVnRtZltW4D0PbVv0si0hgy7YXffwr2mOIsSSptCxxuiuXsD3Ubwjn0dYAEJjdWW4c5WAnM+G7wyD50zQ8ZPyqN/4vxm6Tx6YoMu9QM0vxI6FWtWRdfW6+3kanQJhiqqllvm+PmoaqHIc3wDsJbDoLb/a4yhtGa0LZkb8ICEhoZmTBWSrOrnZOAwzJhNBtrxR03pzB3SwYz+whvxSofZaHy3j/Erye9ddSncfOjJPdGZO5j3wvPaxWegSp8gr/CR5cUrI1jwQ5CnqDzCksg+arRFCkC7tOSdfLzskYTpAhofEl2379eP9M5SeBVPesLAe6wQwMK8gGsExyovT2EdBTkA9gb/tjNvoJrfc56HmMRtM8h5B5ZpxcsqmdxSeIaulRK1o8RywxHIUytkvkdUvfZHHwQceHnSuHTWhTsJRlWSJimMIw3Yy8bsKD60Gz4gEgBTSPJHhiwUMrIghFWOXsPiSXZAdivhpt6BzOqhNYT5EnZW0pSvsugcjwdHqsPVUvFV+U+PDgJOGolu/Nj6Zf6muJt2LbQ4JPsFfFYNgd4IMkTOqgTQk8oGBaQ8cvnQFo4/vMg5VefLYkzUobiiNENGYAsZSB2osihCI9PbDaAqB+Qgleaecq07a7zyGY3wV19wth1wqhmgrdRvJUykORo/tjCLeDhW7LntYFoqgNkwGUko4TTadglAm5uMra5DVyyYDpJww8IMt5XwTtZ7c9e2qc1Mmz2jas4wr5vXyMDt/zsgtPH/hKX/ZCuydnTGBZxqdt7nqal4C7bkgyTEjDhpRTsvI5KHnCoAu4Qkh+7A6lXTvxyQhfwgZc9e4C4imwOA2cNaLSzDrrH02Fbns9koAh0Zo4MBretBXMZHlZ9LoBM95dN/uTO+ot7oWFW1W13H95RrmF7QeuHPyjxck+XfXmm3KcFXDAlG2ZAiu5Ddk+HfetIVx0rxEwKaPdL3qqkpFf19nA6lVv60CUC0pMlh+KS6Sw3Igi7ZPNmxEWz9hBkviWbJo8R7u6RrVkUCoVLLJsULyZ0cL8N/Rclm6SOFGmt96p+6IbF4bQjRx7kXCTLWzMa/mxvJ6g7PHgyluyFKC21qlmpcAKyrmWMVLuHM6MYzj6WborJtTM7ZNQFzG0j2dRDpNR2AWr7LZQHxyybepeU51iPNjhpfGpA7kyyPrMRNX6YgQSbD5t6axnm7eMm5BwFZJDktMXa/5Ec1zCQU7IRPqRc6xj9uWoeD5dm2AtwRrLUIim3leXHC7lOw9hLyZ8Cw+yc4X4KGR42ztxLYJIOwQvn0d1ikA8nDP7ssz76K8PRrsAtnsFWEZ4M0D4Ppu5DzTyDVvQMGuvT0esaTlvoxZmNzjJEIEFv8z7NPOtJOhJlAHftImZcISHMKQqmgYoYewNp3rzYtC5JVU2udHC1Z0PSIrLbPmdEwyWfZ3UHorvtw9ldLmKim9HDRKUCBt9LNhXaiJJuZh/uQ9FB8oixTYARfbhnLFKYVUKyCc5GpF+ObRa1SOvAFZq9vGOV9Evd4d7pC4XDZZp1UOSFuyHj7JuB9QRvciTPsHDCcbZDAe+EJXtBNpRHnXygA0o24cNJxgCmnODJzYEsu9FxQwvuRWxwylBmZ2q2tFf9sCuPzWP557Ysd1g8XDLYHAeE+MO+3B3sKar8s2pT9T5Un8pBVjYBA2wlmyFuKB+yKKFA2Pc8lcjHekFTvmD9QEMBw8tJ6EqVjc94NkMDdOnPxqcG+6QENPQLnvcK5AwzNUCWKBsfbFYK21OQlJBsQj4vrF00woesYMvwZruNPhnch8LwE55UIgNfYI/oPjFn7yTH3kT30kiiDEYqsqEgZCiNhKn6NOsR1NfFUVqQ+OPJcl97yC3BCWfYiHIyqyhMGJf5pH6ZJx21v2zXPJnppdJJuGGrCn7t9kK4NNzQpYWfghcUWAgjCmTvIdT7vPUJqrgOG6Z8gUyL8llG8z6bPLs6W0lEbB2czL2nA/d93MoSULzc2O+Wkzbf7tCBC16pcVPxtKl3RJIFDeMKDBvm6GpvPxxO58dN+xwcckqEzt1rdgg7KRWK8YatuGatf1e3d+8YZi3UMGjEsDnPOjlEdTgL2ZOMq046bmkY/7Bml6DTpn4ot62H/Qlnb4A7TAT/A+FRBI0Yll0+lcghBpKaij0Ak0f4LEg61D/syJ4jnbWEPVlgHOLV54MdP8P8JhLeFqg+KwtLLPeR5db5uz547vDqEN6GYGGKBS6Dkp9ibNR6kBOPpTuC+gGfMsyPKeCqIVkX1EAkaR1BDiNNDGUcBUndWLOmFxPmq41e3cAAahkZ2VbyMOCvd54BZsz1hj9sUXiGYpPdT9LUHjwGQavQcpJsmASrx3UCsOePdDQndNGR7P7PqnG71anPeZCgEB5EWEaOVRi6eNAa4MmEzR0Y11AfekI4HGfQlmbDM+KyvWASPIyOkWz4RZqC9hBIK4GrAhtqGldC3PdAslWy9nkn1lMuHREeRg2VD0+YC4benZLf95xwRAnjeKTo5Qe8gpVsDBdS1DY1o4UeR3DasQ4hXGKSDF5SCTYmE1bvHnyxFkFviLd++tS9EjzpSDZkAIp3gnsy361nXfhnFdqSArqeSTY8B0ontyRoWCRhJHakDN6KCNZTC0qxHpyp7Qh3JdaTGUonqABIcKTLGJj/WfBO8djGhW1AFSS8G2vutvaYZQJdtCSbyQYIpAZBkLZkbJNshZBWCWQLx1bDVsiwk4Ij3ti24EQ0l1NdOj/gI7pSg351kvX99umG3INuzOJDrNLQ6UuyJ8loMqMgImCs78YygQYPT4zteJOSgQoThKClip6ylkHnXcnGlWAN5FCG91FjO0Is5agKDnms0zeWRAxqGGE/tk67zbwp21D5h1PVPIduwu3jHDtLUJc1k1cEnvIkG+7Iqbvm66h3ztWLVgKtCDZAlk0XChd0zSZrgNXBA3qgaUaeKRfQmUuyARhjerotqYtxIZMxQGZQsgnqxhRRD5uHaqBNxbpwBmrGtg+4Ro4NcivRPyPYbDb1rnuM7OnSXDb7/XP553Z/OeOEPJD5lix7TevYWv9zH7Ds9dhsrEM9cBFh4ySGevwaP3DmFDAPgWSzVw4l9m4aoev8CHy4obCBFVCZb31q6MPEhJJ1WMDSbCOT4uCE5+k+KI7ZpqAXyNimbAVd07VdautZUu6IZEIwx6DkCcVQLszAQXr7wNBFyfO1QGr19HRpYNKW7WPLISKxMAM4T+ACsdRWB12vs/6x1zHb1olzQ77t8qo+nspP1eESMn3wHlnx9Cotc5g9W66CnAApk7OTBx6+4KBCXpX12iZEU0dKCfNyKTY7ByFtaCNKmJBLsYktKFnEWgTTufHEPZBFPmsKL9/YW8hAShvoual3LosOtThImENIsVlAoFC7vZ2t6Ev9sT58rolkkjBDiWLzg0GxA3MG7LI0cvgaAOvhEFURJdEkPF4r9royTUF9aKoavYlKBd7Co65iL1ijOsFjj+RnwUOwYvNjRVVcM8IwW5iEp1KVZCUOlPh7EO5SX8ITp4owQIMYMBkkOWG9socRMzJIlcX6XmN3RbgBZ/ylxuHQDO7Mszx4hIEbhMP1K4OBiJnxiahY7d0ZOhABbxQEe6R3Nbvu6yxV/OIvPNkpNn9TIOlwcv9L7e0yC1KWcQv9IBgX8prZqk9U5rMP+edyc/b2hHwXSwXXkaz90td1+fIHVJmEh03F5nk5Px4u+9407adGAAg6BBTsRWO7EIUbTPDyqo9C99aJ8Tl6DI+tXdrChCMwyjRnoyrAnhIigg4w7HyLragZdJEXon9f3uf18Fk8lPGuIP5qNO9TUqo+IN//xfswF34QFT4LR+E9SYqi9z3m9qahpZDBAAGR9dkT+gcW+wQlfUIBn5Kp8CmZjP+pn/Q+/Yf26Ri0x5b3+TF9+r7cv8+c+0dcc5+zIPePe+S+rXLvk1T49HuF9+4oRJ/xxN9W+9wshQ/sLoo+jNtfR/vr8eKaCayPC+S7Pxz+8DiRsa7HRLIS6F7CBpW2RPeuasMlsJ9XkE7eo2dXAyYZJrx3YMmZ1ixChjQ0hthPtr4czeHD5lzm6nIKjWc4URS/T3gZwwQrcE2OYbhsMTkCz+oZG8RDErFBlJyfAj5xmWFZepiUaJjdPUj6wEhwNvUgeyJA001e9uzQmrft0ajLeI9eqofsjmHv4Fr/mnAQQ+8+Nuy7d8shrmwkPOYrdgCHeXJDzzy2CvF0DbQxWI+w5vCvM8qBCIeb8KuX0v1y6Ff6Puqz92Lr37718SJ53i9sfvlZ+QXJJ5Yq/I5R9G9as1xhc6Ce2YEPTbLTa+B6CodBxkbNXfbV7t5GY6C0Z3BJY6PYLrXNTU0/daCg+1LOZl24nPYg9spndGrJlHBswTMVmy2EFobNf7jksdlhLqd9b0eyqKCRotiVnxKFMcHjGzv7/FEHXPy3RKl1CW0GaZ+HpysFr2wLdlB4NeE1xKm8L22+o82+P2qFwqE1ywb7eeHtvByePtQqSALFTWsvBGfsD5/CGvu+buSSX5PBm3bBLqNe1ODEoCBRl7NbU18feF0OtzkFj0E5S1l4YUTuY+gzIViDqBdAP7QBczewuQg+tbm1A8MEbizcKuDS7wbqAoOG5eRcRft8atU8H+4xFYsuHSW01TTrtICyAQcSIGWvWTKbSJYNjQM6OPofr14cq2O5r+ryxVe//+N//uf/BRjxTRfIBQMA"; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 000000000..072daed85 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1415 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -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..8952d5708 --- /dev/null +++ b/classes/AllowAllTenantGate.html @@ -0,0 +1,5 @@ +AllowAllTenantGate | DWN-SDK Documentation - v0.2.18

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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 +isSignedByDelegate +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?: DelegatedGrantMessage;
          descriptor: Descriptor;
          permissionsGrantId?: string;
          protocolRole?: string;
          signer: Signer;
      }
      • Optional delegatedGrant?: DelegatedGrantMessage
      • descriptor: Descriptor
      • Optional permissionsGrantId?: string
      • Optional protocolRole?: string
      • signer: Signer

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    +

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

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

constructorcompareCidcompareMessageTimestampcreateAuthorizationcreateSignaturegetCidgetNewestMessagegetOldestMessagegetSignerisNewerisOlderisSignedByDelegatevalidateJsonSchemavalidateSignatureStructure

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

Class PermissionsGrant

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

asDelegatedGrant +authorize +toJSON +asDelegatedGrant +create +createFromPermissionsRequest +parse +validateScope +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

asDelegatedGrant

  • asDelegatedGrant(): DelegatedGrantMessage

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

    +

    Returns DelegatedGrantMessage

    Throws

    if the delegated property is not true.

    +

authorize

toJSON

Static asDelegatedGrant

  • asDelegatedGrant(message): DelegatedGrantMessage

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

    +

    Parameters

    Returns DelegatedGrantMessage

    Throws

    if the delegated property is not true.

    +

Static create

Static createFromPermissionsRequest

  • createFromPermissionsRequest(permissionsRequest, signer, overrides): Promise<PermissionsGrant>

  • generates a PermissionsGrant using the provided PermissionsRequest

    +

    Parameters

    • permissionsRequest: PermissionsRequest
    • signer: Signer

      the private key and additional signature material of the grantor

      +
    • overrides: CreateFromPermissionsRequestOverrides

      overrides that will be used instead of the properties in permissionsRequest

      +

    Returns Promise<PermissionsGrant>

Static parse

Static validateScope

Settings

Member Visibility

Theme

On This Page

authormessagesignaturePayloadsignerasDelegatedGrantauthorizetoJSONasDelegatedGrantcreatecreateFromPermissionsRequestparsevalidateScope

Generated using TypeDoc

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

Class PermissionsRequest

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

Generated using TypeDoc

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

Class PermissionsRevoke

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorize +toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorize

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

authormessagesignaturePayloadsignerauthorizetoJSONcreateparse

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

Class Records

Class containing useful utilities related to the Records interface.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

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

Settings

Member Visibility

Theme

On This Page

constructorconstructKeyDerivationPathconstructKeyDerivationPathUsingDataFormatsSchemeconstructKeyDerivationPathUsingProtocolContextSchemeconstructKeyDerivationPathUsingProtocolPathSchemeconstructKeyDerivationPathUsingSchemasSchemeconvertFilterdecryptderivePrivateKeyfilterIncludesPublishedRecordsfilterIncludesUnpublishedRecordsgetParentContextFromOfContextIdnormalizeFiltershouldProtocolAuthorizevalidateAncestorKeyAndDescentKeyDerivationPathsMatchvalidateDelegatedGrantReferentialIntegrity

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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 +isSignedByDelegate +message +owner +ownerSignaturePayload +signaturePayload +signer +

Methods

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

Properties

Readonly attesters

attesters: string[]

Accessors

author

isSignedByDelegate

message

owner

ownerSignaturePayload

  • get ownerSignaturePayload(): undefined | GenericSignaturePayload

  • Decoded owner signature payload.

    +

    Returns undefined | GenericSignaturePayload

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

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>

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, commonly as author, but can also be a delegate.

    +

    Parameters

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

    Returns Promise<void>

signAsOwner

  • signAsOwner(signer, permissionsGrantId?): Promise<void>

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

    +

    Parameters

    • signer: Signer
    • Optional permissionsGrantId: string

    Returns Promise<void>

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

    Returns Promise<GeneralJws>

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

attestersauthorisSignedByDelegatemessageownerownerSignaturePayloadsignaturePayloadsignerauthorizeDelegateconstructIndexesencryptSymmetricEncryptionKeygetEntryIdisInitialWritesignsignAsOwnertoJSONcreatecreateAttestationcreateFromcreateSignerSignaturefetchInitialRecordsWritegetAttestersgetAuthorgetEntryIdgetInitialWriteisInitialWriteparseverifyEqualityOfImmutableProperties

Generated using TypeDoc

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

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

Generated using TypeDoc

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

Class TestDataGenerator

Utility class for generating data for testing.

+

Constructors

constructor +

Methods

createDidResolutionResult +generateAuthorization +generateAuthorizationSignature +generateDidKeyPersona +generateEventsGet +generateEventsQuery +generateEventsSubscribe +generateFromRecordsWrite +generateMessagesGet +generatePermissionsGrant +generatePermissionsRequest +generatePermissionsRevoke +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 generatePermissionsGrant

  • generatePermissionsGrant(input?): Promise<GeneratePermissionsGrantOutput>

  • Generates a PermissionsGrant message for testing.

    +

    Parameters

    • Optional input: GeneratePermissionsGrantInput

    Returns Promise<GeneratePermissionsGrantOutput>

Static generatePermissionsRequest

  • generatePermissionsRequest(input?): Promise<GeneratePermissionsRequestOutput>

  • Generates a PermissionsRequest message for testing.

    +

    Parameters

    • Optional input: GeneratePermissionsRequestInput

    Returns Promise<GeneratePermissionsRequestOutput>

Static generatePermissionsRevoke

  • generatePermissionsRevoke(input?): Promise<GeneratePermissionsRevokeOutput>

  • Generates a PermissionsRevoke message for testing.

    +

    Parameters

    • Optional input: GeneratePermissionsRevokeInput

    Returns Promise<GeneratePermissionsRevokeOutput>

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

constructorcreateDidResolutionResultgenerateAuthorizationgenerateAuthorizationSignaturegenerateDidKeyPersonagenerateEventsGetgenerateEventsQuerygenerateEventsSubscribegenerateFromRecordsWritegenerateMessagesGetgeneratePermissionsGrantgeneratePermissionsRequestgeneratePermissionsRevokegeneratePersonagenerateProtocolEncryptedRecordsWritegenerateProtocolsConfiguregenerateProtocolsQuerygenerateRecordsDeletegenerateRecordsQuerygenerateRecordsSubscribegenerateRecordsWriterandomBytesrandomCborSha256CidrandomIntrandomSignatureStringrandomStringrandomTimestamp

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

Enumeration DwnErrorCode

DWN SDK error codes.

+

Enumeration Members

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

Enumeration Members

AuthenticateDescriptorCidMismatch

AuthenticateDescriptorCidMismatch: "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"

PermissionsGrantGrantedByMismatch

PermissionsGrantGrantedByMismatch: "PermissionsGrantGrantedByMismatch"

PermissionsGrantNotADelegatedGrant

PermissionsGrantNotADelegatedGrant: "PermissionsGrantNotADelegatedGrant"

PermissionsGrantScopeContextIdAndProtocolPath

PermissionsGrantScopeContextIdAndProtocolPath: "PermissionsGrantScopeContextIdAndProtocolPath"

PermissionsGrantScopeSchemaProhibitedFields

PermissionsGrantScopeSchemaProhibitedFields: "PermissionsGrantScopeSchemaProhibitedFields"

PermissionsGrantUnauthorizedGrant

PermissionsGrantUnauthorizedGrant: "PermissionsGrantUnauthorizedGrant"

PermissionsRevokeMissingPermissionsGrant

PermissionsRevokeMissingPermissionsGrant: "PermissionsRevokeMissingPermissionsGrant"

PermissionsRevokeUnauthorizedRevoke

PermissionsRevokeUnauthorizedRevoke: "PermissionsRevokeUnauthorizedRevoke"

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"

RecordsDecryptNoMatchingKeyEncryptedFound

RecordsDecryptNoMatchingKeyEncryptedFound: "RecordsDecryptNoMatchingKeyEncryptedFound"

RecordsDeleteAuthorizationFailed

RecordsDeleteAuthorizationFailed: "RecordsDeleteAuthorizationFailed"

RecordsDerivePrivateKeyUnSupportedCurve

RecordsDerivePrivateKeyUnSupportedCurve: "RecordsDerivePrivateKeyUnSupportedCurve"

RecordsGrantAuthorizationConditionPublicationProhibited

RecordsGrantAuthorizationConditionPublicationProhibited: "RecordsGrantAuthorizationConditionPublicationProhibited"

RecordsGrantAuthorizationConditionPublicationRequired

RecordsGrantAuthorizationConditionPublicationRequired: "RecordsGrantAuthorizationConditionPublicationRequired"

RecordsGrantAuthorizationDeleteProtocolScopeMismatch

RecordsGrantAuthorizationDeleteProtocolScopeMismatch: "RecordsGrantAuthorizationDeleteProtocolScopeMismatch"

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch: "RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch"

RecordsGrantAuthorizationScopeContextIdMismatch

RecordsGrantAuthorizationScopeContextIdMismatch: "RecordsGrantAuthorizationScopeContextIdMismatch"

RecordsGrantAuthorizationScopeNotProtocol

RecordsGrantAuthorizationScopeNotProtocol: "RecordsGrantAuthorizationScopeNotProtocol"

RecordsGrantAuthorizationScopeProtocolMismatch

RecordsGrantAuthorizationScopeProtocolMismatch: "RecordsGrantAuthorizationScopeProtocolMismatch"

RecordsGrantAuthorizationScopeProtocolPathMismatch

RecordsGrantAuthorizationScopeProtocolPathMismatch: "RecordsGrantAuthorizationScopeProtocolPathMismatch"

RecordsGrantAuthorizationScopeSchema

RecordsGrantAuthorizationScopeSchema: "RecordsGrantAuthorizationScopeSchema"

RecordsInvalidAncestorKeyDerivationSegment

RecordsInvalidAncestorKeyDerivationSegment: "RecordsInvalidAncestorKeyDerivationSegment"

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"

RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch

RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch: "RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch"

RecordsValidateIntegrityGrantedToAndSignerMismatch

RecordsValidateIntegrityGrantedToAndSignerMismatch: "RecordsValidateIntegrityGrantedToAndSignerMismatch"

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"

RecordsWriteSignAsOwnerUnknownAuthor

RecordsWriteSignAsOwnerUnknownAuthor: "RecordsWriteSignAsOwnerUnknownAuthor"

RecordsWriteValidateIntegrityAttestationMismatch

RecordsWriteValidateIntegrityAttestationMismatch: "RecordsWriteValidateIntegrityAttestationMismatch"

RecordsWriteValidateIntegrityContextIdMismatch

RecordsWriteValidateIntegrityContextIdMismatch: "RecordsWriteValidateIntegrityContextIdMismatch"

RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload

RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload: "RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload"

RecordsWriteValidateIntegrityDateCreatedMismatch

RecordsWriteValidateIntegrityDateCreatedMismatch: "RecordsWriteValidateIntegrityDateCreatedMismatch"

RecordsWriteValidateIntegrityEncryptionCidMismatch

RecordsWriteValidateIntegrityEncryptionCidMismatch: "RecordsWriteValidateIntegrityEncryptionCidMismatch"

RecordsWriteValidateIntegrityRecordIdUnauthorized

RecordsWriteValidateIntegrityRecordIdUnauthorized: "RecordsWriteValidateIntegrityRecordIdUnauthorized"

SchemaValidationFailure

SchemaValidationFailure: "SchemaValidationFailure"

SchemaValidatorSchemaNotFound

SchemaValidatorSchemaNotFound: "SchemaValidatorSchemaNotFound"

Secp256k1KeyNotValid

Secp256k1KeyNotValid: "Secp256k1KeyNotValid"

TimestampInvalid

TimestampInvalid: "TimestampInvalid"

UrlProtocolNotNormalizable

UrlProtocolNotNormalizable: "UrlProtocolNotNormalizable"

UrlProtocolNotNormalized

UrlProtocolNotNormalized: "UrlProtocolNotNormalized"

UrlSchemaNotNormalizable

UrlSchemaNotNormalizable: "UrlSchemaNotNormalizable"

UrlSchemaNotNormalized

UrlSchemaNotNormalized: "UrlSchemaNotNormalized"

Settings

Member Visibility

Theme

On This Page

AuthenticateDescriptorCidMismatchAuthenticateJwsMissingAuthenticationMoreThanOneSignatureNotSupportedAuthorizationAuthorNotOwnerAuthorizationNotGrantedToAuthorComputeCidCodecNotSupportedComputeCidMultihashNotSupportedDidMethodNotSupportedDidNotStringDidNotValidDidResolutionFailedEd25519InvalidJwkEventEmitterStreamNotOpenErrorEventsSubscribeEventStreamUnimplementedGeneralJwsVerifierGetPublicKeyNotFoundGeneralJwsVerifierInvalidSignatureGrantAuthorizationGrantExpiredGrantAuthorizationGrantMissingGrantAuthorizationGrantNotYetActiveGrantAuthorizationGrantRevokedGrantAuthorizationInterfaceMismatchGrantAuthorizationMethodMismatchGrantAuthorizationNotGrantedForTenantGrantAuthorizationNotGrantedToAuthorHdKeyDerivationPathInvalidIndexInvalidCursorSortPropertyIndexInvalidCursorValueTypeIndexInvalidSortPropertyInMemoryIndexMissingIndexablePropertyJwsDecodePlainObjectPayloadInvalidJwsVerifySignatureUnsupportedCrvMessageGetInvalidCidParseCidCodecNotSupportedParseCidMultihashNotSupportedPermissionsGrantGrantedByMismatchPermissionsGrantNotADelegatedGrantPermissionsGrantScopeContextIdAndProtocolPathPermissionsGrantScopeSchemaProhibitedFieldsPermissionsGrantUnauthorizedGrantPermissionsRevokeMissingPermissionsGrantPermissionsRevokeUnauthorizedRevokePrivateKeySignerUnableToDeduceAlgorithmPrivateKeySignerUnableToDeduceKeyIdPrivateKeySignerUnsupportedCurveProtocolAuthorizationActionNotAllowedProtocolAuthorizationActionRulesNotFoundProtocolAuthorizationDuplicateRoleRecipientProtocolAuthorizationIncorrectContextIdProtocolAuthorizationIncorrectDataFormatProtocolAuthorizationIncorrectProtocolPathProtocolAuthorizationInvalidSchemaProtocolAuthorizationInvalidTypeProtocolAuthorizationMatchingRoleRecordNotFoundProtocolAuthorizationMaxSizeInvalidProtocolAuthorizationMinSizeInvalidProtocolAuthorizationMissingContextIdProtocolAuthorizationMissingRuleSetProtocolAuthorizationNotARoleProtocolAuthorizationParentNotFoundConstructingAncestorChainProtocolAuthorizationParentlessIncorrectProtocolPathProtocolAuthorizationProtocolNotFoundProtocolAuthorizationQueryWithoutRoleProtocolAuthorizationRoleMissingRecipientProtocolsConfigureDuplicateActorInRuleSetProtocolsConfigureDuplicateRoleInRuleSetProtocolsConfigureInvalidActionDeleteWithoutCreateProtocolsConfigureInvalidActionMissingOfProtocolsConfigureInvalidActionOfNotAllowedProtocolsConfigureInvalidActionUpdateWithoutCreateProtocolsConfigureInvalidRecipientOfActionProtocolsConfigureInvalidRuleSetRecordTypeProtocolsConfigureInvalidSizeProtocolsConfigureQueryNotAllowedProtocolsConfigureRecordNestingDepthExceededProtocolsConfigureRoleDoesNotExistAtGivenPathProtocolsConfigureUnauthorizedProtocolsQueryUnauthorizedRecordsDecryptNoMatchingKeyEncryptedFoundRecordsDeleteAuthorizationFailedRecordsDerivePrivateKeyUnSupportedCurveRecordsGrantAuthorizationConditionPublicationProhibitedRecordsGrantAuthorizationConditionPublicationRequiredRecordsGrantAuthorizationDeleteProtocolScopeMismatchRecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatchRecordsGrantAuthorizationScopeContextIdMismatchRecordsGrantAuthorizationScopeNotProtocolRecordsGrantAuthorizationScopeProtocolMismatchRecordsGrantAuthorizationScopeProtocolPathMismatchRecordsGrantAuthorizationScopeSchemaRecordsInvalidAncestorKeyDerivationSegmentRecordsProtocolContextDerivationSchemeMissingContextIdRecordsProtocolPathDerivationSchemeMissingProtocolRecordsQueryCreateFilterPublishedSortInvalidRecordsQueryFilterMissingRequiredPropertiesRecordsQueryParseFilterPublishedSortInvalidRecordsReadAuthorizationFailedRecordsReadReturnedMultipleRecordsSchemasDerivationSchemeMissingSchemaRecordsSubscribeEventStreamUnimplementedRecordsSubscribeFilterMissingRequiredPropertiesRecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatchRecordsValidateIntegrityGrantedToAndSignerMismatchRecordsWriteAttestationIntegrityDescriptorCidMismatchRecordsWriteAttestationIntegrityInvalidPayloadPropertyRecordsWriteAttestationIntegrityMoreThanOneSignatureRecordsWriteAuthorizationFailedRecordsWriteCreateDataAndDataCidMutuallyExclusiveRecordsWriteCreateDataCidAndDataSizeMutuallyInclusiveRecordsWriteCreateMissingSignerRecordsWriteCreateProtocolAndProtocolPathMutuallyInclusiveRecordsWriteDataCidMismatchRecordsWriteDataSizeMismatchRecordsWriteGetEntryIdUndefinedAuthorRecordsWriteGetInitialWriteNotFoundRecordsWriteImmutablePropertyChangedRecordsWriteMissingDataInPreviousRecordsWriteMissingDataStreamRecordsWriteMissingEncodedDataInPreviousRecordsWriteMissingProtocolRecordsWriteMissingSchemaRecordsWriteMissingSignerRecordsWriteOwnerAndTenantMismatchRecordsWriteSignAsOwnerUnknownAuthorRecordsWriteValidateIntegrityAttestationMismatchRecordsWriteValidateIntegrityContextIdMismatchRecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayloadRecordsWriteValidateIntegrityDateCreatedMismatchRecordsWriteValidateIntegrityEncryptionCidMismatchRecordsWriteValidateIntegrityRecordIdUnauthorizedSchemaValidationFailureSchemaValidatorSchemaNotFoundSecp256k1KeyNotValidTimestampInvalidUrlProtocolNotNormalizableUrlProtocolNotNormalizedUrlSchemaNotNormalizableUrlSchemaNotNormalized

Generated using TypeDoc

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

Enumeration DwnInterfaceName

Enumeration Members

Events +Messages +Permissions +Protocols +Records +

Enumeration Members

Events

Events: "Events"

Messages

Messages: "Messages"

Permissions

Permissions: "Permissions"

Protocols

Protocols: "Protocols"

Records

Records: "Records"

Settings

Member Visibility

Theme

On This Page

EventsMessagesPermissionsProtocolsRecords

Generated using TypeDoc

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

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

Generated using TypeDoc

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

Enumeration EncryptionAlgorithm

Enumeration Members

Aes256Ctr +EciesSecp256k1 +

Enumeration Members

Aes256Ctr

Aes256Ctr: "A256CTR"

EciesSecp256k1

EciesSecp256k1: "ECIES-ES256K"

Settings

Member Visibility

Theme

On This Page

Aes256CtrEciesSecp256k1

Generated using TypeDoc

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

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

Generated using TypeDoc

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

Enumeration SortDirection

Enumeration Members

Ascending +Descending +

Enumeration Members

Ascending

Ascending: 1

Descending

Descending: -1

Settings

Member Visibility

Theme

On This Page

AscendingDescending

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

DWN-SDK Documentation - v0.2.18

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

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

DWN-SDK Documentation - v0.2.18

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 +PermissionsGrant +PermissionsRequest +PermissionsRevoke +PrivateKeySigner +Protocols +ProtocolsConfigure +ProtocolsQuery +Records +RecordsDelete +RecordsQuery +RecordsRead +RecordsSubscribe +RecordsWrite +Secp256k1 +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 +PermissionsGrantDescriptor +PermissionsGrantMessage +PermissionsGrantOptions +PermissionsRequestDescriptor +PermissionsRequestMessage +PermissionsRequestOptions +PermissionsRevokeDescriptor +PermissionsRevokeMessage +PermissionsRevokeOptions +Persona +PrivateJwk +ProtocolDefinition +ProtocolRuleSet +ProtocolTypes +ProtocolsConfigureDescriptor +ProtocolsConfigureMessage +ProtocolsConfigureOptions +ProtocolsQueryFilter +ProtocolsQueryMessage +ProtocolsQueryOptions +ProtocolsQueryReply +PublicJwk +QueryOptions +QueryResultEntry +RangeCriterion +RangeFilter +RecordsDeleteMessage +RecordsDeleteOptions +RecordsQueryMessage +RecordsQueryOptions +RecordsQueryReply +RecordsQueryReplyEntry +RecordsReadMessage +RecordsReadOptions +RecordsReadReply +RecordsSubscribeDescriptor +RecordsSubscribeMessage +RecordsSubscribeOptions +RecordsSubscribeReply +RecordsWriteDescriptor +RecordsWriteMessage +RecordsWriteOptions +SubscriptionReply +UnionMessageReply +

Functions

authenticate +executeUnlessAborted +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Implemented by

Methods

close +emit +open +subscribe +

Methods

close

emit

open

subscribe

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

  • Parameters

    • id: string
    • listener: EventListener

    Returns Promise<EventSubscription>

Settings

Member Visibility

Theme

On This Page

closeemitopensubscribe

Generated using TypeDoc

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

Interface MessageStore

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

Implemented by

Methods

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

Generated using TypeDoc

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

Interface MessageStoreOptions

interface MessageStoreOptions {
    signal?: AbortSignal;
}

Properties

signal? +

Properties

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

signal

Generated using TypeDoc

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

Interface MessageSubscription

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

Properties

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

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

Generated using TypeDoc

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

Type alias ActiveTenantCheckResult

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

The result of the isActiveTenant() call.

+

Type declaration

  • Optional detail?: string

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

    +
  • isActiveTenant: boolean

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

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CreateFromOptions

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

Type declaration

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

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

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

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

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

    Signer of the message.

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias DataStoreGetResult

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

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

+

Type declaration

  • dataSize: number

    The number of bytes of the data stored.

    +
  • dataStream: Readable

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias DataStorePutResult

DataStorePutResult: {
    dataSize: number;
}

Result of a data store put() method call.

+

Type declaration

  • dataSize: number

    The number of bytes of the data stored.

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias DerivedPrivateJwk

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias DwnConfig

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

DWN configuration.

+

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EncryptionInput

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

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

+

Type declaration

  • Optional algorithm?: EncryptionAlgorithm

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

    +
  • initializationVector: Uint8Array

    Initialization vector used for encrypting the data.

    +
  • key: Uint8Array

    Symmetric key used to encrypt the data.

    +
  • keyEncryptionInputs: KeyEncryptionInput[]

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

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EncryptionProperty

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EqualFilter

EqualFilter: string | number | boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventSubscriptionHandler

EventSubscriptionHandler: ((event) => void)

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsGetMessage

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

Type declaration

  • authorization: AuthorizationModel
  • descriptor: EventsGetDescriptor

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsGetOptions

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsGetReply

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsQueryMessage

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

Type declaration

  • authorization: AuthorizationModel
  • descriptor: EventsQueryDescriptor

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsQueryOptions

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsQueryReply

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsSubscribeDescriptor

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

Type declaration

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsSubscribeMessage

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsSubscribeOptions

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

Type declaration

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsSubscribeReply

EventsSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias Filter

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

Type declaration

  • [property: string]: FilterValue

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias GenericMessage

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

Intersection type for all concrete message types.

+

Type declaration

  • Optional authorization?: AuthorizationModel
  • descriptor: Descriptor

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias GenericMessageReply

GenericMessageReply: {
    status: Status;
}

Type declaration

  • status: Status

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias KeyEncryptionInput

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

Input that specifies how a symmetric key is encrypted.

+

Type declaration

  • Optional algorithm?: EncryptionAlgorithm

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

    +
  • derivationScheme: KeyDerivationScheme

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

    +
  • publicKey: PublicJwk

    Public key to be used to encrypt the symmetric key.

    +
  • publicKeyId: string

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

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias KeyMaterial

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

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

+

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias MessageEvent

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

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

+

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias MessageSort

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias MessagesGetMessage

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

Type declaration

  • authorization: AuthorizationModel
  • descriptor: MessagesGetDescriptor

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias MessagesGetOptions

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

Type declaration

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias MessagesGetReply

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias MessagesGetReplyEntry

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

Type declaration

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias OneOfFilter

OneOfFilter: EqualFilter[]

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias Pagination

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

Pagination Options for querying messages.

+

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

+

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PaginationCursor

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

Type declaration

  • messageCid: string
  • value: string | number

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionConditions

PermissionConditions: {
    publication?: PermissionsConditionPublication;
}

Type declaration

  • Optional publication?: PermissionsConditionPublication

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

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionScope

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionsGrantDescriptor

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

Type declaration

  • Optional conditions?: PermissionConditions
  • dateExpires: string

    Timestamp at which this grant will no longer be active.

    +
  • Optional delegated?: boolean

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

    +
  • Optional description?: string

    Optional string that communicates what the grant would be used for

    +
  • grantedBy: string

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

    +
  • grantedFor: string

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

    +
  • grantedTo: string

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

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

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

    +
  • scope: PermissionScope

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionsGrantMessage

PermissionsGrantMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: PermissionsGrantDescriptor;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionsGrantOptions

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

Type declaration

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionsRequestDescriptor

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionsRequestMessage

PermissionsRequestMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: PermissionsRequestDescriptor;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionsRequestOptions

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionsRevokeDescriptor

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

Type declaration

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionsRevokeMessage

PermissionsRevokeMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: PermissionsRevokeDescriptor;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PermissionsRevokeOptions

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

Type declaration

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

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

Generated using TypeDoc

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

Type alias PrivateJwk

PrivateJwk: PublicJwk & {
    d: string;
}

Type declaration

  • d: string

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

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ProtocolDefinition

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

Type declaration

  • protocol: string
  • published: boolean

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ProtocolRuleSet

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

Type declaration

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

    Encryption setting for objects that are in this protocol path.

    +
  • Optional $role?: boolean

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

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

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ProtocolTypes

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

Type declaration

  • [key: string]: ProtocolType

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ProtocolsConfigureDescriptor

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ProtocolsConfigureMessage

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ProtocolsConfigureOptions

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ProtocolsQueryFilter

ProtocolsQueryFilter: {
    protocol: string;
}

Type declaration

  • protocol: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ProtocolsQueryMessage

ProtocolsQueryMessage: GenericMessage & {
    descriptor: ProtocolsQueryDescriptor;
}

Type declaration

  • descriptor: ProtocolsQueryDescriptor

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ProtocolsQueryOptions

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

Type declaration

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ProtocolsQueryReply

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PublicJwk

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

Type declaration

  • crv: "Ed25519" | "secp256k1"

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

    +
  • x: string

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

    +
  • Optional y?: string

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

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias QueryOptions

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias QueryResultEntry

QueryResultEntry: GenericMessage & {
    encodedData?: string;
}

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

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

Type declaration

  • Optional encodedData?: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RangeCriterion

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

Type declaration

  • Optional from?: string

    Inclusive starting date-time.

    +
  • Optional to?: string

    Inclusive end date-time.

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RangeFilter

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

Ranger filter. 1 condition is required.

+

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsDeleteMessage

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

Type declaration

  • authorization: AuthorizationModel
  • descriptor: RecordsDeleteDescriptor

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsDeleteOptions

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

Type declaration

  • Optional delegatedGrant?: DelegatedGrantMessage

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsQueryMessage

RecordsQueryMessage: GenericMessage & {
    descriptor: RecordsQueryDescriptor;
}

Type declaration

  • descriptor: RecordsQueryDescriptor

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsQueryOptions

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

Type declaration

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

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsQueryReply

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsQueryReplyEntry

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

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

+
    +
  1. May include an initial RecordsWrite message
    2. +
  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

Generated using TypeDoc

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

Type alias RecordsReadMessage

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

Type declaration

  • Optional authorization?: AuthorizationModel
  • descriptor: RecordsReadDescriptor

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsReadOptions

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

Type declaration

  • Optional delegatedGrant?: DelegatedGrantMessage

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

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

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

    +
  • Optional signer?: Signer

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsReadReply

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsSubscribeDescriptor

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

Type declaration

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsSubscribeMessage

RecordsSubscribeMessage: GenericMessage & {
    descriptor: RecordsSubscribeDescriptor;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsSubscribeOptions

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

Type declaration

  • Optional delegatedGrant?: DelegatedGrantMessage

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsSubscribeReply

RecordsSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsWriteDescriptor

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

Type declaration

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsWriteMessage

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsWriteOptions

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

Type declaration

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

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

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

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

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

    Signer of the message.

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias SubscriptionReply

SubscriptionReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias UnionMessageReply

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

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

+

Type declaration

  • Optional cursor?: PaginationCursor

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

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

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

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

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

    +
  • Optional subscription?: MessageSubscription

    A subscription object if a subscription was requested.

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file