diff --git a/7.x/docs/.nojekyll b/7.x/docs/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/7.x/docs/.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/7.x/docs/assets/custom.css b/7.x/docs/assets/custom.css new file mode 100644 index 000000000..24616e25d --- /dev/null +++ b/7.x/docs/assets/custom.css @@ -0,0 +1,4 @@ +.tsd-page-toolbar, +.tsd-page-title { + background-color: #7E56C2; +} diff --git a/7.x/docs/assets/highlight.css b/7.x/docs/assets/highlight.css new file mode 100644 index 000000000..adb6db7ab --- /dev/null +++ b/7.x/docs/assets/highlight.css @@ -0,0 +1,120 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #A31515; + --dark-hl-1: #CE9178; + --light-hl-2: #0000FF; + --dark-hl-2: #569CD6; + --light-hl-3: #0070C1; + --dark-hl-3: #4FC1FF; + --light-hl-4: #795E26; + --dark-hl-4: #DCDCAA; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #008000; + --dark-hl-6: #6A9955; + --light-hl-7: #000000FF; + --dark-hl-7: #D4D4D4; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-hl-9: #AF00DB; + --dark-hl-9: #C586C0; + --light-hl-10: #EE0000; + --dark-hl-10: #D7BA7D; + --light-hl-11: #811F3F; + --dark-hl-11: #D16969; + --light-hl-12: #000000; + --dark-hl-12: #C8C8C8; + --light-hl-13: #267F99; + --dark-hl-13: #4EC9B0; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +pre, code { background: var(--code-background); } diff --git a/7.x/docs/assets/main.js b/7.x/docs/assets/main.js new file mode 100644 index 000000000..d0aa8d5f9 --- /dev/null +++ b/7.x/docs/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=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=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!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&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);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 r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/7.x/docs/assets/navigation.js b/7.x/docs/assets/navigation.js new file mode 100644 index 000000000..350549c12 --- /dev/null +++ b/7.x/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52d23LjRpKG38XXs+sZe8a7O3dsiWrJpkQ1SXXbsbGhgIgSBQsEOACobnlj332rAJKoQ+afSd+0Oph/fQUU6pB1/u///a4z37rv/vndZL02bXtb5+a7v3y3y7oX+5up9tv2+9Hy7y/dtrTm16LKv/vnf/7fX7zQJR20FMI9tXW578y9DXVTdabJ1l1RV4va/jbC1mXWtsbigDqM428/hE+3NrvuvjHPpjHV2oZvWtMQfFInkdv24sWsXzngySxw6n3V3VRFV2Rl8QcDizQK4n1Tb3fdlU2ounlnmYEKU3fXJstNc51VeUk/ZagQaIteS2IGEw7fFW9F935Xd8Vzsc5cZvhoKpsv7HtQTCCH8eT5wmzrN6ONCOphTBtTdVKmSjQi8cIF1WBTocj+2NT7nYadCiG7LJedTbg1m0NCgcCqvw6Fe8ibX5qiY5iUELJ3O4Kz2wlhFvuqIp/gaILhmyZ7f6hspuKLYSyBPBukc5Xq9FvX9JUAAUw0mPherfmH86yQ0tXbYn1VlOYy67Ih65DPRuoged+9TPbfirLImnc2h6UiiVk3xR99aWebmFSkYZq8b+T4FCV1KjKiqQhFtbnuup34bKEOkw+JPiuq11vTZbn9rGyZ5cWqOPivr/7yHzJb3/9rb9rOveC0aahMSogwszU//X1arevcJtzSlrdsQ7hEpEziHj2JnPGzUo2S6OLHvF4h0S5eMlsFlqv3HQPzBCKrLFy71pjc/rF+UwvfmlOfHQtICVorxmA9tLqyIdqfW9adY4Qyu34tDHrkUSCxptusKJemIstUJJBYrka/6VPpuTDNbbbbcVBKKdLrZlPbJq1tv9ZNDt6eEErs8VmWtrXszIb5WKlOIs/qzYZLhcGmIBSVVxzZeoUQSuxjIsFCFom0TPCFzvo293VuCx/tuYd2BQm/aK1+xxq+Xq17M9dS9S3frKb9cEIkM9t636xR7RBItLwW9J9onUh2Cc13TBOJxFua5s00sK4NJCLP9lZ4Dy5WSDTX9lmHYteY1lYhvTt5UVf2aUgnSQohxfbQlKBvECsUNJgOo11BGr7pYl8yuTOQKHifTdNXyCztKJBYX8zTTe6cUlBDhBoVERTE0S6QirX98nnhskBLonzBGSyu10PKRO50lW1QPgkUIi3M+QwwFCmYvUMPXzvQKIit9d7sp2R6O4QIMk3WmKbPF6j8EipILSrbL1qWxVpsHhglpNf5O5uiJxsm1KXJ+MGR0I5IF9n6xeQsKDDLnJ+/voJWL9XIxFOimo4DehLMq9amnBc5P2yTSCDvJSsqk4M2KVYoaCuz3ZW2jZxW1jMlshspg9yyAOXCtwoUl8rlG/mao1FghL3CSZ7t6HRjlH+Gzno3QoCz4ro0ne3ytXy+wgHkuG5yIbFOgjNYQtLEOgW5eq6FNPAkmLdvO9fNrTKyLxjaIanePrkSs3ypm+7FxgzyMScV+Lu6NflpMI3vDrNSDd+faOHTmBfjOA5+S8Z7ralGRWQdpnN8Jat9Ljaur4lmDymVisrnskgh0awTgMZHE4nAc14a+h6eXSJ1ma1+QEMVSzQ8adia1gnkzjVvjfSdE5WK6uZ22OEgSqWirupjY4wTmFVLsdivPDPVpnsBRSkWKZius6z4hLRUyReeeJQoebbzUmZrgXgUicxv3WW93m9d0tX0DAkpk7hNDWtRzy6QXPYoqk1fVSAiodOR/WZiafv8oMTBELrY5jvn87sWCc2lYb0uJluEbb8Awg8SHQ8NwFAqTHUTDd7aHpAStFKmy8U6VclUvjCPVkxpgIc8GiHDDVsfZ9p4GKGSqYmTLvA5vRyTWzHWol4ZoZKpxykC4bEjmYJbi8haT8uPQzuXpl03xY4equK1QgzHb4FTN1Eh6uV9fS+NL6UaSPTWcLhRTW7Ek9ZBsinNOTkZ6+WYlMvFgFiOY2wH8FvEOpls6yz7wuizUjINVyiJpAxy36tsW6x/butK5W9iPYpp+nsrjUElEshDs+XKmfLpv/ZZKU79USpIhX6V1pvqdavapTT4HpRKQf20z9D4IqVSUBX5h1NC+rdd0Vg/iB2pigRnsNiRKlqHybaf0Npaoq9QuRUXlOpcKnhoVqyPQyykQI1ikdcinrMK0WmXtotg+2Q1ndNihUh7bzuzPQ75c3UBpxTobkjx4BWLacBo5Rhs18P+Szg9gRlzKtfxyp5KfrY91SiIACSF/9bPc5xGC5hyResguW6eitw6JmBgLdUIxI3pem+NT71EIxHH5VMQmsgE7lZsWggRZu6rHKalb0ekgwtncjSESogws5PdPUIEmWX9lJWf9nWX8WPzhAgyG2Pyd9ElIWWIO7zOk+1LS/U7p5TpzbCmZxjc3jMeOyvF/PZFXM9LiCSmrSVojjXAsDbh5exEqSQqWIWl3ht0bU2fC/N1WnWUlxCYNRz+iUIBZrEVg6pOgEN7ynG8m1zeJ5dqMNFbN0vBPLOOszTd7b7sCoHnyWRu937f1G9FDjxHRngOG34hIIZxbLf7znkaR4eIHYDllJBe3ZqtfUvskVEqTM3Nt3AxFDMKwykx/TA1BX00SqWiQpjEkEeezxtzjkuiBqvdw9MH2Zq8cJ3QfkwQjNYAsRiH9XGHto6p/QgRYo7uWIsSmpRJ3L5vw7WukUBiaXIDrZPIs1w7u4TUUiz+kjs2PSIRYv5i3kEG860C5XNW7o+beNiHo3WIPMv+eB/2QLBtRCKBPG9HGRi/JWUSd2FKaSKKlCm486ffzZpYDxiYFRxuSiswSxzck4wVmNbajrEbzjrs4wZUWgnp9VC6NGWe1wox2J83yghoqYIvrMilVJjqCgtsWxOJwLOtG3hzz4w4/dhILhUhSoWpzWtef61WtesWgHEFRojZ32yVNqxDYSs9QgSZvVdn35IHRgqZJo0eUipMFWvQs2rP0Tmmq6fQriGxuUefb0z3UufDECWbtwmRzJRmwymVTLX+RH/WgUGDXawU8qXn1T9pnbtuolzGSZ1A3pfm8+BX8vt9SBnm2jqwbg5DN1RhDAWY9Wbye+uxZ24vb/mOvhMnRfy7H/vOJdpskUgUPOnzkzIFFzyf8Fx1f9jI/KutWdqXYmddyiKnayFWivmdNGicSATezXZXGreiDpZORiiwT72IYdHIE5mulEzLnW6LjiymhEjLBC3H2asmVCvFz1whru3Lnd+LC0Lsn1SfbNRpyQ9Vq2T7SkSfu0M/QOYN7ZBU5Gtp3WiqkYhwnC8SQNarasEWKYNccVz+nDF53drSc1eUnvTCxmtaB8lNsXHzqg9w1zGlglRXr0vOBCESma7pLVrnJHBnyZAykSs0V+e1U7YFz8rS8IUoEggs02+HGFbtc29NygRuK50mlGoEouuUilORtA6T27Z7aer95oVd0pNqziOyo1isVMkHHVtKpaTiKQhGqGQfBwPZfi6vVcbAuOyxQqK5xQv9wSkgB6cqTLVOLqCNVpEiNyukTOTyPZ7ALHBe+sVYfG0SCCDrVNP2AdBRZ6xUx2cf9oy6/r5YC6OksQLSSlvZDpMGw0gDgYslkAdOy9GdlGNVwvKSWCHQDuX6OAoLuYwWx9AqltlQKkhtzPq4qfMqK0rYtwNiIQ7hhNtzzrYdtcv9zi0/RLiDBPNqV+XzKRrYBRI61FZ9mu0gRA80miFn/1QWa93+Cl6LY9BkyVSEmG5h9Kpe5M/AG0g1mAiLubqM90Lg+YZ2RFpk1Ubc8EWIRKbtFC9tQrdu4BEUZF4rxiAXZlKGuV/ReF9ghpz8mR2UG20CofcIEMYXCCxxL0CqEYgg9/lWSHEr56rynfGMAjPmrK23yE3q+lZMyQvbqqAd+IlEwxO34DJCJRv2BWmdRG65TqBnxIyN+YY2vUYCmQUoYvjS1ixvyvPzkRrHojxm7k+cLkcG4fsTUK6P51jbSxEcdXoy7q3x2jNjUMIlLjy+TH1y2cL0Z4MLC/wplUhVDa9ySoHuTq/BXXVCJDBVD3vmc8ID4fRnwS3qunOL31zp5984FUlMdXcMiHEccHhZPaoMq2xdbW1VblXR8YQizSm/cphzYtTHcwZdWDFEqRB1mT0b7BLECkgztqeUa+5H4ZSYbqs46zvzjxoKMEveOHLejpFBLbx0JIG849FdoH+aalRE/tyws84LW9qMVprTlIEbpGJHfHmtHIOrijSlF6lhLO7ESys02ZaAjkbM2G+4pnm0QcIua/5V4mH5VCMTH3bWJzKoK0nrtGRpEQmv1cbA+lCECDLhmc7a85x7nXLBA6+VYijW/R0uzIaqWKGkwXcPNTLxqi5z0wgvn8hkrvCQ6ufTLN3llDL9UHmBhTm0TiZLuyUplYL60tT8trpUg4nyu5/z1p6297Aned9PpOsqoD4vFpAYjBTy9095vbVtm+5QBihXxTM2cagIAvWZsYBmlxcLcTz3dYPmkgEgxnE8PxffzuoCiEHk+JSfhpEi/ipze/lBYxsJIEuoZ/Q1zFHpNsaDNyZlkFu/mkqzuIYRQra7X0G1vJBTinT1QNyfvevhocpON4mBkWJShrnuCVQTZKxU5LPprb0Hr9fJk/ukTOaK8zmkDHNLcYdVqsHE1qz3jTkdeav8ZHIoTazSOXK0TkleuoH9rr1v6q5e1yWkR1ohhmHq2+T40kNGqGTfuo27rlTDUgnkMJ6+u9PXdvzjJxqZKA4JkzLE/fzTbbFpDpvvwLAIrYPkoYq3/X3cX6Z1CjKASeGbAm6UjwQa1tLQi/RDOyQJm7c/q3dtu8M3ND0rWgfJdZFzk32jTSbQN66NNh2BXa+SSBDvS7but2PBiVFCpGFKCyVoHSZbwXNW8suOYwWkmafJuuSaZd8qUIb6/Ye//vAju12FUqmp/NsSKjV12NYsYo8yNbcf0Zeog0jFRJ1tQqRiHg4BcE9CXwvKKVV0+Xud863IY298q4qimU4AYiGOl7p+1aQpoVOQUany7ApS7+qxnN4KKYX1SOuKq8IDs5rDVuSUClLr5hVc4xKYIafpt7kfj/sUdztg/RkxsXMztE5B7o8TMrkEDmUKLjySKtWIRPtSbKYK7JD09atbcC42u5QMcX/Lmk2Lr7ZKJCLP7Q/aGvIBQzsiDf5yv83WNBMbaoQVVe8IWPv3iSpE/vCPn0JkNOGLuIRUAY9mxlMkMSkegZgdPT4K7OSJYOXm56+vNKQ3wcC73WJf9RfE7PYdDQkkEOZ6sqsmq9rnutnOd9GNkj6TUkJ0V2+LNd0Z87mJTIYyCx4SKljyEGFP20ZAooYaDS5c18hna1aOI1EMYQexKMevmWh0cA0yvKSZTZZUJkGDpUSQmygldHBTMConnFiIwL9eVcATUhEeLAVEKUNIIfy0NoCHBhIEs80ZevXRLEDC2x44Vqg6C8nXO7QUwt2ldu7cj/bnFrUuhE7E0nflsV9KCIOjS68jDsj0ZcQJJLynDeYGRixEkNytBlKDFgsR+OuZo6UaITwRYrC7hQjku9GOMGJrrG2HyaudPQ57sXOEcTdksF/gZBURwyUbGDRqIM5b1sjzIhEESp06n6vp0NH4pMNFYMneVohzS4eDA4N3zKNSwnPBqLoDehzN6V4ABnuyQwx1lj2bHVi1Pgq+ZBM6Afs1a3KTc7DBihD9RHyxnr65a4HigSAPRugQ9jSTdeF6nSQxlKhgqImIRRLw8OX4LkAskoCBH8gSAxVCwkUkHlRcQcJhoYt/XreBOcubLUNAf040mu6WEAZGx4xu+XQwshXDvPOxGZanwKh4Wo3PxIxWiY92ptFcYkNaCKQPXeafGeilaMJFNCw9lElQN5XJopwRAr6+4vLrCxCIPVPFY8GzVEJcfJYvW4AoIQTXm3S/ns8b7QJmwzRF1FAtFRhVxWDUP0EV6a6GkFTQWxlCUDggzOd+QoewfvftMPVDYgndmViUCLz8zEjCqS0cQzq9xeMPLguf7JxYG4FYq3FibQTjEYS6OCK9OprTiYFsjcDLUST9IYK9g3ZVmDKn0bEIAo+nZ9Cko1WFEL8eqdShNb4mq4ZREEfqsR+NE6MI0tPbWDwtxfD0YC2Ap8WaCPjelrqf1e8tYhDWAoNGK0/5PEAqIfo0XA6goUaHm+87mTeIBCB2ffh14AkomXYPMeS0ewJx6+RsJmWy2GiXMHyGqhV5ibsYyeegO5FCXHT0Cp8TKCEEK4awzhi6So4r4QcGaKkEb+HXDRQYJfYg9L0HZk0/W80BvT4aOSew8jMiOS1817yJp8ZRDDO4DHEwagDj6AVEjTIN1HWEIM4JVCBUoPh7GmiYzdOQZO0qDFunqafV0TYugsdt4IqgqknesyZ4uZMHWDoKgCMiVjEFXGYFU4Qp3MHxoD/sCzDIbY9fvTTOvaCHjEMJhv1B5xdnkAKmVyhHAPoG5Qg0bsxH48KpDELjHeU0M1ZBpHTiig/WHLgS4fmdkXyOxmGE6E7bYt1YdsFU14QOYvsLrqOtMj5utCNMuGeRbwIJnQaL8lmk0eDcsT2Q5QQakM0ntuBC1CDRwHJlRQ70KBp6sw+bVXk5ioTYUsHGwGgh3o2H8k3maBYgye4CPseyalUU3qJwTPeEKrD+uc945mgZO8eNZMLKUNO2QUPcve/McfFq2gL/9b/+42//+CEk9M1//ot5JyAnm5oTza1EJGpShWV5czGmtR5Fy2EToTIGehA8YINhcI6adtgCItNbI2jlOHQSuMNHXGiXecM1hMls+BEXmEVa02Tv0+HinwTl2USOtws1Km0HWCw4hxiP+KRIcrgnYbriuDFEOTsZREK8po4pKZxO5PeX6bqpg/iM1gM3sit46drDE4pZcIgoZA0T2yXedLvr3DWC/bq5Zh/uKhiQhERFpZPNM4kUt0DJJKl1+FkO3bmlXXSmCIwS6eM+WjozMA4/S6Gdt3BYPBsTPJOOMpwJSWMGm8Q53OtdRoNWAygwqkgu+1/UZWnWLC+UqKnkYZsRlj1rk+Ga/NPeNEmZ8W0y59QyppiTSaK49QBxcPebFM62nTPz5k/cDmGPvyvCF9VQQYfzpyeMb5Zotk6IlrIOmOPvivBEDTb8qgjbL2AgQve/i+GPV5M22e4lgfhGLYkaSgxx7CgiyxxOAed4g1XLopPLN4okdyNnusvhQPKNEmmQZSXx+T2TRDnc7vS5XmdP+zJLM2IikInDPB/ZtAZGPYlsfyKzTBtPlCZ9ukQgEk+OLuGDBUY9iXCpz/Kn72sm4WtlmtdsctfqlG5q+8Bm3pDFJbRKrD5CYn/lwAqtEmsYlSES52SQCMdRmBhw/F0b3i3BvrMPzXGOdpHHetZ6n/p00ApZKEKrgrX3rt0gYL75TFpSXcZ2FY9qs08GNQF4VpRG5BZNtyer8tGiZNDZITCKJLYx0LcCo9INryfOVmTW01a2MuRhzqpnkdVTZJZo/eijm4skvp1vU3PIuje0Sqx+zznjYvg2cczi4mL+cLd6vLl8/GX620h6O5yE1H4fKkLejxTqfjG/vV8h1KBQoJbT1erm7uPycTG9nd5+mC4eZ/OPN3eIzQTRRLaaLyYfp4+X0+XF4uZ+dTPHEaVyRSSr3+6niOrsEDOjQ89goHs60D0KdH8/u7mYuNd6/HnJJEWkUeJmlyriQaaEzi9WU/dRFtPJrUT2tUr88n6y+DR7fLi/nKzoD8iJlRH8+vjly5fHq/ni9vFhMZveXcwvp5dSRGQgFOGSJC5RkIfVNRnI/g6CuX3c7LjvSCFkAHoxu5naMnKxmF7avzeT2VJbaHUh/1zUXJEWgqDI5ncrF9R+0Y906ocKNepxNV2QpYOQKaDsm3t2JUZ8spMIAC8vKMLlBQoyvZo8zOxXerDf5raPhSwjlE6BvZuvbq6OpfVqOlk9LDCfDKCIaPnw4ZSNH5fXTDvBq0EUV/PJFQVzv4Ng12TGvUaZ9Xq1Ilsq9zsIdjO5m1DB3O8o2N3l9Ffg+Ph2iLG58m4ye5zMyDT37RrMdLGYLyCoV2hQnx4ml2RuCxUA5Rpg2xBTjIMJBJ5dkl/T/owCzT/aWujzdEY++GgFiFsyN9yivNAXOzIXDBYQdH5DVzvudxTsy531TZXNFytWR8BV1akKIO8ny+WX+eLy8Xa6up6TuSKSaGDKNED6c6LhUoIUIvAN2V7Zn1Gguf59aakSzr7lXP+C8+XNrzTDGlDAxfTK1lHTy0f3P4YRac7Asa4CKQTgxSXZrtmfcSCyZnK/g2DL+eyGLDC9QQr4SDvuR5sYnG1TPLMOwiZ+rBFxXGM/WkWErWPIqn60AsRqens/YzpzR9u//U0BePw8WdxMPswg6SSCwF9X9sVvSTfiZJQAt5PFL5e2WmchR4EEuvuRRdz9KAW2fuuKS5GTGUAe7m5Wjx9+W9He8mhFiMXscXlxPaXdgdEKEJ8nd2Q6ut9RsIvJgizsvQEE/DL9cKNuIFixOgKukUhVAPnrknxV+zMItK3z/XDL5n2Zrc1Lv3aawpBCAM6e2rrcD7Mr4Wrg533Vrzlov481Ie6nv/u4/LihzluVSzIpIQZfRwd5B7Br4hzvGHCMJz0dIEDFMgw9Tk8J0FiGoGV5tS+fi7L01wZ5NM+OMG1rmu60npMkhRIRNi/yNblQJUZGQhHstvFRZ7rF3FAHse740Lpf30jjRjvArEuT0TvNRlSsgbi6Mtz+Pp+YyBC0rtZZR3J6CwraLzWcbDaN2bi9COHmBw9E6ERsr7o1bRss2Y2hvkpEEkdARZs4YzwXQozqdKVYf6/6jo8hEopgaiIxZnJTigEuN+s6Nw9N4ark8bhGispIAdzmZC2ckUJ4Pn+Obzv1gSczhLT7xsxsheCOmrPflGy6UpWIXDVZUcrMQIagLoO7Odh2VaM2gtIhbL/QFGemWINxrq6enh6C4YUiGbhcv5gtWfwDAQA9m2794s6JbA1Zyfl2hCnKjnYeBosY9LAIikyYUAFRFdkQu9+FYMnxl2Fo8vTLGFK0L0LznYgQsHY3/UU3Lnio0Qwgm4MTyO3KH3m08hy0raNUYKtTYKXzBNIINMcKkFGdtjA9NCWKwNdBbHc4Mr+uuqZmkKHmDFy6iZ7H0nvqIb4UehZIj6P54M6hJhZqBexQhIHD+QluleJwKyaDjGUYemmes33JsQ5WjDhd+cpATnaMORxhRvuMvh1jbuPLtQPILXWrdoLoe73u3nWOchJg0H1dFmuyMT0ZMWDY5fBm2JLqKzBq2Ap/0xnSSwoEGOSvoOT6+IRMgL7vbH1TbF64JB8FGDRoTC50s2glQrttNLyX6ZkliDnorpqaR/kiAHzJWt4nOhkBoDgt9r+2jucVWYRjDcJt3TkHrr9+PPKHBCYqhGzHs8yJvQselRLqwFw2jiQQxnZ3DyYYONm75Qcnd3BFAHL7lg9hN3ERoHY41JcHHQQQ1Ht9VVa6FLRfI1wU7AMJIQQfVrfTsIMRAsKxENSL4rQCnj+0J0TjU3siLHmihM9jj5SIQOH6Xp+Qru2NgjLNUG+AAfs17umSfB8RSGTY8a5QADtKICw4hyA5cNRnUkoJ7bb0a8CRDmB/r4sKtby+XcAwX/NgAoHLou3Ck3XwmA7Sg2i2GTlQto03+0SBnIPXHm8lGo6dYZtIXi1H0d9yLLgZjFQJ5+rMWINw/X43EtJbcNA9n89GK0K0q/pyH59q6kE8O8BUdbPtz0lBGT8RAeDO3ejjunU7srX0zDqILbYNM6CUqnTIS7drv6BzLSHTQaducDU4WYeEHmU66CyrrMtKj8oTMgkq+AuxRsIRV0pEMOZaiRTldofws4aRRIKdttSR9UYkkWF0mTgZJcCnfZbzD9JbJURfbZJelGeWIKc2FviypBCBi51ZZs+mJKvB0YoQY9W9quPDqTxWKoPQ3lVd1kwhH80A4ppTtyWf75mGCgF1n61fbRkNN/6HLE8iwNKtnCGJ3tKZYJwLt6rZHBpJVDD+E8YaiMv39LjeYIFBbTtw7Pcwh/v7OE6No6jLNzNpbViueog1Mu4W+gSJSAZyG5kTKNrTHIP7I0asZ8FP8yQiAGwzd07bH26Eze3Up3CRBMGOp9iz+TlUQFT3sayfFBmIVmK0qxP7PPfmby0NmL4EwdzJl3l/9tKtaWg/IdYg3K4sukmVX7iFEiTLF0gg2xHZZktj2xS3dIjFhTIAtamxXdU3FZlNTkYEqC+yqq6KtTvavuBKWqrCSO/6Rc6xSlUQOXO3edBZ42SEANfNz7mxCM8MIcNua54y2iHGds1ydwGE4UmBBMGOlwx/2tddP4obHgnnMUmlBs17M5EEwoqtv5CB7r+mKgEZrGPgmZEMQPdVYR08trb0zAjSn2zbn/1SmPyS8UlSFUC+Dac2mC/F4YIPipiIENDW+8/vcIFdJElg//P/3LqbcVEBAQA=" \ No newline at end of file diff --git a/7.x/docs/assets/search.js b/7.x/docs/assets/search.js new file mode 100644 index 000000000..eb0b4c5b3 --- /dev/null +++ b/7.x/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8y9W3Mjx5H3/VU2zNv1WJJt7eHqoShKoj2joUmOFBsbTyiaQJNsD4iGGwBnZp94v/vbjWMd8vDP6gTXVyMRlZW/qs7MOlf9v9917afl7/7zv//f7z428+nv/vPrb/79X383r57r3/3n776rq67ufq3vr6aXn1ddNVm13e/+9Xfrbtb/OJlVy2W9/AOV6M3T6nnWp9yl6VP/7v/7172GP3/9zUHDpJ0vV93alvFZLBUo+dffLXqZ+YpjP0J8/dU3fzpQzNrHx9oCcBA46l4tp79vlr9fdO2qnqzqaSnLS901D18MLAcBgqV5qVa1geSbr/50/PqTav5TNZ/OasuXCWSKvktE8GRV/+St+7Z6sOvfCWXfo5k/9d/KZhvffPUf//b1n48Oc9HV016wqWbLA9fqy6KnCn4R3e/bP//5j98e8vvtt0FayerskIqu1xCKMevqcUgKqXmzT6sqe7Pj8ijcVusux99/bVC/42UK/mn4skUIb/aiNpC8UiKeyazBv8Qh8et+iq3afUV8Y6mCHbFYePh7JBxvAnEjkPJRmuVyHTRAMtUh8et+lK3afWX80VIHO2Km8IPyIoQ3W0kjBvEpgi5PIMZ3eahELl0eNmO2yyM1LWRZzI29wEQ29l5ETOPP4xCNvy8L2RnQeEydAYUpNNTvr9trpWeeJ3ExUiZbqFdOUDNRoe2ax2ZezT50M3MJzxhhpIeMEzI9dY7J1E/HKZixC0dhHLmIHGAAYe1FHSvg2plgwalWxglWvWRgkHWbwoJsDUFQuF7fz5oJ1IbxSV2ChJJ9UXsmlM5mFhqcYh52Dt451Hoyt7GltUQaMVZTJmOG+EKj/jBv2jlk02xKF5OWc4eaP74onOG0z/fNPP8uKstezIljWa9+qWZrM0gghzR7CFfU+m3tr1tauQI5viH8F8mM7Z+SjQHaxzSHADMbEyehSjwdVTWbXZRWWiL7Wh9ZCKVQZZoiKeQtUSBd1pN1V18Mkaqar8CYqgs5hVdQERhpgbJys0TEHGsBZZQLFv3KmZlhAI4rDQzGkmKxBiVVemdj2KQYDX/3gnA9tjaZgGOrUWPssdkqEYaU2Qs6mWuoscxiIJUxasQuQRlH7SqP0ejLRu82CiUsFIziS/SLjuQ0mtetJXCW88mkXi4vnurJR8Jmol9dXCPPscgjYmyz4VEU5rAKMTBmRwAYe7sG7aTRsQQmW2Mp/vwtbWLn3eOx09PMV3X3UE1SnCGRaG3x0u9khud4tk1Ne3ROyqjs1sE31XXuko9USnUbdd1cNxFGCIPFsP6rRIwsiU/YoLMtix15KYzOy8Ao7QWuVwhcXD3Yo5exFuggItaELZJIPJkRXgx5ApaYp/MzRybvcpskClVgmBwWYp04gWKibN2U2am1ZnhjlWvHbrEiWWa2P3btegGYbZ7Oz2yZvKFZD64QBWbKYSBmihM0y3f1833dvX/YyNhQcmFk7sJI+FCvJk9/W1fTfC5IhIvkTsClODhrRWUObrUp3sFlu7I7uEgWjqNm79rpkamer5+HPtnmr3Jf9tvQd1ddOxMyOTsm4bpyWw5+h2ef4rrunpvlsmnnt3W6VS/9WWaPdzb1Fjcol3c2ZYm8djbRGUNxjWRnuuHLdt1NyH06DMBBAPFSC0lXb7MOP6KOE0s5MOH7vLgvpE71WAj4fV2MeqXFsevm9nGJ+q37uEQrCfdx1bN6VV9vJIWNTlQqn91cbM7Yhi4S3+aaAoLJN00sknMKQHbvNFE1m7mAh6bubvuUq/qR2F/Gw5HSHozoTi/BlvTNXhYGbr8XD6Bt+bJrp3d9aQS2jV+a7QSB5GqYanqup03/bbfxhw8nQlqXoKLlD4UWqUAFTq0y2V27gHDJubWKt7S5dAkbHZ51MkuQxrjAgKPbmRp2CniY4KPCKCGomIQMRCCNKRyBNhUEJWW4cYKBhmWIIZV1bHca70iPp2AMEuxMe+knzdCpQw11pd/Vq6d2qpkckcjH8LiMocaOZC9o5XgKe/OmMKGOwNeLGpwtBJwTsOqVcGzXTTuAot/mBoqVBM7w8x+vq9XkSfEGMpWLO/A5Q/5A4xc4hMBh9wiNCnQJqW5UnzAxME4hACheUaCddAuVwOQXGlW6n4acCt7/gM4G9x2gqZzJ2S6JtKqfzAYH+VeLRT3XNBwSlen4NFSlomKfpkzDZNNPVFQcEpXpmG6GyYqOQyKDjnxufpOoOi5U7Sfld38XbSfNTZrmx+f4+Vxzzug3eOXgtq+kf8w+LKb6+gGf1KVRUbKHWhahNAXNi0Zkb2MgPrChUetLbW3sNEyTo6Eo7Y6do1luZcwkgeBpvlevYL1YtN22ETPDBbKn4tvOO17Nl3VnN/lM/FSUP7f5hgEdbit1GqanannRzqfNqo+w+X4B3QVi6ZMxbr9MEeBR9GR0W+spojuKnoqO7dBi8c3Uq8Vaqmiz+OKm73GSG8V3vzhtEg9zw3YmHdBspyISVcaDEKrWasIvtCWq46SIfWHa247a/J2r3qZz0QusMiYExSuLFAu2AT/Sr+0607TUW8859n+J3VyxRlLCpcTbwU4f6Ve9DtW3ksQuBI/16vLhofeW5qW+bmfNpCHCbQLCyHjxnM/7EVRv41cHQ0OIaCkXpmHofj7pvq9WlQYSJ/WxEeFoTGwfBcdiII9kDqUQXmk8kJJr//ZPoSW8G2ZygpbgYT2fbHpEfzj+KLZicXYbW/1C57b9zZDZbp9hsg0wyjNKUpr1TZ2sxfIq9klLVc3q6T6LJaAuTA5PIJzPZreratVMuN5J/LtPH4XIE+upJLBMG7ogJ29E7akIFClYGqgVpTC0thTTKEQosubtccpScjpa8aW3xSyeJDxGt149tV3zP3V3NV+sjyYRHgGLk+BH6LSjZUS+2MGyhJmdAPvHum9n6+3KE0yQiY2CqF6qZlbdz2qqE6ehMMJmoDCoHVLlhnf4ySeUxdmVHWA60todOtVv92VVOxfAEtXWQ7igXjp8kLptkYPSHxvR52bWVN0XrmWMf3cypzxPrGVMYI0jeUqtdTyPEXR4ZZ4d0kKtMaa/2ifjh9cUCiU2jgpzMQJF6yNgGh/6P+2TkkNMSnUu5FgHw9z0sGDaCx0kMCxG0pFNCsCUxxZEYYOdMCGRtRVjXGT9KAiO7z/N6+7YYDMhkkzlEij5nKFwSePbgqaAYAydJppFO6UnJgWeQAZxChNP1bejbCwVmBI5d65h7ql6rEvQclEPOiTgC1BK2DdpH+L4dUscmxX0BzI+Vp0RbQTMTAepE1DxYV+KP+bgX2A5ZBOgWo+pIVC9LbzceCM0zENVTS/FNAdkKpfmgM8Zag5ofFtzICAYmwMTDdOfFmhMvWoTC7B2JXAVr2NpjNC10zyXduO0RfsmiG4E8jgnIMRi7nUyTLdv0sdzSABYJunOVk2nh5TSEqEAyWfhTruZ61p09YpQaPIFOR93buESdCGy2u8/t3sqffW55q22W8+1GBc1dKun76rlsNLCxN3od6fGLc8TbNZiWGuDRqg1N2UQwX2f5EOXbwckEY6JMTeACBZ9MiqoEPr3ScdpxxolQr3aHEEan4fF2m0SsNiJhGPph9bN4E5nUXpHDikIUh5YEP4M1sAEPtYijCGP9Yow2B3anE1aYVWFTekTAMXcsVDIFsUYFGUUa3i0Uknb3RU0+253hA4KYzKYFtCsFF097MHe7oy47Dq7PVEZnKS+hkXYptvsH5W6iRotnclJiJvlkGYYp00qaou8wpqLn4RSCORKJLGH9DIfoYM74ie2MI/QBfsk0tkedrcEmdBtzwSfO7Rzgi5F8f4JgQbcRaECkW0u1yU6xXKKbSUFM7nizpbTrOrIqXh4Ft6PQYkKY/t82FTu5uUa1QrJVC6myOeMP+MFG6H0hBfHkD/fJb/3YOB5rrvHoBV/Vy2Y17NoNlocaWLHUI5B9OIzPDwm+dPoR8fGRz/J9MoeGxsZB9VKOw2N/sAYs6zs97iYQ/BWK8/+qBgYxoe+nr6DLUvjtilyxE62HNy6m41Rb97RBpOwu9oYEuPONphD3IzB0hRsxZCZ0O2jZfvbYM3b7WqrJ1x3IOFcC9GKTnhCRWUiJD3s17DB2G2Pm9Fm2K2/fnvdRM8Kwumv9f35ZMbE0fBHlwCaZQhFzojRFjJzhcZYieiuJjM2NuUAcWrEGxEGaQI1Z7DPmcL1QO3gYyoB37iHaAc2aeQcxXszsPqQHvWgKiVOP4IDaahyAKWFQnRtdnQIQ6hcaS7hVe5pPVwd2g9qbUCMmBfV5nTjbHuoFMFJ0/ty3AzPAi6bF8Q8cgkvln33ZJjErYZDoMPZt/qZ3E5EWxAv7cc4W9XM3QkUU5jai4HvzhAtq7kfg8cSsgPDxRNTz4VjiA497jo2V3zEj87mscnxif3B9PN8StSdsVlxwwK+tMFh6z//+Y/HGvrtt+HqNUe6N4cczZBvmPKaKpo5dFlUFukM5j9BVS93df37bxxrm30/cli49DFrLqd/iqom4fYV/W1RRdPl5a36dn3/9350MT54UBn9U1Qyxbav4z+VGnNeWqVRgJoCewOw7n9+/2kedTNwFWeMuFIlHl9L59h/o6+BiHPIjSwQG2Rutns5plfzm7ZlrikgeQnRV6+zlOFQX18Z6isrCDdmnE7f1atqGl4BpCPGUq9eQ4F6uKdwyCFkZyrlpZo102plQQpEXr069roPhgJEv0MOB3C/nqi5/wkdo/WvN7HvifSHXrHPae9p/lNV6tLQML9e39Lao/xfqlKxN/nvpkbhlH1IY8/xf88+2V4j0DNH+4rRq6Tt86LdbBvUrsxgU7qshsi5Y4+UskUpnyVXsIqnzM2sz7tuwY/1vO5T2muQyuAkpLtG204YCp6ErOXGLCAgIX8Szo4eIYCUmbQXYzZjLrRoIKtx/s+JMp9HL8LkJ8/MnHL3AA1Gplmnkrrk21y8IvEpGzOhOC8BEpomJwq+MzP6hz8xOAVgJqPG2iAUMuA282TDXFsjwo91oWgcdJDeNvOP79TGl0zl0jHic4Y6RTQ+t3GkT2wB2KVHGhgTB9AxE6iKO2UaI7KRQOBSdhSYtPOLn5K9mFdBC2qEXA5Va8W0LqraUvwmpeK6p3Fbo8sqjw6ONQo3gxjrHrhrOFJw70I6mSNqijfTh1/YsVH4o4sBZhlCzUXEyB3sa+cvdbcien+kzkNabJMhQ4AYV65eCbmILt6piNKa/QkvLWnEXIlN9st989B02/WqmT8iu00OaKqIj5ljajDj10vJuER6f7+V7igPOomFtGTcjoIbB/De3OU1bh3Sl5NjY3uU2zbIH1Xf+mjfUNn4sH8U82ZraC99Gz/fUQCc5XQCz5RCLBxYTxpOxwdRr9DpGzBdppJkRNNMkpVPnUiS2eB5JCuXNI0kIyGzSFYadhJJRlHnkKwc9sB0qnB0ou6B664KH2ZrRBm7bcHuweMretyugIJ6tncJHBfekZYlfDV7/fDQfLYMWVQJlyYW04I9pa0WkWt0N4KlaAdpLAZZKEuCEUhtHKo4UxPP6Y7B5gcqxdxYQAKpbcOUMXWthyS8ovFBio34P/7t6z8fg8NhsiW+eWvY5bP8Q/yjGHDEzUZsbmfKptSEjt2isOjqZS8R94w1rW8yOQRiv49WXS3CORr9E6sMQVvDz+v6TuqCM7pSKzpiwnP0bGfpxK4+q+uglZxgHT+7SmoPDmt8106/XFfdsu7Ou0dyn22cAj+msbu4Dszy7Jic9ocEVNmnhmp91sZ8vNrA/46Jsi94/MnFA5PsilwwoDX7YKbf7IS6dsYLU9VGN0T1kn5I6zY5Iqk/NKKf/3g9DLIFW8pSuJgUnWuRZeVFMBsYR0PaWZFuxrwYxcoSHqx1Mfy6SYtqjiSQ/SMSi9hZg0HeHP/z919rx4vy3MiMuEg+rWf1ipiYLYJ8c8xtFKzWFZz3ksQ9CWXMx9xOydz7+bRZkfdxlGFHGTqTZzdV/G1dEU+MMeChwFiHykh+qbpmeGHYRBMKuRK99MH54YupdmIRVxqhZRXDrqmBlWiila7qk9DGRr/6rGllORa1rTE2t4OSvnqLQDDevcVph/bF5Nq1jTGINmFnDFHj9q0xeInpvTFcqW2bY7ivHs4096n/MfuwGNaMBMumk/nMKfNZF9k6UyKb0UtQRutXeUDDFOtJ7eHaKBhnlBAUryzRT7qGzmDyEd1awqF6tWwmF4cuCjdqp1L5DODZnKElFxrf5hgCgtEvTDT1XfW4tXATUizmwwVNN/BIip+YtG96u9/3lvsTfe+ngJGLIp02O93wAcrgQkl3NmGSSvAx+3yV3ZboKSTNnmyzSZrnRWeslWh3kkBni3FSWccbhJctjAwpcDTxYyBN0c0KJZZgjeF91zw282r2oZtdfl511fD1udUGLi2+7iCc3kL1aGe4wjpgC8fOEU1m62n9t3W92ULSzB8L8Kg8yvGCWEElz+yHSuQSM9iMob4RyV5+xI+HKT7hZyLk7QQglA2kmBCJcjyV0m+y6OZjvWBD5nhvrw0y3mo1Yoq5mg0FznxXdY/1ivfj5HcXF6byLGr1U3izIdAkZhsAORhnICGMLb6JgDRAgcJkezxJ+izMYcs50+Uk0riYH5cv/CxMCs5E5+E5k3fVAtd/FEDCsEyCPn1CggBPn4Ca5Qc96K9Q9KCHqSbYBz2E2jA/6CFYSTzwWvUyb+v54+qJH3ulabyGX2S+pSOwrCC2OScWxzjjJJOAgzCaRHEMg2ZxIMp8lZKxqK0muKGgVBvW0aBkJblj3H1Z1LJbHFN4OkWS6xiXCIpQZIYpCmaEulbVBLM6KDVAtAYk86NrocT4SJrY9NqPDW91xx+dDC7JELxJMGBkt20MaaguCKXzmBbpfTD6MbNOlasWreuSjDkra4Edo6VlTJgusdF66S+eXAR1U88Yy41+dTHdPEf4wqcjpq2TQKg0dg8w7dtElO9QBGFqxHs4BvT6pkQ/cG2Tqk2+rin9ykXXNIElZq9nIkttvpaJ/Pa5E73fnLPhOLa/ejpRkKPFiXaYjBm/VLM1W5ehxn3CEbrqxVP9XHdV/qQkoS9MPEJnNZu1n942S+Q7nYWJbTojI203v54PmW2MS9WbChgChExSTad3LXuWnaqBRMBY88SdZUxTE//s4iZElqOuKiuNhiRH8SVlRS0AhVB4PVlxPOYZii4mEyPy9axq5n9ZtvO30x8277RlNFkKF5Ojc4Wic45s6+Ywqo1dHYkCMTSGQuluwFqHbtNP1XIzLPu86kMOfYcJVxecNBJfYUY+EHDWYY4Fxq9EuqP4pUweKVpuuKN0tn7kdpEefvLZORpnV7Zb9Ehr3CGaKLfuCqX0QnswE73avktVj7DjNK1fswWjpaR3epIlte3uJL9uuNw0mdSL1XVXP9S9yISb26GT+Sw68VkXGTRTIuMCkAClrQGZ9AvLQFK92FeCCmqFXgxSa8a2HqRxRd0dzUxPYqB+pjneKLzMYaR7wI7hx0A37l5mCBrgTTV/rFUrJFM5nYbici48FUUVx3o+iUVSzykZtEvnlfg6KTi3ZK4R5vySUivGc0wyVWiiH+bDwrpmomQqFxPlc4aGhzQ+ZxTt830zz2tfZNiLYN1UjSfqKW8/LXFdlAAUyPBE/yJZh63KWD+SKs3sRyYmJrKolXYammo2uyippETuNT6mEIDUyjMFIJUqvBNnOFxxs72PZpuQvRuHTInvVV8xOzQxFWe5OB2SmAIxUAsu9IJUhLwH1jM9LQ1CZdIeSBPuZA0IRch7YN3nh4BBoEiyFCU9bRklztw8T+J3zjLPFj9kGVMb/VejkBxXOR4HcbEurIGJvutBxnixxiW4rwcV68iAOfEe7EFG+LLGxDhxIQ18VpYgQQ7KQnqVs57Uhyk76GmoBf6UJ1sT9iOerI2EQ3oxvvqHVkNUFYeE4z68yzcfY/SYvTtpp4foLnaGmNj3m+uz3i+GB6b6YMcd46eTuRidkDXUpjMlYKLuss8qr2+JYS+BxFuVBXQBsU7U60RsFIwTSAhK9C/RT7qBzmDyB91SAsf4sV6pXkGkcXEJLl/IHyhwkzOw2i2eYKCQrg9hWdTLQ4xEoGPyX0b1SoN+xiVZ5Yo/mjWTzqhoN3miYh2BGw63jKh+SCVycUQ2Y8gTSXaTK/L6Lb5o4ZCckaexe6PCBLqj8H1Uf7QQMA7Jq1c80q6bdElNv8knNabw2o8kWfzeQHjZBZUQn0Rt9+K2vM9COfoD0CWgQ5Aafk4SemxhR7xXYLSbWVzMg4S7fwJ1NT8G+tYHL5cD28Dr4fZT1QrJVD6bTNicsV21JL5xZy2PYN1da6GhW2UBxtIsayTothvh66iNoImB23DDA2h7ju3a6a02GoFtv41mIaFrtkt9mEgl8nFMLmPMLyl2o1uyAFavNLAwTsmimHxS5kBdkv8uukcaCDiHZNVr/mjWTbujot/mjYplhM64BnwxT+Pjiky+mCcS4EZH5NRb/RAnYdyQAzF5IU6xXz5kL3tjgQjJ8WxogGCtRY8PuH4uPHDKtehg1UwHB1m7LTbIdhLfS/JSd8Mrn5dd13ZcdKCTuQQIIWvw6giyBPyy95DaVsSzUArxBRuTunVBQivcvmAjXD61n25X1eTjXVcRbylLfJmoCx1+8wv/TdWIYqPgb71hEfSrb8z6uTtnFIYsupRz1NstPpuk3/dNSTPLt9ZKQLT8Caymq3v5m3q56IOM0XRSUR+6YCIxTMLtxEzT4NOH9SAJZ3m2T05bR4bKKBUeR6TVas8jSoqDFk5s19xbM7wNk9rvcVEPjXVjCZiIB8U5H91ktINjXAFDvAlp2nT9QEHrOzHpnDYm8XkXblGiC1WwWUkiU9teIwe7YUmA0E46lRAwm5ZUCuP2JY0sOtneZy3aZ5rA55Q7lSnUn894jSfcScXWc+4gQ22u17NEBOk5oDRKL53mKeqfC0TQbQAkiXYnAKhTuBmAtkn7/QCm0tO3BAg1YLsrQLCN8MaA4bqm7bHt7fM0vw45Eef66XQ+dwYIeWOXVTOF4NxhvVi0/aB9+q5ePbXEq5AiECGNeIaRsdqkHK7wNOLFgj5k0Iu5KJX2Vi6XT1gwbr6EfFPYCPZmn0sxnvLK7KIl7nEzQ7bCAMiBce2AuHYmhK76kCC1uz5UR0heuh2uDdrdd1cUSpgcfJw2Ym2Ww6oQd5mfCJmKnoZuXQy3PjXbdhN0IV4qfALCx3o+zOhvldj4UtFT0m0kCvH2sifgE67sEbsl9jt7bFzSpT16jLPd2qN3TaInTT43s6bqvgz3Z+7vNeR6jXxan56jkj/41AlfINsQU8UxjjYLyKq9CLu8q0JSWUCOZ6ddLupJ89BMymGJHE7E2u1uXrwjO78aZyLtx4g9gKPQqQ/hmEmkB3E0ny14GKewppgHcqDaMj6UA9lbvP6+XFXzlRJh6WRe6+9c1uj6O1UCxr2eNi0PuSLIUhxlwHU2mQdcteVx1FVbg35x7Zr/LiVPl5hrhVtLVmrG+oiJYj30Izq6v9ApvVxGyH3s4zpjDVdCwx/bcTBfsY7GPL7jYcR6LZU+xgOa8uaBGs2K80ROBsxkbHisB4v32qM9NEPJ4z0j3YaDgR7zGe8sbF0UPu7j4CJyjRQ89gM5xu65BsUzyFQursHnbHnHBBxfqs/ykKPLwud5Ro15JZ6iB4tGuatAgz0eNNZhJSspfUxotMuqtVLyuBDktL0tLjZT25LPUolcXJbNGPJYkl0cvVD+yjOEMoi3KjzQiyo8jOwdFt3CmzL897C/LGOuDfp9F6VGbK+8KEzBPs44EXscnEiG7+bs0i2sQMZnHbV5NSokQa4cNTEBBEJFAMTrTVzcOUHEcRr1jfY0Hx8bFWuwKOOlX3y9aaxfQ01dO20eGr2xI5P5GB+fdZkR0iUymoEApTU6Jv2CM0j1YneKglqhjVOtGZuRalzZ0weKpRJpfLYmM/mWP3owagDD4hiHLzIJ/PhCgZ8YNCsPL/h4iLkm+EcXnHxDsZJwU3RvfNVj/X29nHTNYlixO59uTueQD4AJiX02S2sKsI3TUpmMm6hVIOuG6gK25VaGXTTWIfMckAFYCet23felvq5W+c5EHTQRd6SEtmOrfNrW7AIWYZu27g32LdvFtUVv3wZrzLaVG7S7IIz9Wk02u3qUJp5O5hK6hKyLGnqmRDaDlqAUU7bpryazu/a67p6b5bIh3vqUQHJZxO1tfNuDqsOer+VwW3v1bPt+hPQJGNlAILKZQ0CJZZHOr1uXye1VrsjhP306X6+eNH+nUvm4O5sz1EWh8dk9bkRbKgDs0kMWqnBAQYYn0WKMRbvgHsK3sHuHvUZo59BqxeYbmr2EK+qbaDXdn8oPmtEMkk/qs7ouZ4+tsfOlYbvL1Wq9vGinxFquAhSJgiu6Zr5slhilI2eKfdmKuE7AFF6u+hGxZDKVixHzOUP2S+PbTVfAKLBaExVrsAKT2VZNRFYaX5Lo6oNlvULsk0vodPmBkDlkpWw57IYqwxTYqpWNNVeZzGyxVq4CJnee2HQRqz2VwY6yVR8zNVloIYFkjAY7LNRu0zxGa/7w3zY5MzAj0rgYFpev5e2/CNw2XcyqN84SG0ie5REwS5TJIcNFmcv2bBvxjdTLcAz65efqcuXYe3W4ZumJOE57yRtxnI0QkZ5b9/R3Q4sHKk3aKFPDrWw8BXvzEmRrXvqZe5dcLA4ytp1ZLrq+NzJfVWS3gkjjGf2zfC3RPwK3NKuscrFZNWhluxKsZrUrYdB+38yrLl97ZHUf0pdo/ubbb77+01F3s7x8XqwMyo8CRdqDfYvX0RUrwX6+zQ/43kRpa+AxK/sgZMuH2Cmt0E9ZYiC0OsIqihWmVkFrpEzBojI0BiasBYoNQQ02jyLPLghkikoHdbyJFEQQTKVgJCWBg1X6bagyTvUu/bYP6/lk+GH5By6paDjffPUf//b1n48t4l7oatpnM2yJOzaMw4VCx12hxwRF+f9SzdY1k/Xmt6Jcb+pJ202ZbLc/FuX7Y1ctnphsN7/Jzhl1n8Wveexkmb8k3p1mswZnTMgSGPcNChDWrYMmHvoZCQnH8pKEjaXJL0SSQBr0CiSVIurqL+vV+5e665ppnV8gIFZMLOhP9o91RVwKJiHtJQotN+0p5jEQ+06BWClJ8oVKAsVZLOdBUk2nf+ur2ERxlHEksJlFIOTB0NXP7UttrohIzJfDVh2xnNNXsX4Q1zooKL6T/oe2s3+AQMg/am6Ldz6bFVTKVsqjXp4qW5Vs03tofqxX1sIfRJz0W5X7tRPW9sFPc3BVhxUiFvX3iMdyukz0VP5aCkhJ+zDGfaFJId+EIXNieX//935AUEp0kHblelvPH4k9lgDTQbLYJ+Ph62YgfX14yuoYkbcj2PRncXgpXmMt5Hem3FidMcLFkbU7F6akLNy474WY+xDUvdmnh5Qqd1N/qpvHp5VB+UGgUDs/5UkZJjujhpppVNjos8JZn4nfmC8DAzF5Gl6QIy8oUDiOkk4ofbioV81zSZ0Eok4w/Y/ttJk/FsAEok4ws2r+uK4eS2omEHWC6YYDlwUke7lyDDEuGkG0pwr4PLblYCpnPW9KfClEerPLo4hLu/u/6lYF4Szm22fiBJgsJyzbdTepiQn+eCkhTSZPnEdRntUQ1YdJQfpUBbmMyuR5tkgPgMbVmeHS5brtRf4x+7AYQiG7kpslwktVzR7r+45cQqNzPTtK0EXLiQtWDBnd5sVlGMYIchoIfnWRwTAuRsMgwpojQ2JdpJZQQvs/vH1MsRx+NC1TP7VTPbOzQ0Layo9cXDew6h7pDlii6JCwUNFC7tEm2uLUhSr7keO02QRtQGOUuFDhfTsljTFRtUtmUBIskn6YL+vJuqt/re9v28nHerW87tpVO2nzaT0+qctiqZI9tGAqlMa2aKrBGBdO7VwL6h4GjSprfPlJqYKaapar4Z2TfLJZraxA0o0N3EmqWpW6d9lOw+wo1VCUncx2jna+73BdPA3d1XzhSEOicjjNFxR2wWL1ZtoRi1l/+JjMZNKu56s+Vd/e/1ANQYh4BIRI5BIa2Yyxd2Modls45AGsL8UYWD7V91fTW3ITCc8TCSGmaiHa3uttRYqlTsP0c/VsR9oJORBBj7uwNNqrLgbd1XQaJTdQEKLeNdOr+HWwz1/6iPTQTHaTCnZOPhNvYuF5HN647O/imK2LfhBHsTDbSziKD4YXN1STp3r6l08ff9y+A0fdqJAlcWkYmGyxCxpyan62BNa8TTtW48c6b105jdu0iOHj+nf3rsEMx/S+HDvhPimMEok406zvZ83EBBNIjGZJNxpcb+X/arCVVKrATjOKTRGtEIFQCUMwVbSdS1196QPVSzOtu12oOu8eyWkKIblhUpjsBhu0nKU50JUglY2LVdNqsTqkLGLLsnCDu6+W9YduVkR1lHXDaZvp5JqZ31d5AmE3oI3+arMwctOuV+R6mApGZOIGOJk1vcxFV29Eq9kyHgtYMNms3GDTRsxCRzVoI3H+TvWPLExJBn719NR+ul1Vk493vdkUVleahRtc3XVtt+1Ol9VakoEbWEcfTregZVmMggs65IxE1kIz6Vy65lLeUP+cK4Rt5kbEME7eGInoXgIExncP+L6jka7/BA9NPq7RPttW5gQ8TMcF4hJ6LG58ad8FAqM6LW5EWfcFQiL7LW5MbA8GYhO7Ln6WL3diME/Qey9uvNxgXAS0jciNRGRXBsJi+zB+tUX3ZrBK47sxbnxkhwaiY3sybmxMnwaiEzozbnyLXTJzY7qX8mHKJ2JKsGLB0j4QcVt4GU4me4K6mvTN9LqrLwdD3l/Kky+ny5hMFiegbebNcCLH3EuK5E5icZsAWm/fZP1r/cVYhaT8Kepvub15/q79WOd3KclVmIiewhY3X6g3pYtZ1TxbrTATPgXhxiMLulGx4CnrbqOjtO4Owqck3ASKUsKDsBNhMG19PnsMFxKCaYPtL6a9vEo24qLUDoSmJNf0AiXwgh5CbFtMQxZsyOUJUSO0NsGoRk80yFp3e+p//w2k/k0ELFRDvlakEukLRSepiINa7VRHVg9HYHpaTN695L9tybBfSbzZa9xGBZcdCmM2vmA7Xpy0kxsjfHZEsBThtXvMjGt4x5thsjV346Rrr+QLDTL4Bgt1ZE215smpfEhNni0aMulWuy0qV8d9ncdjRUkK+YhudKZqGb8Bd8zy8Bua2cuwQ+mLRJmkEDP+4zHonF9cvP/w891vt5d3d1c//3j7283lu8t3313e/Pb2/Y9XPx8UvVRdU93Pht6ALCEfuErORu9wb+vVqpk/pie9k1/Hno2mstPORqeA7GzHc/18X3dv28dmjqt9k8pBEPJp5X1ibjU1/B0PGNtxAJTf2SGtXJoNoD1AcPq0wBDJ7RD56LirawwgSv9KhT7q1Ht5kXQAy51V3ZypMtVAKvJKlRCp3dfDn7B6iJHl2Hj3/ub8x8vfvr+8vbi5ur67ei/GxTx1eeTCs1cjmVAYU1QzI6FRTsgtP70cX7ddk1Fv32dLE7j0yMlM0Vu2a8YVwAcWCMXS+jP1hgFEwC0X0Qi2dSKUYZgCbapZ8z/EmRuaI5YYyQI+qEBg6K8pQDqTllcxP7npRXUSDaCsF2gBUd106yOrx5ofuMalZzuoSjcPgW32xj2jwdqc9Q0N1g+TIHshnNlJfncLsWmecIQNYQvCW6bXHt0AgtUq3wVCat8mHKeZXPnB1AeprTWu3jLIKOQPtIO6uvqhq5f5lhZS3zHxKJ3TelajdXpIa7bhxC033arAhTmTJtK5uSmXN+yuVCHs/SIWw9w9svE08+FivnxtSGM6yhFc9KNYFjIpwLFYYqAbz1R/XjTJhRwQViR3gq9YbVORa+AiWCzoVWdJWHlo5jV5i6WIFsmV+h7RG72aT+vPxjgQCTqylGB4EVDXBYvqpfuCjbq5ppTVrTWpBt0Pw59MyncSbtqviLurVYAr4eZwIwN1abEcVf1qv8/qh6aeGb9AIOVCIXR1hHikdnkMBL1Q11gb3aOQYwzapb1rnut2bTQMJoeTtCOTp3rycZfUSBlLnoZuVlfz9+vVwlyFkaAbW7CoQo18g5lpdOCbrDIkIzAhQ30ARg8V0Kl1Vp++uBCKHij5hRVQOx8s3Qu60hcO4jKu+PnyeMQp6dUGnM7F3KnbF/VbqKh7Rqa4SQsgqVcCv3Nht9q0BcFQbMcnrgLd/df15UF9vggy/CyvfQfxZBN50rF6UKTwdzyiEMMEKU9keBCB2j+NpFN3u0g6gGWKH/VKRYisNypNkLpXwaB9X/ivv8JKvyHmRtRJP0hUTvV/XrX0O4B9Bfw7Vv49NlMF4UBM1J4OwF616L3yw3fnI3AsV7FlZhrTXG3amr5qmYP29WvQ04UWlrmRPlebDrdetczLoMygfS/5MvNbb3LNxPTGq5Yc24oTyclbcfg+BtW0ZJ2MVy181O0QulhJs5b0PIhvH0+3AR8gn2b7X7CCDYQ+fiCMYYsvtPLh7I/a1KazPq/e1vcAh3AA1sOemw+D8QyQFo7ymZ/XDogbgoM1gL2eA7m6g5TsUEf7L+EuNaPhahqeeIiy3vxk3XB79f1vf738L2FAsU1Qhhqf9EpgNz/Kowp6d1WaL7EXAcm9YIdVmK11j9WeWjh0S918wGk/pjfvr1BInodb7E0soYQDTXQRYzgtyZ0xpxK5fHo2Y+w6Roqd//y/NPUnA8FRYrz2WbSzUte9T1+kGVlEF1VrF9z8i2R5FrhK2s3JIyZirwAq3WIs2bByi7EDJrJvkSc0HqqysGz36t3stgRz+/x4NE7+FaqR3xgofGvz5kD7hyU3CGof17RJUGEKujcXb68u+87Lxc3l9/2/V+dvbw8bupkJVEUC7VcJ2cj79jFBjy38Bk3abn6wtFzwr+7rmQvgm31WYzCVx8mqfX/FhzjM7oTUy7ofzK58kA95nZB3c9u/D+4+K2fadDcydvcWn9RvjzKfPb5dmS6NfQukBGPeBWmjEvdTC1gFW6tNXNoREomt7DCJyoceK5HQgAMmNg52d7YAoW7UNhEM817ffXkbNU8oSSzrSyTtmdGZqH0z46iErY9iMNJ3P9o4pP3uAgey9d1WH+KRHbFKig7vlPg3e4xH93HzgR6AL545DJJSE53pz6ZZyQyGnp/kkplmKlVdYsV7z16KCsq7BiNmNGWikrlNK508yynzlc13IoThXr80ObXGkSXCd+k05LINneFZI/SjM05otKfrVIZ0qNp4QKGrVUYNqNp8tKirBoaEqPpk2Kfr1sZ2gmLRavnNqvbBELSJs7CTqDZV8DZAGUDfcMRkIGxHobqrIBHSW32VqglAgN2hdEZhYcSqSvvRJkatG/2K1bVDAXYOSxW2L5B548+IPv6rVBK2DYjJoXRD0IgBx6tUSrw9SNhQT+eRbxQKV2tTmfPtMwb5qgCT0GfVVsocW7nlymFcxRRBjE91WJmEt1ZlLvN7q1Yy8LUC5TOOea4AINYPGsp84klDa41t/rHp34mULkcaAbcvShsRD0Kng0yWfIcLFI2QByFwhbLAsr778qHXcdFOrRWYCZ+UsSlxgb3caciGWL42u8ZR6jRU07pvYFri9UiR6ih1Gqqufmk/1t99+bGromEpRpdLu1EiHQjuhmMl/Um7E+bnv7TC+TXk495PL+Qc2az7PUaE8xOLGbutudaOK/FaQZaTq1UYW9z4UaATNbzKm9qp1Pf1qmpmS3ZXp5z+NL5N6Cjz7aRwIwcOFNbY8QNGWOrVZEW6enUhP70OU8ZveZAE54f2TCK8ysp8IZGw/RCqRPtOxDE1R29KxGvPtj8Rt9Fsj3smK+9255I77nsXVRh2wLMlK9kTLkNZY2IRn9QhAxjt/bEiSjRwI596VNz2oWfCdgm9KWqj9IbTHDIudq7DSiRuvZeBtFakiEfbw6580sLd7GW1JuxrR2quYIc74i1BA/L9Zk4ebkDk5C4NCKACakCUko0LfRDkmNDnRE+HviJ6S+iD6ZFAg9AqgaaMhw80UAWaA82YWiMDDV5zpkCD22YQaN62j70BcXEl+tUljOQ5QlEjxiw4M0fqVQ7LZf7DUSDuQgAo3gFp452BKrHZ9g0lJk2dLbXJsnmKeD/o5iT+9rq+6K6q7TbQ5Nfyc1d8dtrhqhQQ3mmmqgQOH6XS8qmd/dMqBoRApJQgiEw39bKdvWyvUuTiE5HGJUpx+WpPI5JDUqogtnEyi2McHBtIxIPSLA98TrqQSorwwjfDDkXjTEi8Z3GUqG/QjB14ZkHs550LOem7CCSjFq4iMOjl20beVswtpNlSyHZSsRZTa6n4UzhNWc0n9ex9M52wM5NpCp/JSDLXondn8yIYp0toFG2GBNUqTIowdWCfB7HVAD31IdWCbbZDoMmXDq/mD628WBikcFweTHM1LAiGyEwrtWDe11UYcjF8EYqmwpedMhhooQnQqi0t5V+icDEJrgFh+YiphYIFI8ZKQgfoLa4WLkCKfvYx/TxLzO5j0lKjJ7QXWjzHA5k7gaHZOqTvsV5tdlJBGoPEfiXe9udwiDi9N8fVsHe9mpDP8fA0sZQfkxCGKK+wxyCDTdIBiLVLW/RhfTUIPT+0XW+Avw6Lllz4yZO4hCAmWygMEdSFoYijKAtHIhcSkjgcJSzhennjZ7+H2QGstUA6gVwTJkeQrSVwhuuufV6wzXD0q4sL5DlC1h9j2qaPCJWm+1og3YtNos1qVP5wDkGQpB/DgTgZQaD4F6SNdy3qO5u9ylBi0qHYUpt8if3+oRs1k49ii5Im8HEmKlPMn1Jeo0uRim1eBRIIe5NoCvNuJJREa1dpnLJWVWCC9uXQLNpOHFQrF2RIpVqcAXUKoYb2Anu0MZWeDjhCDdhijsASXE5w+Vw1s9t63tvXefdIXqiRJMGvI6gHwb5D/dA8ovmexTL0B0+Z7YeBNdXa+ehUPqRmKuOpXZKH60GUNzt5M4+ySrlou1FYO3lvrGq9Ih/rQrF28g5Yzia1ITu8OTACcVtEpvrWy6DJHQv5ZpfbKFLNDPus/YB3uZ0SeLnJ4OfwELKGHYlYI1t6m1aQMmtDkt9dOopUnvA1WSGsrZtIqjXflQnoH1LcddV8OQQ0FCQXciQiLEyEYcyrhAO9AjNjAO69BDTKVwbmVlh0TyBccvZyQKb05hsBGVtIHH6Yj2lX132mn9qOGc4w6dwCAJc3HAioQnDmL9xYy3LYr6s1EK1W9M2nLM1WwIckGbMl79NCOOpDtWYK+tZVAUC+aNWgW7jdlFUPXG0qEwRX2l+f397++v7me+0GfTKd6I+SEvm2fCl5+V5NQ/7a5k2xPNIYcgTMm30GdiSgyzpYyRi4IA93vpe+tXlo6lF8QR7ufNLbATCgvmnXSJi0unp7e5qWdkQbC7VlQnebUG3ucI9u4V3adoyimg2LKPNpvujCgYQSrizabfgETNkl+FAbK3T8CRCg6w9pFe5Pp5xCvzZ9VF+moBcD6dveA3UZNW6K3ljERb90dz5LgFyZj33pYc6le/5l08ZMKnKjCx8LCdGRPMOsz3Dka2Kwv0RmJMF2Cw+q+5B6pFahL13Wi8a+vjjIp7550TDfEOnYgT4b7cxDfZYmXZER12JsqzBdPWkWw5ZKPb+zMK0wQ5nOTUbt6fr+7/UEUXZMWahqVX9G9OySFSrZ1bOmJP8cmpKgpylN5npP5MKTuJItj5rEc5jAK5+2RKYsXTST0cRjypAhCCKINFUYWLB1pjC5aj6ZggIy1meg5PkXdClO1a/f9ExlcaBnq4SMRkXTYSevCOCCdLoO2DvR+eu/S2fkTlwJ0a3fplrILvxOz1Hvk1MP9kS/iQ7H50o90pP8KrsyM80hPcljyb9kqqPoAZ4UnB/eXXPv2pD6S57bAVnkV3ZImrLHdXgeao753eXdT++/l+bitilkiw1aIbX9KWx5+LcX7PMDY2MLq1GPrrGo/LIC07IY25QTFDZoR77mG1O4CaFmRWQAZFLkBOUO1B7K/xVY/hBZrAfhRZbiyZmT1UXy7Ar/lA9VGdprK8JEkeKMhnmiU8SCXL3e9UwCA1ECYc9cNn8lA0LTVyeomFCv1gGLxSNibvdbPI0moyizaCco/FbjIW6gTcQO1Nz7tve7T1Dm+IUd/hUrpZ+dXxG7F2CPAVOpfE4Dszkb7oFN8W3LdQJC0a2vIM0isg8DVCqILFcVkUk3o4pk9ntQeTLD9ackE3brKahfvOyUVA/dcQpq1642pb2o8EZTU40IF5kKtVJwf6lgwdm1pVpQI1O5BDU+Z8PdpC5hRCApCSNFZNIto25hRCPDrxItcWOTdu3iUCc3LqgR4ZpQLzdWqdgZ+F1abk2PTYzPidCuBOsQPIqfCg1LxY1jSxYiMjg6FyfEVf28mPUeeTl/bOYldFkGTmA1sSaIU8XSTkhdvaxXcUzEiSLhEUDJNRxZ+iwKkKlcGks+Z/g+jhzfNgIQEIwjABON3HQLUCVNt4lMCjkAnxZrnCiZqAMACuHGiY0KPAAYF3GcqIjYA0AxQaecCRrTCUDamM6kX7gOh1EP3IgDax/Om90M9fuO2sQoQKSC7t9Fvq6Hi9hFN/YYvxV7aY/4vcz39ohUxBJdeNMp10vl0uKdVPJGZFQDfzMyNX2YFai03ywzYd1mKxR1RzOMxN3VbAUKb6YhkmdGTCVy6WSxGWO31FDsti4WD2DsYVlY5A4Wj1TSv1K4sNtiWCL1xhiDdvoebPEDCRdhW76HeJs7DwBf5y6+LWoBlS54l1wJu+F9DCZ0/w9LaNymaWHBboHn0ezXwLtVo3ClEf+t7dcamT8sfbWR8nFt1xspPhG/g1GrswRUIpf2i80Yar9Idlv7xQPYH7+AWeT2i0cqab8sXMj0AE9XPjugMEJtLM+ltbEW7fxrHIxy/TkOWHcXpjUgpHLeX0R8B4Pz7pKHMIxfiXsJQ/xS1qcwRN8KwuyHTTOoxVkylUug5XOGIi2Nbwu1AoLpCLWJRQ61AlJJrC0io6ftADLLzJ1GBoVYgUmLsSb9TJAV1CtR1qSdD2eSD5njWUGNkAFNrRVTRFOpgvmxzS76drrZwNGyM2N5KnxO7L6X/dCRu52ZbM+OIrQpENDcdQObFy4fmrr7cXu0qSWXGjkQWnwsVFfPqlXzUm/uLo2OSQBIlPBYIOL6YICEuUO4DGHR2gECmRL16QGhQ8LMPeOf/Y4FxVniJ4KOpLbGm1JqHCFh+lOflwAoZx9PIDm+RKN5/Hgy3vslLtntx1MJN4hTONr94cUcWRyQKMgAUMQA3wqTECBXwqj69qduh9RXB/uD9LOi/vWxsTxDpezTe5Jsz5D16bB4GqR2pZDv9Ugpyi71AL8Kf6MH+VHs13lQHOHhyvf6BYHvC+8GfA9fC0inFBWhNwIKWauXATIFABtNE8Qbrc/M5THiBjuACri8DuUKLOP9rz9f3mhmlydCDS+WlE2PTethfHLmmvnxxZD6AKUYbz5l8R6C0a54bJbN/ay4ct4c5X25+q7HiLraS49nygcxYvfJ+QrHMEPL8KX44sZIof3ORkWzeF1jpLrgpkZF93M1r7BiH1N66U6djNdNudM43eqFkJH+wrsgcwZDh994A6SiS7r8MXYn4N5HRRd75WOkSL3tUdGyPeD+nTzkz07Tf6f0V1DNfRrmWtNM6S7pqPp8/6kfcCEKw7TlGrcbLzYZATrj1OVau/q5fYG1xqlHeIY2rBp/UyIUB6QhlcP9iEQ8DBrxTTW+q1dV/yWrX4cc8k9ApHFp0rl8oZadArc18Kx64xSlgYSdbWJZzFNOBppdp+J2NczoPOZv57FQuaAHG9JEskhKS2nQzIcF3l7N0cFcE2SQUGrDFCsUonCL+2GK5mq+WNOX6cRJzBvag6GOkusZMOJPeBnVm39QrbvEoxTGw19NozzcBVUutzsp6dMIlNZAwKqYNpn365VqM9s0hqO60dhYy/JMHgxnqLxSZpWZ1SpOl4FqAaMJtaJWAyh928w/GhXvROzKw6MS/DKp8xIpujwq7qEdMZk/fiK/eKkJWGby0EvvYR6/cEDrj+MPf/gHmaVCr0u0jKiJnjl8HRShR730ay9TdjEiPIR3K1ZwE6Jwu9VeRL0DMZ0wYPVi8wVuxYzUAXfZ7YVjTKHo0YyFiCFOWLgWeNAEXOgZlnUDxxttMlEiWZUyT+JpwFtVwBWOgRnv8JiiUjM0LAEyQeNW3EAZcoPpXjZkZLew5PNDLAYyPeRW5kAZcmvpXjZkpLs9F/u9BNyu7zSBSxeIzNRy915buM2bVmxacEEJ2DkYmkGegBlDwXVrWY6jgCfJoacu3vCX0GRCznXD3ZrO1s1VyT2DKkkzv5081c8VyBEkH0lhueiwte2qR7XK1xu2pr30qE71UsM0MpXeZwiWXrrKkKyBklsMaZbknYKWfvigLXnzIHevILeClw54d41/9twHUPa0QTvqVYPW4UEDlUB5y6B1ecaAosgPnm36J/KpszCJ45GzLFvDebOI2toH4NQbewEmEuksF0liP8PFkBgOcOUg2OktRLN4dCtXDJ3bQvQOo8pfds/xXhN7fDmAXA5b/sLJtONkhH8UniXDv49wkIz7RgWnyDifCYLT+f2yna2HA2erp6thYFZNhjv8aTeSErsELFUBFLrEMrFnQYlGQsdZsIc5suABUkEtqA5GtadjafjWVOeh29aSrxYa73r11HbDfrJNKq51pZP5GCyfNWaqdAls430JwjTqV2mQlkaiUVobW210dIwS1Hd8W4/cfGPDW7brbmLjO4icChBsF0WrNreNJVZFto+6ZZnaSP1zBqHmaqq2jnkSlxDDZAuFF4JaOL8Cq94lRkIKTtBMfw43jWgMh+S+FPV8ue7q2z7PvJXjUGKZ0TxQD4Bj0dp9XDPf2nO69TZe0R5PrWx+v666/v/CjZTb6ZX4R9OUzeXn1XANMDlrE/0m5xqsiLOhIVjqMMWGdD3umrlnoNAG+G+ALtyIirXF80x4D8yerkgtUSUBTPFUlXBQrS8/ZxkcsZlWKBHgerxMOp/2SMgba5SYQpi6eSKF3s8bwcP060QgoGNnIwI7cvK3IntyIziYAYEIoYwIigjIziNAYeo9AlYT3fG4vQECmmaREru4sKoAvPtRKJOlm6njGDqcJVRdIFNAl4g7UkJdQR1Q6xCU0PDdQ51Hb51BouDc96+X312ptxnkidBj5bGkfKycTetxrFzOXDtWzhfDeKwcwlCOlfN5lN9rgHHp5xwsbMkS7q/ybTzHn92WcJMs4SXcgNR+nDtVaj7QrWuXjnSn6u2HunX92vHmlKHsgDPJgR5xThGAQ866Pu7ocapMO3ysa2qWw74ntHqPicfoHFYch4zog8Cp0jD1GK3C0fHMffXD47q+5MFlSZ/y3DJYPvEAcFbEoiPAqKewh4BpbzEfA6Y5ggkhogkI5g3AFgA5SWDxSJIanesgFOnnCQIh4URBFgMEtWoIcC3kXpu+5TyQPCAKpwji8CMQ6NHHtcAHdfpxgkD0CGk+42MMfa6FxU76BFLyWR/+hXtjvHUtZPywPT8VGchlr9qHkW34zpu0u/kO7tJhKh0e7YRrh9mM1YuHSXQGoN0cG3lqFr/03bkpd/Mwz0LKj8fKttpBMOR+u1IE+bphHgK4cNiMwS62KBjyM68WDO7WB4hFuvnBAhSMP9OkWS8oTeAyBiUzhUahGa9tHEorNo1EUQLuVmQaQbwXuZhBiEoyjhKOxpOxe4BpHuMOYJRCuAeZ5tBuQh5HQs/uCySWvcgoiXYvDY0DXUpjYYJ2R9Ms2t5oVCszi0IrVeZRUJ38qJiJmeZxsa305MhYqgHT2FiyyfBAxHymNVN5Ep8DEXS22IGInNoehjgAcyAy0jDHIiQa08EIiQY6nsCQaMcTYL3CIQDOJuyHAIy1QB8CEGvCdghA5ol3Rf26P4SaH4wLfzLttDoIUlut4h9Nh+SYfLOZPix380pLnK1tteVIXXBojtJecnAOI5EPz1EsZQfoWJroCH87X3XtjGsv4p9dPjeRJXZ4PyblpsS2qfI1CEbtPjESjTECZh8TpV/avoRrRw8nUxWgblXCtHLHsAmV2iFsSF+zZE7eEwqPaYlaJjaJYQT7N0YuLPZGCJ2Q6ZZYbQSobpOljvFcz3X3aKuoVMKTRjo0z9qr7cg8GyeiwDs8vR3sweFDMJ3QKRgLmYNhmSmHNTxKIMZAaSMS33iXufR33kfTSQ+7a19Pedy9hA1ubEQyoNmxkbANkIShNkUlDExg0TmMIUa3oiDY/NSrGeZ6LvvAlE9VRb+6hJU8RyiWxJimfeuExny3ulnXQzOjN68S6oK0Ro3Eh+Iag+R3149lDv0pLHsAbXE1n9afMcVBaiRkgQyr+nkx60Uv54/NnLeeiCSTOQFP3h0SUdCRCk8Bxm/aJtSwDeplojWpVAnSoMZhK8XdrhIxvYmEY60L7YRQA6bmQSKJp5KCJiSZRwp+KTmwt1PN3r7OJMX3MrSLYdQScoO5n4WStFVx5eBQmumEqkgYKJN3wRLvqReB9H3cAAp9vo5r2U40wLEObcCjScWB1dYl9qHRz49pEdeTQztFNjb2iTzfBt7R59Wt3jOu+7Ceb/6w/AOZTj5xEm1KbJZPsoIsDZx52z3Wq/gJ2iDb469w/P7Lsp3f1IuuXvZ1yQbXPBUetf++NOV5tktPByEClzvqvHszxKI6kClQH5xxOr+4eP/h57vfrm/ev7u+OyAcD9fECUxLQee7SB2c5aqX69nq2LHctuZsOniBaCjtRTt/qbulEMbJVC6RnM8ZGqzQ+LZJKgHBNENlYplsEq5MdX0WCnkQga2bRKQOHkwMTJsmACgDiQLtZEumEpgaM5UqCd6GDriQHA/nfYx8asn+pZb92UGU/x7G/u6q6pjjHCrMQdQNRmroRBS1xTOCaE2f9pH0NtB/tKRyoSOmAjxx1KSC6SMnEClpeYERFJ3Mre31HEkxJSpqb/xGVDYqoQVyGlmV8LBtkuMIS+dKWqVoU2riTcNvpuN6UGbq5tYDlv0oEKlIO+50ENqDMecM2slmIAG4O5/U5+yBnD12CoEvjfE8ggJjO5lgpmKGAxqVaUwAUaF7oLVvp/bF7TTcLnAFRdsPXshB78eGWGw7syFbih28/+Mj5t90Si/3FnJHvZspCuvck4/mgp4dpEAvsjHt+mvMkRKZLJE9CR8feiQya+RRmfDAI1oVEndsLHzYkUD0qFNCwQUdncQac3QbCl9P78dKyjbfPIlLkGGyLRoyEKUo3ZrJYRVvz8TZhHe7ubqyP9sN03DvlzMoxuELzsFt5+VAkC294oXexcZE7akFzUnbV+sELG+25VjxDbdOmNKD8aL52d6Ll3jCGHk7rN9MgF4Zl9AlXoqZQ30ythzcZrp6ueizzT+CjBKIIT0MgAqJSzKT0qZbGfhIrXwlc7wuqx3SdZAaMjkQYk+BG/0iLw7+4r8qSGQJOcovY9YBKaWmLjerHTRBstRq5xrTyjgfpVJxOYs+0px5nSYj5r91aLpN/QmI/3QyH1Pms8ZMmi6B0bQFCJuJazSoqUu1opu8iYIzfQFBc4EC/bQrqAw2l9C4gm1GvdCyTp6YPW4zCn5F9y29bC9LqX9tVk+XXRe4wjHbLI2YebDZ5sPN299uL366fHd+yPW40eb4I7zt5ef24qmefHyvXxHDpnSJDnLuRUNqvmi22XkFTZqcJwbTCBXitQqV4rhmCj6CaV/O3GEsrCEyrkC1ZAotkFWF01O6Z53IpTx9ycNQ/CxktPMYvMaTg54P8LNN2Cjv2o/1HLBMJp2LeUp5Qx1CrhC26C5iGGO7kYi7p1xEsl1YbiSqPy+a5NQJBBXJ+XAhbiwyKS2gkeCxXm0kwmtuIIxY8AR1s5+H3YhZ2WLRk3y5ZQFYIHUCptVT136Ke+YQVSR3Ai6+6ZRjpbn9LPI+svECPNDUggFkwear82m16Ad5P1RDO0HeohqnwDdibe9svt3G2l0mYP5njCwdhpIi2LdroQTaDq4kH7IQdGfiYtbUw5bQtJr2NpL87tJ5oPLE7vNIYG2dBVKtsZMAEvDnIriym05E8BTZwWIMYJfSWuuRts1ky830YZ8c00xIjauB6Dts/oE4dikL1xZBHO5+GQpo7LvQ4FdbL4YThBjSIS3WHBis9LsvH/qsL9opWDmZzCmIGoPz7JO7cgwhcY0a8DGxK8O07qNym3ebSYZjYleGrn7pexbfffmxq/DAkguNZRKazbQTw5AhPZnCRjTuQtjb0rwPU9agpRxj2rWciXhdienmQXiWvp6tvrBIH9E4B3wCMLDfy2HM38wfuWpLfnexWCpPyFRTWFu3j1Rr7PaBBGR3g9TPdzcypwB1c/NRpHrbPBRPEM9lDJH2r/WXH9BvHws4kqx3HQMLTCbjydNMTShBckeKjwaEj6eoBbqrSVdB3tUs0EgOgEh94gDIoE3oyLJ6mY5sOQHRcZWUN6NLznUSSa1UJ7FAp9YpJHVLncICBq6DzrZ0aQcdjPN8w811POlkp2jGzR1PpgTjmrW4JzWmdfPodIpVZOl06nUVmMZ1n8Mwy71+fOLA8iQuJsFkC5kDQW3pXXGq1fmcMgamX89RAH16mANpSzkOpTnF9ZItKqdVbFRtOoV2VdIONK1mDqJ1VRCEBhbXzrU1ku9JzQ2umWvdOc1aA49r1tp4jgBt5mW/F0Mr1/CyKU8UaM3NL1+UsSHPOpthpbK3w1p1WZpiiDBc3txfarZ/Hp59NpVOiS93knfEY/nzl8SHRWeKwuAs+iw+tR3/XqjEkwq7ALXTi+FL0++5ijShpAdK/Vw15Au3EsVeyPPjlH4XJ4yoKwciZD06m/ogmueJs8iRJ3GJ30y2UOAmqG0ToZxy41woziE+XsHRFDxbgRPRsUlD4oOSC1MenlQgOi550MQRSgPJQ5PnVzJ/IHcScsjJURjm9EUCZPMkx6Dsm8T18tvZ2Bhm3slmrQVyE5tcE6b9azJPeJX8tBdoVl+uu/almdbdT6vVYndMievkKSJ4b2+xy0DYN4foOsvzoU1GKyu7YJw/DWRF5B4JcsB7So5QWtGO8qOxwqvoeanM7oW0Ll0VLX+ozyIVyNZ5UXGMvZgCMs7zYETJ5fi2ooBUepcL+K7Wp7kKCFP/g+koxxtLBj1IgIGN9AT0oQb1G9pfbCitKfrJBKy2bG8nQITBUd7medFuH0fYixw4j2d580Tw6dtBSIrQye8+xwKJPKFInMLaoi+p1hhxQQItypIoZZGVJ0JvorJGAVCjfBOXg7ebSs5ehOTh1YJVRNst18u+g/aumlf0zv7wZ6ftlVmW4LbKiNR6QiFXaro+FtPeD5U/1h3x2i2h/pjWT/9kl4re7k3Ue5R+FEdk3stF9Wn+q6EyEgGjBSTXyt0288dZfffU1dW0pjY15/oJoXEM113zXJH7linlx9TjtG5rEFR6SGzUGXQEVu1F2zfz815i+ZflXXgW69gRyBOJcSTIftYsV/F3OeZEKJKSiyrDGQjGeIJhbJwC7tRsq5sLtNGvLnE2zxEKszGmEmfgwpxlEkiw4ViQTgTBoHQhIG18B4IqtLn7YCgx2XlgS23qOrAUgZ/80MyHmbzhhh3KSYKf8Rm4h60QlOFZkJj+niGh/QApq087MRoKHhjpkBAk5YY6eRKX4MBkC0UIglr+npGNaASxDDYAEomQYMHBKBED18uHDfZLmGOHtRbIACLXhCmKyHaSuwFv/b5GP+Y+6iNq6Yce/X1LjbvwPmdQq2RM421IOi14+XnVVdxBvsOPXicD4wyLbChiNpsRwWC2JISAMaZcvdGecN2kSXH6TVbFMsSvbP5X1T0u3y82g4sDyPZhzfAneASwEbquuv7/qD118c8uBktkCTXxCallDZ9SKW4wwnS1yWeQ1B3TGjWG/dveRtJPH/QOj7/ivdv1MjxuwWd2tk/IjcsPYOzJjq6ZrKJJIEFblLpU5aytpj907fPl/AXRGScvVVrPX36puuuufmg+I1qT9Ba1qReL7U6Wws+X8RYoM3gm6EU1+mVIeN49ppavMORiWL/dxPVSAPXiSYQ0jwyLMo6AtW73Vf9XX9UvsH1EIsisC07DdlI4FnNPxfg9yC6D+E1M/QbRXsN3JTYzhMMTFFUzr7vhFcBb5rQdn9QlaCjZF/VfhdJx59fr1U29PbdwOe+bmzp3Yg2UzALzaYgXWUTSGIFlW/GeCTsoc4JEAx17IYYddLJPW2KhB8lT4qYGW2KhJ3Shp8ruM1uZUxEtC+poedI6mtazmnhPSoM6iJ2Kqy6MeTUf6Ly+Yd/6zb78eIyt9i9K5PBqbvqx/nLXbncvPTQFsSWXfzX05qD1rqUuz9XQc/mTogcD41++fdc8drv3T9UjeHxqfODcR431Iu1A4TrOEnm6Dy4Ui8F62T4wE349A1Qk7YUUHPEprKssBy+0yeYSrYuu3hhuNVuOgBTy8sOtq/nBakpM+yzPwgtuXn86H/2lqUwcAW9HOm2ehRfc8mOz6OPdQ9M9x3e6W0JKnscYvPBFKlIgax/oZC5jRiFr7EUqugS2sZYEYdq4Z6NhbQPhEo3Ci5BodRA2prlxqzfK26E643zci4xpEhE2oS30olNbRcgpkebQj5huGDFQvkX04uPbRoRQbhQdGcnmESRk28URfNCLeAKW9iKeSX+z3H0EE0Iohc0M2qi2M+klZKnkSej4txQlMvOMfIkl0W8bqtZke9tQ9cCgk9U3g/zyXfijS4cqyxDqRkWMTCD5SPQCcm0f4UYf0TmtH6r1bPVLNVvnHzVXniQfQYGEqFy/EpgQXbxrEV/W7FB4aUk34kpsch7uu4dXu/TZrK6r1RPvOHkSF/dhssWudsmpDa7EacYdCte/85MhLcwRy4zmga7HYFC06zFgvcL1GJwd2K/HMNYCfT2GWBO26zFEKwmc8LtqWX/oZrwLpglcHJDMFHK/jFcx/pa4eZPWHksgpi+wIIZPYyhmj+rkjZ6pe7PJ20pPGrxUAyZzl6wi3EXx1H/cIXve3PMkPrsm6GzLdkvkpTAbActjNgOchnEDDsW4C9jKQRqkzGIySZEn2nDePt8383p6EBjWPWcv1KFLLqXPVnQxd+xANVsUJkp3u9+JI70yTShYzgJtT5dBlHBtphC26Svfx75nv6yG6E30SC3ZdtQjtkTFdtZ9TuM2RneBQka5kbgZx1i3wd3FkUKO6aNNEjXF88Ui79svFj5D110+2Fi1B2EibyNdqLrXESeCRoO8xgf2TN5BX5hkpDblPPmxGvlT5LymeMfTqiLGGAcF+58L8m15Mzrb/QrlGt50vVjcrOfzuruaL9ZH6vBa3ygFvqVmOIBRd9ddu6i7Vbg3Tc77jJBjCxWi89tCH5pHVPkh9RiVL1XXDEdSv+t/aubMveGEckJuDMZyH51Q/aHAGMVVeHZA0VmlhwYwdXFw3SaifGP7i1egDXJDw+0OzbYzIVFl2oxA6YzfZVjnWw4ShdskeJmINSy1+vapCrX0iBez5vbLfAIU5phylDZM09iaAxSFCQt1PQ6zgZOPfRt3W69WUZRilJIS40p6uDpHaJWJchNiY2ucHSNwNR8IuHhlvZ0UuM1iNgNCpPeJDttywRxEeheO3Xo23XHOv8g2oWcNXHad3ggkaUv1E/Pvv/SjDXLDefK75+x7lKdl8v0AyzRz99tkmN5jYsOUu0awe1WO2tJGQkTp/TlMEL4ETJeDBDB1PHj9hrWPWD+29KFpVFc+ErsvXfjASi6te1ClL1n2oGwgvtGEn1I+/uYziZzkhz5vrk0UT5RbWRKlcepirUt9Sj5VTYmY9EcrA8Po9LqdStu2qURO6wFMxuBSAMFui1E8gPE2YwvLEIRr7j5jnigRQwKohWo7T8Ft7hS/VCTnzdW162FoYAfLBB3IsNUcjkhdyMF1S2s47JcqWL6x1gazciPXiHHRRmYKb8PZnw8EjvxxafHZybRLimZOdk+TEtPFYEAW4W4smGKR7scag7CJVXaGvZgPxGPdp+Xe+ZNBQlG/GkmGC6ZqIYYODjjFLKNA4v5HlpyKH1kir/4HnTHa/8jZzf0PBsDe/4BZYufUUXKvFNtPmONwSQbxlK/4ZQIpb6Y8ZuhEdLDw4RFmGeQPZppqKCCy4/iwgD0wBkXvgcG6xR4YZ7slPTBjbXA9MLFGrD0wkSl8GW+fgrtxO0qA97WOuwawTM8iAfrjx6xHxejd26JW7f7tWDigpZvNKDn7JByRyKXZZDPGHoGj2LXvTN7GzXOkclgjqpBB74KxSNqDYAbdwktg/JexPwFmrg367S+lRmyPfim2Q7mI5BneDjFma96oNsehqSlvb5Fm1kWzbGAedsWa09tNf1wyqiyFi2nRuUKBNkcWByfcjCRDkAohfTuJCDE0BkUJrbBW3r24r2B2MmMNkAYv1oLJ7EULCYz/XTtdz+pftrdxsOvIZCoXJ+BzhhyBxrePuAQM85CrhKkAyIkGcU4BRnFQk3beSSUrMTtqQY2QzqrWislhVarwTbC6ntbT/BFzbgZcSo+PzILrZ8hRkqrlLMmBNhmxcOy8+HL5qe2mI9jSLBzh2unFsO+Inq0GyEJ5P6zt6t4Pzay+ZlYVdLQsj3F44YEcRiTzQi6hz/EcKXOogWLLYZtNlkGMM8pWJtLxMTLW4/kGy0pH+z6Gxzu9I1/u/iAc7fd+ZEwEgI2fc/1RhNDxMJFM6ZJYGYTjcnIF2U/NFdUOfWwNqCHb6TXAtqLw3b3IY+oshVPApnIFI3WKbA3RpGpzbAYplpuE3MiegUmFMJ8FiRbUbRkMyAK/JwOvkXbysaYvrOGqI5TwZdkktH0WBwYseJIMatQEtWZvpip61WdTYc1SoKajQkGENtU9E5qF+jfGZMEawwnO6n++vJUnAtMUPhOcZK7YBGeGzJ0LNpXo7ME2qSlQfPPtN1//CZ5opWn4iVaYIj8G85ZunriPEcsUEATzEn2ad/WqmlarihpPBj8b1oOzp+uFHIGn60NGriFryFOwmbJtOoua+GH358Us/VrRs+7H3y0Hqcnjy1lmZ9uETMgN0ezL5aQybZk8EhrgWBNj6supptA6Kq4dul5+/62iKamT+OHB6PgZo6vOzp25F2ejYl+gb7QCbYGYIn2qOvIi/FDdLs0JCzRo2Jfna7VAGx52u8NDq2nbpTlheQYN+/L8SSvOBocpTt/vuG+Xqr5jshMWaqfk8J2+0gq2p2LKNq3v12po2Cc6Ybk2KrSwuRPY4nCDkWY245rPg7Z9ohMWaKNi/5n+XSvSFog/98r0c44/uZ12DcuAHnTNKizqqYVtD6dJanx0DY/1auh/qFqO6ZAOsa63Jk9Cp1rltkjXErUOnBKxedB1RBGb0yGGbF1HGkY5NVoc1TXFQY3TI0c1XUscaTgtcqghtYTO/2tXLRbN/JEJAPHPLkGAyBIKBAmpbT6RUkpMJkL61ODDKBupiQ4GlK48IEgTH5h2MkhQyrNAMV43GTwo3VkAGa+bCyqUeiqwjCeggw2lPw8447XTQYjSngeiMu3Z+DSdB8o6RMg0W7xWR83tiNmCUzvMtI6tf8fqxbqve/GI+Mjyx2OUfvv+x9/eXv5y+fb2ALO/CK1nOfwo1us3X/3Hv33952/CT/a2fqmPxzsH4k3JNn8W8/o2PF+02pUmiHkP6/lk8+L7H8Kf0SyX9erHWXtfzWirOmZOJ0TVdHUvfzV807muik8sG3P4pFzbTJnG+/iTS8OdZFe0eTugNTSoqWapMdU10A1pqsPWiOpayQY0VWpqPHWdZMOZ6jQ1mrpOrsFM1VobS10z3VCmem2NpK6VbiBTrbbGkdRKOz23SJKlcA4B5kWoHNnWg2dU256LFBjwxR+uEpAeglgL4bCs6Wu0nXOjsvBXn0FZliM2JoswjUOyXKXpY3K69eEZqdhcRmRwlmsyjs0Q3fTQLFdtG5khmumBWa7ZNi5DNLPDsly5eVSG6GcGZbl245gM0c0MyXLdxhEZ58tcWOKaHiqRf5AyN0AkOxeyoiGMrn+f3hy3tHZoeyX6lepncW1EUu5MUtsoQCHNo53jrqvmy2EDXH6LrsYSiRK1RGwo1Gwov02UO3Qe/+y2upJkWTRGS8htG+IoCOwyyeLD3GS5S6+SLD/AzZe85CJJ+dD2Tduu9rvFOQsj0riYGZcvFIQpcG4zWp/sXbVYGIp2FskggU/mQQyeZVGs3qCZN33+W5jt31wTpBMotWHyBMVWwuHwbtaSc4Xkd5+hMJFn2ZRYAm82AprE/vYzxsE9H05BGO83MBHQz07zFLb3plmSb8PNlL9Us2a6T3uAOU7vJilEuwvm5e8u312/Pb+7POR4nJXf//T7r62Z/fbL+c3V+XdvpVwPafDZ510ew8MEguNtf3b1uyBLbP4pJuW2YqUfU1IbJIZmn0CCGfH0Nq1+Br+6jelu+7Fy10wx9UHiUQSW6BLqV9pXTJ8eVSM7Kw6qSKnFiJaXvCig5d8/GbIcn/j4y5Ib4DPp3AYxXN7wfjGqEJzJLzah2sZxFEIsXyeKjOF+3cym3LMsIlYieQK23RWO9OCH5QqkSr9ZtNd/ff/QzqZ1N9zZvu4m9fLH/c2S7J0Nsgi+cyA9IWPUQR6ZCWtCKxuDtaqfF7O+hi/nj82cPkaA0GXZnAby86qeDxdzjOcMcnJFfd6dNrldDXb7WP69iYxcQdkLpCE6+R5pA1LSiOQCZMDIk7k1IUzWcAtClMC2uiVBGE8x23i4M3wSkO0gn42HCU0IlhCO3OmymGQCJOOQFyMbjBBEMQB5EdI3ZUtYlruyVRa8i8LhQD0UnKF34z7Z8odN9DSBpJL+9bNq73ZW+7aZf7SZeyp6gq/XtevFkDvdI2e/Xyh2OpvaSxTZViB8OsLsxLCFMBD2J9xbdsOs4Gge0cDzLDpX9PYJP96NHnuwDXepy/LJflr5oEkeMKFbjlX92qZjKoMDOzlvWk2nu69STw/fiZg9JdPJm5HDK9WnPdPm3r+8ExreRp4n8/mwXMb6h6XI7R9W1a8fLaayID5tfHp6+9jbdUue+mehIrH/lWo5Eqh30BNZBPy0Ofa/iHYY/u5jgFmOuuVFkPa65TVqVRpJEiYW1mTWCAcE+9/wGmwOH1PN7yxKy6zq7uEYdV29GPb8z1fVipkAiVVm6WG1VJUR43FCMzgchw2xuNMtNuKoUWraNdMk5KkYGF7XNnysybYLz0+AkKlc5j/4nLGr20h81p7VmR4Bh5RGungmxv0onRmOCXyZpAcbNloVqFS/UWsnNNb1/bR9rpq51F86QAmJfUxXU4BZsFQmxkiGxwWvK2oboc4UykIWgvGJEa6ATr00SMrqWEZuDmjyVD978L055DQGc19YPm4R1yvaWXf5+JKCEUKl1QMFZojxSYe8g48TAd181HnjGMYtVFCMXFqvCCbmjwYwtkAjGmINrbw5tvMu9yJkwJU5I1k/PtjtZDrE65Daigz84aH5jLXQTEon45ZyB02bK4rQMFtBdjKYaeg8qGGITIBZGEnESCyyQGEY+E6Bie5XBqbkRMeei0zlYpp8zpBZ0vi2JV8Bwbjia6JJ3ruHmRI5xFlMXC/KpmwBLRd1p9veuH989N5iTZHgicj2ItfUDdwqXiLtzpi+4Q6AUa+3l9NgIVnAUcOxShDMrx3SYhNtQnKfGTdNgaH0LnNwMI82RJUyUqaN+884bH5t5vQOweBn/BtEfRMhs7xDkkx+H8gYRZ/q+ytyQSXTtE9ZrGo/5wVpCxIXK9z8gyjbJSxWVPejyhmkaZ+yWFXbTCdXy+WaXlXI9EXJTUqDHtjFJvL36bi9w2kCl34XmSnU5cp4bb0tWrGxo4UyLKROLU2SiCCNHkrTtevBELjOC82TCbkS6bMPDFXplANKRm9No2Esm9IE/cQpdWqMxnhOkN7uN0E4OGydECICkcYlKHD5QnGBAreFBla9MToYSGgzY0EslmagANyQRSr2RJkPdAbeYlR/UPTHXcDUE+JWGfEB4iJJZrOLvShkCQy7L2h1wOaLveARka7B8/Xqqe2a/+kbkp9Wq8VufM6duuFTm2p4MwdVzZaX21krekyl6Dpj8qFrRCgmt0e7ndbjALMcvNAWdffcLIfd6Td1NaVtX4Mj8vDCq3YSZWCRtBdSuxgCSl/YdOrKAEbkMQYvaNhpgSyi0slcmncha6iFZ0pga+QlCNM9cjYaMR5BFaQFIi9SJiQhjEIs8qJjoxLCJ4YjL0IiMCFsTETyomJjE8ImBqURhMgRfolLOcpv019Nh5dV6+Xy3WDFd+0leTWj+AmZHPzrir9+QAwh5msISr4geR2B/hVN1xLoXEHnczjXcRu+ufo+ObsfNM9cWrzj+dTz2LM+24vRlswWgYH4WJOnUWSErZAPwKQOnqGFCXZSPgiLh892gq2QE0CfyeKpY+b6FY5QthwnOV99Kz5XnKVwO1Wd5wofqI6R7WepCdUFx6ghiu0S6pqeP+GrIZRBWgqYR7qihECxX07CURBzN7f0U8xcrcQydutgCdLQbwB571Y/oVvumq5t0gvJgtiULm4q5w65K18Um9sqKEb3RajyK7mZa2oVtFjUjy/uYDAdeIXtydR1N1Mtn9pPt6tq8vGuH/zl/T8FLpP2YkRGGFDFjbJ6Ihxtxgbv+rECtRKnOSOVw0lqjB9naIjmoUbh1yRHG9AXNQ04ILpgzBGMSq7mizXZF07T4GOMrv7HOjyIoGV6dhRgjDjF5ReKFn1LQHZoOc0HCbvqsJ0Upiy95ynhyUnRYsaM4h2G7uUzLsg0i4tm2ncdpgdogugK1iHJTeJG4QWswe/y1QHJO2ZUvtunzMblmPhdmOX2JzHPrOjLpEOeFn33O3xrwiBDjy6TCIEPMIkF0wRazRobSOTs9kVUQL+2nJpnEdHT9f7+MDMLNDhsYvw7HGaC7fmfhbJ0FfClsTeECgzVIkohpQCNbypVNqLNHA0XNKZU+iwQU4lcmlc246J2liyLucEVmMwtr4WIaYJ5HGNbbGchG2WNx9Q6a0zhzpuqW2J7RuiU5i71kA2zzYdXcJYKM/tl6MJwu46H4Z2wkUDiSWQ9cPYx6dfhcxZUUCLtgYRst5Cg4K0WOlYQW/PEmTflSVziKpMtNHdHUNsm7Tjlpi0VOAXtrhoM76ceTKTHakisq/rUEum0ejWx3upBpW5F4LgKtyGIZEhrzPEoM4NWvemwEVN/w3dkyflmKxW9DUJmEjY+jCLi+29s7DP33qz1Q/aX5Oox9ZZkvwoP++tLSCdaO7IuGknF9Zib9puUHr22YFhU8OQgjdJxOhyeB/+1mpzPZu0noAfPJPXf8i0psu335kpXvNlbRAN3ehuhkG3eIha8x9sIhnTvRTC4fw+AhW/Z5qkzVyPSuERaLl/sIVsC3NbJZ9XbHuDGOaBd03yllG+ZNjAq+6VZuqLN0gYudac0S1a4TdrApg4BWLbCMYDMhrTkLJEyCjBorqbTfWr2PnYWgxZ2rhu+z8U7obnTZf5WZG9H+V6m7o5CFPZ36vvbdvKxXmlrMWRCvK/zaS9uy/sslGPslSwBg7FePHZ9hEhHrhhLJlwIFLbNSdrcKpIEPq0ylWnR6Cfjt/shzWJ3QpCEi5YkhnHUY2Ogo4DAYQsBPAtpgMBoXEjra5ZjNnVKBTJ2HjUc48bOAjJu66SKZts8iZGZ3Khwc2IBCRBa/OZXimtKdnbHmQ7QysIFoHa6uyzlbTvZdFXZB7j4pD4LQnL22MIQXxrGyR7ZOyQ0nkfjDRIQW3Lj22oncbyhsgCTzGRM/QXmM7xej9qPkNbFgLT8IQuSCsStW/UidpidFGI5GJPddFRGk+2ANZc9IbGT+b5eTrrmnsCkk/msBfBZG16RyErAGEo/zHgmLoIWGPYSiJWoLNAKgACjtN42/ft7DO+6ZjGrbbWSy/rXj7BeI9mMfc2m4KvR6yXql7OtmaiWHTmy6sIncV6L28qFHW8UXuYw0n1Bx/VjYIzRzQztBriQpmrZlP4mmeUONilcUbizbCvqUjaFxHI1m5loQd3mrAAt8DuczTxTLC7lUKGgF1lJQCEsiYwso1iQkJKDqJ0CIwXUcVWY1G6rNFFTWG96GOTqrjwecnTBDL82NgvmvkuGZslQWvh0oCLbkEMfbqAnYsxM6jNTTIZk+ehG7Xyy+Gmzosm1ZWkClyaMzBS78Czl5YZBVdfXgnBnF0mQSyERGWVacpMWNEyQ3JNis8gOIuzTeuqvVqu+uVuvYIhIYCQJdL0WSaFdrAXqFK6pon3CfkGVqfT01VRCDdgupRJsIrpvvVty8Sf4zSX0pPmBF6wfAbl9OYYynMWJEZumCaB3DSXt+pPkx6QTEgHxqIxAcSa6sKAf5cU1uxCgX/AeprQmx2EMLjz9L7ba/k12YXsNNQlPm0R5e0AFoUNSxGvGNAP2NmBkA+AS/ceGfp+4jwT97eTfeZ/b6nK+Ii5fSxM4TsYnmRqm4QNe9oTRrE/4Qj7qRGuPJcZpf2hm9ENXtOoguV0v/TH5SbE0ifcHLZgGy6i5TnO1WETvHWnqAwF83QAhGeaw3lWryRNexWexjC9P/XnRdOzaSs5yTO/LwWyx4TBM27NFCupZhoJvREn6svUj2x+A6JDOcv1AhQiXulJWv4g6AiYkUe3i2mSuGlqXBL/CRdV/35+YPo/wJRI536+hrvpxdVKw4sf5M7Vr8Hz6UnerhjrTTKTx3SWY5GvbHRiAc/NBm3RUP4ElCEWQ7y/TmPbbpSjoPjtdM7C/LvsS5fvq0JqQ99PRtVG2j462lGiStu8eNqsvP7fDXO52spd/l0hM7TR9q2kA53KlYplWIgEiy2pkEVl9Vz3ys+gqXyzuSQlPQOpfVW2Ai5jYiVgVSJ2VLaZhJkZBIuMsKWhtYUiYTm/q5/alBmOCmNwnKOgqsKggl8wWFgAmU1woYhMDA0BYEBlQTjQ0IN9Wjw1FVFxwAJC06DCChw4PMJMtPsBWFwSI7+tZvQKjg5DWJTRo+Rftp5MKaDZwnVC17gIexrRVGMWui0lIowZpTBaNEYbmjBny6UzY2XidzNZssG5MjOnajNaZhjRfX8O1mOww1wEGYD6p2xz52G6ZUBp2emN4BNcMcxBD57dsVPvHeW/r/DyNhhbLuvGh85IjmgQ7hzw7a28qtVlBt/YKqynzrKWptbpo55spnfljKHXb51zNyGcQNQGnrS+AEnA/jFI+W0jAwEyBoZRwspUr/URnobwzJ7z/BeJU+7OlZOweIARL3Rg0honZrYNzGbfw4BYYhI6/LNv52ykYNqTELiFDVVDU+xXLaDMrHVAxqRIW3vmA+jK3juW1RRo8WmMmY0cZg1MDdGL2diAhOX56YB5kUqLkLMmANimpZFyz09f5vJ4VMR1lR+Ewg20h+pww7nhHHC//9vVslwhojH3ePOqg2yG6qFzRYz6/1vdPbfvxm6+++eNF4lbhmz55MtFykyvNBtGd2JAD5bh5KjxQcUeImDzPxE3cBC7XP6/n07vWovggMVZ1M7Wo3aSGl9lBhFW7aCamWt8JeIMsV9tRAv4VdgInAOlW59wtdhzKTsQbprc0G8pewBukM36d7jQfp5pM6oWpQg4S7jVST+rmpf6ha59NFROJuRtv//3pw6FSMKNH7iNR+uxWl8+N6WMFMh448d66JOEddW6ITua1w47LGt1kR5XAtjVYgrBfvGfg2URrbkOARJUIghsADWSf6vurqQlpL+HCEnUvm3mzSvtvCFEsV2g/Ecmq3Q5vTRiBkAfDpH1eDGumJTWSy3p4FXnWUKyRtI+aetS/2KKbBEfeDiLB8VeD+MMtn6qJ7QvuJV4P72/rappvTlcZ92KvAvpQV6s1dfZEwgyETgWZ7vcPLtIwoWaipf0Ahe+27IOnkq9SnS/92H/atyu36/uySmUyeBX4fww1ddeWxPBM9FWA6+1NGO/IKyMk3ETQyXCJTuzQQ6ZW6+KfPTutYZaWzuqetKiTGikt65wq+pvlcg3qPyQ1dPoU7WLHM1Je0OFUdP/900d+Zw6FkAj4kWzORlZSSIs4ouSjKPDjOLkHqAvJmFb++FGmUj95BOvjDvkwOq3ne5hvnoexXyX73/zoGcKOGVoC2JaRGw2suxX/+QKFh4QGg001Gwwn0IyZjahLdY2wZkuOqIGllcw2K3GJ0WbfmjqaObTQQvubJfI9nJlmbDudGbKbW2QGoPS1BoBle+7zXbUw4IQyoLNJPKbDohkMeloU0A0cF81to/y8KFwb8oFRpkbKTowyTNSrS0PS3ZSh/vJSmhhfsBQ2MMi5q9sX+JLwfUngISgaxvAYlITDRUth0jdL5B8toftRYPsrvt1BYBrnpWU3PvA4xt0TdhY9Yoy9b0FhYg31bbNcDUMcmW6fyt9Uo5ztLfsBf0TTHiOMads1muX2rlYLzlHE3LJrNE9IjIppjiLuNPfVkrxJS6A5injQlAS1xHqRETLOgIQx6vN4atcDF0VQHrkoK+FC13DzsWa+2zT+YSvI1x60duAjQlaofkzAkkmgcBWijAhWCgk2KopYxgyKMhqzY4YoFreUNU9m7bK+3FysNt3KkLP1jJ2Sws51AwbOiGtcZxD5VnoYy79XeRDLiIJdq/vXhg4CYZt33LVKJROj2Lfhkni3PAqm79MedZDp5IEgFYpFr+x/9A2++wzHDWsGZtZgBJc6aN+mctVK341Kqt4n9dP/SBySzVU/0sdhi7UuIa1LZ63VlJyAT7RuU/lpnW5uQgAUHxJ660YNLE7tRzGZ1RXk2bt0jl98CQWps306P819yq6hl9QT3ceUvtq/3IqdhEj/Pq0fwcf6C6J8l8zR4vtxRNM3dH/F9CfJ/Theqtka+vyHhM66wa8fpvUjeGi7y2pC7s9L9B9TjtP+7Tdf/ykYNjT/g0TcXTK/cv93L7TZNPB/Ae2/7RP/NpYhGjL996q97SPK/PGueoQwgvSjSdJjWse+sXJQK0toOaq1FdYPa2XpXI5r0bmqB7Zy6OKjFwwBd/iiFIQ9wMXotx3hgjGkQ1zct7Ae44JhpINcDIz5KJcFRjjMxeNYj3PBQNKBLgbHfKQL9yPzl7Ie64JRxINdDIz9aBduN9KhUM5s8mOhnjjssS4Bx3awC8aZyUe7GKBZweEuEYmaggEOeJEJfadmxhzyostROEPudNBLY7IcYhLAwGNMphrijuwIGKMP7ZgAuWM7AuDogzsmQPbojkA4/vCOHZE9zaFxjj/MYYKVjvAIqC6HeEyOrB/jEXDLD/JYGeWjPDKi02EeEzJ6nEcgdz/QYyqAfqRHQHc81GOClg60Sm0BdaTVk0s7biSwlR44MvEBh3DFPg9/DHc05X/829d/PnbM9i8KpLuzh9b8+IoBsi37j8dMv6uWNZfxS9U11f2sz5xIBfcnkwdM9UzPlOdLKWSybN9f/nD+4e3dbz+/v7v64eri/O7q/c+//XB5fvfh5vKWABLToxW6z+T2w3e3FzdX15tMbn86v3graMwTywvA0guxcO5aPQslYRr+/9OPAFa90xazvPntmIMVav/qLcc2qpLelFaVQrV9m7xv5f7eNwjL9w/lgEROzqybPSXTcsKDvDNX35wu6m71pZwsyMGBLRi1D6FqF+DJwXryu8sYncpT20FBDotTeMv4k4RQh50F2snBJaldHVMWaKdHjqR6fcBYqp8eGfAQ+miggIQd85Ec0FAPo7AM6EgWYRxXQCDNDZHqkSkhvPTCUJErPDhCLOCBxoEklnn4V0CnDPJILsPYroCIHcHR0VS7iwjUKo7PSM3ssKxAuzb6Yloz7O4jIXYljfStdHtXmsCtmc4yhabQM17b1Dmt2DhljjJw505oCNuRE5SB29pOM9j2tQsMyDZyqRpKvj+4PZuxPfPebFvpyY3ZUg2YdmVLLMHWkYs+dAzDkPD24Z3EeRc8BR8s+Cki+IaSx+xCEqOWs0fyhpKwGrTyseuv2YXgVrYoC1e4OpmXspId5X2xiBcgzWjMK5CFeNFrNaxU5oRCWpe2TssffJ6GLxDscDAR7Wl8Q1BAR/gcjMc4mytf6nYwHOVvvmTC26s6nfnhVYwQfslH8wXgER8zD9P/UGGUrkgxCfNqD0RjfLAHsq4gcP61/vLLsEN6N3C4ZXqPdDKXcClkDUVKpgS2YYIEYRws2Hi47roEZOu0W+tn8tFcPzsRFxr18JaEkh7jGqX5fJYP0BXlWxEP/dRRLkl5eqirXPN6Ma2I41yS8oOIh37mOJmknzhYNlY/N0OjY4jTZSP9oVmWcIVSJ/HRt30E6IWs3nIU84ljQbO2vW2hmT/ul865DhSX0KVpEzOHGje2HLbmTQYxNnBWJq6Jk6FsjZyViZupk5lsM3YAUzw1HW7BxoBqZv+1Aw3Th0YqCO6uWpn4cYbiaea5vrLaIvv5SI2ZOvkIG/NIYdp6MG/07ZLhc330wSkuy/TcVFg4itZ4Yo1VK25qsSjmzmfxmrPjWYWq2dNYrOr8MFa5au7slaQ8O3pVqJ49acUqzw9aFarmzlWxmrNjVYWK+VNUrGriEFVpqeVTmXzhgUOZFrNjj27xVic/6GdUTs93i8qF6W2D8plwLItVP6NOZeEASsORTg/JRMgsUTKDjRYWHvULhQB3mNpAdjvkfv+nAqI3Q0H4qgnnI2xQ0rTEa1dQz7Kvo28L62goDhcxp2hPBJ49edUK6kHeKBuVhSyGYjAVk8zqGJCUyZ1XrZ4ty95+/r2kjnbFYaopmXwyoClzUK9aTVuWfTV9U1JNu+LQLUO4Ue227l6aCYlJJMPbgmx3PZDxmbqhniI3jWlY1cKYxqB0EuzfsmiP5UZj7HasmhCOMiXqlY4HVyFMUlOXg9pDC6pAt9NyJXJxfY6mqCuyySwpFecgxOZflBTZB/xKlRagFHVMNjmF5WFnDZL9riiguvX1lSpqz1HU/G6yOZSEG+NTm3NRPGif7itVVchS1AxvsopKxDUYzI5ilBTdXPxKFZfgFPSFN3mlpaIXiULpbby7J5YEyFQuy0N8ztDaEI3P2sn8pe6oDU4yxUEIWWMwES2D/kC+FV+gSgU9yJClDwFJ2Thk0s4vckhfyrzCUVAj5PKGWiumtQ2Viukm7k5Gs88DcWnxjmJXL7p62VPGjxuiOs4yed1UokLJAwY7j/ZmEQLCxFLuQTUijXschZ5TQy2w+BUvnmiUn5a9aMbCGFdrzSRqvBj7mJhCxMQK7SkxLi0eK6AFwvzlLnyVEHlDDIwM9tfMrCDVbpnaThJI+qA816tqWq0qO0ogWY7CxEtub9KpDiiYDyagPli8fcO4PdyJB4iXY3a3+GwT99werhAx8XI3cXfPnxnjU+MxU5n5VFRAE6BCoeBRkwWJHD2NBOrqaS/bVLPl5XZ2gD5fp7LR+XhhLuruuVku+/Q3dQWsoFOIRB5eeNV69dR23Pk/DSyS9kJKN0kaeKidkuNgnqvP36+TV9wNQLH4GCimwTwKiOHymMy92UyyNs/XBCWw7eSVIIz7eG08VHyGaoYJzNhcDcAFTWwR36t4ZgtgkqI0hKeFZy9SNlAjlGKE9iIkYjXCxgRpLypuT7uEZNvRbuOhIjbCxIXqEVzWLnaKZJhL1fUfzKDMeE5SJ9gwKAsJo0ZC6JdShyD01yoehdCWzTT7H+ZLrOEPE7o3/Vnm5sY/Kkd585+DjOgAIExI0MuhysMew2QNMDmSIcQgDJhDE3YzyqXx2lGdmquhYrfmrClwbPEOKvf7p/C7p6QijruHyOMOohG3L0E3L/noJg3O5d4j7gaswLCGkQZ0DwyX0MXgxMyhFoMtB3IcCsPgryjN4rKVZtmuu4mV5yDkRAQ6pvKt1BtKrCSMg8oYSptVxkA6KsJhclqELZh7Hu42u2nX/eBcuaqMTIjPON/34uEb1VDOZ0cp+kPQ9OAxZAyBOoZcjFDNZu2nevqu7oc8U2M1n2XCfkDX1erp5/4vhUiheCFUcmlmlDZzmiyFSytC51p8v3VcBNkt3tbzR+ayaYIoFXJm4o7rMzTiOf0xHIyzKDiCl3hR2YlOSRM54E39ePnZWFWZ8HhGui8QbwLR3C6VcqZi+gWikePhzd4v0qoB7gAYa4C9OpWtBfPdqawlR3dKbtYImvnj+0W9nSP9abVa8FfxScldmgNABXi5pFgy80oLyGVacSljbA9py7/SGZGJKzF8dyJQq8D1iSVUTChCkJS4NIaHuUcRZTJepYjaXxAyDknlziKdzCVECFlDoYEpgdl4RQ7VaFUKQ49VIsG7reLjdTZcrjMrgSI9WkdEpZ8rkRo6u77AhbCvDwr0joEKNnSRx+FbOs6Q1+u9Z0dgpiHTfQ1uKEp4yIZMZzI1YLpdBg3XTT1tur7u++ZO6uPSyVwaLiFrqOFiSmBbXpUgpMXVrC9oo+l2qfPgJQGFUv5M6ewoQkTNjXrxbF/847dTSVy57Cm+4XLRm2n96+CINrxM1J9uuAVuvbxop3nYkcgiMRcqsPsoRgO1+2ijYJoICUEZ49j0P/R/2kuYKBJB/+8jNFZ67ZgaK50rWCCCFodGLAxxoUbNXQw0UXHRxRBhjcqwPiXWvMNalWGdygVFX7Oyr1d5golrVyXrVsVwYRdPnJLwn4konICARlFqZyDXXdgHGDcLUjT54TDncbqpjlEzHKeY2PCYzzjhNMbY2YsTTVo4zlWcforCY2bihBMSY+Yhxk8/jJ118JlsYCmCbtv5qn1uJt9Xq+p80jeES7pnlacynCHNArGeccFyJlGQIxB6DZKKo919RGRwLApTQcPFbszxd47nKPJPUDk7GP2eNiKDfUH4qnkn3A4gEL2jrgb436yiPZB+URtdTYcC8VV18dTMpn0mRrJA7J+jqvZA+l2JdFUdCsRU1aehRN+3k/XzkIuBLRX8J6iuCGlfYV/z19oR+cSlkursop2vqmZOjzdFwlDyn6XWDkyHavvKXG3Hckn1VhLDUsF/llpL49jXJu+MS8XU2faa45s62a4OEGaS/wS1FjPpF08S+STFoqcStnI/NLOa7M3tu5Z0MpfJBSFraJaBKQE33VA/L4a0w4DGhJIIIjMOKlnUsafbFwSNb2DK64lZVZMwgCOL4uDLBtjt7PpdtVgYQTPRUwGDU0uiBxQOaVCqdBiBMJWNIwxEWcsHUhU2fAayrLMMkhX2lk2xI+9nwcGjtKNl4iv6qmM6NCgd03NA8EZ1HQx2NxyWzGcUFaPbC71KeIs+1CBU/pl30q+C/dJn8PDl8nOzHBYsLz+v6vmSunlDgufzeL2a/7641r9/hRoPpg61ScMTTBeirWpYppHd+hGTgW7TgFjDfdJCw5N8jtN7eM/g1EXHJ++cp+3wLsipqwCflHOfjisdJ7lXg3Wy7RTTbKZ+3+lrwzKJdorpM0s/8/S1YZgcO8W0mKlXe9LasE562ae71Imuk0xxlU9ujZyuKZ6oKWFQZmRGz8WATOCki2W6pUQzN7GCT6kUamWH2bZpk0Lt7ASJbWqkRLs8gTpm6tRpGsY8AVPMYLQBrPFzmk4xT6QUWiI9ZTJisqSQY0hq98lECllusESmzQ7ttvtiB6NEPen0eSSPGaTCehvuG7BXWSLl/C1vqk92pFjImWgT0e1MqZgnVTWdXrfL5rORihDzpEInH/2mHcvb1QJvhGYW0Z5m3InvBxH7b6J155mkXh17KXu0i8+VhuloP2wkyLZNpDnKgUasc9k6YCId3BUroRI7ZToW1D0zcvUDntmXHwo/ZSLs9j2T157KvOosECxcUrBXpzjSk53UvMRupxNGgyKbdam9iExqFDU689JsoQMXM5YtIBfVozT21erRvEHATqiPy0TIwqVuLOwErfvV/F393I8vxHadSuTSorMZQ205yc5E12bzLMhDU3e3q66P1Y9fDDCkMNIKWAiH695zO+Gh9ukdOMQ5ZJBEW2glxbdlYCqkl+uaOm+tMZA3R3Er0L4o5rZPMGd1plP5RFD7xuvXZjyN2tn2QSRQ57yMFGwLIFKoM6AWCrkTznNg3W8zCd/xVlD0LreZpcBGsJlRC4nSCvMo4AyphaVZDqku+7BkansiKYdgn3rRT32zVnWTJwtUInYCquuNnLWyMsETkBUwOdKEfbfrPrfVU9euH5/E7huTzqUHJ+UNdeK4QlhHySIINES2URmaARENawlKePjGQAfS2wMjEd9pki1I7TcZObiuk0ih9Z7sDGzjqHGorWOJpZTRYK21vW7Ybp1WN2rPzsiidB5EHLD/AES/8OmnXu4fMzHW50lcwjyTLRThCWrbvhpOuXFnDc5Rz6eLtiEiOUcSCCBtPE4CTFtwTMWTFjjdQ72aPBk+2DG9L8djPR+u7DTYbSgxmgV9xozzIbWNw7VzzRtfD3LLZtLMNiOCdrX9MBGwTYdAoLYaOIHS7eIgwB6XkYPtjooYak/USGG2CaxXgVMojTiHAbbfJuu8qWd9WJnGF9wBFprIjY5X0HQvyPMm+f/ff61NBBMZK3lyYX/zjzf3m12uXvD5ZHL8jvg2Z/dSHPI9XTm48P8zdVku0AT8jN+Wi7tds9xnf3XoD+FdKFrYl3C5SXmx70jDcLncKbhu+zg4Wf3YVYv8AgeZLJY8BdvVfFl31go7CJ2OyNzmMcKnIPx+064ZyQ5CpyD6sOiLW29VnM/ye9NltFz6dIwlXhBLOrP1w87b0uhByp6Kb1sLBXAHwfEDxmAe5Zdq1vT5NvNHcS6FTuYynyJkDc2pMCVgOhkv29RGjlAKqX6VyTBGkbiwcUoBDT9yU3H00Zvti7HLHBLJ+I2AtkrjpzpE8zZvALRRcVMgEpN145+ZiO0SKFTmrXQFZl/EVrbRz1xv7ISOUm/mDX42MmVSQYIr3Nin88UPgTeTPiRNm+EZo+X7xeafA2b8HjSREr8J5LkaZnSXl3fVozH7s1iUDppMQbj5gHb1rpwnk/ZAem6nw6hxetvM6ePgYg0lwh5A6/kopFy8FCp+JDxMnLlT8rtLB4zKE+p5pbDcElJvQ9yTEaTuWABb0QJZKCcVWQpc0+iTovoyT7S5oFz+Ehu3epxIUOhnXHu1+6BsSy9ZgToXL9RD6uSXmlcECfzcPM0U9/OQV9gRxlp2pvmYepxW1aUzzbBPA9qX/T/7Hsxwkpsx6oyBkrOTBB0dotEIGjKwybB0aEoiZXGQFPSCIbI0OkolhuJSeVgUVKNBEW4RpUuLSqMhqRy9pEdRqi2tBeIpLu0/VDwOcNBonN6WxlmxORzSEQCtTU6dVo2h3J6wLFwURWHnQgcq9TueQumQlTuzxDYEEhHeDDhXRaZYvygvzCPnZrs69V2f7fSmXnT1ss9o85xw750vdUe9caoJeHWFdCVo10guH7eZbXguahAkh3gAXJQBPEQqYm3Xq5GwcQ7utGkn9P1o4CyT0V8fnC0GLVPdJldKxjwxhmEZXx0bx0g+RGbhNL1NZvGdIPxdPA0rIVM+3KUJXMIbmSkUzjJe2+5kWrFxbzLKMNknyJ2crYCjALKKJ5CA7syAqO6LambclVarPDiN6hxejL6mHjGhtQbJPet8t2uZfk6FJklEPGnWm7X5IeNf6+bxibj+jUai5Dy5hsr/rl7mi8r8t9ol96To6uf2pf6u2tgBWjWZkCfRqvrYd1vrBcgSJPek2AzhvwzNis1qKDlPruV6sWj7BMeUKBkt6W3Rh0TXXf1Q9xkQU8m8gdPSnoxCB0WKzKYOicQSzwouV9V8dUgnLIByafH5jol0E7iY/dlE3TXCFoWBmQpXtMssU21DjRXluZn/bV3NmtUXO0wk64NTz6v72fAu9bSpbqr5Y203hzMyD6cP1yzH89GZlAOGnfo0ee7laQqfbj2ZK9avz5CNHXtatdSzz6MnyvDAvZLHUATpXTmGkNSL3FFHQvhvEYi40rRJ4FZIjsnHUqBDHaZG9LEOqpsb7NCKtdGOTSvdmEuaba25ZAVx6Nm2knftXf28GI6kiFGITewVkGQFaGziy1R+Fvj/Z+7duty4kWzh/zJ61agrE8jbedOnS1unJUstlbtnVq9ZXnQxJXHMIqtJlmzN+fNfEkhWJXZGABHJZHtebBURQOzEJQLYCABpcJNPBU9BfOgFX22+dDknoB0VcCmkCbOXbnG9BZRglJuhFEKJRVIj4o1TAk7aTqmxnII+Txs0pNNIwKLKuFRrPlxV9JB5ImKilAtifru9Wax/pA5eisAOs19qLEe2mQT2UbbFFI2inwI6tt+URi3da5oDtmbjSdQnuE2nubHGJzUii6Wd34i6AUx1ekfyse1y3DAzHJCZbWJDlSuezyDwtKt9tyDIyAiMMJ/UfvC4tF2ZxCXcNlUgiTt6unJE/l2oP+LWSeUCb67SzA7RiPbRyJzeC3qR29h8kOsJ47zn99JyMHbW7WLzSOE+9tLP95sbt/b9E4pEbUMZhG09kutEuUG6olCfoV3GUdOCCjXHHRyCGQ80hDKKwr3ZPj73cb3YdX/TxaOUVMFDqN5ytYjXEiM5RVHQs2kNRxFp0av9myNJuVmsB32ZKJ+Ukyq5e/zk6223fF1tvhAqCKk4mY/+9/fD6XDp2+1iyXlglJrPB5Mly73wCH7MD/9O7b9FQZzyiO1aBE9gedddqgZLLz+xJgaN/vJ794/Vzf/ddwNXwDDFxWfpBgIVov6Q+LJprI0E3CTeRoxWOFkS1WL6afJJqJgplARSYjY1sZZOvYWbdqu6nG4OPg3xcdeanH5JkA4yXw5hZLIqb2fVilI+ngfm7dVut+2WoMdMvFGjhGYxZWzBIgNGYtcNOR5AYqBpdLePsgoAYS5JR01gktJgPKQ56C8NyBjtxaOche7StG+CG+CRTqS3NNh4BxgZe+o7OPQjkTSMqdGoMoepjjY2gn+9X0TikimhOY3guGCNEQyxTzKCBACZEeR0Kw0OoX9GgyMCKTA4BMo5DY6oHWUGh0B6nsERYUsaHKqfTzU4il4fMzhsz59icFhMgxjE0+wsEnoIIpozyqvNKXMQM5Qo/AmRkR72iJ6lEJbtSXSvQkLlPAtKO3rONwWhJZ/wnVQLY8Yr/f10xIBQ/dizpXkLTnBOD3cGV8F+xzSWIg5oEj+hRcgOUxnG6GCdDyU/hqVtGxvJ8+EcD3AZPnqYz1l/fORQclQoo4YE2BSzwWn8k7Z+0rPCC0ZiaMEKZoeXjMDQtq9sljhv5IUWY3K2qGJm50SWnjXOx9xJOuLAqb/e7m5TlB0hM4sr58oVeXEKuM44seoTdimuWWqSWO1zWCMFxJghYjHOYoMULZgwPyzOiZZHgSzyPD3bu/Xv0mv7OmlqEv1dZWUSHWxgYN4tdr8ut79trrc/dLp4I8PIzWJoYmWLjA33EdNWDFE4kxYMaXwSgxjFlTCKyhqKGMYoijmMoxJqzEBGsc5iJJUtmzCUUbwTjaUSIW8w46NUbTQnjQnScArGhcp4Cjog/fYubz0poVlMJ1swazdjX05+i85I8YASFkqjW/SG7Nk9VF8bZPdM1YiqbyYwDTvmkZy+3n5cfua75Vhklk7JFCty5QTqqOGn4iRTOKicEjcexSYZHBygxNCQ10nEb3O653DZ2kbTIZzFUcvbLuGjOZQT3bMcF2/02PGmNnnaHk4avHgvV5m7eMcaGLtOJLWpPxaZxdgxxYqMHYE6cZ0HE4jMgRhlk5i5KCqJmePQJMycvDYiZo7TPYeZkwOMmTkO4SxmTt52CTPHoZxo5uS4eDPHjjS1mdP2cNLMxXu5yszF8QyCCZj7F5/vvpCBBRFxeZDBavxcpkLFkxX9YGbw+ZGvYkDtgiyTgI2KmA3cHTEn1SC7Y2amE2ANXaTwDuJLXj086cbh6MiZ6+rZCTfOzoiLc6Qz3jc73zWzc98uq7tUVnWf9sXv0p5+j3asRi5w8/Nstz7Pe+Pz1Nue5649ZgDOfuvzzDc+X+S25wk3PR8viC7tq83NdrnafPnU9fXFlzFaUmqWYciXLL7HfgyfaY7D9sf2t7+04zuXIiAGefiJ/RmI3u9WX1abxVoNK8w4D7bwYQj6YcQIKP49RNkSSFV1wzPcAmxeXDaMVDi+LujL+hkcXvwCOPa6+thfqj6W9OvkEShL9mny89F0WXYrwqlG4DxmmQcPeQ/eMcqSM7aU0GxH08mCdffdDbEztuOXrk7IQFQewiCLzJgl8Ii6AQ+H6gVTtbN+h1evdjs6PDGvEwM1xelo+g3jc3hI57ocTbVRHodHpnE4GhSUv+FRaNyNBgXlbSKtdKG6YHwND0TpalJYhs+w/X632hEz6OFbVqFI1KSzlZ0ob1TVw89BjMwg/KJQp+nlvHrxa2AMBMEbYJDziJv5/OEAS+nWDK8LfX4H4fT5pfjzj7i5/apwTKXUK0fUhSrBo0g+CghZe+zcaRWYM6QwaOeNF6qKHobgnUDIfcJPz1x/WOy/plgCQmaWeStXrmjaSgFnWpy5RJ5Vr3wgKo5ENmNksagnjCo0sfliBNKU6aKivZjZIgvo3MmiosqouSKLS+NEFRiomSKLQePJFBioeSLfPpepB2aWyMJQujQFEm4ZykLR+pQ4FvNobt/8+PLVf/z85uXPf3n1nw9wvi12q+PjI/s/DZMT89SmyorHcv+2WN+7Bwdftvub3eou2OM9OqT9nyiRaTq4glWl+aPZoWnz5Q1SVCUeIbz/5b87ewIFPiaoynuxaxeHli0Vk1Vl+8sVx9/+8LuqtDebZft7vPUpkWk6XmzX6/YmpuJRQq+hXf71vt1htQyT4mUOloZ9psjKMJSQB3gs28/d6pS7tYAo9UmQg54wAVz9tDSuN71Wg/wDyNz5bTcCXDYpnjDLv7AiBorTU3QoYAg6WhU6MH9EBaSWauSXK1fslHac5lz8cwfL84xfn2NOfnnOkDOUapxWXvxbB0xMJh7eESbmeAWkVHcv+y/82qPGh8+9kn6uwxn53jdLcV9+FP8Xf3Wn9OHDxcbrhJZby8n7dYzivMg37wf9upZ+757v113S61W7Fvftgfy/9qud1gc3Je7jD3jVFCM9dRgtx/4F05UBnxjhVUdTlYmEIoUhtQN5kQ8H9lDc2+Pk4fE4++vVuuWIQ0ifhTSkyhQRhgiWNdbMa4+kYuVbj0IM6+3NrwRhSSJ4kJ1Z/5txkHkSxxs6snwKniTrRoKITY2Euih2jdQVm3IKdVEsGqkr5hqFuhi2jFSXMM1CjRwrRqpMWUV5TzlKHqMr12NKm+szQZYZ++393bLLqAVE5Jp3LJF3Ycfq5nzrAk7j9IpfzHGAzGzOgypX7EAQuG7HiVWv3HFSIGH2Ulgkgr2UiUjGj7FLWoV4hH06HpFTIZGkHItQJ+dcSJ0pByPUyTkZuvnn+c6IsyHVChyOUHPM6ZCqJY5H3qNOkq+0MMi8s/f5vXMof37UpegZRNbZ8f3afr/eJmaeJLpxxtmxPR6bvN5S++UstnHGWbANdiK6Ut0mWWQrAkTkexEMMUmVF7WSiFG/ruVUpnceMKc+SozUHTPQF/pcUVTYKCdPOzP0HKk75hsu9LkDho6nLDBnhKHjGSpSfcItXeijZUFvmHUyR0ViSHnFC326OMgNc8d5qneL37sMb9vNF/50BiEzy5KDK1d4jeIYuG7JwapXLjkUSJiZBYtEOZ1QILkdiMrxQK7ZUXXm+OvxqqvV73JMQZ45ECWXJTEoE/trcvnF6oxNLBQ6qaUQ3y3n0ckshVi1CZ+j0MwthVjVKaOv0P3bbnH3YfGdfDiU1R9mmr2Xd52oE/376vD1xdf25ldV74OMF8KmhTSXdRq6yvZ2u/v+bnHH+kkQmMdJUoXKPCTi5WZ+i8NCqLYXlTCeEe1pY0cqj1o6oTbSnJPaorZcqI00qqS2qEUVauPMKd2SCVsq1MkaUlJp0opGeix9iy23vD/h4EVnGZyJ4lP3qZAGKfJ1ulllCpxycinClRzaKVCxQa5HQA33FILYwNcjoExAsmFmrQPGLKRAJAyEHgdnKlJAUkZDj4Q9apSCoj5xNAVb7OBRGuCU80dClGHIuDtLN2hOHy3e/xo1rlEaZFzME8kRxzbyxF4KZ6/g2aNkVNGJfWL03cHUntd3R8znZfoGvvDv3cLgrl1yZ7FPHYcWm8UHRooWTVOZL9BxOTEQSjpHh4fxvTE8Mb87mkbr0BxWt8rKOeWYBUvS+8eQxDy/TjPl9WOaYx5fp5ny9tGuMNs3M14+pjzh4XX6Oe8eA5Dy7DoEu27x8K31RnPJbTLH4DAFXGRk/LTx3mZMASWGyDDj/MhW+1cTYA1zzY/psMWphsiuDXJdAtNLijSJA3opJ0+SaKJzKDmcZ/5//56lttSYooJSpDOw6fCSUzQJTOX87Qy0qQneNLSjs8Gr3eGeOsz7mKA7a+yzkQdvg7RzJ/njwlJT/RAa04ArnHuzep6t+LYJMyUbwZ0N+NiuF9zh3FPauZU2LixVaSE0ttc7aaGuZw/iApXjyjvnM3vVwoOkgOGEm6mEX0dDSAzjWZf337MpYBLm6Jy6eebPb10A1c3X1RqHGQ/rJP2v7yxO88NBNl1FeNQzdJUQxLNfgZmRAZmzmwAgufVIIRrzEsxFAOBUFZcBKFkJ8ji2nJRgD5wpOAkKwjRKQobmW2w/JIIJ8immqTJcq6PUBFyQ7zK4+OkpC0m7tBC33mr58nj/wyqYSsgaELLOjm633bob9/+2UHX3MNv8qHrzpGrDYaY5EAEbM7qlRABJcFOJCgV1SYjEPgouClHhiPBx2gsrVHojDKT28ogJ9a6v8nm0RzhI7dUCWr3hEX+Z8vgxf+Woi3GgEw7aq7TjVRYC9anrLNT6tcrn0Zzgfqec9FfpP2yJm8IEICDfPHOxvMwzO/aYU9zlfJjwKFanQGkZ+yyXwXO8JuB6q60mzHg5bB/bm+1ON7RHOS+D7sVxJeZ7sBYeZL0QPn9MdbX54mtCi3Gc/QI4/alyF/egwRdmu2D7fpwyv6UyX2qEHDOOyE/pIIHMF8DoFkZdU52xrMLcF0DpJgNe8mhs9ROJMO8FEO63629teEekZI43zHWZHugEqXipeN8bZLuYVXnZtndH/6RehdHZL4bzDIz/EnxdM02EN8g5E9sGb8kd7/V4PF/97piZfvSNEpyF7IwWLn5UjvwOHeUZB6JkPbWYjs8pfWz/ed/uDz99fKPENsp8GYzHqf1R/o66RiuOELJeBt/95tfN9rfNu3a5WhzH9avfD+1mT3nMONhYOZdBftseFsfjKZ/uP1PHB+NwR5kljKAAYWDIbhd3P+3W19vX3DVqCYzj7JPHMokrePpnIjgsY7a2JhG/3N7c33ZZzgAMRVwGb7+S6YSPY+H1bnvb6VYC5sq4WA2f+tn1Vg+WyD5PX31cE7a7yXU4yH2x9j71q0kgw8z/qj45YRSxhVwM8/NfuvXE/WGKAR3nvhhKv579NhEl5L4MytOy9gyoTBGXwbvav+ud9ASko8zzzUEGi4GHSc4x35JZCFBCsywC2IJFCwASOxf9c78/bG/pp9sjKIJckgmWHtNDDj2wIOsM6PQTFh7hWZMVDc6E4+IRTnRaSmwShxXFeI6z0mDthtvqjl878RhHGWfBJlm685gEy/boG2IacIk1PA9SsX6fDWx0Mc9DFS/kZwMqX9XzqKet6M/5BN3iOW09yYXz3Pjii+g0SPkCeraqla1ONXY15QLm7BXxZWq0wvkl6sxVyy5Xk5UqWqrO2ROi66soXPHaak640dVLFK540TIbXNGKi8esXm3NBjyx9OIhK5ZdZ/m6xBrs9eK49BnvDkZkL7YiG5Y/eWF2+iBd/GEaTjwKUYhkcPnu6Yret6vN451ig4suh+nRGocDXqfVuKjMJ4E8/WkBUEbt6PWTqFLy9ROtyptHtyrTGmaYrvhx4AqreCivUjvsLtGN1IF+9T4q3HzJzBkkGuTMdoI3kt4FK0eSOsJLljT6HL7S6Om3FKps6+pfUWkBkvQ5Qq7awg+Sd2h0RgnYEn8kfA4zVXzK/se+Zp42ItBM6dWnYsZPaA4mCq9Xv7fLwbqFoWtpsVmmB5GiRTMD5gsUvkSIhHQpMTpKh+zIgzC79jFgQbZL4OqgTIA1zDUTqgmr9RjC83aSz0VLLiF0cFW0rQ6viKiPoU1S9WfVZYycT9ThFHpeN14YYjmG61xqWQcwQS7HgM5FL+sARwnmGNx5KGaluRSTzFHzOT/NPM0CsESzZPSrqeZpGONkswToTHSzGn6ctU0gn8bbTnJcLHMr8Fjnc7dqyFH2NgF5Hv5WDTnKhiYgz0OF6iCLWNwY7nl5XB34BJMbgz0Xl5t2KoNF2qf7X5bb224giUJrotKzLNnSGkQrt/hnRWYvDxmnIMMCJEEuk5Du2i/EQQ0BwlPGiyE7VsGHxY44XCWsv1PmORGK7vLT4EtxJvGyHj+TqcT9zdf2dhaEzx6KOgto4m6kXTdpnwVtX9DMWFXTDgHsqUHO0u6qWZPK4E5Zmk5Cu+tdLj3rFBmosIDL1mx0iiGr2kmhuZPwipgTAWh1rGN0tjG16iWklXwsarir+T8nEYwo+AxFVOIs8CW0kgD2uezS5ClGhGQS+p05uKZpc7cY5SSxkLMwT5OgywkowXdcgIc6y6yydJTCpKpZqbMQx8kpBeyZOKqZXMF5szLFpstF+lKcd5M1yjT6bWr1RyktWcXPw2xN+gARWyT4inlJo0mfkuCOBB8xF4Uk9g4DJqkbfN/a3WG1+dLp7lad4wnFSGIWxoguVcQSjSHrZkiMauUtDGIUd6p6ffIoLuFSxChuvKAcxzDDrEhcrMvtcf5woG8CZQAR+WbFtWw/L+7XdCAIAynMci6aMFZ1sflhsVmuxViGGfTjBu4l1Sj+OqvWT4vPSs19Dpm3jfaGgVl8c3t7f1j8sm4HlpkcxZzgLEYyWrjIVrLfoTOZcSBKy6nFxBnQOCidHdViergY5bDrSvoyjqGPgyOyXwLl6iTfyXXGkzj9G4dJ5Z8Jp9DYJUZA0uZpkTCmLw4jYQGnYSANoQSHyh5KetTALP5oODv4kDKL4QtLE1m6R2g60waqlLYsqbXdfOmW6CmtD1KS0ZXU+aXdtJ1dSdfrUHCqZuFAxhZNjtykLmaogqLE2ExqcW4kpeQkNEsddqu19fdunrJc0Xebgu6x+CwoIkaIrGGV1aG1hy9HOQnfR3ZvNnf3+AjTKD1qeASv5dAFpl6RGsPkdofDB1EFOp8RD6JGVSf2e4nzYRIUgmNiWiThoJKAGI8wrf6BFxuKj3r3MHEWXzYqkHVnsSETYFZbXwIDaYDPRcDY5LF6wizPo5u0WJx+ldFiMAw71sflZ25+9Jg0S6eC4kQzpAE63RQJlSnnSGm93AoPFevWdKRe4YAZ1W9yvpLWxgwOVJWYsUj1kAOB1qUaBrT+4eHm5efj3cBtLxX67uFpWUJutsPOXNmiQ8/UB4g8mQhB3JVplO+PgjrlpyzTlIembihK9bRh+lxGb1TmJGeK4KeYBwKJ2qUKcfCGYwxC6VhVCDiTwqHQ2hUOSXBzwt2u3Xc53LMISRPDSs93q0JUg+yOBfaT1EYngSZhetRAdkGOKYhGJZwDbWieqAzjvktJzWOq2JKnGSzyc/RmK4JKb7w0mDgTxgPSGjI9GtqcpRDpjFoCVaLLcmtUXvRSnVe0fk18ObF2kiw+EmC0ixE1LnZxkgCmXKxIcE0cUqmV93k4VObmTA5iai1Jh/q5HIGsdw0PcnVZ/7n+yT3IwnkpQmaeQ1tMubKjWgRwZaAyp145ohVImM0YFolqWyaOQzhk+DZJEhAK/YzpYJUnbIZC82o/FJYjGOWbuUVW+5fuydM3m327I05F8bgg3+y4Xmxv77b7la6yhplmRnSKuNS24CjfhXBNa0cm94UwTmhTKuvM6OitThaRZtNTbZtIh52wTypPnfAaAxf95/X2l8X6r/fbSLQPITOLi+bKFbloCnjkcI5ceS8tafg4Boxpv+7E1l3L3LQ/7dvxm6gsICqrbPKgqKNde7clA2hZWIMcsk6pQLNe3a7G9o2FchKfA8foJMK3xWp9jCFy1a9qtVHW2fG1+8PqtpP4tPofBTTINTsqfwOfE/3z/YJ4/pcf+OOcs/St4fb4dhm3digwzzY5VajIzo3wJplc3Zc9ITNKrJ8U2eLmpt3vxZUyED8ThdIA03CmW18psn272N18/bC6PT06KgNGZJuz1ViHQKNRewMpDtoV0CB0fkDRcxJOgO05Ez2AFFnU/NOgJtl+KZ6k4WfM4FSrH+tDA5Mft/fzG3uFpY/Zj/OGqXSMqjXSA1I0GiW6lENPPe6mYEg4jlm9xvkDXzPq1ZqTQ1w7vkX9D97e/mm3/ri973ryx3uC6BtJzDKo6VLFz2yHkCML1U9B2EtC+zCDxPmLkbhImnF0NgPjQfpcDBIel8GQYHHFWj93P6naYJhh1u/neXSuL6p3nJRtQfJW0fZQsVZRNIMwmcdjjq7eX20O9M36lJw8NIaNP2OLTcSfkbA55fd3R1/94mt78ysdmxNBgXmnwSGP0UfMLiU082H6KcaXxM7U+jGq3o/lsenjUYS5JCZAg6k/hU2bJB4UZJsBle4QtdI8a3TzFppXrzXSGjySw+znm2p96yQOm89gsFP9eEi77drPbZftpv3kzdN4bYgS8xBvZKky5m0EmYuheRAcmw1Gf5hFxNtI0fB3YfB1oboLI4YkJLZ8srhSBvITWiQINvvS/k46qYeUmULJhqUJI8dO0NgFPXWNLmgaX5mr0rEnrSfoSATTUzpGTcDPFiB9xuaYMEdAsJp9RFKpYg9RqHvXpY0HEqn8JHqednEUHFXn6fNEMr1sFCChNBn6J9J4e9wtp2cXpNZAfsYaP2xPl37JcATyM+KIRhiyraAMK2RHwNCgRGzJzGZEaEGi33TOkDp7rjh9YKXH1Bx66e40Q09KdaLjJYZHDvQjx5qjwCwdiixU+Ngb4GW8w+fYG5pxGExWiQmRolt92XT28fV2vWx3Yx9Gw8I8c+I53Vb7gX4Ng4IDWc5Eg/sLP22IHRUayKO0usegVnLzgNUa3TqQar1ZrG/uOzfVvvh6v/lVAYDMeB6W6B4KjUK0jaJoAb9FpGqGYZZze+GAUg1ADFjG4+9yyvR+2I+pUp7cx/quA8EFkdxu7zeJwh9kRMWbR+P9049vrn/+//7z+tWnBwXfFrvVcQNx/6fHxGhFYG2OXAxAFnkYuPgoNBSxApN2gukT0ndcWYWnp3VLkeZnJ5j8J8d6ps5IXeKTXefrP9mKPznW0SMmMgpGYSFnr4ix7uRjNMMyCOjcERfKZkehiUz27BUy1Jp+bDrIHwCOxLP8zYfMc+EnD8nzRbSERYrmr4CUpaNioTmgdiAs8X8sAslyiNKfoBlk+vjFH1nT6gWg5qvJxRj/5aoFGY9j4C2fH7a3q5uPrb8QLOReBqOMEFP5zo/J4/ychidUblkFUN+mNzByYGlfRJU1/j5upJ5VjVTu/xXVOAJ2qsbsSlWP4w/kZrPL5SmnCmiY739F3Q0gpZw+Vcbwi9gd8OOptUn1Ncr6v6LKQlTp+QFVEHwZU3W32+Xq8/dJVTfK+r+i6kJUp6qrVVUHX8ZU3dfFflK9hfn+V1TaAFJ6eUaWMvgmPiqT9uDDMDG589ZEZRJfLI3K5KocpknjnpDQz3WCSfr5uUsCRXzaMgkLPwFIYIn7/klYKCeaQMH5z0n6Gb+UgBBxSZNQMCY+gSJi3aUoguG/2ix23z+tVzcpK8AIzmMMYoVP2sZjv4s7G0FfBhIHprwRRIBJaz6i8BRWRFlbXJeNwuFdq+wZKW31Ra1/FOmUmYAWXdQGRtFNWUpo0aUsZBTgxLm7FmPKfkYxTpwkazEKvG58zExeeEuG9DBQfHHztX3oV5/a8a7mSGKeEHGyVFl8+AiyzloxqmNmahxtLMVwcxQUf30vfC4CsTlkcEgmw9EaGHSwl4vD4nl/QNw9/0dPM2ixWbpapGhRf2O+QDehiIFQTid0eNiz/DFEyhP9OkSCew9i2CbffqCst/vfV+vV0ZROAUnlnh9j8tWvGMSJb34lEYqNTwycxALpkKQn1TE88im1DlVsNhjtX4JlsQ5JesYSwyMnC3SoEnO9aP+WLZh1eBLz4xgeIY2gw3O6hu3N+FZwCSYy+0xeiLlpjn1HSoIz9a7U2Ti7cf7jdnfbqfufdnl6g05rKcgSLoT2uLl7PmK2lEug/u24ZpmEFHNeDN3LScheXg6V38k/vky/WG3anRofnf8SSHft7fbb0czddaN0WjOzRVwC7/1db1h8zbw7eo1Vu3y5IG7DjIGOl3MJ5P6Sjp8+vtGteAa5LmnpP63vv0yy8X3Gi9TYul1s1MCGuS7XjkcT/NNuNaEtH3NeAt3x8t6+T5NPkUeXaqO8l7GNZ0AkMl+mFj9ut+5sP3VdXLwOw5wXqsEPu+1du3vxdbVedkVoq3CU+xIo910/X3/3NyI/P62vT/Np3XwyWdTlxvnH9uZ+t199e3QVOuixUi6BultpPr85rL6tDt8nOXM6//xMQ6fnoS5OCrVAqQLmYW0GhOibzbL9PVws05QoJzgLKRotXESLst/B0X5H+R+P/9ZhGeaTNIYW1227XC0+LjaEXY4DCzLOhExJWcUBykkrLTJ3hrrdf4hco5GoO6qAS7QuQ9TE0Z27Y62tzhhLGkc6Zcdaiy7GUcbRTdmx1qJLMHJxgBN3rNXDJc5iJobKtB1rLcY0/5sYM5N3rCVDeuA/325vfj3eXxSNWqKEZvGbbMEin0li120k8gCU24gaLEzH5bGoNtN1tXLz69jZxCrFy8+NI709yGOaujmYwCd2KTwyybabBkV6BsNjkc9eNIhizizSYoLtNg2KtLGNDK2L1EvCjfJwhNtaGiwJd8ljEW75KXvwUTyyvxbtwaO8s9jmAOHRwh0DcYZd4uO9pkfxJcyP1tMXr36/W+1clomDIFHM/Lh/W6wOr7fHkJN2cXu9fbUZ36PNoyUzz+OlBxOjd9vNqks+XQ87wgfps0yHqDJFMyEEq5t4kGpVcw5ev9iNkiAkHlSoO+08SQRyvynEEXOZJAKJtxTqTrglUr3QIwkRpF013RnnboWEUyRBCP2hEEF7uzq8+Hrku8a2j1QfZphxVK72f9lsf9uwNC+JZpzpPER4PPjtan9oN8QEgRsjgwyyhbIQi7SLKpboYs3SntlLzqrdhw3ommGUZ976+PxZWB1O8AK18Xy9Pn3ceNUcqRHINyuytQ7Q+lI4dovftHUT5pgVTUu90cOa1Uu1yYvgzi5Ru7wYXeE1A57Oc961G6VNHWe6BKb3nemahAsyztt7vnXix00yYU8O5M9GMrw1vivq8HW3vf/C3MmLArMsQ8hCZVfGI17dQoRWLNg/EmIQL0ZoIJLViFR7ejlCY5CvR6RIYgsSGoNkRSLVnliS0ACEaxIphsRigMYgXA1IMaQXRszgmKM/hCbncPOVZT2C1JmMDZYotDRDmJyPOQr5q8NEikFesqLhcOg62AiJuHcJakGu9dydelFlxO3uCNOUPXkRDokFHqGZfhOaCFPcFo/QTIkIEOFIWuURlIl7/yI0Ets47suzt1T4vMeim4Guv9NWMkidxUqOSxQ+7DGEOaHTEXol3l+kN9HJCNVCvy/SnrDJhHahTRZpT3dpAoDc13MYJH6BUnymXxBVScwvEJim+AURjrRfINBM9wtsUwXWZlg0PFxIwItIz2SNUhqE1in2WbpAHgEkZUTPJHTJM+QCnBOPkk/CuzoJTqvSMPvFUG7vD2fBhPwXrM1YDK+oPvUxvFKkaiOXRCvnIiZhjM9Lkuhk85QJuCS+O4lO48sn9MTp1Xa+r59QpXHfn8Q8bS4wAWdyypqEOnGdNAltcoqbdkXToqXFaAe3oFOXZg0ud5XemKW5w3bSTU30HU3SO2pjKlPXRwd5yRtp86umyorHOZwPF3i3uHuAclSw/9PD79GqJFsnmHFSH5acZOrvpT8rnJWL9VK3WER5+tb5sJR575s/K6r1AtUz5Tb5sJi57pGfGHt8gTpR3BIf5p7lfvjpgcYXqArt7e9hEXPd+z493vkCVaK91T0sYpb73BXHF+Kef/bKUd3eDvmT97YfX8wcBQSPJkqE0Dw8ClewjD6hsHPROdy7sbT6Xly0/IyjkE/zWTCiWZkChWDty2JRzDsUiKIrXRaLyJUpUAjWtSwWxYRDgSi13GLhSL2bAktqMcVikboVXQ9WWqongywzjOrw6YuuG/7zvt0ffjgc7l7tduQzFSMZ+Rph3/Wo+/2L7XL8vVy5Tx7z/Hsmdl7UlzCY7om7hVgw9/R1QudiWO3fdE5iQUUJs1CCPHMgijp2BZzUrJgqYvAxet/LYpK9nSJupfN67yX6zc3ifq8AcxKfHUd7TNRVzDDL7HhuuQt5WDi3kSt4JqABG79pj/s/7DVBLCoi50QuN1F5w4vvt5vP69VNxAWMJGZxAHSp08z/+BsUxp8BojH9Yv0Rw8/AmGD2Y2hERj8JJWXyxwWcZfAZPKI3EqQtc05Pnb+f0IaeqweVmRdj4I08g0Nv4sVYWAPPQFGb9xgSnXFnEM1n2qPDe2hqQmv++X5z426M/lOfErXig4L6I+bHLO/a/X54b+NjmWOhuJMYOKDX290vq+Wy3fAeaCwyiwtiip3mg4jPUDghDorGC8kRRNwQB2SCH4riETmiNJiUJyJKOMsVcYgkvkjePmf12Qv0F9odsXWh8kdyFLxD4pDoPZIcDeuSODBqnxTFonNKHKb5vFK84gJzf79Zxkz9MHkmMz8qcqqJD6CrzPsYgs60SzRHzfoYwCSTzuAQmvMYiLQpD3KfacbHSGQmXNIO6+0NzcJTagfCc/aFyeNhZhyc6yDqX+k2JNpjLmOMYIq7kKCIuIoxiAlugsGgdRFjLHO6B85w2BHEB7HhMwCPSw1KTLqWGeV9ccwgUeIExUFXD9ne34WP/Aw2zFFG7uvCMZUqkhhYw5YZQRUPpaRiejxNUT4aQUnd5DCSqh5MV/iZimySAvf1sA5a5pvJD5jg/ya4vnM8jszZqLTRfiXpUlQ6eO8hchwqXayPkLiHlCadJzjHCSSRUEYyNMLU0E5b31RXjJeq6pIermD2n9CJCwC9MsKeJHRq7AqqlkaCxfWmpvmQe9I0PwFGZe5GtQD24brd3e6vt6PR9DiXoMSkE5b298NucXN49VAEVT7K6Jjd51++7NovJ/aW5XZDMTG7++bYFJvF+lO7+9buaE9KyMyy8OfKnbb6p75EQQGwYDQ8gAJDZK7BQpnACMQRiWgBAZyU0aCKOIsgYDHJXoQRt9J5vfcS/YaeWPH1oVq1K3Dwky8Wi379rsDDTtBYOOqVfByNbhLHoppvTZ+ovOGNzO3h63b54/bwfL3e/tZG6F9WchaHEC99mlvgv03hHBLANC5CjSfiKBKwJrgLCTqR0xBDS7kOvqCzHEgCn+hqcG1L3roMxM2HcSyP2WbCMccIvFx/px1cqr1Ubk6NiXd2CVx6lzelV9EuJt2tdO5PgkznBBMI53OFokoNnij41i4/dGu1xaYrYP094hA5yXkcYrT0iQ6R/TaNQ4wDUzlELZ6YQ4zDmuIQBehkDlEKLekQ2YLOc4hxfLK3MpQtyW7EJsCo92TVyOYYk5dDx7jIRAvqXKQWU8RFxnFNcJFabLyLjEPTu0gBMqWLjCOc0UVKKnXgIjtnmggVGknM4hLpUqe5wvE3KFwgA0Tj+sT6Iy6PgTHB1cXQiFxcEkrKtY0LOMulMXgkrkzcMuf01Pn7Ce0YuHpQOQQxBt4RMDj0DkCMhTX8DBS1wY8h0Rl6BtF8Bj5aaaFhf3N7t25vu2wxKpCRm8vIs2VPNvXkV+kMPg9KafY1WOLGn4c0zQUkkEkdgQSWwB2QxZzrFHhsQtegab3ze/ml+hXrLCL1o3UZGjxRx8FjmuQ+NLhiToSHNcWVJFCpHQqPbla3koI9iCl6//z+8NUJvF616yUZVYQyco/SBo4qVeSTkzg9zkdQY0p/Xrb7m93qjrtJLgIAsp4HZn+zpYN+aAAn8TOVHvwdJ1Klvbhe6WCW4sT4yUmYPEsEKFGkJFwLgOodFqVX4qdYxaFxW2y68b/dfYfxGNM+znMOgoiDpJRP8IsyHLQ7JGtf5QVl2nnnRyHQ+zxhb+CcCdkNtB6OxaBzbBSW+fwZX1HDp5x2bTcEl6ujzX69WK1j66SI7CxrpVT509ZLsS9UrJmS4DTrpgmYIvY8CW3C+kmGULSGUsBLraNiRZ21lkpiFL03pm/VeUbDJfsd7UzS9aXyLBNw8W4miU3vcybgYx1QEp7aG8nQ6VxTEuV8fkpYucMbWY9Xk3fLtU+Lw2r/eRXzWbzoLC4rUfw0jxX5PIXDSkHT+Cs9ooi7SgGb4K1E+ETOSg4ueUc3X9JZriqFUHQtsLo9ZxkDF+xvtJtK1pXKS+lR8U4qhUzvo/ToWBeVAqf2UCJsOgeVwjiff5IZl/HR74/tctW5tsfrs1JHwOkM4gNQo+zjOkOJWegkulQJozRGPMEc0tplb8vx6mXRXYxyMqprkuaY2aV1T7G2UjSMkWVaQGdbpRgiJpXGMcGSSrHwBpSGorebESRKc0kjmtFKxqAGrwRFrWLwzoPeHMrPZkdKn2UMTTm7HcOkmq6rwMTPdscwTZmpp6DJXwGR4Eo/pEOWcu5Z8Bg4zjOdV2vD5vz0fX9ob8MpwPBSzkF6fAIwGLZUmYMPlhaJLzPtWnrsY3lPHmXphhzi47wXYwlGum5ilzMIFC3bPfk+3UhRLzhZUefaNluRppPkZFWrzWeZpl5wsqK7xeGrSFEvOF3RdidrpV5wsqL99/3NYr0W6XqUVakbrAJ+2izuD1+3u9X/xGgxUmoWRowveRoZRn+PggeLANL4VBWOyGopAmeCO02hEnFeIkgpT0oXchbTFcElWd6pWuzcHn2ZfkQvuGL1olp0qbDwC68IHv3iS4WJXYBFIKkXYSlEuoVYBNl8i7FkJQYOY39/d/Rx7fJdN81cXHejPOY4ItIzOZCUhqmOJPadKoeSBKhzLBNwRR1MEt4kRyNDKXQ4CohpxxMr7EwHlMQpc0QTWniuEXLZfsg5qHS9KR3VBGwxh5XEN8VxTcAYcWBJiBMcmQyh1qElkc7p2ISVPHBwz3e7xfefNqvt5ofFZrlux+N8JBF1ZFLrQZcqshhjyEzr3Gxvf1ltxj2c1X0S5+tfiiPox1998jjqlgEykJ/YE+RVtOglxJU0yCAbWGIsX1VAvl4IxWK9fqGtFMhz6Ubzn/5p8VlZWX2OOSqsqbLicaA/33/f3PRibzZ394/U0XFy0qHC9MTWKl/6+/tDvHgvIN4WHmYdV+YgcR6jhwXK7N0Qo34cj3WSXVWrkRutI3XEQJ2mi+7wjL5RXxfoDB7l3W7X7YJ1imHyLJ2DKFL2lGqIlN2l//JF9h1PHkRlblCmn/WBFIK4Axy9tcwiEA4RsuaTg0SmNdJ1+S+Pdl6NXoXOCf1r+Hzp4uZru+RGS5A6y2AZlyh7hzKAyS0u6QfKCZXEi+R8LxXp/kwfzyJ0fx4fyjpT981RSFTTveA5moVDk9SeGpkincwAIRQmxodI25f28Jf2u6hhH0Vl9lek/3P308t2f1ht6FgtsoNhlhnxRMwi2wKq6Svb48M3l31g/WLNWq6RyDzmiy5W+pYuolYaMka5zprJUXQfM3ytNAnjQf4iOLqxpYXis1wEzd8W63t11ZwyzYuoH2TK1sJc82LqbNBq/9WNbBmcQYazkUhdFDeW035KrD1mLuMNE5tJavUrdc+gt7PhN78+iMurHrOd3RfKoE+OJrqPAWSD1KinCApcH9rdD7hAGpY5FBBzG/423NfDzKMaJGRmcXBcuYobt0Pg/BZB5K5tQj91yzbfJxRIGGfLAlF52zgOoaHi2yRpqRT6GVPBKk/YCoXm49Dz4nLtQZ6ZWyJitBO1oZrpJvro8DqDxW6xXrfsZBfSZzEEVJmy8+IAVssrkYqVxBKPQTjk6K9PDjehXmaoRb58Ho1kl45oVXXnSLsHN3Nsb9r9nu3JQfI8HXlcpPDegwApx72s7/fd+H232CwompZUjllEPVqEhvFlFAqVG5Npb39vb+4P7fvNh93qdrEbL9coHESmsxBJBzjVMOnxLdLKDW9CZWp0S7/yla9F6Wc+is9X1zETw365zsKwvXBgYD61/7xvNzctZ2EgfRYTQ5UpsjEIVusrScVKX8ljkHTqCIIJXy0cvHR9qwMcVF9OduzI16t6dqQfDLv2YXFYsZveQeo83XpUoqxTBzCZLv2N5M8Ijd8UnBmnWdSRx6pT3ViiLdKJidrVd2H5F9MdmPtqXfflWnzUea+/7ra/xXvwUGTGbjwqVtGXA9SxuEyx7vHVpqlezWCQd+0xCFH/luhNdXKi7if2dHktRLo7VxMT+jzXM4KTCJEYzdnDM6dFZp4VDDkxDlKrf9f5yNWufT44c8gjCIQlg0yCYPVls93595sltQDiZ6AQDjZp0KdWI2NWRKGdWl3RKM4zAjjVtcyEIJ8ffXxmoOgsMaJcb6cPUEVjLRm5mYwZX7b2jAoXOjjy4e+6JSa1kRoFAzllYz2FTTzsY7UksAAqHKwxiIBI2oUJCJjBkUShHCfJ/jMYMn9fuCPwa5anR4FZBglZqGh0jPDqQlBpxcogVCkGdvZBo1ByIBEUwkHItEJy9Ek1M8Mu9vUz6SQHWkxvNHQh1t7DKO7Fvn2z7LKsPq/a3afD8ZzVlzGhTIvNE9XNFy2L7qa/gKnq3szsH3OoAJHZ58D1pT18cDlfbDeHRTfN0eEis8+Ba7X/uN1OBDXOOweiG18eEScf70inTFMxDG4zigyYwe0syvES7i/x3TStQdNLo98svUxLjqM/jf3vpQLQM+JzmGqLjCIBXMUgumi1jXGcqi3XVBvxOdx6mxnkAqzSMX7RCgMQp9qymtrCD+G2odH6COAljc9FK+ekPXURApH/ATjDNK82X9btsdoEM4iY8Dzsc0qBjIeOfRPTJ37pfMdPuzFblkb0mFPET0/Axiwp0tCUywshNu1cLI1T4eumYEzNf9IApRZyCjrBrDENMOH2otz8BMzs/E00gMeGdAZ8gVG7/2W5ve20SGwaLzuPSUuUL7NokQ/SGrQUHqU90yPbtV/a3/W4TtkuhIozsilYWhsrQqY2sSmUGgurR5g0sCl4YvuqxyYxryl451hXPWLeuApMidK2ysYJcE0f28Xy78ey3m5vfmX4BJCZjWWiyk3dp0wf6Cc+hF0v3G8Oym99EmaaA1PQSX5bHb4eRY9SclCQi6dRhCgWN27nWA9knFFi1hXIdu267aV1yMYZZ0Z2bIM3xyXfZrF+ceokuiakss+MsjN5D6UneFYSJpt/9pFwu12uPn93yuTwwkyzW4y10lis03YieqmSsvs9iOm63TCbzL8ocekh8Z1/hmobsMWvfr9b7bqFCOf6BhwOIyrnjUnTLlQgs/Dc1+gJKzGWFHPFFRR8T6TCxl1ag5Lu2X9QlT38mGaMY7X2+E30TO7VP+8X69RUjhKaZS7HFixaD5PYdbaYByAwxgos8lkbj0g2qJU4eCcQByIYK0okE0Ak7b6mtwwGxevVuvUPLHxs/aEvZmBwgrMMjmjhogHCfoeO/YgDUVIfWkyLQyd6d/jUHg6diRsvh+PgxrklM2R9vd38+v7OXWCgrrxhzkthe71dLye06yDjJZB9XnWLl+PF9Epgw3wz4QqZtt8W6/X2NyZoOY4N886ET3SZugLZs+Cvf89S8zK26EipCbZAO5Afck02dRQzoETxmGseFIftMf1zl+vD8LUjGZhR5ksMhtON3dPM2zj3JTCuNqvDypkEJbwg4zwtejJOE23abDhu7veH7e37zYvtbeeGb1d7tZmlS5jLEQxmW3/ete3ye2oNQkrNMs/iSxZNsmj4XDQYc+VYBEP0jjhigqXCs+vEPt1//rwab8VFIAW5LoDKseZ6WGG2eXBNoUMjEM8kRCehpW4BFEBkbwI8F1eMqo3gmkLW6nud2vqIt3iiHKSqAqP8QQQpSyCcg0zCskQwnct5qyuOJzwSNafnvdXYpsA6j/tOtm5wx97tdvc9wYhQQrN4abZg4TV7BHYdC8IDUDIgOiy6Wo6OJ+KCNzmS+82x6BfdAu+Xxc2v1C2EHKRxzhmwiZaUPKbUclKjnVtK8tpTy0iN9s5dHwVod8pDgGxz9Jbw9r3jwio1p6fFZjEXkaKlV/JRXxCZRtMtEMMxzCVpgCSmKZPVGMAzZ6s6vLFpYQzklHmhrnVjE8N4P5thZqirxOjUMIZ10txQV42ML4uhOnd2qK88fnqYqj39/FCPbhKw82aIaZCDAAlBYMTFAiKm75mev5t/duDDRQIezti8vWCVKAIbpAENYRdcrvaj3cIA2EBA3v2O/9vfdSV82LVDXipa8pNxLu5Lh6i5Kfj+GO93y1T3SPdA/Ayld13O37a7pVDpQPwMpctfhOqcoFLRYJ7qZBjPPkibZUaK5YmmoUOAuuXqSJ1ylSrQvDuKpBWfxCRTXKnWj78J9TrBOTWTLpjWzTveKdpTgRAjDNNiHwRIOFPIIolZwbOQ8CEEIwzaqAFae7jH1i3gDq0TfLFetcS6ZTzmiSwzoekWaw/+kqL8R1jGGeZE4lkCOZCh/Ew4+nCE14s1wc6MUID0dAyiYI2o+mfDP9LRGcOy2GImrRhHKIXz6WTTxJdapFrJpDWpl2MKx8YzQRAKdHG8IOEs4nSgQFckBGKkThD1INDIBjqwlvccbTddDe2OIgK/F8ieYUqCRQW56RHMTcU7HqFXhw4ZL1LQLadEkMmUps1QkPUElZ1MhaMjgSE9Ri7w4b1SyUI1yHwCSy86/r5b3N21y9RhklP/jovPsjQRqJDdjhf/Mt0CRgJKe3PeRHxT20V7iGAavvYoTj91KsEYZJ8Zp3ymIUEqmnxMx8bPR6Tg0lOUaejaXvyDj8Ob3sxBGRLXKO+RAwP3t+1qyRizx6RZDBcUJzJSA3Q6g4TKlMaH1CsfIKhdNBhkOvmOTylNd3K6hgcd5IfF/uu7xd1IXf/7LF1jWJaoX5xAMZ3iqwDzk0chyeASaHw9tukjha+lr36O9YmWqoTC1FTwIYuHx/S9LjWpTNFcyEHEy/YCk8rep8reTy972U0diUepguIfZCZpcMujxHDpRSaV3wntVm2iZR+FJun4lXpfPlDwKz4rryjdvZ+TKP9BZpKGz9vdq8XN+MBHoOJRSKyjzDM7CDanludhR40tyxPf8I/ODXTzxu3uv+I6fj7J/TzV9P7jsP10OE4/rhdfUsoGohp9gyeKVw+BLj+EBvjxkWIUiS/3B47vMYiGciVB6ixOcFyiyBWGMBXWm9CHNjwWayDSS1l2Qi/a97P1Ulaf0Iu2/2y9jEcgVBN+4WzttLeg+tXIZ5ytm/MkhHbKn5ytn/QyhPKRrzlbM+OBCN2EHzpbO+edCPWUj5qkX+C5qMGG/uvsb494NUI/49umoFB4PAoI6/cmYSFd1qf28O5+fVjFXddAamYXhiUrXdkQ/iSXNtI/zbXJcLzqDNp46zQO5pTnAojiTncEZprzFeCIO+ERjmnOWIBjsRyHHERwePEL4EhODkZQJk8SxGjUXTfMdgFcqUnM2LJMnMxIes5eZz+fnDJcAEt6gjVCM32iJcTzvZNTIzplugCmxCRwBGfiZFAyulb7w6pbgv5FiQjyXQBZcro6wjR52ipFo+1Fw0wXwJSeUo8QTZ9aM3hUU+yxK5021RbUjWjKPcJz1tSbRjVpCj4GduZUnMY2IKj8gSeClvIJ0Vn3oJhujvay/bzoVBFFPSZGi8uvmiorHifyz3e7xfdX6/a2HQRDHncK9n8aJqnKfHV7d/j+/pf/bm+wyEGKqsSuZodxib4w/6O2nL8Fb7I/lOR+1pYVzpseynI/62usy/mCWFYNai6UEC/WYJcoXuCT1IWfBNRIJbkOjlcR9TU1TIuPgdimF1dY6kNCaFyw12DVkFD0DJcMrLLTXhwbZ3W7/Sb+vmcP4pM0D2PmKLpgEG8l5QnwVTBJWdHNPca+CsPEKFWn+LCMfwttmO0Ijt/yDa1ATDO54r/gl570PXxuLfrcB5iCQRFTHxsQM39ppyod8zfMdcTGHWUi1sQx3dxi+IKfO1CZftVvmHuIlWvdvXD8E+vcS7bwUVn6dbmgjfeR2SKupGO6qSX0BT+1V/cwaq9EX3sCGfnecKWegjBeol/4m53Ch6+WjeNHoNxoptbg0bHFLb4vOZ4HOk8VILPVAVqmCmCxHwOSCJKY+bO9tgfDLWvxHmLsW8XdnOYQLv3Fw26eywb3I1DuXB3QFTEQqTCVmb+5V/cwsGXG+wSSW+yPKYgYBkFIy8xf/agxFXo3zDr4rOhRhNjO3lhkziMHk/b0CNRMu96Qt8nwuuV38cgx3Mor9cmtOHY0qj+5qcnpjwVcqjTSe0ARtfEJr1w3tVHJqY2tEuUaqS1JTmMsMFSukdp85DTGVk1yjcw2I6c0EaCq1avrTJIFlBwBvXXIWpBo4KyihclNQraNoysnuVZuO5DTm1rI6DTTG38x3fElhVw7ucXHKY4GFit6dmwzj+3aksWEHAOzbcdpT8zmlXpVrZ2eWcu1c1txnO7U/DauWbDpxjqLWHC2/Hsj22ucZsH8Vj7/iW+ksRBEgdxxFIOJ7ouvxwdbl9ft7d16cfQOX7o/R2BIqVmmu3zJohkvDZ9bvK12+4P6C5+E2SRzUBWqGy/shcYjP1ZBmHN2bF2eZbtrlz8e/1Qgg3xz4AonH4vND4vNcq0CNcw0rTfBZF4L4Ovs2j8tPk9A0OeS7b8n+8vwzbz/3icMyUhiFiNClyp7Km8EmRkK3IPxjG7dM/ExFJJOx4BIdDjxt/fPox+POx/azZ5874aBQGcl6kRy5aa4mnj7wHUV0jbMgiUyUqPNphql0aYcjtBTKxzfdk15/ZjwPOM2pWDS0+XRbzynhyfRajv7BNTSbp6u2aQ3nIKIs09JOISpivb3ydjogSjEpxuTwn4YnP8/avllsUv5UU5wlmEZLVx4ZQDzHUrnGkei87ECTJKuHIeU8LjaepGYpTigWf2vtgp5+5ToYmpvPK1xSVsgaWCVHZA0+sAGfDosDqubxPinhGYZ+2zBonFPYmf69qGXUkAYZJGM+ClotPX9ZJRxBmTCQRRpq6Rz1yBgLCGvPmEF9brJgZrSrxqkSUxhwO01dl4fPnr6WRWVfMp0fB0yIFrCMk/J8bIHcaanjJ4ufCh1sJseSsijTQ9TSn4yykX3DoAd/7YPw9dhCf3HdP13HataVOoTyBH/Igc2oVr8QU8gh0o1VZW+z7/Z3N2TocSEmLxiO9/RzT7oaCGu4CeDTPGPGyKXOhsJANLdKAAMnHrCnV/AkU9YTZOG8VwnNc/87ixHNcN682xnNZObYnGE55eGPiOwKMFBJpSSHpA6Ps81coCPJQ+To0WawfmoDx/evnnx/PrN+x9//r+f3v/4UOy3xW61+GV9PCcFIlOKfvtSUnovNUXB+xfXr65//nT98dXzdwktQ9Epqj59eP7xr29//unDy+fXrxK6Atkpyv7j57///e8/v37/8d3PP318++rHF+9fvnqZUErmkSq/fvUf1z//cP3uLaHkIU1V2LvnH//y8v3fqcYP0lWF/mi44n40qoKuf/p4/ZZqxkGqtMA3P16/+vjj87c/P39LVd8wWV3kX396/vJTrFAnoC721ceP7z/GinUC0mJfvnr9/Ke31z+/+OnT9ft3P1//54dXFGZKbPoBOUG5qbNyJG7u/MjNeoLqZz6bXH3iEN3iZjcNBc8hTEBx2x4WU2D0+c7BMXCLn9vDzdeXi8NiGPj46BaHyXJPu7/r8rbXW77ckYy0cP/kyp/bTTfNuHn1rfvqV7erQzctfnHMSGiKZ5h6TlZV/pOETGKAJXInaoRePxHi1CqDEJOvnxbL5dvV/nAsQlP2kzAfXScUfn1gvgRCqnWoMoZfwFTO4Hp3CSC4zv1fWBXbjeDUFZV7u+G//UaL4UbVAPN+/00rOJ5C18BN4iD3pPExyvqH1EuI4uHIkq6G4FO4/vL5s67JnPwf01s+fxYczSQ7Swc62leer9eniiIpqURLQfY/sM8MkQjO9/H9Jvgkpu7Wk6ps/UfX1BoriD/xSZWxTlXLbvHbxM4UZvxjutEAg+CsJNmBhp/BnYruZFW4+gx/SJ0cdadvOaCyO9SJ0RO+467pwOOX3P+AUeRApC9DiI0k/x1MNd3t2rt2M222O877h1QVwBBcgkIVhR8Tr6/33fzonDqD/H9kvQ2hCG5UidRd8FGcZTrmO26r6mx3kO2PsVIPCNK3dZC26vELSHZgtf/z/WK3HLwgO7jm/5QmpRq+HMU/Hbrl9S1R3CBVtXGOAP1+uRLaYbfY7D9vd7d/vd8e2qXfdabYD1pwOl8oKvkJk5ZYSTO5mG9l58p7+g68yXifPRQ5A+zk9V53624E3QbbzvN8Q1DwRb5k0D/3d+vV4flm+WLdLqgnN4J0aafvcO7bD4td99dhOG19LBYkVAU/v7lp76iOM0idUOCLr8d/J8rthSYU/2pzs10Ow1nI8k9SExS8XWw6S/eFsgCE1AQFLxeH9np1m1BwkpIqWCyXP7SL5WBe8VjsQ5oK7Qsf2HFNW0MUURX9erv7jfNaoYCq2Lerza9sJYCEtODbxeHma7t/fn/4ut2t/sc9NPmp+4VsP15Yqu7rYs+W/pAmji0b1/NgziKr4zAAnLwDLizoyS/8vQWPeLizn1tyXgwaPkdiW5Mqvm735MIOdPRiE5UcA7W3Ai0nObmaoGvekX0wfsPNcCtstT6QY8UniHeotpubBWXwfYIczYayB8ef5Rtxy/sbOtjlmCAtZu9C8Z/vv29u3rU70hWgiNhMH3Ncb91twpSlHiSrJtn/dz/YX/Ez7ONPUlibbrLjHjmPhCKNZKSF//d2tYmUO0wWV+Mv++36Pho5hSLSotvN/n7XXu8Wq3U3gfjUSVOlE1LypczqNsjY0jPfkZTuC952bi75AUMhDf5hPhZ+KCRehLaHh0Mw1Cp0kCxGvH2x2Gw3q5vF+qfdiukvYyFp8cu2m2y2faYX29u77YZZzjCS8oaVKmIkpYpW++PM7niifMfUFkhMKPjxxvh48Y9y4mr6vVvA3RzYeVSQPgczMC7wSfhTggcIhUP43JEz+ceRWJ49FKCGlFzR76m5gBRXn30GVKFN+diuu+n4t+D8YmBVBgK60JxP978st7ddX/3Yfml/p6ZkpJzCHr7bLu/X7cftlnnq4DFdvKpxOZix/ZioCIDarr+172KljmSUhT/vhA7xsh9ENCHSHxY3v3YL+WACFUZJDySkoY2PVfjhyEJ93a6Hi9LH2DdSTjOvortznyK3yh9229vVnrInD2nK5upzvd+FT0yM2iyUEy/3fa5PW5pGeUwVTyjX69f3627dsyZJiWGyal7OVIOfoU/79n3b9Z7jPPyv94sl5fxDARWDwhX5mCgt7n6z+uc9W94gVTyJa3e319s3G5LqPqXFqYzBSZ/XboXbDbzuv+M36oPUWc75jEsUndQNYXJzgfvwdZmIzkfRM/TddavpbppMnAkmNA6Fz9C5FX/iduIXDjrHx26avlu+p1UOE2fpGqMCRT0jwMgxwh87G3u/u2nftYfFcjGIvg64YZQSD/G7Trp1T6qs2uXLBXnMaCykYLRP55Pi+FFKPH1bd6uij23XQ/ddnTqylpq8jaXkZE9niruJ5WLZrWaWq/DZnyHpMxYTU7yf1qub1u/K4sNCwwu5R1Jy0nd/WOzoZ2voQp+cMtAdlwDMbfpv6JdVGLVe/FylwRWXko+N3XIZVzu8TeJRcGQfBmmz2BssT3ZlxAAgV3POiKTVPcg9aorduCTQvGuPy6oj1fTranzt8AgAis+P4ziWFTh68XNwBAdcf37YwE6DCGQ1bR9o/GW1Wey+O8G0ylB4tq/2jl+IIRSeDcPN1/bm11cbQeMPJM/RDovZ46ryegsXPoSr2aGIZp3s83ETepDQFHxcV7NBR6GAgjP51H3eun1zaMlQpmG6eIG0unOnwNfUxs1jojqiiS0TJFRRXG0fqfW6W2JSFYAycgp6+f4z21qDVPEExu2hXZ8+NTKHIQXl05ixTRSV/SRtH+kv0AcRSkCkI57pUh6/gtt5X9/vyStNIqhOef6wanEAUuw6nd9j52O5Xmxvbxef2q6UxYGkhAgpMYOz2HSz/P85Us0fhnPrQeGhhJzI+9tivVqOriga0nmBhLxgmmh0v4tJ5/319uX9jltoDZPluK7bHWWJfIJ8g/BYGUumrEGqvEC/MmdLfEyWF/nWXWtPNcNDmrywDydehoUYSMjJycPRW705Dt9vJFaQ0O21/G17s/jlfr3YUf4SRRT7hZ3jihaNIioOmCjZ878TyztahNVizRY7Sp+I9m33rzUL2aVOLJkiwyF1YslBb8aCkx15eK3KC+pSju5XeQEfyAI+iAugLsN4Lr604/lP1z9QBXQ/S4t4+YIo4OULafbX75+/Jgo4/iwt4gfqE34Qf8AP19dUIxx/lhbx5vmPz4kijj9LizjeUvTzW+oenj5FWtDbl9TXdL9KC3hHfco78Yf8+P76zev/JIrwCdJi3r8hO9bxZ2kRH95Q9zZ1v4oLeP/pzX9QRRx/lxby8SXVv7tfFQVQg/z4s7SIT+/fvqG6lvtdVcjPpME5JemK4i4KGqROKPDn61cfqXZHEV3RjJF4TNQV9+7VNTXKHhOlxf3t+Y/ULVjHn8VFvHj+keoc7ndpIf/xiSqi+1VawIv3P16/+vH657evfvwz6ZNCgWnFcn2DkNIqON4pFCn5mDylyBTiBxmxTfv46nU3CF69/Pn4L9q8gcjUojnspByl5L+edkv8Zfv7v/2f//dv39qdC/b8P/+WPzPPmk7y86pdLzvBf3j9XdZunX1czf9Xn/a39rhbcZTwIn+6+ren/7h6Wl89K81//dfTf5wyuN/dD04q6/7Knub2WXVVBWJZIJZ3f+VPTfGssmFpeSBmur/M06p4VuRZIGYCMdv9ZZ/m9bOqCUuzgVjR/VU8zZtnmSkCsSIQK7u/SkqsDMSq7q/qaVl19RF+aRWI1d1f9bE0GxZWB1Jdk/yjISq3CSv3iiksg0ZwrXD1tMyeZdAKYTMcr9/5R5YRirOwITLDaQ5b4nibzT+ynCowbIvsWOcZ2bZZ2BzH4+K06rA9smO9Z5ZSHbbI8Qz1P7LiaWmfFdDCWdgqWcP25rBhjjdF0D0wD1smz7g+mMMAyblemIctkx8bICuJz87Dpskt9zF52DS5a5qKapo8bJq85MZnHrZNXrHjPWybvGYrMmyavGErMmwac8VVpAmbxrhBUxMVacKmMTlXkQasl+EwmrBpDGvATNg0pmA/JmwZc6z/jLIoJmwZU7EfE7aMOdZ/fkUZPBM2jTk2QE4ZFRM2jT02QJ4/LfPOTIX9x4ZtYzPWwodtY3Ouym3YNvbYArmhPseCc7FcnduwceyxCXLKANmwcWzJ1bkNG8eyPsaGjWNrbnzZsG0sO2xs2DYFa9GKsGmKjKueImyawvn8gqieImyawnDVU4QtU1juqwtw/AX7MWHLFCU7RQhbpqjYrw5bpnAtU1I2sgibpmCdTRE2Tck2TRk2Tck6mzJsmpJ1NmXYNKUbNRXRhmXYNKVrmvpp1Q3tIvyaMmyb0o2ahqqgEuZlJTcayrBxymMTGGquWoaNU9ZclZdh25TssCnDtqnYtqnCtqnYYVOFbVMdW8BQ1rQK26Zih00Vtk1luY+pwqap2GFThS1TsVPmCubMrmWo6WEVtkzFtkwVtkzFtkwVtkx9rH9jCNV12DL1sf4NZcbrsGXqnKueOmyZ2nDVU4ctUx/r31Amsg5bpj7Wv6EmfXXYMrWboVEDtg5bpnYtQ81+aljPsC1Thy1TH+vfNE9t+azKm1AybJrGDRpqudKETdOw04AmbJqGnQY0YdM0bNM0YdM0bopGDcMmbJqm4OqnCZumKdn6acK2aSq2fsK2adzsOX9aVM8a8IgNrDcbtiZxyXnFVaVPGoqyNs0nDUXd2KFGo08airJ2zScNRS1XUT5pKOpsm6UclE8byvIt5dOGshVXsT5pKFrzNQvr0KuGr1loL0cF2IJyk9mIJuDZGiQKMtbYZUgVZOyyJ0O2IGPn1hnyBY4VsJTJy5AwyNj5dYacQcYOrQxZg4xdmmZIG2SsU8qAOMhydnmaAXWQOYbAUrY8y5HWYZeoGdAHmWMJ6BoAAiHL2WVqBhRClrNcWwYcQpazk4cMWITMkQWWclIZ8AiZJxKoBXAGTELmqQRqupgBl5A5yqAg+TJgEzJHGhSdLe7mtdgGQChkjjcozFPbPMsr5NeQiHOji6S5gFXIHHlQFCTHBsRC5viDghxeQC1kjkEoyH4I5ELGswsZ0AuZIxHofgj8QmZY55UBw5BZ3nsBxZA5JqEgOxeQDJlnGcjOBTRD5siE8opsA4vcqbOGZO8CqiFzjEJJ86zQXI5TKElXC3RD5liFkuxbQDhkjlegRy1QDpljFkpqVpsB6ZA5boHuL0A7ZI5dIBf/GRAPmeMXSrJvA/WQOYahJPs2kA+Z4xjoyVZWINnNm0NgIDJHNJRkNwQOIvMkBNkNgYXIHNdQkTYOaIjMsQ0V2QuBiMgc31CRvRCoiKxkp+4ZkBEZz0ZkQEdkjnWoyL4NhETmaIeK7NvASGSOd6jIDlvi3oTjJMiuBaRE5riHiuxaQEtkjn2oyD4AxERW8lsUQE1kjoFg3AGwE1nFUkcZ8BNZxc8MgaHIKna1lQFHkTkqoiL7NrAUmSMjSF4oA54ic3RETVvjCreTjo1Sk+MAyIrMcRJ1TkOABqv4BgPGIqtZMikDziKr+fYC1iKr+eEFvEXm6ImaHF7AXGQ1u7uUAXeROYqCttzAXmSOpKjpVRoQGJnjKWp64QMcRlbzSy9gMTLHVdTkCAcaI3NsRU2OcCAyMp7JyIDKyBq+vYDMyBxnUZN2A+iMrOHbCwiNrOHbCyiNzBEXdUPt6GRAamSOu2josQi8RubYiyYj2xaYjazhF1/AbeSOwGhyqnvlQG7kjsFoqLGQA7mRX7EWMQdyI79iLWIO5EbuGIyGcmA5kBv5FctB5cBt5I6/oHdmgdrIHX9BD8YcuI38imeiciA38it+KxfIjdwRGA3lmXPgNnJHYDTkvjhwG7kjMBpq3ObAbeSOwGioEZYDt5Fn7Go5B24jz9ht3Ry4jdwRGA3lF3PgNvKMXXzlwG3kGbt/mAO3kfuYiKurp4V91tQgC83lGIzsivKhOQZGRCIjRqERjt24ouadOUZH+PCIK3LcYoAEz2/kGCKR8y2GMRKOxMiuyIGLYRI532QYKJHzTYahEo7FIJfWORAcuWHXyzkQHLmPl7giByMQHLkPmbiio1QwnsW3GDkcgeHI+cCJHAiOnA+dyIHgyH3wxBU5yoHhyA27RZ8Dw5E7GoOefOZAceTGj7KGClLKgeTILbtqzoHkyPlAihxIjpwPpciB5Mgt78WA48gdkZFl1Eo0B5Ijt7wbA5Ijd0wGHZ2SA8uROyojI6PecqA5csdlZGRAWw48R+7IDDqcJQeiI+fDK3IgOvKCN4xAdOQ+xIIMasmB6cgLvs2A6cgL32akDQWmIy/4NgOmIy/4qQcwHXkRmXoA1ZE7PoOeV+bAdeQFP/UAriN3hEZGxhfmQHbkjtHIMtI0AtuRl/xkEdiOvOSbDNiOvPRNRhpcoDvykm8yoDvykm8yoDvy0o8y0owD35GXLPebA9+Re76DDNPLgfDIfTAGPQkFwiN3rAYdp5MD45FXvGUExiP3QRlkIF4OlEde+dhZ0jQC55E7YiMjg+xyID1yR2xkOWnDgPTIHbOR5eRQB9Yj9zEaZMBbDqxHXrGUfQ6sR16zO2I5sB65ozYyMqYsB9ojd9xG1rVwWTxryhKEodlqLtw5B94j97xHXtHFQqs5eoMuFtqs9m1W08VCo3nmgywWo2t9kzV0sdBmnvkgi4Um88QHSb3kwHzkjt7IzBVpy4H7yB3BQUIA6iN3/EZmMrpYaDTHcNDFQov5aA5DUwTAfuQNF6meA/eRO34jM4YuFhqt4Y4Q5EB95I7f4Po4kB/mijtMYID6MFcZ38cNkB/mimsyA9yH8YEddB83wH6YK67JDJAfxpMfdB83QH+YK67JDLAf5so3GWXtDLAf5oqNkTJAfhjHcNA+ygD7YRzF0RlF8kAM8B/Gx3aYkupiBhgQ48+BkHFiBigQk/mRRgfKQ6v1x0HIDmmABTH+SAjTzYAHMVnEQBpgQoxnQpguAVyI8cdDaANlgA0xng2hzY4BOsR4OoQ2Jgb4EJNnvIkwwIgYz4gYMt4fGBGTs/FUBggR44+MWGpGYoARMY72YDoyUCImZ8OsDTAiJmfjqQwwIiZnt6QNMCImbyIjCQ+QGHZ5bfAIiWGX1wYPkRh2EmlGx0jYeb/BgyTGtxh5+ALPkhh23m/wNIlnRI6t2xnKHIWhyRzvwXwZNJlhY6oMHioxbAicAT7EeD6EjC40QIgYy4bAGSBEjGM9smPMINFpgBIx1kQsH5AixkYmkQZYEeNZEcbyAS9i/FETxvIBMWI8MWLpUQHMiPHMCBmQZ4AZMZbd8zRAjBgfAcJUMlAjpojMJQ2QI6bII6Ya2BHjz6Awphr4EeP5EcZUA0FiPEHCVDJQJKYoI70ISBJTVJFeBCyJKepILwKaxPijKUwvAqLEeKKEjFM0QJSYkh99wJOY0o8+ctoBRIkpY4MPqBJTxgYfcCWmjA0+YEtMGRt8wJcYz5eQEYsG+BJTcisCA3SJ8XRJcUVDgJZznEhWZE9L86xbu4bCQJiYKja/BMbEVPyRSWBMjGNFaJcAhInhD7IY4EtMxR+cBLrEeLqkoOgSA3SJ8XRJYZ6WzbMSZz3AlxjPlxT2aXE1Cgk1QJgYHyZyjNahqhcaruZnKECZmJqfoQBjYmp+hgJ8ieFPuBggTIwnTMhIUwN8ian5GQoQJsZxIsx3QaPV/PwE+BLj+RIy1tUAXWJYusQAXWIaP85IUwZ0ifF0CRlraoAtMY4TyUraHQJhYjxhQkabGuBLjA8WIcNNDTAmxjMmZLypAcLENGzotwHGxHjGhIxNNUCYmIZffgNjYhwpQhLaBvgSyx+EsUCY2Cv+uDLQJfaKje6xwJdYz5eQgbQW6BJ7xYb3WOBL7BUb3mOBLbFX7CCzQJfYK3aQWWBL7BW7brPAlljHiGRkKK8FtsRmrFG0wJXYjI0ltsCUWM+UlBV5aB2oEsufhLHAlFjPlJBxvxaIEuuJEjLw1wJPYjO+yYAlsRl7ptkCR2I9R1KRlsYCR2L5WzQsMCSWv0fDAj9i+XgRC+yI5e/SsECOWE+OkNHPFtgRm/MB4BbYEdvfqZFTs34L9Ij1ESPkBRwW+BHLR4xY4EdszsdkWSBIrCdIOLzQanzQiAWCxPIEiQWCxBq+1YAgsT5kpDJUtIQFisQa3jQCQ2INewDaAkNiDUtpWeBHrOHHGfAj1vhxRt4pAQSJNfwww3s3PEFCRrhbvHnD8uMM796w7Fa2xds3+IgRO7p+w7UXGWNv8QYOPmLE4h0clt3KtngLh+V9Gd7DYVlCy+JNHJYltCyQItaTIuTZAQuciC3YJbUFRsQW/GUpwIfYgl2VWWBDbMHflwJciPVcCHnQwQIVYgv+0hQgQqwnQiryTgkLRIgt2FBwCzSILdhNbAskiC3ZTWwLHIj1HEhNkewWSBBbsutoCxyI9Vd1kP0bGBDrGZA6I+sLGBBbskeZLPAftuTnHsB+2JK3iUB+WH9pR00tRizQH5Y/HWOB/LCe/KjJpbwF8sN68qMm7TJwH9ZzHzVpbIH8sD5chDxtYIH9sD5chDxuYIH+sD5cpCbvY7FAgNiKH2nAf9iK3Z2xwH7Yih9nwH3YireMwHxYz3zU5FQYqA9b85YRqA9bs/cTWqA+bM3P8YH6sJ76aMiRDtSHrfmpB1AftmZX0RaoD+v4jawhp7fAfVj+og8L1Iet2VW0Be7DNvxcEagPy5+RscB8WP6MjAXew3reoyHNB/Aelj8kY4H2sA1vFoH1sA1vFoH1sA1vFoH0sJ70aGj7BbSHbXi7CLRHcRW5CAxuArtip4oF0B4FT3sUQHsUnvYgD74UQHsUPO1RAO1RXPG3gQLtUfC0RwG0R3HF3wsGtEfhg0TIwywF8B7FFX83GNAeheM26EjoAniPwvMeZMRyAcRHwV8AUgDtUfC0RwG0R+GoDTpiuQDao+BPyRTAehQ+OoQ8/VMA7VH44BB68VgA8VFkkVFWAPFReOKD9roFUB+FDw6hKZUCyI/CB4fQuwMF0B+FDw4hzzcVwH8UfHBIAfRH4YNDmHoD/qPw/AdTb8B/FJ7/YOoNCJDCEyBcvUHz5XWs3qD5+CtGC2BACsMbSWBACsPflwgMSOFPzTR0PQAHUpjIrYnQcvypmQIYkMLwVhIYkMKw05ACGJDCXwtCnmIrgAIpDDsNKYABKfzFo/5omq1BFlrM8i0GDEjBMyAFMCCF5d0aMCCFv4CUPBtXAAVSWN6tAQNS+EtI6ToACqTwwSE0l10ACVJYdqpfAAlSWHaqXwAJUvAkSIEXkhbesVETtwLvJOVJkAJvJfVnZugKw4tJfVQIU2F4OWnBj7LR9aT8KMMLSgt+lOEVpY7pyMmjjwXeUuqvKb2ypH3Gi0oLP84KKk6gACakKNltmAKYkIK/I6QAIqQoWeqqACKk4E/NFECEFP7WUvKYYgE8SMGfmimAByn4UzMF8CBFWfG9EYiQomS5xgJ4kIK/v7QAHqSoWOaqABak8GdmyJOaBbAgBR8BUgAJUlQsc1UAB1JUlq8u4EAK/jbTAhiQouKvAQYGpKgiFwFDe1V+jFFsZwEUSMHfElIABVI4moOuLmBAijrjqwsokMJTIFdk8FIBJEhRs/RwASRIUbNBOwVwIEXNT/iBAykc0ZGTx0oLIEGKmt0yK4ADKTwHQse9FsCCFI7q4Oa4wIMUjuzIM/JKiwKYkIJnQgpgQgr+5tMCmJCCv/u0ACKkcGxHTh6DLYAJKfx1IeRp0QKokKLxzUau7YELKRzhkWe01wE2pPBsCB2YVQAbUvggkIwMFyyADymvWH9WAh9S8mEgJfAh5RXbbCXwISV/ZUgJdEh55ZuNvK8b+JCSvzOkBD6k5PmQEviQkg8DKYEPKfkwkBLokPLKNxhlSUvgQ0o+DKQEOqTkw0BKYENKR3kwXaYEPqR0pAcz1ktgRMqMtY8lECJlxnq0EgiRMuMftQE+pMz8OKMWZyXQIWXGX6AOZEiZ+dPx5K3swIWUuX8YgloblUCFlI7toMLuSuBBSsd15Ee6a0xYlECElI7tyMmDsCUwIaUjO3LyIGwJREjJX4xaAg1SOqYjJ0+3lsCClP6BlZyauZZAgpT+5hD6Fn/gQMrctxo50oAEKY1vNbLjAAtSOqojp+/oBxqkNCzzWAIJUvInZUogQUrjmUeyjwELUvInZUpgQUrDzvVLYEFKw19YVgILUvrXV8ib80ugQUpPg5BX3ZdAg5T8/agl0CAlf3VICTRIydMgJdAgZf8OCzl2gAYpeRqkBBqk9DQIfcCrBB6ktOx0vwQWpORZkBJYkJK/IbUEFqT0N4eQ9/mXQIOU/BWpJbAgJX9zSAksSFnwYwxIkJK/OKQECqT0D7SQx0pL4EBK/uKQEjiQ0oeC0PEdJbAgZcHPQIAEKQt2QV0CBVIWLG9V4mstjuXIyfOyJT7Ywp+HKfHJFh8KQgdtlPhsCx8MUuLDLSU//8CXW0p+/jF6uoWff+DjLZ4CIc+ylvh+S+QBF3zBxfEcOXmWtQQOpKx4qwgcSFnxVhEokLLirSJQIKWnQMhjnCVwIKXnQLo1KrHUKYEEKX0gCH0GpQQapHRcR27JB95KIELKil1Vl0CElBU/zoAHKfnnXUrgQUr+3pASeJDS8yCWdDrAg5Q1S1yVwIKUfChICSxIWbPkcAksSMmzICWwIKVnQSw5YwQWpORZkBJYkLJmr5orgQMpa769gAEpG/4ZK+A/yobdMyuB/ygdyZGTx1JLIEDKht0yK4EAKRv2qbES+I/ScRz0XaUl8B+l5z8sGepdAgFSNrwnA/qjbPgRBuRH2fCeDKiPyvEbOXkEswLuo7piPVkF3EfFcx8VcB/VlbeLlG+ogPyoPPlBvutQAflRXfEvXQH5UV3xb10B+VE5hiMnn4uogP2o+CtDKmA/Ks9+FOTZ5ArojypjXVkF9EeVsa6sAvqjylhXVgH5UXnyo6BWIxVwH1XGTvAr4D4qR3DknSOzHdwsA2FoMx8OQnu9CviPyvMfRUFt8lVAgFT+4lTyNGMFDEjFn4OpgACpPAHCfB0wIFUfDEJ/HZAglSdBmK8DEqTyJAh5/LECEqTin5etgAOp8ljbAQtS5bG2AxqkymNtBzxI5XkQ8hhmBTxIlfNtBzRIZWJtBzxIZWJtB0RIZWJtB1RIZXzbkaYSuJCKPxJTARVSGfa0YAVUSGUi08cKyJDKsAvrCriQyrDhBRVQIRV/aUgFTEjlH6MtyZPyFXAhFX9rSAVcSMUfiqmAC6ksO3+sgAqp+EdpK6BCKk+FkAd9K2BCKv5l2gqYkMrGhhpwIZWNHH2vgA2pPBtSkguaCuiQykeFlORGTwWESOXfjKEZ4AookcrfF8JgBlKkKkykNoAWqTwtwnwg8CJVUcQ+ENrPMyP0dQ8VMCOVPybDfSC0oA8Q4T4QWrCItSDwI1UZa0EgSKrSX9NJrdwqYEgqR4Lk5HnpCgiSyhMk5MHiChiSykeJkI8EVUCRVP51W/JYbwUcSeXDRMhjvRWQJFXJrt4q4Eiqkl29VcCRVCUfQFfhQ7eOCMmrK3Is4WO3PlKEPFZb4Xu3jgvJyVeFKnzy1p+XoW8sqfDZW0+UkK8FVfjyraNCcvLgZYWP33qahDxNWY3ev3VWkzzMWOETuD5ehDz1V+EruI4MyauarghoOh8xQvOnFXAlledKyONpFXAllY8ZId/MqYAsqRwjktf508I8K2wDwtB0jhPJa/KGpQoIk8q/L1O7CZi1+HnQeJ4yqQsaBrSeI0Zy8nhWBaRJ5UkT8nhWBaxJ5c/PkA+3VECbVD5wpCZvhq+AOKkcO5KTJ44qYE4qz5yQZ4MqYE4qR4/k5CGaCqiTir1stQLmpPKRI+QbKxUwJxV712oFtEnlbw6hD/ZVQJxUjh3JycMmFTAnlQ8bIQ9wVECd1J46acqn5dWzbi4WCNfAndRXvtXIV5uBPKmvfKuRDzcDe1J79oQMu66BPakdQ2KuqJ5TA3tSO4rEkKHMNdAnNXvhag3sSe0YEnNFXkFQA31SO47EkLGuNfAntaNIDPkgRw30Se04EkM+clEDf1I7ksRcldQUqQYGpXY0iSFjJ2ugUGpHkxgycLAGCqX2FAo9qauBRKl7EoWc1NVAotRZyU/qaiBRak+i0JO6GkiUOosEH9fAotSZbz3SedXAo9SOKjEZ+RhADTxK7agSk5EXBNbAo9R55K6lGniU2nElhgyfq4FHqR1ZYsjwuRqIlDpn90xroFHqnI1LqIFEqfMq0o+BRKkdUWIy8mmGGliUOmcP0NfAotT8nSI1cCi18e1GjlGgUGr+UpEaCJTa+EajnH0NBErNEyg1ECg1T6DUQKDUjiMxWUU6DSBQaseSmKwmHlGogUGpjW800hEAhVIbdkenBgqldiyJIUO8amBQakeTGDLEqwYKpeYplBoolJq/V6QGCqV2PIkhn0WogUOp+XtFaqBQaseTmJycqtZAotSOJzG5pdbrNZAoteNJTN5NVbsWrvHroNkcT2LIgLAaOJS68O1G+iKgUOrCt1tNWlSgUGrHkpicttVAodSOJTFkSFgNDErtSBJD3+VaA4NSO5LE0He51sCg1J5BIZ83q4FAqR1HYgxJcNZAoNSOIzGGNpRAoNSOIzGGjHWugUCpy6tIvwACpXYkiTEl6WuBQak9g0IHrtZAodSeQqFDYmvgUOqeQyGJqhpIlLr0DUj2TyBR6pJlMGvgUGofaEJaYuBQ6rKO9DdgUerSNx49RIBGqR1TwnVOoFFqf+0I3TmBRqkdVcJ1TuBR6spEOifwKHVlI50TiJTakSVc5wQmpXZsCdc5gUqpPZXCdE7gUmrPpTCdE8iU2pMpTOcEMqWufQOSvhS4lNrxJcbS01EgU2pHmBgyBqgGMqV2fImxpC8DLqV2dIkhb0evgUqpHVtiyECZGpiU2pElhgw+qYFIqR1ZYsgojRqIlNqRJYa8T7oGIqV2ZIkhIxRqIFJqx5UYMpagBh6ldlyJIWMJauBR6iaPTACASKkbE+nxwKTUjY2VDE3XFBHfC2xKzbIpNbApdVNF/D+wKTX7ck0NXErdNBEDC2RKwx/BaYBKafgjOA0wKQ0fhtIAkdLwR3Aa4FEaz6PQDHUDRErjiRTaPjTApDQsk9IAk9J4JoW80boBIqXxRAoZrtEAkdJ4IqWgrEMDRErjiZSCsg4NECmNJ1LIoIoGeJQm454baoBFaTyLUpCxVg3QKE3mm41aTTXAojSOKOlqtyhGjEsDJEqTsY0GDEqT+UYjx28DDEqTcQOtAfqk8fRJSXcxoE+anHsiqgHupPHcCbnJ3AB10uRskwFv0uSxJgPipPHECXlJdQPEScMTJw0QJw1PnDRAnDSeOKHnOg0QJ40nTkry6psGiJOGv4qkAeKk8cQJ3RuBOWk8c8L0MaBOGsePcD0HyJPGsAeCG+BOGsOGMjTAnTSOIDHk7m8D5Elj2IVAA9RJY2LtBtxJ47mTkjxZ0gB50hg/2sqnRfmsLFAYWs5HoND7Vg3wJ43nT0p6aACB0vinfM1T2zzLK/g+YFAaR5MYcse6AQql4Q/kNMCgNJalvRpgUBrPoJD74A0QKI2NNR0QKI0nUI5b1uPJVgMESuMJFHLLugECpfEESkVS4w0wKI1nUCqSGm+AQWn8Fa30aAYCpSkiO6oNMCiNj0FhOhswKI1nUCpLMcINMCiNY0lMVdDfB+3n7yiht18boFAaT6FU5GS5AQql8U/70n0eGJTGMyhVdUSRZTBJAwal8QwKeWltAwRK4zgSU5FdGfiTxlEkhtxob4A+aUq/SUBOT4A9aTx7wtggoE+akp2fAHvSePaE6UDAnzTsgzUNkCeNJ08YuwbkSVOx8xNgThrHjjC9AZiTpmLnJ0CbNJ42IeMdGmBNGs+akNfWNkCaNJ40YewJkCZNxTYZMCaNI0W4YQyMSVOxTQZ0SVM1kdEDdElTs00GZEnTB57Q5gzIkqZm2wyokqaPO6H7LXAlTc3FLjTAlDR90AltyIAqaWq2yYAoafxbNbT9B6KkqdkWA5qkqSO2EWiSpmEbDEiSpok5NmBJGvZl3wYoksZTJIw/AYqkYYNNGuBHGs+PMM4E+JGG5Uca4Ecaz4/U5PoZ6JHGkSCGvEW6AYKk8QQJeYt0A/xIduVYEEPGKfWJgbRrNzJSqU8MpNnzcH1aIOwNZE1ZnD41EPc2smHELYq7JiSjm/rEQJpdEPRpgbBrxiajLv7pUwNx15INyeL3qYE4e19ynzYU7pkTytf3iYF0xs4M+sRAmuW8+rRA2DVmQ9KPfWogzh5x7NMCYfaQY58WCLsZJhmk1ScG0r4pqZHTJwbSnBHtkwJZNyabkpqr9KlDcR+M0pC3B/apgbhryYZkWvvUQNyNyyuy3XNsSk+skJFgfWIgzS7z+rRAmF3o9WmBsN8sJ5dvfWog7pqS5kz61ECcPSjSpwXCDT8v6FOH4v7G1yuSDelTA3HHQ19llLfpUwNxftnXJwbShnXnfWIgHRmXBlvTRMalwdZ0vIolb+jsEwNpd+KHDNnrEwNpd6KVDNrrEwNp9rhWnzYU9mErnJOy2JSeeeGclMWm9MErZARhnxhIu9kpHVXfpwbiNmaBLLamD2OhbYTF1vQ0DGeuLDanZ2I4c2WxPT0XQ28i96mBeHR0WmzSgpu09kmBbBYbyQW2Z8FNXPukQNbERn2BrVlwk9c+KZDlNx36xECam7/2SYFsFbEmBbZjwfvLAhvRv59DXq/aJw6l+Ytj+7RAmL26rU8LhB0rQ8fV9amBuIl11RJb0XMz9Cq7Tw3E3dHzq4oclCU2ZOkH5VNbPqvyBqWxKUtvYmu6/5XYlv5C2eOVn6Q4NqdjY2xG0ql96lDcUTI2YwZDhS3qL1bJSA6kTw3EnZnNyMVnnxqIu5FJXjzZJwbSkQlQhQ3qyRuud1XYon3MC9O7KmxS/+JORt4a1qcG4nWkv1TYopVvUXqAVtig/KvDfVogHBmgNTamD33h6qTGxvS3zx4fTKQWJjW2Jn8DbZ8WCLM3Q/RpgTB7N0SfFgj7lqR45D4xkGbvh+jTAuHI+rLGZvRxMFx/bbAhPcvDtU2DTdnksbZpsCk92cOtuxtsyibSlA02ZRNpygabkn+auE8LhH1T0supBpuSf564TwuEI5GgfepAPPOv9TDVnSH1k/Ev9vRpgTAbht2nBcJsiEyfFgi7JQkZON4nBtLs5n2fFgj7GHqSD8mQ9sn462r7tECYvWSnTwuE2ZsI+rShsGN1LBkc3ycG0twNqH1SIOssKzOpz5DyyRypY8kY+T4xkPbNSK7oMqR8sizSjEj5ZBkbhdGnBcI+dIZuc2R8sqyO9BDkfLKMjcTo04bCPeNDM2YZMj5Zz/jQLGKGjE+WR8YjMj5ZHhmPSPhk/cvG5OwoQ8Yn44Np+rRAmL1rs08LhNlLQfq0QJi9b7NPC4TdTIe8W7dPHEobfqaTIdWT9UE1ZMRfnxqI8xRshkxPxofV9GmBMBtY06cFws45kudF+sRAmufSMyR6Mh9ew1YItiN/vUufFgj7diT3LjJkejL/6A95m3GfGEi7FQh5n3GfGEhHRiPSPBl/TKlPC4TdaCQPxvSJgXRkNCLHk3mOh2sa5Hgy/iHkPi0QjrhH5Hcy/h2gPm0o7CgcS17d3CcG0uxdPX1aIJzzfgbpnczTO+SlzH1iIM3PVTOkd7KCn6tmyO5k/JtAfVog7GwqeTt0nxhI83PVDPmdrOCXHRnSO1kZW3ZkSPBkZdSqIsWTeYqHWUdkSPFkJXvzUp8WCPMEeob0TlbyBHqG7E7mH0wmL8PuEwNp35K0D0NyJ2NDcPqkQNZZVUPTyhkyO5lndgyz6EBmJ/OXwdD3F/apgThLuGZI62Se1iHvWu4TA2lvWGkDj7xO5t8PooPz+9RA3LUleXynTwyk2ft8+rRAmL3Rp08LhF1bkkeD+sShtONt2I9EVierI+tHZHWyOuIhkdPJ6oiHREYn87fpkkea+sRAOuIhkdLJ6tgOZYakTuYPNtHRwX1qIO6DicnYvD41EI/tgmTI7GT+rWWayc+Q2Mn8I0PkWa8+MZB2jUme9uoTA2nDjmHkdLLGNyYZmNOnBuJ+WFaMOLanf3yZPCHWJwbSflOLWS4js5P5a3fJI2V9YiDNb1JmSOzkV+wrX31aIJxFOm2OxE7uiR3ydFufGEj7AHF6Ez5Hbie/4qc9OVI7+VVkVytHbie/KiPDIUdyJ3cEji3IG/P71EDc74bQ+xU5Ejy5I3FsQV5X06cOxT3FU5DHc/vUQNwNzoK8IqVPDcT5gP8+MZDmV5U5kjx5xq8qc+R4cv9CEXnqq08MpN3YJM999YmBtG9OMlK4Tw3EXXOSt732iYG0b01yJOfI8+SOybH0ZTB9aiDOr0hyZHnyCMuTI8uT5/w8NkeWJ88jLYkkT+6IHFsyowFpntwH9jCOLUeiJ3dkDukfcuR5cn9tLzfqkenJHZnDFI3taCIOM0eiJzcs75ojy5P7N4zIw2l9YiDtBmRJzmdy5HlyH9BDnorqEwNpfvaTI8+T+xtomNCYHJme3DM9TGhMjkxP7mN6yAs6+8RA2g3JY5equy41go5taflzcH1iIM23JTI9uc1jHRC5ntyyc58cqZ7cUz2ci0KuJ3d8DlM0NqUtY+4MqZ7c8iMSmZ7cMz2c60OuJ7f8iESqJy+ibhK5nrzgmxGpntw/ecS5VCR78oJvRqR6ck/1MHYEuZ684FsRqZ7c0TmWvHu2Twyk+VVljlRPXvCryhypnryIDkYke/LSO0jyJfs+NRD3GyE0e5Mj2ZPzj0H3aYFwZLKDVE9eRlwkUj25j+Qhzy32iYE0T6HnSPXknurhqhu5ntwH8rDVjY3Jvw7dpw2FK/bZlj4tEGYfbunTAmE3ICt6GYJUT+6pHq5KkOvJPdfDzV+Q7Mk92VNlJDuZI9mTe7KHmwAi25P7IJ6KMZjI9+T+vSTy4uI+MZDml5U58j05/3h0nxYIZ7EqR74n93wPV+XI+OQ+ioercuR8cs/5cFWOpE/u43i4KkfaJ/e0D2eBkPbJa35jJEfSJ699c9LzNeR88pq9M7FPGwo37BtYfVog7JqTvLe6TwykHaNOb6rnSPjkTXR0IueTN/x51j4xkPZtSa8TkfHJm4ihRcInb9g7wfq0QLiOfiS2pA/l4foUMj7GH+JiogEMcj7Gcz50+xikfMxVzle4QcrHXPHLSoOEj/GHuJigB4OUj+GfXurTAmF+p8sg32M830Pen94nBtL8TpdBssdEDnAZpHqMp3qYbmKQ6jGe6mHMpkGqx2SxnS6DXI/JIk2JXI/xAT3kUfc+MZCOtCRyPYZ/kLpPC4R9S5IzK4NMj+Efpe7TAuFISyLPY/JoSyLPY/IsMg0zyPSYPNqSyPWYCNdjkOsxOb9naZDrMTm/Z2mQ6TGOy7HktQV9YiDtViTkDYZ9YiDtDGxN3grWpwbizlXWtI83yPYYE9uBNkj3GE/30NyGQcLHeMKHPAfcJwbS7EuEfVogzL5F2KcFwkWkwpHvMf4EF1fhyPcYf4SLq3Dke0x/7TBX4dicjtJhKxxbk3/Juk8LhN3IJE9e94mBtG9LcqJkkO8xjtSxNb1/ZZDyMTYyMpHwMTYyMpHxMZ7xoc91GyR8jH/ZmnyDok8MpNloAoN8j3GkDtcFkfExReyUrEHGx/jTWzXtGpDzMZ7zoU+MG6R8DE/5GKR8jGN16KN1Bhkf46N7GprmM0j6GE/6NMwwQ9bH+Agf8hmNPjGQjnhLpH1MJMLHIOljYvcS96mBuGtJ+lS3Qc7HlHmsCpH1MWVs09Ig72P4R7D7tEA4smlpkPcxZWzT0iDzYzzz09ABBQaZH+O4HW7NgMSP8XE+zPFRg9SP8dRPQ++4GSR/jD/BxZwINUj/mIrf6DLI/piKDw8xyP0Yz/3Qp90NUj+m4jdIDBI/puLj0g3SPsYRO5xDQ9bHOGKHfke4TwykeQ7PIOtjap7DM8j6mJrn8AxyPsaxOgX5bEyfGEibmK1Hysd4yoc+KmmQ8TE1f9jZIN9jHKNTkE/Y9ImBtKN76IPuBvke4/keznwj4WP85Tz0uXiDjI9xrA7zlcj4GEfqFPQheoOMj2l8WxbUNdh9aiAemcMi4WOayKwH+R7jKB2mbyPdYyIHtwzSPaaJjUjke4xjdDhDj3SPadhtLoNcj72KXP3Ypwbi7DaXRabH+uAexoFYpHrsFTvnscj0WMflMM7GItFjr9htLos8j70qI47JItNjr9jNSos8j/VhPYwTs8j02Cu2FS0SPdYTPYzDs0j0WP7clkWWx/qAHvrovEWSx2b8ULRI8tiMX05a5His43GYAWOR5LFZGbEgFmkem3mzyjQN8jzWcTnFFVfd2JL+5NYVOQuwSPXY/ugWTcZYpHpszgfCWiR6bCSkxyLNYyMHtyzSPNZROUVGul+LPI91XA5bgcj0WH90KyN9pEWmx+b83rNFosf6y5CZOBOLRI/N/WVoTDdEosf6sB7y+a0+MZDmo7Ms0jzWMTkcEKR5rL+oh3zbq08MpG2sCyLTYw3vJS0SPdb4tiRnAhZ5Hss/zt2nBcL8OTyLHI/1r0uRb3f1iUNpy5/Ds8jxWBt5jq9PDcTzWBdElsf6a5K5lkeWx1o/MGn7jTSPjZzhskjzWMsvQSyyPDZygssiyWMdk1Mwh8kt8jzW35hM3zVhkeexBb8Gscjy2IJfg1gkeay/M5m+WMEiyWOLiK9Elsf6wJ6soR0a8jy2v6SHNsdI81hH5BT0qW+LLI/1j09x/RVpHuvvTub6KxI91t+eTB/8tsj02NLH2tF2DYke2z9BRT421KcG4tGBiUyPLfkJLNI8tozdN2mR6LElP4NFmseWvjFpA4ssj+Wf8+7TAuHosESSx5axYYkcj42E91hkeGwVmfUgv2Mr9unFPi0Qdp6SPp9tkeCxkft5LPI71nE47BhGhsd6hscyk1LkeGwVHZZI8tgqOiyR5bGe5aFPaVukeWzthyW5AWCR57E1vxxBmsfW/GWTFlkeG2V5LLI81l/PQx/Stsjy2MhhLossj60jrhJJHltHnhboUwPxyHsefWogzvN1Fkke20TpAaR5rKd56Kef+tRA3B8Woc/8WeR5bOOHJsmCWCR6bBMJhbXI9NjIFT0WmR4bYXosMj3/P2N3u2PLcaSH+l70myAqP+LLd3CuwTAEWtozJiyJAsk5OGPD9366M2Kt3fkyIuQ/ozXM6LW7K6qysp7KyNxeyVW8e9xIPdu6IoON1rNr69loPfQ8TXYIrYdq6yG0Hnq6TBJaD9XWQ2g95GVcedYJrYdq6yG0HjqaU5whhNRDNfUQUg8dzKF8nQBC6aGneU1JaD00vFQkxy9C66HRTB4g1B4a3QKFhNxDPqdn5TOuCMGHDuoULxYIxYd8d6u8Jp1QfGjUk+0IvYdGPdmOUHvIZ/UU6UHsIceeMj2YTd/oqkgPYg/FRuFFepB7aM4uPQg+dFCnSg+KD80OCQjJh2aNBITgQz61J+2NCb2HjunkvTGh95CvzJwvXUDIPTTrGc2E2EPtrB5C7aE1uuSg91CzWg8h91CzWg+h9lCzWg+h9ZBbz0rHgYTYQ449hasSag8tXwA2HTYScg+tev4AIfeQ74dVjI4JvYdiZebiukTxoe25TEeOhOBDu97IgJB7aHsXm+IxofZQLMucPnIRag/tetBDqD206/WzCLWHXHuK1RwIvYfce3Y+p4LQe+iQzsehKsIxmQd1Po5VHo7kQw35EJIPOfnkaxcQkg815ENIPkRdLlF8yHfKymdhE4oPUbM4IaH4ENUKS+g9RPUqWoTaQ1SvvkSIPeTYk6/8QIg9xLWmE1IPeSFXIRuE1EO+as/nShHZrRK1h3xST7qRcDRe0fWDJaH2kGtPvqoEofaQz+kpKl0IvYfce/JVJQi5h7iuFyHUHpJ60iSh9pBrT75MBCH3UMM9hNxDzj2Uj9SRe+iQDqX72UbjFX02pHjyOk9C76EjOlRUnBJ6D0m3Qgih99ARHUq3zI3GK7oZ+KD2UDOphxB7qFm4h1B7SJtUovaQeirz7gGxhxx78iUfCLGHDuh89HV5NGbS5/TkKz4Qcg/5nJ7PvVCzvge5h3w95o9E0pM8ECP3kHMP59cOeg/5wj3pbrrReEWfXOZrCxBqD1kz7EHroViOOb/5ofXQ4ZzxMSBIn0UQe6jBHkLsIWvGPYg9ZM2zCFIP+ayefLEFQukhL+J6Cr1B7GEv4hr5CIwRe9jXYy5OQkbvYd+LqzgJGb2HvYyr6NoYyYejkCvv2hjNh33tnnwZCkb14WY3Lkb04ace+TCqDz/1yIcRfbhZlpnRfNjNJ1+vgpF8eHRF7Izmw+VG5tF0xZ5EctprMnoPj/rtCCP38Ki3b2LUHh7NbhSM3MOjySJyD48mi6g9PJosovXw9CymNxFG6+FmrR5G6WGXHs4fbxmlh72CK18wgFF6eDYPIozQw7PuXBmhh5tFmRmhhxvoYYQedujJa/oZoYcb6GGEHvZZPcXTKiP0sO/AlR8QZB5umIeRedhn9RRP2YzQw8sfQ/LHZkbqYaee4rGZ0Xp41S9FGKWHXXrSPa6j8YqupYdRevhYztz59i2M0sNN9Raj8/BuUonMw7sevDIyDzvzSDqUYmQerrc/j7YrmJrLF5mHd02vjMzDzaQeRuThXU/PYiQeduLJV55gFB6menoWo++wb4NeHA8EHqZ6yiSj7zDVlbGMvsNUuysj77BP6MmXbmDkHfYJPfkCC4y8w77vVr6qAaPvsPtOXtzOCDxMTceKwMNcrwnC6DvM9YMko+8wN1lE3WGuJ74y2g677RTvexhxhxvcYcQd5uZaRNthbq5FlB3m5lpE2GFfpScvxmeUHZbmWkTZYak3Z2KEHT54U82LYKQd9j3SJd8ljNF2WOrKO0baYZ/Kk68LwCg77LKTV6ozwg4fuqF0b/dovKLP5Zju7h6NV3RtdIyuw1qv6cLoOqw+t664DlB22JfoKXYTY7Qd1nLCAKPssMtOXgDPKDvcTONhhB1upvEwug4fualQgtF12KfxFLv3MboOu+vkheSMrsOHbooCNkbXYevukOg67AsyF3v9McoO+wI9xV5/jLTDXq9V7PXHSDvstFPs9ceIO+yLMhd7/THyDsd2W/lef4zAww48efk+I/BwsyozI+/IAZzq5BLkHXlGc7kJ8o74Ij35CSCoO+K6k2/6Log78tRjV0HakadGAUHZEa/dyk9yQdqRp5tlJ4g74riTr2kgqDvy+NWZ3jIFeUecd/KlBAR5Rw7gUL6UgKDuyOiuTkHgEd9qveiFBIVHfJ2e4mIWNB7xhXqKi1lQeWR0V6cg88jork5B6BFfl7noKgSpR3xij6W3ZUHrkVmPggSpR2a3arog9sjs7p2C2COOPZaOEASxR5ot1wWtR9x6iisOsUdmg3aC2iO+BVd14qL3yOxun4LgI75iT3XiIvmIb7penbhIPuLkU51aiD7iS/ZU5zmyj/jsnuo8R/YRZ598VQ5B9ZFmlWZB85HVZRTRR7yYqzpvUX3Et+PKl+UQZB/xCT75/AdB9ZHdracl6D7i83uKclJB+RFftqfYSELQfsTX7Sk2khDEH9nNYgSC+iMHeMjSMYig/siuX44I6o/sehaloP6Ib7te5Af5R3a3yq+g/4jP8KnygwIkvnRPlR8kIHECqvKDCCSx93qeH1QgaTbnElQgaTbnEkQgaTbnEjQgcQOyfAyHBiRe01XsiSWIQHKgp5htJKhA4tN8TPKhLTqQuANZPtRCCBKuX0ILQpAc7ClOcIQg8ZKu6pggBMnBnuqYoASJT/Mpjwlms7EgQQsSrrfLE7Qg4fqFlyAFiU/yyZe/EbQg8SWb8xVcBDFIpEkkUpBIk0iEIJE2kUhBIvXEZkEJEqlFTxCCROr3XYIOJId6uFhlXxCCpJngIwhB0qzVLAhB4qv25EvUCDqQ+AyffM0ZQQYS35srX0ZGEILkWA8/+a0PIUgO9vCTr/whSEHiO64/+fMgWpAc7eEn76SQgkQ9l/l1gxIkB3s4X3pBUILEF2rO11IQlCCx+iW0IASJze4URAgSq1+WCDKQNMv2CCKQWL1YoSABiRdzjfytqCABic/wqQbfSEBi5XKFggAk5onMz24UIH3qJ0xF/9EjPNUfqeg/+tRvoRX5R5+62EBRf/SpX3op6o8e4eGRryCk6D/azOxR5B9tZvYo4o82M3sU7UebmT2K9KPDL8e811G0Hx319ahIPzrql16K8KPN8syK7KPNVlyK6KPDs5j2lIrmo748c76GgiL56KjL1xXBRx188oG5oveoT+0ZuRAogo8e1OF8xQVF8dFjOpyvuKAIPnpIh/M1ERS9R33dnnxNBEXvUd+LK18uQBF81BdozqvjFcFHZ3NBoveoz+7JK8wVuUd9z/W8wlxRe3TWNc+K1qPLM5mfgUg92szuUYQeXfWUEEXm0eV5TEcBisqjq3Y7ReTRAzlclOsqMo+u+rWXovKob8WVm5Ai8qiv2bPydZ8VlUd9ck9RHa3IPLq9fH3+QOtH2vjLIPPogZypVIRjNnez16Gi8qiv2yPy+eVjbAzHfB7I4VXcsZF51NdnXvlkLUXn0WM5/LkSShqOOT2aw3nVpCL1qE/0KTZxVrQe9R3YV14kqGg9ejSHV752mKL1qFdzrXzatKL16NEcLqbUKVqPHs7hYiqgIvaoT/kpZuApco8e0uFiBp4i+KiDT16Lpig+2mzRpQg+2mzRpcg96kVd5a+NCeWnyz96j/Lozi4EHz2oU54uSD7qc3+q0wXRR32brup0QfRR35O9Ol1QfZS5O11QfbRRH0X1UZ8BlBfTKbKPOvvs/OaM7qPNUj6K7KPNTl2K6qNe25VX0imyj0pdbqnIPurs8zEQygxZkX1UPJX5KAHdR6We56zoPirNowm6j0o9k0tRfVQ8jfmQAtlHtXnCRPZRn/9THT50H3X3yUv6FN1HtXk4QfZRralAUX1UaypQNB9188mLBRXNR7XpYJF81MknryxUJB9t1vBRFB+15mpE8FFrrkYEH3XwofxJA71Hm2WaFb1HG+9R9B5tlmlW9B5tFu9R1B517cmrJhWxR62ep66oPerak5crKmqPPfU0dUPtsad+JjG0HnvqZxJD67HjOUz5zddQe6yZ62OoPdbsx2VoPfbUHaqh9dhTQ7qh9djjV2J6izHEHntqRzfEHnPsoXwsYog9Nhztcv4y5B4bHb8ago8NT2U+0jEkH3PyyetIDc3H3HzyOlJD8zE3n7yO1NB87LjOKkZ0hupjB3Y4r7I0VB9z9clrCQ3Rxxx98ro8Q/QxR5+8eM4QfWzWL7gMzcdm/YLLkHzMySevQzMkH5vNJiOG5GPTU5kOiwzNx9x88jo0Q/MxN5+8pMvQfOy4DuclRoboY44+ef2NIfrYgR3Oq1MM1cdcffLaDUP2MWefvHbDkH3MF+/JazcM3cfcffLaDUP2Ma/oyuf9G7qPrXq4Y8g+tpo1tQzVx5an0tKJQ4bqY7vb/sdQfWzXNQiG5mO7fjNiSD626zcjhuBjuzZ1Q+4x5568osBQe6yZ1WNoPebWU7yRMMQec+ypRgSIPebYkxc3GFqPNXVdhtJj1OQRncfceYoN5Aydx9x5NCcNQ+cxdx7Nec3QeYzq8auh8hjVUwgMkceoGfkg8tiBHM6nqxsqj1GzaqEh8phvyVWsiW6IPHYYZ/qXb/xyNB5z4/nc+G7/SH/4O9F4zI2n6k7QeMwn9lTdCRqPufHkE8UNiceazdgNgce4nnBnCDx2DKc8hJhNB558wroh8NhBnPKAI/GYE091wBF5rK3zMlQekxoHDJXHpH6uNDQekxoHDInHDuOwFuNpRB7zyT2W7yJuyDwm5TwCQ+UxV558prqh8lijPIbKYz65p/ojUXlMm7slIo9pc7dE5DFt7paIPObIUz13IfOYNtckKo9pjXWGymNazyMwRB7Teh6BIfKYT+vJJ/kbKo8103oMlcdceYpttQ2Zx5ppPYbMYw3zGDKPNdN6DJnHnHny2eOGzmPWDF6Recy0684QeswX7qm6M5Cejw67lJ5ou4JL6Ym2K7iUnmi7gs9NMp03Ho1XtM+ZzGazRuMVfaQnn90drVd4s5lTtF7h3rOmI9JovcJPNi27X0fjFV16T7R9DR7lvMlou4JHcwgH5tLn9lSHcGA2fXZPdQgHptOxpzqEA/M5yvFrtF3B5fg12q7gcvwabVewZzIbw0TjFd1kcmAmZ5PJiZl050mnPUfjFX0yudKlJ6P1Cv/MlaSzpKPxit4nOhsKROMV3eRxYh5devKJkNF6hZf3yWi7gsuXWtF2Bdv5G7NbXzR+jV7lcCfaruBxvjq99UXrFd7cKaP1CvdUputDRusV7rnMe+SFuVzNdOZovcL5fHnmSNF4RcuJzvvMhdk8niOflXxZ57Mwn6va0iCavsbu5rrcmM09ut9jYzZ3tS5aNF2xx18/S9v+WDMQrVf4rr8aE3k0R550tBGtVzjXX41pPJgjn1WN6QHBPJZbr0fTFXsuypEuJh+tX8MP5uRfTZjGYznyWS2ZfTVhGqlOI2EaD+TISLdSidYrvE4jYRqP40g6uTsar+jyESTarmDpzmvCNB7JkXTnu2i8oq07swkTeSSnPFsZc8mjOwMZc3kopzyrGNPJqztTGNN5KKfMPmNG2TOad5mMGa2hJ9qu4BJ6ou0KbrtXxoRym1DGhEqbUMGESptQwYRKm1DBhEqbUMGESptQwYQ691S3b8GMCne3b8GcSrV/TDRdsX6J5vdXwYyK97X5uFcwocd0ZOSjU8V8HtKRdFp7NF7RJ53ptPZovKJPNtNp7dF4RZdzCaLtCqbumlBMpa/rU10TiqlU6a4JxWyqdteEYjq1vXUq5tOe7powTKiN7powzKh5RrM3ndF4RZdTfKLtCt51J2eYUKPuYjNM6AEeSasaovGKLvUn2q7gcipstF3B1p2HaD/Dd2MvzsOB+jOe0ZyHA/1nPLM5DwcK0HhWcx4OJKDx7OY8HGhA46HmPBxoQOPxhKaDloEENJ46oQMBaBzjkbTwJBqv6JPRtPAkGr9Gj6c5bQca0Bje26Y9+UADGsOvzbQnH0hAo96aPdqu4HJVgmi7gsuJW9F2BZfT76LtCj4d7UrvPgP9Z4xy+l20XcEnj+kWbdH4NXrWKDvQf8asUXYg/4xZo+xA/BmOP3lRSLRe4fUtcyD+jHrd5mi7gsvpd9F2BdeIN5B+xuEdWekNZ6D9DLeftfNeBPFnHOCRtI4lGq/oczWme11F4xVdzteKtivYE5n3Iig/w2u7NKe2gfQzDu5IuhtVNF7RTSoRfka9H3u0XcG14g1Un7E8k3lnhu4z6v3Yo+0K9nmUaSVntF7hp1vdeaeD8jO8rOsT4vlHJrwkUX7G4R3ZebeD9jPCfvInkoH2M3zt5nx7n2i9wk/vmpeXROsV7hMK0u2Lo/UKP8+Z6fyDaPwafZTnY0CVHhckoEHl+8tou4JnOWAbKEDDBag64ihA4zBPecQRgYYjUHXEUYHGkZ7yiKMDjSM91RFHBhq+hk914qIDjSM9khaXRePXaGegtLooGq/o09Gm1UXReEX79Zn3nWhAww1o6+ef+fDEcEyoG1BaIRONV/TJZ1rFEo1XNHdHHBFocAkGAw1ouAGllSnReEWf1bU0LbqN1q/hB3nK3xsJaBzkyX9v9J/h/kPpqsHReoVXywBH0xV7MpnvOROtVzi1fyTmUkpmHyg/4/COpEUk0XhF+/5O6fJD0XqFn9eYVDzUof4M1x9K1+CL1it8dEcF/Wdoae0D9We4/qQbcEXjFd0MZVF/hutP+UdiLo/vSFrxEY1XtLSHBNPp+JPuBRaNV3T9Unqg/AyXn7yCI1qv8Pq6RPYZzj6czk6L1iv85JKLDgXlZxzdKQ8h2s9w+6k6CbSf4faTVpNE4xXdUAHazzDtTizUn+H6k5aeROOX6Pl03exE/JmOP2mlSjRe0fXTyUT5mb6g88jHHRPlZz5dOifKz3y6dE6Un+nyk9bYROMVXadzovzMp6a8ifAzfVmffMZ4tH4Nd/kpHtUnys/0Wq98gnm0XuF+faad50T6mU4/6VTtaLyi23Si/swjPJJWE0XjFd2NgSYC0BzlGGgi/8xDPJKWHkXjFW3dOY4ANH095yebnDURgOZ0OMhVYiIBTZ8BlK5LFI1XtK8Wmy5eGq1X+BkGpSVW0XhFn2SmJVbReEXX7zQnKtCc9TvNiQo0XYGKwdtEBppe65XXW0Tr1/DVDYImOtBcdTFCNF7RJ5ta5AclaLoEpWVq0XhF18OgiQ40V7l4frRdwdz9kZhMnwBUHkFM59Ge+phgOt2C0mK8aPwa7Ws5V1+OGjR3OQyaSEHTKSit84vGK/p0s5QVRUTjFX3ooDiCKEHzWM/4pID0yzGbPgsofxczEYKmL+T85K+dJkLQPNQjaT1jNF7R9ZB2IgNNqudzTVSg6QpUHG9koOmrOBfHGx1o+k7t1fFGB5o+E6g43shA80BPebyRgSbVQjsRgaZPBkrLR6Pxii7X/o22K7gsSIi2r8EuQGlhajRe0eeOmRamRuMV7QVC6Voj0XqFexebDwxQgKYLULq1UzRe0eeGmRZiRuMVfcayafVjNF7RzVgWBWhyM5ZFAJqHeCTdNCoav0Z7tVfh5xP9Z/oUoGooiwQ0nYDSjYyi8Yo+uUxrFKPxim5ulyhAU5rbJfrP9Mk/6Z430XhF++rq6fLd0XqFn1wWb94nEtCUcjWYaPsa7ACk6Wpb0XqF1+8yJ/LPrLdrj7Yr2DOZX5XoP9P9h/JXYBMFaB7jKTYBjdYr3LOZX/MoQLNe2CfaruCmh0X+mfW6PtH2NdjK7dmi7Qo+F2W6aVA0XtHnmkwrCKPxij6ZTGvPovGKPv1ruh1JNF7Rp39Ny7ii8YrmrutB+5lWP10i/Uynn7weaqL8TPOXX/m8j4n0s3wt5+LsXkg/6+hOdXYvtJ/l837SvR2i8Yqu54kspJ/1lPV70XYF1+UlC9lnPfU8kYXqs47sSF7DtZB91qGdYZoC1EL4WY9PmOV0tLEQfpYXfXEO8gvhZ43RjAUXws9y+MlrnBbCz2rm/Cx0nzXq+XgL1Wcd2CmPIbLPGtwdQ2SfdWynPoaY0KHtMcSEjrqXXQg/6+CO5MVcC+VnHdvRvDprIfysWS7QHW1X8KovCFSfdWBH87qvheqzZrnnU7RdwXX93kL0WbNckjLaruB6vshC8lkHdTSv+looPsurvvJHxYXgs3xN5/xRcSH4LJ/4UzwqLgSfdUynPFlRfNbyTKa3y4Xks+rdu6LtCi6XdY62K1i6I4ipdPCpjiDmcll7BDGZXvRVHUEEn+Wbd+WnFYrP8qKvdIeRaLyiyyULou0KLpcsiLYrmM7vkQ43FnLPcu4piv0Wes86oqN5+d5C7lle9pXuXRKNV3TNPQu5Z1G5NGW0XcFNHlF7FtWPIguxZx3O0XS/lWi8ouuHyoXUs6h+qFwIPYuaXZ6i9QpvOleUntVIz0LpWY30LJSedTBH0/1novGKrqduLYSe1S3sE61X+Mljvu1itF7hp2sd+S0EpWfVO7dH2xV8LsiR99oIPctn+pS/N6bycI7mpYQLrWdxc0Ei9SzxXObdDkrPkuaKROdZh3I0L5db6DxLmp4VmWdJ07Mi86xDOZrXVi10niX1K66FzLPqhZuj7Qou14KJtiu4uSCReJZ6EvMOG4VnaXNBovCsozjFW6KFxLOO4hSLfkXrFe7XY94NI/EsreerLwSepTWhL/Sdpe3liMKztBm2ovCsozia19MtJJ5lT/ebIPKseobPQuJZR3E0L9VbSDyrKexaKDzrIM6QlffaSDzLt2zf+ZMkEs8yf7OVd9ooPMuFJy9fW2g8y5pLEolnHcQpzj8Env3UVreRd/YBHJ352+yNvLObqT0bdWcfwam/e2F4WeG+kXd2wzsbeWc/9VPkRt7Z9frN0XYFn7tjXim2EXd2s57PRtrZTjsrXZA5Wq/w+va4EXZ2vVlXtF3BtQVsdJ09/N1keuPdCDt71MOcjayzh1+M6b10o+rs4zb0OXMleSrcqDp7eCLT29hG1NnNcj4bUWcft9G8cm4j6mxHnbwKbSPq7AM3uvI+eyPr7Hrl5mi7gk8qV9r5bWSdfehG81Kqja6zG9fZ6Dq7cZ2NrrOP3ehKx6sbYWfPeqiz0XX2oRvNC7o2us5e9VBnI+vs5XnMLxtUnb3KVe+i7Qqu1Xwj6exVrnoXbVfwuSDzurKNprPrJZuj7Qqu1xONxiv6XI4s6dBvI+nsXUPARtDZDehsBJ29awjY6Dn7mI3mlXMbQWfvGgI2gs7e1Bw+BJ3tKzZXhw9BZ+/6wWOj5+xdj3I2cs7ezdWInLN9FZ+8hm+j5+ymiGuj52xqbo/oOZuaixE5Z1P98LiRc/YhG81rAzd6zm5W8dmoOZuaHKLmbGpyiJqzG83ZqDnbNScvUNyoObvRnI2as33aTrozYDRe0UcA0hm3Gylnc12vvlFyNtdPjhslZ3P9HnIj5GyHnJ3fn9FxNtf16hsZZx+qKQ8eZvFQzfj4RTJJ3Ag5W+pZHhshZ0u5qG+0XcHNSBUdZx+r0bwIdCPkbGlGqug4u96AK9qu4OZSRMfZ9QZc0XYFn8f/vIpyI+Rsh5y8inIj5OyDNVpMDN9IOdtrtfIyyo2Us7UGgI2Qs+sduKLtCm4eG9FxtjZXIzrOdsdJt2iLxiv6jFLzys+NjrMP1UzjtPB3I+RshxzK66k2Qs4+WjPlSQVlo+VstxwqHjkQc/YBG6V8+shGztkHbJTykuiNnLOP2CjlnrPRc7Z7DlERjjl10PncbiINx6T69uuUL6660XT2cRulfFbDRtWhx7NqaTih65C7TrqFUjRe0TXrELIOPfVTJCHqkKMOp7tQRusV7lPPsxsxoevQsRvl/NwilB06eqOcT3witB1y2+F8WhUh7tDTXaSEvEOj2aMiWq9wT2d+5hICDx3EUc7PXELiocM4yvmZS4g85MjDmh8ZVB46kqNcnLnoPOTOI3n3RQg95FVbkpeDEkIPOfRIcc6g9NDRHM2LMgiph2a9Ugih9NAst5CJtiv4XKD5XENC56G56qsInYcO5ayV38oJoYeO5azP20UajtlspIdQeqiRHkLpoWYGDyH0kM/gyctICKWHmnWbCaGHDuZoXgRBKD206gEtIfTQql9MEkIPrfrZkhB66GCO5hUThNJDq362JIQeWnXtHSH00PLLMZ8hTig9tOrZdITOQ43zEDoP+bo9+Tej85BP3MmLPAihhxx6irEyofSQr9dczK8htB7yyTt5CQmh9VC9O1e0XcH1owmh9FAjPYTSQ430EEoPufTkZS+E0kON9BBKDzXL9RBKDx3NKfbWiNYr/DBBMcGGUHuIfOST1k0Tag/VG3NF2xXcdKuoPURNt4raQ0d0NK8xIuQe4qZbRe0hbm6PqD3EzS5O0XqFr67XQfChBnwIwYcO6mhe7kQoPsRNHlF8iOtXk4TgQz5xR/ORC4oPsScyvz+i+JDP3MkLowjBh6S5IhF86KDO/Dh8tH786AowHDPpi/QU9biE6EPHdebHn7n1x70x8ag+5FVaH39n/stgMo/tzI/bQjZXlFB+yAu11g/bfpyC+UT6Id+US6X4SzGhjj+q6ftPQv0h1x/Ny+4I+Yd8qZ6PC+jjwIyBfynyDzn/WDFmRP+hYzxqeUkaoQCRT+WxYkiPBkTHedRWOt+fUIHoSI9a8RiIDkTuQJZvfkMIQeQQZPmkQ0IJIp/R83FPyb8ds+oSZMVJgBJEPqUnLz8ghCA61GN5+QGhA9GRnvLxGB2IwoGKJ1J0IDrSUxkWoQNROFBuWIQOROFAxQmGDkThQLlhEToQhQPlhkXoQBwOlEsAowOxO1BhWIwQxI/rXv7wzUhB7DN8CsNixCB2DCoMixGD+ICP5YUljBrETz20ZbQgfuqHFEYJ4pCgPP+MEsStBDFKELcSxChB3EoQowRxK0GMEsStBDFKELcSxChB3EoQowRxK0GMEsStBDFKELsEFRzIKEEcElScBEhB7LN+Cj1kxCA+4GN5hRGjBvH0rjcd2zFqEM9yIUNGDOLDPZaXpDBaEE+/QNNxICMF8SyXMWSUID7aY8VDMKMF8fGe8pJDDeIDPpbXpDBqEB/xsbwmhZGDeHkm05soIwfxIR/L6xkYPYhX/WKM0YP4mE95TFCE+KBP2Q0hCbFP/qm6IUQhXtJ1Q8hC7CxUdUPIQuy7eFXdEMIQ76frz5GG2BfxqXotxCEOHCp6LdQhdh2qei3UIXYdqnot1CEOHar+VMyq13ZVvRYCER8EspHfoFGIeNdTEBiFiH1F5/wGjULEB4EqamEkIj4MVGkBIxIx1WTLiERMNdkyEhE304EYgYiPAVleQcQIRHwQqKpmYiQiJs9k/oKBEYn4QJCNfGY3IxMxdRP0GJ2IjwVZXhjECEXcTAtihCJui7wYoYgPBZWHBaGIDwaVhwWpiL3KqzosaEXcWBGjFTHX5sdoRcy1+TFSER8Nsry2ipGKWGrzY5Qiltr8GKWIu53bo/UKP/P0Pu8R2cFGKeJWihiliEOK8mc+RiniVooYpYh9jhAV3TJSEXu1Vw5LjFLE4vnMB0MIRax+beaDIXQiPhJkeZUVIxPxgSDL65UYlYibWUKMRsRarzfBKER8DKg8s1CIWLtKWkYh4mNANosbPgoR19u4R9sVXNcJMeoQN2v6MNoQH/6xvBSK0Yb48E/lMYw4xC0OMeIQBw7lfMOIQxyThIoxEOIQBw4VlzLiEAcO5XzDiEMcOFSMmxGHOHCoGDcjDkngUD5uFsQhCRzKh6qCOCSBQ7n2COKQBA7l42ZBHJLDP5aXzwnakDzU9M+COCRP+ewpaEPiNlT05YI6JK5D+VcrxlrT7wvSkBz8yb8aXUjGaO4Rgi4ko1w9XxCFxDd0z+8ngiYkoyzjEwQhOeRj+dZ5gh4kR3wqFBD0IPGFfYpOSNCD5IiPzfzKFPQgOeJjeaWbIAfJAR/Li9cENUi8CKx4nhXkIJl1LhGDxDGoePYV9CCZdTJRg8RLwIpHU0EOkpqDBDlIptNe9VtjKmd9SaIFic8MKh55BTFIVn1JIgWJU1BeVChIQdLs6SUoQeISVMy5F7QgWd63puMwQQqSVc+SFoQgWfVTiSADyarfYAsikBzmsbwUUtCAZHV7kwgakLgBFZNyBA1IjvJYvoOfIAHJblKJACTNuj6C/CO7noogiD+y62o+QfqRgzuWl3sKyo/4qj7FEEyQfsSX9SmPNubyAI/lxaSC+iPk623tH+j5kf5wvFF/hDyV+T0H8UeoSSXijzT4I4g/Qk0qEX+EmlSi/Qh5KlM/EaQfcfqp7ntIP3Jwp+x5kH7E6SdfyktQfsRnCBWLcwnSj7AvXpC+3ha0H2knCQnaj7j9rGK0gfYjbj95Nawg/UizwI8g/AjXa6cJwo9wm06kH+E2nYg/wl06EX9E2nQi/4h06UT/kdZ/BP1HpE0n+o9Ic3Wi/sjxHctLeQXxR6S5YyL9iDR3TIQfEb9j5rd5hB+RehUDQfcRrRfLF2Qf0Q7YBd1HtAZ2QfYRbfpYZB/RGtgF2Ud8YlBRqiLIPqL1fANB9BGtp9IKko805CNIPqL1VFpB8pHDOpaXFAuaj1gt64LkI04+heEIko8c1ClKTAXFR6wu8hP0HrFm+IraI1YX+QlajxzNsbxeWZB65GBOMaNXUHrkWE6liILSo49nMu8sFaVHj+XYzl9kKEqPHsuxvHRUEXq0WcVZkXnUmWfn9ydF51Ff6Kc4LIrOowdz6sPCGO4JzXlNkXr0eI7tnNcUtUeP59jOvUxRe/SQTn7eKnKPjrqKWhF7dNTrUihqjx7Qsbw2VVF7dNTrUihyj/p6P8VgQ9F71BdyLtZeVfQeHXUfq6g9Ouo+VtF6dNR9rCL1qFNPvk+rIvXorPtYRejRZg1nRenRuboLDaVHZ1euoIg96lN/qgsNsUcndxcaeo/69J/qQkPv0andhYbko7OuIlIEH131WxJF8VEXn3xrXEXx0UZ8FMVHV111q+g96t5D6cO8ovfoakpPFMFHvRisWHFPkXx0dcurK6KP+so/dFxfBt6oUH101S+8FM1Hd9PBovioiw+lBqEoPtqs/KMoPnpUx/I9ehXJR3e3wqEi+ujukonqo7t7d6nIPuoTfqqrHtlHt3ajDmQfdfah1C0U2UepnlmgiD7qVWHVQUT10WYFIEX1UWo7WnQfbevCFOVHqe1o0X6U2o4W8Uep7WgRf5TajhbxR6npaNF+lJuOFuVH2a/O9O2LovwoN+lE91Eup8sqoo86+lA+g0dRfdRrw/KvxkQe2DHK56soso/WG7grmo8e1TGy4qsxi14bln81JvGYjn329tlXo/hovX27ovfoER37eDzPvxrTWG/frog9ekDHPl+K/bFgXlF7VOosovXo8RzjlVaQKWqPSp1FxB517Mn3ZFbEHm2wRxF71Cf55NsgK2qP+iSfKueoPap1za2i9ugRHeNc7RS9R5vFgBS9R4/olBcveo9qe0Gi+KhP86kuMjQfVe3OblQfPbJTnbHIPursU52F6D7qc304L49VlB/1QjDWIhxTap7SfCd5RfrRwzv2OZ06DcekHuCxfItbRf1RqylWUX+03sFL0X7UtDu3EH/U6i4W5cdcforz0FB+7Cm7WEP2MWef4pw1dB97yi7WkH3M2afoJAzZx56yjzU0H3PzKS4dQ/Oxp0yjIfiYg09+mRl6jz1lFg2xx0Z3SRpyj406i6g9dkTH8h2NDbnHmm27DLXHmm27DLXHfHJP0Xcbao+N+lo0tB4b0lxfhtpjPrenumbQe8zn9lTXAYqPzW7QY0g+5rVe1fmK6GNe7FWcg6g+5upTnVeoPub1XkVXb6g+5uqTL4dkiD7m6JMvumNoPubmU9xGDM3H3HzyZXcMyce84itf78bQfMwrvvIdgg3Rxxx98tVgDNHHvOKruP0Zso8d2qluf4bwYw4/+WowhvBjzQ5ehu5jR3YsX4bFkH1sSXdNIPvY6oY/huxjh3YsX3fE0H3s2I4VL5YN5cd2TeuG8GN7dh0R0o8F/RQdEdqP7ebBxJB+bFPXbaH92O6eTQztx9x+8gVFDOnHmmIvQ/ixYzufrwXkR/vDfQXhx3zf9nx1a0P5MarvnMg+dminWtbCEH6sme5jyD5GHRUYso85+1QnCrKPOftUqUf2MWqvTmQfo/bqRPYxah5ODN3HuB0JofyYy0++Uo2h/NjRHctXqjGkH/MpP/lG24b4Y44/mt8l0H7sAI/lW1Ab6o9xPbnA0H7Mp/xU/Rvyjzn/VMlH/jGv96qSjwJkUq+6Zug/JqO7KJCAzAmouiiQgMyn/BTnISKQOQJVlxAqkPmcn+q0RQgyh6B8129DBzKpN0swhCDzHdzzQTk6kHm1V743tyEE2bGeqmNGCDKHoHwnb0MHMu1KMQ0lyJp5P4YOZNp2tihBpm1nixJk2na2KEHmElRdQChBpu3liRJknQQZSpC1EmQoQeYSlO+2bghBZmUdgqECmfmK+5L+2ohA5ghk+YskQwQyR6B8I3dDBLIDPZbvtm6oQOZzgPINzg0dyNyB8s3CDRnIzC/O/B4BELQeh6B0uaZovKLPG7AnXa8pWq/w6eHZxRytV7ivOJsuYBKtV/j28GwwGa1XeLzTzBIarVc4e3iW0Wi9wsvONtqu4DOuXen7tWi9wq2+mKP1a3ioUNpVROsVPuobf7Re4eVrsGi7glfdhUbrFb7rLjRar3Aqe61ovKKbDjdar3CpO7lovcJjnl52SUfrFW4eLsVRx5z6otAfp0Z+ykxM6owLNa2bjOYr3q/UkVZxRvMV75dqumpHtF7h5QSvaLuCmxUNovUK5/ZQTkzsQaDmUGJmp/aHElM7rT+UmFpfJ/rj2snuS9F8xXtq0616o/UKL+cHRdsVHGlNF5+I5it+t8d+YWpjktBINySM5ived5UqDuXC1C7pfx1M7dL2VFiY2tj2vToVFqZ2P+2psDG1e7Snwsbc7mqsFE1X7Oquqo2Z9QlD5ZmwMbO7etcSTVdsf8VuTOuuXrZE0xWr7Rm2MaW7et0STV9jKdKZ9/GE2awXkY62Kzg64CI/hOmkuFKLeyVhPinyadnU+mi+4sstp6LtCi73Koq2K7gsRom2K9jTmS7nEa1XeDlBIdq+BnNZjRJtV7Bfmun2w9F6hTejJMZccrn7W7RdwZ7IdBGNaL3CvcdNV0SI1ivcL820mD5ar3DvcNO9a6P1Co9s5hcQYza9TuxJC96j9Wt4FIqlpdLReoVHRvNHH8GMil+gaSVxtF7h5TZi0XYFe07TyuBovcJPHedKF3+J1ivcc5pW5UbrFe45TQtno/UK95ympbDReoV7TtO60mj9Gq6e03RT02i9wpsuVzGj9RyiaLuCzzWabwUcrVe4r/yUFi1G6xV+MjrSlbOj9Qov33JH2xVcLuIVbVdwuYhXtF3Bkcv8+lTMpZVzbaPtCj7vz1I0jMYr+nS3MvKbm2EyfamgKjuGyawLx6LtCi4Lx6LtCo5LM++yDFNpcWnmXZZhMqN2LK3Ui9Yr3NohCNLReJ5uCDIQj0bgUTEEGahH4ymnw0fbFezjobSsLlqv8PqBdKAcjZCjdJfMaL3Cuf87GePLkqNou4LLkqNou4LLkqNo+xo8PJ3pZpbReoV7NtPyvmi9wv32mW4NGa1XeKQz7fcHwtHwArIn3RsyWq/wSGh62Q2UozE8oWk1W7Re4X6VpsVb0XqF+1Wa1vtE6xXuV2lalhOtX8MDjtISlGi9wusb6EA0GoFGaQ1KtF7hntO0NCNar3DPaTo9P1qv8HIaSrRdwdzcLwaS0ZjNFYpeNGZzhSIWjcAiyk9ctKIRVkT5iYtUNFa5H1W0XcGRzfwsRyoa9TLS0XYFlwshRNsV7Fdnuu1ktF7h3N22BiLRCCSqbluIRCOQqOrOEYlGXU0WbV+Dd1mvEm1XsHe5nPcUqEOjXkAo2q7g+hl0IA6NFw4VhxxxaEQ5WXXIEYjG7u+gCESj3mMs2q7geog7kIfG9uuT894WhWiEEHH6jjGar/jIaK5sA5VohBJxrlsDlWhQN9AdiEQjkIjzLheNaFDT5aIRDWq7XFSiQdIfScxqQFF5JDGxZP2RxMw6FlVHErloHBAqLifEosGt/Q30osGt/Q0ko8Gt/Q00o1FvNx9tV3C59kW0XcGR1fx2h1406v3mo+0KLusEo+1rcFhRdcgRi0ZgUXXIUYtGaFF1yJGLhpQTU6LtCi4XpIm2KzjupvmQAbFoSDlnLNquYOmuaaSiIc3ICKFoSPs0OlCKhvZPo0hFQ/unUdSiobXoDtSiobX+DbSiodHr5gMvtKKhTa+LUjS0lvmBUjTq9YWi7QpubqMoRSOkSPIhHUrRaKRooBQNX2DoSau1ovUKL9eJirYreLUnIUrRsN2ehIhFw6g9CdGLRl1qFm1XcP2iZaAVjbCitOAnWq/w+kXLQCiaAUVpxUe0XuH1vXMiEs2nvXdOdKL5tPfOiVA0n/beOdGK5lPfOydK0Xzqe+dEJpo+w+hJK2Gi9Qo/Cf1cXPOP695E6xXerHwarV/Dfb+xkb+CmIhFM7AoLbSJ1iu8fnKZSEVz1LfOiVA0R/0gOpGJ5ijXy4y2K9ifWdLqoGi9wuv5YhOJaI72EXSiEc1RP4JOFKI5ywVNou0KrkVhog/N8KG0BCpar/BaFCbq0AwdknR562i+4r2nlfwVy0QhmseA8qXlovGK9tXe04Xko/UKP5Ot8/1po/UKPwu+5zvIRuvX8MNA+Urr0XhFn2UW83KVaL3CPadpBVe0XuFNTlGJZswmSiuyovUKp/Y3x4yGE1VnDDrRDCeqzhh0onkgqDpjUInmsu6MQSea++nOGJSieSyoPGNQiubRoOqMQSqaPpPoSXenjtYrfLe/C2Z1N3syROsVXi0AH01XrLQHERO6qwXgo+mKte4IYjapWv89mq7Y9vpEIZpUTgmbqEMz5hCl1XjReoXX78wm2tA8/pO/XJ9oQ5P6SxNxaFJ/aSIOTeouTaShSe2liTI0ub00UYYmt5cm2tDk7tJEGZqHfsqTBWFoBgyldXDReoX7PTQthIvWK9yzmlbCResV7klNS+Gi9Qr3MVFaCxetV7g/gaa1U9H6Nfy16HR+m0MemsFDadVStF7hfhNNS2Ki9Qr369Ty6xR5aMZsorRyJVqvcL+NpttiROsVXne46EPzCNCSdDOPaL3C6w4XeWge/6GPi47+sFx/NH6N1rrDRRiaOrrrGV1oat3hIgtNXV3PgjA0tdo3JZquWM/izh9r0YWm1llEFprqWaQ8iwhDU+ssogtNbUe26ELT6jQiC03z+2a6W0S0XuF1GlGFptVbGUXjFV1nET1oWjukRQ6aVmcRNWjG3KG0Qi1ar/Ca3idq0PRlp4vJcRM9aB3xKXZRjNYrPDrX9D6yUITWIZ/qIlsIQutZzeW+0IPW041mF3LQ8pWn81NloQetYz5V+heK0AoRSgsDo/UK9ztmWhkYrVe43zHz0sCFIrR8+tDISwMXitAa9USThR60Rj1Tc6EHrVEvCh+NV/R5l1LMpV1IQmt0TycLUWj54tPVyYUotHyzserkQhZao96iMxqvaOtOLmShdeiHV7pmTLRe4QeGVl65spCG1sEfXvnb3YU0tA7/8Mpf7i7EoeU4NPK604U2tGabVKShVe45Fk1XbPfIuRCGVrnnWDRdsd29c6EKrXLPsWi6YkdzYiEJrVXeOhd60FrdA8pCEVqrvHcu5KDl04ZGXj28kIPWql90LrSg5etP5x0QQtDqIGghBC2vKRt5FfNCCFo7utl0cL8QgtbuBrMLIWjt9t6JErT26k5BlKDl+44VpxVC0NrdWGghBC2fMzTyeu2FFrSO9nyE54MKtKDlZWXjyW+1yEFrR1LzWy160KpXoY62K/iklCgfPSEILWpTiia0qB0OoQktaodDqEKLuuEQstCidjiEKrQoUpoPWBCFFtUj3IUmtI76VNc0ktAKEiqOOZLQ4vYiRRJaPLtjjia0uHlaWUhC66BPecyRhFaQUCF3C01ohQkVcrcQhZavSL3SLQKj9Qqv758oQstXpC6/GnPqIjRGMSBCElpOQiOvkF9IQkvqV54LQWhJuY1DtF3Buzl1UYOWTxcaI7+LogYt34O+OtMRhJa0wyEEoeWLElVnOprQkgbhF5rQOvBTnunIQksjn/l9GlloHfv5CM/v0yhDy/ehHyO/e6EMLZ8yNPJK5IU4tDSSmt+9EIdWjUMLcWhpe4EiDi3V9ipCIFo+cWiM/EaKQLQsLtL8FoBGtKxa1i+artjT6+YbQUfrFe4JzQuXFyLRqpFoIRKtWJioeHZCJFo1Ei1EonUY6OMBKZ0FshCJ1oGgYru2aL3CPZl5DfVCJtpP+cSy0Yj2M5pffKMR7afZZy5ar/BIZtopbjSi3RSXbRSi/dQvyjYC0fbSspFXc28Eou1ANPJq7o1AtB2IRl7NvRGI9hPpTDuhjUC0A4jyau6NQLQdiEZezb2RiPbwVTfztxgbkWg7EhVvJjYq0fYlq4v71kYl2q0SbVSifRyoeJexEYl2i0QbkWgfB6ocfKMS7dHcQzci0Z5+D81fDWxEoj3d5POXFBuRaM9mJdVovcLjKk07/41ItAOJ8oL+jUi0fQLRyGv0NyLR9lWJRl50v9GJti9KNPKi+41OtH1NopEX3W+kou1VZiMvut9IRdurzEZedL9Ri7YvSDTyMvCNXLR9BtHIa543itH2GUQjr3neKEbb5xCNvOZ5IxrtQKO8bHgjGm1Ho5FXAm9ko+1TiEZeUrsRjrZXmo28pHajHO2Qo7ykdqMc7ZCjvKR2oxztXQP9Rjfauwb6jWq0ff7Q2JL3GshGe0dKNX29tBGO9o6c5s+YG+Vohxzl9bob5WiHHH3OrE1/Hcxq0BEVtya0ox12RMW9CfFoOx59bl2fxqMfba85G5+AlP3+CEjba84GFXcQFKTts4oGFelFQto+rWhQTggbDWl71dmgIr2oSNsnF30uIpbHY36DkTh/pNnoSNsdaXCRX6Sk7ZVng/NOAS1pc22DGyVp+ypFI93PKVqvcE9tukdTtF7hqz0z0ZI27/ZMQEzaTO2ZgJi0OTKbbg4SzVd8rfgbKWmztr0UctJma3sp9KQdnlT1UuhJOzyp6nYQlLbMtttBU9qy2m4EWWnLbrsRhKUdsFR1IyhLW7i9zJGWtkh7maMtbdH2Mkdc2mLtZY68tL0ebeSljht5aTcrF23Epe173RcPDGhLO2wprwDcaEvbbakoHNloS/voUTX3Y6MtbXUwzOtoN/LS1shqPvpDXtrBS/lOJ9F8xVt7EqMv7XoC0kZc2tZfsAhMu56BtFGXduhSXvO2UZf2IaTqfEFf2lYu5bgRl7YvYDTysrGNvrStrnrZqEvbdak6VVCXduhSXmW2UZfIi9JGXk5FCEz0jK57JBQmemZ3LyMkJnraeyuhMdHT3lsJmYkaZiJkJgpmKu59hM5E4UzFvY8Qmiigqbj3EUoThTQVlxIhNVFQU3HvI7QmGu2QmBCbaLRDYkJtorG6exkhN5EvZ1Tdywi9iXw9o+peRghONLi7lxGSE3mx2sjL9wjJiUb9ZpUQnGjEZZs+lhKKE824bNPNhqP5iv/MnVC6U1a0XuFlJ0zoTXRESYrFiQm9iY4oCeczzQi9iWY7XiIEJwpwqjoEFCcKcUp3HIvWK1zbUxLJiWb7FEtoThTmVPWXiE4U6FSM/QnViVYtFITmRKsVCkJ0otUKBaE60WqFgpCdKNip6v/QnSjcqer/EJ4o4Km6uaE80WqHTYT0REFPVf+H9kR7tP0Z8hPt2fZnKFAUApXucBetV3j9PodQn2g3N1qkJwp60uKqQnsit6fPZTH/uO17tF7hnte8oJJQnijkKS/sI4QnonKTpmi7guuifkJyIqpXfiT0JgpvyqvYCLmJmio2QmuipoqNEJqI+mQiNNGRpPlY+s6S0JkonCkv1iJkJqK6BpwQmYjrGnBCZCKua8AJiYmCmPKaMUJiIq7rhQl9iQ4gFdlBXKLAJS1uGIhL5Osa5TtLResVXq+dQmhLxPVCOISwREeO5pzFL4KpDFfKy+gIWYmkSSaaEoUp5TV3hKREx4zywRRyEnWzlAgxiRyTCqMgtCTyWUrVIURKoqAkLQaNSEkkzXgXHYmkuS4RkUib6xIJibRJJRISxfykvMCR0JBIm+sSBYm0uS7RjyjmJlW9JgISNWtfE/IRNWtfE+IRNSsaEcoRhRzlFZ+EcEQ+Mak6YdGO6OBQecIiHZHPTUo3M43GK9pvmHn1KSEekTU3TLQjsnr5G0I8IqsXpyKkI2pWMyKkI/LqtZFXzBLSETkdldmBZPLBoSo7jHTETkfF0jqMcsQhR3n5LiMc8VNfmYxqxE+9kjkjGfFTr2TOSEbcLGXE6EUcXpTXIjJyET91/8poRXwwKO98GKGIA4qKzocRinjUo1hGJeJmpzRGIuJRrxjH6EMcPpRXRDLyEI96xThGG2IvWcuPH8IQBwwVgypGGeKjP9UhwUyOekFHRhficKG8FpKRhdjL1fLXBIwqxDMuyXTcwwhDHBOR8spJRhhin4g088pJRhhih6GZF7cxuhDPbuzDyEI8626WEYXYUWjmJVeMJsSzXjSOEYTYVzEa+dMRowexe9B8VsprjB7EPgtpPruIx5w6Cc2HinhM6oqk5ns8MpIQr8hqvicWIwmxk9Asti5jJCF2Epp5cQyjCPFqulzkIPYVr/O9OhgxiI/2VPtNMloQ7z6xaEHsFjRHfjUhBfFe7XmAFsR7t+cBchBvas8DFCHe3J4HKEK8pT0PkITYSWjmZSmMJMS7uWQRhNhnIpXHEk2IabTHElmIabbHEmWIabWnDtIQ026PPeoQE7XHHoGIHYhmXlvD6ENM9ctSRh1iirymI15GHWKfhDTz8hRGH+LGhxh9iH0S0iy24GMkIm72SmMEIuZmnIRAxD4BaeZlMoxExMeAiscoRiBijmzmIw4EIvbljWZeycJIRNwsfc1IRMyRzbxzRyJiJ6KZ16YwEhFLM+hFImKZbfLRiLhZ+JoRibhZ+JrRiNiNaObVJoxGxM3C14xCxL6wUbH8KSMQsQNRwfaMRMQ+1Wjm5SaMSMQa6cwvfWQibmYaMTIRBxMVr1sZnYh9haPiEkIoYp9qNPP6FEYq4mbla0YnYl/5uho/ohSxTzSaee0LoxWxNg8yaEWszYMMShFbZDPvs1CK2GcZzbyqhlGK2Oo3K4xQxA5FMy/BYYQibqCIEYq4gSJGKOIGihihiBsoYoQidiiaec0IIxRxs+w1IxPJa4ZR/pQp6ETiTjTzghRBJ5JwouKlsyAUiUPR/FzqJv11Fsb7xVks6SLIReK7pM1iTRdBMZKnHekKopE4Gs285kUQjeTAkFr+/kaQjeTQ0HqqPxZz63A084oaQTeSEalNL2pBORKfXzTzihpBO5LRZxb5SEZZbCpoRzKoPQuQj2SU1aaCeiRD2jMG9UhGWd0viEfi04rKswv9SGY5s1MQj2RGNtN+UVCPZNal/YJ2JEeHdv4EJUhHMuvlzAXhSGbd5QqykczacwXRSGYkMu1FBdlIgo32xyhBf+Q//pWYy2NDRW4wjz6PaO6Rfze6kayyBFzQjCTM6HMcl3435nKV7z8FvUgOCBmvtKpTkItklXN0BalIgor2Kn5tzObBoOK7MZUrUrk/8WcKYzymctWpRCiSHanM+1iEImkK1gSVSEKJqt8bmUiCiapTFplIgomq0xCZSIKJqlMLmUiOA5WnCyqRhBJVpwAqkYQS5bWCgkokjRIJKpEcBspfMAgSkQQRVccdiUiOARXTCASBSAKIqrMAgUgCiKosIRDJEaAyS+hDQv2FikAkJO1JhkYkYUT5LqmCRiTUZBWFSI4CVQceiUiCiD7GrumdH4lIuL9cUYmEI7H5DQmdSLh+chFUIuF6TpggEslhoAq7BZFIfBZRLumCRiS+2lE+CVMQicTnERXTzQSRSAKJqkOOSiTSX6kIRSL9zRShSGS1JztakchuLybkIpH2WkUuEueimRcNC4KR+JSimW/yKwhG4mA0801+BcFIAozyTX4FwUgOCdnnbNnx48ADg14k7kUz3+VXUIzExWjmu/wKgpH4xKKZ7/IrKEYSYpTvlysoRuJiNPP9cgXNSDSSmncbaEYSZpRvVCtoRuLFaTPfvlVQjcRnGM1861FBN5Jwo7ysWNCNJNworxQWdCMxz2peKSwoRxJylG8kKihH4nI081pJQTsS3zVt5gWNgnokXqM28xpCQT8Sr1Gb+V51goIkzULZgn4k7kczr9sTFCR1QZp5dZ0iIOnTdsGKgqQuSDOvmFMEJH2ahZUV+UiDj4r7hyIf6dOOgBX5SJ9uBKyoR/q0I2BFPtJHu9uNoh/pE5lNrydFP9JRV/Ur6pEeH8pHHIp2pKMZASvSkQYd5ZVdinKkLkf5iEPRjjTsqDoF0I50cHv+oh9p+FF1yqAf6ehzioakB4nKUwwJSefTnmLISBqMlFe+KTKSzrha005SEZJ0RmbTTlJRkjQmIeUlMYqWpDEJKd8GTFGTdNYv1xQ1SY8XVWcwYpLOViAUMUl9ElJ5kiEo6QuUipMMQUmPGpUnDZqSvkypOCfRlDTmIVUnGbqSxjykvARI0ZU0piHlJUCKtKRBS5oLriItacxC0nwhd0Ve0uAlzd8mK/KSemHaLOYjKhKTBjGp5PFoTBqTkTR/blVkJj2OtEbOuYrKpKFMReGBojLpYSSb+WtoRWTSQCbLX0gpIpPGXCTL3ysoKpOGMln+rkBRmTSUqVjJUpGZ1Jlp5jOjFaFJm1W1FaFJfZu1otNBZlJqPUIRmpRaPlSEJu2hSRGatIUmRWjSHpoUoUl7aFKEJg1oyud3K0KTNtCkCE3KMWW7uEaQmvRFTcXfitSk3I2fEJqUW0FUlCaNGUnViYDYpNyPitGblNtRMXqTcp9YFCflSGw+ZEFyUm4Si+Ck0t9oEZxU2hstepO+vKk4D9CbtPcmRW/SroBNUZtU+qExcpNKPzRGb9Lwpnw6vKI3aVPBpqhNKnWFhaI16eGkSh0VsUkDm/KZ9orYpIFN+Ux7RWxSx6aVz7RXxCbV/mJFbVLtL1bkJg1uqk4x9CbVbmCM3KTaD4zRm1Tbpx30JrX+aQfBSQ8pfRzKxBwVuUmtv7+iN6mVb1oVsUkdm1ZeP6GITerYtPIaB0VsUusvVNQmtfJlqyI1qfXPr6hNauXLVkVqsqftfQ2tyZ7yvbmhM9mRpOrMMnQme8pkGiqTPa3yGyqTPeV7c0NhspigVJyEhsRkT5lKQ14y56WV7/pjqEv21DdSQ1uy40czHx8Z4pLF1KTqr0RfspibVJzghsJkIUzViYXEZKN9c26ITDa6oa+hMdloh76GxmRuTCvfb8mQmGxEXtORr6Ew2TGkz1crW3+U8YdcYWZdmNbDea5QmMyFaT2SrvxmSExWr35k6Es267pTQ12y40fl34m6ZDP6XP2B+MeHJ8ZjUp2X1scoI4/HpPp8pY9fh57ssGBSjyHJrn4bTKoL08orkAyByY4glccGfcnWaM8BBCZzYCrPAQQmqyctGeKSrfq9uSEt2cGj+u/EnC5uzwGkJVvSngNIS+a0VJ0DKEt26Kg8BxCWzGFp5WVWhq5kB46kYChDVjKfvbTyQiJDVjLfpq068qhKtnd7hiEr2ab2DENWsl1OETUkJdt1DZShJ9kBo/rvxJQ6J5VnGHqS0dOeYUhK5nOXqjMMTckOGpVnGJKSOSmtvODLUJSM2h4YQcmI2nMARcmI23MARcmoHiuhJlmzUZuhJRlF55uTqyEnGbe9L2qS8WjPGdQk49meM+hJ5p5UnTPISXa8qDxnUJPMNWnlu0wZYpJ5hdvKy+cMMckck1ZeEGdoScbaH0rMLFt/KDGz7knVoUROMp+/tPL6PENOMulvq8hJJs1wCS3JpL1YEZNM+uESYpJJP1xCTDJph0uISSbtcAk5ySSu2NRwDEHJtL1gEZRM++ESipJpn1ckJdN6uISeZNoMlxCTzDFp5UWahpZkbkkrr3Y0pCTzqUsrLzE0tCRzS1p5iaEhJZm2jzVISWb9Yw1Skln/WIOaZPXK2oaSZNZcp0hJZu11ipRk1l+naElm/XWKlmTWXqfISWbtdYqaZD53aeXFmgagtJ+nuU6j9QrvrtNovuK76zSar/jqOo2mK7a8TqPtCo7rNH1FHc1XPLfHhTFcmnMmmq94bc6ZaL7irT5novVr+OGj4pyJ1ivcs5oWs0brFT67YzMwp2O158zAvI7dnjMDUzsqLIymK7ac4RJtV7A0g9RovuKbB5tovcK7B5to/ho/uwebaL7imwebaL3CmwebaL3CPatpRXO0XuFNHxytV3j3YBPNV3z3YBPNV3z1YBNNV2z5YBNtV3BzT43Wr+Hrac+BhTl9sVJxDixMqrNSdQ4sTOqho/IcWJhUh6WVVp5H6xXe0FK0XuHcngMLc/qipeIcWJjXVdWpRtMVW8p+tH0N3u09dWNOd/ewGs1XfPewGs1XfPOwGq1XePOwGq1XeNxYs+eCaL3Cz33149E2WcMxWq9wz2labB+tV7jfVtPdH6P1Cj9v3vL116P1a3jIUrpZZLRe4d34N5qv+LIAOdquYO9+050oo/UKb7tfwqRSNwSO5iu+GwJH8xXfDIGj9QpvhsDReoX7jTVdgiBav4Z3thStV3g/BGZMK/dDYMbMcj0EZkxrXREXbVdw2/0y5pQ72Y/mK76T/Wi+4hvZj9YrvJH9aP0aLnGtZoYWrVf46I6NYE5frFScA4I5ldWeA4J5lWrph2i6YsvldqLtCm4fawRzKv1jjWBOpX+sEUyqtI81gknV9rFGMamBSulyHtF6hXtS0+U8ovUK73OqmNOalaLtCg4CLh49FPOqbV4V86p9XhXzqn1eFfOqbV4V82ptXg3zGrCULuwRrVd4+7hqmFfrH1cN82r946phast926Lpim0eVw2TajFWykdihjn1aUor3YI5Wq9wv6mmWzBH65fw4ROVVroFc7Re4Z7SdAvmaL3C/VJNt2CO1iv8PNaMdGnvaL3CzxzRjxMg2f88Wq/ws2DLStdei9Yr3O+r6XoZ0XqFe1bTNR6i9QrvDGKgK43HupN9ICyN8XQn+0BZGqOafxZNV2w9/h2ISmM0L8uj9QrfXYc30JTGoK7DG+hKw12p6PAGytI4dFR1eANhacR0pXRFiGi9wjuDGOhKo52uFM1XfPtcMxCWRjldKZqu2NL1o+0K7h5qBprSaKcrRfMV3z7UDDSl0U1XitYrvHuoGQhLI6Yr7fSmNxCWxiqraqLtCj6j3yerF43GK/rcT2feOyIpjVWuHBptV3C5UFa0XcHneWYVvzVmc5UrZUXbFRydbnorHShJwycprXSViWi9wj2V6SoT0fo1fDepREwaR4uKw42SNA4VFYcbGWnscknfaLuCvb9NV8aI1iu8foYZSEhjl1sfRNsVLM3Jin40drleaLRdwdYcEEwilUszR9sV7D1sulBItF7hzY0T4WhQvTxANF7Rkcd8oIVuNGKp7XzBoGi+4stdgqLtCi53CYq2KzguyXyUhWQ0gozS9U2i9Wv4QaEi9QhGI8AoXQwlWq/wJpuIRYO7bCIXjUNCn+9Aafw49A+/OGbzkBCL5T0sgtEIMEpXcYnWK9z72HQVl2i9wj2h6Sou0XqFl/t3RdvXYGnSiVQ06nW2o+0K9geVdDGZaL3C/dkzXUwmWq9wvzrTxWSi9Qr3AVC6mEy0XuH1w+dAKRohRcX79YFSNA4FVScuOtGod2OLtq/B9W5s0XYF+8WZrpgTrVd4uTBztF3Bkc28U0EgGg0QDQSicQSouq8hD416N7Zou4KbfhZlaNS7sUXbFey9bLqAULR+Dbdm4IMoNMy3Ckr3oo3WK7yuH47GKzoymXdtSELDyv27ou0KLvfvirYr2PvYdJGkaL3Cy0W2o+0K9h42XVEpWq/w+pXoQA6asRdberpO1KD51F3sRAuaT7kvRbRdwfUgdqIDTZ9gtNJloKL1Cq8HsRMVaLoCabrvdrRe4fU1OdGA5lOPYicK0HzqUexE/pnBP+lKV9F6hZdrvUbbFXweK4s3wxMBaB7iKY4I8s8c9QU50X7mwZ3iiCD8TIeflS7OFa1XeFkoEW1XsDYXDarPjOlE6dJW0fo1PNQnXVIqWq/w+rlyovjMWT9XTiSfeVineIyfaD7TzSenionkM2eTSvSeGd6TLvQUrVd4k0rEnjmjb03vfBOxZ856vDOReuaqxzsTqWcezSmOCErPjKK0dHGqaL3Ca7ybSD3zcE7+FD+ReuZqRjsTqWeuerQzkXrmanpWhJ656tHOROaZwTzpWl3R+jW8YZ6JzDNjzlC+I2Y0X/GeSc2HRxOxZ/qcoaX51JiJ3jPDe6r7GYLPPKiTr6AbjVc0938t5nSXs/smks+MKUPlkcGs7qpaP5q+xsaEoeooovtMKt+WTESfSbM94ug+k8ppJRPVZ4b6pHvYR+sV3gx8kHymTxXyrYdMMRozeVyn6CXQfGaYT3WaIPrMQJ8yPZhOftpTBeFnBvxUKUL5mTFTSPNbMtrP5Ka7RfqZPlOoOOwoP9Mr0Ir9pKL5iq9JdiL8zICfKk0oPzPkp0oT0s+MCrQyTZjWmCpUpQkBaEYJmubjBCSgKbXnTQSgGQCkxYFHAZohQKr5rREJaAYBaX5PQgKaUYKWbj8frVe4ZzbdbT1ar3BP7OdCdOkfi4mNEjRLN4qM5q/xDkFcHBukoBkUZLuIx8TGfCGj/LxBDprBQemqXNF6hfepRRGaWs4rmehBM8rQyj8VE6v1DRVFaMZcoXRNq2i9wmtGmChC09qMognNmChUHUJEoWmzPSzIQjNYqDoD0IVmTBVKl82K1iu8ua+iDE1rumB0oRlThSxdfSaar3jfGTFdkStar3Dz8LwfQBxaPldo57t6RfMVPzw+feZeCETrKecfLPSh5buv7WenGV1IRMuJaD/5GbDQiJYb0X7SPmChEi1Xov2k19JCJVpHgvhz4dCkf1zoROtYEI/8vrdQitYTWU3P3oVWtEZkNb3VLLSi1VjRQitavnp28SJroRUtr0Db6VIv0XqFe1LTVUGi9Qqn7ja2kIyWk9FOlwWJ1itcurveQjVaMVmoGEIsdKMVblR0kgvhaM2uD14IR2u2d9WFdrRme1ddyEdrRm7zzgD9aM36JctCPlqz3EMm2q5gbo8LptX5aKdbO0frFa5tx4SCtKa1HRMi0vL5QjtdcyJar3DvgtM1J6L1Cq/HwAsZaa3IaN7pISStKEKrLj+0pLWovZ5Qk1aUoVXXE4LSirlD1fWEprSOG5XnDarSClWqridkpRVLHFXXE8rS2pHZvJdHWFovWCp+fYSltUuGWIhKK1Cp+lMRldYuR8ALSWnt6ITzuxOK0vI6tD3TNbmj+Yr3yzVd5yFar/DjvVuKHGFO3ZV2uixEtF7hntJ0WYhovcKbixVZaR07KrpIdKXlrrTTtQmi9Qr3wVK62XO0XuGe0ryKfSEtLWrHwAt1aZG2pwDq0iJrR7WoS4sjqXm3h7i0OJKaX6doS8ttaedlmgttabkt7bzucqEuLS7rlRba0orVjaoeA21pcfusupCXlvNSeadEXlqs7Z0SeWkdPyoH2ahLy+cWVYNsxKXluLTzCtaFuLQcl3ZekrqQl5b0jzfIS6uuQ1tIS0uoPY5oS0uq9eWi6Yr1nObVrgthadXrZEfbFVyukx1tX4NbUlpISuuY0eeMivSQoCgt7W+mKErrJUrFpYGktJyUdl4Yu1CUlheh7byGciEqLa3niy0UpaU17C8kpRWkVB4XTKn2YyRkpeUTjT4u3ryrRlda1jyrIiotm/2XY1Itut78PoCmtKy+RBGU1kGjz11jkkV4o/UKP6Skp75i7z/84pjSo0afm8Dk345JPWpE64dtP075w6+OKfVFsj/PgOTF/0JS2seMPl+3f/wuY8Bkko2itH2ZbBvpt28Upe2i9PEEkdWTbUSl7YsafY7A0/CF4Sejxj/w/pHwNfNGUtq+VrZJ8e2E4afbtfxAbiSl/UTPmw4zNpLS9nWNdl6DuJGUdr1gdrR9DfYFs4uzdyMobd+OrTh7N5LS9ulHxdm7kZS2Tz/Kz96NorR9Q7bi7N0oSvuQUXn2Iijtwd3Zi6C0jxiVZy960j5gVJ69yEn7eFF59qIm7eNF5dmLmrTn6M5exKTtmLTzGteNlrSb6rONkrR9JlJ1OqIl7eNFqpwOBTZq0p5d37tRk/bs+t6NmrQPF31uOpfNtduISftoUXWyIyXtg0Wq+cPsRkraB4vKawMpaR8uUrXi2zGlh4vKSwkxaS/ve/MB20ZL2ou6Kw8paS+/UPMX2Rslaa/2QkVI2r6ekeVj+42QtJd11zU60t5Pd10jI+09uusaGWnv2V3XqEjbpyftvBh9IyRth6SdF6NvdKTt1Wg7L0bfSEk7KCkvRt9ISTsoKa//3ihJOyQpr//eKEnbV8veeanwRknaIUl5VelGSdr1BKWNjLQp+t58KICQtOv5SRsdaftqRlX3hY60jxR97pmZDcA3OtIOR8qrOTc60vYpSlVPjYy0qVx1bCMhbbLunoGCtI8R5V+NfLQPEJWHEPloc/kOdaMdbV/AqOr/0Y52bUcb7WgzdZ0/0tHmkhg2stE+LlTeKFCNNtdpRDHabN1NBcVoS51G5KIto7ujIBdtqdOIVrRldXcfpKJdU9FGKtpC3Z0KpWjXUrRRirZId1dDKdpSpxGhaIt1tzSkoq11GtGJtk892nlF+EYn2loL/UYk2o5EOy/F3mhEO4yI0t0+o/mK70xhIxLtA0Fll4ZMtLXtXBGK9pGgchiMTrR9AeyqE0Qm2j77qBgGIxJtG103iEy0ffXrahiMSrR9K7WqJ0Ql2oeCyt4NoWj7GkVVj4VQtK19AEUo2r6ZWtVpIRRt064jQinaLkVV54JSRM/TdBiEUkQhRfkwmFCKKKQo7zMIpYhCivKTgFCKKGYf5dX5hFJETYEaoRNRTD3KC+gJnYjCifICekInonCivCae0InoqethCJ2IRl0PQ6hENOp6GEIjIl+haOcV7oRGRKPmBEIiotFM0CYUIhp10SihD1FMOCJLX1kRAhEdAiqONvIQjbokhhCHyOca7byInxCHaNYlMYQ0RHO0fyXaEM26bpRQhmjW1YaEMkTHfopDgi5EvirRzlcIIHQhmvVLFkIVIp9jVJxTiEJ02Kf6GzGTMb+oPNqYysM+xdFGEqKmSI0QhMjnFu18zQRCEKKmSI2Qg+iAj6yd98fIQXTA52PU/QM/P04eGI65bOrUCDGImjo1Qgqipk6NEILI90wr/0jMpE8o2vmiE4QQRDGfiHc6niSUINqzj8d8BgVxvvAEoQVRWFC+KAOhBVFYUPn1mNPAoHyJA0IMosCgfGEBQgyiwz1lqhCDyKcVVecjYhBR090iBRHVBcGEFkRUFwQTShBRXaNPSEEUU4ryBREIKYhiSlG+xgEhBVFQUL4CACEFkU8p2nl5PCEFUcwoymvHCTWIYkJRXuBNqEEU84nyAm9CEKKYT5RXPxOCEMV8orygmdCEKOYT5ZXEhCZEXq2289JZQhYin1L08Vidh2NWfUbRx2N1Ho5ZjQlFmmcVZYhiPpHmWUUcIi7rSQlliMTfgOa3XLQhiqlEeRUnoQ1RTCXKqw8JeYhiKlFeBUfIQ+SFah9P7Hk4ZjQmE2l+vqAQUS1EhEJEMZcoL4EjFCLyuURTcw8hVCKSOp9IRHQcaHzyRvrdyESkJb8TGhG5EX1aSP7dmM9yh7RoumK3f3c+pYXQiKguTSMEIvJZRDPfZDWar/iyNI2Qh0gjl/nydIQ+RFrnEnGIjv9UC3YT6hBZnUqkIbJIZf4Cg9CGyOpUIgzRoR+bo/i1MZP14tWEKkS+VtG0fMIsIQuR1ZlEEyIvSJs2iu/GTFqdSRQh9nK0afnEXUYS4qdMJaMHsS9cPS3vTRhBiOv90Bg1iEOD8mJdRg3iKEXLi3UZPYjDgyy9CzJ6EIcHWXoXZPQgfkqHZ8Qgjjo0S+9rjBzEUYdm6X2NEYTY69B2XqXLSEIcJJRXuzKSEEclWl4ByohCHJVolt6rGFWIvRKN8jJNRhfiWLQ6L9NkZCH2QjR68jMAYYi9Do3yKk1GGmKnIXryrCINsdMQPXlWEYc49kLL6y4ZbYh93hDldZeMOsQ+b4jyykhGH2KvQaO8MpJRiNiFiPLqRUYhYhciyqsXGY2IDwNVs1MZkYi9Do3y4kVGJuIXExX9HTIRexka5dV8jFDEXoZGeREdIxXxwaDPFbKyacGMVMRORZTXxDFiEXshGuU1cYxYxCvSmp9jiEV8QIgKb2PkIvYqNMrLuBjBiFekNT8lkYzYi9Ao3fU2Wr+GOxlRXg3FSEbsZER5eROjGLGLEeXlTYxgxLEdWl6ExOhF7F5EeRESoxexexHlRUiMXMTORZQX/TByETsXUV70w8hF7HOHKC/6YeQi9rlDlBf9MHIROxdRXqrCCEZczx1i9CI+JiSc19gwihEfFRLOB7GMZsRuRpQXzTCaEbsZUV58wmhG7GZEeZEFoxlxbIWWF1kwmhG7GVG+pxGjGTFFSvPzC82IOVKan19oRuxmRPlsb0YzYo7NKPPzC82IOfYtzM8vNCN2M6J8kh+jGbGbEeWT/BjNiDk2+MizimbEHHtB5FlFM+LXXmh5VtGMmGN7pTyryEbsCxxRPsmP0Y3Y3YjyiXuMbsTuRpRPl2N0I5b6/QujGvFxoc+3xOnoAdWIXY0on0bDqEbsqxtRPjOGEY7Y4YjyVfkZ4YibIjRGNeLYCC1/k88IR+xwRPnLeUY3Yp9eRPnLeUY6Yo2M5qcXyhH7BCPK34oz4hE7HlG+7jujHfEBIqbcPhj5iJ2PKH/DzKhH7HpUTOdgBCR2QKL8ZS2jH3GzthEjILEDUr4iNaMfsZegUf7Wk5GQ2AmJ8pd2jILEXoNG+UrxjIjEvq4R5YuoMyIS+7pGlL+CY3QktkhpfjoiI7GvbUT5KzVGSWKLlOanI0IS+9JGlL9AYrQkcUui/AWSICWJr2xE+QskQU0S1yTKXyAJYpL44kaUv0AS9CRxT6L8BZKgJ4l7EuUvkAQ9SdyTKH+BJOhJ8pQ4KIhJ4pOLKH/ZJOhJ8pQ2KIhJMiKf6dkiiEnimET5iylBTBLHJMpfTAlikjgmUf5iShCTxDGJ8hdTgpgkgUn56yNBTJLApPz1kSAmSWBS/vpIEJMkMCl/fSSISRKYlL8+EsQkCUzKXwkJYpIEJuXQKohJEpiUQ6sgJklgUg6tgpgkgUk5tApikgQm5XgqiEkSmJTjqSAmSWyBluOpICaJl6Hl7zMFLUnckiinVkFKkqCknFoFKUl8DzTKVxESpCRZkdT8lEFKEqckzmVWkJLEKYlzmRWkJHFK4lxmBSlJfEUjzmVWkJLEKYlzmRWkJHFK4lxmBSlJnJI4l1lBShKnJM5lVpCSxCmJc5kVpCRxSuJcZgUpSZySOJdZQUoSpyTOZVaQksQpiXNqFaQkcUrinE4FKUmckjinU0FKEqckzi1UkJLEKYlzCxWkJHFK4txCBSlJfEEjznFTUJPEK9E4x01BTRLyrOa4KahJ4prEOW4KapK4JnGOm4KaJK5JnOOmoCaJaxLnuCmoSeKaxDluCmqSuCZxjpuCmiSuSZzjpoQm/bcf/vTzP/7fb7/+/u2v/88//vrt//vTf/mv//VPf/7z7//5z29/+uF//+nPP/t/1B/Ot/7pv/zvP+nH//k/P/zpY7Dl/7vif9n/93Ml3fhArw/y+mDx4eOJJz7s14fXj1t8/+e6o/Fhvj7s14cI/lwdyD+8vvnzXdL5IK9vltc36+un9P1fXv+WvZpszNeH9395xczn9eEVw6+Y169h8oqRV4y8YuQVo68YfcXofn14Besr2F7BryNmr7/LXn/FeMY7JfS8P833p/3+9P4Jev3E5zbA8Ynf/+31y4/PrZX80+eWGq9P9vq0Xj/7ueHB69P7Jza9P71/dr9/lt4/Qe+foNdPfK7QFp/erZ+LjPinzwVBXp/W+xO9P8n70/sn3n/lZ/3j69P7J/Td+v436P1v0PvfoPe/Qe9/g18nzODXeT/kdVqNd9Lns16n/rPn+9N+f+L3p/dPvHI537mc71zOR17X1OdWffFJxvvTen96ffN4nW7zczcu//S550182u//Zq//tt5x+3Xlzc+3qa9Pr2+W5/un128vr+5hyusIzc9nnPg03/9tfv9v72+Z729Zr29Rfvcq/O5W3n+58uvo6vsY6PsYqHzviL73RN8/vTulV84/Pq33J3p/kven90+M90/Q+5N9766+f6L3J3l/im9Z85X9NV/ZX/OV/TVf2V9T3nHyjtN3nL7jXv3Jmvr+CX3/hL1/4v2bvrvh9e6H15rfP71+dr3ysT6XDX19ev3s9954vf/d9zm01vvfWO9/Y7/7+G3fP833p9dRo9f5suiV1fU+m5a8+uolr55wyau3XvLqr5a8+qv1OeJ/faL3J3l/ev2Evvq/9T5f1vt8We/zZb3Pl/U+X9b7fFnvG8ay979r75wbveP03fo6Bh8HaL0+DXp9evXFH92fvj7xO07269Pr+O13L3+2/PZP7155v3vl/e6V97tX3u/b+H7fx/f7lnxWDX19esV9rjkYn+T7J359ep0HZ82C16f1/vT6iz5r5l+f5vvT+2df995T7x2f5P0T8v6J92+w37/BlvdPvK6eM9k3Pr3jPieMxqfXHeJMxnx9ovcneX96/4S9f8LeP/HOB9n7J15n05ms9vq03p9evym/j5W8zqvDYx+fPj7GqO78f5+jvD///utP//jt33759e9fx3AHlN/DuOPI+Y//9N9/++Vv//H7t3/7+W/f/vnT7//j/pKPgfmXL1nV7/D6ks8v+Pkfv3/79ae//P7zL//49ZeP//b1Cz/nd7y/73Ppqur7/vKXb//8/RqTEn//ybnfPfr7SE62/tv++eu3f/v267d/fHz+6dffvv16/aE2v/yd9bE6X/Q5XP7t609/3Fq//zR7Z1T89G+//eV/fPvL/7z/9fnlT6PvN9X/m6/56dd/v38V+fKbdH/Gb7/9/ad/Xqn5crqM9S9+9Je/XmndX54YhndY5c/+cv3pH+PiL2m1/RoCGL9vna/ubPF+d/PeIeT/xi//8Y/f//zzX//8P7/959d/6XOrn/e/ZN25cr7gn7/+8vf7DPx8z/X9r4yrv/mG3779/vvP//j33/7867e/f/v7f//265//9su///yP63eir7/TaE4c/8bff/n1p3//9ue/fvvtL7/+/M/PK+z6Nv5yGtpszp/zbfjU97mJz/cfl+YM+Pzxn/96/ax9Oe/GM99PJq8738dN6ftzxms8vd5PMOs9nt7vTyTvcbePSLtf5g/J3l+Trf/qx//QUX3uOPTlD3r+RWp+/sfPv//8099+/l/3hf1pud+/Rfym+X/1LXhdfyLyl29a/+ov+tIHf/vtP/72+/1lX0+UT1vvv+zj2F4//rlJ6/eDu//FdXBO+jhz7yO8vqao6TQ+v8Uvx3/7+JN++fXO9PiSKO36rc+v+eMNie3LoYgHnvrnX9f0fRHz14v4X1x2yZHg9bX71PdFoT4U6r/rPqakX3+VtwW8+WaM99P5a9Q51ven3/cz+XtUPOT7M+r7ufBp/si/XXejL7/OezRH75FbPPvl34P3mPXlUtK6P/jbP7/9+veff/vt48z/SNZ92n75gvr+8bc/HNUxvvwZk+vz/eNHf/3p92///p/3T8v/X9m7LTeuI13C7/JfzwVx4OlZJiYqVJJsq0uW1DrYu76IefcBSGIhE8Si93/RXdy2kSRBIJGHlSvlaL7Oz89rfnY1i16s0b7hS1Sd51PyJts0i2dUH/dx3B2O94/d5XDWCmyQlo11I1+QwbqKMtS6VrYev/1/X6diwiNpdn50BxMZzulELb5cbZxUk+T4YOfr/o+6Q+zKlu9ge66ZtZ3o5cEyFfbRcat11MkzsuVPfa8to06eRy3/Ds/T1+mpRgY/VHzDfuNDzGOPn6fnU3/JsZFWWrdhWswiLtfn6e2038Xz5/14CUfRU5t9g9yMNrIxEoGH3S08S03vO/FIQ1JcQ9ItphvoQx6U6RIpifLuSl6ghWdouz5HvJL/5rEQfZu9VHi43DY8HLIFHRbI8X7XE9P3YtNY21J1MQnKJ6OaGum0DZ6e7lHE/L0+j88w08+dWuq2ExPj+pFukcNhf708d6fLbHKU6y8IGpUg/rGzIKHF1UKUy8bQXXA4LKvueAjmz/V132uHrW+lWluC4XVBHyu1NpXZCKfYbIw+nx7P+CR6PqTlE8ygHILYkFT9RE45TykYhWgY1zGHw+36OP1TEzrK/WBHt7GN/vvaFVvJy620sWDiyMJvbeXQjSUSvKnr1/FfaBj5Gt5vTEVaIvojeSsXLSKgPaK7fYuYZIpAuQERwcEghog46oARiGs7aCw3DDmamH42mn/x3NWl0bYq/NNvaKQg56GXlRfbwzfcVz4cnsfP2znsM/IMnXyGLY38vFYlDMqEoVbf4fC92+/O5+t3TcogrQnr/Iba+D7+Ph2+jnesrZp2NVK70nd6j/8l95WwzLfG0CiRE1qdm5FRxP68ezy4HPH8PZ2LKOc9uEs3LsfKHcvknN/1GCcnD6lZmy7oJz6/H3/fd3o+ZJ6ab5Tz+3++lfHnWnk+jvQLns/73WU2ipWqkto/pY5S3qZNTpc3DqF07lWez2+v89vpfD4e9M7xavfycNf5HFb8x1Ur09HLWOmAXNaArNvQbki8fs9xzvno+76fCmvQGrGWO8M/fZB0PFSfz6rnQ94PucXBIovn8fQtPVDmO8Xgc5Ra3MupeyFj6OlhW0i7H9+DICWyVyIHPHR+1M1JiVaBVnOtVHN0T56Dgxm00n7taskze8Oc+YwGoz7mpFvteh6CvCnnsmulLzM29I632/Gilrbce4b7pLfbedHAv/7z0O7wRBEkfDC+lIWQ86Emxyo59JsJOdf98xgDseETfBbCnBK2MSMQ9rjt7v89/3rdwolVOMC9cjPbfzNP//z6/v7+FfNAv1738/GyDy7GoZAq11nbbXzs899gih9Oz9IAN+pIdkssh8kImi3oDr0fZZQ5mJcbb3Z/XQrTuVNe8EaIOw0+XW6vp5YgQ5+joSrl/v6lx7XqzvS17/fd3+P5+Fmc/hPDfZ57z0PBUcDrEua9Eo6JWBkhZWP/6I8WgblCwTj69GVSaJBhEtsig+pdztKmY24jbfZ4HO/PeuKgFXtwyaJTCdfTYS8i20qtyEyKWRK3VFBUoGR9tzKE6rtNQc94Rhz/ed6n8IRaLjJkF7YM/05/L/vqh5YearAl/o2A1WIPy2VUUvj0ZinX13MlRirtIIbqtijmeZ2WsJ5UGQOd6u23BKR09vVW+Ty9dCn6hkoKDsVpHz2BatZRJZOHjuqRSUrMjFNJMstuB+7BT5IQjFiFmK1TMRKeQ31Gj6uah5jaa4qYJmAHjp9sz+f99Pv11CbTIC1c63hq5qXRAlbuZcTKDJBqvufBhCBq9/rndD7t7n/X5o0x8ola6iQEKeG/44Go09Otk0YHsiEL7opIKlShUYcnj6qFkdf76X9m73ENNFAHO99JixT1GqMKaWzEV9LgOa1ZUS+tTJrFbio/SSqSAjIVmaxfANusBXCxTyHR8LRbn36+x0p/9VKJcu9/ERD2w8fzeau8bi8n3Vpu+VcllanYXlp6QRo114O0WiR/lBYwcCzcYEzb4nSIa/vtdKzmB8JiloqIz/Yi7Xy6/EnBkoqLJ4MEneNTT7esjHEafoomAbVXkl6RAaw8YQe7DOHLwHBDn/Rrdzrvfp+PJLAsrVJDoxm/d4f78b+voL/j+lgF741rpDc10sjw792jgEXJlY6UQjTY054CSDV438vbdggsdjSfGe/U+ckZiOfFOvlsml4a9Nay5RwlbeElFACkYetPSFlnrztpC1r2KWcRG7kquT27zfeJNs/leC6RMKNppAi3KeJ8ihG3+3HanbvzozI5Kp1pGqr1q/LW0ySPedPQ4NIk7fp5u17CTx//eVSSaL20Oiy3MmdR1z+nteXipAE0UssuSjh+hj34OF4KTeFltNkYGvuPIqIplvXgZwwvFIaCDH05fkxPwq7392uw4R+P7+v9sHoz5bEFv3drPf6gm12vLLPNeT5f39+L48vI46uhYbBl9OnCoSZO5vRGmhSJkoLt8iySZmqxAMPdUjd8FjNPb21byKUTLOCtCd74SnI3GAr1moUU8NZGqn33wxNcDzHwVjh6Xp1zblNVZAmlSRHZlIUUu7UFgpTKXEYKOnGC/CRhPY2jeg/qMcTx8bCfTIaIqij9Vomb8xzEOsuZjtLX/VRs4V5t4YSTB/bbtSgJaynga77B4m5VM4S9igwb6gsoSWvHzasA6qbCmb5aDWYzeuVFNlurSAkpF9IodantqesWBQVRX1VoRa9CdJYmH1ZCKg57L/31IGtremJwu+atjHJt285vvtT6A0nf0XXUzp5Gv34fruGU0nFiI9/BtWZLe0dTItiIt7BgYi4vzsf+Opdc6o3SSBfMNZur73U/67GNUsTzXhhSwR+qooIiAdI2JaNiSGi5auGht6gpHB2u2oSEsQZJrgSzsah6s4PLmRokvNKjBD0E1B8SYy0NbizvWo+oyYCYGTYN3iCj5gVadX5R9Mgi4Xy8vOvjYvTKxQIcckCZ3EARF4vQefPeX+dyjVq1Rn94uTlBXYTGVQpopIiqKGLKckcHcH2MOI1R2/pSk5TVfmsl5jPC5biE057EYBu54d2mhStl1OKFTaO22ZZHJkVVAjcy9eBpMc4kJ7jV77WgbqNUUUOjYZMQrUSUcy5zGBxUvkiZzthaxYv40u2Wl1QIKY8cM8rqFbOx7qb45y3icisBB2lc9vxUP+7ux/u08qpaQihGqlCDfazPOyv9zj7pR8B7+qQJB/5yk8zH+VSAiFqZNZrIuX4cv2VpdMrSoEv5eigQ8hIpyTdTGFZZJq0yb5aZaFPhfUsR3FncasG0CllF5/R6PR939SyYlOANDV/+fp3Oh8/dZVc6VF4doDSC97vMYqhiOMs23n63/yg/nYJSAihqqC83yTjUX14mEk3LlMgs4T/ff6rGr7NyUdAZnIVgTR4L8ICy1HtqWu135/0rosT2H6/Ln0cR1g6en1SLPSB0PYWW7HeXffA+Toda7sxb6VYaGkcKQo7/HPfFCWhcp3JmFK1axQbJ4P5iEwDcsrwV8EHLDlp+n0yrVAibYIEpAgj+iGUcyAvATpALrJINl8rtDao50srLrA8ppZt5AlK5r0UFP8r208NnAgHwFqSyXZt0BIxPh0rsZFw61HWnUlvUkIPuwScfzxsYkyn7nAR6QKw80tEJl40i46S9cxFxqivzKOpF/W4qVm8TJgmuZpumt01R1zbNRpvqEtuEVWrT2dGmCW+T89qmD4riYlQPo5S1SzftUhl4l/LtXZr5Lt0rMjQvF8stupSS75In0KUsTZfYAjqE0ZMlj33Xp4JLFMn3aXqHVF4/pJ+gLB7V7sHKQd2Rw1WaaoM6dWMaLNgEoTKoWDcGvouBZOPxW3CGGNQsmeRrGLBfGPguxkKyBSuIRbUAyGpiCD9dGVzljeRxhR3ksIVQ7R4eNP3Wp0mMTe7TFe4L1oPIYp6u8L4tWFXaxBtgULtugMYwqDWPXF3Y6biy+C04XLCMTIcKTSwk03X5Cr9N+9r0uUoMLDJ9qpEwoOIJmsXhKj3LACU14FlyzQYYO4J/BykjfgvJWHQGDAxmBBfNCOabsccIVJWOKZFkQK5jG6ACGxAbgXcheIrJwzXJ7AlX+Fn6vtaidNsmtWbBxGHBZ2Qd+FDAumHBrGBRExuuMBbsJg6cJg6ES+DKsdCZQT+ne3jcw2ftjTJrD3SlbzGixc/AvuLBtALtaX36RhZr12LtWihFC61o2xZ/l9aV7ZKitl3+Gaij+lQcYXvMUI8Rfa7MAQ9Vj0QhVmL4HEB9ggNnwFcYwNYzYA4GHGdYiXbIrFVYJSMOwhFPBV4omzk+mvQ9XJN2j2s6/AwMKg14U3CuO2hCh3PcGTDLGFQSgAfIQf85pE2dAQ+LhYEF7ehyUrEFF03b4mcoxgdLhmvxzNA+rgNnF5iSXAeWFmgV1+FJOzDVdJDSp73lofmDjQ+TGSe8abOFkM54AxYPA4vCgIMEpk24SlJg5QSVDT6UdMx5m4tzUPvVpjXkwVTjYRRMzWSXqw3TfDEdV4iHUToKdgD30ACWpGHDyr49X/fjlJVOjrYuVJaw64Hm5Pe716MwiSXS3o3p+7gxvasbwW80JovHgSjNjT1GgBWlAbNJk9aebzCLDb439ktQbrARYcE1YGMxGXjPHbPjXeNLVKmTpXwZwcs4XY4HEsiV1Xau4Z9nFnK8vId/tEPsVZ1MS1GQi4hUczOLKiQp3DDlTYh+0/uxRDgFNSVehRdjLGlzhZ9QJQcgWbNtVts4EHjoguXjFbYFvE+2x0nV04KYIPJe+K1Whr4GClWYSl6WVKraRjKZO9Ia/Wk4IoqFi6nAnRTwPxfdXIrSkE5hKbl/+nE665FGVi45R8u69jHusoaBOpmkHPlmiaMz104RjpWJLmcoj8Ak5HF+vetAgWRgcctJz0a/bkv+Wz1BJ0M/Bgd+OC3oYg/CNLJpkFoj80bBDvMeuii7qp7Wzk83iKnUQilICFbwIvhURcCI/tAyrb457JcAmvxIL6PITBoenOGSV5QzitWkofHVFShGo2vUc9Fo3krIUlyuZSnaF1p3wWRVsqneqHekbAUrkYfjM+JlahEuBd9sKLr832GTZOK/oRmflay1JKMgYPC4mjH7+SwoX0U9rWhSFKYenKLDhir6EUulWEUQ6IffCIZOA869MN9gVkWcoUkxHMOrZeen0eUPMjRPsYtpYGW9tgp+0tFsWyGiskxbhbbsKI5mkXR5u1ZDr1IIL0+JQqpJXrWwBwC1R5rzD5Iqab/OKi1Pq3XC6BjbjglVNVzBcUaaYdufr5cjz9NNXX3EUT1wzXR96FKtsVGUM7RgZxp5/OcWXuPwiGgcDdkaFLta2/EXeT2eEYD9dtUZc0W3QJOey/BKpqVrNK4W8SLoBJAwe0MrcZP8ghGoU6qr59NbjDPKEfIbWikMTMb2Yw0e65Qtk/RRuKJ75/r5u7DYlfOQ7FqPmHPyh4zLvind47P0w+Pjen/GzVld2ormb6AAoQgcPR+fx5qpr0peWpS/dkh1IKZoOevQT8jUVqXo+MqNYsLm2QSShw8uXbStd46yJLdEFY4kvZGOQpo2xK1gW0bx6/Cs4PUS5BRJSVUpTjEF8ER2NWxMRPzJLUEroghiQxnmqOYHFW5D4SibkItelZ2lBEpaZhxHFIS+nTTvgCydAYF00DjbImqcqJ3EO1iEMWzDz+9JVsRt1lkCO1V8wAn1IKeW0pZzZS0PgUwyataVsiRyNNNyH20SlfRjOU19p4B/3A+ZpLzW6Ex1dHHWtTT+uD/vTp9FvEtSA3JvMUmYImeFBGFyDpQnERImm7iQIBce5YWaJNw/JfOIsqsk4MFYAPd4KVMUeD7tWZ2K0ft147GiZVO19KSlZijuP0p47oIRXo+dOYXOGjYmWEupQr2cQo3RerEkbKv6SejUjqLkJ0H3V2nEys2c9Ew62Bd9CDKh5VBP5z0ywvO/KYCawuXJfELDCCRVkSHNDR7SEkGaEhlEUKQho5cukHXLqTHkuZDmQv4HSaT0N4CHIieRjAOXIJKCVD79TQr1ApnqEEIWvErpApFkkKEj7gtjCdF7VMCCmRwhGrBzg7o7RZdBQI6sAkjCwQyevoBHbiEFf9r0PEgYtOndkRxrk6XXpnRymx6jTfiPNs1hmyYBkSZQkHcJpdClz9SlSUDapUvz3KV7dWkBdMCcpAnv0orrUoS9Sy5uh5smivM+ZU3RCAIs/X36BOj4AGL+Pn2LPn33Pi3/PqWZwP4ypD8GtnhAG5b07khHIBsxIknfAGLQNHDakcxHm45gyoOwOLv+SK83A4IAaPZhkHhGetggKRz0IQhX00MZg2Q+XAVjcmsWpL4NoBIGGB+kpiJfS7oCJMAiSQ/wjUFrB4M9GLQ+rgAxQJI56AfAHdAIxgM+gb1kENI0SCMbbCcD3I3xHUZgToG4MS0UVIsWM9gWsbF0uoI8QGkMtobBlogt/JYrgGdiv610hfnrcLcOd8POMF3WjS3+DnfrBLkkfoZv1KeNb9COwmD5G7SeMFjupgfMAgRyps8wC4SUQJBkQJBkkNI2SGkb0DsZ7BszYJWgRYoZsLIHgCHQ/MIMuaEN3ghNUAzaW5gRBwraWwSzEREbrMkxI8wG/AzvNqIAukGyEwlBi4SgRTsjizSgbZCab9LThyvANmCZGxQwABpngY2zJp3G1uBEww61OBLDVXqqXLSdsXIWd7MAQ2S4HJpuWNvlcxS/BWQBTLfW4ZkdoCY4Mi2OyqAOACtBrb0DbMOhVQ5aclhg7iz2eTjKAf7AV/CAvfhsv6S9bwFrsh6NjXCWWhymFqSoFuVbNlc1g+zdtngC+HcWSXWLpLptEVrAkWlxZtoWMBVoAdsBktKByhoHnsWetl2GkGBFAPhme0BDesxuJovtBwQ8AKME/MkOAFIOABANuAf4vu0AeSO+/ohvPuLpsbfsmE4NBz/U4XwLiymDTgyukpHVAHvZoJTTAMABqJPDqeYAx3AA4jnA7xxaijm0oXI4y1wuF8Wp5ixAIrAunYWhaHE38Em43C/OoSuEAwgB0CmHU81lExKGovPZ4kwrx8G0c2gt4lAW5WCnOSA7XZsSAq5FgyZgOl0LIA8avDg0eHHAdTqcRw7nkeuyIYx2QbDMHOiIXYdnxnnkunxfzDMacDnYXA5lDg7lDUFFgNAU84wYvMPp4rBiHTImDjEVN2A2cGoEDxPNjtBAagSEacTXGgEMQps8N6KlDgjoPWB6QXHBD4BtjxZqvkH5WZN0jsepEVQdIEI5CJ2e1MOG8zgXPGw4b3APA38B697j1PBY9x7r3sOp8hatmrADPBwsjx3g4Wt5+FgeMNZgmgHWhJZEYAP22CkeMFaPhl7e4T0cGiVlMDYaenkvqK/Rvin5Bh7N8sIRANw14NqAB3p4QB4wMw8wmAdK2XdbgZLZ546p5BK/0sggpttIPwUhr88ieSnd9iZbevCxATsxnMYI9NU6b6kqF7HNsSSDMtuIVcwCddqwG1Sx31ZwbBnOIo+KxnEjyr6WU8awO5VAHDeSIIniexf5cSqEJDL7Fo6BjcjhLOh5TUFIFmXqVZTph9kqSLVkXDRsRKAFsXEsynksZUOMoiMoYl1UOnWnzTfot2L/QsSvmA8r5DglZyPiPskpsRhTI1spYCNeCgG1x1BcppvLIPz3ekKC8SOq8ThqRo6v5Q4kpI7XN81SCuSNJMnwLc89z4PLibSSM7GH3YNzx8FbcabFlbBE0DCRJ+HznVc6UPGWG0qQJ0VsBEI7GQjd2jiLrOvv/xz3BdqukdOxpToXGbWvKbNTtFZeyLgfg0LYl4pAsiM4QzupTHL+0cBcCQyyHYKgPccszUIO1/0r/vx8XZHaNbKSLxxXm6/1T7FIm1Zln2kBbxx8v6oErvyow9b6CONq5HGqXVFLGdAXCbrzlMLwtFuh9YoiV0s7mf0tonOwuQ2ClaYHuTSKbiwagto+d9uDdzrANkfhgusoryMetPg6CmrZbKVT4/DT5X1K0lRm28pUTUtpD7IgmW4O26hy6g+Kfttz6CxkxsZEc/66TrA3yjyZ5VzsWWI4/PcfJXeTBNa6HxdHkHJndAoSr979ixecgGHhV/eCU0+RdHQcIzpxYwlq2tq2kdDX4DbzDRtlrcgnZVFq8go5UcQiZEOxyz6RlFBzFjP9nSool1lRymY2D64pc3W8cgVU5xuT33ZIUagRtX9NToEhWCoqYqEi0NXWoCrJwBU2/YYpfK9BMgdpPFlUsVq/cciUXOwqy+s9L9CY2+pVuJfkKWnhVyHu790GDiMShr3e3k7/6GcyCoXMHZVIbFUQgYjlnuKGY1KuY/Kux2RH58I8xK0Mij8MfGYDX9ggzmmQDTQecew2R68RwcrFyagqdvBinecFD9Pbzfy/YUFr6ncroUo9L7lIMsrv3nkFeuTOnBRQWYJOEYs23PKTcp6nz+O1wPnL/Tnyo2sW8/5+P77HYpQ1yEA6Nm7k+ItZUNFgoFdM75SZbR68P5/0YIXfpBwVGKxRwlXEtbR5mh/ehcFKewWx4VGEWQgAcjVcpWxdYEaOD11ErexZ1faSu3rT8EOqJiOFAVbasT0//Cdh0zr5DPuocPt7qbxs7nQ/cvtylhfBr9EU4DBc1eHNcQaUWeBEl3HaH7/CrxZ60amfjlaLgzrDKBXzLHIepbaY7H2agvPIigU9lSxP/8N0VtgiVbejBrYuYOsWJfjW0H4fs/SpS10Vqa3wdNvLJ1E31raVaolouTmzCIqk3Cu7cVBd0DzHx85CriqS5lWf31yGbZGfsYDlWkruB9E1u0+VlHgOhJtl3K9fp8JRVO24Bg5zngT893V97t5fu3tRZ6BKODvkTLrs43BLbBJ8P+5f98fp64i4m94StlNkMD+cpUHbnh6V0iUvIefecXDtImVWTNphEnurpV0LFwErHmNJaTMM2yfHY/d2LNkrFTlXOEp/kDDRJ2o9qNjFkdC0vNBPSKoxMA6K/JwXG85i5oBsrTTKqDKr3JwbRTAABBlknEzPC4rm+yXGxanLUtHAVvIC+Z/W59Q24nYtSWslHZ3dKDicZVQjWOG8l47pBhZ1ErJaEa0if+IRl2n013W/+/06FxRlsUm3DKtSyt1ZyN9V+xrFyjds2Qu1EjuxJ1JyKrmg2XdaFurWB0+yq0eKWl9Z50IjI98PDGG4QhwOdJX91ufJhXBFw3gvO9yaDbz66xFbFf7zPF5WHPLGSLo353lp8CQkMoN+xv6Cp0fZp0kqa+943c0kJy7a8jm8eg62WMpGiVaSvfUpI4nN3KeoJwASfVoG4ORARC2H0RzlQaBNVWSDLztQHS7HR0bKNRulUb2zXU9LBWMHrugL6ci1NHIoKe/hd3GCSS/e0WD1YV9scBnh6WnW63D8rauie1U7AqSHRcGibUAfA6SHNdRPPRxj2VNQYtHcyk6Iflh1Si/lPlVZb7vX+flrXqi/1itV0Wf7lnauS4JkcPPXW1B1r3vR7k9Zvx01BpPAcP7Ap/kVPD/dv35sVKkPrapYpK1KRVSzO265peFXTU/RqRAKN0aW4ZXFr6rLOpqdXASsMoJG1mC4luZ/lvFfu/NL15R4depQLymMD/bkqjhc+rhAFmYuEYsrblQfjrGITWcgpL2fYk+gM0vHyJgMrxHMYE1mOAOoEvAOAzCTsQD/2tzIA3HHNkM4AS5rwakECITtMzcPIPMWsCsACh2I95xFWhEcZg6hPydY+ABmcgBvOYCZnAiRZWYDdDsHvMODI8fTuph59islhKMsFbe8OfEi4F8FaFRTDFrXOEtcRfoHFX0AoMt7gIA84Dae5jBn4f+iNbXMlvB05iwu514qZXvy0OBszbOg2+5+nOJAa9NLOpjUcUtSNrx5+Q0sDaHPgmpdt8dONWtFxAIkcHY0uALrNvDHwUfCb2GPjjkDD5QhihAc0NgOtHauh2IB3toNIMgCcZ0bMAJVCQ7k624YgH5LqQbH+03Oc1Kcsop1ia+SeID9LmIicjtYR3kBwuCyY6Bil6XkOHHg/VoQXSgTGiz0HUoReoD+t+ybCCkJxwFp1GTkmWZpkdfh9Ijdng6fx8Npd49kR2WxmDTVOYVGkPM8XfbP4C7oyvpRVdYD7+dB/wXKPO+5NlrAAcWjWfVo1LjaQBbI+KKztMD9cLveOJm2TH7SoOnhb/iT0z421/0RhyVprhwn5j3+57FJcaVCr/Ton7oNqfWp8iwocTMAeQcfFtEW+r6T2FX/FtV91NJdPg1eVyd7p2gzaL6aNVDqVE9lVJ9YEJVYqgCEyNVLOcWjTNuAxCC5UuJWtesAA+EA7FxLz5goa+YmK8KXqlHPQNNBtX5gqnsSSHItz+bHBpt/P3c3Vt/pVRNefn5PcirhJK+au3vqPR0vP6gwzWrA3IO5E/RPDp3qekshb6mRnHaTJRyA5rvXPGaKTZ0iW8I4TXkwtCrVjmRGCx7UjircIOz6Vune3armnjyJG8bfrietsEcZmguGBztKKrrMDKqzDMpmO8pLcLw8gst7Pu6mdn7n3eOj+I4qZEq5sGYxq/GtVV2kaD5mHh6OjNOZPIZRj0F3SLDDT0XBvIT6wZ4bRYkySoZQyAQMQfCVkEJDfTEChw6QeQd4fPCVUD4CEw/lkcFXylEs/B3KJHJZMvievW/gMaQIWDAK4Duk8i/PwQaTc/IomXzUImuBvM+lzblc2dOA2fHy9bW7R3I+DfNQ0N/g9dNHu30cP8NJodsRDQo3zCzG439fu/Nm67BRwVdouON4v1+ueqRSqIZG6lYYBStjzm0uRcQaQ7mUbVBKB7Zea/Ctm+RGeM50Md2dkeuZsBDFOzRcA0cpa0ajRoY5R5TqoEjTIYDiRkQMRhTtjCgqGlEU04Ajt0EpRwMeogaU+yjN9A1WdwMPGsXTHoXSwVGgioWiIGWTmaTowTI8pI2N4iPrUMjoKERX3q20fqw0G1qafJtEVJLwg2I/oTY8Q0MYpQaDdtnYDNdoaH9OaYkZ7legcBTVB80+zYKu0Y7XVoai9uFEH2I8s/5HJWhzmzyvQVswwl2VYTUUH7II+sEn6ZRPQpGQwd09fcZ85ap5SSPT3mBbcODAch1KBnucNT1tIsd6RynWV/SiAHMI+HpAcWE9wiIoZrddZuYAKK6hQNsJAxNvWnjgsldkMOtRtcUV79xn5Xq53cMsFqlN1ZPUm5E+TUT6rNA9TmK9UCNrUFVmW9CJO9oVe2bQ0weurNqyON/D6Y+2JtCejiJgEjqpSt0o3dGe281aRI26cVQke3xpLZKWnKP2SaQz4XnAKMOttg5y1QOU4liTrHoRmAyCWL5EYyb2cKw0RJWWsPEUSDILoFl3acf2tMgC+eBCt7RKt+Saaf6FFjlTNrPW3lgGSJ3//yWosnKMUivOUwImLW8rOqO8Ot4rcwk4TTp6IbrVp6+Vpy9fjVnKdAgWR59RRx89hGcpE9hNqYBexfiASejAh9CB+qinZHSLdBLO7FQtzQ9PWGDXepkftGjpZA1cYktBwIvExz4a9AXqRvluPLqxSEhsk+qteulPjPSsrxE/qvbtsDctSq+toU02l4SwDkZJQ4zrxloueehUUgicDF2+osUPb8fn/iMaY2XPNAU49C2lg54EFJEsqY3sSE+zaWi0nwomOhGloUNPx/Oh2EWqpQC3kCJXIgd0yJU6Uhfp5/bu8rR3oOFyPQ1x10RWNaHEnDhPrZAob/1gvbIWDF9mFULJVsWlQSthPdJV4NJ2FqQOnlry8R7RTL0fb9eVvWtlE1zHaZ4nIX9jHD7l6aoHvbTcLFXTQVj5HK1RgSoKSJuH7s7n63eMhD4/rnp5Wllu3FG/chaz2NXF+u5UxotmlGYRycfiK10m3njdwiwtLIXw/yVptIqLUrzmLEGDXwYViaQgtmVoBSwldSVfGpdYUxhj00rnq/Rfj6Qfb7AhBFU8nk7x5veUVn2RUjyLYobOgR0wUYAVzTsKi0mSS3CewnchBOSoMZbkFK+n4I65jxmFqAYx6kmcPGTHlIsGJZAB+YlBlyUDVEmwFkDNCPIYjw5IHT+yw913r4LDQKdYNuZzGnq9h48+4ZRjw/fPVTJCWu5LJQSVNrM+n8qDW07txmc5/C7z341VeWGaipsG/61Uc3nFeA77JRZ7L1foPWUsTf3M4iu9371qwuEyxx71vWdR62yo6qcO+jJjKVfCLOi8+62xPL5RZWcAPzUU9jkLemlKE2+UGHCTdjlPC6LFfuO4mEQ/jqsQqW8UQAidC0FnacBeaThreZSPQFJuclPk5VRDqA0FfjlEGEXQDutosOoIxR3GKKNK5y1bWnvDrcww4FTYiTIVhl6KYGFyYKtznjIWTGKjuOiYX4vtbbyy4TaOyMvUpL4gEJDLxIP1sd1c/7PhUMyQzPiZDYv4crh+l9Uuo3JStsbOqCs9WIJKaQXWPLjsOaBqKhuawp4GEwCNggZtroxbYWwpzAtIKR32kqd50yht5ZEYFcjdsLhjK4M1xkXVyWwPPpzuRRJ+bBXSjAaR4/iKoSQPbwc2QbdlrV0QNlHrWUGEW5o9m8aX+NxGIcTMplb8CqdktLSKL6BKdLe+3kxNfjwUMQjVfsD4DZPzcnp8HMs9qAj+Kfp7HizoFfQMKveJRi7fTsHireKJpCJY4LnV8f9MLQAF8c7aO5XT6WnS6O38KhPmihNhIVSujbzu3vQHbFRdkKP7oKy1UXX9G47T9f77FI6pCyOS1wuILv+wg3Z79c6DUoPgtPa+QbLcZBguctto/dhyl/96fz8+J1ybXii9WijUf87DayBXdQAZbi0FKdfnFlpWVYNvuFs1QSuslqp450V+WthKsflOGYXgswZXrbGo9nPcUbnePzczgSrozOFuQc7qzLDSxe35qX29f+/uh0LftNIG9Lw45C0Y9Qe24GUAfqShyAX4rQsaZK5xTEt6BIuFgZuWOYQNoAjgCrcG/K8GnEa5/s4AFoPmvzbz+ePYDlf4mclXTA+k94kxj5vm95IbgvefgYAYytERnFGOZ5s6jY8+UY7nqcUrcSjG0SM9SaryU0kkvGlzOvHH50rSdLi3lVRLpvXwaqjVm+VF+psSdqyQLgNVYUnIgTWLMcp2+mkRYyusiRCcYkgaKUh0JaqsknXKpOJUlElQDezQq+7JBmivEbEO7DqXMWPgDnJjpq7N7SXQVqIBxguVQMHgBZlsixEAYqGFgG8yDSyIXg0FdaR3rHU58Y0qkKfmSpJRcSGkBmt+nOhkPW8tAsko5xuqlbPIdelH71WvOVo7m2Q8r3+O2g5UTfs6CrmBgPvpVpjDg0a801M0iQg2wtx0rwjSDKqGn1c1VquDOhW9AljL5LbyDs3pO/Cso7m6HcFn1G7vRs1xUiSpNN0YO6Hfi8bKUgP3Kaw4JsKmMQFhxhS2GnOTUPRlaKAkwbhvLIrmrM3BM1giKEIH+NL4MV+lEQOgMS249ztc9SiaAwOzs1AXaHLjLDivLdIyIBNzLpc9A2DjULYHtmXnwPcJZn6XAaMOIDwP9maP2DX437ynwJPwZXZhcZ5fFQ1gFBLLo4oJfW4ccp2updjdeIcpAVJhmOxVL1GuYbSE88Q0NGkGzT7Qq439L6VVlYzcWhu7I0g6z0wzRWRanpu0nHUeD76UIv8mJWw9wfmst5bkWBry8gUAgbY1jMJiI+6gZ7LhpCdYGT0s1hjlpC6LdQvMqGT7AI2UNkyyM0Gzk0HVtDC/ftfis8ijI9Ps5oac6bbg7gfpDTfDnruvWOkTQya33b4E/SleSFQTAg/iupYfHs9ow9bsl1HuG8t5y6KI8D1Z/Nkr94pS9gUp++CTHz+m2FoBflMlFlsPMrWZr7+M/CqcoizJmAtlilClKnH5+Tnux/NubTIZxf/tN1yUJEUZFmOryE0zUSzcKxR42hHQoBF4FcTQ7YjDBq1wHG96nh+nohNNIxm4XENjTVFKImwqzJRwEHTqIAARIgpgW7ToaCn5Qb7DhAvcXwvqKaNKLT3NrSxyjjVGbUlAQwsDtIC3+/WzcvQN6o2hkICLRSMa124uWX2j9cyqhQvsvUeDixbqqaUgovk+X2FznuIE3wtzK3YnVzt98wu9Ls+C88aoil3PcfJpfISAEM3vZG7A29xLIts0Gy7vc6U8WqXSk4dmh2RUWrSpsiNaE4LGwcLUtCBysKM4GTZOm4XMQk+UahjN6eSn4dX6jkEC/WyLiEuXr2CdcnanKH9yxq73v3Wd69UBsvFBU/XweuUqZQmCeg8vGcSqrt26wfHtLTxosH9u1/NpX2ToVbiS9giIUkqmhlExNYxbB3iE0uv9YlTFJKq8mq0PWsf2tqrNQbclYEKMVT+WUx9rY/fWYGODZEcLZ/TG8Pf7rgApSIspKOgNlfxxitHm/UfxEZShsuGsP6cRpeLRTO48axTGrwtSZLmp4+RYy9jI0Xf+W0jolYQNw3n14Kraw9H2u/PQEkipMs5bqz6M/T49P4Jxtv9T3L9T99949KCsd+fpT/WRocAJFP83C/hTIamWcTrvts7IjePCSk/MDVsKL0opPsOoUtjdRrzpOZdmFdmvXo3nbYfD+ArfqMrbbPkt09hY37DyQ41XJhEajm3s4ahB9DvILdhsraaq8pGGkAV/SThgYawiUzAC+T4iGwG8WThgc+QJJUVbTkd6nEuB0BlHdXjRItYo4np4nY8RWqKVsipi4ez4QcLlev+cwX3VqjkrofWup8m5IGmLn8dKMBhvaBClvJ6313NNkNbIpeoaGKwme7coKjNoLWVQfGZwbKM+wCFD5FAp4JANctZsvewKCeNHRaAL3JbfiEw/g0P9Z/d+fByfU/MFFf5UwQjemnySEqE11Z5bYSpkfhuxQm9RrWZTBM5zQs/1TUonTH0dSjsAORVzplMn6cYSmSWsqlTk/Fuak8X45CIXLppyiyj4c5KizRCnWpE16ETegKbfogWyR/DWI3iLYKZB422DJH/Y0Zuf5vkx+5ulv6+KpGhlziLieV0T3ykKHr9l5k7Wra5gkWnILfv0dj997Z7H4nBzkopjSNwFw+baqpJGi4N+SDt+pAVBUczrd3iX1eNIdo8UIuCcnO+RFuK7bu+qpb61s1FduPJYFU+Jo8ymk4yItTrEP9b7RaHYRkrmlkRED2YVRlBF0eh267BwHTy84CRt6NN0h9ILa+UC9LxByyRi6nT1WYmbhE2oOkxRrOEshvLnK5sxA8d7hHFBnBSOSvCf4YQa0GtjQLfTAY4lnHsHvregU/CzlAlxvGpoevrZyDquCUU6BdgZXM7PbM7GLG+9/ka1/rYeqbROjFMVRlsOW3RafrRQnLJQNnbTcsyqXS1jmgig8JYUUUokR13hcQbJ+Wdb9Izu8tUGEOP5CM91PoaNXtLxqLpbivSaJJQF+Up3oyu767fCY7ESoThVVQAKXZ1HChqapEyFzHWfZ5CIOwvCTQsMv3W5Dzhl+1vuUrJ/yLjGSMmD4uDXFGZnbpmKdKNRKZo4A/mNRCE6FW8ckQn3WotiGEUa6dstTTel/Isd2cp6K9Nt5eTCOR+Zv1fLxavlsjF3s4CYDHqVjN1WopFdBxaiDg2Xuw2o2KS4v4+n948yvqsKyLcU4OsycxgUoXcV8HKUgHgSoFncwsSoRgboYs0bvAQpX6ejAnc5RU2AJuUGLTAN2icb9FE1dkC6P+UOI9I0XaG5gAfVHWiQTJuaHJtuyxieZ/t4yDm0wrL3iheEv/P5+nt3nppuPJ4RE/JedJCT1WLhvKC2QAzRhbVdRCpa1aCX44Lf78fj4e8WKYOqf/GOmwL36+u2KrvovfIyuN31WqMuvUoNdNwvnMfO7GwxqVIcCYplitJlTFIqDG9eUTl01A6evXj1DYQLv+hnnAbJlpj/hZe5/DzZhWlhJ+c4pQETqRmqWABfQYkY6vUMsDAJLgoHC03SQLk64CLJATceaJHwEuimkPmo069yUwUQrIEFDUgWkOrCZku/AqY782QB/IYpQ3dyFFJm7Eu6AOYbDcfBOZPSS8g4JVAOEEBgCETKDe3KgXNp06dsk33YprsDBNqmeW6TymrTB22T5Qoi2DZ9067BRWqZkVyDLn3KLn1KkAZ16RN06PWYzOQu4cC6tHy69MpdAkx1qeK1T3fvE4yxT0EiWO9Dmnngo5DPHjMqC+q3gROPjsZBnacrxKViqDxdYe2atHwMqNcNolbhsMIIEKcDxGnyokasytjEAW2sOEawU9BR0CEs4bChHMY60VEQ7SFBOOjQAR5rNRw3+BmeGXy/ET2XdiY2a4v3BWdT2LfoXIt+8yA1NC0qqDtogw6NLDvMZAfJWEYGXZ1Mh7JTVCmZDlWjQL+ZHjPe47fgwTY9jusBbTMHPNWAOYV/ZwZIgVcXlBH+DjM0YHYRbw5XaQQSugbxZjOmFLoB0jFcZT0H6j7Erxv4IiC9sgZ5V5OMCGsy6j7pIGsB3kDvSGvT01uYxhbkkcH9gBXvoWJz75oWv0Vi2mXSOkTfQbkfnO90D2ABrcc9QC1poS7DFcZmWjBUDyCRaz0i90D+WY8Ee4t7YO3aNiMocY8Wb9RCcpcUtcVasyhCt33aPbZPiCyL9Wf7jMgEgqzPY8FtM4AJfkB+AuvPDh6/hY8CokKH3iiuQTUruuI5nL7OINZhgPFCRYYzqPszoAIzgJAbQHzMiNMTMRHUXDjwNbsWUZQW6NA2wY1cC7JR1Eo56AjXwUnrDFwOk72zNLZDfAaHhQNBu+uT8ezxvt7AqjEJxuINEKiwObwB2B11Jx75BY839yg1D+oURgCg9bBGvHU49QHBR3whWAIOV+nkb/MIir6bzbvfu/smxbgsg/Ic+TQLQ26gEqOR/ltP3a9ZzqrYaJC1fUGvMKO71nRwVH5D+vzhKqszKCKouLbNGzhtnw4qqYcNCbYKO6QFEzYcUojUh18e9PjfV0G70I+qXQGNzNUIXFS7JZiyyTADfBoGh4eZERZqXp5Ydig6tJTrMj3G1HJvpnN/rXD8vcJI8ELrWViM+KmoZR6LL5YUVdr8y3MmizPZq8lghOW3/LvISYcwjnRYbA3MNNhXyOEghZMNkLSk8uG/XCR1Z5PVZXEA4/zFEZDpnDOpFpZZUpG5iU26SLort+pAsQ/YaFGuAwZaaJ70KywKqI70PD4tIYAEPRKGoLlNJoFPmwSEBD5Z4MATtknvQYm1KUzUJnOjTboWlWJoTg5eKNiK6BrUpmXcpm/aNbhY3r1LMfguzWGX7tWlbwpbEXyhXVIXXTIVuvRRunTTLsVGu6QfQHPaJ6ehT98LB/6QZh583mODhZl7uSejr4HBDfZl08BANjDvxRqGeY9D3OBQMzjEwxVGoA+8ESWZcDDypkCEycJdQJ9OY1F4AmZx49D3BEUhBsziwdWAIwLjH6s4nL7ptx6Okm/haqTvYjxGwHCLeIh0hREtety3GAs6cQMO7OB0oFYR7lsHyWgga7CMTJd1A5yJDu5blxlXBpxGmPEeTluP3C9MvWBZeFzBccD3wFIyQw6A9HBOBkgZ8VvMFTzdcJXuO6Y1GqwX/AyuEFCkJncGG2GUNkCCo9mQhcMcnA44GEkDhSsU6eZGw212NdLfYV1ZrCsLF9ZCRVoUOVgUG1mE6S2CNBYObnA6squB87OBgwGyQ3T8sj5rb8SMoC8tFKb1uK+H3QEEtEXIxkJ9WhhzFmvXIhJjoRUtXOfgdMDByNYLMPodZq3PrUIzaSdATFh1NtfW9HDzQGYWXA2LK1hDCKDljm4DDG70inNow+jAie4M0ObQXMHVgFuR7BmHc9eh+NsZBNygpZzJktNOdiiecziHHaJ/rgXqv4U708JJQDgiXMERgeQOkkGJ6aAjHPa+Q5ghuBoWV4gborANbreHfvbQz97g/EXZu4fR4U3mmR9xzINKAmFPjznwMEY8ukZ4NPv22XIE8atHbsHj6PZtHkEzPIuJV6E5VnlYz4vbZgkrSgs/KDYwSr/xsStIFITN3MMgTMf/mMPHMKjbHAHOxHFYnhYQRqCqgkZCw0HkjnAQOkRJHKIkzgET4LAUHRAVPil8j4ic9/AMPT4NJ8YMsxCM9cNpVSEkWXAWnlk6fHb1VkgLq4iZe5q/DUIqrd46RaLDF8FjhR8bFH6s7WG9YnFDCXtPGZCD5I/U2qfOxq36iW0s9MfHmwaPeKfq1SnLUxz6ubsVYzs1FhmCcWOhf6zbmwSzUOVBaU1rGH66BLfuWSBI5NfZmMPbPYJBazVksRuiWh8bL1ArXI20fHI8kJ5oXubQgtn1aPDRJ0XpYEK53Jh5wE4Grsuhk4YbsmsF1T9AfSNG6zhhZXiXGr+0am7dUeauMLpS4y/TyR2tS59LGitxkUGWbVhP86mzgGI9KhxUR0GjlXpKK0vgMmm4p1nYKGMbWCz50SlH94fGWnSNgtXQgqyPqw7PqH1oEOz0HYVWfjw/C7ZJ1RqU8iPHcRFDsNJzrYRCmJZyjCYBtZiYV/xPFJkZiS6KabNq2ugBQRiDVBtPyvC2SbKiuvtQrBdE1IhDnOy560ZuagQhldnrJSWEtfwoycNPl9tLh/kkVtjyxhBRRjVKqGhruA6dhj9uYQZ09b9Cflp+FIXxBQGBBINZin6YBk5BwRqxvSpvsBRAe9pddsXyc2r5sZnXpqGVJXY4B0xubeWBaWvhvsI8tz2wXvywJSCyVuOGZjE93L6cIQERrvPAe7a59Bh9e1vK/ZyfoEql4tVxAR858tWkh6FaPIuuGjWqAyQFjSni+ULCqCSwg0hQHhyfn69z7EJUSJKnkve0R4mQVAEqyYI8EKbAoU4fysKegLeanahkgMOFH+Guj0Meh/xTjuEinmqp8Z2fPhoFf7V5pprX+exisA0+Cws2/IKbr+xWJ83WgVKYEEklPZ9q7jZQ87mURlRxK2n3TU/V0Ya48gFbVcXTt3xBCxbO+6rnjjzqjKdJuNOhrEtsraL1pYVwp8NtHqHOdd1DherH98v1PmfZipNRNf+0NPs0C3i7nkvzzigOvKDz6Bf5/Hw9I6VIgnTf1uWFMeYshPGoAoQtXQSKIhjJxeRaWh94+oxdIq6nw75WRdLKxJzpKVX+6bI/vw7xyL7/DeqlQJsrXtTsmdIKkBMhjrRy4buB1n1Of//rdPhVwvcbNSmWmoDT3x8P0+toAar1GU/qLQKqvvSonoH2m5hFFB9VsdNvnBrx78s9FpMUygfl0x/+vl4nppoJcmd+kSArSiokyqqXS08LnKa/r82k6lfhNk7h+PcxYrOPHFMrAuHwRVSvMUr7Bjmsh2cjDVRnqal/urypBqa95L63jUfmIIXBbAOwEGLHFrFjbyga9nSZ+2lfNGf/ICNetkVCAelCCyxZmI5N4atm5k7WHA2UjjkOPlX7iEhHw6AxqeH9jpSoWicRBULn7hPk6OeRnXcN2mt4BxyL40YkJOrOHTKiNGY8JdJrNuMVkUDzlPcm30W/tizxNmMKlRreA/R0+Tx+BvOFNrdRvIYjDVQGx4/A6p2EtLiBeoCT61irhpY+bIOoVZMpxhzSI2D7AlbBIXEQrjAidzagPQROlymQpfwyRSZsPA1pVAKKmoCPViBSwnNF17ZxBmF4zYiUDEWRf/xfS1m59W2rSG43TjRuOjrVnixl9wakxj23cguptXdV7a09txAvU4enwyny796PERw2N7kr3EoZD95YM1nYusBYeqaupTwik5DL7vyroAMM2kD1WeQOShKwDkx5mQXyLQ0IQcS6gYNysP2G6b2ImIMjlRiZ4qQdNzTd3HYl1+PnJhdaUclqlc0NkqQVDJZG0WvwxfeY9eQqUu1kvHKg0bJpfMmx0qlY50DpY8Pg1/Mj+nj7WOmsNaWMWFGC5yjhB0ZHTROS9G2GwC4XID5MW9fxJfmoWCSjdB1tRylZwuBr8Fgep2exoZRr0PEoSM7hsfCVasTeearXs6RVUWOryoQ7vr03M4qqjpW2sTo94nG9CpiPg2JT2VjBcz5yabGnkZViTjvurS0S5oNOLWTl1GeEwNaz3GI730vm/FRmqwzg0xTr6XH8vD3VQJWd7RO2FfAP4GMHWjobhFYi+6p/Dc0qhrHV2kzpyzluCj3qRXVqldLGO6cHDaZLn8NyI2QS8Jg1txagGvDQ5jGnmFKdGGgLS1ClI4BHGVFYBgZNBwZNB7Ihl2muxxRS9E2GfAIskFv+NcB4Ni1GdBiB1Dm6bXqUNXkDoIHZWL3pmCM0lrElmnhnQ4l2To8/l+v3JRo1X6dnUVCqGmMPNBl1esQiTr1qlFoySAAY3krl9Agewe/j/fo21YVqi00ccFvjK+QFplMM1JTFOg+vK+tR9ZAZKQlqllOh8lBULzi+gO11LQ65lgJsTo/LVc2OaqRC2QFPj3CUPauqVwLAaZo1jL+fPgst2TUqlouCnmZjrdRawqteGL6j1ERh9Kv+Dr18B77YdaCotmCsBMhsBLwfUdFFTXu6rOg3VIde+HwokeHBagAy6mtQkS8MlI4wiAlPxMiqVHwU2DeLghsgQr3dMAenXnuVQJmaPtdv6Pp1SN8rps5cV7hhU86kHpGbaVccW13TqqXJ98Xjtrv/V1mIKppBOUXSyNftsFuZiPLE6XiY//F4lR9IzsGyndoNG/Pxuk29l7X2Vcp3Y/DUdrlibqiUIScbOz2i46m38qCK5ykTyumxIiJSS5NzP5weX7vz6RApPlZxZ4Xa8T2lsVhkpE51ythQZKe8c8rp8X38/XG9/rGNdbXAp+oQs3XwoLcHk6RKltqNPfV9vRdkDF2jqrO4d/hc57SHUTWlHwDuawD4swBFigp6VLPQgMV/rqdLlaKlNcqboXTVUcBq/ajsdEcJk0qa11btFlQ8RgjT8iIdBUJEWb/O2l7uGrUDHPvwuWvZg8TNFFiUf/coaGqiXk0BSdPf0p0cZfwQxVPIUc5qUZe0juQpqGNL2WGjuPPhco2n4X5O7wRp6xD04BVHMY0MRnmcgKxVqr+l22WWspDl1/JFKvjMKVCinJLIpu1USxM+9vtPFYqiWiQNKa+D2vgBZestJZhaEfNJuwMH84CSfpD+WZAjhCMEcGqapA73qYY9O4WfG2iarMJio1IoPQWMlpTJgwJ8tfDLPJSAT7a597kekroBQX7MdNesuE4eMGaA6+noKR+EhePqdVzOhsqCG1U7KQ4YTZLqa1a6jI4ujlVbbqcQHQ1quDjX+Xl3eX8V91f5moFGGc67x9RHSn081TajRWlRh76DnMTnvPufvwtzcwVIJ+GYtqFxqfOhhHG26ghgyu18/NJT2au2NoZm3c+nz5JDS97SofTSdchNdbRLenTfdchHai++EMKwpVIh7uJaFl+FjqgNHgUlX6yq0owiv6X7JMoJj1HC1pRNCG4bah8kKcsDTSxXGhEtIXkdxQcvcuZmM/qBFEsV/8bT+OBjPAofQSVkqIsax7PWsoq+2rTUSi9lrMBcTiUIN9ZrbIgcK9hLknc7qjRt0oa+pao1ydKwN0k/J6oNwCjR0iDuLC84kikIVpmvUaJRgl/M187jqX3SKYdwORZ92TuV0eV9Zs7XXZFsUTwPhgIm4sCYcYrI/mdJU6rsypH2YokyIjna8fKlhlt1fm08wn6tENR3ciNiDahh9Q3FDCSBP9mpqvMadSMn4rqDNgXvr6KURqKx3cAVz4oEr5VNWEyHGtwOlZku80CAzsTmuiObr5Ld4VD/52gUND7JDBssFLriKKd4rI0+Cs2o+kFQm24SEYlOtj+SarRHAySLMGlql8guuZ54TCwKqvc4bdTE8I24/1MAMSWU0w0b6+xdmxQyLNCgELtB6THKeG2D4uImh1Y3vt37r8mgKBruSSe+oeCL2QZSx5wYl8yoZf0lmjrU/KOKE7XreF7g31Fynuup06ZAzgXqIB0DuSdl2gUJpeRRj5sCE22Sg9pEEBmBqQhsAigZBllUl1IwII3q0/wPaQ+C0xmkY2P6FXJIwfeDBQwOBuDrTDPkK/BBgLXBJKCRMWBPQBmDAXeMsSB0g/YwFowKwMwbRJ2NA0MDavQNGoIalLwazLRBrXz4vgiKgCcDRE8GRE8GDD4GLU5ND3+xB8AMJRrh1ZKUATwPwOSYEYwUY9oeYWXhCvX46JwcbHRcAVbY5L9Dc/IGpGeYcZtrD9CW1Wb2GETIrcW2tOiJiYaTNld8ONT8g1kjCMneN4piwBeACnmLCnkLMkfbocgBMx4eBS4OeA8wp3YAZduQW2TiSXMP6iZzCCDXadGsFXy4LjNwgknEYa86MDQ40NY48F86ULu5NiM4cI829/xCgQ54QRwoZRwy6mHpomgUNGQDYo9oSxKmHtUioBKDxgkaH6crwOIoDvdgrvCOxm+p89jJrLUZBVURriiH9CyUoS1HZb9xw/YaTmHtqMuBTWZ+Bduko+nZSVhuHaNAarJXreHU/5OISuRB5aRGGrmbhq+Amk7md0daMh0Gr51tBQRqKFg3jK22gG9UWyRa4hqGh3mrGEFeVaIYGvL4LIv0ZKl6T9uWfO5O5+d9d3lM+SF9Z1mDZQx98yDiksjr1t3dFQ8BGPucoSU9n7vLrjAyvCxRMLzLRhh6iFGBv8EuPRfQQCcDakEdMUtsVc4m+xp4FAZ6jj8KElbop8jLKsVQFFcYnHIez+u6F6IqtwA9owefCcwcB74Qx3vWhJutGkpIrJ/3FFIdht5yJ4ha+EPsuI5iOaOYsuPSoFj/PTX7w9gwQc8rh70Z1TULNKQOLFUOVI6upSmYdJ/UobJyG9XfJx3ADlaow4Hu2q1lM92mmvLSRawg+XUg+XVAz4SbYQ3QlFS42RTiLb59p7498wI+d/c/h+v35XmN1e310qimU61g6Rm2dDWPwNHr/fQ/c+6mRtIgtw+HUy7i1p02FboL0WcHNJZrQKgKXJZr6Emx3GeCU3PKfhmPNDSCImVVIFqNEsIX6SKkgm5qZFvd8How4yhqYZHG3szKloNuoBncScy6Qdeo7AuQ68F4B9OqAcWXAQ+iASTKIExrQN0V87tbD3Nfc2EYFb7fXlmV0IJVndepmfW5++fwuq9CXaNMw1n4PranVRRBUNDZ5+PlvVQRquWH21D6WUA9w2OVHLpz43oNlkOJ7ekVHpCainNlT9BD9WeQ2sPx03ISkgI/tS4TEirjeQX2Z6zYX2D3OnatiivaFu7sxrwEUbkMIL6hfjeZQ+Tnq5ZSll0q0AgVUegBxc7lW5owrSoR1UA8bbcuubZ98r365CWARa1P1GR9On/75MD2ydfK5ImgdTNoVGCzOzeCpWsE4xBcfTfivB1RV4X6ODeChg2hF9+g2wP8LQ9GCo8Ym0eMzTdw9hCY8QjMeEORkT9krlS8HoxlfNkvwu67m1ICVp66Pa142AaxKmqonmbAMoJ1nXqSbBRpibTp0OVdupPIuYmifqZePhN1ghYBNUYJK7MpYBi1YDK04Ft1oJB34AF1A42m46avtxXPlzq9PTcnFhErm8zKPEVPIa8bdrjUX12PPfnTk8ySVoAcKzG4HT+kjsGc0yWmcvbBVWk4lcosIhjDzypxVmyNIRbZhoE5yZm6lNaL5xSV1LaUyzXhigm1kioAH394t8I/VQ3cmxzbpqRin6fLf1+7cwnIb1S30YYPLxu3DpK53DqaWt2YS4lJQrTVggHWInLp0qFgHcU9hPtE3bTlZEoSOt52Owl6nMqij0auSofTwIEiN1jL9CNGqaXzLBNonvZXnoeu09xOBgO9zXFF5D03zLFJZjV75RW1T0sV+iSBsP0pNknUNCNs70Cd7PrcdykFpd2AnhIINrsBIwA/cwMc8wFsSyOYAnkSen703LWuNPAHtSOoIp+6eK/hpvJ09h0PXGH41AD1Y51gbRViuuNxrEnSgvkM/6zRYSogxutMPq+XU9ijC4tm8U0HhamgTSU+r1/HQ7REdxGgcP7LVJ+MHTQUUvcZHqTmCAXDT7GK0YbtFzdx1Py+Hv5WLI9WemMUSrTIWPHcSCuspYbPMnpDDcq0NS3Pmv5CjlIg7AaU7w4E3yCPNmC0N73NKbTcOwktEHI+FeCCkbKkxJtP7SQrjKUqDO0dWlY4SuRzOX4vtcQVD6+TmtIM+YGpzRrEPY7PV81d7FSgekDCeaD135dr+Pr7P3P3+I/TbcL5l1Z52yv4AX/R1BiXgNUVvSiNMgbb4i1MFrUsZPyroX6shECrs90rnlFqy8rxtapoZSJ0FGxeEVPDo0qMkO1paqMirYyTjXJ+bE9jxlLUzJrzu8RwyXRPTxsQS0ERaVpYJqOq7uppoK0iZmVzj7IA3HKcqJRVdTMHidi0nNRMCqrB3CQs0PYUMFoRU3k3q+aJb9ifof29WuFUe1clrR5skKal9TT5pcS9ftdWlFNLk/qudUkllnKUxohdrK4fpL3ok8lES09RP5MsbemqiiHf06BrHPp5O0/d4LnXJDUkT5EGWTy8ryw8WJtgMHIN3TbXibQiPlUta6iIExpKBzkJIa8nl7hvKDdyBQKsiGz84r3ToZWSVzPoLPDm+Mf5VJj9CiXpO0oRe317K0xLhYhMGBvPS2Ui31+xwFQMiSrQOHCJ29YQhJLSzfCa3yiFkFt2jaoVoRxqUQQlSFIxZMCpOlpvMAlblX32qre9pZD7iTyxzLqo8njEXWkM+PonMRYTcjkrTe2eUgcUVr5VhIdDbpBHLZJr6bNbZaYPud0FVfm5CitaD+8F95mkvRjoeQ/ycx1SFG+DFjAwug3Igy0H026zqstez7kJDwj5AL+yDr04HWx+tCezLnefpD50+SDr2J9MMLXUDc5yCHG3hAhbR5OHNTlrBm9FuMCRuRA2FZTXAoqjDNXagVqQc4Rld15TeUqdZynioRKh6WQ9q8mNfAzQvoLnmALfg5v/fgoP9rqfq16pgviC8pSuhoq00hYxvcKLU2X2ejL6VBl9G/j+nQBlNM2uWEQN9UkyLK3k8FO2A7pWoPm5MwAEGIAS0QfaoeOoQ8fR8BTopsp1fJiRyPmklrPTRGH0W39fFGJCGxxyIdLi9sn3/bV4Zb+IklesPoZzUmhhK+ifyvg76jBMUni01yvuX0chgJOYnDqdU/7Ktlc8lPT7bAcHnCq7Bpllm5vTUUv/trsHW+1YM1iMUyaXoSxMQcZRR49HxX80YgU6arbNMgCfWk+U6hBA3fMpDBdp527aevWjinzQ2gcxPpzPkVe+EKOCpjQwKMREqo3gd5QQImVMUySNkJNaEBVydGHdxuwmObVK1iBHVRzSc3mSwxicWkUj0FHSz0lInJaP1Uc2Mmfst6f37Xr/XnN/taqQldfpTCKmetD1Q7QKr8op2SYZcQMFPVECefyoQGJU9S0ywmrTj6CcFmZJpMHaupYW/kgLHKexa9ZK1QjG87rsOd59eNufTzFvr8lcBkW8QNn5JhkV8theDaehoWl48L5ry0h1jtsUAC6TCg/coHgC283JCFuTGpnyIOWn4FpKaeT0it/EUVLvICnC8KMSnY6uKhhJtQ+jvsYi6uu63/1+nQs2LdOqJGFPvcAoRYPgG8WQxhep7vajOoMYQ4/dOO72cd8VPW4GRetHw/tx9PMjWOfvH+H4vxVHf6tqEjgD+FpKpeRCTaDhXaeEMIZxVQBPmm4SgjiTtVyv47+Zpm2WBvlkjvpqQlwlQagaAwwUhBeFfBd4HQV3Nyj0C6sHNV0JC+A5vC9J/rXGk3jFf2JpdA8ifrJ0NXaB9hhayVsZuzJwbLg7kgSdDoUn6VXhtXU/PcnpsCJJ84o2h9PtJhFT0Uyt9qSX4BjeIqomp9Sjvlcf7Md5qbyUNNvR19Og0M64DathFrpa5F7VgdvUAsiA387YVKVmLOoR0UrUgLjPWHQpAoDPoD7b9D5fJfceGB/bbJxPhZViZQYOFeM9MJAtAGuIM7o29ziCT9tRz7+eGpdYgdZnoByuUlGv41xEk+Sa02Okg+jQR94NlDZDiloFhYwCIDoOdJ2k1MERihFroLnfScJ2CE8sMN7jb2VQymEoXRzQkMHnSte0EaxLfEQW7qjt8hX4iHgNWXyK3+EAP1RcQRl63vBVnh+f6/UzqAym39imz48yOCOth43V8FFDX6oyBU9DsLfd3xWFhjGKmwvxtw3HABGHaQpTfKa0GVTTPTqPEj6ubBeprmh4aCv4oUwDKDxr0QTUtogauwzXQ+txLDfefKm8/XqDKnoDikUV8Pdj0eBBzgJgL/R53tS66HuVRuF78rSn1Dhe0XPxYsab9tJ6ua1tw9/8pPkyFROM7ylZ5+10Oz52b8dz4TKofle8HdjtvDtdZi69GXirc4nyGWi+5nb92dZSAThHayCkqHVMsVcy6ExeD1PnjCJ6p3hfXaq6NqBvMz0ULKoPwoGdiucbHszC/dZkhiqT6Gi4O4uYQ9ZahlUyNqauCgHpW8Vb2gOZS1OjQVLR4135Yi5ZAGZDM17XVm5rFBc/92KvNQNX9WwOXw0VYRTFGORUCov7XtV+UaxvGP3f17VeV2BUYYHjCK8gZP0iisrXc0v9egg68FmWyvbSJraWZmHj8HkjJXqk2psMqu2X48bXdW1I6yZZWBMJ5m1wghiXzDsD8kfjQRji05ljUMBsWn7wRyypZmWWQY6wJvkXvRctpZXD2mPPJxM7mE18bT0Ky6OTM+l7CgS/FY2trUTE8Vbkcdi20SlepqWQhVuss7kcTlHK2+50pgAdCfjyTUvnNBKd70uaa9Ueyne0UCPn9yq4XhXzSp5Wm/Z9m/KZLf/e9eyhapkxAP9vUYPFe7oLic9rpcdko4rPDQ/NZzkzS7dWLpI2w/00e+ED/KqAdzsFzu63PqAS8mtF3N0pHGrPVcR9apySWPgK30q+Evrjek7vu0iLUBAiUdWcApzc0erT2/30FRbqf74VpaUCsW8EvO7XGMGLcF+ljL32keiRtgxf1Qf0CnNoNj7TJKCePpTfx2xsh6m/wvW+ZgFQne09p25YRDyuZZ5N1oqE8XzFXj9vz2qrY7knE5p7AM0W9+MmiVVrXXHPUAjeLGA6pIsQuGJCodwhC5Oi7nuk/K2OB/3v1+dVT6RRCUtuoVX65Cpufl66uNVwWqpt1OAYgxMdqAgDGiVjumw1J5usR5V+z3MHr9/n0z5YvVNBauzLVkWwKEqJTVGrjS27Z/PvXwCeZDlfx03U1w+H8SAPY/YVV2lBVUjf0xjWNO55rXUE6BVbdaohs12+ooZJlBpm//BGMh+qVS5XMxtGs+pVxTuSTRKqCAyjGHZdT6NKK44CJ6NKAzXrpnFbxYdCT3YU2TpJuVyfj7A+HrEKkdlYqvyTxjImcdumksQkUvTRvTDThlYViCQL3naZJ5sez/fdNynHUn1eaFuBML5K12usigsPKMxvaXomrNjCEFetPijXeBhXjXsr3mGOMA3DH8V9VcSF4sbjwOhK1W8urZqWApUKGZVwuDK4uI0cBD2vceezTa8MWr4cDm/1DesVdTz9FMddEW+QGRp60zAqNmmZX6DAVyhowsY6hoyKOa+4eoMQupijkP19xQMnLQhqNsfB67JgL6Gb3tEgQQXpJnORA6JXYJLceokYBwzzcNwVrXt6BX+ixlgUcb2c/9ZyK6pIk1KbRwm33f7P7v1YdmMJJpj6GpsTWskMeOWfOxrNi8MTtZ0WoGahpXiZbTiIfAdHSxyCl348fR0jybbW2KrgCVSlLehLe+r+BJGnWwQRqY2mkgs8yTOzc1TLVZTlTz3nGCYIQp7sJFSljlznllL25wK5EkSpyiKac06iwp6fJNWsOLkHeXtLIYkgk0ZpV1tecJAk6eovGVMIg7ceo8DGSVvWu3ZzZFysxWiFXKJVZxhdLnWraJgoAngaf/8uxrZqLN9qYWwtSBp7oauNtvH0r7ICyihneEP1vt2PD53Cla44mIlHCmi7H9+PZf5SIhJbVLV1ILXmeKpJ2lzscH+dCwWsaEo6iluaZaxHOzWa65i51UdJXSWNdk95AtLoMu9jZeKtowH7efjXCqhpJS6pQ5za09I6KWirX3wrV6nhpXZJXoXcs1egBcoklSQU4wdVAe03tPc8fMpsltOjWrAbB/Y9R5MaQdyxgPwZr/DALsUOPOR5Bz4tRyOai+R4gq70kVMtY+zG14vktFNvgCK/rzqLBTOGnzKLhMef062QoMIzG4fL3LJWzbNVAaUN+2MeuyZplof/aBbHaKQZgyDo+qU3ksyCgwzc86rwWcTurFadlW1z+o2zehnL/Dy59Ad0CWxpSnEW+Ht3qEBGFCNjs2FeRhEEWK+eiPc6n2Us3bTDL+5FE5X4aaXPQymKZkH14PagzOWUR/Ptht6Owqb6Fe1IqbQ7+Pg9BWzNgqJDpVeOrPzcsPLS4CKsJZncaDhsHp1qUKuMhKoC1fW0VOYeO7iH7zP9qdJTchN53pcouNaR0Cf+rCw4UNbBxjzGvM6M+10bvIohfMMeXDN0G1WA6jqQ53e5uT0NdvL+hpq1LgEKwfBkTQ80UFqNzmYafgov0XdkQQbVinLDPqjKWpUoNqr1i6Xw/ao8Ag1UdSIb6//nLtJSBVOyGi2oHilSy4CW1FYl1eJFUmnxtFxFXBXdqbCU3b/8BCRhq4CZ/Ub0YVVYolm6Ewihhd9s0SSD9zdYxB4Pa/I8xRKA5h586iZBtfCtzBZkAB66jjhaWrP0Gi9O6FgoKW0lmofealWuEi9cz04C4tRk5J7ejKrym6/S4MVNtvYlUlqwrosyMW63wgRBWrVEoVfHIS18UwKqIHmFRNtY3o9Y8PQDqYI8HDesuShqBZBXMUYLmI2lJeORFuEc7LLH9IYr2jtVlUaz0YuQ1bnWqXkZKVh1GU9rEFQjObP1maIYyuGnygspnnuRspkeV2Y/zfIvkrSl2ynkKs9kL4MfH+HIj3Oi57VV87qxSFZEjn2rEAYbZ9c8tk4Q7KTFMmxYPQstd9k4VFWcOr9huHFeb0Wq42h2NImY2lXoOJys/AjmfgI9jxv6dekvp8HIklQrEfQB2Jbz5tiNqWAETd2SV5w7RuXGEcOGW7k8DcF5SqMSxAQWvdesyQdfaghg7Yabz3rrOUUXP9AaoaT5dDRGFrOgUXSXUel4XN5K8EeVKj25jfzRLOV5naicyxr0QXkKFMeQpFSyxZ1YJqgGGhI2Aj2pLKqHLFhf7bD1XTQfSidPRZOqk9zSxTtioih6Jch6ncvae1VeThsn3o9f1z/H33/f77uyMFkx8MccYvrI2CM99kbPlVlhkgxSqnXcdg7j6g1VvNJB6H/sc/0U2GtbtAbpuWktblSrR1YVMLyNRxTzr5C6iqqZH0JB3IozwDhFSk5xLWnw166w52Wk0W1ED9ZgZ2kRoB2P8ajg46SrkzDU/evIqzR7PLdTOPOP1JUc9qcErHj51Mk6UGANDcnL5djxXH8YHpsQv/45nU+7+998QFdRNoq2mZL0lULrojp1Zm+L2jou5CNxqoRFUI3tVSW1xzaXMNAPV8y25PRDf8CRr+MwvIhXWuXR0iqMolNwp/rZjnzjvS7780mPVPB6nhuYRj7+XvZ6tCK8oVVnsXKI5z9lO3N6EMzFR4fjOexSrCesBj2JnQrf0SU/i3yffKeVQdspZOYANc5LgR+7c3SdLjoq6WXIy1iq5h/hT/LiLlEBjcwWhpWe1lZD98tjF7s3/k9M5kS+Bu1pqA7uPQ2Frdtl9Z06bVJ5U7ACEoKqa+kb7q/FeaHwuH7jXY67+/7jdvqsMRJYVU/Z0Qq2x3F/18aXU2FrcPQH05rtgscxGIOHhXyatsdUHY+pHmKySv3fKSK6huLuHlMwWuM4ZA2PH+ENoAkstzpmaWVg20uXxJhEQmgMzdVGOVNQIbaD1DEFqWwtzcdEAY+wgv8b28GF8+NVQEMapfYbip/Icl63w2p7qWh3Q4GbUYjGUg+K3M+PwDTmHkPUv4iMPTEMWYXbKxgQh8SBaLhG/qMiEzRdVWc9HpUd3KEpeEdbxQQ5X4VtqoqsG3oszSPD9307vb/W5NJKivtBSrUT7qgeg3+PKIBua9WtlRbEFQ6e4hTtE1BuTNM5omM5cpMW3J4ODnx4aRQQ4SSyaG5h0ZsTKXEHH88hOe4ckjeuxd916K6Mfsw+dwVBayufujB7jz7sfmPXPmn+U+b4qIETBEykyUpfy/TgmMoAxhHTBTYKv/V53s/X35vhX7mjG5pYjTqtlnqR1AC8LiGODj7xad0UVu57T/FQMZ6w0DwWSVCZNqcFelPAmGbpVC8m16OtIxpBuD73sUIn7iFlEhx4at2AxCGYgR1617shj007ww0peuRGGpENTx9ttymS/7U7F7aNKminBZ41PJcizjOOIu9puwgZCw47OjmfA+3HEiStO3PJyafm8Mdur1E6krbIosQ1KAlcUVKASdjqABlUHLNN+992+YpGj+rx5U75VzRfhMHVWp1OcV4PFF8DKSleroXILzUmg8iM3Ab9uH4Hu3z/Jz5S8b3EB2uTBdAl6MyQFOyQ8ibWUnDC43TWDAu9OobBIWubFN+zDUrtm6T/LK8ofkyk+bPy00e1slr5hw175nwEs+cM5V5vBKt4h2nwbZYWw0E/hBvcoFKNFGQ6C3zO3Vj14lO0ABx48wgHv9oFilQaTSSDfZaAZh4wNJ8oWr3PzPRNwhxxbz7es47CUIy7PSVzihCyyXy6f660eaf6jA4tDA4az5ro+msA/U7VW/PDP4+vdQ1rW1U0QcFGj/PrvZbGlg/Bp3RigSxO10EmDm2LPEnLbdpJTBnj7RtlItBs6jy6hFOqxryeJquD0tLxbtOplrO8pck08teurBvyajCfuDh4jSXqFF6553oyj68UeSueyp4GRGchEedeDFc14hSANA9fdantVFkEby8zHRfBNSvoMXWVkadp50fcx4ddjJVNvXb14lcz0FGc/TogpepuFz0DmHGTL3CFztXoG2+QgwjOIfrioqtVC8q5Dmw1nUXuLPE4mS5xwpkunTimT/6uQXteg25+Bu0YrE+nocWz2B7JJIum6RZdeG0y9J0zcF/wW9fCuUF3wLbPZmoyP8EuFcxUGJ0Gxim6uQzgu8O5HcxU9B0ckutj0knswdcevKZ0JCAw5nnf7lrkUpbpO4/gGhXB4yKjOrZGWlQ2i+DkodJzHikaepEyBWeLwIoMzjU8FDIJOMW+ScVrKPZSCmuQ42te2agaAjQUhjXLeYQX2T9XPZBHFdkbeUxGhJlY+aqqyaXnhxC0RL4LCFYjPZbwXvQwEZJW7xWkWCXl3zwPb1LYKtTS9pKZZa24KJ20Rgdu9pQyVvhAmQjgBO9Bzvfl+3r/U4JqZFjQcBzw43bcx55Y1ebQMo/QUdje43Y+PYOzsj8fd9oZ96M6MXiwPkqIP9zNNObPkku9V44xTUoFJ0fvwa5VKSKDSD9Ff00idjqtrujBPCoJM0qyo71GV+mQQRWr+XR8BGGIUqagUDDOqc6IYiux10EhHdpk3QenbeN9n8d/0SRPyvW0sjRKC3IidC78WBshg1XGI1/RWUbtDVUrwo1g2SRlppMhYCD5OLynxCyoHudWnV54+H6SIOqkqj25ZPhmIzgxyVrc1mqvxkEay9bx0PkkKdXxHi/vwScuctsSTdZyY38W9HG/ftdnSYqxW3v3+Xrsr7r3i5UIgj4RovWp6g+NXhHos+h95cbk0roxWYJuREBwRCJyRGh59BiLIDOoZN0IW2pET5sR4Wv0FvFNYofw4Eb0DULQTQow+gbwowY1YEiPhs0PKS3+rsPPOvxdKlkJV7jbgCtYcwZOv4EaNHD6DU9NPK/Kk+lkGtVsBDrXoRXVzR0hxiG91JCSB2Myacdke4+JvSoWMi1XKN03NsUpjAMBtk/mrumAruobYKqQMB3BQT2CkmfEiBGJxxbhqxZuAJwJi3vYDuC8Hn/X47d94sj2Jt3N8z4M29tcdWCgBYNKxtyl6zBVcRRmnZUZN175txZX09FGMdnyBOssrCDB7Hp1ZoMicewQ6USV1jhiUdOi33+DHFN5E86PuIiqiZChHaBIcZQbJKiCFw2flQdf5vuscdZOpsXDO3Ozo4AYWenMtGlO2+QXt8nZbFOCA45om5Zs3+UvkXm2kwlkwOBukG+1iRbLWpeLP+BEI4blQbM8JlpZ1wKf0QGN1G0c0uF9a+lTVbo7pre0lmN1oqQCk2NUIRGPPVaWhep7AGp7h7wfL2eIbCv752dxHnYK1zdYvk8jV8uqHZ9i7rGUTymOvgUH6XhZVasYBVDyKWTjWlqj93j9PlxjvTAETlTga/B5BGUI2S3Fg0JijrwTE081juNB37U8EsmXrq+lsMwgbzY8f4CjSwPLGu5DcHGrvjzKTjeU2QkiC+JcxYPMIxavFc2JqhoNOwZkkzyLPHdfXgfZR5mAsbwTjRJwvH8VfXpHyedge1rAUCPCUbBT/pXjwH8NOpXZEO4/TTJ/WtadosvngamZOXX/cVxViijilqBh+dKbRBwz+VVZVq5iUzxnn+RABxTBQ5VXaVMI17fJTgtXfDUusud+OBpSIA923ghuEVHiWWVkqaPNztPgellQUBqKlQFl/BYUr4gSe94g9fE9N7KOuYli6hrFIsNXwyzhLfJIagFO0T7xfNLfx35VRqloUZdQfn1s8DQrtEYSlBecFaahn7s/scL0Viw+uYgbyiHzDFqyQE/KhOqAfjScGXcWQTrIqvlfbFQQS6LGJBz66WqANQRsrh1oSme+96JzH1dF5Teq1HdH90h082sVH6NCXnBK1BrdV+9U2RwKtmzes6lExLeZoIFm39I9fn3t7qfIOKdvpkq33E8PeqBc/+qNLV2xEPTTGS4/gKWnDI+zeBX5scCl2lR8Z2CTW3DKhhulWAQ8/OBHJmPMoAORScCN8AlafIKtZZKfcl0D7xWRckuzuJBTMyF7r8wetO02lGQliSu5pY1qVOVbau5IAdOfayFOCflpaVUoqhXpnKHYqyShhixoOsUj+eMnWtVuqd5v4TVAC0ppNpMojSNTzJItDR9i8JoU0kv7JNwf6oDi22OyXeO3jKL/oI5KHPi8ni5FjYBXKA1qlUSFro1Y1UyNxpbjuF8fz099Fqq+cL6luLlp9Ofu/udw/S7SJb3aXtTynCRcXDF2UGPZKT6Nfb7uz3IrqRQL78k1xXlXB3mr/OyOYsRi/+HC55NFe47HsZ7X/e5yvZz2sfv6aV3Krrj4Or7mr+Ent+sl/Ozxn0cJ8O1UBxWO8J3rYYv3kMaIo/mW53UmRioZkTo1ms7+dW5EpHM+0mtDgabtDNJTsDJ62grmef1zvPzQ3VtxQ/COvM/rORb6rsCtCgDDN9c1VrZXy1O9aofsKFDweY1/dFhBeFrlv/eUDS6MP36vYieKic4io4DQlrM4dR0NRj6vM0Vo5dkUvIjGPoKA+ymczrvz+gFH9YCAlqcgurPAMfPa4Of1dlJ1coOi5vTJ2rBtZsPO3KoUmhXEpj4olVdX2CbqpcXI3EzTV/hpypel3ACJwPi5U8fVoGAawMB6j9yNh0HrE67Fcw7x5zUdjSXFQ++VDUuDAEFC0EsVKlmjvG1PQ4fBS7k83q7lNKvTpeeWbxodWeaPh3nSSoovxRNI2V0gqtp+TSECKfwj3P7zfNzFjvOP8+7xUWjOVlG4cu7+KCY8zulM5SgGE8o7/Hwqteak1TWmiLYx/OhYHb1Dr9DvNI66qkaR4IoBjPR+QMqqwRVgBh1+trTOmKDwaf92+LseXoVDUYPn3yg82kGCCGoF5dLVD/Lp6o+y/h0pmjwzOTPzJLAa1lcdyvhxVt+MjaJntNRQfk1d3t5Ke0la2RzQ8rqgYyZrkaAq5Qzdiq9LnMifeomoGdmSVM/0yx3NP8gkYLMbp2q5Rr26Wc5m1wexsziTYZDz31e1CFHRqVMnJIzX0SUJSRtAmNHTnFMU8Ov332e5QJ2qBafoqdflT7TcgsVz2sXFShI3Xh0eKeXmPLq4tiiCailA+HWJpxprANrKKE1QqXzGo40Xo4m/d/s/JS+14uSmVf2vy+f1EMOth8fpUhBUN6quGt3qHHAWrqFu/uvyOO5fUxO4x3N3ef60Z9T5w6dtFjpNXF2MXKpMzwoxMz7/MTVI2l/1mSSx9gMFdgRhKXI+Ab7rW1pqF96aV8jCMmT6SvXiom7AutLZt6rqGo0QLbK6HaqUNjbLJBdFQGkNrcqqFemc66lHlhCux1t853m03naKbYQCu4Bv1bEML+FuQRhdtdNwgTHTQkYlZHtuprqotb3WSDvZOa5NJyHhyKvNRavmgurDhNKtf5pWUtN4zrU+i6kw/iqQbw/E0A+vNAmqKT2jqHZoaDphfTc4E+VnctQFBGj44/t4ev94lik5xQdAHb1ZSuLSXkpKlRoZFUdVAo0FLyTNmKOQx1l4TahEjwGgN1Jw4SyIbS1VckDxybOMNZjGqPN168OFbRnJklfsqYNKv/Ceza9bWRzgVaSp6QBWQ9fl3uCKn4H3k1auMkDiRvRGGBMQx40ogx5b4B8H/HbMyEWgCoEWbCwwhw74wi6jD4FwHIEvbDK+kM5uwfivYOt8zK+J4EXF4Fp5WJmO9vEJoytJf6M4kVuaCnw9VgWjMoEzUIqGV2GdeqdUO22OEMdFWGzNi1DhSm5fPtZ0KMbLx/acvOoVu1l+ww9ZV9wrEjfQGKCMnuY1v7rP0/vcIJDxVij01EAJBeqSVmQ0yjgd6GZdYp8l3Y98SQTU0tvSot4kbIo6P06lkaFKYDoanM1SlsbEhaPQKs4DSmCaxByOb9M8lR6CUx4CrXzOYmJZz7rwySiwoeM9IpMggpywinG9pxVcSQxrbxIbcMoXQxTU93mRtviSdL0ut4m1vcVzynnrafoPAgRwSQeC5E4CCMZ2+Ypm0JLsCkGQUfVjvH92EvF9en6sEzyKX7fjW3EWEk59VpdnmkbxgdE4ZL1dnjqzkw+Atg2Oc1ZBXCWtrSZoc/ewraPaa3iqiddGyKCjoPNr9CgGMoBQcKjCJDTHQXSMUDK6UBraQkLBLS87rlJCukmEzuGOKi+VcPHep3Jbn7l6vMNV4lXxnqKB5nsdn8XtvLodovcpKBtE4xEotHEWXaFqM1azRm5+jBW7aKPalVhqlGM04e0NglQnCJpn+tpd9MBOtfvqaYihDr5R+IaNg2Ee+zuMK3MGncxSmpH6/UlGlS5WAUcSbZ/lNUVJWHRESlmq+osG3b/2u3vBZGAVASElDv463n9fNdSuN4pTDIj5BpUiMKJtgzC+oammyPgVPWRlVXplVVJQ8TRW97YWCyudN5uDE/+fJrqSUZqRK8JJwvGf02PqL1iLWI6S3tMOSE1wZ3EWug7kdopdlW6Z4AWz4jyFbqA5pkVCWc8id48ZQGgw0ATg1ykcwj+UCzr1RHSaT/fna50qNqppOK93WYbXUpEqVeBoNufr9DgV2sSrUhkHUheOtP667ne/X+ddQWrRypPJ80qKPDzWABWoBMXlzeERWcY6fa2KnLmznkVU+ieonkk933jX06FK/K96y1HwyTx8xZ8kU59B8fB5TKOr1HOK7IkWkH3v9hMOmTQCHRpFYU7B/xUxpb83yDSMdRQbm0RtNTWXbPk0MvC9Oz2Dhz6zBz2vR80gZlRvOcfj8t+7u8ZLNooCErVSKAa1TY+rAYYjBYJ/R1fpLbxyPeAvc168Hc338fduf66l7uS5SlFkYfjH9fon5hwux/NEQyS/nDTILWdqXEspDa9Bcf62fE5mScfPU2koDL2yYik4ZZEwJXj0eGWW8lVYDlScX6D3Taksg3VgwIdpHBg53YioNurtbAoHhnlIa4iXIE7P82uxhH8Rc7S1irueRuK1sPIjKexeBCJuSSlBNa3iuXAU/YPBxVmoeuAYnvjE+DWBf6MmAX0bWppBn2St5cgYk2kRb2/xzTk2ZJK4Kvp0EpOIogMDczP2lUtXWDAGJdTO5SvwMaFBBUgVDYp0wgNurIA5Y6k1tGp9BXA7B3JDTNzs1d2qGO+2vmaWUzuGpK62HEJdk7OKLwy9QpjRGI4SVut6OQxKm1FuJSVoWhWFGEUSQutZIaZeMT6okgyePoEYou1HxUjXcsuhIqdUJaPiW+4oQhSyqiaIql6ngfFSxvq76x6WPy+ikvJvUMAwij/JaIAfuKjlmnbUcZ2TijoEJEk4aFgm+CxhsV1qBqY8AxvqkyoBVRtTAShpDCZGMFOrvMlFrbRKVtQtNGIeJVUGqzLg3HcceS+XVLbn/UWi6HobZwWHtT0CgAOuUpbFOxB4OETQQL7mHUhCUHUfrvjne35Mtm/lhRWDKTgsLIJsFjQjyImEJ8KzpaSjd6lePDwHJou6nzOt1efusisWVCcDKYZjCau8WNKX7ylF9vd9d7vtgsdYtMhWjWmdoyVQ0/hY73o73ZdW25jclfemKgj5YtQiq1FKOTHO0cqXRdQ0bAZHruOdsi6D87wtkjgnuNxofnu6IwHuWnkoj6KhEc9pdjUuQxqGdInEYYAD6fiTPEsGROaGxKNrxwQRD8s/MV0AA2zB8m5H0EWOyT9zDQ1aTk9U6ess09Nb63YZXRbLjSq7NACzz3slzqKu+9f0UzUzShS8z2HALIB5DCAECzIfixYCNvOHjGAnbmjQcHqgKkWiYlIA52V4IEw8WsWOSTdbYCHCA+HveoQZwezUIDnYcw9HPtpq6mWrITughIK3LPr+/o4J942QhFzdPUX9/vMog9dyO/Y0bf03BlPC/yqVip3y1gb6CpOI/flUJ0K3KhdPw26TkNpDqKZpAy27ncZXG6QpQt0ggenxKOGrOg3qCepQ1//zv/6/2+kWC0HCn/3v//N//+//A6+EGTnkEQ8A"; \ No newline at end of file diff --git a/7.x/docs/assets/style.css b/7.x/docs/assets/style.css new file mode 100644 index 000000000..108428c3f --- /dev/null +++ b/7.x/docs/assets/style.css @@ -0,0 +1,1383 @@ +: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-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: var(--light-color-ts-type-alias); + --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-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: var(--dark-color-ts-type-alias); + --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-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-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-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-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, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-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.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + 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-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.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-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/7.x/docs/classes/AbsolutePathInteractionRoute.html b/7.x/docs/classes/AbsolutePathInteractionRoute.html new file mode 100644 index 000000000..9e1b1bb96 --- /dev/null +++ b/7.x/docs/classes/AbsolutePathInteractionRoute.html @@ -0,0 +1,159 @@ +AbsolutePathInteractionRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AbsolutePathInteractionRoute

+
+

A route that stores a single absolute path.

+
+
+
+

Hierarchy

+
    +
  • AbsolutePathInteractionRoute
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
path: string
+
+

Methods

+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AcceptPreferenceParser.html b/7.x/docs/classes/AcceptPreferenceParser.html new file mode 100644 index 000000000..14ff971e5 --- /dev/null +++ b/7.x/docs/classes/AcceptPreferenceParser.html @@ -0,0 +1,181 @@ +AcceptPreferenceParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AcceptPreferenceParser

+
+

Extracts preferences from the Accept-* headers from an incoming HttpRequest. +Supports Accept, Accept-Charset, Accept-Encoding, Accept-Language and Accept-DateTime.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AccessChecker.html b/7.x/docs/classes/AccessChecker.html new file mode 100644 index 000000000..59aa038ed --- /dev/null +++ b/7.x/docs/classes/AccessChecker.html @@ -0,0 +1,175 @@ +AccessChecker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AccessCheckerAbstract

+
+

Performs an authorization check against the given acl resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AccountInitializer.html b/7.x/docs/classes/AccountInitializer.html new file mode 100644 index 000000000..568f54e45 --- /dev/null +++ b/7.x/docs/classes/AccountInitializer.html @@ -0,0 +1,224 @@ +AccountInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AccountInitializer

+
+

Initializes an account with email/password login and a pod with the provided name.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accountStore: AccountStore
+
+ +
email: undefined | string
+
+ +
logger: Logger = ...
+
+ +
name: undefined | string
+
+ +
password: undefined | string
+
+ +
passwordStore: PasswordStore
+
+ +
podCreator: PodCreator
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AccountPromptFactory.html b/7.x/docs/classes/AccountPromptFactory.html new file mode 100644 index 000000000..d6ab19b71 --- /dev/null +++ b/7.x/docs/classes/AccountPromptFactory.html @@ -0,0 +1,252 @@ +AccountPromptFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AccountPromptFactory

+
+

Creates the prompt necessary to ensure a user is logged in with their account when doing an OIDC interaction. +This is done by checking the presence of the account-related cookie.

+

Adds a Check to the login policy that verifies if the stored accountId, which corresponds to the chosen WebID, +belongs to the currently logged in account.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cookieName: string
+
+ +
cookieStore: CookieStore
+
+ +
logger: Logger = ...
+
+ +
webIdStore: WebIdStore
+
+

Methods

+
+ +
+
+ +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: DefaultPolicy
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: DefaultPolicy
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AcpHeaderHandler.html b/7.x/docs/classes/AcpHeaderHandler.html new file mode 100644 index 000000000..ad2500681 --- /dev/null +++ b/7.x/docs/classes/AcpHeaderHandler.html @@ -0,0 +1,218 @@ +AcpHeaderHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AcpHeaderHandler

+
+ +
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
attributes: string[]
+
+ +
modes: string[]
+
+ +
+
+ +
targetExtractor: TargetExtractor
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AcpReader.html b/7.x/docs/classes/AcpReader.html new file mode 100644 index 000000000..d33210bf8 --- /dev/null +++ b/7.x/docs/classes/AcpReader.html @@ -0,0 +1,326 @@ +AcpReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AcpReader

+
+

Finds the permissions of a resource as defined in the corresponding ACRs. +Implementation based on https://solid.github.io/authorization-panel/acp-specification/.

+

Caches data so no duplicate calls are made to the ResourceStore for a single request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
acrStore: ResourceStore
+
+ +
acrStrategy: AuxiliaryStrategy
+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Generates the allowed permissions.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: ResourceIdentifier
      +

      Target to generate permissions for.

      +
      +
    • +
    • +
      credentials: Credentials
      +

      Credentials that are trying to access the resource.

      +
      +
    • +
    • +
      resourceCache: IdentifierMap<IAccessControlledResource[]>
      +

      Cache used to store ACR data.

      +
      +
    +

    Returns Promise<Partial<Record<AccessMode, boolean>>>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns the data found in the ACR corresponding to the given identifier.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ActivityNotificationGenerator.html b/7.x/docs/classes/ActivityNotificationGenerator.html new file mode 100644 index 000000000..ca24c6862 --- /dev/null +++ b/7.x/docs/classes/ActivityNotificationGenerator.html @@ -0,0 +1,200 @@ +ActivityNotificationGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ActivityNotificationGenerator

+
+

A NotificationGenerator that creates a Notification by using the provided activity as type. +Requests metadata of the topic from the ResourceStore to fill in the details.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
eTagHandler: ETagHandler
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AddRemoveNotificationGenerator.html b/7.x/docs/classes/AddRemoveNotificationGenerator.html new file mode 100644 index 000000000..7a063abb6 --- /dev/null +++ b/7.x/docs/classes/AddRemoveNotificationGenerator.html @@ -0,0 +1,201 @@ +AddRemoveNotificationGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AddRemoveNotificationGenerator

+
+

A NotificationGenerator specifically for Add/Remove notifications. +Creates the notification so the target is set to input topic, +and the object value is extracted from the provided metadata.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
eTagHandler: ETagHandler
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AgentAccessChecker.html b/7.x/docs/classes/AgentAccessChecker.html new file mode 100644 index 000000000..2857744c6 --- /dev/null +++ b/7.x/docs/classes/AgentAccessChecker.html @@ -0,0 +1,171 @@ +AgentAccessChecker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AgentAccessChecker

+
+

Checks if the given WebID has been given access.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AgentClassAccessChecker.html b/7.x/docs/classes/AgentClassAccessChecker.html new file mode 100644 index 000000000..f6385ad73 --- /dev/null +++ b/7.x/docs/classes/AgentClassAccessChecker.html @@ -0,0 +1,171 @@ +AgentClassAccessChecker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AgentClassAccessChecker

+
+

Checks access based on the agent class.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AgentGroupAccessChecker.html b/7.x/docs/classes/AgentGroupAccessChecker.html new file mode 100644 index 000000000..5b77e3f41 --- /dev/null +++ b/7.x/docs/classes/AgentGroupAccessChecker.html @@ -0,0 +1,219 @@ +AgentGroupAccessChecker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AgentGroupAccessChecker

+
+

Checks if the given WebID belongs to a group that has access. +Implements the behaviour of groups from the WAC specification.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Checks if the given agent is member of a given vCard group.

    +
    +
    +

    Parameters

    +
      +
    • +
      webId: string
      +

      WebID of the agent that needs access.

      +
      +
    • +
    • +
      group: Term
      +

      URL of the vCard group that needs to be checked.

      +
      +
    +

    Returns Promise<boolean>

    If the agent is member of the given vCard group.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AllStaticReader.html b/7.x/docs/classes/AllStaticReader.html new file mode 100644 index 000000000..ef9cd7b7f --- /dev/null +++ b/7.x/docs/classes/AllStaticReader.html @@ -0,0 +1,191 @@ +AllStaticReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AllStaticReader

+
+

PermissionReader which sets all permissions to true or false +independently of the identifier and requested permissions.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
permissionSet: Partial<Record<AccessMode, boolean>>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AllowAcceptHeaderWriter.html b/7.x/docs/classes/AllowAcceptHeaderWriter.html new file mode 100644 index 000000000..73a52625b --- /dev/null +++ b/7.x/docs/classes/AllowAcceptHeaderWriter.html @@ -0,0 +1,352 @@ +AllowAcceptHeaderWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AllowAcceptHeaderWriter

+
+

Generates Allow, Accept-Patch, Accept-Post, and Accept-Put headers. +The resulting values depend on the choses input methods and types. +The input metadata also gets used to remove methods from that list +if they are not valid in the given situation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
acceptTypes: {
    patch: string[];
    post: string[];
    put: string[];
}
+
+

Type declaration

+
    +
  • +
    patch: string[]
  • +
  • +
    post: string[]
  • +
  • +
    put: string[]
+
+ +
supportedMethods: string[]
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Generates the Accept-[Method] headers if required. +Will be added if the Allow header was added, or in case of a 415 error. +Specific Accept-[Method] headers will only be added if the method is in the methods set.

    +
    +
    +

    Parameters

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    Generates the Allow header if required. +It only needs to get added for successful GET/HEAD requests, 404s, or 405s. +The spec only requires it for GET/HEAD requests and 405s. +In the case of other error messages we can't deduce what the request method was, +so we do not add the header as we don't have enough information.

    +
    +
    +

    Parameters

    +
    +

    Returns boolean

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/App.html b/7.x/docs/classes/App.html new file mode 100644 index 000000000..0eff61bda --- /dev/null +++ b/7.x/docs/classes/App.html @@ -0,0 +1,158 @@ +App | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class App

+
+

Entry point for the entire Solid server.

+
+
+
+

Hierarchy

+
    +
  • App
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clusterManager: ClusterManager
+
+ +
finalizer: Finalizer
+
+ +
initializer: Initializer
+
+

Methods

+
+ +
    + +
  • +

    Initializes and starts the application.

    +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Stops the application and handles cleanup.

    +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AppRunner.html b/7.x/docs/classes/AppRunner.html new file mode 100644 index 000000000..fa9a1ebd0 --- /dev/null +++ b/7.x/docs/classes/AppRunner.html @@ -0,0 +1,369 @@ +AppRunner | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AppRunner

+
+

A class that can be used to instantiate and start a server based on a Component.js configuration.

+
+
+
+

Hierarchy

+
    +
  • AppRunner
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Returns an App object, created with the given config, that can start and stop the Solid server.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: AppRunnerInput = {}
      +

      All values necessary to configure the server.

      +
      +
    +

    Returns Promise<App>

    +
+
+ +
    + +
  • +

    The second Components.js instantiation, +where the App is created and started using the variable mappings.

    +
    +
    +

    Parameters

    +
      +
    • +
      componentsManager: ComponentsManager<App>
    • +
    • +
      variables: Record<string, unknown>
    +

    Returns Promise<App>

    +
+
+ +
    + +
  • +

    Returns an App object, created by parsing the Command line arguments, that can start and stop the Solid server. +Will exit the process on failure.

    +
    +
    +

    Parameters

    +
      +
    • +
      argv: CliArgv = process.argv
      +

      Command line arguments.

      +
      +
    +

    Returns Promise<App>

    +
+
+ +
+
+ +
    + +
  • +

    Creates the Components Manager that will be used for instantiating.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      loaderProperties: IComponentsManagerBuilderOptions<T>
    • +
    • +
      configs: string[]
    +

    Returns Promise<ComponentsManager<T>>

    +
+
+ +
    + +
  • +

    Uses the CliExtractor to convert the CLI args to a Shorthand object.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Shorthand>

    +
+
+ +
    + +
  • +

    Retrieves settings from package.json or configuration file when +part of an npm project.

    +
    +

    Returns Promise<undefined | Record<string, unknown>>

    The settings defined in the configuration file

    + +
+
+ +
    + +
  • +

    Throws a new error that provides additional information through the extra message. +Also appends the stack trace to the message. +This is needed for errors that are thrown before the logger is created as we can't log those the standard way.

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
    • +
    • +
      error: unknown
    +

    Returns never

    +
+
+ +
    + +
  • +

    Uses the ShorthandResolver to convert Shorthand to VariableBindings .

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<VariableBindings>

    +
+
+ +
    + +
  • +

    Starts the server with a given config.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: AppRunnerInput
      +

      All values necessary to configure the server.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Starts the server as a command-line application.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional argv: CliArgv
      +

      Command line arguments.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Starts the server as a command-line application. +Will exit the process on failure.

    +

    Made non-async to lower the risk of unhandled promise rejections. +This is only relevant when this is used to start as a Node.js application on its own, +if you use this as part of your code you probably want to use the async version.

    +
    +
    +

    Parameters

    +
      +
    • +
      argv: {
          argv?: CliArgv;
          stderr?: WriteStream;
      }
      +

      Input parameters.

      +
      +
      +
        +
      • +
        Optional argv?: CliArgv
        +

        Command line arguments.

        +
        +
      • +
      • +
        Optional stderr?: WriteStream
        +

        Stream that should be used to output errors before the logger is enabled.

        +
        +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ArrayUnionHandler.html b/7.x/docs/classes/ArrayUnionHandler.html new file mode 100644 index 000000000..3ad8c8398 --- /dev/null +++ b/7.x/docs/classes/ArrayUnionHandler.html @@ -0,0 +1,244 @@ +ArrayUnionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ArrayUnionHandler<T>

+
+

A utility handler that concatenates the results of all its handlers into a single result.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
handlers: T[]
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Awaited<ReturnType<T["handle"]>>>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: AsyncHandlerInput<T>
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<Awaited<ReturnType<T["handle"]>>>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AssetPathExtractor.html b/7.x/docs/classes/AssetPathExtractor.html new file mode 100644 index 000000000..b3ae4269e --- /dev/null +++ b/7.x/docs/classes/AssetPathExtractor.html @@ -0,0 +1,201 @@ +AssetPathExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AssetPathExtractor

+
+

A ShorthandExtractor that converts a path value to an absolute asset path +by making use of resolveAssetPath. +Returns the default path in case it is defined and no path was found in the map.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
defaultPath?: string
+
+ +
key: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<unknown>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AsyncHandler.html b/7.x/docs/classes/AsyncHandler.html new file mode 100644 index 000000000..775db8448 --- /dev/null +++ b/7.x/docs/classes/AsyncHandler.html @@ -0,0 +1,242 @@ +AsyncHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AsyncHandler<TIn, TOut>Abstract

+
+

Simple interface for classes that can potentially handle a specific kind of data asynchronously.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn = void

  • +
  • +

    TOut = void

+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      TIn = void

    • +
    • +

      TOut = void

    +

    Returns AsyncHandler<TIn, TOut>

+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AtomicFileDataAccessor.html b/7.x/docs/classes/AtomicFileDataAccessor.html new file mode 100644 index 000000000..71924f7b0 --- /dev/null +++ b/7.x/docs/classes/AtomicFileDataAccessor.html @@ -0,0 +1,438 @@ +AtomicFileDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AtomicFileDataAccessor

+
+

AtomicDataAccessor that uses the file system to store documents as files and containers as folders. +Data will first be written to a temporary location and only if no errors occur +will the data be written to the desired location.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
resourceMapper: FileIdentifierMapper
+
+ +
tempFilePath: string
+
+

Methods

+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Gets the Stats object corresponding to the given file path, +resolving symbolic links.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      File path to get info from.

      +
      +
    +

    Returns Promise<Stats>

    +
    +

    Throws

    NotFoundHttpError +If the file/folder doesn't exist.

    +
+
+ +
    + +
  • +

    Verifies if there already is a file corresponding to the given resource. +If yes, that file is removed if it does not match the path given in the input ResourceLink. +This can happen if the content-type differs from the one that was stored.

    +
    +
    +

    Parameters

    +
      +
    • +
      link: ResourceLink
      +

      ResourceLink corresponding to the new resource data.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
+
+ +
    + +
  • +

    Helper function without extra validation checking to create a data file.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The filepath of the file to be created.

      +
      +
    • +
    • +
      data: Readable
      +

      The data to be put in the file.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuthAuxiliaryReader.html b/7.x/docs/classes/AuthAuxiliaryReader.html new file mode 100644 index 000000000..e3c162ea7 --- /dev/null +++ b/7.x/docs/classes/AuthAuxiliaryReader.html @@ -0,0 +1,250 @@ +AuthAuxiliaryReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuthAuxiliaryReader

+
+

Determines the permission for authorization resources (such as ACL or ACR). +In contrast to the regular resource mechanism, read/write access to authorization resources +is obtained by setting Control permissions on the corresponding subject resource +rather than directly setting permissions for the authorization resource itself. +Hence, this class transforms Control permissions on the subject resource +to Read/Write permissions on the authorization resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
authStrategy: AuxiliaryStrategy
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuthorizationParser.html b/7.x/docs/classes/AuthorizationParser.html new file mode 100644 index 000000000..4e3701a63 --- /dev/null +++ b/7.x/docs/classes/AuthorizationParser.html @@ -0,0 +1,210 @@ +AuthorizationParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuthorizationParser

+
+

Parses specific authorization schemes and stores their value as metadata. +The keys of the input authMap should be the schemes, +and the values the corresponding predicate that should be used to store the value in the metadata. +The scheme will be sliced off the value, after which it is used as the object in the metadata triple.

+

This should be used for custom authorization schemes, +for things like OIDC tokens a CredentialsExtractor should be used.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
authMap: Record<string, NamedNode<string>>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuthorizedRouteHandler.html b/7.x/docs/classes/AuthorizedRouteHandler.html new file mode 100644 index 000000000..5d9f10b7e --- /dev/null +++ b/7.x/docs/classes/AuthorizedRouteHandler.html @@ -0,0 +1,212 @@ +AuthorizedRouteHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuthorizedRouteHandler

+
+

An InteractionRouteHandler specifically for an AccountIdRoute. +If there is no account ID, implying the user is not logged in, +an UnauthorizedHttpError will be thrown. +If there is an account ID, but it does not match the one in target resource, +a ForbiddenHttpError will be thrown.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/Authorizer.html b/7.x/docs/classes/Authorizer.html new file mode 100644 index 000000000..913ea1e94 --- /dev/null +++ b/7.x/docs/classes/Authorizer.html @@ -0,0 +1,174 @@ +Authorizer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuthorizerAbstract

+
+

Verifies whether the credentials provide access with the given permissions on the resource. +An Error with the necessary explanation will be thrown if permissions are not granted.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuthorizingHttpHandler.html b/7.x/docs/classes/AuthorizingHttpHandler.html new file mode 100644 index 000000000..0733b95cb --- /dev/null +++ b/7.x/docs/classes/AuthorizingHttpHandler.html @@ -0,0 +1,250 @@ +AuthorizingHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuthorizingHttpHandler

+
+

Handles all the necessary steps for an authorization. +Errors if authorization fails, otherwise passes the parameter to the operationHandler handler. +The following steps are executed:

+
    +
  • Extracting credentials from the request.
  • +
  • Extracting the required permissions.
  • +
  • Reading the allowed permissions for the credentials.
  • +
  • Validating if this operation is allowed.
  • +
+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
authorizer: Authorizer
+
+ +
credentialsExtractor: CredentialsExtractor
+
+ +
logger: Logger = ...
+
+ +
modesExtractor: ModesExtractor
+
+ +
operationHandler: OperationHttpHandler
+
+ +
permissionReader: PermissionReader
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuxiliaryLinkMetadataWriter.html b/7.x/docs/classes/AuxiliaryLinkMetadataWriter.html new file mode 100644 index 000000000..490e6f9a2 --- /dev/null +++ b/7.x/docs/classes/AuxiliaryLinkMetadataWriter.html @@ -0,0 +1,231 @@ +AuxiliaryLinkMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuxiliaryLinkMetadataWriter

+
+

A MetadataWriter that takes a specific auxiliaryStrategy and relation type as input and +creates a Link header with the strategy identifier and the relation type as "rel" value.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
auxiliaryStrategy: AuxiliaryStrategy
+
+ +
logger: Logger = ...
+
+ +
relationType: string
+
+ +
specificStrategy: AuxiliaryStrategy
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuxiliaryReader.html b/7.x/docs/classes/AuxiliaryReader.html new file mode 100644 index 000000000..49cfce208 --- /dev/null +++ b/7.x/docs/classes/AuxiliaryReader.html @@ -0,0 +1,242 @@ +AuxiliaryReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuxiliaryReader

+
+

Determines the permissions of auxiliary resources by finding those of the corresponding subject resources.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
auxiliaryStrategy: AuxiliaryStrategy
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BadRequestHttpError.html b/7.x/docs/classes/BadRequestHttpError.html new file mode 100644 index 000000000..1ff0b0095 --- /dev/null +++ b/7.x/docs/classes/BadRequestHttpError.html @@ -0,0 +1,238 @@ +BadRequestHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BadRequestHttpError

+
+

An error thrown when incoming data is not supported. +Probably because an AsyncHandler returns false on the canHandle call.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • BadRequestHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 400
+
+ +
isInstance: ((error) => error is HttpError<400>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<400>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<400>

      +
+
+ +
statusCode: 400
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/Base64EncodingStorage.html b/7.x/docs/classes/Base64EncodingStorage.html new file mode 100644 index 000000000..a3d6376ef --- /dev/null +++ b/7.x/docs/classes/Base64EncodingStorage.html @@ -0,0 +1,279 @@ +Base64EncodingStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class Base64EncodingStorage<T>

+
+

Encodes the input key with base64 encoding, +to make sure there are no invalid or special path characters.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
source: KeyValueStorage<string, T>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseAccountIdRoute.html b/7.x/docs/classes/BaseAccountIdRoute.html new file mode 100644 index 000000000..ea3489295 --- /dev/null +++ b/7.x/docs/classes/BaseAccountIdRoute.html @@ -0,0 +1,158 @@ +BaseAccountIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseAccountIdRoute

+
+

Implementation of an AccountIdRoute that adds the identifier relative to a base InteractionRoute.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<"accountId", string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<"accountId", string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseAccountStore.html b/7.x/docs/classes/BaseAccountStore.html new file mode 100644 index 000000000..a2ed3e415 --- /dev/null +++ b/7.x/docs/classes/BaseAccountStore.html @@ -0,0 +1,295 @@ +BaseAccountStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseAccountStore

+
+

A AccountStore that uses an AccountLoginStorage to keep track of the accounts. +Needs to be initialized before it can be used.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
initialized: boolean = false
+
+ +
logger: Logger = ...
+
+ +
storage: AccountLoginStorage<{
    account: {
        rememberLogin: "boolean?";
    };
}>
+
+

Type declaration

+
    +
  • +
    account: {
        rememberLogin: "boolean?";
    }
    +
      +
    • +
      Readonly rememberLogin: "boolean?"
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Creates a new and empty account. +Since this account will not yet have a login method, +implementations should restrict what is possible with this account, +and should potentially have something in place to clean these accounts up if they are unused.

    +
    +

    Returns Promise<string>

    +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Updates the settings for the account with the given identifier to the new values.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends "rememberLogin"

    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      The account identifier.

      +
      +
    • +
    • +
      setting: T
      +

      The setting to update.

      +
      +
    • +
    • +
      value: AccountSettings[T]
      +

      The new value for the setting.

      +
      +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseChannelType.html b/7.x/docs/classes/BaseChannelType.html new file mode 100644 index 000000000..9c652bac0 --- /dev/null +++ b/7.x/docs/classes/BaseChannelType.html @@ -0,0 +1,347 @@ +BaseChannelType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseChannelTypeAbstract

+
+

A NotificationChannelType that handles the base case of parsing and serializing a notification channel. +Note that the extractModes call always requires Read permissions on the target resource.

+

Uses SHACL to validate the incoming data in initChannel. +Classes extending this can pass extra SHACL properties in the constructor to extend the validation check.

+

The completeChannel implementation is an empty function.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      type: NamedNode<string>
      +

      The URI of the notification channel type. + This will be added to the SHACL shape to validate incoming subscription data.

      +
      +
    • +
    • +
      route: InteractionRoute<never>
      +

      The route corresponding to the URL of the subscription service of this channel type. + Channel identifiers will be generated by appending a value to this URL.

      +
      +
    • +
    • +
      features: string[] = DEFAULT_NOTIFICATION_FEATURES
      +

      The features that should be enabled for this channel type. + Values are expected to be full URIs, but the notify: prefix can also be used.

      +
      +
    • +
    • +
      additionalShaclProperties: unknown[] = []
      +

      Any additional properties that need to be added to the default SHACL shape.

      +
      +
    +

    Returns BaseChannelType

    +
+
+

Properties

+
+ +
features: NamedNode<string>[]
+
+ +
path: string
+
+ +
shacl: unknown
+
+ +
shaclQuads?: Store<Quad, Quad, Quad, Quad>
+
+ +
type: NamedNode<string>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns an N3.js Store containing quads corresponding to the stored SHACL representation. +Caches this result so the conversion from JSON-LD to quads only has to happen once.

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    +
+
+ +
+
+ +
    + +
  • +

    Converts a set of quads to a NotificationChannel. +Assumes the data is valid, so this should be called after validateSubscription.

    +

    The generated identifier will be a URL made by combining the base URL of the channel type with a unique identifier.

    +

    The values of the default features will be added to the resulting channel, +subclasses with additional features that need to be added are responsible for parsing those quads.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Data to convert.

      +
      +
    • +
    • +
      subject: Term
      +

      The identifier of the notification channel description in the dataset.

      +
      +
    +

    Returns Promise<NotificationChannel>

    The generated NotificationChannel.

    + +
+
+ +
+
+ +
    + +
  • +

    Validates whether the given data conforms to the stored SHACL shape. +Will throw an UnprocessableEntityHttpError if validation fails. +Along with the SHACL check, this also makes sure there is only one matching entry in the dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      The data to validate.

      +
      +
    +

    Returns Promise<Term>

    The focus node that corresponds to the subject of the found notification channel description.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseClientCredentialsIdRoute.html b/7.x/docs/classes/BaseClientCredentialsIdRoute.html new file mode 100644 index 000000000..f44234275 --- /dev/null +++ b/7.x/docs/classes/BaseClientCredentialsIdRoute.html @@ -0,0 +1,153 @@ +BaseClientCredentialsIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseClientCredentialsIdRoute

+
+

Implementation of an ClientCredentialsIdRoute +that adds the identifier relative to a base AccountIdRoute.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<"accountId" | "clientCredentialsId", string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<"accountId" | "clientCredentialsId", string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseClientCredentialsStore.html b/7.x/docs/classes/BaseClientCredentialsStore.html new file mode 100644 index 000000000..992d02dbd --- /dev/null +++ b/7.x/docs/classes/BaseClientCredentialsStore.html @@ -0,0 +1,332 @@ +BaseClientCredentialsStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseClientCredentialsStore

+
+

A ClientCredentialsStore that uses a AccountLoginStorage for storing the tokens. +Needs to be initialized before it can be used.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
initialized: boolean = false
+
+ +
logger: Logger = ...
+
+ +
storage: AccountLoginStorage<{
    clientCredentials: {
        accountId: "id:account";
        label: "string";
        secret: "string";
        webId: "string";
    };
}>
+
+

Type declaration

+
    +
  • +
    clientCredentials: {
        accountId: "id:account";
        label: "string";
        secret: "string";
        webId: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
    • +
    • +
      Readonly label: "string"
    • +
    • +
      Readonly secret: "string"
    • +
    • +
      Readonly webId: "string"
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseComponentsJsFactory.html b/7.x/docs/classes/BaseComponentsJsFactory.html new file mode 100644 index 000000000..e342d2db8 --- /dev/null +++ b/7.x/docs/classes/BaseComponentsJsFactory.html @@ -0,0 +1,171 @@ +BaseComponentsJsFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseComponentsJsFactory

+
+

Can be used to instantiate objects using Components.js. +Default main module path is the root folder of the project. +For every generate call a new manager will be made, +but moduleState will be stored in between calls.

+
+
+
+

Hierarchy

+
    +
  • BaseComponentsJsFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
options: IComponentsManagerBuilderOptions<unknown>
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Calls Components.js to instantiate a new object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      configPath: string
      +

      Location of the config to instantiate.

      +
      +
    • +
    • +
      componentIri: string
      +

      Iri of the object in the config that will be the result.

      +
      +
    • +
    • +
      variables: Record<string, unknown>
      +

      Variables to send to Components.js

      +
      +
    +

    Returns Promise<T>

    The resulting object, corresponding to the given component IRI.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseCookieStore.html b/7.x/docs/classes/BaseCookieStore.html new file mode 100644 index 000000000..317a58a31 --- /dev/null +++ b/7.x/docs/classes/BaseCookieStore.html @@ -0,0 +1,219 @@ +BaseCookieStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseCookieStore

+
+

A CookieStore that uses an ExpiringStorage to keep track of the stored cookies. +Cookies have a specified time to live in seconds, default is 14 days, +after which they will be removed.

+
+
+
+

Hierarchy

+
    +
  • BaseCookieStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
storage: ExpiringStorage<string, string>
+
+ +
ttl: number
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Generates and stores a new cookie for the given accountId. +This does not replace previously generated cookies.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      Account to create a cookie for.

      +
      +
    +

    Returns Promise<string>

    The generated cookie.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseEmailSender.html b/7.x/docs/classes/BaseEmailSender.html new file mode 100644 index 000000000..c5e93106e --- /dev/null +++ b/7.x/docs/classes/BaseEmailSender.html @@ -0,0 +1,204 @@ +BaseEmailSender | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseEmailSender

+
+

Sends e-mails using nodemailer.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
mailTransporter: Mail<any>
+
+ +
senderName: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: EmailArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: EmailArgs
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseFileIdentifierMapper.html b/7.x/docs/classes/BaseFileIdentifierMapper.html new file mode 100644 index 000000000..018fb626f --- /dev/null +++ b/7.x/docs/classes/BaseFileIdentifierMapper.html @@ -0,0 +1,464 @@ +BaseFileIdentifierMapper | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseFileIdentifierMapper

+
+

Base class for FileIdentifierMapper implementations.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseRequestURI: string
+
+ +
logger: Logger = ...
+
+ +
metadataSuffix: ".meta" = '.meta'
+
+ +
rootFilepath: string
+
+ +
unknownMediaTypeExtension: "unknown" = 'unknown'
+
+

Methods

+
+ +
    + +
  • +

    Get the absolute file path based on the rootFilepath.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The relative file path.

      +
      +
    +

    Returns string

    Absolute path of the file.

    + +
+
+ +
    + +
  • +

    Maps the given container path to a URL and determines its content type.

    +
    +
    +

    Parameters

    +
      +
    • +
      relative: string
      +

      The relative container path.

      +
      +
    +

    Returns Promise<string>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
    + +
  • +

    Determines the content type from the relative path.

    +
    +
    +

    Parameters

    +
      +
    • +
      filePath: string
      +

      The file path of the document.

      +
      +
    +

    Returns Promise<string>

    The content type of the document.

    + +
+
+ +
    + +
  • +

    Determines the content type from the document identifier.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
    • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<string>

    The content type of the document.

    + +
+
+ +
    + +
  • +

    Maps the given document path to a URL and determines its content type.

    +
    +
    +

    Parameters

    +
      +
    • +
      relative: string
      +

      The relative document path.

      +
      +
    +

    Returns Promise<string>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
    + +
  • +

    Strips the baseRequestURI from the identifier.

    +
    +
    +

    Parameters

    +
    +

    Returns string

    A string representing the relative path.

    + +
    +

    Throws

    NotFoundHttpError +If the identifier does not match the baseRequestURI.

    +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Maps the given container identifier to a file path, +possibly making alterations to the direct translation.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
    • +
    • +
      filePath: string
      +

      The direct translation of the identifier onto the file path.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
    + +
  • +

    Maps the given document identifier to a file path, +possibly making alterations to the direct translation +(for instance, based on its content type)). +Determines the content type if none was provided.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
    • +
    • +
      filePath: string
      +

      The direct translation of the identifier onto the file path.

      +
      +
    • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
    + +
  • +

    Maps the given resource identifier / URL to a file path. +Determines the content type if none was provided. +For containers the content-type input is ignored.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
    • +
    • +
      isMetadata: boolean
      +

      If we need the data or metadata file path.

      +
      +
    • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseForgotPasswordStore.html b/7.x/docs/classes/BaseForgotPasswordStore.html new file mode 100644 index 000000000..a07c44600 --- /dev/null +++ b/7.x/docs/classes/BaseForgotPasswordStore.html @@ -0,0 +1,198 @@ +BaseForgotPasswordStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseForgotPasswordStore

+
+

A ForgotPasswordStore using an ExpiringStorage to hold the necessary records.

+
+
+
+

Hierarchy

+
    +
  • BaseForgotPasswordStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
storage: ExpiringStorage<string, string>
+
+ +
ttl: number
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Creates a Forgot Password Confirmation Record. This will be to remember that +a user has made a request to reset a password. Throws an error if the email doesn't +exist.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +

      ID of the email/password login object.

      +
      +
    +

    Returns Promise<string>

    The record id. This should be included in the reset password link.

    + +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseIdentifierStrategy.html b/7.x/docs/classes/BaseIdentifierStrategy.html new file mode 100644 index 000000000..04718e7f5 --- /dev/null +++ b/7.x/docs/classes/BaseIdentifierStrategy.html @@ -0,0 +1,195 @@ +BaseIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseIdentifierStrategyAbstract

+
+

Provides a default implementation for getParentContainer +which checks if the identifier is supported and not a root container. +If not, the last part before the first relevant slash will be removed to find the parent.

+

Provides a default implementation for contains +which does standard slash-semantics based string comparison.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseLogger.html b/7.x/docs/classes/BaseLogger.html new file mode 100644 index 000000000..0e72bd3a9 --- /dev/null +++ b/7.x/docs/classes/BaseLogger.html @@ -0,0 +1,279 @@ +BaseLogger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseLoggerAbstract

+
+

Base class that implements all additional BaseLogger methods, +leaving only the implementation of SimpleLogger.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Log the given message at the given level. +If the internal level is higher than the given level, the message may be voided.

    +
    +
    +

    Parameters

    +
      +
    • +
      level: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
      +

      The level to log at.

      +
      +
    • +
    • +
      message: string
      +

      The message to log.

      +
      +
    • +
    • +
      Optional meta: LogMetadata
      +

      Optional metadata to include in the log message.

      +
      +
    +

    Returns Logger

    +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseLoginAccountStorage.html b/7.x/docs/classes/BaseLoginAccountStorage.html new file mode 100644 index 000000000..598211882 --- /dev/null +++ b/7.x/docs/classes/BaseLoginAccountStorage.html @@ -0,0 +1,607 @@ +BaseLoginAccountStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseLoginAccountStorage<T>

+
+

A LoginStorage that wraps around another IndexedStorage to add specific account requirements.

+
    +
  • New accounts will be removed after expiration time, in seconds, default is 1800, +if no login method was added to them in that time.
  • +
  • Non-login types can not be created until the associated account has at least 1 login method.
  • +
  • Login types can not be deleted if they are the last login of the associated account.
  • +
+

All of this is tracked by adding a new field to the account object, +that keeps track of how many login objects are associated with the account.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • BaseLoginAccountStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accountKeys: Dict<string>
+
+ +
expiration: number
+
+ +
logger: Logger = ...
+
+ +
loginTypes: string[]
+
+ +
storage: IndexedStorage<T>
+
+

Methods

+
+ +
    + +
  • +

    Makes sure of the operation, adding or removing an object of the given type, +is allowed, based on the current amount of login methods on the given account.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
    • +
    • +
      accountId: string
    • +
    • +
      add: boolean
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Removes the field that keeps track of the login counts, to hide this from the output.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TVal extends undefined | Record<string, unknown>

    +
    +

    Parameters

    +
      +
    • +
      this: void
    • +
    • +
      value: TVal
    +

    Returns TVal

    +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Defines a type in the storage, just like in an IndexedStorage, +but additionally it needs to be indicated if the type corresponds to a login method or not.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      Type to define.

      +
      +
    • +
    • +
      description: T[TType]
      +

      Description of the type.

      +
      +
    • +
    • +
      isLogin: boolean
      +

      Whether this type corresponds to a login method or not.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Deletes the given object. +This will also delete all objects that reference that object if the corresponding key is not optional.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to delete.

      +
      +
    • +
    • +
      id: string
      +

      The identifier of the object.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
+
+ +
    + +
  • +

    Finds all objects matching a specific IndexedQuery.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of objects to find.

      +
      +
    • +
    • +
      query: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
      +

      The query to execute.

      +
      +
    +

    Returns Promise<TypeObject<T[TType]>[]>

    A list of objects matching the query.

    + +
+
+ +
    + +
  • +

    Similar to IndexedStorage.find, but only returns the identifiers of the found objects.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of objects to find.

      +
      +
    • +
    • +
      query: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
      +

      The query to execute.

      +
      +
    +

    Returns Promise<string[]>

    A list of identifiers of the matching objects.

    + +
+
+ +
    + +
  • +

    Returns the object of the given type with the given identifier.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of object to get.

      +
      +
    • +
    • +
      id: string
      +

      The identifier of that object.

      +
      +
    +

    Returns Promise<undefined | TypeObject<T[TType]>>

    A representation of the object, or undefined if there is no object of that type with that identifier.

    + +
+
+ +
    + +
  • +

    Returns true if the object of the given type with the given identifier exists.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of object to get.

      +
      +
    • +
    • +
      id: string
      +

      The identifier of that object.

      +
      +
    +

    Returns Promise<boolean>

    Whether this object exists.

    + +
+
+ +
    + +
  • +

    Sets the value of a specific object. +The identifier in the object is used to identify the object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to set.

      +
      +
    • +
    • +
      value: TypeObject<T[TType]>
      +

      The new value for the object.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Sets the value of one specific field in an object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    • +
    • +

      TKey extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to update.

      +
      +
    • +
    • +
      id: string
      +

      The identifier of the object to update.

      +
      +
    • +
    • +
      key: TKey
      +

      The key to update.

      +
      +
    • +
    • +
      value: ValueType<T[TType][TKey]>
      +

      The new value for the given key.

      +
      +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasePasswordIdRoute.html b/7.x/docs/classes/BasePasswordIdRoute.html new file mode 100644 index 000000000..0fb131324 --- /dev/null +++ b/7.x/docs/classes/BasePasswordIdRoute.html @@ -0,0 +1,152 @@ +BasePasswordIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasePasswordIdRoute

+
+

Implementation of an PasswordIdRoute that adds the identifier relative to a base AccountIdRoute.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<"accountId" | "passwordId", string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<"accountId" | "passwordId", string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasePasswordStore.html b/7.x/docs/classes/BasePasswordStore.html new file mode 100644 index 000000000..9f95e7db1 --- /dev/null +++ b/7.x/docs/classes/BasePasswordStore.html @@ -0,0 +1,425 @@ +BasePasswordStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasePasswordStore

+
+

A PasswordStore that uses a KeyValueStorage to store the entries. +Passwords are hashed and salted. +Default saltRounds is 10.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
initialized: boolean = false
+
+ +
logger: Logger = ...
+
+ +
saltRounds: number
+
+ +
storage: AccountLoginStorage<{
    password: {
        accountId: "id:account";
        email: "string";
        password: "string";
        verified: "boolean";
    };
}>
+
+

Type declaration

+
    +
  • +
    password: {
        accountId: "id:account";
        email: "string";
        password: "string";
        verified: "boolean";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
    • +
    • +
      Readonly email: "string"
    • +
    • +
      Readonly password: "string"
    • +
    • +
      Readonly verified: "boolean"
+
+

Methods

+
+ +
    + +
  • +

    Authenticate if the email and password are correct and return the account and login ID if they are. +Throw an error if they are not.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +

      The user's email.

      +
      +
    • +
    • +
      password: string
      +

      This user's password.

      +
      +
    +

    Returns Promise<{
        accountId: string;
        id: string;
    }>

    +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Confirms that the login has been verified. +This can be used with, for example, email verification. +The login can only be used after it is verified. +In case verification is not required, this should be called immediately after the create call.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      ID of the login.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Finds the account and login ID associated with this email.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +

      Email to find the information for.

      +
      +
    +

    Returns Promise<undefined | {
        accountId: string;
        id: string;
    }>

    +
+
+ +
    + +
  • +

    Finds the account and email associated with this login ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      The ID of the login object.

      +
      +
    +

    Returns Promise<undefined | {
        accountId: string;
        email: string;
    }>

    +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasePodCreator.html b/7.x/docs/classes/BasePodCreator.html new file mode 100644 index 000000000..55b26abcf --- /dev/null +++ b/7.x/docs/classes/BasePodCreator.html @@ -0,0 +1,291 @@ +BasePodCreator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasePodCreator

+
+

Handles the creation of pods. +Will call the stored PodStore with the provided settings.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseUrl: string
+
+ +
identifierGenerator: IdentifierGenerator
+
+ +
logger: Logger = ...
+
+ +
podStore: PodStore
+
+ +
relativeWebIdPath: string
+
+ +
webIdStore: WebIdStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Creates a pod with the given settings. +In case pod creation fails, the given WebID link will be removed, if there is one, before throwing an error.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
    • +
    • +
      settings: PodSettings
    • +
    • +
      overwrite: boolean
    • +
    • +
      Optional webIdLink: string
    +

    Returns Promise<string>

    +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Links the WebID to the account if linkWebId is true. +Also updates the oidcIssuer value in the settings object in that case.

    +
    +
    +

    Parameters

    +
      +
    • +
      linkWebId: boolean
    • +
    • +
      webId: string
    • +
    • +
      accountId: string
    • +
    • +
      settings: PodSettings
    +

    Returns Promise<undefined | string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasePodIdRoute.html b/7.x/docs/classes/BasePodIdRoute.html new file mode 100644 index 000000000..7020f3c2f --- /dev/null +++ b/7.x/docs/classes/BasePodIdRoute.html @@ -0,0 +1,152 @@ +BasePodIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasePodIdRoute

+
+

Implementation of an PodIdRoute that adds the identifier relative to a base AccountIdRoute.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<"accountId" | "podId", string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<"accountId" | "podId", string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasePodStore.html b/7.x/docs/classes/BasePodStore.html new file mode 100644 index 000000000..0f9f006b6 --- /dev/null +++ b/7.x/docs/classes/BasePodStore.html @@ -0,0 +1,426 @@ +BasePodStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasePodStore

+
+

A PodStore implementation using a PodManager to create pods +and a AccountLoginStorage to store the data. +Needs to be initialized before it can be used.

+

Adds the initial WebID as the owner of the pod. +By default, this owner is not exposed through a link header. +This can be changed by setting the constructor visible parameter to true.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
initialized: boolean = false
+
+ +
logger: Logger = ...
+
+ +
manager: PodManager
+
+ +
storage: AccountLoginStorage<{
    owner: {
        podId: "id:pod";
        visible: "boolean";
        webId: "string";
    };
    pod: {
        accountId: "id:account";
        baseUrl: "string";
    };
}>
+
+

Type declaration

+
    +
  • +
    owner: {
        podId: "id:pod";
        visible: "boolean";
        webId: "string";
    }
    +
      +
    • +
      Readonly podId: "id:pod"
    • +
    • +
      Readonly visible: "boolean"
    • +
    • +
      Readonly webId: "string"
  • +
  • +
    pod: {
        accountId: "id:account";
        baseUrl: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
    • +
    • +
      Readonly baseUrl: "string"
+
+ +
visible: boolean
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Creates a new pod and updates the account accordingly.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      Identifier of the account that is creating the account.

      +
      +
    • +
    • +
      settings: PodSettings
      +

      Settings to create a pod with.

      +
      +
    • +
    • +
      overwrite: boolean
      +

      If the pod is allowed to overwrite existing data.

      +
      +
    +

    Returns Promise<string>

    The ID of the new pod resource.

    + +
+
+ +
    + +
  • +

    Find the ID of the account that created the given pod.

    +
    +
    +

    Parameters

    +
      +
    • +
      baseUrl: string
      +

      The pod base URL.

      +
      +
    +

    Returns Promise<undefined | {
        accountId: string;
        id: string;
    }>

    +
+
+ +
    + +
  • +

    Find all the pod resources created by the given account ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      Account ID to find pod resources for.

      +
      +
    +

    Returns Promise<{
        baseUrl: string;
        id: string;
    }[]>

    +
+
+ +
    + +
  • +

    Returns the baseURl and account that created the pod for the given pod ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      ID of the pod.

      +
      +
    +

    Returns Promise<undefined | {
        accountId: string;
        baseUrl: string;
    }>

    +
+
+ +
    + +
  • +

    Find all owners for the given pod ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      ID of the pod.

      +
      +
    +

    Returns Promise<undefined | {
        visible: boolean;
        webId: string;
    }[]>

    +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Add or update an owner of a pod. +In case there already is an owner with this WebID, it will be updated, +otherwise a new owner will be added.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      ID of the pod.

      +
      +
    • +
    • +
      webId: string
      +

      WebID of the owner.

      +
      +
    • +
    • +
      visible: boolean
      +

      Whether the owner wants to be exposed or not.

      +
      +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseReadWriteLocker.html b/7.x/docs/classes/BaseReadWriteLocker.html new file mode 100644 index 000000000..fd4b02744 --- /dev/null +++ b/7.x/docs/classes/BaseReadWriteLocker.html @@ -0,0 +1,383 @@ +BaseReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseReadWriteLockerAbstract

+
+

A ReadWriteLocker that allows for multiple simultaneous read operations. +Write operations will be blocked as long as read operations are not finished. +New read operations are allowed while this is going on, which will cause write operations to wait longer.

+

Based on https://en.wikipedia.org/wiki/Readers%E2%80%93writer_lock#Using_two_mutexes . +As soon as 1 read lock request is made, the main lock is locked. +Internally a counter keeps track of the amount of active read locks. +Only when this number reaches 0 will the main lock be released again. +The internal count lock is only locked to increase/decrease this counter and is released afterwards. +This allows for multiple read operations, although only 1 at the time can update the counter, +which means there can still be a small waiting period if there are multiple simultaneous read operations.

+

Classes extending this need to implement getCountLockIdentifier and modifyCount.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
countLocker: ResourceLocker
+
+ +
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Generate the identifier that will be used to acquire the count lock for the given identifier. +There will be cases where this lock needs to be acquired +while an active lock on the main resource is still being maintained. +This means that if the input resourceLocker and countLocker use the same locking system +this generated identifier needs to be different.

    +
    +
    +

    Parameters

    +
    +

    Returns ResourceIdentifier

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+ +
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseResourceStore.html b/7.x/docs/classes/BaseResourceStore.html new file mode 100644 index 000000000..2cf659da7 --- /dev/null +++ b/7.x/docs/classes/BaseResourceStore.html @@ -0,0 +1,284 @@ +BaseResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseResourceStore

+
+

Base implementation of ResourceStore for implementers of custom stores.

+
+
+
+

Hierarchy

+
    +
  • BaseResourceStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseResourcesGenerator.html b/7.x/docs/classes/BaseResourcesGenerator.html new file mode 100644 index 000000000..3a2d8d922 --- /dev/null +++ b/7.x/docs/classes/BaseResourcesGenerator.html @@ -0,0 +1,330 @@ +BaseResourcesGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseResourcesGenerator

+
+

Generates resources by making use of a template engine. +The template folder structure will be kept. +Folders will be interpreted as containers and files as documents. +A FileIdentifierMapper will be used to generate identifiers that correspond to the relative structure.

+

Metadata resources will be yielded separately from their subject resource.

+

A relative templateFolder is resolved relative to cwd, +unless it's preceded by @css:, e.g. @css:foo/bar.

+
+
+
+

Hierarchy

+
    +
  • BaseResourcesGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
logger: Logger = ...
+
+ +
metadataStrategy: AuxiliaryStrategy
+
+ +
+
+ +
templateEngine: TemplateEngine<Dict<unknown>>
+
+ +
templateExtension: string
+
+

Methods

+
+ +
    + +
  • +

    Generates resources with the given options, based on the given template folder. +The output Iterable should be sorted so that containers always appear before their contents.

    +
    +
    +

    Parameters

    +
      +
    • +
      templateFolder: string
      +

      Folder where the templates are located.

      +
      +
    • +
    • +
      location: ResourceIdentifier
      +

      Base identifier.

      +
      +
    • +
    • +
      options: Dict<unknown>
      +

      Options that can be used when generating resources.

      +
      +
    +

    Returns AsyncIterable<Resource>

    A map where the keys are the identifiers and the values the corresponding representations to store.

    + +
+
+ +
+
+ +
    + +
  • +

    Generates a Resource object for the given ResourceLink. +In the case of documents the corresponding template will be used. +If a ResourceLink of metadata is provided the corresponding metadata resource +will be yielded as a separate resource.

    +
    +
    +

    Parameters

    +
      +
    • +
      link: TemplateResourceLink
    • +
    • +
      options: Dict<unknown>
    • +
    • +
      Optional metaLink: TemplateResourceLink
    +

    Returns AsyncIterable<Resource>

    +
+
+ +
    + +
  • +

    Generates TemplateResourceLinks for each entry in the given folder +and combines the results so resources and their metadata are grouped together.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Record<string, {
        link: TemplateResourceLink;
        meta?: TemplateResourceLink;
    }>>

    +
+
+ +
    + +
  • +

    Creates a read stream from the file and applies the template if necessary.

    +
    +
    +

    Parameters

    +
      +
    • +
      link: TemplateResourceLink
    • +
    • +
      contents: Dict<unknown>
    +

    Returns Promise<Guarded<Readable>>

    +
+
+ +
+
+ +
    + +
  • +

    Creates a TemplateResourceLink for the given filePath, +which connects a resource URL to its template file. +The identifier will be based on the file path stripped from the template extension, +but the filePath parameter will still point to the original file.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<TemplateResourceLink>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseRouterHandler.html b/7.x/docs/classes/BaseRouterHandler.html new file mode 100644 index 000000000..15ce9299a --- /dev/null +++ b/7.x/docs/classes/BaseRouterHandler.html @@ -0,0 +1,252 @@ +BaseRouterHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseRouterHandler<T>Abstract

+
+

Checks if a given method and path are satisfied and allows its handler to be executed if so.

+

Implementations of this class should call canHandleInput in their canHandle call with the correct parameters.

+

canHandleInput expects a ResourceIdentifier to indicate it expects the target to have been validated already.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
allMethods: boolean
+
+ +
allowedMethods: string[]
+
+ +
allowedPathNamesRegEx: RegExp[]
+
+ +
baseUrlLength: number
+
+ +
handler: T
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: AsyncHandlerInput<T>
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<Awaited<ReturnType<T["handle"]>>>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseServerFactory.html b/7.x/docs/classes/BaseServerFactory.html new file mode 100644 index 000000000..565771114 --- /dev/null +++ b/7.x/docs/classes/BaseServerFactory.html @@ -0,0 +1,160 @@ +BaseServerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseServerFactory

+
+

Creates an HTTP(S) server native Node.js http/https modules.

+

Will apply a ServerConfigurator to the server, +which should be used to attach listeners.

+
+
+
+

Hierarchy

+
    +
  • BaseServerFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
configurator: ServerConfigurator
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseStateHandler.html b/7.x/docs/classes/BaseStateHandler.html new file mode 100644 index 000000000..f7b060b49 --- /dev/null +++ b/7.x/docs/classes/BaseStateHandler.html @@ -0,0 +1,217 @@ +BaseStateHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseStateHandler

+
+

Handles the state feature by calling a NotificationHandler +in case the NotificationChannel has a state value.

+

Deletes the state parameter from the channel afterwards.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseTypedRepresentationConverter.html b/7.x/docs/classes/BaseTypedRepresentationConverter.html new file mode 100644 index 000000000..b6d37e8f1 --- /dev/null +++ b/7.x/docs/classes/BaseTypedRepresentationConverter.html @@ -0,0 +1,233 @@ +BaseTypedRepresentationConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseTypedRepresentationConverterAbstract

+
+

A base TypedRepresentationConverter implementation for converters +that can convert from all its input types to all its output types.

+

This base class handles the canHandle call by comparing the input content type to the stored input types +and the output preferences to the stored output types.

+

Output weights are determined by multiplying all stored output weights with the weight of the input type.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
inputTypes: Promise<ValuePreferences>
+
+ +
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseUrlExtractor.html b/7.x/docs/classes/BaseUrlExtractor.html new file mode 100644 index 000000000..54195e160 --- /dev/null +++ b/7.x/docs/classes/BaseUrlExtractor.html @@ -0,0 +1,191 @@ +BaseUrlExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseUrlExtractor

+
+

A ShorthandExtractor that that generates the base URL based on the input baseUrl value, +or by using the port if the first isn't provided.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
defaultPort: number
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<unknown>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseUrlHandler.html b/7.x/docs/classes/BaseUrlHandler.html new file mode 100644 index 000000000..cd4053c5d --- /dev/null +++ b/7.x/docs/classes/BaseUrlHandler.html @@ -0,0 +1,188 @@ +BaseUrlHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseUrlHandler

+
+

Adds the pod identifier as base url variable to the agent. +This allows for config templates that require a value for TEMPLATE_BASE_URL_URN, +which should equal the pod identifier.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseUrlRouterRule.html b/7.x/docs/classes/BaseUrlRouterRule.html new file mode 100644 index 000000000..1bf68186a --- /dev/null +++ b/7.x/docs/classes/BaseUrlRouterRule.html @@ -0,0 +1,236 @@ +BaseUrlRouterRule | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseUrlRouterRule

+
+

Routes requests based on their base url. +Checks if any of the stored base URLs match the request identifier. +If there are no matches the base store will be returned if one was configured.

+

Part of the dynamic pod creation. +Uses the identifiers that were added to the routing storage.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseStore?: ResourceStore
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseUrlVerifier.html b/7.x/docs/classes/BaseUrlVerifier.html new file mode 100644 index 000000000..1fed8150e --- /dev/null +++ b/7.x/docs/classes/BaseUrlVerifier.html @@ -0,0 +1,208 @@ +BaseUrlVerifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseUrlVerifier

+
+

Stores the baseUrl value that was used to start the server +and warns the user in case it differs from the previous one.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseUrl: string
+
+ +
logger: Logger = ...
+
+ +
storage: KeyValueStorage<string, string>
+
+ +
storageKey: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseWebIdLinkRoute.html b/7.x/docs/classes/BaseWebIdLinkRoute.html new file mode 100644 index 000000000..c1bbcdd0a --- /dev/null +++ b/7.x/docs/classes/BaseWebIdLinkRoute.html @@ -0,0 +1,152 @@ +BaseWebIdLinkRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseWebIdLinkRoute

+
+

Implementation of an WebIdLinkRoute that adds the identifier relative to a base AccountIdRoute.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<"accountId" | "webIdLink", string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<"accountId" | "webIdLink", string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseWebIdStore.html b/7.x/docs/classes/BaseWebIdStore.html new file mode 100644 index 000000000..e12abd5bf --- /dev/null +++ b/7.x/docs/classes/BaseWebIdStore.html @@ -0,0 +1,326 @@ +BaseWebIdStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseWebIdStore

+
+

A WebIdStore using a AccountLoginStorage to store the links. +Needs to be initialized before it can be used.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
initialized: boolean = false
+
+ +
logger: Logger = ...
+
+ +
storage: AccountLoginStorage<{
    webIdLink: {
        accountId: "id:account";
        webId: "string";
    };
}>
+
+

Type declaration

+
    +
  • +
    webIdLink: {
        accountId: "id:account";
        webId: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
    • +
    • +
      Readonly webId: "string"
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Finds all links associated with the given account.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      ID of the account.

      +
      +
    +

    Returns Promise<{
        id: string;
        webId: string;
    }[]>

    +
+
+ +
    + +
  • +

    Finds the account and WebID of the link with the given ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
    +

    Returns Promise<undefined | {
        accountId: string;
        webId: string;
    }>

    +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicConditions.html b/7.x/docs/classes/BasicConditions.html new file mode 100644 index 000000000..5fb18babe --- /dev/null +++ b/7.x/docs/classes/BasicConditions.html @@ -0,0 +1,193 @@ +BasicConditions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicConditions

+
+

Stores all the relevant Conditions values and matches them based on RFC7232.

+
+
+
+

Hierarchy

+
    +
  • BasicConditions
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
eTagHandler: ETagHandler
+
+ +
matchesETag?: string[]
+

Valid if matching any of the given ETags.

+
+
+
+ +
modifiedSince?: Date
+

Valid if modified since the given date.

+
+
+
+ +
notMatchesETag?: string[]
+

Valid if not matching any of the given ETags.

+
+
+
+ +
unmodifiedSince?: Date
+

Valid if not modified since the given date.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Checks validity based on the given metadata.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional metadata: RepresentationMetadata
      +

      Metadata of the representation. Undefined if the resource does not exist.

      +
      +
    • +
    • +
      Optional strict: boolean
      +

      How to compare the ETag related headers. + If true, the comparison will happen on representation level. + If false, the comparison happens on resource level, ignoring the content-type.

      +
      +
    +

    Returns boolean

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicConditionsParser.html b/7.x/docs/classes/BasicConditionsParser.html new file mode 100644 index 000000000..5ccfd036b --- /dev/null +++ b/7.x/docs/classes/BasicConditionsParser.html @@ -0,0 +1,246 @@ +BasicConditionsParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicConditionsParser

+
+

Creates a Conditions object based on the following headers:

+
    +
  • If-Modified-Since
  • +
  • If-Unmodified-Since
  • +
  • If-Match
  • +
  • If-None-Match
  • +
+

Implementation based on RFC7232

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
eTagHandler: ETagHandler
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Converts a request header containing a datetime string to an actual Date object. +Undefined if there is no value for the given header name.

    +
    +
    +

    Parameters

    +
      +
    • +
      request: HttpRequest
    • +
    • +
      header: "if-modified-since" | "if-unmodified-since"
    +

    Returns undefined | Date

    +
+
+ +
    + +
  • +

    Converts a request header containing ETags to an array of ETags. +Undefined if there is no value for the given header name.

    +
    +
    +

    Parameters

    +
      +
    • +
      request: HttpRequest
    • +
    • +
      header: "if-match" | "if-none-match"
    +

    Returns undefined | string[]

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicETagHandler.html b/7.x/docs/classes/BasicETagHandler.html new file mode 100644 index 000000000..48ce10934 --- /dev/null +++ b/7.x/docs/classes/BasicETagHandler.html @@ -0,0 +1,183 @@ +BasicETagHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicETagHandler

+
+

Standard implementation of ETagHandler. +ETags are constructed by combining the last modified date with the content type of the representation.

+
+
+
+

Hierarchy

+
    +
  • BasicETagHandler
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Validates whether the given metadata corresponds to the given ETag.

    +
    +
    +

    Parameters

    +
      +
    • +
      metadata: RepresentationMetadata
      +

      Metadata of the resource.

      +
      +
    • +
    • +
      eTag: string
      +

      ETag to compare to.

      +
      +
    • +
    • +
      strict: boolean
      +

      True if the comparison needs to be on representation level. + False if it is on resource level and the content-type doesn't matter.

      +
      +
    +

    Returns boolean

    +
+
+ +
    + +
  • +

    Validates whether 2 ETags correspond to the same state of a resource, +independent of the representation the ETags correspond to.

    +
    +
    +

    Parameters

    +
      +
    • +
      eTag1: string
      +

      First ETag to compare.

      +
      +
    • +
    • +
      eTag2: string
      +

      Second ETag to compare.

      +
      +
    +

    Returns boolean

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicRepresentation.html b/7.x/docs/classes/BasicRepresentation.html new file mode 100644 index 000000000..e3b77581e --- /dev/null +++ b/7.x/docs/classes/BasicRepresentation.html @@ -0,0 +1,301 @@ +BasicRepresentation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicRepresentation

+
+

Class with various constructors to facilitate creating a representation.

+

A representation consists of 1) data, 2) metadata, and 3) a binary flag +to indicate whether the data is a binary stream or an object stream.

+
    +
  1. The data can be given as a stream, array, or string.
  2. +
  3. The metadata can be specified as one or two parameters +that will be passed to the RepresentationMetadata constructor.
  4. +
  5. The binary field is optional, and if not specified, +is determined from the content type inside the metadata.
  6. +
+
+
+
+

Hierarchy

+
    +
  • BasicRepresentation
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Accessors

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
binary: boolean
+

Whether the data stream consists of binary/string chunks +(as opposed to complex objects).

+
+
+
+ +
data: Guarded<Readable>
+

The raw data stream for this representation.

+
+
+
+ + +

The corresponding metadata.

+
+
+
+

Accessors

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicRequestParser.html b/7.x/docs/classes/BasicRequestParser.html new file mode 100644 index 000000000..d46fe657f --- /dev/null +++ b/7.x/docs/classes/BasicRequestParser.html @@ -0,0 +1,220 @@ +BasicRequestParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicRequestParser

+
+

Creates an Operation from an incoming HttpRequest by aggregating the results +of a TargetExtractor, MetadataParser, +ConditionsParser and BodyParser.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
bodyParser: BodyParser
+
+ +
conditionsParser: ConditionsParser
+
+ +
metadataParser: MetadataParser
+
+ +
preferenceParser: PreferenceParser
+
+ +
targetExtractor: TargetExtractor
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicResponseWriter.html b/7.x/docs/classes/BasicResponseWriter.html new file mode 100644 index 000000000..32596ef70 --- /dev/null +++ b/7.x/docs/classes/BasicResponseWriter.html @@ -0,0 +1,212 @@ +BasicResponseWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicResponseWriter

+
+

Writes to an HttpResponse based on the incoming ResponseDescription.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
metadataWriter: MetadataWriter
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BearerWebIdExtractor.html b/7.x/docs/classes/BearerWebIdExtractor.html new file mode 100644 index 000000000..991bd39e8 --- /dev/null +++ b/7.x/docs/classes/BearerWebIdExtractor.html @@ -0,0 +1,192 @@ +BearerWebIdExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BearerWebIdExtractor

+
+

Responsible for extracting credentials from an incoming request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
verify: SolidTokenVerifierFunction
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BinarySliceResourceStore.html b/7.x/docs/classes/BinarySliceResourceStore.html new file mode 100644 index 000000000..dd3687d88 --- /dev/null +++ b/7.x/docs/classes/BinarySliceResourceStore.html @@ -0,0 +1,325 @@ +BinarySliceResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BinarySliceResourceStore<T>

+
+

Resource store that slices the data stream if there are range preferences. +Only works for bytes range preferences on binary data streams. +Does not support multipart range requests.

+

If the slice happens, unit/start/end values will be written to the metadata to indicate such. +The values are dependent on the preferences we got as an input, +as we don't know the actual size of the data stream.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
source: T
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BodyParser.html b/7.x/docs/classes/BodyParser.html new file mode 100644 index 000000000..2a4d707b5 --- /dev/null +++ b/7.x/docs/classes/BodyParser.html @@ -0,0 +1,175 @@ +BodyParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BodyParserAbstract

+
+

Parses the body of an incoming HttpRequest and converts it to a Representation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: BodyParserArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BooleanHandler.html b/7.x/docs/classes/BooleanHandler.html new file mode 100644 index 000000000..09ee29f03 --- /dev/null +++ b/7.x/docs/classes/BooleanHandler.html @@ -0,0 +1,214 @@ +BooleanHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BooleanHandler<TIn>

+
+

A composite handler that returns true if any of its handlers can handle the input and return true. +Handler errors are interpreted as false results.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
handlers: AsyncHandler<TIn, boolean>[]
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<boolean>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<boolean>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CachedHandler.html b/7.x/docs/classes/CachedHandler.html new file mode 100644 index 000000000..336e101da --- /dev/null +++ b/7.x/docs/classes/CachedHandler.html @@ -0,0 +1,273 @@ +CachedHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CachedHandler<TIn, TOut>

+
+

Caches output data from the source handler based on the input object. +The fields parameter can be used to instead use one or more specific entries from the input object as cache key, +so has as actual required typing (keyof TIn)[].

+

A WeakMap is used internally so strict object equality determines cache hits, +and data will be removed once the key stops existing. +This also means that the cache key needs to be an object. +Errors will be thrown in case a primitive is used.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn extends Record<string, unknown>

  • +
  • +

    TOut = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cache: WeakMap<object, NestedMap<TOut>>
+
+ +
fields?: [keyof TIn, ...(keyof TIn)[]]
+
+ +
source: AsyncHandler<TIn, TOut>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Returns the WeakMap that contains actual objects that were cached, +so the last WeakMap in the chain of maps.

    +

    Returns undefined if no such map exists because earlier keys were not cached.

    +

    Will always return a map if ensure is set to true, +in such a case the intermediate maps will be created and added to the previous map.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
    • +
    • +
      keys: object[]
    • +
    • +
      cache: WeakMap<object, NestedMap<TOut>>
    • +
    • +
      ensure: boolean = false
    +

    Returns undefined | WeakMap<object, TOut>

    +
+
+ +
    + +
  • +

    Extracts the values that will be used as keys from the input object. +In case the fields value was undefined, this will return an array containing the input object itself.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
    +

    Returns [object, ...object[]]

    +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CachedJwkGenerator.html b/7.x/docs/classes/CachedJwkGenerator.html new file mode 100644 index 000000000..74dabdf57 --- /dev/null +++ b/7.x/docs/classes/CachedJwkGenerator.html @@ -0,0 +1,184 @@ +CachedJwkGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CachedJwkGenerator

+
+

Generates a key pair once and then caches it using both an internal variable and a KeyValueStorage. +The storage makes sure the keys remain the same between server restarts, +while the internal variable makes it so the storage doesn't have to be accessed every time a key is needed.

+

Only the private key is stored in the internal storage, using the storageKey parameter. +The public key is determined based on the private key and then also stored in memory.

+
+
+
+

Hierarchy

+
    +
  • CachedJwkGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
alg: AsymmetricSigningAlgorithm
+

The algorithm used for the keys.

+
+
+
+ +
key: string
+
+ +
privateJwk?: AlgJwk
+
+ +
publicJwk?: AlgJwk
+
+ +
storage: KeyValueStorage<string, JWKS>
+
+

Methods

+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CachedResourceSet.html b/7.x/docs/classes/CachedResourceSet.html new file mode 100644 index 000000000..c67b45070 --- /dev/null +++ b/7.x/docs/classes/CachedResourceSet.html @@ -0,0 +1,148 @@ +CachedResourceSet | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CachedResourceSet

+
+

Caches resource existence in a WeakMap tied to the ResourceIdentifier object.

+
+
+
+

Hierarchy

+
    +
  • CachedResourceSet
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cache: WeakMap<ResourceIdentifier, boolean>
+
+ +
source: ResourceSet
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CancelOidcHandler.html b/7.x/docs/classes/CancelOidcHandler.html new file mode 100644 index 000000000..08b4356c5 --- /dev/null +++ b/7.x/docs/classes/CancelOidcHandler.html @@ -0,0 +1,171 @@ +CancelOidcHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CancelOidcHandler

+
+

Cancel an active OIDC interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ChainedConverter.html b/7.x/docs/classes/ChainedConverter.html new file mode 100644 index 000000000..74b976ac9 --- /dev/null +++ b/7.x/docs/classes/ChainedConverter.html @@ -0,0 +1,419 @@ +ChainedConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ChainedConverter

+
+

A meta converter that takes an array of other converters as input. +It chains these converters by finding a path of converters +that can go from the given content-type to the given type preferences. +In case there are multiple paths, the one with the highest weight gets found. +Will error in case no path can be found.

+

This is not a TypedRepresentationConverter since the supported output types +might depend on what is the input content-type.

+

This converter should be the last in a WaterfallHandler if there are multiple, +since it will try to convert any representation with a content-type.

+

Some suggestions on how this class can be even more optimized should this ever be needed in the future. +Most of these decrease computation time at the cost of more memory.

+
    +
  • The algorithm could start on both ends of a possible path and work towards the middle.
  • +
  • When creating a path, store the list of unused converters instead of checking every step.
  • +
  • Caching: https://github.com/CommunitySolidServer/CommunitySolidServer/issues/832
  • +
  • Making sure each intermediate type is only used once.
  • +
  • The TypedRepresentationConverter interface could potentially be updated +so paths only differing in intermediate types can be combined.
  • +
+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Finds the path from the given list that can convert to the given preferences. +If there are multiple matches the one with the highest result weight gets chosen. +Will return undefined if there are no matches.

    +
    +
    +

    Parameters

    +
      +
    • +
      paths: ConversionPath[]
    +

    Returns undefined | ConversionPath

    +
+
+ +
    + +
  • +

    Returns a ConverterPreference if the given converter supports the given type. +All types that have already been used will be removed from the output types.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<undefined | ConverterPreference>

    +
+
+ +
+
+ +
    + +
  • +

    Tries to generate the optimal ConversionPath that supports the given parameters, +which will then be used to instantiate a specific MatchedPath for those parameters.

    +

    Errors if such a path does not exist.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ConversionPath>

    +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Filter out paths that can no longer be better than the current best solution. +This depends on a valid path already being found, if not all the input paths will be returned.

    +
    +
    +

    Parameters

    +
      +
    • +
      paths: ConversionPath[]
      +

      Paths to filter.

      +
      +
    • +
    • +
      maxWeight: number
      +

      The maximum weight in the output preferences.

      +
      +
    • +
    • +
      Optional bestMatch: ConversionPath
      +

      The current best path.

      +
      +
    +

    Returns ConversionPath[]

    +
+
+ +
+
+ +
    + +
  • +

    Finds all converters that could take the output of the given path as input. +For each of these converters a new path gets created which is the input path appended by the converter.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ConversionPath[]>

    +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ChainedTemplateEngine.html b/7.x/docs/classes/ChainedTemplateEngine.html new file mode 100644 index 000000000..ad8e1e80a --- /dev/null +++ b/7.x/docs/classes/ChainedTemplateEngine.html @@ -0,0 +1,227 @@ +ChainedTemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ChainedTemplateEngine<T>

+
+

Calls the given array of TemplateEngines in the order they appear, +feeding the output of one into the input of the next.

+

The first engine will be called with the provided contents and template parameters. +All subsequent engines will be called with no template parameter. +Contents will still be passed along and another entry will be added for the body of the previous output.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
chainedEngines: TemplateEngine<Dict<unknown>>[]
+
+ +
firstEngine: TemplateEngine<T>
+
+ +
renderedName: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CliExtractor.html b/7.x/docs/classes/CliExtractor.html new file mode 100644 index 000000000..e72d8aa53 --- /dev/null +++ b/7.x/docs/classes/CliExtractor.html @@ -0,0 +1,184 @@ +CliExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CliExtractorAbstract

+
+

Converts the input CLI arguments into an easily parseable key/value object.

+

Due to how the application is built, there are certain CLI parameters +that need to be parsed before this class can be instantiated. +These can be ignored by this class as they will have been handled before it is called, +but that does mean that this class should not error if they are present, +e.g., by being strict throwing an error on these unexpected parameters.

+

In case strict mode is preferred, the following should be added to the list of known parameters:

+
    +
  • -c / --config
  • +
  • -m / --mainModulePath
  • +
  • -l / --loggingLevel
  • +
+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: CliArgv
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: CliArgv
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<Shorthand>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: CliArgv
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<Shorthand>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CliResolver.html b/7.x/docs/classes/CliResolver.html new file mode 100644 index 000000000..726b12d09 --- /dev/null +++ b/7.x/docs/classes/CliResolver.html @@ -0,0 +1,119 @@ +CliResolver | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CliResolver

+
+

A class that combines a CliExtractor and a ShorthandResolver. +Mainly exists so both such classes can be generated in a single Components.js instance.

+
+
+
+

Hierarchy

+
    +
  • CliResolver
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cliExtractor: CliExtractor
+
+ +
shorthandResolver: ShorthandResolver
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientCredentialsAdapter.html b/7.x/docs/classes/ClientCredentialsAdapter.html new file mode 100644 index 000000000..d49593331 --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsAdapter.html @@ -0,0 +1,271 @@ +ClientCredentialsAdapter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientCredentialsAdapter

+
+

A PassthroughAdapter that overrides the find function +by checking if there are stored client credentials for the given ID +if no payload is found in the source.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clientCredentialsStore: ClientCredentialsStore
+
+ +
logger: Logger = ...
+
+ +
name: string
+
+ +
source: Adapter
+
+ +
webIdStore: WebIdStore
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientCredentialsAdapterFactory.html b/7.x/docs/classes/ClientCredentialsAdapterFactory.html new file mode 100644 index 000000000..a8c33672d --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsAdapterFactory.html @@ -0,0 +1,155 @@ +ClientCredentialsAdapterFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientCredentialsAdapterFactory

+
+

A factory that generates an Adapter to be used by the IDP to persist information.

+

The oidc-provider library will call the relevant functions when it needs to find/create/delete metadata. +For a full explanation of how these functions work and what is expected, +have a look at https://github.com/panva/node-oidc-provider/blob/main/example/my_adapter.js

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clientCredentialsStore: ClientCredentialsStore
+
+ +
+
+ +
webIdStore: WebIdStore
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientCredentialsDetailsHandler.html b/7.x/docs/classes/ClientCredentialsDetailsHandler.html new file mode 100644 index 000000000..cb229cd0c --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsDetailsHandler.html @@ -0,0 +1,206 @@ +ClientCredentialsDetailsHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientCredentialsDetailsHandler

+
+

Provides a view on a client credentials token, indicating the token identifier and its associated WebID.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clientCredentialsRoute: ClientCredentialsIdRoute
+
+ +
clientCredentialsStore: ClientCredentialsStore
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientIdAdapter.html b/7.x/docs/classes/ClientIdAdapter.html new file mode 100644 index 000000000..169a4ad45 --- /dev/null +++ b/7.x/docs/classes/ClientIdAdapter.html @@ -0,0 +1,295 @@ +ClientIdAdapter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientIdAdapter

+
+

This Adapter redirects the find call to its source adapter. +In case no client data was found in the source for the given Client ID, +this class will do an HTTP GET request to that Client ID. +If the result is a valid Client ID document, that will be returned instead.

+

See https://solidproject.org/TR/2022/oidc-20220328#clientids-document.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
logger: Logger = ...
+
+ +
name: string
+
+ +
source: Adapter
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Parses RDF data found at a Client ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: string
      +

      Raw data from the Client ID.

      +
      +
    • +
    • +
      id: string
      +

      The actual Client ID.

      +
      +
    • +
    • +
      response: Response
      +

      Response object from the request.

      +
      +
    +

    Returns Promise<AdapterPayload>

    +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientIdAdapterFactory.html b/7.x/docs/classes/ClientIdAdapterFactory.html new file mode 100644 index 000000000..5ae7c7307 --- /dev/null +++ b/7.x/docs/classes/ClientIdAdapterFactory.html @@ -0,0 +1,146 @@ +ClientIdAdapterFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientIdAdapterFactory

+
+

A factory that generates an Adapter to be used by the IDP to persist information.

+

The oidc-provider library will call the relevant functions when it needs to find/create/delete metadata. +For a full explanation of how these functions work and what is expected, +have a look at https://github.com/panva/node-oidc-provider/blob/main/example/my_adapter.js

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientInfoHandler.html b/7.x/docs/classes/ClientInfoHandler.html new file mode 100644 index 000000000..261987e93 --- /dev/null +++ b/7.x/docs/classes/ClientInfoHandler.html @@ -0,0 +1,190 @@ +ClientInfoHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientInfoHandler

+
+

Returns a JSON representation with metadata of the client that is requesting the OIDC interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
providerFactory: ProviderFactory
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClusterManager.html b/7.x/docs/classes/ClusterManager.html new file mode 100644 index 000000000..29c22ffe9 --- /dev/null +++ b/7.x/docs/classes/ClusterManager.html @@ -0,0 +1,213 @@ +ClusterManager | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClusterManager

+
+

This class is responsible for deciding how many affective workers are needed. +It also contains the logic for respawning workers when they are killed by the os.

+

The workers values are interpreted as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
valueactual workers
-mnum_cores - m workers (autoscale) (m < num_cores)
-1num_cores - 1 workers (autoscale)
0num_cores workers (autoscale)
1single threaded mode (default)
nn workers
+
+
+
+

Hierarchy

+
    +
  • ClusterManager
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clusterMode: ClusterMode
+
+ +
logger: Logger = ...
+
+ +
workers: number
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Check whether the CSS server was booted in single threaded mode.

    +
    +

    Returns boolean

    True is single threaded.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CombinedShorthandResolver.html b/7.x/docs/classes/CombinedShorthandResolver.html new file mode 100644 index 000000000..fe66c62d1 --- /dev/null +++ b/7.x/docs/classes/CombinedShorthandResolver.html @@ -0,0 +1,190 @@ +CombinedShorthandResolver | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CombinedShorthandResolver

+
+

Generates variable values by running a set of ShorthandExtractors on the input.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
resolvers: Record<string, ShorthandExtractor>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Record<string, unknown>
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<Record<string, unknown>>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<VariableBindings>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ComposedAuxiliaryStrategy.html b/7.x/docs/classes/ComposedAuxiliaryStrategy.html new file mode 100644 index 000000000..6bde87952 --- /dev/null +++ b/7.x/docs/classes/ComposedAuxiliaryStrategy.html @@ -0,0 +1,336 @@ +ComposedAuxiliaryStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ComposedAuxiliaryStrategy

+
+

An AuxiliaryStrategy that provides its functionality through the combination of +an AuxiliaryIdentifierStrategy, MetadataGenerator and Validator.

+
+
+
+

Hierarchy

+
    +
  • ComposedAuxiliaryStrategy
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
identifierStrategy: AuxiliaryIdentifierStrategy
+
+ +
metadataGenerator?: MetadataGenerator
+
+ +
ownAuthorization: boolean
+
+ +
requiredInRoot: boolean
+
+ +
validator?: Validator
+
+

Methods

+
+ +
    + +
  • +

    Adds metadata related to this auxiliary resource, +in case this is required for this type of auxiliary resource. +The metadata that is added depends on the given identifier being an auxiliary or subject resource: +the metadata will be used to link to the other one, and potentially add extra typing info.

    +

    Used for: +Solid, §4.3.1: "For any defined auxiliary resource available for a given Solid resource, all representations of +that resource MUST include an HTTP Link header pointing to the location of each auxiliary resource." +https://solid.github.io/specification/protocol#auxiliary-resources-server

    +

    The above is an example of how that metadata would only be added in case the input is the subject identifier.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Checks if the input identifier corresponds to an auxiliary resource. +This does not check if that auxiliary resource exists, +only if the identifier indicates that there could be an auxiliary resource there.

    +
    +
    +

    Parameters

    +
    +

    Returns boolean

    true if the input identifier points to an auxiliary resource.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ComposedNotificationHandler.html b/7.x/docs/classes/ComposedNotificationHandler.html new file mode 100644 index 000000000..278c2d107 --- /dev/null +++ b/7.x/docs/classes/ComposedNotificationHandler.html @@ -0,0 +1,213 @@ +ComposedNotificationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ComposedNotificationHandler

+
+

Generates, serializes and emits a Notification using a NotificationGenerator, +NotificationSerializer and NotificationEmitter.

+

Will not emit an event when it has the same state as the notification channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
eTagHandler: ETagHandler
+
+ +
+
+ +
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConditionalHandler.html b/7.x/docs/classes/ConditionalHandler.html new file mode 100644 index 000000000..4b1589018 --- /dev/null +++ b/7.x/docs/classes/ConditionalHandler.html @@ -0,0 +1,266 @@ +ConditionalHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConditionalHandler<TIn, TOut>

+
+

This handler will pass all requests to the wrapped handler, +until a specific value has been set in the given storage. +After that all input will be rejected. +Once the value has been matched this behaviour will be cached, +so changing the value again afterwards will not enable this handler again.

+

If handleStorage is set to true, +this handler will set the value itself in the given storage after the source handler successfully resolved.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn

  • +
  • +

    TOut

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
finished: boolean
+
+ +
handleStorage: boolean
+
+ +
source: AsyncHandler<TIn, TOut>
+
+ +
storage: KeyValueStorage<string, unknown>
+
+ +
storageKey: string
+
+ +
storageValue: unknown
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConditionsParser.html b/7.x/docs/classes/ConditionsParser.html new file mode 100644 index 000000000..70b0cec97 --- /dev/null +++ b/7.x/docs/classes/ConditionsParser.html @@ -0,0 +1,173 @@ +ConditionsParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConditionsParserAbstract

+
+

Creates a Conditions object based on the input HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConfigPodInitializer.html b/7.x/docs/classes/ConfigPodInitializer.html new file mode 100644 index 000000000..027a5376a --- /dev/null +++ b/7.x/docs/classes/ConfigPodInitializer.html @@ -0,0 +1,215 @@ +ConfigPodInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConfigPodInitializer

+
+

Initializes all pods that have been stored and loads them in memory. +This reads the pod settings from a permanent storage and uses those +to create the corresponding ResourceStores in memory, +so this is required every time the server starts.

+

Part of the dynamic pod creation. +Reads the contents from the configuration storage, uses those values to instantiate ResourceStores, +and then adds them to the routing storage.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
configStorage: KeyValueStorage<string, unknown>
+
+ +
logger: Logger = ...
+
+ +
routingStorage: KeyValueStorage<string, ResourceStore>
+
+ +
storeFactory: ComponentsJsFactory
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConfigPodManager.html b/7.x/docs/classes/ConfigPodManager.html new file mode 100644 index 000000000..ba71f2b73 --- /dev/null +++ b/7.x/docs/classes/ConfigPodManager.html @@ -0,0 +1,196 @@ +ConfigPodManager | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConfigPodManager

+
+

Pod manager that creates a store for the pod with a PodGenerator +and fills it with resources from a ResourcesGenerator.

+

Part of the dynamic pod creation.

+
    +
  1. Calls a PodGenerator to instantiate a new resource store for the pod.
  2. +
  3. Generates the pod resources based on the templates as usual.
  4. +
  5. Adds the created pod to the routing storage, which is used for linking pod identifiers to their resource stores.
  6. +
+
+
+
+

Hierarchy

+
    +
  • ConfigPodManager
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
podGenerator: PodGenerator
+
+ +
resourcesGenerator: ResourcesGenerator
+
+ +
routingStorage: KeyValueStorage<string, ResourceStore>
+
+ +
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConflictHttpError.html b/7.x/docs/classes/ConflictHttpError.html new file mode 100644 index 000000000..a5124c95d --- /dev/null +++ b/7.x/docs/classes/ConflictHttpError.html @@ -0,0 +1,228 @@ +ConflictHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConflictHttpError

+
+

An error thrown when a request conflict with current state of the server.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • ConflictHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 409
+
+ +
isInstance: ((error) => error is HttpError<409>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<409>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<409>

      +
+
+ +
statusCode: 409
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConsentHandler.html b/7.x/docs/classes/ConsentHandler.html new file mode 100644 index 000000000..045df518b --- /dev/null +++ b/7.x/docs/classes/ConsentHandler.html @@ -0,0 +1,251 @@ +ConsentHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConsentHandler

+
+

Handles the OIDC consent prompts where the user confirms they want to log in for the given client.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
providerFactory: ProviderFactory
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Either returns the grant associated with the given interaction or creates a new one if it does not exist yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      oidcInteraction: Interaction
    +

    Returns Promise<Grant>

    +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Updates the grant with all the missing scopes and claims requested by the interaction.

    +

    Will reject the offline_access scope if remember is false.

    +
    +
    +

    Parameters

    +
      +
    • +
      grant: Grant
    • +
    • +
      details: UnknownObject
    • +
    • +
      remember: boolean
    +

    Returns void

    +
+
+ +
    + +
  • +

    Updates the interaction with the new grant and returns the resulting redirect URL.

    +
    +
    +

    Parameters

    +
      +
    • +
      oidcInteraction: Interaction
    • +
    • +
      grant: Grant
    +

    Returns Promise<string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConstantConverter.html b/7.x/docs/classes/ConstantConverter.html new file mode 100644 index 000000000..626220d6e --- /dev/null +++ b/7.x/docs/classes/ConstantConverter.html @@ -0,0 +1,233 @@ +ConstantConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConstantConverter

+
+

A RepresentationConverter that ensures +a representation for a certain content type is available.

+

Representations of the same content type are served as is; +others are replaced by a constant document.

+

This can for example be used to serve an index.html file, +which could then interactively load another representation.

+

Options default to the most permissive values when not defined.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
contentType: string
+
+ +
filePath: string
+
+ +
logger: Logger = ...
+
+ +
options: Required<ConstantConverterOptions>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConstantMetadataWriter.html b/7.x/docs/classes/ConstantMetadataWriter.html new file mode 100644 index 000000000..169d3cfe3 --- /dev/null +++ b/7.x/docs/classes/ConstantMetadataWriter.html @@ -0,0 +1,193 @@ +ConstantMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConstantMetadataWriter

+
+

A MetadataWriter that takes a constant map of header names and values.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
headers: [string, string][]
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContainerInitializer.html b/7.x/docs/classes/ContainerInitializer.html new file mode 100644 index 000000000..81034158a --- /dev/null +++ b/7.x/docs/classes/ContainerInitializer.html @@ -0,0 +1,218 @@ +ContainerInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContainerInitializer

+
+

Initializer that sets up a container. +Will copy all the files and folders in the given path to the corresponding documents and containers.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
containerId: ResourceIdentifier
+
+ +
+
+ +
logger: Logger = ...
+
+ +
storage: KeyValueStorage<string, boolean>
+
+ +
storageKey: string
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContainerPathStorage.html b/7.x/docs/classes/ContainerPathStorage.html new file mode 100644 index 000000000..b21d8fe78 --- /dev/null +++ b/7.x/docs/classes/ContainerPathStorage.html @@ -0,0 +1,288 @@ +ContainerPathStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContainerPathStorage<T>

+
+

A KeyValueStorage that prepends a relative path to the key. +Leading slashes of the relative path are trimmed, and a trailing slash is added if needed.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
basePath: string
+
+ +
source: KeyValueStorage<string, T>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContainerToTemplateConverter.html b/7.x/docs/classes/ContainerToTemplateConverter.html new file mode 100644 index 000000000..fe5dbfe76 --- /dev/null +++ b/7.x/docs/classes/ContainerToTemplateConverter.html @@ -0,0 +1,301 @@ +ContainerToTemplateConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContainerToTemplateConverter

+
+

A RepresentationConverter that creates a templated representation of a container.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
contentType: string
+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
inputTypes: Promise<ValuePreferences>
+
+ +
outputTypes: Promise<ValuePreferences>
+
+ +
templateEngine: TemplateEngine<Dict<unknown>>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContentLengthParser.html b/7.x/docs/classes/ContentLengthParser.html new file mode 100644 index 000000000..4c40145ef --- /dev/null +++ b/7.x/docs/classes/ContentLengthParser.html @@ -0,0 +1,198 @@ +ContentLengthParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContentLengthParser

+
+

Parser for the content-length header.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContentTypeMetadataWriter.html b/7.x/docs/classes/ContentTypeMetadataWriter.html new file mode 100644 index 000000000..11dc30adf --- /dev/null +++ b/7.x/docs/classes/ContentTypeMetadataWriter.html @@ -0,0 +1,176 @@ +ContentTypeMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContentTypeMetadataWriter

+
+

Adds the Content-Type header containing value and parameters (if available).

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContentTypeParser.html b/7.x/docs/classes/ContentTypeParser.html new file mode 100644 index 000000000..985e4ca83 --- /dev/null +++ b/7.x/docs/classes/ContentTypeParser.html @@ -0,0 +1,186 @@ +ContentTypeParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContentTypeParser

+
+

Parser for the content-type header.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContentTypeReplacer.html b/7.x/docs/classes/ContentTypeReplacer.html new file mode 100644 index 000000000..b24bb2bc0 --- /dev/null +++ b/7.x/docs/classes/ContentTypeReplacer.html @@ -0,0 +1,243 @@ +ContentTypeReplacer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContentTypeReplacer

+
+

A RepresentationConverter that changes the content type +but does not alter the representation.

+

Useful for when a content type is binary-compatible with another one; +for instance, all JSON-LD files are valid JSON files.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
contentTypeMap: Record<string, ValuePreferences> = {}
+
+

Methods

+
+ +
+
+ +
+
+ +
    + +
  • +

    Find a replacement content type that matches the preferences, +or throws an error if none was found.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<string>

    +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContextDocumentLoader.html b/7.x/docs/classes/ContextDocumentLoader.html new file mode 100644 index 000000000..c9deeaed6 --- /dev/null +++ b/7.x/docs/classes/ContextDocumentLoader.html @@ -0,0 +1,140 @@ +ContextDocumentLoader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContextDocumentLoader

+
+

First, checks whether a context is stored locally before letting the super class do a fetch. +This can be used when converting JSON-LD with Comunica-related libraries, such as rdf-parse.

+

To use this, add this document loader to the options of the call +using the KeysRdfParseJsonLd.documentLoader.name key. +All extra keys get passed in the Comunica ActionContext +and this is the key that is used to define the document loader. +See https://github.com/rubensworks/rdf-parse.js/blob/master/lib/RdfParser.ts +and https://github.com/comunica/comunica/blob/master/packages/actor-rdf-parse-jsonld/lib/ActorRdfParseJsonLd.ts

+
+
+
+

Hierarchy

+
    +
  • FetchDocumentLoader +
      +
    • ContextDocumentLoader
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
contexts: Record<string, IJsonLdContext>
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ControlHandler.html b/7.x/docs/classes/ControlHandler.html new file mode 100644 index 000000000..d87754101 --- /dev/null +++ b/7.x/docs/classes/ControlHandler.html @@ -0,0 +1,277 @@ +ControlHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ControlHandler

+
+

Creates an object with the keys matching those of the input controls, +and the values being the results received by the matching values in the same input.

+

If source is defined, the controls will be added to the output of that handler after passing the input. +In case the control keys conflict with a key already present in the resulting object, +the results will be merged.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
controls: Record<string, InteractionRoute<never> | JsonInteractionHandler<Dict<Json>>>
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Merge the two objects. +Generally this will probably not be necessary, or be very simple merges, +but this ensures that we handle all possibilities.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional original: Json
    • +
    • +
      Optional controls: Json
    +

    Returns Json

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConvertingErrorHandler.html b/7.x/docs/classes/ConvertingErrorHandler.html new file mode 100644 index 000000000..58d776aa8 --- /dev/null +++ b/7.x/docs/classes/ConvertingErrorHandler.html @@ -0,0 +1,247 @@ +ConvertingErrorHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConvertingErrorHandler

+
+

Converts an error into a Representation of content type internal/error. +Then feeds that representation into its converter to create a representation based on the given preferences.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
preferenceParser: PreferenceParser
+
+ +
showStackTrace: boolean
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConvertingNotificationSerializer.html b/7.x/docs/classes/ConvertingNotificationSerializer.html new file mode 100644 index 000000000..8f120eea1 --- /dev/null +++ b/7.x/docs/classes/ConvertingNotificationSerializer.html @@ -0,0 +1,200 @@ +ConvertingNotificationSerializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConvertingNotificationSerializer

+
+

Converts a serialization based on the provided accept feature value. +In case none was provided no conversion takes place.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConvertingOperationHttpHandler.html b/7.x/docs/classes/ConvertingOperationHttpHandler.html new file mode 100644 index 000000000..102e0f9b9 --- /dev/null +++ b/7.x/docs/classes/ConvertingOperationHttpHandler.html @@ -0,0 +1,200 @@ +ConvertingOperationHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConvertingOperationHttpHandler

+
+

An OperationHttpHandler that converts the response of its handler based on the Operation preferences. +If there are no preferences, or no data, the response will be returned as-is.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
operationHandler: OperationHttpHandler
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConvertingPatcher.html b/7.x/docs/classes/ConvertingPatcher.html new file mode 100644 index 000000000..43fcdfada --- /dev/null +++ b/7.x/docs/classes/ConvertingPatcher.html @@ -0,0 +1,242 @@ +ConvertingPatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConvertingPatcher

+
+

A ConvertingPatcher converts a document to its intermediateType, +sends the result to the wrapped patcher, and then converts back to its original type. +No changes will take place if no intermediateType is provided.

+

In case there is no resource yet and a new one needs to be created, +the result of the wrapped patcher will be converted to the provided defaultType. +In case no defaultType is provided, the patcher output will be returned directly.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
defaultType?: string
+
+ +
intermediateType?: string
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConvertingRouterRule.html b/7.x/docs/classes/ConvertingRouterRule.html new file mode 100644 index 000000000..73c660fc3 --- /dev/null +++ b/7.x/docs/classes/ConvertingRouterRule.html @@ -0,0 +1,251 @@ +ConvertingRouterRule | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConvertingRouterRule

+
+

Rule that directs requests based on how the data would need to be converted. +In case the given converter can convert the data to the requested type, +it will be directed to the convertStore. +Otherwise the defaultStore will be chosen.

+

In case there is no data and only an identifier the defaultStore will be checked +if it contains the given identifier. +If not, the convertStore will be returned.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
defaultStore: ResourceStore
+
+ +
typedStores: ConvertingStoreEntry[]
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Helper function that runs the given callback function for all the stores +and returns the first one that does not throw an error.

    +

    Returns the default store if no match was found.

    +
    +
    +

    Parameters

    +
      +
    • +
      supports: ((entry) => Promise<boolean>)
      +
        +
      • +
          +
        • (entry): Promise<boolean>
        • +
        • +
          +

          Parameters

          +
          +

          Returns Promise<boolean>

    +

    Returns Promise<ResourceStore>

    +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CookieInteractionHandler.html b/7.x/docs/classes/CookieInteractionHandler.html new file mode 100644 index 000000000..735aa0f76 --- /dev/null +++ b/7.x/docs/classes/CookieInteractionHandler.html @@ -0,0 +1,212 @@ +CookieInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CookieInteractionHandler

+
+

Handles all the necessary steps for having cookies. +Refreshes the cookie expiration if there was a successful account interaction. +Adds the cookie and cookie expiration data to the output metadata, +unless it is already present in that metadata. +Checks the account settings to see if the cookie needs to be remembered.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accountStore: AccountStore
+
+ +
cookieStore: CookieStore
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CookieMetadataWriter.html b/7.x/docs/classes/CookieMetadataWriter.html new file mode 100644 index 000000000..020e49107 --- /dev/null +++ b/7.x/docs/classes/CookieMetadataWriter.html @@ -0,0 +1,208 @@ +CookieMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CookieMetadataWriter

+
+

Generates the necessary Set-Cookie header if a cookie value is detected in the metadata. +The keys of the input cookieMap should be the URIs of the predicates +used in the metadata when the object is a cookie value. +The value of the map are objects that contain the name of the cookie, +and the URI that is used to store the expiration date in the metadata, if any. +If no expiration date is found in the metadata, none will be set for the cookie, +causing it to be a session cookie.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cookieMap: Map<NamedNode<string>, {
    expirationUri?: NamedNode<string>;
    name: string;
}>
+
+

Type declaration

+
    +
  • +
    Optional expirationUri?: NamedNode<string>
  • +
  • +
    name: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CookieParser.html b/7.x/docs/classes/CookieParser.html new file mode 100644 index 000000000..2d8991255 --- /dev/null +++ b/7.x/docs/classes/CookieParser.html @@ -0,0 +1,208 @@ +CookieParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CookieParser

+
+

Parses the cookie header and stores their values as metadata. +The keys of the input cookieMap should be the cookie names, +and the values the corresponding predicate that should be used to store the value in the metadata. +The values of the cookies will be used as objects in the generated triples

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cookieMap: Record<string, NamedNode<string>>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CorsHandler.html b/7.x/docs/classes/CorsHandler.html new file mode 100644 index 000000000..7ba90095d --- /dev/null +++ b/7.x/docs/classes/CorsHandler.html @@ -0,0 +1,250 @@ +CorsHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CorsHandler

+
+

Handler that sets CORS options on the response. +In case of an OPTIONS request this handler will close the connection after adding its headers +if preflightContinue is set to false.

+

Solid, §8.1: "A server MUST implement the CORS protocol [FETCH] such that, to the extent possible, +the browser allows Solid apps to send any request and combination of request headers to the server, +and the Solid app can read any response and response headers received from the server." +Full details: https://solidproject.org/TR/2021/protocol-20211217#cors-server

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
corsHandler: ((req, res, next) => void)
+
+

Type declaration

+
    +
  • +
      +
    • (req, res, next): void
    • +
    • +
      +

      Parameters

      +
        +
      • +
        req: CorsRequest
      • +
      • +
        res: {
            end: (() => unknown);
            setHeader: ((key, value) => unknown);
            statusCode?: number;
        }
        +
          +
        • +
          end: (() => unknown)
          +
            +
          • +
              +
            • (): unknown
            • +
            • +

              Returns unknown

        • +
        • +
          setHeader: ((key, value) => unknown)
          +
            +
          • +
              +
            • (key, value): unknown
            • +
            • +
              +

              Parameters

              +
                +
              • +
                key: string
              • +
              • +
                value: string
              +

              Returns unknown

        • +
        • +
          Optional statusCode?: number
      • +
      • +
        next: ((err?) => unknown)
        +
          +
        • +
            +
          • (err?): unknown
          • +
          • +
            +

            Parameters

            +
              +
            • +
              Optional err: unknown
            +

            Returns unknown

      +

      Returns void

+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreateAccountHandler.html b/7.x/docs/classes/CreateAccountHandler.html new file mode 100644 index 000000000..8b6d9239d --- /dev/null +++ b/7.x/docs/classes/CreateAccountHandler.html @@ -0,0 +1,265 @@ +CreateAccountHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreateAccountHandler

+
+

Creates new accounts using an AccountStore;

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accountStore: AccountStore
+
+ +
cookieStore: CookieStore
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Updates the account setting that determines whether the login status needs to be remembered.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      ID of the account.

      +
      +
    • +
    • +
      Optional remember: boolean
      +

      If the account should be remembered or not. The setting will not be updated if this is undefined.

      +
      +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreateClientCredentialsHandler.html b/7.x/docs/classes/CreateClientCredentialsHandler.html new file mode 100644 index 000000000..f925fe577 --- /dev/null +++ b/7.x/docs/classes/CreateClientCredentialsHandler.html @@ -0,0 +1,235 @@ +CreateClientCredentialsHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreateClientCredentialsHandler

+
+

Handles the creation of client credential tokens.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clientCredentialsRoute: ClientCredentialsIdRoute
+
+ +
clientCredentialsStore: ClientCredentialsStore
+
+ +
logger: Logger = ...
+
+ +
webIdStore: WebIdStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreateModesExtractor.html b/7.x/docs/classes/CreateModesExtractor.html new file mode 100644 index 000000000..e7bc94403 --- /dev/null +++ b/7.x/docs/classes/CreateModesExtractor.html @@ -0,0 +1,199 @@ +CreateModesExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreateModesExtractor

+
+

Adds the create access mode to the result of the source in case the target resource does not exist.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
resourceSet: ResourceSet
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      operation: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreatePasswordHandler.html b/7.x/docs/classes/CreatePasswordHandler.html new file mode 100644 index 000000000..1e37bfa67 --- /dev/null +++ b/7.x/docs/classes/CreatePasswordHandler.html @@ -0,0 +1,226 @@ +CreatePasswordHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreatePasswordHandler

+
+

Handles the creation of email/password login combinations for an account.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
passwordRoute: PasswordIdRoute
+
+ +
passwordStore: PasswordStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreatePodHandler.html b/7.x/docs/classes/CreatePodHandler.html new file mode 100644 index 000000000..9b13b7569 --- /dev/null +++ b/7.x/docs/classes/CreatePodHandler.html @@ -0,0 +1,268 @@ +CreatePodHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreatePodHandler

+
+

Handles the creation of pods. +Will call the stored PodCreator with the settings found in the input JSON.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
inSchema: ObjectSchema<{
    name: undefined | string;
    settings: undefined | ({ webId?: string | undefined; });
}, AnyObject, {
    name: undefined;
    settings: { webId: undefined; };
}, "">
+
+

Type declaration

+
    +
  • +
    name: undefined | string
  • +
  • +
    settings: undefined | ({ webId?: string | undefined; })
+
+

Type declaration

+
    +
  • +
    name: undefined
  • +
  • +
    settings: { webId: undefined; }
+
+ +
logger: Logger = ...
+
+ +
podCreator: PodCreator
+
+ +
podIdRoute: PodIdRoute
+
+ +
podStore: PodStore
+
+ +
webIdLinkRoute: WebIdLinkRoute
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreatedResponseDescription.html b/7.x/docs/classes/CreatedResponseDescription.html new file mode 100644 index 000000000..ebe8e6ca5 --- /dev/null +++ b/7.x/docs/classes/CreatedResponseDescription.html @@ -0,0 +1,129 @@ +CreatedResponseDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreatedResponseDescription

+
+

Corresponds to a 201 response, containing the relevant location metadata.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
data?: Guarded<Readable>
+
+ +
+
+ +
statusCode: number
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CredentialsExtractor.html b/7.x/docs/classes/CredentialsExtractor.html new file mode 100644 index 000000000..0b97ea5a5 --- /dev/null +++ b/7.x/docs/classes/CredentialsExtractor.html @@ -0,0 +1,177 @@ +CredentialsExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CredentialsExtractorAbstract

+
+

Responsible for extracting credentials from an incoming request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DPoPWebIdExtractor.html b/7.x/docs/classes/DPoPWebIdExtractor.html new file mode 100644 index 000000000..7c6db30bc --- /dev/null +++ b/7.x/docs/classes/DPoPWebIdExtractor.html @@ -0,0 +1,208 @@ +DPoPWebIdExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DPoPWebIdExtractor

+
+

Credentials extractor that extracts a WebID from a DPoP-bound access token.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
originalUrlExtractor: TargetExtractor
+
+ +
verify: SolidTokenVerifierFunction = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DataAccessorBasedStore.html b/7.x/docs/classes/DataAccessorBasedStore.html new file mode 100644 index 000000000..653a0fc4f --- /dev/null +++ b/7.x/docs/classes/DataAccessorBasedStore.html @@ -0,0 +1,851 @@ +DataAccessorBasedStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DataAccessorBasedStore

+
+

ResourceStore which uses a DataAccessor for backend access.

+

The DataAccessor interface provides elementary store operations such as read and write. +This DataAccessorBasedStore uses those elementary store operations +to implement the more high-level ResourceStore contact, abstracting all common functionality +such that new stores can be added by implementing the more simple DataAccessor contract. +DataAccessorBasedStore thereby provides behaviours for reuse across different stores, such as:

+
    +
  • Converting container metadata to data
  • +
  • Converting slug to URI
  • +
  • Checking if addResource target is a container
  • +
  • Checking if no containment triples are written to a container
  • +
  • etc.
  • +
+

Currently "metadata" is seen as something that is not directly accessible. +That means that a consumer can't write directly to the metadata of a resource, only indirectly through headers. +(Except for containers where data and metadata overlap).

+

The one thing this store does not take care of (yet?) are containment triples for containers

+

Work has been done to minimize the number of required calls to the DataAccessor, +but the main disadvantage is that sometimes multiple calls are required where a specific store might only need one.

+
+
+
+

Hierarchy

+
    +
  • DataAccessorBasedStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accessor: DataAccessor
+
+ +
auxiliaryStrategy: AuxiliaryStrategy
+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
logger: Logger = ...
+
+ +
metadataStrategy: AuxiliaryStrategy
+
+

Methods

+
+ +
    + +
  • +

    Generates activity metadata for a resource and adds it to the ChangeMap

    +
    +
    +

    Parameters

    +
      +
    • +
      map: ChangeMap
      +

      ChangeMap to update.

      +
      +
    • +
    • +
      id: ResourceIdentifier
      +

      Identifier of the resource being changed.

      +
      +
    • +
    • +
      activity: NamedNode<string>
      +

      Which activity is taking place.

      +
      +
    +

    Returns void

    +
+
+ +
    + +
  • +

    Generates activity metadata specifically for Add/Remove events on a container.

    +
    +
    +

    Parameters

    +
      +
    • +
      map: ChangeMap
      +

      ChangeMap to update.

      +
      +
    • +
    • +
      id: ResourceIdentifier
      +

      Identifier of the container.

      +
      +
    • +
    • +
      add: boolean
      +

      If there is a resource being added (true) or removed (false).

      +
      +
    • +
    • +
      object: ResourceIdentifier
      +

      The object that is being added/removed.

      +
      +
    +

    Returns void

    +
+
+ +
+
+ +
    + +
  • +

    Clean http Slug to be compatible with the server. Makes sure there are no unwanted characters, +e.g., cleanslug('&%26') returns '%26%26'

    +
    +
    +

    Parameters

    +
      +
    • +
      slug: string
      +

      the slug to clean

      +
      +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Create containers starting from the root until the given identifier corresponds to an existing container. +Will throw errors if the identifier of the last existing "container" corresponds to an existing document.

    +
    +
    +

    Parameters

    +
      +
    • +
      container: ResourceIdentifier
      +

      Identifier of the container which will need to exist.

      +
      +
    +

    Returns Promise<ChangeMap>

    +
+
+ +
+
+ +
    + +
  • +

    Generates a new URI for a resource in the given container, potentially using the given slug.

    +

    Solid, §5.3: "Servers MUST allow creating new resources with a POST request to URI path ending /. +Servers MUST create a resource with URI path ending /{id} in container /. +Servers MUST create a container with URI path ending /{id}/ in container / for requests +including the HTTP Link header with rel="type" targeting a valid LDP container type." +https://solid.github.io/specification/protocol#writing-resources

    +
    +
    +

    Parameters

    +
      +
    • +
      container: ResourceIdentifier
      +

      Parent container of the new URI.

      +
      +
    • +
    • +
      isContainer: boolean
      +

      Does the new URI represent a container?

      +
      +
    • +
    • +
      Optional slug: string
      +

      Slug to use for the new URI.

      +
      +
    +

    Returns ResourceIdentifier

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Warns when the representation has data and removes the content-type from the metadata.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Checks in a list of types if any of them match a Container type.

    +
    +
    +

    Parameters

    +
      +
    • +
      rdfTypes: Term[]
    +

    Returns boolean

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Sets or updates the representation of a resource, +creating a new resource and intermediary containers as needed.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      Identifier of resource to update.

      +
      +
    • +
    • +
      patch: Patch
      +

      Description of which parts to update.

      +
      +
    • +
    • +
      Optional conditions: Conditions
      +

      Optional conditions under which to proceed.

      +
      +
    +

    Returns Promise<never>

    A ChangeMap.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Validates if the slug and headers are valid. +Errors if slug exists, ends on slash, but ContainerType Link header is NOT present

    +
    +
    +

    Parameters

    +
      +
    • +
      isContainer: boolean
      +

      Is the slug supposed to represent a container?

      +
      +
    • +
    • +
      Optional slug: string
      +

      Is the requested slug (if any).

      +
      +
    +

    Returns void

    +
+
+ +
    + +
  • +

    Write the given resource to the DataAccessor. Metadata will be updated with necessary triples. +For containers, handleContainerData will be used to verify the data.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      Identifier of the resource.

      +
      +
    • +
    • +
      representation: Representation
      +

      Corresponding Representation.

      +
      +
    • +
    • +
      isContainer: boolean
      +

      Is the incoming resource a container?

      +
      +
    • +
    • +
      createContainers: boolean
      +

      Should parent containers (potentially) be created?

      +
      +
    • +
    • +
      exists: boolean
      +

      If the resource already exists.

      +
      +
    +

    Returns Promise<ChangeMap>

    Identifiers of resources that were possibly modified.

    + +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DeleteClientCredentialsHandler.html b/7.x/docs/classes/DeleteClientCredentialsHandler.html new file mode 100644 index 000000000..2ebb4d58b --- /dev/null +++ b/7.x/docs/classes/DeleteClientCredentialsHandler.html @@ -0,0 +1,199 @@ +DeleteClientCredentialsHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DeleteClientCredentialsHandler

+
+

Handles the deletion of client credentials tokens.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clientCredentialsRoute: ClientCredentialsIdRoute
+
+ +
clientCredentialsStore: ClientCredentialsStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DeleteNotificationGenerator.html b/7.x/docs/classes/DeleteNotificationGenerator.html new file mode 100644 index 000000000..ea8f6b572 --- /dev/null +++ b/7.x/docs/classes/DeleteNotificationGenerator.html @@ -0,0 +1,173 @@ +DeleteNotificationGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DeleteNotificationGenerator

+
+

Generates a Notification for a resource that was deleted. +This differs from other activity notifications in that there is no state and no resource metadata +since the resource no longer exists.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DeleteOperationHandler.html b/7.x/docs/classes/DeleteOperationHandler.html new file mode 100644 index 000000000..3a82d4c72 --- /dev/null +++ b/7.x/docs/classes/DeleteOperationHandler.html @@ -0,0 +1,191 @@ +DeleteOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DeleteOperationHandler

+
+

Handles DELETE Operations. +Calls the deleteResource function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DeleteParentExtractor.html b/7.x/docs/classes/DeleteParentExtractor.html new file mode 100644 index 000000000..d8281aa77 --- /dev/null +++ b/7.x/docs/classes/DeleteParentExtractor.html @@ -0,0 +1,213 @@ +DeleteParentExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DeleteParentExtractor

+
+

In case a resource is being deleted but does not exist, +the server response code depends on the access modes the agent has on the parent container. +In case the agent has read access on the parent container, a 404 should be returned, +otherwise it should be 401/403.

+

This class adds support for this by requiring read access on the parent container +in case the target resource does not exist.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
resourceSet: ResourceSet
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      operation: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DeletePasswordHandler.html b/7.x/docs/classes/DeletePasswordHandler.html new file mode 100644 index 000000000..0f20bdf62 --- /dev/null +++ b/7.x/docs/classes/DeletePasswordHandler.html @@ -0,0 +1,199 @@ +DeletePasswordHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DeletePasswordHandler

+
+

Handles the deletion of a password login method.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
passwordRoute: PasswordIdRoute
+
+ +
passwordStore: PasswordStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DynamicJsonToTemplateConverter.html b/7.x/docs/classes/DynamicJsonToTemplateConverter.html new file mode 100644 index 000000000..69c9f0490 --- /dev/null +++ b/7.x/docs/classes/DynamicJsonToTemplateConverter.html @@ -0,0 +1,240 @@ +DynamicJsonToTemplateConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DynamicJsonToTemplateConverter

+
+

Converts JSON data by using it as input parameters for rendering a template. +The extension field can be used to only support a specific type of templates, +such as ".ejs" for EJS templates.

+

To find the templates it expects the Representation metadata to contain SOLID_META.template triples, +with the objects being the template paths. +For each of those templates there also needs to be a CONTENT_TYPE triple +describing the content-type of that template.

+

The output of the result depends on the content-type matched with the template. +In case JSON is the most preferred output type, +the input representation will be returned unless a JSON template is defined.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
templateEngine: TemplateEngine<Dict<unknown>>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/EjsTemplateEngine.html b/7.x/docs/classes/EjsTemplateEngine.html new file mode 100644 index 000000000..b59d2e4f1 --- /dev/null +++ b/7.x/docs/classes/EjsTemplateEngine.html @@ -0,0 +1,217 @@ +EjsTemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class EjsTemplateEngine<T>

+
+

Fills in EJS templates.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseUrl: string
+
+ +
supportedExtensions: string[]
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/EmailSender.html b/7.x/docs/classes/EmailSender.html new file mode 100644 index 000000000..f157b7de9 --- /dev/null +++ b/7.x/docs/classes/EmailSender.html @@ -0,0 +1,173 @@ +EmailSender | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class EmailSenderAbstract

+
+

A class that can send an e-mail.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: EmailArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: EmailArgs
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: EmailArgs
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/EqualReadWriteLocker.html b/7.x/docs/classes/EqualReadWriteLocker.html new file mode 100644 index 000000000..36f9e9a02 --- /dev/null +++ b/7.x/docs/classes/EqualReadWriteLocker.html @@ -0,0 +1,240 @@ +EqualReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class EqualReadWriteLocker

+
+

A ReadWriteLocker that gives no priority to read or write operations: both use the same lock.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Acquires a new lock for the requested identifier. +Will resolve when the input function resolves.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    +
+
+ +
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+ +
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ErrorHandler.html b/7.x/docs/classes/ErrorHandler.html new file mode 100644 index 000000000..7fb4b683b --- /dev/null +++ b/7.x/docs/classes/ErrorHandler.html @@ -0,0 +1,175 @@ +ErrorHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ErrorHandlerAbstract

+
+

Converts an error into a ResponseDescription based on the request preferences.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ErrorToJsonConverter.html b/7.x/docs/classes/ErrorToJsonConverter.html new file mode 100644 index 000000000..d8f6c854b --- /dev/null +++ b/7.x/docs/classes/ErrorToJsonConverter.html @@ -0,0 +1,230 @@ +ErrorToJsonConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ErrorToJsonConverter

+
+

Converts an Error object to JSON by copying its fields.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
inputTypes: Promise<ValuePreferences>
+
+ +
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ErrorToQuadConverter.html b/7.x/docs/classes/ErrorToQuadConverter.html new file mode 100644 index 000000000..69afa24b4 --- /dev/null +++ b/7.x/docs/classes/ErrorToQuadConverter.html @@ -0,0 +1,215 @@ +ErrorToQuadConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ErrorToQuadConverter

+
+

Converts an error object into quads by creating a triple for each of name/message/stack.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
inputTypes: Promise<ValuePreferences>
+
+ +
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ErrorToTemplateConverter.html b/7.x/docs/classes/ErrorToTemplateConverter.html new file mode 100644 index 000000000..c793a0885 --- /dev/null +++ b/7.x/docs/classes/ErrorToTemplateConverter.html @@ -0,0 +1,264 @@ +ErrorToTemplateConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ErrorToTemplateConverter

+
+

Serializes an Error by filling in the provided template. +Content-type is based on the constructor parameter.

+

In case the input Error has an errorCode value, +the converter will look in the descriptions for a file +with the exact same name as that error code + extension. +The templating engine will then be applied to that file. +That result will be passed as an additional parameter to the main templating call, +using the variable codeMessage.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
codeTemplatesPath: string
+
+ +
contentType: string
+
+ +
extension: string
+
+ +
inputTypes: Promise<ValuePreferences>
+
+ +
mainTemplatePath: string
+
+ +
outputTypes: Promise<ValuePreferences>
+
+ +
templateEngine: TemplateEngine<Dict<unknown>>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ExpiringAdapter.html b/7.x/docs/classes/ExpiringAdapter.html new file mode 100644 index 000000000..94b5484ec --- /dev/null +++ b/7.x/docs/classes/ExpiringAdapter.html @@ -0,0 +1,311 @@ +ExpiringAdapter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ExpiringAdapter

+
+

An IDP storage adapter that uses an ExpiringStorage +to persist data.

+
+
+
+

Hierarchy

+
    +
  • ExpiringAdapter
+
+

Implements

+
    +
  • Adapter
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
name: string
+
+ +
storage: ExpiringStorage<string, unknown>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      id: string
    • +
    • +
      payload: AdapterPayload
    • +
    • +
      Optional expiresIn: number
    +

    Returns Promise<void>

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ExpiringAdapterFactory.html b/7.x/docs/classes/ExpiringAdapterFactory.html new file mode 100644 index 000000000..23f77521c --- /dev/null +++ b/7.x/docs/classes/ExpiringAdapterFactory.html @@ -0,0 +1,134 @@ +ExpiringAdapterFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ExpiringAdapterFactory

+
+

The factory for a ExpiringStorageAdapter

+
+
+
+

Hierarchy

+
    +
  • ExpiringAdapterFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
storage: ExpiringStorage<string, unknown>
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ExtensionBasedMapper.html b/7.x/docs/classes/ExtensionBasedMapper.html new file mode 100644 index 000000000..e9a8285b5 --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedMapper.html @@ -0,0 +1,507 @@ +ExtensionBasedMapper | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ExtensionBasedMapper

+
+

Supports the behaviour described in https://www.w3.org/DesignIssues/HTTPFilenameMapping.html +Determines content-type based on the file extension. +In case an identifier does not end on an extension matching its content-type, +the corresponding file will be appended with the correct extension, preceded by $.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseRequestURI: string
+
+ +
customExtensions: Record<string, string>
+
+ +
customTypes: Record<string, string>
+
+ +
logger: Logger = ...
+
+ +
rootFilepath: string
+
+ +
unknownMediaTypeExtension: "unknown" = 'unknown'
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Maps the given document identifier to a file path, +possibly making alterations to the direct translation +(for instance, based on its content type)). +Determines the content type if none was provided.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
    • +
    • +
      filePath: string
      +

      The direct translation of the identifier onto the file path.

      +
      +
    • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
    + +
  • +

    Maps the given resource identifier / URL to a file path. +Determines the content type if none was provided. +For containers the content-type input is ignored.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
    • +
    • +
      isMetadata: boolean
      +

      If we need the data or metadata file path.

      +
      +
    • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
    + +
  • +

    Helper function that removes the internal extension, one starting with $., from the given path. +Nothing happens if no such extension is present.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
    +

    Returns string

    +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ExtensionBasedMapperFactory.html b/7.x/docs/classes/ExtensionBasedMapperFactory.html new file mode 100644 index 000000000..52b70b32b --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedMapperFactory.html @@ -0,0 +1,118 @@ +ExtensionBasedMapperFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ExtensionBasedMapperFactory

+
+

Factory that can create FileIdentifierMappers so the base and rootFilePath can be set dynamically. +Specifically used when identifiers need to be generated for a new pod (since pod identifiers are generated).

+
+
+
+

Hierarchy

+
    +
  • ExtensionBasedMapperFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ExtensionBasedTemplateEngine.html b/7.x/docs/classes/ExtensionBasedTemplateEngine.html new file mode 100644 index 000000000..c3eb2d9b0 --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedTemplateEngine.html @@ -0,0 +1,209 @@ +ExtensionBasedTemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ExtensionBasedTemplateEngine<T>Abstract

+
+

Parent class for template engines that accept handling based on whether the template extension is supported.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
supportedExtensions: string[]
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FileDataAccessor.html b/7.x/docs/classes/FileDataAccessor.html new file mode 100644 index 000000000..dea5cc9cf --- /dev/null +++ b/7.x/docs/classes/FileDataAccessor.html @@ -0,0 +1,561 @@ +FileDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FileDataAccessor

+
+

DataAccessor that uses the file system to store documents as files and containers as folders.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
resourceMapper: FileIdentifierMapper
+
+

Methods

+
+ +
    + +
  • +

    Helper function to add file system related metadata.

    +
    +
    +

    Parameters

    +
      +
    • +
      metadata: RepresentationMetadata
      +

      metadata object to add to

      +
      +
    • +
    • +
      stats: Stats
      +

      Stats of the file/directory corresponding to the resource.

      +
      +
    +

    Returns void

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Reads the metadata from the corresponding metadata file. +Returns an empty array if there is no metadata file.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Quad[]>

    +
+
+ +
    + +
  • +

    Gets the Stats object corresponding to the given file path, +resolving symbolic links.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      File path to get info from.

      +
      +
    +

    Returns Promise<Stats>

    +
    +

    Throws

    NotFoundHttpError +If the file/folder doesn't exist.

    +
+
+ +
    + +
  • +

    Verifies if there already is a file corresponding to the given resource. +If yes, that file is removed if it does not match the path given in the input ResourceLink. +This can happen if the content-type differs from the one that was stored.

    +
    +
    +

    Parameters

    +
      +
    • +
      link: ResourceLink
      +

      ResourceLink corresponding to the new resource data.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
+
+ +
    + +
  • +

    Helper function without extra validation checking to create a data file.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The filepath of the file to be created.

      +
      +
    • +
    • +
      data: Readable
      +

      The data to be put in the file.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FileSizeReporter.html b/7.x/docs/classes/FileSizeReporter.html new file mode 100644 index 000000000..918f8326b --- /dev/null +++ b/7.x/docs/classes/FileSizeReporter.html @@ -0,0 +1,233 @@ +FileSizeReporter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FileSizeReporter

+
+

SizeReporter that is used to calculate sizes of resources for a file based system.

+
+
+
+

Hierarchy

+
    +
  • FileSizeReporter
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
fileIdentifierMapper: FileIdentifierMapper
+
+ +
ignoreFolders: RegExp[]
+
+ +
rootFilePath: string
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Get the total size of a resource and its children if present

    +
    +
    +

    Parameters

    +
      +
    • +
      fileLocation: string
      +

      the resource of which you want the total size of ( on disk )

      +
      +
    +

    Returns Promise<number>

    a number specifying how many bytes are used by the resource

    + +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FileSystemResourceLocker.html b/7.x/docs/classes/FileSystemResourceLocker.html new file mode 100644 index 000000000..14032a7a6 --- /dev/null +++ b/7.x/docs/classes/FileSystemResourceLocker.html @@ -0,0 +1,356 @@ +FileSystemResourceLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FileSystemResourceLocker

+
+

A resource locker making use of the proper-lockfile library. +Note that no locks are kept in memory, thus this is considered thread- and process-safe. +While it stores the actual locks on disk, it also tracks them in memory for when they need to be released. +This means only the worker thread that acquired a lock can release it again, +making this implementation unusable in combination with a wrapping read/write lock implementation.

+

This proper-lockfile library has its own retry mechanism for the operations, since a lock/unlock call will +either resolve successfully or reject immediately with the causing error. The retry function of the library +however will be ignored and replaced by our own LockUtils' retryFunction function.

+
+
+
+

Hierarchy

+
    +
  • FileSystemResourceLocker
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
attemptSettings: Required<AttemptSettings>
+
+ +
finalized: boolean = false
+
+ +
lockFolder: string
+

Folder that stores the locks

+
+
+
+ +
lockOptions: LockOptions
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    This function is used to override the proper-lock onCompromised function. +Once the locker was finalized, it will log the provided error instead of throwing it +This allows for a clean shutdown procedure.

    +
    +
    +

    Parameters

    +
      +
    • +
      err: Error
    +

    Returns void

    +
+
+ +
+
+ +
    + +
  • +

    Generate LockOptions or UnlockOptions depending on the type of defauls given. +A custom lockFilePath mapping strategy will be used.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      ResourceIdentifier to generate (Un)LockOptions for

      +
      +
    • +
    • +
      defaults: T
      +

      The default options. (lockFilePath will get overwritten)

      +
      +
    +

    Returns T

    LockOptions or UnlockOptions

    + +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Wrapper function for all (un)lock operations. Any errors coming from the fn() will be swallowed. +Only ENOTACQUIRED errors wills be thrown (trying to release lock that didn't exist). +This wrapper returns undefined because retryFunction expects that when a retry needs to happen.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: (() => Promise<unknown>)
      +

      The function reference to swallow errors from.

      +
      +
      +
        +
      • +
          +
        • (): Promise<unknown>
        • +
        • +

          Returns Promise<unknown>

    +

    Returns (() => Promise<unknown>)

    Boolean or undefined.

    + +
      +
    • +
        +
      • (): Promise<unknown>
      • +
      • +

        Wrapper function for all (un)lock operations. Any errors coming from the fn() will be swallowed. +Only ENOTACQUIRED errors wills be thrown (trying to release lock that didn't exist). +This wrapper returns undefined because retryFunction expects that when a retry needs to happen.

        +
        +

        Returns Promise<unknown>

        Boolean or undefined.

        + +
    +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FilterMetadataDataAccessor.html b/7.x/docs/classes/FilterMetadataDataAccessor.html new file mode 100644 index 000000000..68307f5c2 --- /dev/null +++ b/7.x/docs/classes/FilterMetadataDataAccessor.html @@ -0,0 +1,374 @@ +FilterMetadataDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FilterMetadataDataAccessor

+
+

A FilterMetadataDataAccessor wraps a DataAccessor such that specific metadata properties +can be filtered before passing on the call to the wrapped DataAccessor.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
filters: FilterPattern[]
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FilterPattern.html b/7.x/docs/classes/FilterPattern.html new file mode 100644 index 000000000..337ee1bad --- /dev/null +++ b/7.x/docs/classes/FilterPattern.html @@ -0,0 +1,137 @@ +FilterPattern | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FilterPattern

+
+

Represents a triple pattern to be used as a filter.

+
+
+
+

Hierarchy

+
    +
  • FilterPattern
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional subject: string
      +

      Optionally filter based on a specific subject.

      +
      +
    • +
    • +
      Optional predicate: string
      +

      Optionally filter based on a predicate.

      +
      +
    • +
    • +
      Optional object: string
      +

      Optionally filter based on a specific object.

      +
      +
    +

    Returns FilterPattern

    +
+
+

Properties

+
+ +
object: null | NamedNode<string>
+
+ +
predicate: null | NamedNode<string>
+
+ +
subject: null | NamedNode<string>
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FinalizableHandler.html b/7.x/docs/classes/FinalizableHandler.html new file mode 100644 index 000000000..d222f3c8f --- /dev/null +++ b/7.x/docs/classes/FinalizableHandler.html @@ -0,0 +1,182 @@ +FinalizableHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FinalizableHandler

+
+

Allows using a Finalizable as a Finalizer Handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
finalizable: Finalizable
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/Finalizer.html b/7.x/docs/classes/Finalizer.html new file mode 100644 index 000000000..f876c21b3 --- /dev/null +++ b/7.x/docs/classes/Finalizer.html @@ -0,0 +1,173 @@ +Finalizer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FinalizerAbstract

+
+

Finalizer is used to indicate an AsyncHandler that performs finalization logic.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FixedContentTypeMapper.html b/7.x/docs/classes/FixedContentTypeMapper.html new file mode 100644 index 000000000..cfe30d07c --- /dev/null +++ b/7.x/docs/classes/FixedContentTypeMapper.html @@ -0,0 +1,504 @@ +FixedContentTypeMapper | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FixedContentTypeMapper

+
+

A mapper that always returns a fixed content type for files.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      base: string
      +

      Base URL.

      +
      +
    • +
    • +
      rootFilepath: string
      +

      Base file path.

      +
      +
    • +
    • +
      contentType: string
      +

      Fixed content type that will be used for all resources.

      +
      +
    • +
    • +
      pathSuffix: string = ''
      +

      An optional suffix that will be appended to all file paths. + Requested file paths without this suffix will be rejected.

      +
      +
    • +
    • +
      urlSuffix: string = ''
      +

      An optional suffix that will be appended to all URL. + Requested URLs without this suffix will be rejected.

      +
      +
    +

    Returns FixedContentTypeMapper

    +
+
+

Properties

+
+ +
baseRequestURI: string
+
+ +
contentType: string
+
+ +
logger: Logger = ...
+
+ +
pathSuffix: string
+
+ +
rootFilepath: string
+
+ +
unknownMediaTypeExtension: "unknown" = 'unknown'
+
+ +
urlSuffix: string
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Maps the given document identifier to a file path, +possibly making alterations to the direct translation +(for instance, based on its content type)). +Determines the content type if none was provided.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
    • +
    • +
      filePath: string
      +

      The direct translation of the identifier onto the file path.

      +
      +
    • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
    + +
  • +

    Maps the given resource identifier / URL to a file path. +Determines the content type if none was provided. +For containers the content-type input is ignored.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
    • +
    • +
      isMetadata: boolean
      +

      If we need the data or metadata file path.

      +
      +
    • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ForbiddenHttpError.html b/7.x/docs/classes/ForbiddenHttpError.html new file mode 100644 index 000000000..1e2758e61 --- /dev/null +++ b/7.x/docs/classes/ForbiddenHttpError.html @@ -0,0 +1,228 @@ +ForbiddenHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ForbiddenHttpError

+
+

An error thrown when an agent is not allowed to access data.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • ForbiddenHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 403
+
+ +
isInstance: ((error) => error is HttpError<403>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<403>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<403>

      +
+
+ +
statusCode: 403
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ForgetWebIdHandler.html b/7.x/docs/classes/ForgetWebIdHandler.html new file mode 100644 index 000000000..54d39b5ae --- /dev/null +++ b/7.x/docs/classes/ForgetWebIdHandler.html @@ -0,0 +1,191 @@ +ForgetWebIdHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ForgetWebIdHandler

+
+

Forgets the chosen WebID in an OIDC interaction, +causing the next policy trigger to be one where a new WebID has to be chosen.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
providerFactory: ProviderFactory
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ForgotPasswordHandler.html b/7.x/docs/classes/ForgotPasswordHandler.html new file mode 100644 index 000000000..9d4917363 --- /dev/null +++ b/7.x/docs/classes/ForgotPasswordHandler.html @@ -0,0 +1,264 @@ +ForgotPasswordHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ForgotPasswordHandler

+
+

Responsible for the case where a user forgot their password and asks for a reset. +Will send out the necessary mail if the email address is known. +The JSON response will always be the same to prevent leaking which email addresses are stored.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
emailSender: EmailSender
+
+ +
forgotPasswordStore: ForgotPasswordStore
+
+ +
logger: Logger = ...
+
+ +
passwordStore: PasswordStore
+
+ +
resetRoute: InteractionRoute<never>
+
+ +
templateEngine: TemplateEngine<{
    resetLink: string;
}>
+
+

Type declaration

+
    +
  • +
    resetLink: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FormToJsonConverter.html b/7.x/docs/classes/FormToJsonConverter.html new file mode 100644 index 000000000..fe7f00d74 --- /dev/null +++ b/7.x/docs/classes/FormToJsonConverter.html @@ -0,0 +1,216 @@ +FormToJsonConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FormToJsonConverter

+
+

Converts application/x-www-form-urlencoded data to application/json. +Due to the nature of form data, the result will be a simple key/value JSON object.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
inputTypes: Promise<ValuePreferences>
+
+ +
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FoundHttpError.html b/7.x/docs/classes/FoundHttpError.html new file mode 100644 index 000000000..9a121e6e2 --- /dev/null +++ b/7.x/docs/classes/FoundHttpError.html @@ -0,0 +1,239 @@ +FoundHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FoundHttpError

+
+

Error used for resources that have been moved temporarily. +Methods other than GET may or may not be changed to GET in subsequent requests.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • FoundHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
location: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 302
+
+ +
isInstance: ((error) => error is HttpError<302>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<302>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<302>

      +
+
+ +
statusCode: 302
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/GeneratedPodManager.html b/7.x/docs/classes/GeneratedPodManager.html new file mode 100644 index 000000000..79752a2ee --- /dev/null +++ b/7.x/docs/classes/GeneratedPodManager.html @@ -0,0 +1,157 @@ +GeneratedPodManager | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class GeneratedPodManager

+
+

Pod manager that uses an IdentifierGenerator and ResourcesGenerator +to create the default resources and identifier for a new pod.

+
+
+
+

Hierarchy

+
    +
  • GeneratedPodManager
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
resourcesGenerator: ResourcesGenerator
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Creates a new pod, pre-populating it with the resources created by the data generator. +Will throw an error if the given identifier already has a resource.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/GetOperationHandler.html b/7.x/docs/classes/GetOperationHandler.html new file mode 100644 index 000000000..7882d82cc --- /dev/null +++ b/7.x/docs/classes/GetOperationHandler.html @@ -0,0 +1,200 @@ +GetOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class GetOperationHandler

+
+

Handles GET Operations. +Calls the getRepresentation function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
eTagHandler: ETagHandler
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/GlobalQuotaStrategy.html b/7.x/docs/classes/GlobalQuotaStrategy.html new file mode 100644 index 000000000..a49376e08 --- /dev/null +++ b/7.x/docs/classes/GlobalQuotaStrategy.html @@ -0,0 +1,227 @@ +GlobalQuotaStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class GlobalQuotaStrategy

+
+

The GlobalQuotaStrategy sets a limit on the amount of data stored on the server globally.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
base: string
+
+ +
limit: Size
+
+ +
reporter: SizeReporter<unknown>
+
+

Methods

+
+ +
    + +
  • +

    Get a Passthrough stream that will keep track of the available space. +If the quota is exceeded the stream will emit an error and destroy itself. +Like other Passthrough instances this will simply pass on the chunks, when the quota isn't exceeded.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Guarded<PassThrough>>

    a Passthrough instance that errors when quota is exceeded

    + +
+
+ +
+
+ +
    + +
  • +

    Get the available space when writing data to the given identifier. +If the given resource already exists it will deduct the already taken up +space by that resource since it is going to be overwritten and thus counts +as available space.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      the identifier of the resource of which you want the available space

      +
      +
    +

    Returns Promise<Size>

    the available space and the unit of the space as a Size object

    + +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/GreedyReadWriteLocker.html b/7.x/docs/classes/GreedyReadWriteLocker.html new file mode 100644 index 000000000..64f36b900 --- /dev/null +++ b/7.x/docs/classes/GreedyReadWriteLocker.html @@ -0,0 +1,354 @@ +GreedyReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class GreedyReadWriteLocker

+
+

A BaseReadWriteLocker that uses the same locker for the main lock and the count lock, +and uses a KeyValueStorage for keeping track of the counter.

+

Since it is completely dependent on other implementations, +this locker is threadsafe if its inputs are as well.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
countLocker: ResourceLocker
+
+ +
countSuffix: string
+
+ +
+
+ +
readSuffix: string
+
+ +
storage: KeyValueStorage<string, number>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+ +
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HandlebarsTemplateEngine.html b/7.x/docs/classes/HandlebarsTemplateEngine.html new file mode 100644 index 000000000..ad94a5482 --- /dev/null +++ b/7.x/docs/classes/HandlebarsTemplateEngine.html @@ -0,0 +1,217 @@ +HandlebarsTemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HandlebarsTemplateEngine<T>

+
+

Fills in Handlebars templates.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseUrl: string
+
+ +
supportedExtensions: string[]
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HandlerServerConfigurator.html b/7.x/docs/classes/HandlerServerConfigurator.html new file mode 100644 index 000000000..f299665ab --- /dev/null +++ b/7.x/docs/classes/HandlerServerConfigurator.html @@ -0,0 +1,245 @@ +HandlerServerConfigurator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HandlerServerConfigurator

+
+

A ServerConfigurator that attaches an HttpHandler to the request event of a Server. +All incoming requests will be sent to the provided handler. +Failsafes are added to make sure a valid response is sent in case something goes wrong.

+

The showStackTrace parameter can be used to add stack traces to error outputs.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
handler: HttpHandler
+

The main HttpHandler

+
+
+
+ +
logger: Logger = ...
+
+ +
showStackTrace: boolean
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Creates a readable error message based on the error and the showStackTrace parameter.

    +
    +
    +

    Parameters

    +
      +
    • +
      error: unknown
    +

    Returns string

    +
+
+ +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      server: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HashEncodingStorage.html b/7.x/docs/classes/HashEncodingStorage.html new file mode 100644 index 000000000..4699b72dc --- /dev/null +++ b/7.x/docs/classes/HashEncodingStorage.html @@ -0,0 +1,282 @@ +HashEncodingStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HashEncodingStorage<T>

+
+

Encodes the input key with SHA-256 hashing, +to make sure there are no invalid or special path characters.

+

This class was created specifically to prevent the issue of identifiers being too long when storing data: +https://github.com/CommunitySolidServer/CommunitySolidServer/issues/1013

+

This should eventually be replaced by a more structural approach once internal storage has been refactored +and data migration from older versions and formats is supported.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
source: KeyValueStorage<string, T>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HashMap.html b/7.x/docs/classes/HashMap.html new file mode 100644 index 000000000..f358ad24e --- /dev/null +++ b/7.x/docs/classes/HashMap.html @@ -0,0 +1,346 @@ +HashMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HashMap<TKey, TVal>

+
+

A Map implementation that maps the Key object to a string using the provided hash function. +This ensures that equal objects that are not the same instance are mapped to the same value.

+
+
+
+

Type Parameters

+
    +
  • +

    TKey = unknown

  • +
  • +

    TVal = unknown

+
+

Hierarchy

+
+
+

Implements

+
    +
  • Map<TKey, TVal>
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Accessors

+
+
+

Methods

+
+
+

Constructors

+
+ +
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      TKey = unknown

    • +
    • +

      TVal = unknown

    +
    +

    Parameters

    +
      +
    • +
      hashFn: ((key) => string)
      +
        +
      • +
          +
        • (key): string
        • +
        • +
          +

          Parameters

          +
            +
          • +
            key: TKey
          +

          Returns string

    • +
    • +
      Optional iterable: Iterable<readonly [TKey, TVal]>
    +

    Returns HashMap<TKey, TVal>

+
+

Properties

+
+ +
[toStringTag]: "HashMap" = 'HashMap'
+
+ +
hashFn: ((key) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (key): string
    • +
    • +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns string

+
+ +
hashMap: Map<string, Entry<TKey, TVal>>
+
+

Accessors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Returns IterableIterator<[TKey, TVal]>

+
+ +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns boolean

+
+ +
    + +
  • +

    Returns IterableIterator<[TKey, TVal]>

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      callbackfn: ((value, key, map) => void)
      +
        +
      • +
          +
        • (value, key, map): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            value: TVal
          • +
          • +
            key: TKey
          • +
          • +
            map: Map<TKey, TVal>
          +

          Returns void

    • +
    • +
      Optional thisArg: unknown
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns undefined | TVal

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns boolean

+
+ +
    + +
  • +

    Returns IterableIterator<TKey>

+
+ +
+
+ +
    + +
  • +

    Returns IterableIterator<TVal>

+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HeadOperationHandler.html b/7.x/docs/classes/HeadOperationHandler.html new file mode 100644 index 000000000..43b6e774a --- /dev/null +++ b/7.x/docs/classes/HeadOperationHandler.html @@ -0,0 +1,200 @@ +HeadOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HeadOperationHandler

+
+

Handles HEAD Operations. +Calls the getRepresentation function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
eTagHandler: ETagHandler
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HeaderHandler.html b/7.x/docs/classes/HeaderHandler.html new file mode 100644 index 000000000..c7f00241a --- /dev/null +++ b/7.x/docs/classes/HeaderHandler.html @@ -0,0 +1,193 @@ +HeaderHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HeaderHandler

+
+

Handler that sets custom headers on the response.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
headers: Record<string, string>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HtmlViewEntry.html b/7.x/docs/classes/HtmlViewEntry.html new file mode 100644 index 000000000..25dfcafce --- /dev/null +++ b/7.x/docs/classes/HtmlViewEntry.html @@ -0,0 +1,121 @@ +HtmlViewEntry | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HtmlViewEntry

+
+

Used to link file paths and URLs together. +The reason we use a separate object instead of a key/value Record, +is that this makes it easier to override the values in Components.js, +which can be useful if someone wants to replace the HTML for certain URLs.

+
+
+
+

Hierarchy

+
    +
  • HtmlViewEntry
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
filePath: string
+
+ +
route: InteractionRoute<never>
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HtmlViewHandler.html b/7.x/docs/classes/HtmlViewHandler.html new file mode 100644 index 000000000..f5c987816 --- /dev/null +++ b/7.x/docs/classes/HtmlViewHandler.html @@ -0,0 +1,232 @@ +HtmlViewHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HtmlViewHandler

+
+

Stores the HTML templates associated with specific InteractionRoutes.

+

This class will only handle GET operations for which there is a matching template, +if HTML is more preferred than JSON. +The reason for doing it like this instead of a standard content negotiation flow, +is because we only want to return the HTML pages on GET requests.

+

Templates will receive the parameter idpIndex in their context pointing to the root index URL of the IDP API +and an authenticating parameter indicating if this is an active OIDC interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
idpIndex: string
+
+ +
templateEngine: TemplateEngine<Dict<unknown>>
+
+ +
templates: HtmlViewEntry[]
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HttpError.html b/7.x/docs/classes/HttpError.html new file mode 100644 index 000000000..3c42042ef --- /dev/null +++ b/7.x/docs/classes/HttpError.html @@ -0,0 +1,289 @@ +HttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HttpError<T>

+
+

A class for all errors that could be thrown by Solid. +All errors inheriting from this should fix the status code thereby hiding the HTTP internals from other components.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends number = number

+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
    + +
  • +

    Creates a new HTTP error. Subclasses should call this with their fixed status code.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends number = number

    +
    +

    Parameters

    +
      +
    • +
      statusCode: T
      +

      HTTP status code needed for the HTTP response.

      +
      +
    • +
    • +
      name: string
      +

      Error name. Useful for logging and stack tracing.

      +
      +
    • +
    • +
      Optional message: string
      +

      Error message.

      +
      +
    • +
    • +
      options: HttpErrorOptions = {}
      +

      Optional options.

      +
      +
    +

    Returns HttpError<T>

    +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: T
+
+ +
prepareStackTrace?: ((err, stackTraces) => any)
+
+

Type declaration

+
+
+ +
stackTraceLimit: number
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • +
      targetObject: object
    • +
    • +
      Optional constructorOpt: Function
    +

    Returns void

    +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HttpHandler.html b/7.x/docs/classes/HttpHandler.html new file mode 100644 index 000000000..8271e7833 --- /dev/null +++ b/7.x/docs/classes/HttpHandler.html @@ -0,0 +1,180 @@ +HttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HttpHandlerAbstract

+
+

An HTTP request handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IdInteractionRoute.html b/7.x/docs/classes/IdInteractionRoute.html new file mode 100644 index 000000000..21d1596f5 --- /dev/null +++ b/7.x/docs/classes/IdInteractionRoute.html @@ -0,0 +1,203 @@ +IdInteractionRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IdInteractionRoute<TBase, TId>

+
+

An InteractionRoute for routes that have a dynamic identifier in their path.

+
+
+
+

Type Parameters

+
    +
  • +

    TBase extends string

  • +
  • +

    TId extends string

+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
base: InteractionRoute<TBase>
+
+ +
ensureSlash: boolean
+
+ +
idName: TId
+
+

Methods

+
+ +
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<TBase | TId, string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<TBase | TId, string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IdentifierMap.html b/7.x/docs/classes/IdentifierMap.html new file mode 100644 index 000000000..85ab4144a --- /dev/null +++ b/7.x/docs/classes/IdentifierMap.html @@ -0,0 +1,298 @@ +IdentifierMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IdentifierMap<T>

+
+

A specific implementation of HashMap where the key type is ResourceIdentifier.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Accessors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
[toStringTag]: "HashMap" = 'HashMap'
+
+

Accessors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IdentifierSetMultiMap.html b/7.x/docs/classes/IdentifierSetMultiMap.html new file mode 100644 index 000000000..d30aa085b --- /dev/null +++ b/7.x/docs/classes/IdentifierSetMultiMap.html @@ -0,0 +1,445 @@ +IdentifierSetMultiMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IdentifierSetMultiMap<T>

+
+

A specific implementation of WrappedSetMultiMap where the key type is ResourceIdentifier.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Accessors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
[toStringTag]: "WrappedSetMultiMap" = 'WrappedSetMultiMap'
+
+

Accessors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IdentityProviderFactory.html b/7.x/docs/classes/IdentityProviderFactory.html new file mode 100644 index 000000000..8e3941ece --- /dev/null +++ b/7.x/docs/classes/IdentityProviderFactory.html @@ -0,0 +1,409 @@ +IdentityProviderFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IdentityProviderFactory

+
+

Creates an OIDC Provider based on the provided configuration and parameters. +The provider will be cached and returned on subsequent calls. +Cookie and JWT keys will be stored in an internal storage, so they can be re-used over multiple threads. +Necessary claims for Solid OIDC interactions will be added. +Routes will be updated based on the baseUrl and oidcPath.

+
+
+
+

Hierarchy

+
    +
  • IdentityProviderFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
adapterFactory: AdapterFactory
+
+ +
baseUrl: string
+
+ +
clientCredentialsStore: ClientCredentialsStore
+
+ +
config: Configuration
+
+ +
errorHandler: ErrorHandler
+
+ +
interactionRoute: InteractionRoute<never>
+
+ +
jwkGenerator: JwkGenerator
+
+ +
logger: Logger = ...
+
+ +
oidcPath: string
+
+ +
promptFactory: PromptFactory
+
+ +
provider?: default
+
+ +
responseWriter: ResponseWriter
+
+ +
showStackTrace: boolean
+
+ +
storage: KeyValueStorage<string, string[]>
+
+

Methods

+
+ +
    + +
  • +

    In the configureErrors function below, we configure the renderError function of the provider configuration. +This function is called by the OIDC provider library to render errors, +but only does this if the accept header is HTML. +Otherwise, it just returns the error object itself as a JSON object. +See https://github.com/panva/node-oidc-provider/blob/0fcc112e0a95b3b2dae4eba6da812253277567c9/lib/shared/error_handler.js#L48-L52.

    +

    In this function we override the ctx.accepts function +to make the above code think HTML is always requested there. +This way we have full control over error representation as configured in configureErrors. +We still check the accept headers ourselves so there still is content negotiation on the output, +the client will not simply always receive HTML.

    +

    Should this part of the OIDC library code ever change, our function will break, +at which point behaviour will simply revert to what it was before.

    +
    +
    +

    Parameters

    +
      +
    • +
      provider: default
    +

    Returns void

    +
+
+ +
    + +
  • +

    Adds the necessary claims to the id and access tokens based on the Solid OIDC spec.

    +
    +
    +

    Parameters

    +
      +
    • +
      config: Configuration
    • +
    • +
      jwtAlg: AsymmetricSigningAlgorithm
    +

    Returns void

    +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Creates the route string as required by the oidc-provider library. +In case base URL is http://test.com/foo/, oidcPath is /idp and relative is device/auth, +this would result in /foo/idp/device/auth.

    +
    +
    +

    Parameters

    +
      +
    • +
      relative: string
    +

    Returns string

    +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Checks whether the given token is an access token. +The AccessToken interface is not exported, so we have to access it like this.

    +
    +
    +

    Parameters

    +
      +
    • +
      token: unknown
    +

    Returns token is undefined | AccessToken

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IdentityProviderHttpHandler.html b/7.x/docs/classes/IdentityProviderHttpHandler.html new file mode 100644 index 000000000..37821a02d --- /dev/null +++ b/7.x/docs/classes/IdentityProviderHttpHandler.html @@ -0,0 +1,213 @@ +IdentityProviderHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IdentityProviderHttpHandler

+
+

Generates the active Interaction object if there is an ongoing OIDC interaction. +Finds the account ID if there is cookie metadata.

+

Calls the stored InteractionHandler with that information and returns the result.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cookieStore: CookieStore
+
+ +
+
+ +
logger: Logger = ...
+
+ +
providerFactory: ProviderFactory
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ImmutableMetadataPatcher.html b/7.x/docs/classes/ImmutableMetadataPatcher.html new file mode 100644 index 000000000..4c5f2dcd1 --- /dev/null +++ b/7.x/docs/classes/ImmutableMetadataPatcher.html @@ -0,0 +1,218 @@ +ImmutableMetadataPatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ImmutableMetadataPatcher

+
+

Guarantees that certain PATCH operations MUST NOT update certain triples in metadata resources. +Furthermore, this class also handles the patching for metadata resources. +List of triples that must not be updated are given during instantiation with the ImmutableTriple class. +When there is a change to an Immutable Triple, then a ConflictError will be thrown.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
immutablePatterns: FilterPattern[]
+
+ +
logger: Logger = ...
+
+ +
metadataStrategy: AuxiliaryStrategy
+
+ +
patcher: RepresentationPatcher<RdfDatasetRepresentation>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/InMemoryDataAccessor.html b/7.x/docs/classes/InMemoryDataAccessor.html new file mode 100644 index 000000000..ea68bb412 --- /dev/null +++ b/7.x/docs/classes/InMemoryDataAccessor.html @@ -0,0 +1,418 @@ +InMemoryDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InMemoryDataAccessor

+
+

A DataAccessor is the building block closest to the actual data storage. +It should not worry about most Solid logic, most of that will be handled before it is called. +There are a few things it still needs to do, and it is very important every implementation does this:

+
    +
  • If the input identifier ends with a slash, it should be assumed the identifier is targeting a container.
  • +
  • Similarly, if there is no trailing slash it should assume a document.
  • +
  • It should always throw a NotFoundHttpError if it does not have data matching the input identifier.
  • +
  • DataAccessors should not generate containment triples. This will be done externally using getChildren.
  • +
+
+
+
+

Hierarchy

+
    +
  • InMemoryDataAccessor
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
store: {
    entries: Record<string, ContainerEntry>;
}
+
+

Type declaration

+
    +
  • +
    entries: Record<string, ContainerEntry>
+
+

Methods

+
+ +
    + +
  • +

    Should throw a NotImplementedHttpError if the DataAccessor does not support storing the given Representation.

    +
    +

    Returns Promise<void>

    +
    +

    Throws

    BadRequestHttpError +If it does not support the incoming data.

    +
+
+ +
+
+ +
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IndexRepresentationStore.html b/7.x/docs/classes/IndexRepresentationStore.html new file mode 100644 index 000000000..8ca01a03a --- /dev/null +++ b/7.x/docs/classes/IndexRepresentationStore.html @@ -0,0 +1,355 @@ +IndexRepresentationStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IndexRepresentationStore

+
+

Allow containers to have a custom representation. +The index representation will be returned when the following conditions are fulfilled:

+
    +
  • The request targets a container.
  • +
  • A resource with the given indexName exists in the container. (default: "index.html")
  • +
  • The highest weighted preference matches the mediaRange (default: "text/html") +Otherwise the request will be passed on to the source store. +In case the index representation should always be returned when it exists, +the mediaRange should be set to "*∕*".
  • +
+

Note: this functionality is not yet part of the specification. Relevant issues are:

+ +
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
indexName: string
+
+ +
mediaRange: string
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/InitializableHandler.html b/7.x/docs/classes/InitializableHandler.html new file mode 100644 index 000000000..d9f3c2854 --- /dev/null +++ b/7.x/docs/classes/InitializableHandler.html @@ -0,0 +1,182 @@ +InitializableHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InitializableHandler

+
+

Allows using an Initializable as an Initializer Handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
initializable: Initializable
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/Initializer.html b/7.x/docs/classes/Initializer.html new file mode 100644 index 000000000..29111e94e --- /dev/null +++ b/7.x/docs/classes/Initializer.html @@ -0,0 +1,188 @@ +Initializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InitializerAbstract

+
+

Initializer is used to indicate an AsyncHandler that performs initialization logic.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/InteractionHandler.html b/7.x/docs/classes/InteractionHandler.html new file mode 100644 index 000000000..dbcc76e19 --- /dev/null +++ b/7.x/docs/classes/InteractionHandler.html @@ -0,0 +1,175 @@ +InteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InteractionHandlerAbstract

+
+

Handler used for IDP interactions.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/InteractionRouteHandler.html b/7.x/docs/classes/InteractionRouteHandler.html new file mode 100644 index 000000000..eb80e7db0 --- /dev/null +++ b/7.x/docs/classes/InteractionRouteHandler.html @@ -0,0 +1,213 @@ +InteractionRouteHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InteractionRouteHandler<T>

+
+

InteractionHandler that only accepts input of which the target matches the stored route.

+

Rejects operations that target a different route, +otherwise the input parameters are passed to the source handler.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
route: T
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IntermediateCreateExtractor.html b/7.x/docs/classes/IntermediateCreateExtractor.html new file mode 100644 index 000000000..24da6fd26 --- /dev/null +++ b/7.x/docs/classes/IntermediateCreateExtractor.html @@ -0,0 +1,224 @@ +IntermediateCreateExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IntermediateCreateExtractor

+
+

Returns the required access modes from the source ModesExtractor. +In case create permissions are required, +verifies if any of the containers permissions also need to be created +and adds the corresponding identifier/mode combinations.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
resourceSet: ResourceSet
+
+ +
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/InternalServerError.html b/7.x/docs/classes/InternalServerError.html new file mode 100644 index 000000000..0235746d5 --- /dev/null +++ b/7.x/docs/classes/InternalServerError.html @@ -0,0 +1,228 @@ +InternalServerError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InternalServerError

+
+

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • InternalServerError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 500
+
+ +
isInstance: ((error) => error is HttpError<500>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<500>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<500>

      +
+
+ +
statusCode: 500
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/JsonConversionHandler.html b/7.x/docs/classes/JsonConversionHandler.html new file mode 100644 index 000000000..5cf9fc861 --- /dev/null +++ b/7.x/docs/classes/JsonConversionHandler.html @@ -0,0 +1,204 @@ +JsonConversionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class JsonConversionHandler

+
+

An InteractionHandler that sits in-between +an InteractionHandler and a JsonInteractionHandler. +It converts the input data stream into a JSON object to be used by the stored handler.

+

Since the JSON body is only made during the handle call, it can not be used during the canHandle, +so the canHandle call of the stored handler is not called, +meaning this class accepts all input that can be converted to JSON.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/JsonFileStorage.html b/7.x/docs/classes/JsonFileStorage.html new file mode 100644 index 000000000..9a29393c2 --- /dev/null +++ b/7.x/docs/classes/JsonFileStorage.html @@ -0,0 +1,302 @@ +JsonFileStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class JsonFileStorage

+
+

Uses a JSON file to store key/value pairs.

+
+
+
+

Hierarchy

+
    +
  • JsonFileStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
filePath: string
+
+ +
lockIdentifier: ResourceIdentifier
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Updates the data in the JSON file while using a write lock.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      updateFn: ((json) => T)
      +

      A function that updates the JSON object.

      +
      +
      +
        +
      • +
          +
        • (json): T
        • +
        • +
          +

          Parameters

          +
            +
          • +
            json: Dict<unknown>
          +

          Returns T

    +

    Returns Promise<T>

    The return value of updateFn.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/JsonInteractionHandler.html b/7.x/docs/classes/JsonInteractionHandler.html new file mode 100644 index 000000000..041d446b3 --- /dev/null +++ b/7.x/docs/classes/JsonInteractionHandler.html @@ -0,0 +1,210 @@ +JsonInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class JsonInteractionHandler<TOut>Abstract

+
+

A handler that consumes and returns a JSON object, +designed to be used for IDP/OIDC interactions.

+
+
+
+

Type Parameters

+
    +
  • +

    TOut extends Dict<Json> = Dict<Json>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/JsonLdNotificationSerializer.html b/7.x/docs/classes/JsonLdNotificationSerializer.html new file mode 100644 index 000000000..aa6125f47 --- /dev/null +++ b/7.x/docs/classes/JsonLdNotificationSerializer.html @@ -0,0 +1,171 @@ +JsonLdNotificationSerializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class JsonLdNotificationSerializer

+
+

Serializes a Notification into a JSON-LD string.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/JsonResourceStorage.html b/7.x/docs/classes/JsonResourceStorage.html new file mode 100644 index 000000000..26d503a0d --- /dev/null +++ b/7.x/docs/classes/JsonResourceStorage.html @@ -0,0 +1,332 @@ +JsonResourceStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class JsonResourceStorage<T>

+
+

A KeyValueStorage for JSON-like objects using a ResourceStore as backend.

+

Creates a base URL by joining the input base URL with the container string. +The storage assumes it has ownership over all entries in the target container +so no other classes should access resources there to prevent issues.

+

Assumes the input keys can be safely used to generate identifiers, +which will be appended to the stored base URL.

+

All non-404 errors will be re-thrown.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
container: string
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/KeyExtractor.html b/7.x/docs/classes/KeyExtractor.html new file mode 100644 index 000000000..3937dda50 --- /dev/null +++ b/7.x/docs/classes/KeyExtractor.html @@ -0,0 +1,200 @@ +KeyExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class KeyExtractor

+
+

A simple ShorthandExtractor that extracts a single value from the input map. +Returns the default value if it was defined in case no value was found in the map.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
defaultValue: unknown
+
+ +
key: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<unknown>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/KeyValueChannelStorage.html b/7.x/docs/classes/KeyValueChannelStorage.html new file mode 100644 index 000000000..069f0e8e2 --- /dev/null +++ b/7.x/docs/classes/KeyValueChannelStorage.html @@ -0,0 +1,299 @@ +KeyValueChannelStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class KeyValueChannelStorage

+
+

Stores all the NotificationChannel in a KeyValueStorage. +Encodes IDs/topics before storing them in the KeyValueStorage.

+

Uses a ReadWriteLocker to prevent internal race conditions.

+
+
+
+

Hierarchy

+
    +
  • KeyValueChannelStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
logger: Logger = ...
+
+ +
storage: KeyValueStorage<string, StorageValue>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LazyLoggerFactory.html b/7.x/docs/classes/LazyLoggerFactory.html new file mode 100644 index 000000000..b0423a127 --- /dev/null +++ b/7.x/docs/classes/LazyLoggerFactory.html @@ -0,0 +1,173 @@ +LazyLoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LazyLoggerFactory

+
+

Wraps around another LoggerFactory that can be set lazily. +This is useful when objects are instantiated (and when they create loggers) +before the logging system has been fully instantiated, +as is the case when using a dependency injection framework such as Components.js.

+

Loggers can be created even before a LoggerFactory is set; +any log messages will be buffered and re-emitted.

+
+
+
+

Hierarchy

+
    +
  • LazyLoggerFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Accessors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
factory: LoggerFactory
+
+

Accessors

+
+ +
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LinkMetadataGenerator.html b/7.x/docs/classes/LinkMetadataGenerator.html new file mode 100644 index 000000000..c1d9b9179 --- /dev/null +++ b/7.x/docs/classes/LinkMetadataGenerator.html @@ -0,0 +1,201 @@ +LinkMetadataGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LinkMetadataGenerator

+
+

Adds a link to the auxiliary resource when called on the subject resource. +Specifically: will be added.

+

In case the input is metadata of an auxiliary resource no metadata will be added

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
identifierStrategy: AuxiliaryIdentifierStrategy
+
+ +
link: NamedNode<string>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LinkRelMetadataWriter.html b/7.x/docs/classes/LinkRelMetadataWriter.html new file mode 100644 index 000000000..8e2e61168 --- /dev/null +++ b/7.x/docs/classes/LinkRelMetadataWriter.html @@ -0,0 +1,203 @@ +LinkRelMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LinkRelMetadataWriter

+
+

A MetadataWriter that takes a linking metadata predicates to Link header "rel" values. +The values of the objects will be put in a Link header with the corresponding "rel" value.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
linkRelMap: Map<NamedNode<string>, string>
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LinkRelObject.html b/7.x/docs/classes/LinkRelObject.html new file mode 100644 index 000000000..784640b46 --- /dev/null +++ b/7.x/docs/classes/LinkRelObject.html @@ -0,0 +1,195 @@ +LinkRelObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LinkRelObject

+
+

Represents the values that are parsed as metadata

+
+
+
+

Hierarchy

+
    +
  • LinkRelObject
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      value: string
      +

      The value corresponding to the rel value that will be used as predicate in the metadata.

      +
      +
    • +
    • +
      Optional ephemeral: boolean
      +

      (Optional) Indicates whether it will be stored by the server.

      +
      +
    • +
    • +
      Optional allowList: string[]
      +

      (Optional) Contains the objects that are allowed to be used with the given predicate.

      +
      +
    +

    Returns LinkRelObject

    +
+
+

Properties

+
+ +
allowList: undefined | string[]
+
+ +
ephemeral: boolean
+
+ +
value: NamedNode<string>
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Checks whether the object can be added to the metadata

    +
    +
    +

    Parameters

    +
      +
    • +
      object: string
      +

      The link target.

      +
      +
    +

    Returns boolean

    a boolean to indicate whether it can be added to the metadata or not

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LinkRelParser.html b/7.x/docs/classes/LinkRelParser.html new file mode 100644 index 000000000..58c0899a0 --- /dev/null +++ b/7.x/docs/classes/LinkRelParser.html @@ -0,0 +1,212 @@ +LinkRelParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LinkRelParser

+
+

Parses Link headers with a specific rel value and adds them as metadata with the given predicate.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
linkRelMap: Record<string, LinkRelObject>
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LinkWebIdHandler.html b/7.x/docs/classes/LinkWebIdHandler.html new file mode 100644 index 000000000..c945077f7 --- /dev/null +++ b/7.x/docs/classes/LinkWebIdHandler.html @@ -0,0 +1,253 @@ +LinkWebIdHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LinkWebIdHandler

+
+

Handles the linking of WebIDs to account, +thereby registering them to the server IDP.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseUrl: string
+
+ +
logger: Logger = ...
+
+ +
ownershipValidator: OwnershipValidator
+
+ +
podStore: PodStore
+
+ +
storageStrategy: StorageLocationStrategy
+
+ +
webIdRoute: WebIdLinkRoute
+
+ +
webIdStore: WebIdStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ListeningActivityHandler.html b/7.x/docs/classes/ListeningActivityHandler.html new file mode 100644 index 000000000..c2750d4a1 --- /dev/null +++ b/7.x/docs/classes/ListeningActivityHandler.html @@ -0,0 +1,224 @@ +ListeningActivityHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ListeningActivityHandler

+
+

Listens to an ActivityEmitter and calls the stored NotificationHandlers in case of an event +for every matching notification channel found.

+

Takes the rate feature into account so only channels that want a new notification will receive one.

+

Extends StaticHandler so it can be more easily injected into a Components.js configuration. +No class takes this one as input, so to make sure Components.js instantiates it, +it needs to be added somewhere where its presence has no impact, such as the list of initializers.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      topic: ResourceIdentifier
    • +
    • +
      activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
    • +
    • +
      metadata: RepresentationMetadata
    +

    Returns Promise<void>

+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LocationInteractionHandler.html b/7.x/docs/classes/LocationInteractionHandler.html new file mode 100644 index 000000000..815e1ba1e --- /dev/null +++ b/7.x/docs/classes/LocationInteractionHandler.html @@ -0,0 +1,210 @@ +LocationInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LocationInteractionHandler

+
+

Transforms an HTTP redirect into a hypermedia document with a redirection link, +such that scripts running in a browser can redirect the user to the next page.

+

This handler addresses the situation where:

+
    +
  • the user visits a first page
  • +
  • this first page contains a script that performs interactions with a JSON API
  • +
  • as a result of a certain interaction, the user needs to be redirected to a second page
  • +
+

Regular HTTP redirects are performed via responses with 3xx status codes. +However, since the consumer of the API in this case is a browser script, +a 3xx response would only reach that script and not move the page for the user.

+

Therefore, this handler changes a 3xx response into a 200 response +with an explicit link to the next page, +enabling the script to move the user to the next page.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LockingInteractionHandler.html b/7.x/docs/classes/LockingInteractionHandler.html new file mode 100644 index 000000000..97c6f77ed --- /dev/null +++ b/7.x/docs/classes/LockingInteractionHandler.html @@ -0,0 +1,209 @@ +LockingInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LockingInteractionHandler

+
+

An InteractionHandler that locks the path generated with the stored route during an operation. +If the route is the base account route, this can be used to prevent multiple operations on the same account.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accountRoute: AccountIdRoute
+
+ +
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LockingResourceStore.html b/7.x/docs/classes/LockingResourceStore.html new file mode 100644 index 000000000..f17318c2b --- /dev/null +++ b/7.x/docs/classes/LockingResourceStore.html @@ -0,0 +1,441 @@ +LockingResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LockingResourceStore

+
+

Store that for every call acquires a lock before executing it on the requested resource, +and releases it afterwards. +In case the request returns a Representation the lock will only be released when the data stream is finished.

+

For auxiliary resources the lock will be applied to the subject resource. +The actual operation is still executed on the auxiliary resource.

+
+
+
+

Hierarchy

+
    +
  • LockingResourceStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
auxiliaryStrategy: AuxiliaryIdentifierStrategy
+
+ +
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Wraps a representation to make it reset the timeout timer every time data is read.

    +
    +
    +

    Parameters

    +
      +
    • +
      representation: Representation
      +

      The representation to wrap

      +
      +
    • +
    • +
      maintainLock: (() => void)
      +

      Function to call to reset the timer.

      +
      +
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns Representation

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Acquires a lock that is only released when all data of the resulting representation data has been read, +an error occurs, or the timeout has been triggered. +The resulting data stream will be adapted to reset the timer every time data is read.

    +

    In case the data of the resulting stream is not needed it should be closed to prevent a timeout error.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Representation>

    +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns a promise that resolve when the source stream is finished, +either by ending or emitting an error. +In the case of an error the stream will be destroyed if it hasn't been already.

    +
    +
    +

    Parameters

    +
      +
    • +
      source: Readable
      +

      The input stream.

      +
      +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LoggerInitializer.html b/7.x/docs/classes/LoggerInitializer.html new file mode 100644 index 000000000..e7a7918ae --- /dev/null +++ b/7.x/docs/classes/LoggerInitializer.html @@ -0,0 +1,182 @@ +LoggerInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LoggerInitializer

+
+

Sets up the global logger factory.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
loggerFactory: LoggerFactory
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LogoutHandler.html b/7.x/docs/classes/LogoutHandler.html new file mode 100644 index 000000000..50c23541a --- /dev/null +++ b/7.x/docs/classes/LogoutHandler.html @@ -0,0 +1,191 @@ +LogoutHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LogoutHandler

+
+

Responsible for logging a user out. +In practice this means making sure the cookie is no longer valid.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cookieStore: CookieStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MappedMetadataWriter.html b/7.x/docs/classes/MappedMetadataWriter.html new file mode 100644 index 000000000..b05dd53dd --- /dev/null +++ b/7.x/docs/classes/MappedMetadataWriter.html @@ -0,0 +1,196 @@ +MappedMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MappedMetadataWriter

+
+

A MetadataWriter that takes a map directly converting metadata predicates to headers. +The header value(s) will be the same as the corresponding object value(s).

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
headerMap: Map<NamedNode<string>, string>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MarkdownToHtmlConverter.html b/7.x/docs/classes/MarkdownToHtmlConverter.html new file mode 100644 index 000000000..29295603e --- /dev/null +++ b/7.x/docs/classes/MarkdownToHtmlConverter.html @@ -0,0 +1,230 @@ +MarkdownToHtmlConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MarkdownToHtmlConverter

+
+

Converts Markdown data to HTML. +The generated HTML will be injected into the given template using the parameter htmlBody. +A standard Markdown string will be converted to a

tag, so html and body tags should be part of the template. +In case the Markdown body starts with a header (#), that value will also be used as title parameter.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
inputTypes: Promise<ValuePreferences>
+
+ +
outputTypes: Promise<ValuePreferences>
+
+ +
templateEngine: TemplateEngine<Dict<unknown>>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MaxKeyLengthStorage.html b/7.x/docs/classes/MaxKeyLengthStorage.html new file mode 100644 index 000000000..4d8483a83 --- /dev/null +++ b/7.x/docs/classes/MaxKeyLengthStorage.html @@ -0,0 +1,319 @@ +MaxKeyLengthStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MaxKeyLengthStorage<T>

+
+

A KeyValueStorage that hashes keys in case they would be longer than the set limit. +Hashed keys are prefixed with a certain value to prevent issues with incoming keys that are already hashed. +The default max length is 150 and the default prefix is $hash$.

+

This class mostly exists to prevent issues when writing storage entries to disk. +Keys that are too long would cause issues with the file name limit. +For this reason, only the part after the last / in a key is hashed, to preserve the expected file structure.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
    +
  • MaxKeyLengthStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
hashPrefix: string
+
+ +
logger: Logger = ...
+
+ +
maxKeyLength: number
+
+ +
source: KeyValueStorage<string, Entry<T>>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Hashes the last part of the key if it is too long. +Otherwise, just returns the key.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
    • +
    • +
      Optional parts: string[]
    +

    Returns string

    +
+
+ +
    + +
  • +

    Similar to getKey but checks to make sure the key does not already contain the prefix. +Only necessary for set calls.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
    +

    Returns string

    +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MemoryMapStorage.html b/7.x/docs/classes/MemoryMapStorage.html new file mode 100644 index 000000000..ae17919c8 --- /dev/null +++ b/7.x/docs/classes/MemoryMapStorage.html @@ -0,0 +1,227 @@ +MemoryMapStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MemoryMapStorage<TValue>

+
+

A KeyValueStorage which uses a JavaScript Map for internal storage.

+
+
+
+

Type Parameters

+
    +
  • +

    TValue

+
+

Hierarchy

+
    +
  • MemoryMapStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
data: Map<string, TValue>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MemoryResourceLocker.html b/7.x/docs/classes/MemoryResourceLocker.html new file mode 100644 index 000000000..505178af5 --- /dev/null +++ b/7.x/docs/classes/MemoryResourceLocker.html @@ -0,0 +1,199 @@ +MemoryResourceLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MemoryResourceLocker

+
+

A resource locker making use of the async-lock library. +Note that all locks are kept in memory until they are unlocked which could potentially result +in a memory leak if locks are never unlocked, so make sure this is covered with expiring locks for example, +and/or proper finally handles.

+
+
+
+

Hierarchy

+
    +
  • MemoryResourceLocker
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
locker: AsyncLock
+
+ +
logger: Logger = ...
+
+ +
unlockCallbacks: Record<string, (() => void)>
+
+

Type declaration

+
    +
  • +
      +
    • (): void
    • +
    • +

      Returns void

+
+

Methods

+
+ +
+
+ +
+
+ +
    + +
  • +

    Releases a lock on the requested identifier. +The promise will resolve when the lock has been released. +If there is no lock on the resource, an error should be thrown.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MetadataGenerator.html b/7.x/docs/classes/MetadataGenerator.html new file mode 100644 index 000000000..7614dd02a --- /dev/null +++ b/7.x/docs/classes/MetadataGenerator.html @@ -0,0 +1,173 @@ +MetadataGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MetadataGeneratorAbstract

+
+

Generic interface for classes that add metadata to a RepresentationMetadata.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MetadataParser.html b/7.x/docs/classes/MetadataParser.html new file mode 100644 index 000000000..25315c00b --- /dev/null +++ b/7.x/docs/classes/MetadataParser.html @@ -0,0 +1,195 @@ +MetadataParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MetadataParserAbstract

+
+

A parser that takes a specific part of an HttpRequest and converts it into metadata, +such as the value of a header entry.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MetadataWriter.html b/7.x/docs/classes/MetadataWriter.html new file mode 100644 index 000000000..1ceca4b1a --- /dev/null +++ b/7.x/docs/classes/MetadataWriter.html @@ -0,0 +1,185 @@ +MetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MetadataWriterAbstract

+
+

A serializer that converts metadata to headers for an HttpResponse.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MethodFilterHandler.html b/7.x/docs/classes/MethodFilterHandler.html new file mode 100644 index 000000000..750b18e63 --- /dev/null +++ b/7.x/docs/classes/MethodFilterHandler.html @@ -0,0 +1,233 @@ +MethodFilterHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MethodFilterHandler<TIn, TOut>

+
+

Only accepts requests where the input has a (possibly nested) method field +that matches any one of the given methods. +In case of a match, the input will be sent to the source handler.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn extends InType

  • +
  • +

    TOut

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
methods: string[]
+
+ +
source: AsyncHandler<TIn, TOut>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MethodModesExtractor.html b/7.x/docs/classes/MethodModesExtractor.html new file mode 100644 index 000000000..423ae4bc7 --- /dev/null +++ b/7.x/docs/classes/MethodModesExtractor.html @@ -0,0 +1,198 @@ +MethodModesExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MethodModesExtractor

+
+

Generates permissions for the base set of methods that always require the same permissions. +Specifically: GET, HEAD, POST, PUT and DELETE.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
resourceSet: ResourceSet
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MethodNotAllowedHttpError.html b/7.x/docs/classes/MethodNotAllowedHttpError.html new file mode 100644 index 000000000..a24824097 --- /dev/null +++ b/7.x/docs/classes/MethodNotAllowedHttpError.html @@ -0,0 +1,238 @@ +MethodNotAllowedHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MethodNotAllowedHttpError

+
+

An error thrown when data was found for the requested identifier, but is not supported by the target resource. +Can keep track of the methods that are not allowed.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • MethodNotAllowedHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
methods: readonly string[]
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 405
+
+ +
isInstance: ((error) => error is HttpError<405>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<405>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<405>

      +
+
+ +
statusCode: 405
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ModesExtractor.html b/7.x/docs/classes/ModesExtractor.html new file mode 100644 index 000000000..1992c4614 --- /dev/null +++ b/7.x/docs/classes/ModesExtractor.html @@ -0,0 +1,178 @@ +ModesExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ModesExtractorAbstract

+
+

Extracts all AccessModes that are necessary to execute the given Operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ModifiedMetadataWriter.html b/7.x/docs/classes/ModifiedMetadataWriter.html new file mode 100644 index 000000000..569480592 --- /dev/null +++ b/7.x/docs/classes/ModifiedMetadataWriter.html @@ -0,0 +1,176 @@ +ModifiedMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ModifiedMetadataWriter

+
+

A MetadataWriter that generates all the necessary headers related to the modification date of a resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ModuleVersionVerifier.html b/7.x/docs/classes/ModuleVersionVerifier.html new file mode 100644 index 000000000..efabfe341 --- /dev/null +++ b/7.x/docs/classes/ModuleVersionVerifier.html @@ -0,0 +1,193 @@ +ModuleVersionVerifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ModuleVersionVerifier

+
+

This initializer simply writes the version number of the server to the storage. +This will be relevant in the future when we look into migration initializers.

+

It automatically parses the version number from the package.json.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
storage: KeyValueStorage<string, string>
+
+ +
storageKey: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MonitoringStore.html b/7.x/docs/classes/MonitoringStore.html new file mode 100644 index 000000000..267b49d91 --- /dev/null +++ b/7.x/docs/classes/MonitoringStore.html @@ -0,0 +1,1082 @@ +MonitoringStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MonitoringStore<T>

+
+

Store that notifies listeners of changes to its source +by emitting a changed event.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
addListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
          • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
            • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
            • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+ +
emit: ((event, ...args) => boolean) & ((event, ...args) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (event, ...args): boolean
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      • +
      • +
        Rest ...args: [target: ResourceIdentifier, activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">, metadata: RepresentationMetadata]
      +

      Returns boolean

+
+

Type declaration

+
    +
  • +
      +
    • (event, ...args): boolean
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      • +
      • +
        Rest ...args: [target: ResourceIdentifier, metadata: RepresentationMetadata]
      +

      Returns boolean

+
+ +
eventNames: (() => "changed"[]) & (() => ("https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update")[])
+
+

Type declaration

+
    +
  • +
      +
    • (): "changed"[]
    • +
    • +

      Returns "changed"[]

+
+

Type declaration

+
    +
  • +
      +
    • (): ("https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update")[]
    • +
    • +

      Returns ("https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update")[]

+
+ +
listenerCount: ((event) => number) & ((event) => number)
+
+

Type declaration

+
    +
  • +
      +
    • (event): number
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      +

      Returns number

+
+

Type declaration

+
    +
  • +
      +
    • (event): number
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      +

      Returns number

+
+ +
listeners: ((event) => ((target, activity, metadata) => void)[]) & ((event) => ((target, metadata) => void)[])
+
+

Type declaration

+
    +
  • +
      +
    • (event): ((target, activity, metadata) => void)[]
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      +

      Returns ((target, activity, metadata) => void)[]

+
+

Type declaration

+
    +
  • +
      +
    • (event): ((target, metadata) => void)[]
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      +

      Returns ((target, metadata) => void)[]

+
+ +
off: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
          • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
            • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
            • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+ +
on: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
          • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
            • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
            • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+ +
once: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
          • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
            • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
            • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+ +
prependListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
          • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
            • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
            • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+ +
prependOnceListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
          • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
            • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
            • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+ +
rawListeners: ((event) => ((target, activity, metadata) => void)[]) & ((event) => ((target, metadata) => void)[])
+
+

Type declaration

+
    +
  • +
      +
    • (event): ((target, activity, metadata) => void)[]
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      +

      Returns ((target, activity, metadata) => void)[]

+
+

Type declaration

+
    +
  • +
      +
    • (event): ((target, metadata) => void)[]
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      +

      Returns ((target, metadata) => void)[]

+
+ +
removeAllListeners: ((event) => MonitoringStore<T>) & ((event) => MonitoringStore<T>)
+
+

Type declaration

+
+
+

Type declaration

+
    +
  • +
      +
    • (event): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      +

      Returns MonitoringStore<T>

+
+ +
removeListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
          • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
            • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
            • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+ +
source: T
+
+

Methods

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      error: Error
    • +
    • +
      event: string
    • +
    • +
      Rest ...args: any[]
    +

    Returns void

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns the current max listener value for the EventEmitter which is either +set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    +
    +

    Returns number

    +
    +

    Since

    v1.0.0

    +
+
+ +
+
+ +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional term: Term
    +

    Returns term is NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">

+
+ +
+
+ +
    + +
  • +

    By default EventEmitters will print a warning if more than 10 listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The emitter.setMaxListeners() method allows the limit to be +modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
    +

    Returns MonitoringStore<T>

    +
    +

    Since

    v0.3.5

    +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MovedPermanentlyHttpError.html b/7.x/docs/classes/MovedPermanentlyHttpError.html new file mode 100644 index 000000000..ad89cc286 --- /dev/null +++ b/7.x/docs/classes/MovedPermanentlyHttpError.html @@ -0,0 +1,239 @@ +MovedPermanentlyHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MovedPermanentlyHttpError

+
+

Error used for resources that have been moved permanently. +Methods other than GET may or may not be changed to GET in subsequent requests.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • MovedPermanentlyHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
location: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 301
+
+ +
isInstance: ((error) => error is HttpError<301>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<301>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<301>

      +
+
+ +
statusCode: 301
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/N3PatchBodyParser.html b/7.x/docs/classes/N3PatchBodyParser.html new file mode 100644 index 000000000..8d875908f --- /dev/null +++ b/7.x/docs/classes/N3PatchBodyParser.html @@ -0,0 +1,265 @@ +N3PatchBodyParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class N3PatchBodyParser

+
+

Parses an N3 Patch document and makes sure it conforms to the specification requirements. +Requirements can be found at Solid Protocol, §5.3.1: https://solid.github.io/specification/protocol#n3-patch

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: BodyParserArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Finds all quads in a where/deletes/inserts formula. +The returned quads will be updated so their graph is the default graph instead of the N3 reference to the formula. +Will error in case there are multiple instances of the subject/predicate combination.

    +
    +
    +

    Parameters

    +
      +
    • +
      store: Store<Quad, Quad, Quad, Quad>
    • +
    • +
      subject: Quad_Subject
    • +
    • +
      predicate: NamedNode<string>
    +

    Returns Quad[]

    +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Extracts the deletes/inserts/conditions from a solid:InsertDeletePatch entry.

    +
    +
    +

    Parameters

    +
      +
    • +
      patch: Quad_Subject
    • +
    • +
      store: Store<Quad, Quad, Quad, Quad>
    +

    Returns {
        conditions: Quad[];
        deletes: Quad[];
        inserts: Quad[];
    }

    +
      +
    • +
      conditions: Quad[]
    • +
    • +
      deletes: Quad[]
    • +
    • +
      inserts: Quad[]
    +
+
+ +
    + +
  • +

    Verifies if the delete/insert triples conform to the specification requirements:

    +
      +
    • They should not contain blank nodes.
    • +
    • They should not contain variables that do not occur in the conditions.
    • +
    +
    +
    +

    Parameters

    +
      +
    • +
      otherQuads: Quad[]
    • +
    • +
      conditionVars: Set<string>
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/N3PatchModesExtractor.html b/7.x/docs/classes/N3PatchModesExtractor.html new file mode 100644 index 000000000..c628ee1b5 --- /dev/null +++ b/7.x/docs/classes/N3PatchModesExtractor.html @@ -0,0 +1,201 @@ +N3PatchModesExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class N3PatchModesExtractor

+
+

Extracts the required access modes from an N3 Patch.

+

Solid, §5.3.1: "When ?conditions is non-empty, servers MUST treat the request as a Read operation. +When ?insertions is non-empty, servers MUST (also) treat the request as an Append operation. +When ?deletions is non-empty, servers MUST treat the request as a Read and Write operation." +https://solid.github.io/specification/protocol#n3-patch

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
resourceSet: ResourceSet
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/N3Patcher.html b/7.x/docs/classes/N3Patcher.html new file mode 100644 index 000000000..8525f1f53 --- /dev/null +++ b/7.x/docs/classes/N3Patcher.html @@ -0,0 +1,244 @@ +N3Patcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class N3Patcher

+
+

Applies an N3 Patch to a representation, or creates a new one if required. +Follows all the steps from Solid, §5.3.1: https://solid.github.io/specification/protocol#n3-patch

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
engine: QueryEngine<IQueryContextCommon>
+
+ +
generator: SparqlGenerator
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Creates a new N3Patch where the conditions of the provided patch parameter are applied to its deletes and inserts. +Also does the necessary checks to make sure the conditions are valid for the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      patch: N3Patch
    • +
    • +
      identifier: ResourceIdentifier
    • +
    • +
      source: Store<Quad, Quad, Quad, Quad>
    +

    Returns Promise<N3Patch>

    +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Applies the given N3Patch to the store. +First the conditions are applied to find the necessary bindings, +which are then applied to generate the triples that need to be deleted and inserted. +After that the delete and insert operations are applied.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NoCheckOwnershipValidator.html b/7.x/docs/classes/NoCheckOwnershipValidator.html new file mode 100644 index 000000000..4308b47b8 --- /dev/null +++ b/7.x/docs/classes/NoCheckOwnershipValidator.html @@ -0,0 +1,193 @@ +NoCheckOwnershipValidator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NoCheckOwnershipValidator

+
+

Does not do any checks to verify if the agent doing the request is actually the owner of the WebID. +This should only be used for debugging.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: {
          webId: string;
      }
      +

      Input that needs to be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input data that will be handled if it can be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotFoundHttpError.html b/7.x/docs/classes/NotFoundHttpError.html new file mode 100644 index 000000000..bed9c462f --- /dev/null +++ b/7.x/docs/classes/NotFoundHttpError.html @@ -0,0 +1,228 @@ +NotFoundHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotFoundHttpError

+
+

An error thrown when no data was found for the requested identifier.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • NotFoundHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 404
+
+ +
isInstance: ((error) => error is HttpError<404>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<404>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<404>

      +
+
+ +
statusCode: 404
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotImplementedHttpError.html b/7.x/docs/classes/NotImplementedHttpError.html new file mode 100644 index 000000000..b330c1bdb --- /dev/null +++ b/7.x/docs/classes/NotImplementedHttpError.html @@ -0,0 +1,229 @@ +NotImplementedHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotImplementedHttpError

+
+

The server either does not recognize the request method, or it lacks the ability to fulfil the request. +Usually this implies future availability (e.g., a new feature of a web-service API).

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • NotImplementedHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 501
+
+ +
isInstance: ((error) => error is HttpError<501>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<501>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<501>

      +
+
+ +
statusCode: 501
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationDescriber.html b/7.x/docs/classes/NotificationDescriber.html new file mode 100644 index 000000000..0140a2623 --- /dev/null +++ b/7.x/docs/classes/NotificationDescriber.html @@ -0,0 +1,203 @@ +NotificationDescriber | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationDescriber

+
+

Outputs quads describing all the subscription services of the server, +as described in https://solidproject.org/TR/2022/notifications-protocol-20221231#discovery and +https://solidproject.org/TR/2022/notifications-protocol-20221231#description-resource-data-model.

+

In the future, if there is ever a need to add notification channels to the description resource as described above, +this functionality should probably be added here as well.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
subscriptions: NotificationChannelType[]
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationEmitter.html b/7.x/docs/classes/NotificationEmitter.html new file mode 100644 index 000000000..411bd7428 --- /dev/null +++ b/7.x/docs/classes/NotificationEmitter.html @@ -0,0 +1,174 @@ +NotificationEmitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationEmitterAbstract

+
+

Emits a serialized Notification to the channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationGenerator.html b/7.x/docs/classes/NotificationGenerator.html new file mode 100644 index 000000000..bc926ab26 --- /dev/null +++ b/7.x/docs/classes/NotificationGenerator.html @@ -0,0 +1,176 @@ +NotificationGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationGeneratorAbstract

+
+

Creates a Notification based on the provided input.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationHandler.html b/7.x/docs/classes/NotificationHandler.html new file mode 100644 index 000000000..a2683b4e4 --- /dev/null +++ b/7.x/docs/classes/NotificationHandler.html @@ -0,0 +1,174 @@ +NotificationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationHandlerAbstract

+
+

Makes sure an activity gets emitted to the relevant channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationSerializer.html b/7.x/docs/classes/NotificationSerializer.html new file mode 100644 index 000000000..42e68d67d --- /dev/null +++ b/7.x/docs/classes/NotificationSerializer.html @@ -0,0 +1,176 @@ +NotificationSerializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationSerializerAbstract

+
+

Converts a Notification into a Representation that can be transmitted.

+

This is a separate class between a generator and emitter, +so that a specific notification channel type can add extra metadata to the Representation if needed.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationSubscriber.html b/7.x/docs/classes/NotificationSubscriber.html new file mode 100644 index 000000000..19839a4f6 --- /dev/null +++ b/7.x/docs/classes/NotificationSubscriber.html @@ -0,0 +1,259 @@ +NotificationSubscriber | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationSubscriber

+
+

Handles notification subscriptions by creating a notification channel.

+

Uses the information from the provided NotificationChannelType to validate the input +and verify the request has the required permissions available. +If successful the generated channel will be stored in a NotificationChannelStorage.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
authorizer: Authorizer
+
+ +
+
+ +
+
+ +
credentialsExtractor: CredentialsExtractor
+
+ +
logger: Logger = ...
+
+ +
maxDuration: number
+
+ +
permissionReader: PermissionReader
+
+ +
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationUnsubscriber.html b/7.x/docs/classes/NotificationUnsubscriber.html new file mode 100644 index 000000000..68a93a4d6 --- /dev/null +++ b/7.x/docs/classes/NotificationUnsubscriber.html @@ -0,0 +1,198 @@ +NotificationUnsubscriber | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationUnsubscriber

+
+

Allows clients to unsubscribe from notification channels. +Should be wrapped in a route handler that only allows DELETE operations.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OAuthHttpError.html b/7.x/docs/classes/OAuthHttpError.html new file mode 100644 index 000000000..9c062d695 --- /dev/null +++ b/7.x/docs/classes/OAuthHttpError.html @@ -0,0 +1,270 @@ +OAuthHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OAuthHttpError

+
+

Represents on OAuth error that is being thrown. +OAuth error responses have additional fields that need to be present in the JSON response, +as described in RFC 6749, §4.1.2.1.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
mandatoryFields: OAuthErrorFields
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: number
+
+ +
prepareStackTrace?: ((err, stackTraces) => any)
+
+

Type declaration

+
+
+ +
stackTraceLimit: number
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • +
      targetObject: object
    • +
    • +
      Optional constructorOpt: Function
    +

    Returns void

    +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OidcControlHandler.html b/7.x/docs/classes/OidcControlHandler.html new file mode 100644 index 000000000..ad6991d00 --- /dev/null +++ b/7.x/docs/classes/OidcControlHandler.html @@ -0,0 +1,256 @@ +OidcControlHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OidcControlHandler

+
+

A ControlHandler that only returns results if there is an active OIDC interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OidcHttpHandler.html b/7.x/docs/classes/OidcHttpHandler.html new file mode 100644 index 000000000..7f5c73e59 --- /dev/null +++ b/7.x/docs/classes/OidcHttpHandler.html @@ -0,0 +1,197 @@ +OidcHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OidcHttpHandler

+
+

HTTP handler that redirects all requests to the OIDC library.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
providerFactory: ProviderFactory
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OkResponseDescription.html b/7.x/docs/classes/OkResponseDescription.html new file mode 100644 index 000000000..13ca72591 --- /dev/null +++ b/7.x/docs/classes/OkResponseDescription.html @@ -0,0 +1,140 @@ +OkResponseDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OkResponseDescription

+
+

Corresponds to a 200 or 206 response, containing relevant metadata and potentially data. +A 206 will be returned if range metadata is found in the metadata object.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
data?: Guarded<Readable>
+
+ +
+
+ +
statusCode: number
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OperationHandler.html b/7.x/docs/classes/OperationHandler.html new file mode 100644 index 000000000..aebdb4361 --- /dev/null +++ b/7.x/docs/classes/OperationHandler.html @@ -0,0 +1,178 @@ +OperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OperationHandlerAbstract

+
+

Handler for a specific operation type.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OperationHttpHandler.html b/7.x/docs/classes/OperationHttpHandler.html new file mode 100644 index 000000000..71482df1f --- /dev/null +++ b/7.x/docs/classes/OperationHttpHandler.html @@ -0,0 +1,180 @@ +OperationHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OperationHttpHandlerAbstract

+
+

An HTTP handler that makes use of an already parsed Operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OperationRouterHandler.html b/7.x/docs/classes/OperationRouterHandler.html new file mode 100644 index 000000000..7c7f0062a --- /dev/null +++ b/7.x/docs/classes/OperationRouterHandler.html @@ -0,0 +1,243 @@ +OperationRouterHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OperationRouterHandler

+
+ +
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
allMethods: boolean
+
+ +
allowedMethods: string[]
+
+ +
allowedPathNamesRegEx: RegExp[]
+
+ +
baseUrlLength: number
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OriginalUrlExtractor.html b/7.x/docs/classes/OriginalUrlExtractor.html new file mode 100644 index 000000000..f7897d6bf --- /dev/null +++ b/7.x/docs/classes/OriginalUrlExtractor.html @@ -0,0 +1,206 @@ +OriginalUrlExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OriginalUrlExtractor

+
+

Reconstructs the original URL of an incoming HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
includeQueryString: boolean
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OwnerMetadataWriter.html b/7.x/docs/classes/OwnerMetadataWriter.html new file mode 100644 index 000000000..967cdf52d --- /dev/null +++ b/7.x/docs/classes/OwnerMetadataWriter.html @@ -0,0 +1,211 @@ +OwnerMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OwnerMetadataWriter

+
+

Adds link headers indicating who the owners are when accessing the base URL of a pod. +Only owners that have decided to be visible will be shown.

+

Solid, §4.1: "When a server wants to advertise the owner of a storage, +the server MUST include the Link header with rel="http://www.w3.org/ns/solid/terms#owner" +targeting the URI of the owner in the response of HTTP HEAD or GET requests targeting the root container." +https://solidproject.org/TR/2022/protocol-20221231#server-storage-link-owner

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
podStore: PodStore
+
+ +
storageStrategy: StorageLocationStrategy
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OwnerPermissionReader.html b/7.x/docs/classes/OwnerPermissionReader.html new file mode 100644 index 000000000..2b36e5468 --- /dev/null +++ b/7.x/docs/classes/OwnerPermissionReader.html @@ -0,0 +1,253 @@ +OwnerPermissionReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OwnerPermissionReader

+
+

Allows control access if the request is being made by an owner of the pod containing the resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
logger: Logger = ...
+
+ +
podStore: PodStore
+
+ +
storageStrategy: StorageLocationStrategy
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Finds the owners of the given pods. +Return value is a record where the keys are the pods and the values are all the WebIDs that own this pod.

    +
    +
    +

    Parameters

    +
      +
    • +
      pods: string[]
    +

    Returns Promise<Record<string, string[]>>

    +
+
+ +
    + +
  • +

    Finds all pods that contain the given identifiers. +Return value is a record where the keys are the identifiers and the values the associated pod.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Record<string, string>>

    +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OwnershipValidator.html b/7.x/docs/classes/OwnershipValidator.html new file mode 100644 index 000000000..3f1c98a66 --- /dev/null +++ b/7.x/docs/classes/OwnershipValidator.html @@ -0,0 +1,185 @@ +OwnershipValidator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OwnershipValidatorAbstract

+
+

A class that validates if a someone owns a WebId. +Will throw an error if the WebId is not valid or ownership could not be validated. +The error message should contain a description of what is wrong and how it can be resolved.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input that needs to be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input data that will be handled if it can be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ParallelHandler.html b/7.x/docs/classes/ParallelHandler.html new file mode 100644 index 000000000..7d380853d --- /dev/null +++ b/7.x/docs/classes/ParallelHandler.html @@ -0,0 +1,204 @@ +ParallelHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ParallelHandler<TIn, TOut>

+
+

A composite handler that executes handlers in parallel.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn = void

  • +
  • +

    TOut = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
handlers: AsyncHandler<TIn, TOut>[]
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut[]>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut[]>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ParentContainerReader.html b/7.x/docs/classes/ParentContainerReader.html new file mode 100644 index 000000000..66c3aa624 --- /dev/null +++ b/7.x/docs/classes/ParentContainerReader.html @@ -0,0 +1,288 @@ +ParentContainerReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ParentContainerReader

+
+

Determines delete and create permissions for those resources that need it +by making sure the parent container has the required permissions.

+

Create requires append permissions on the parent container. +Delete requires write permissions on both the parent container and the resource itself.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Merges the container permission set into the resource permission set +based on the parent container rules for create/delete permissions.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional resourceSet: Partial<Record<AccessMode, boolean>>
    • +
    • +
      Optional containerSet: Partial<Record<AccessMode, boolean>>
    +

    Returns Partial<Record<AccessMode, boolean>>

    +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Determines the create and delete permissions for the given resource permissions +based on those of its parent container.

    +
    +
    +

    Parameters

    +
      +
    • +
      resourcePermission: Partial<Record<AccessMode, boolean>>
    • +
    • +
      containerPermission: Partial<Record<AccessMode, boolean>>
    +

    Returns Partial<Record<AccessMode, boolean>>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ParsingHttpHandler.html b/7.x/docs/classes/ParsingHttpHandler.html new file mode 100644 index 000000000..da51d4c2b --- /dev/null +++ b/7.x/docs/classes/ParsingHttpHandler.html @@ -0,0 +1,260 @@ +ParsingHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ParsingHttpHandler

+
+

Parses requests and sends the resulting Operation to the wrapped OperationHttpHandler. +Errors are caught and handled by the ErrorHandler. +In case the OperationHttpHandler returns a result it will be sent to the ResponseWriter.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
errorHandler: ErrorHandler
+
+ +
logger: Logger = ...
+
+ +
operationHandler: OperationHttpHandler
+
+ +
requestParser: RequestParser
+
+ +
responseWriter: ResponseWriter
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PartialReadWriteLocker.html b/7.x/docs/classes/PartialReadWriteLocker.html new file mode 100644 index 000000000..974bf5d85 --- /dev/null +++ b/7.x/docs/classes/PartialReadWriteLocker.html @@ -0,0 +1,309 @@ +PartialReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PartialReadWriteLocker

+
+

A BaseReadWriteLocker that stores the counter and its associated locks in memory. +The consequence of this is that multiple read requests are possible as long as they occur on the same worker thread. +A read request from a different worker thread will have to wait +until those from the current worker thread are finished.

+

The main reason for this class is due to the file locker that we use only allowing locks to be released +by the same worker thread that acquired them.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
countLocker: ResourceLocker
+
+ +
+
+ +
readCount: Map<string, number>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+ +
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughAdapter.html b/7.x/docs/classes/PassthroughAdapter.html new file mode 100644 index 000000000..9248a741c --- /dev/null +++ b/7.x/docs/classes/PassthroughAdapter.html @@ -0,0 +1,248 @@ +PassthroughAdapter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughAdapter

+
+

OIDC Adapter that calls the corresponding functions of the source Adapter. +Can be extended by adapters that do not want to override all functions +by implementing a decorator pattern.

+
+
+
+

Hierarchy

+
+
+

Implements

+
    +
  • Adapter
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
name: string
+
+ +
source: Adapter
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      userCode: string
    +

    Returns Promise<undefined | void | AdapterPayload>

+
+ +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      id: string
    • +
    • +
      payload: AdapterPayload
    • +
    • +
      expiresIn: number
    +

    Returns Promise<undefined | void>

+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughAdapterFactory.html b/7.x/docs/classes/PassthroughAdapterFactory.html new file mode 100644 index 000000000..ed3d88827 --- /dev/null +++ b/7.x/docs/classes/PassthroughAdapterFactory.html @@ -0,0 +1,140 @@ +PassthroughAdapterFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughAdapterFactory

+
+

A factory that generates an Adapter to be used by the IDP to persist information.

+

The oidc-provider library will call the relevant functions when it needs to find/create/delete metadata. +For a full explanation of how these functions work and what is expected, +have a look at https://github.com/panva/node-oidc-provider/blob/main/example/my_adapter.js

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughConverter.html b/7.x/docs/classes/PassthroughConverter.html new file mode 100644 index 000000000..e8b06a7af --- /dev/null +++ b/7.x/docs/classes/PassthroughConverter.html @@ -0,0 +1,171 @@ +PassthroughConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughConverter

+
+

A RepresentationConverter that does not perform any conversion.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughDataAccessor.html b/7.x/docs/classes/PassthroughDataAccessor.html new file mode 100644 index 000000000..1ead1e582 --- /dev/null +++ b/7.x/docs/classes/PassthroughDataAccessor.html @@ -0,0 +1,338 @@ +PassthroughDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughDataAccessor

+
+

DataAccessor that calls the corresponding functions of the source DataAccessor. +Can be extended by data accessors that do not want to override all functions +by implementing a decorator pattern.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Should throw a NotImplementedHttpError if the DataAccessor does not support storing the given Representation.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
    +

    Throws

    BadRequestHttpError +If it does not support the incoming data.

    +
+
+ +
+
+ +
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughKeyValueStorage.html b/7.x/docs/classes/PassthroughKeyValueStorage.html new file mode 100644 index 000000000..aac9fe017 --- /dev/null +++ b/7.x/docs/classes/PassthroughKeyValueStorage.html @@ -0,0 +1,281 @@ +PassthroughKeyValueStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughKeyValueStorage<TVal>Abstract

+
+

Abstract class to create a KeyValueStorage by wrapping around another one.

+

Exposes abstract functions to modify the key before passing it to the the source storage.

+
+
+
+

Type Parameters

+
    +
  • +

    TVal

+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
source: KeyValueStorage<string, TVal>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    This function will be called on the input key and used as a new key when calling the source.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +

      Original input key.

      +
      +
    +

    Returns string

    A new key to use with the source storage.

    + +
+
+ +
    + +
  • +

    This function is used when calling entries() to revert the key generated by toNewKey().

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +

      A key generated by toNewKey()

      +
      +
    +

    Returns string

    The original key.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughStore.html b/7.x/docs/classes/PassthroughStore.html new file mode 100644 index 000000000..1c9db0c50 --- /dev/null +++ b/7.x/docs/classes/PassthroughStore.html @@ -0,0 +1,321 @@ +PassthroughStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughStore<T>

+
+

Store that calls the corresponding functions of the source Store. +Can be extended by stores that do not want to override all functions +by implementing a decorator pattern.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
source: T
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PasswordLoginHandler.html b/7.x/docs/classes/PasswordLoginHandler.html new file mode 100644 index 000000000..b942f0576 --- /dev/null +++ b/7.x/docs/classes/PasswordLoginHandler.html @@ -0,0 +1,278 @@ +PasswordLoginHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PasswordLoginHandler

+
+

Handles the submission of the Login Form and logs the user in.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accountStore: AccountStore
+
+ +
cookieStore: CookieStore
+
+ +
logger: Logger = ...
+
+ +
passwordStore: PasswordStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Updates the account setting that determines whether the login status needs to be remembered.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      ID of the account.

      +
      +
    • +
    • +
      Optional remember: boolean
      +

      If the account should be remembered or not. The setting will not be updated if this is undefined.

      +
      +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PatchHandler.html b/7.x/docs/classes/PatchHandler.html new file mode 100644 index 000000000..8d01f8e66 --- /dev/null +++ b/7.x/docs/classes/PatchHandler.html @@ -0,0 +1,183 @@ +PatchHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PatchHandler<T>Abstract

+
+

Executes the given Patch.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PatchOperationHandler.html b/7.x/docs/classes/PatchOperationHandler.html new file mode 100644 index 000000000..65461edbb --- /dev/null +++ b/7.x/docs/classes/PatchOperationHandler.html @@ -0,0 +1,198 @@ +PatchOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PatchOperationHandler

+
+

Handles PATCH Operations. +Calls the modifyResource function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PatchingStore.html b/7.x/docs/classes/PatchingStore.html new file mode 100644 index 000000000..366e7ab2f --- /dev/null +++ b/7.x/docs/classes/PatchingStore.html @@ -0,0 +1,324 @@ +PatchingStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PatchingStore<T>

+
+

ResourceStore using decorator pattern for the modifyResource function. +If the original store supports the Patch, behaviour will be identical, +otherwise the PatchHandler will be called instead.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
source: T
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PathBasedReader.html b/7.x/docs/classes/PathBasedReader.html new file mode 100644 index 000000000..fbd44685c --- /dev/null +++ b/7.x/docs/classes/PathBasedReader.html @@ -0,0 +1,246 @@ +PathBasedReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PathBasedReader

+
+

Redirects requests to specific PermissionReaders based on their identifier. +The keys are regular expression strings. +The regular expressions should all start with a slash +and will be evaluated relative to the base URL.

+

Will error if no match is found.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseUrl: string
+
+ +
logger: Logger = ...
+
+ +
paths: Map<RegExp, PermissionReader>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PermissionBasedAuthorizer.html b/7.x/docs/classes/PermissionBasedAuthorizer.html new file mode 100644 index 000000000..af6e5d312 --- /dev/null +++ b/7.x/docs/classes/PermissionBasedAuthorizer.html @@ -0,0 +1,288 @@ +PermissionBasedAuthorizer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PermissionBasedAuthorizer

+
+

Authorizer that bases its decision on the output it gets from its PermissionReader. +For each permission it checks if the reader allows that for at least one credential type, +if yes, authorization is granted. +undefined values for reader results are interpreted as false.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
resourceSet: ResourceSet
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    If we know the operation will return a 404 regardless (= resource does not exist and is not being created), +and the agent is allowed to know about its existence (= the agent has Read permissions), +then immediately send the 404 here, as it makes any other agent permissions irrelevant.

    +

    Otherwise, deny access based on existing grounds.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<never>

    +
+
+ +
    + +
  • +

    Ensures that at least one of the credentials provides permissions for the given mode. +Throws a ForbiddenHttpError or UnauthorizedHttpError depending on the credentials +if access is not allowed.

    +
    +
    +

    Parameters

    +
      +
    • +
      credentials: Credentials
      +

      Credentials that require access.

      +
      +
    • +
    • +
      permissionSet: Partial<Record<AccessMode, boolean>>
      +

      PermissionSet describing the available permissions of the credentials.

      +
      +
    • +
    • +
      mode: AccessMode
      +

      Which mode is requested.

      +
      +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PermissionReader.html b/7.x/docs/classes/PermissionReader.html new file mode 100644 index 000000000..ff4a160d4 --- /dev/null +++ b/7.x/docs/classes/PermissionReader.html @@ -0,0 +1,182 @@ +PermissionReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PermissionReaderAbstract

+
+

Discovers the permissions of the given credentials on the given identifier. +If the reader finds no permission for the requested identifiers and credentials, +it can return an empty or incomplete map.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PickWebIdHandler.html b/7.x/docs/classes/PickWebIdHandler.html new file mode 100644 index 000000000..b6f09ba3d --- /dev/null +++ b/7.x/docs/classes/PickWebIdHandler.html @@ -0,0 +1,232 @@ +PickWebIdHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PickWebIdHandler

+
+

Allows users to choose which WebID they want to authenticate as during an OIDC interaction.

+

One of the main reason picking a WebID is a separate class/request from consenting to the OIDC interaction, +is because the OIDC-provider will only give the information we need for consent +once we have added an accountId to the OIDC interaction, which we do in this class. +The library also really wants to use that accountId as the value that you use for generating the tokens, +meaning we can't just use another value there, so we need to assign the WebID to it, +unless we use a hacky workaround.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
providerFactory: ProviderFactory
+
+ +
webIdStore: WebIdStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PlainJsonLdFilter.html b/7.x/docs/classes/PlainJsonLdFilter.html new file mode 100644 index 000000000..bff3c9e73 --- /dev/null +++ b/7.x/docs/classes/PlainJsonLdFilter.html @@ -0,0 +1,216 @@ +PlainJsonLdFilter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PlainJsonLdFilter

+
+

Filter that errors on JSON-LD with a plain application/json content-type. +This will not store metadata, only throw errors if necessary.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PodCreator.html b/7.x/docs/classes/PodCreator.html new file mode 100644 index 000000000..f7e41f40e --- /dev/null +++ b/7.x/docs/classes/PodCreator.html @@ -0,0 +1,173 @@ +PodCreator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PodCreatorAbstract

+
+

Handles creating a pod and linking the created WebID.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PodQuotaStrategy.html b/7.x/docs/classes/PodQuotaStrategy.html new file mode 100644 index 000000000..f8989c7ff --- /dev/null +++ b/7.x/docs/classes/PodQuotaStrategy.html @@ -0,0 +1,262 @@ +PodQuotaStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PodQuotaStrategy

+
+

The PodQuotaStrategy sets a limit on the amount of data stored on a per pod basis

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accessor: DataAccessor
+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
limit: Size
+
+ +
reporter: SizeReporter<unknown>
+
+

Methods

+
+ +
    + +
  • +

    Get a Passthrough stream that will keep track of the available space. +If the quota is exceeded the stream will emit an error and destroy itself. +Like other Passthrough instances this will simply pass on the chunks, when the quota isn't exceeded.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Guarded<PassThrough>>

    a Passthrough instance that errors when quota is exceeded

    + +
+
+ +
+
+ +
    + +
  • +

    Get the available space when writing data to the given identifier. +If the given resource already exists it will deduct the already taken up +space by that resource since it is going to be overwritten and thus counts +as available space.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      the identifier of the resource of which you want the available space

      +
      +
    +

    Returns Promise<Size>

    the available space and the unit of the space as a Size object

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PodStorageLocationStrategy.html b/7.x/docs/classes/PodStorageLocationStrategy.html new file mode 100644 index 000000000..42bb82619 --- /dev/null +++ b/7.x/docs/classes/PodStorageLocationStrategy.html @@ -0,0 +1,140 @@ +PodStorageLocationStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PodStorageLocationStrategy

+
+

A StorageLocationStrategy to be used when the server has pods which each are a different storage. +The IdentifierGenerator that is used to generate URLs for the pods +is used here to determine what the root pod URL is.

+
+
+
+

Hierarchy

+
    +
  • PodStorageLocationStrategy
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PostOperationHandler.html b/7.x/docs/classes/PostOperationHandler.html new file mode 100644 index 000000000..8d34baf5e --- /dev/null +++ b/7.x/docs/classes/PostOperationHandler.html @@ -0,0 +1,198 @@ +PostOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PostOperationHandler

+
+

Handles POST Operations. +Calls the addResource function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PreconditionFailedHttpError.html b/7.x/docs/classes/PreconditionFailedHttpError.html new file mode 100644 index 000000000..16d6775a0 --- /dev/null +++ b/7.x/docs/classes/PreconditionFailedHttpError.html @@ -0,0 +1,228 @@ +PreconditionFailedHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PreconditionFailedHttpError

+
+

An error thrown when access was denied due to the conditions on the request.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • PreconditionFailedHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 412
+
+ +
isInstance: ((error) => error is HttpError<412>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<412>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<412>

      +
+
+ +
statusCode: 412
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PreferenceParser.html b/7.x/docs/classes/PreferenceParser.html new file mode 100644 index 000000000..6739dd2f5 --- /dev/null +++ b/7.x/docs/classes/PreferenceParser.html @@ -0,0 +1,183 @@ +PreferenceParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PreferenceParserAbstract

+
+

Creates RepresentationPreferences based on the incoming HTTP headers in a HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PreferenceSupport.html b/7.x/docs/classes/PreferenceSupport.html new file mode 100644 index 000000000..85a346960 --- /dev/null +++ b/7.x/docs/classes/PreferenceSupport.html @@ -0,0 +1,146 @@ +PreferenceSupport | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PreferenceSupport

+
+

Helper class that checks if the stored RepresentationConverter and RepresentationPreferences +support the given input RepresentationPreferences and Representation.

+

Creates a new object by combining the input arguments together with the stored preferences and checks +if the converter can handle that object.

+
+
+
+

Hierarchy

+
    +
  • PreferenceSupport
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ProcessHandler.html b/7.x/docs/classes/ProcessHandler.html new file mode 100644 index 000000000..4af223d14 --- /dev/null +++ b/7.x/docs/classes/ProcessHandler.html @@ -0,0 +1,251 @@ +ProcessHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ProcessHandler<TIn, TOut>

+
+

A wrapper handler that will only run the wrapped handler if it is executed from:

+
    +
  • when running multithreaded: either the primary or a worker process
  • +
  • when running singlethreaded: the only process (i.e. always)
  • +
+
+
+
+

Type Parameters

+
    +
  • +

    TIn

  • +
  • +

    TOut

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clusterManager: ClusterManager
+
+ +
executeOnPrimary: boolean
+
+ +
source: AsyncHandler<TIn, TOut>
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PromptFactory.html b/7.x/docs/classes/PromptFactory.html new file mode 100644 index 000000000..1e5d4f9bc --- /dev/null +++ b/7.x/docs/classes/PromptFactory.html @@ -0,0 +1,173 @@ +PromptFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PromptFactoryAbstract

+
+

Used to generate custom interactionPolicy.Prompts.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: DefaultPolicy
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: DefaultPolicy
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: DefaultPolicy
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PromptHandler.html b/7.x/docs/classes/PromptHandler.html new file mode 100644 index 000000000..32eb89b6a --- /dev/null +++ b/7.x/docs/classes/PromptHandler.html @@ -0,0 +1,203 @@ +PromptHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PromptHandler

+
+

Redirects requests based on the OIDC Interaction prompt. +Errors in case no match was found.

+

The reason we use this intermediate handler +instead of letting the OIDC library redirect directly to the correct page, +is because that library creates a cookie with of scope of the target page. +By having the library always redirect to the index page, +the cookie is relevant for all pages and other pages can see if we are still in an interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
promptRoutes: Record<string, InteractionRoute<never>>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PublicCredentialsExtractor.html b/7.x/docs/classes/PublicCredentialsExtractor.html new file mode 100644 index 000000000..0c04713e9 --- /dev/null +++ b/7.x/docs/classes/PublicCredentialsExtractor.html @@ -0,0 +1,164 @@ +PublicCredentialsExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PublicCredentialsExtractor

+
+

Extracts the "public credentials", to be used for data everyone has access to. +This class mainly exists so a Credentials is still generated in case the token parsing fails.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PutOperationHandler.html b/7.x/docs/classes/PutOperationHandler.html new file mode 100644 index 000000000..4727e54d4 --- /dev/null +++ b/7.x/docs/classes/PutOperationHandler.html @@ -0,0 +1,207 @@ +PutOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PutOperationHandler

+
+

Handles PUT Operations. +Calls the setRepresentation function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
metadataStrategy: AuxiliaryStrategy
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/QuadToRdfConverter.html b/7.x/docs/classes/QuadToRdfConverter.html new file mode 100644 index 000000000..7580518fd --- /dev/null +++ b/7.x/docs/classes/QuadToRdfConverter.html @@ -0,0 +1,230 @@ +QuadToRdfConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class QuadToRdfConverter

+
+

Converts internal/quads to most major RDF serializations.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
inputTypes: Promise<ValuePreferences>
+
+ +
outputPreferences?: ValuePreferences
+
+ +
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/QuotaStrategy.html b/7.x/docs/classes/QuotaStrategy.html new file mode 100644 index 000000000..896486f88 --- /dev/null +++ b/7.x/docs/classes/QuotaStrategy.html @@ -0,0 +1,224 @@ +QuotaStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class QuotaStrategyAbstract

+
+

A QuotaStrategy is used when we want to set a limit to the amount of data that can be +stored on the server. +This can range from a limit for the whole server to a limit on a per pod basis. +The way the size of a resource is calculated is implemented by the implementing classes. +This can be bytes, quads, file count, ...

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
limit: Size
+
+ +
reporter: SizeReporter<unknown>
+
+

Methods

+
+ +
    + +
  • +

    Get a Passthrough stream that will keep track of the available space. +If the quota is exceeded the stream will emit an error and destroy itself. +Like other Passthrough instances this will simply pass on the chunks, when the quota isn't exceeded.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Guarded<PassThrough>>

    a Passthrough instance that errors when quota is exceeded

    + +
+
+ +
    + +
  • +

    Get an estimated size of the resource

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<undefined | Size>

    a Size object containing the estimated size and unit of the resource

    + +
+
+ +
    + +
  • +

    Get the available space when writing data to the given identifier. +If the given resource already exists it will deduct the already taken up +space by that resource since it is going to be overwritten and thus counts +as available space.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      the identifier of the resource of which you want the available space

      +
      +
    +

    Returns Promise<Size>

    the available space and the unit of the space as a Size object

    + +
+
+ +
    + +
  • +

    Get the currently used/occupied space.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      the identifier that should be used to calculate the total

      +
      +
    +

    Returns Promise<Size>

    a Size object containing the requested value. +If quota is not relevant for this identifier, Size.amount should be Number.MAX_SAFE_INTEGER

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/QuotaValidator.html b/7.x/docs/classes/QuotaValidator.html new file mode 100644 index 000000000..8fac8d37b --- /dev/null +++ b/7.x/docs/classes/QuotaValidator.html @@ -0,0 +1,190 @@ +QuotaValidator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class QuotaValidator

+
+

The QuotaValidator validates data streams by making sure they would not exceed the limits of a QuotaStrategy.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
strategy: QuotaStrategy
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: ValidatorInput
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RangeMetadataWriter.html b/7.x/docs/classes/RangeMetadataWriter.html new file mode 100644 index 000000000..4de75c841 --- /dev/null +++ b/7.x/docs/classes/RangeMetadataWriter.html @@ -0,0 +1,195 @@ +RangeMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RangeMetadataWriter

+
+

Generates the necessary content-range header if there is range metadata. +If the start or end is unknown, a * will be used instead. +According to the RFC, this is incorrect, +but is all we can do as long as we don't know the full length of the representation in advance. +For the same reason, the total length of the representation will always be *.

+

This class also adds the content-length header. +This will contain either the full size for standard requests, +or the size of the slice for range requests.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RangeNotSatisfiedHttpError.html b/7.x/docs/classes/RangeNotSatisfiedHttpError.html new file mode 100644 index 000000000..32dddd35e --- /dev/null +++ b/7.x/docs/classes/RangeNotSatisfiedHttpError.html @@ -0,0 +1,237 @@ +RangeNotSatisfiedHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RangeNotSatisfiedHttpError

+
+

An error thrown when the requested range is not supported.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • RangeNotSatisfiedHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 416
+
+ +
isInstance: ((error) => error is HttpError<416>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<416>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<416>

      +
+
+ +
statusCode: 416
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RangePreferenceParser.html b/7.x/docs/classes/RangePreferenceParser.html new file mode 100644 index 000000000..ab587bb5a --- /dev/null +++ b/7.x/docs/classes/RangePreferenceParser.html @@ -0,0 +1,181 @@ +RangePreferenceParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RangePreferenceParser

+
+

Parses the range header into range preferences. +If the range corresponds to a suffix-length range, it will be stored in start as a negative value.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RawBodyParser.html b/7.x/docs/classes/RawBodyParser.html new file mode 100644 index 000000000..346832262 --- /dev/null +++ b/7.x/docs/classes/RawBodyParser.html @@ -0,0 +1,183 @@ +RawBodyParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RawBodyParser

+
+

Converts incoming HttpRequest to a Representation without any further parsing.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: BodyParserArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RdfPatcher.html b/7.x/docs/classes/RdfPatcher.html new file mode 100644 index 000000000..bb89b2a6b --- /dev/null +++ b/7.x/docs/classes/RdfPatcher.html @@ -0,0 +1,198 @@ +RdfPatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RdfPatcher

+
+

Patcher that converts the representation data to a representation with an N3 store, does the patch using this store +and then converts the representation with store back to a representation with data which gets returned

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
patcher: RepresentationPatcher<RdfDatasetRepresentation>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RdfStorePatcher.html b/7.x/docs/classes/RdfStorePatcher.html new file mode 100644 index 000000000..d1b28f68e --- /dev/null +++ b/7.x/docs/classes/RdfStorePatcher.html @@ -0,0 +1,171 @@ +RdfStorePatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RdfStorePatcherAbstract

+
+

Applies a Patch on an N3.js Store.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RdfToQuadConverter.html b/7.x/docs/classes/RdfToQuadConverter.html new file mode 100644 index 000000000..029d22087 --- /dev/null +++ b/7.x/docs/classes/RdfToQuadConverter.html @@ -0,0 +1,231 @@ +RdfToQuadConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RdfToQuadConverter

+
+

Converts most major RDF serializations to internal/quads.

+

Custom contexts can be defined to be used when parsing JSON-LD. +The keys of the object should be the URL of the context, +and the values the file path of the contexts to use when the JSON-LD parser would fetch the given context. +We use filepaths because embedding them directly into the configurations breaks Components.js.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
documentLoader: ContextDocumentLoader
+
+ +
inputTypes: Promise<ValuePreferences>
+
+ +
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RdfValidator.html b/7.x/docs/classes/RdfValidator.html new file mode 100644 index 000000000..db0e10f6b --- /dev/null +++ b/7.x/docs/classes/RdfValidator.html @@ -0,0 +1,191 @@ +RdfValidator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RdfValidator

+
+

Validates a Representation by verifying if the data stream contains valid RDF data. +It does this by letting the stored RepresentationConverter convert the data.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: ValidatorInput
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ReadOnlyStore.html b/7.x/docs/classes/ReadOnlyStore.html new file mode 100644 index 000000000..ac1b55ead --- /dev/null +++ b/7.x/docs/classes/ReadOnlyStore.html @@ -0,0 +1,313 @@ +ReadOnlyStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ReadOnlyStore<T>

+
+

Store that only allow read operations on the underlying source.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
source: T
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RecordObject.html b/7.x/docs/classes/RecordObject.html new file mode 100644 index 000000000..d05416410 --- /dev/null +++ b/7.x/docs/classes/RecordObject.html @@ -0,0 +1,105 @@ +RecordObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RecordObject

+
+

Helper class for instantiating multiple objects with Components.js. +See https://github.com/LinkedSoftwareDependencies/Components.js/issues/26

+
+
+
+

Hierarchy

+
    +
  • RecordObject
+
+

Implements

+
    +
  • Record<string, unknown>
+
+

Indexable

+
[key: string]: unknown
+
+
+
+ +
+
+

Constructors

+
+
+

Constructors

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RedirectHttpError.html b/7.x/docs/classes/RedirectHttpError.html new file mode 100644 index 000000000..1001977cf --- /dev/null +++ b/7.x/docs/classes/RedirectHttpError.html @@ -0,0 +1,279 @@ +RedirectHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RedirectHttpError<TCode>

+
+

An error corresponding to a 3xx status code. +Includes the location it redirects to.

+
+
+
+

Type Parameters

+
    +
  • +

    TCode extends number = number

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
location: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: TCode
+
+ +
prepareStackTrace?: ((err, stackTraces) => any)
+
+

Type declaration

+
+
+ +
stackTraceLimit: number
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • +
      targetObject: object
    • +
    • +
      Optional constructorOpt: Function
    +

    Returns void

    +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RedirectingErrorHandler.html b/7.x/docs/classes/RedirectingErrorHandler.html new file mode 100644 index 000000000..b4b6fa4fb --- /dev/null +++ b/7.x/docs/classes/RedirectingErrorHandler.html @@ -0,0 +1,172 @@ +RedirectingErrorHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RedirectingErrorHandler

+
+

Internally we create redirects by throwing specific RedirectHttpErrors. +This Error handler converts those to RedirectResponseDescriptions that are used for output.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: ErrorHandlerArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RedirectingHttpHandler.html b/7.x/docs/classes/RedirectingHttpHandler.html new file mode 100644 index 000000000..88145bd22 --- /dev/null +++ b/7.x/docs/classes/RedirectingHttpHandler.html @@ -0,0 +1,286 @@ +RedirectingHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RedirectingHttpHandler

+
+

Handler that redirects paths matching given patterns +to their corresponding URL, substituting selected groups.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
    + +
  • +

    Creates a handler for the provided redirects.

    +
    +
    +

    Parameters

    +
      +
    • +
      redirects: Record<string, string>
      +

      A mapping between URL patterns.

      +
      +
    • +
    • +
      baseUrl: string
      +

      Base URL of the server.

      +
      +
    • +
    • +
      targetExtractor: TargetExtractor
      +

      To extract the target from the request.

      +
      +
    • +
    • +
      responseWriter: ResponseWriter
      +

      To write the redirect to the response.

      +
      +
    • +
    • +
      statusCode: 302 | 301 | 308 | 303 | 307 = 308
      +

      Desired 30x redirection code (defaults to 308).

      +
      +
    +

    Returns RedirectingHttpHandler

    +
+
+

Properties

+
+ +
baseUrl: string
+

Base URL of the server.

+
+
+
+ +
logger: Logger = ...
+
+ +
redirects: {
    redirectPattern: string;
    regex: RegExp;
}[]
+
+

Type declaration

+
    +
  • +
    redirectPattern: string
  • +
  • +
    regex: RegExp
+
+ +
responseWriter: ResponseWriter
+

To write the redirect to the response.

+
+
+
+ +
statusCode: 302 | 301 | 308 | 303 | 307 = 308
+

Desired 30x redirection code (defaults to 308).

+
+
+
+ +
targetExtractor: TargetExtractor
+

To extract the target from the request.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: HttpHandlerInput
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RedisLocker.html b/7.x/docs/classes/RedisLocker.html new file mode 100644 index 000000000..63dd4114c --- /dev/null +++ b/7.x/docs/classes/RedisLocker.html @@ -0,0 +1,488 @@ +RedisLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RedisLocker

+
+

A Redis Locker that can be used as both:

+
    +
  • a Read Write Locker that uses a (single) Redis server to store the locks and counts.
  • +
  • a Resource Locker that uses a (single) Redis server to store the lock. +This solution should be process-safe. The only references to locks are string keys +derived from identifier paths.
  • +
+

The Read Write algorithm roughly goes as follows:

+
    +
  • Acquire a read lock: allowed as long as there is no write lock. On acquiring the read counter goes up.
  • +
  • Acquire a write lock: allowed as long as there is no other write lock AND the read counter is 0.
  • +
  • Release a read lock: decreases the read counter with 1
  • +
  • Release a write lock: unlocks the write lock
  • +
+

The Resource locking algorithm uses a single mutex/lock.

+

All operations, such as checking for a write lock AND read count, are executed in a single Lua script. +These scripts are used by Redis as a single new command. +Redis executes its operations in a single thread, as such, each such operation can be considered atomic.

+

The operation to (un)lock will always resolve with either 1/OK/true if succeeded or 0/false if not succeeded. +Rejection with errors will be happen on actual failures. Retrying the (un)lock operations will be done by making +use of the LockUtils' retryFunctionUntil function.

+
    +
  • +
+
+
+
+

Hierarchy

+
    +
  • RedisLocker
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
    + +
  • +

    Creates a new RedisClient

    +
    +
    +

    Parameters

    +
      +
    • +
      redisClient: string = '127.0.0.1:6379'
      +

      Redis connection string of a standalone Redis node

      +
      +
    • +
    • +
      attemptSettings: AttemptSettings = {}
      +

      Override default AttemptSettings

      +
      +
    • +
    • +
      Optional redisSettings: RedisSettings
      +

      Addition settings used to create the Redis client or to interact with the Redis server

      +
      +
    +

    Returns RedisLocker

    +
+
+

Properties

+
+ +
attemptSettings: Required<AttemptSettings>
+
+ +
finalized: boolean = false
+
+ +
logger: Logger = ...
+
+ +
namespacePrefix: string
+
+ +
redis: Redis
+
+ +
redisLock: RedisResourceLock
+
+ +
redisRw: RedisReadWriteLock
+
+

Methods

+
+ +
+
+ +
+
+ +
    + +
  • +

    Generate and return a RedisClient based on the provided string

    +
    +
    +

    Parameters

    +
      +
    • +
      redisClientString: string
      +

      A string that contains either a host address and a + port number like '127.0.0.1:6379' or just a port number like '6379'.

      +
      +
    • +
    • +
      options: Omit<RedisSettings, "namespacePrefix">
    +

    Returns Redis

    +
+
+ +
+
+ +
    + +
  • +

    Create a scoped Redis key for Read-Write locking.

    +
    +
    +

    Parameters

    +
    +

    Returns string

    A scoped Redis key that allows cleanup afterwards without affecting other keys.

    + +
+
+ +
    + +
  • +

    Create a scoped Redis key for Resource locking.

    +
    +
    +

    Parameters

    +
    +

    Returns string

    A scoped Redis key that allows cleanup afterwards without affecting other keys.

    + +
+
+ +
+
+ +
    + +
  • +

    Releases a lock on the requested identifier. +The promise will resolve when the lock has been released. +If there is no lock on the resource, an error should be thrown.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Wrapper function for all (un)lock operations. If the fn() resolves to false (after applying +fromResp2ToBool, the result will be swallowed. When fn() resolves to true, this wrapper +will return true. Any error coming from fn() will be thrown.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: (() => Promise<RedisAnswer>)
      +

      The function reference to swallow false from.

      +
      +
      +
        +
      • +
          +
        • (): Promise<RedisAnswer>
        • +
        • +

          Returns Promise<RedisAnswer>

    +

    Returns (() => Promise<unknown>)

    +
      +
    • +
        +
      • (): Promise<unknown>
      • +
      • +

        Wrapper function for all (un)lock operations. If the fn() resolves to false (after applying +fromResp2ToBool, the result will be swallowed. When fn() resolves to true, this wrapper +will return true. Any error coming from fn() will be thrown.

        +
        +

        Returns Promise<unknown>

        +
    +
+
+ +
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+ +
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RegexRouterRule.html b/7.x/docs/classes/RegexRouterRule.html new file mode 100644 index 000000000..bbadb365a --- /dev/null +++ b/7.x/docs/classes/RegexRouterRule.html @@ -0,0 +1,256 @@ +RegexRouterRule | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RegexRouterRule

+
+

Routes requests to a store based on the path of the identifier. +The identifier will be stripped of the base URI after which regexes will be used to find the correct store. +The trailing slash of the base URI will still be present so the first character a regex can match would be that /. +This way regexes such as /container/ can match containers in any position.

+

In case none of the regexes match an error will be thrown.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
base: string
+
+ +
rules: RegexRule[]
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RegexRule.html b/7.x/docs/classes/RegexRule.html new file mode 100644 index 000000000..1a48c9c8f --- /dev/null +++ b/7.x/docs/classes/RegexRule.html @@ -0,0 +1,118 @@ +RegexRule | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RegexRule

+
+

Utility class to easily configure Regex to ResourceStore mappings in the config files.

+
+
+
+

Hierarchy

+
    +
  • RegexRule
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
regex: RegExp
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RelativePathInteractionRoute.html b/7.x/docs/classes/RelativePathInteractionRoute.html new file mode 100644 index 000000000..a1a852cda --- /dev/null +++ b/7.x/docs/classes/RelativePathInteractionRoute.html @@ -0,0 +1,188 @@ +RelativePathInteractionRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RelativePathInteractionRoute<TBase>

+
+

A route that is relative to another route. +The relative path will be joined to the input base, +which can either be an absolute URL or an InteractionRoute of which the path will be used.

+
+
+
+

Type Parameters

+
    +
  • +

    TBase extends string

+
+

Hierarchy

+
    +
  • RelativePathInteractionRoute
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
base: InteractionRoute<TBase>
+
+ +
relativePath: string
+
+

Methods

+
+ +
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<TBase, string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<TBase, string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RepresentationConverter.html b/7.x/docs/classes/RepresentationConverter.html new file mode 100644 index 000000000..e53da7368 --- /dev/null +++ b/7.x/docs/classes/RepresentationConverter.html @@ -0,0 +1,177 @@ +RepresentationConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RepresentationConverterAbstract

+
+

Converts a Representation from one media type to another, based on the given preferences.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RepresentationConvertingStore.html b/7.x/docs/classes/RepresentationConvertingStore.html new file mode 100644 index 000000000..135abcd7d --- /dev/null +++ b/7.x/docs/classes/RepresentationConvertingStore.html @@ -0,0 +1,379 @@ +RepresentationConvertingStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RepresentationConvertingStore<T>

+
+

Store that provides (optional) conversion of incoming and outgoing Representations.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
+
+ +
logger: Logger = ...
+
+ +
metadataStrategy: AuxiliaryStrategy
+
+ +
+
+ +
source: T
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RepresentationMetadata.html b/7.x/docs/classes/RepresentationMetadata.html new file mode 100644 index 000000000..3512fa879 --- /dev/null +++ b/7.x/docs/classes/RepresentationMetadata.html @@ -0,0 +1,766 @@ +RepresentationMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RepresentationMetadata

+
+

Stores the metadata triples and provides methods for easy access. +Most functions return the metadata object to allow for chaining.

+
+
+
+

Hierarchy

+
    +
  • RepresentationMetadata
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
id: BlankNode | NamedNode<string>
+
+ +
logger: Logger = ...
+
+ +
store: Store<Quad, Quad, Quad, Quad>
+
+

Accessors

+
+ +
+
+ +
+
+ +
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Helper function to simplify add/remove +Runs the given function on all predicate/object pairs, but only converts the predicate to a named node once.

    +
    +
    +

    Parameters

    +
      +
    • +
      predicate: NamedNode<string>
    • +
    • +
      object: MetadataValue
    • +
    • +
      forFn: ((pred, obj) => void)
      +
        +
      • +
          +
        • (pred, obj): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            pred: NamedNode<string>
          • +
          • +
            obj: BlankNode | Literal | NamedNode<string>
          +

          Returns void

    +

    Returns RepresentationMetadata

    +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      predicate: NamedNode<string>
      +

      Predicate to get the value for.

      +
      +
    • +
    • +
      Optional graph: MetadataGraph
      +

      Optional graph where the triple should be found.

      +
      +
    +

    Returns undefined | Term

    The corresponding value. Undefined if there is no match

    + +
    +

    Throws

    Error +If there are multiple matching values.

    +
+
+ +
    + +
  • +

    Finds all object values matching the given predicate and/or graph.

    +
    +
    +

    Parameters

    +
      +
    • +
      predicate: NamedNode<string>
      +

      Optional predicate to get the values for.

      +
      +
    • +
    • +
      Optional graph: MetadataGraph
      +

      Optional graph where to get from.

      +
      +
    +

    Returns Term[]

    An array with all matches.

    + +
+
+ +
    + +
  • +

    Parse the internal RDF structure to retrieve the Record with ContentType Parameters.

    +
    +

    Returns undefined | ContentType

    A ContentType object containing the value and optional parameters if there is one.

    + +
+
+ +
    + +
  • +

    Verifies if a specific triple can be found in the metadata. +Undefined parameters are interpreted as wildcards.

    +
    +
    +

    Parameters

    +
      +
    • +
      predicate: null | string | NamedNode<string> = null
    • +
    • +
      object: null | string | BlankNode | Literal | NamedNode<string> = null
    • +
    • +
      graph: null | MetadataGraph = null
    +

    Returns boolean

    +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      subject: null | string | BlankNode | NamedNode<string> = null
    • +
    • +
      predicate: null | NamedNode<string> = null
    • +
    • +
      object: null | string | BlankNode | Literal | NamedNode<string> = null
    • +
    • +
      graph: null | MetadataGraph = null
    +

    Returns Quad[]

    All matching metadata quads.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RepresentationPatchHandler.html b/7.x/docs/classes/RepresentationPatchHandler.html new file mode 100644 index 000000000..a55df342a --- /dev/null +++ b/7.x/docs/classes/RepresentationPatchHandler.html @@ -0,0 +1,200 @@ +RepresentationPatchHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RepresentationPatchHandler

+
+

Handles a patch operation by getting the representation from the store, applying a RepresentationPatcher, +and then writing the result back to the store.

+

In case there is no original representation (the store throws a NotFoundHttpError), +the patcher is expected to create a new one.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RepresentationPatcher.html b/7.x/docs/classes/RepresentationPatcher.html new file mode 100644 index 000000000..4666d987c --- /dev/null +++ b/7.x/docs/classes/RepresentationPatcher.html @@ -0,0 +1,187 @@ +RepresentationPatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RepresentationPatcher<T>Abstract

+
+

Handles the patching of a specific Representation.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RequestParser.html b/7.x/docs/classes/RequestParser.html new file mode 100644 index 000000000..1d79770ff --- /dev/null +++ b/7.x/docs/classes/RequestParser.html @@ -0,0 +1,173 @@ +RequestParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RequestParserAbstract

+
+

Converts an incoming HttpRequest to an Operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ResetPasswordHandler.html b/7.x/docs/classes/ResetPasswordHandler.html new file mode 100644 index 000000000..88d463144 --- /dev/null +++ b/7.x/docs/classes/ResetPasswordHandler.html @@ -0,0 +1,242 @@ +ResetPasswordHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ResetPasswordHandler

+
+

Resets a password if a valid recordId is provided, +which should have been generated by a different handler.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
forgotPasswordStore: ForgotPasswordStore
+
+ +
logger: Logger = ...
+
+ +
passwordStore: PasswordStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ResetResponseDescription.html b/7.x/docs/classes/ResetResponseDescription.html new file mode 100644 index 000000000..78b2f6393 --- /dev/null +++ b/7.x/docs/classes/ResetResponseDescription.html @@ -0,0 +1,124 @@ +ResetResponseDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ResetResponseDescription

+
+

Corresponds to a 205 response.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
data?: Guarded<Readable>
+
+ +
+
+ +
statusCode: number
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ResolveLoginHandler.html b/7.x/docs/classes/ResolveLoginHandler.html new file mode 100644 index 000000000..95212f596 --- /dev/null +++ b/7.x/docs/classes/ResolveLoginHandler.html @@ -0,0 +1,258 @@ +ResolveLoginHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ResolveLoginHandlerAbstract

+
+

A handler that takes care of all the necessary steps when logging a user in, +such as generating a cookie and setting the necessary OIDC information. +Classes that resolve login methods should extend this class and implement the login method.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accountStore: AccountStore
+
+ +
cookieStore: CookieStore
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Updates the account setting that determines whether the login status needs to be remembered.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      ID of the account.

      +
      +
    • +
    • +
      Optional remember: boolean
      +

      If the account should be remembered or not. The setting will not be updated if this is undefined.

      +
      +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ResponseDescription.html b/7.x/docs/classes/ResponseDescription.html new file mode 100644 index 000000000..a1bf869d2 --- /dev/null +++ b/7.x/docs/classes/ResponseDescription.html @@ -0,0 +1,142 @@ +ResponseDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ResponseDescription

+
+

The result of executing an operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
data?: Guarded<Readable>
+
+ +
+
+ +
statusCode: number
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ResponseWriter.html b/7.x/docs/classes/ResponseWriter.html new file mode 100644 index 000000000..5185f5aa9 --- /dev/null +++ b/7.x/docs/classes/ResponseWriter.html @@ -0,0 +1,188 @@ +ResponseWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ResponseWriterAbstract

+
+

Writes the ResponseDescription to the HttpResponse.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RootFilePathHandler.html b/7.x/docs/classes/RootFilePathHandler.html new file mode 100644 index 000000000..4d824f209 --- /dev/null +++ b/7.x/docs/classes/RootFilePathHandler.html @@ -0,0 +1,206 @@ +RootFilePathHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RootFilePathHandler

+
+

Uses a FileIdentifierMapper to generate a root file path variable based on the identifier. +Will throw an error if the resulting file path already exists.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RootStorageLocationStrategy.html b/7.x/docs/classes/RootStorageLocationStrategy.html new file mode 100644 index 000000000..a91c4acb7 --- /dev/null +++ b/7.x/docs/classes/RootStorageLocationStrategy.html @@ -0,0 +1,133 @@ +RootStorageLocationStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RootStorageLocationStrategy

+
+

A StorageLocationStrategy to be used when the server has one storage in the root container of the server.

+
+
+
+

Hierarchy

+
    +
  • RootStorageLocationStrategy
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RouterHandler.html b/7.x/docs/classes/RouterHandler.html new file mode 100644 index 000000000..02054f01f --- /dev/null +++ b/7.x/docs/classes/RouterHandler.html @@ -0,0 +1,251 @@ +RouterHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RouterHandler

+
+

A BaseRouterHandler for an HttpHandler. +Uses a TargetExtractor to generate the target identifier.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
allMethods: boolean
+
+ +
allowedMethods: string[]
+
+ +
allowedPathNamesRegEx: RegExp[]
+
+ +
baseUrlLength: number
+
+ +
handler: HttpHandler
+
+ +
targetExtractor: TargetExtractor
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RouterRule.html b/7.x/docs/classes/RouterRule.html new file mode 100644 index 000000000..88cf884aa --- /dev/null +++ b/7.x/docs/classes/RouterRule.html @@ -0,0 +1,191 @@ +RouterRule | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RouterRuleAbstract

+
+

Finds which store needs to be accessed for the given resource, +potentially based on the Representation of incoming data.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RoutingAuxiliaryIdentifierStrategy.html b/7.x/docs/classes/RoutingAuxiliaryIdentifierStrategy.html new file mode 100644 index 000000000..bd2b2d0ee --- /dev/null +++ b/7.x/docs/classes/RoutingAuxiliaryIdentifierStrategy.html @@ -0,0 +1,227 @@ +RoutingAuxiliaryIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RoutingAuxiliaryIdentifierStrategy

+
+

An AuxiliaryIdentifierStrategy that combines multiple AuxiliaryIdentifierStrategies into one. +Uses isAuxiliaryIdentifier to know which strategy to route to.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RoutingAuxiliaryStrategy.html b/7.x/docs/classes/RoutingAuxiliaryStrategy.html new file mode 100644 index 000000000..ff62c0241 --- /dev/null +++ b/7.x/docs/classes/RoutingAuxiliaryStrategy.html @@ -0,0 +1,334 @@ +RoutingAuxiliaryStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RoutingAuxiliaryStrategy

+
+

An AuxiliaryStrategy that combines multiple AuxiliaryStrategies into one. +Uses isAuxiliaryIdentifier to know which strategy to call for which call.

+

addMetadata will either call all strategies if the input is the subject identifier, +or only the matching strategy if the input is an auxiliary identifier.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
sources: AuxiliaryStrategy[] = []
+
+

Methods

+
+ +
    + +
  • +

    Adds metadata related to this auxiliary resource, +in case this is required for this type of auxiliary resource. +The metadata that is added depends on the given identifier being an auxiliary or subject resource: +the metadata will be used to link to the other one, and potentially add extra typing info.

    +

    Used for: +Solid, §4.3.1: "For any defined auxiliary resource available for a given Solid resource, all representations of +that resource MUST include an HTTP Link header pointing to the location of each auxiliary resource." +https://solid.github.io/specification/protocol#auxiliary-resources-server

    +

    The above is an example of how that metadata would only be added in case the input is the subject identifier.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RoutingResourceStore.html b/7.x/docs/classes/RoutingResourceStore.html new file mode 100644 index 000000000..62a738e7d --- /dev/null +++ b/7.x/docs/classes/RoutingResourceStore.html @@ -0,0 +1,322 @@ +RoutingResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RoutingResourceStore

+
+

Store that routes the incoming request to a specific store based on the stored ResourceRouter. +In case no store was found for one of the functions that take no data (GET/PATCH/DELETE), +a 404 will be thrown. In the other cases the error of the router will be thrown (which would probably be 400).

+
+
+
+

Hierarchy

+
    +
  • RoutingResourceStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SafeErrorHandler.html b/7.x/docs/classes/SafeErrorHandler.html new file mode 100644 index 000000000..4cc73feef --- /dev/null +++ b/7.x/docs/classes/SafeErrorHandler.html @@ -0,0 +1,207 @@ +SafeErrorHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SafeErrorHandler

+
+

Returns a simple text description of an error. +This class is a failsafe in case the wrapped error handler fails.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
errorHandler: ErrorHandler
+
+ +
logger: Logger = ...
+
+ +
showStackTrace: boolean
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SeededAccountInitializer.html b/7.x/docs/classes/SeededAccountInitializer.html new file mode 100644 index 000000000..7ad651911 --- /dev/null +++ b/7.x/docs/classes/SeededAccountInitializer.html @@ -0,0 +1,212 @@ +SeededAccountInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SeededAccountInitializer

+
+

Initializes a set of accounts based on the input data. +These accounts have exactly 1 email/password login method, and 0 or more pods. +The pod settings that can be defined are identical to those of the CreatePodHandler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accountStore: AccountStore
+
+ +
configFilePath?: string
+
+ +
logger: Logger = ...
+
+ +
passwordStore: PasswordStore
+
+ +
podCreator: PodCreator
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SequenceHandler.html b/7.x/docs/classes/SequenceHandler.html new file mode 100644 index 000000000..fd000ba8b --- /dev/null +++ b/7.x/docs/classes/SequenceHandler.html @@ -0,0 +1,206 @@ +SequenceHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SequenceHandler<TIn, TOut>

+
+

A composite handler that will try to run all supporting handlers sequentially +and return the value of the last supported handler. +The canHandle check of this handler will always succeed.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn = void

  • +
  • +

    TOut = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
handlers: AsyncHandler<TIn, TOut>[]
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<undefined | TOut>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<undefined | TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ServerConfigurator.html b/7.x/docs/classes/ServerConfigurator.html new file mode 100644 index 000000000..ecdf3907f --- /dev/null +++ b/7.x/docs/classes/ServerConfigurator.html @@ -0,0 +1,174 @@ +ServerConfigurator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ServerConfiguratorAbstract

+
+

Configures a Server by attaching listeners for specific events.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ServerInitializer.html b/7.x/docs/classes/ServerInitializer.html new file mode 100644 index 000000000..1fadcd9df --- /dev/null +++ b/7.x/docs/classes/ServerInitializer.html @@ -0,0 +1,229 @@ +ServerInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ServerInitializer

+
+

Creates and starts an HTTP server.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
port?: number
+
+ +
server?: Server<typeof IncomingMessage, typeof ServerResponse>
+
+ +
serverFactory: HttpServerFactory
+
+ +
socketPath?: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ShorthandExtractor.html b/7.x/docs/classes/ShorthandExtractor.html new file mode 100644 index 000000000..710f06e80 --- /dev/null +++ b/7.x/docs/classes/ShorthandExtractor.html @@ -0,0 +1,175 @@ +ShorthandExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ShorthandExtractorAbstract

+
+

A handler that computes a specific value from a given map of values.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<unknown>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<unknown>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ShorthandResolver.html b/7.x/docs/classes/ShorthandResolver.html new file mode 100644 index 000000000..901d09c6a --- /dev/null +++ b/7.x/docs/classes/ShorthandResolver.html @@ -0,0 +1,175 @@ +ShorthandResolver | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ShorthandResolverAbstract

+
+

Converts a key/value object, extracted from the CLI or passed as a parameter, +into a new key/value object where the keys are variables defined in the Components.js configuration. +The resulting values are the values that should be assigned to those variables.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<VariableBindings>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<VariableBindings>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SingleContainerJsonStorage.html b/7.x/docs/classes/SingleContainerJsonStorage.html new file mode 100644 index 000000000..a18a08260 --- /dev/null +++ b/7.x/docs/classes/SingleContainerJsonStorage.html @@ -0,0 +1,334 @@ +SingleContainerJsonStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SingleContainerJsonStorage<T>

+
+

A variant of a JsonResourceStorage where the entries() call +does not recursively iterate through all containers. +Only the documents that are found in the root container are returned.

+

This class was created to support migration where different storages are nested in one main .internal container, +and we specifically want to only return entries of one storage.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
container: string
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SingleRootIdentifierStrategy.html b/7.x/docs/classes/SingleRootIdentifierStrategy.html new file mode 100644 index 000000000..a8d3cfe94 --- /dev/null +++ b/7.x/docs/classes/SingleRootIdentifierStrategy.html @@ -0,0 +1,213 @@ +SingleRootIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SingleRootIdentifierStrategy

+
+

An IdentifierStrategy that assumes there is only 1 root and all other identifiers are made by appending to that root.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseUrl: string
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SliceStream.html b/7.x/docs/classes/SliceStream.html new file mode 100644 index 000000000..0e53d0bfe --- /dev/null +++ b/7.x/docs/classes/SliceStream.html @@ -0,0 +1,4044 @@ +SliceStream | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SliceStream

+
+

A stream that slices a part out of another stream. +start and end are inclusive. +If end is not defined it is until the end of the stream.

+

Negative start values can be used to instead slice that many streams off the end of the stream. +This requires the size field to be defined.

+

Both object and non-object streams are supported. +This needs to be explicitly specified, +as the class makes no assumptions based on the object mode of the source stream.

+
+
+
+

Hierarchy

+
    +
  • Transform +
      +
    • SliceStream
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
allowHalfOpen: boolean
+

If false then the stream will automatically end the writable side when the +readable side ends. Set initially by the allowHalfOpen constructor option, +which defaults to false.

+

This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is +emitted.

+
+
+

Since

v0.9.4

+
+
+ +
closed: boolean
+
+ +
destroyed: boolean
+

Is true after readable.destroy() has been called.

+
+
+

Since

v8.0.0

+
+
+ +
errored: null | Error
+
+ +
readable: boolean
+

Is true if it is safe to call readable.read(), which means +the stream has not been destroyed or emitted 'error' or 'end'.

+
+
+

Since

v11.4.0

+
+
+ +
readableAborted: boolean
+

Returns whether the stream was destroyed or errored before emitting 'end'.

+
+
+

Since

v16.8.0

+
+
+ +
readableDidRead: boolean
+

Returns whether 'data' has been emitted.

+
+
+

Since

v16.7.0, v14.18.0

+
+
+ +
readableEncoding: null | BufferEncoding
+

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

+
+
+

Since

v12.7.0

+
+
+ +
readableEnded: boolean
+

Becomes true when 'end' event is emitted.

+
+
+

Since

v12.9.0

+
+
+ +
readableFlowing: null | boolean
+

This property reflects the current state of a Readable stream as described +in the Three states section.

+
+
+

Since

v9.4.0

+
+
+ +
readableHighWaterMark: number
+

Returns the value of highWaterMark passed when creating this Readable.

+
+
+

Since

v9.3.0

+
+
+ +
readableLength: number
+

This property contains the number of bytes (or objects) in the queue +ready to be read. The value provides introspection data regarding +the status of the highWaterMark.

+
+
+

Since

v9.4.0

+
+
+ +
readableObjectMode: boolean
+

Getter for the property objectMode of a given Readable stream.

+
+
+

Since

v12.3.0

+
+
+ +
remainingRead: number
+
+ +
remainingSkip: number
+
+ +
source: Readable
+
+ +
writable: boolean
+
+ +
writableCorked: number
+
+ +
writableEnded: boolean
+
+ +
writableFinished: boolean
+
+ +
writableHighWaterMark: number
+
+ +
writableLength: number
+
+ +
writableNeedDrain: boolean
+
+ +
writableObjectMode: boolean
+
+ +
captureRejectionSymbol: typeof captureRejectionSymbol
+
+ +
captureRejections: boolean
+

Sets or gets the default captureRejection value for all emitters.

+
+
+
+ +
defaultMaxListeners: number
+
+ +
errorMonitor: typeof errorMonitor
+

This symbol shall be used to install a listener for only monitoring 'error' +events. Listeners installed using this symbol are called before the regular +'error' listeners are called.

+

Installing a listener using this symbol does not change the behavior once an +'error' event is emitted, therefore the process will still crash if no +regular 'error' listener is installed.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

    +
    +

    Returns Promise<void>

    +
    +

    Since

    v18.18.0

    +
+
+ +
    + +
  • +

    Returns AsyncIterableIterator<any>

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      error: Error
    • +
    • +
      event: string
    • +
    • +
      Rest ...args: any[]
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      error: null | Error
    • +
    • +
      callback: ((error) => void)
      +
        +
      • +
          +
        • (error): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      callback: TransformCallback
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      size: number
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: unknown
    • +
    • +
      encoding: BufferEncoding
    • +
    • +
      callback: TransformCallback
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
    • +
    • +
      encoding: BufferEncoding
    • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +

    Event emitter +The defined events on documents including:

    +
      +
    1. close
    2. +
    3. data
    4. +
    5. drain
    6. +
    7. end
    8. +
    9. error
    10. +
    11. finish
    12. +
    13. pause
    14. +
    15. pipe
    16. +
    17. readable
    18. +
    19. resume
    20. +
    21. unpipe
    22. +
    +
    +
    +

    Parameters

    +
      +
    • +
      event: "close"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

    +
  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
    • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
    • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
    • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+ +
    + +
  • +

    This method returns a new stream with chunks of the underlying stream paired with a counter +in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Readable

    a stream of indexed pairs.

    + +
    +

    Since

    v17.5.0

    +
+
+ +
+
+ +
    + +
  • +

    Stop piping the source stream and close everything once the slice is finished.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ReadableStream

    +
    +

    Parameters

    +
      +
    • +
      stream: ComposeFnParam | T | Iterable<T> | AsyncIterable<T>
    • +
    • +
      Optional options: {
          signal: AbortSignal;
      }
      +
        +
      • +
        signal: AbortSignal
    +

    Returns T

+
+ +
    + +
  • +

    Returns void

+
+ +
    + +
  • +

    Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable +stream will release any internal resources and subsequent calls to push()will be ignored.

    +

    Once destroy() has been called any further calls will be a no-op and no +further errors except from _destroy() may be emitted as 'error'.

    +

    Implementors should not override this method, but instead implement readable._destroy().

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional error: Error
      +

      Error which will be passed as payload in 'error' event

      +
      +
    +

    Returns SliceStream

    +
    +

    Since

    v8.0.0

    +
+
+ +
    + +
  • +

    This method returns a new stream with the first limit chunks dropped from the start.

    +
    +
    +

    Parameters

    +
      +
    • +
      limit: number
      +

      the number of chunks to drop from the readable.

      +
      +
    • +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Readable

    a stream with limit chunks dropped from the start.

    + +
    +

    Since

    v17.5.0

    +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
    • +
    • +
      chunk: any
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
    • +
    • +
      err: Error
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
    • +
    • +
      src: Readable
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
    • +
    • +
      src: Readable
    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
    • +
    • +
      Rest ...args: any[]
    +

    Returns boolean

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional cb: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
    • +
    • +
      Optional cb: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
    • +
    • +
      Optional encoding: BufferEncoding
    • +
    • +
      Optional cb: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

+
+ +
    + +
  • +

    Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or Symbols.

    +
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ] +
    +
    +

    Returns (string | symbol)[]

    +
    +

    Since

    v6.0.0

    +
+
+ +
    + +
  • +

    This method is similar to Array.prototype.every and calls fn on each chunk in the stream +to check if all awaited return values are truthy value for fn. Once an fn call on a chunk +awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. +If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => boolean | Promise<boolean>)
      +

      a function to call on each chunk of the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): boolean | Promise<boolean>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
          • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns boolean | Promise<boolean>

    • +
    • +
      Optional options: ArrayOptions
    +

    Returns Promise<boolean>

    a promise evaluating to true if fn returned a truthy value for every one of the chunks.

    + +
    +

    Since

    v17.5.0

    +
+
+ +
    + +
  • +

    This method allows filtering the stream. For each chunk in the stream the fn function will be called +and if it returns a truthy value, the chunk will be passed to the result stream. +If the fn function returns a promise - that promise will be awaited.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => boolean | Promise<boolean>)
      +

      a function to filter chunks from the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): boolean | Promise<boolean>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
          • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns boolean | Promise<boolean>

    • +
    • +
      Optional options: ArrayOptions
    +

    Returns Readable

    a stream filtered with the predicate fn.

    + +
    +

    Since

    v17.4.0, v16.14.0

    +
+
+ +
    + +
  • +

    This method is similar to Array.prototype.find and calls fn on each chunk in the stream +to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, +the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. +If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => data is T)
      +

      a function to call on each chunk of the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): data is T
        • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
          • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns data is T

    • +
    • +
      Optional options: ArrayOptions
    +

    Returns Promise<undefined | T>

    a promise evaluating to the first chunk for which fn evaluated with a truthy value, +or undefined if no element was found.

    + +
    +

    Since

    v17.5.0

    +
  • + +
  • +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => boolean | Promise<boolean>)
      +
        +
      • +
          +
        • (data, options?): boolean | Promise<boolean>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
          • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns boolean | Promise<boolean>

    • +
    • +
      Optional options: ArrayOptions
    +

    Returns Promise<any>

+
+ +
    + +
  • +

    This method returns a new stream by applying the given callback to each chunk of the stream +and then flattening the result.

    +

    It is possible to return a stream or another iterable or async iterable from fn and the result streams +will be merged (flattened) into the returned stream.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => any)
      +

      a function to map over every chunk in the stream. May be async. May be a stream or generator.

      +
      +
      +
        +
      • +
          +
        • (data, options?): any
        • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
          • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns any

    • +
    • +
      Optional options: ArrayOptions
    +

    Returns Readable

    a stream flat-mapped with the function fn.

    + +
    +

    Since

    v17.5.0

    +
+
+ +
    + +
  • +

    This method allows iterating a stream. For each chunk in the stream the fn function will be called. +If the fn function returns a promise - that promise will be awaited.

    +

    This method is different from for await...of loops in that it can optionally process chunks concurrently. +In addition, a forEach iteration can only be stopped by having passed a signal option +and aborting the related AbortController while for await...of can be stopped with break or return. +In either case the stream will be destroyed.

    +

    This method is different from listening to the 'data' event in that it uses the readable event +in the underlying machinary and can limit the number of concurrent fn calls.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => void | Promise<void>)
      +

      a function to call on each chunk of the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): void | Promise<void>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
          • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns void | Promise<void>

    • +
    • +
      Optional options: ArrayOptions
    +

    Returns Promise<void>

    a promise for when the stream has finished.

    + +
    +

    Since

    v17.5.0

    +
+
+ +
    + +
  • +

    Returns the current max listener value for the EventEmitter which is either +set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    +
    +

    Returns number

    +
    +

    Since

    v1.0.0

    +
+
+ +
    + +
  • +

    The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most +typical cases, there will be no reason to +use this method directly.

    +
    const readable = new stream.Readable();

    readable.isPaused(); // === false
    readable.pause();
    readable.isPaused(); // === true
    readable.resume();
    readable.isPaused(); // === false +
    +
    +

    Returns boolean

    +
    +

    Since

    v0.11.14

    +
+
+ +
    + +
  • +

    The iterator created by this method gives users the option to cancel the destruction +of the stream if the for await...of loop is exited by return, break, or throw, +or if the iterator should destroy the stream if the stream emitted an error during iteration.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional options: {
          destroyOnReturn?: boolean;
      }
      +
        +
      • +
        Optional destroyOnReturn?: boolean
        +

        When set to false, calling return on the async iterator, +or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. +Default: true.

        +
        +
    +

    Returns AsyncIterableIterator<any>

    +
    +

    Since

    v16.3.0

    +
+
+ +
    + +
  • +

    Returns the number of listeners listening to the event named eventName.

    +

    If listener is provided, it will return how many times the listener +is found in the list of the listeners of the event.

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +

      The name of the event being listened for

      +
      +
    • +
    • +
      Optional listener: Function
      +

      The event handler function

      +
      +
    +

    Returns number

    +
    +

    Since

    v3.2.0

    +
+
+ +
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName.

    +
    server.on('connection', (stream) => {
    console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ] +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
    +

    Returns Function[]

    +
    +

    Since

    v0.1.26

    +
+
+ +
    + +
  • +

    This method allows mapping over the stream. The fn function will be called for every chunk in the stream. +If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => any)
      +

      a function to map over every chunk in the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): any
        • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
          • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns any

    • +
    • +
      Optional options: ArrayOptions
    +

    Returns Readable

    a stream mapped with the function fn.

    + +
    +

    Since

    v17.4.0, v16.14.0

    +
+
+ +
+
+ +
    + +
  • +

    Alias for emitter.removeListener().

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
    • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

    +
    +

    Since

    v10.0.0

    +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
    • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
    • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
    • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
    • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
    • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
    • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+ +
    + +
  • +

    The readable.pause() method will cause a stream in flowing mode to stop +emitting 'data' events, switching out of flowing mode. Any data that +becomes available will remain in the internal buffer.

    +
    const readable = getReadableStreamSomehow();
    readable.on('data', (chunk) => {
    console.log(`Received ${chunk.length} bytes of data.`);
    readable.pause();
    console.log('There will be no additional data for 1 second.');
    setTimeout(() => {
    console.log('Now data will start flowing again.');
    readable.resume();
    }, 1000);
    }); +
    +

    The readable.pause() method has no effect if there is a 'readable'event listener.

    +
    +

    Returns SliceStream

    +
    +

    Since

    v0.9.4

    +
+
+ +
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends WritableStream

    +
    +

    Parameters

    +
      +
    • +
      destination: T
    • +
    • +
      Optional options: {
          end?: boolean;
      }
      +
        +
      • +
        Optional end?: boolean
    +

    Returns T

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
    • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
    • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
    • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
    • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
    • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
    • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
    • +
    • +
      Optional encoding: BufferEncoding
    +

    Returns boolean

+
+ +
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName, +including any wrappers (such as those created by .once()).

    +
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log'); +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
    +

    Returns Function[]

    +
    +

    Since

    v9.4.0

    +
+
+ +
    + +
  • +

    The readable.read() method reads data out of the internal buffer and +returns it. If no data is available to be read, null is returned. By default, +the data is returned as a Buffer object unless an encoding has been +specified using the readable.setEncoding() method or the stream is operating +in object mode.

    +

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which +case all of the data remaining in the internal +buffer will be returned.

    +

    If the size argument is not specified, all of the data contained in the +internal buffer will be returned.

    +

    The size argument must be less than or equal to 1 GiB.

    +

    The readable.read() method should only be called on Readable streams +operating in paused mode. In flowing mode, readable.read() is called +automatically until the internal buffer is fully drained.

    +
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
    let chunk;
    console.log('Stream is readable (new data received in buffer)');
    // Use a loop to make sure we read all currently available data
    while (null !== (chunk = readable.read())) {
    console.log(`Read ${chunk.length} bytes of data...`);
    }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
    console.log('Reached end of stream.');
    }); +
    +

    Each call to readable.read() returns a chunk of data, or null. The chunks +are not concatenated. A while loop is necessary to consume all data +currently in the buffer. When reading a large file .read() may return null, +having consumed all buffered content so far, but there is still more data to +come not yet buffered. In this case a new 'readable' event will be emitted +when there is more data in the buffer. Finally the 'end' event will be +emitted when there is no more data to come.

    +

    Therefore to read a file's whole contents from a readable, it is necessary +to collect chunks across multiple 'readable' events:

    +
    const chunks = [];

    readable.on('readable', () => {
    let chunk;
    while (null !== (chunk = readable.read())) {
    chunks.push(chunk);
    }
    });

    readable.on('end', () => {
    const content = chunks.join('');
    }); +
    +

    A Readable stream in object mode will always return a single item from +a call to readable.read(size), regardless of the value of thesize argument.

    +

    If the readable.read() method returns a chunk of data, a 'data' event will +also be emitted.

    +

    Calling read after the 'end' event has +been emitted will return null. No runtime error will be raised.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional size: number
      +

      Optional argument to specify how much data to read.

      +
      +
    +

    Returns any

    +
    +

    Since

    v0.9.4

    +
+
+ +
    + +
  • +

    This method calls fn on each chunk of the stream in order, passing it the result from the calculation +on the previous element. It returns a promise for the final value of the reduction.

    +

    If no initial value is supplied the first chunk of the stream is used as the initial value. +If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

    +

    The reducer function iterates the stream element-by-element which means that there is no concurrency parameter +or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = any

    +
    +

    Parameters

    +
      +
    • +
      fn: ((previous, data, options?) => T)
      +

      a reducer function to call over every chunk in the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (previous, data, options?): T
        • +
        • +
          +

          Parameters

          +
            +
          • +
            previous: any
          • +
          • +
            data: any
          • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns T

    • +
    • +
      Optional initial: undefined
      +

      the initial value to use in the reduction.

      +
      +
    • +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Promise<T>

    a promise for the final value of the reduction.

    + +
    +

    Since

    v17.5.0

    +
  • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T = any

    +
    +

    Parameters

    +
      +
    • +
      fn: ((previous, data, options?) => T)
      +
        +
      • +
          +
        • (previous, data, options?): T
        • +
        • +
          +

          Parameters

          +
            +
          • +
            previous: T
          • +
          • +
            data: any
          • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns T

    • +
    • +
      initial: T
    • +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Promise<T>

+
+ +
    + +
  • +

    Removes all listeners, or those of the specified eventName.

    +

    It is bad practice to remove listeners added elsewhere in the code, +particularly when the EventEmitter instance was created by some other +component or module (e.g. sockets or file streams).

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional event: string | symbol
    +

    Returns SliceStream

    +
    +

    Since

    v0.1.26

    +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
    • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
    • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
    • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
        • +
        • +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
    • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
    • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+ +
    + +
  • +

    The readable.resume() method causes an explicitly paused Readable stream to +resume emitting 'data' events, switching the stream into flowing mode.

    +

    The readable.resume() method can be used to fully consume the data from a +stream without actually processing any of that data:

    +
    getReadableStreamSomehow()
    .resume()
    .on('end', () => {
    console.log('Reached the end, but did not read anything.');
    }); +
    +

    The readable.resume() method has no effect if there is a 'readable'event listener.

    +
    +

    Returns SliceStream

    +
    +

    Since

    v0.9.4

    +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      encoding: BufferEncoding
    +

    Returns SliceStream

+
+ +
    + +
  • +

    The readable.setEncoding() method sets the character encoding for +data read from the Readable stream.

    +

    By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data +to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the +output data to be interpreted as UTF-8 data, and passed as strings. Callingreadable.setEncoding('hex') will cause the data to be encoded in hexadecimal +string format.

    +

    The Readable stream will properly handle multi-byte characters delivered +through the stream that would otherwise become improperly decoded if simply +pulled from the stream as Buffer objects.

    +
    const readable = getReadableStreamSomehow();
    readable.setEncoding('utf8');
    readable.on('data', (chunk) => {
    assert.equal(typeof chunk, 'string');
    console.log('Got %d characters of string data:', chunk.length);
    }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      encoding: BufferEncoding
      +

      The encoding to use.

      +
      +
    +

    Returns SliceStream

    +
    +

    Since

    v0.9.4

    +
+
+ +
    + +
  • +

    By default EventEmitters will print a warning if more than 10 listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The emitter.setMaxListeners() method allows the limit to be +modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
    +

    Returns SliceStream

    +
    +

    Since

    v0.3.5

    +
+
+ +
    + +
  • +

    This method is similar to Array.prototype.some and calls fn on each chunk in the stream +until the awaited return value is true (or any truthy value). Once an fn call on a chunk +awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. +If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => boolean | Promise<boolean>)
      +

      a function to call on each chunk of the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): boolean | Promise<boolean>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
          • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns boolean | Promise<boolean>

    • +
    • +
      Optional options: ArrayOptions
    +

    Returns Promise<boolean>

    a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

    + +
    +

    Since

    v17.5.0

    +
+
+ +
    + +
  • +

    This method returns a new stream with the first limit chunks.

    +
    +
    +

    Parameters

    +
      +
    • +
      limit: number
      +

      the number of chunks to take from the readable.

      +
      +
    • +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Readable

    a stream with limit chunks taken.

    + +
    +

    Since

    v17.5.0

    +
+
+ +
    + +
  • +

    This method allows easily obtaining the contents of a stream.

    +

    As this method reads the entire stream into memory, it negates the benefits of streams. It's intended +for interoperability and convenience, not as the primary way to consume streams.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Promise<any[]>

    a promise containing an array with the contents of the stream.

    + +
    +

    Since

    v17.5.0

    +
+
+ +
    + +
  • +

    Returns void

+
+ +
    + +
  • +

    The readable.unpipe() method detaches a Writable stream previously attached +using the pipe method.

    +

    If the destination is not specified, then all pipes are detached.

    +

    If the destination is specified, but no pipe is set up for it, then +the method does nothing.

    +
    const fs = require('fs');
    const readable = getReadableStreamSomehow();
    const writable = fs.createWriteStream('file.txt');
    // All the data from readable goes into 'file.txt',
    // but only for the first second.
    readable.pipe(writable);
    setTimeout(() => {
    console.log('Stop writing to file.txt.');
    readable.unpipe(writable);
    console.log('Manually close the file stream.');
    writable.end();
    }, 1000); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional destination: WritableStream
      +

      Optional specific stream to unpipe

      +
      +
    +

    Returns SliceStream

    +
    +

    Since

    v0.9.4

    +
+
+ +
    + +
  • +

    Passing chunk as null signals the end of the stream (EOF) and behaves the +same as readable.push(null), after which no more data can be written. The EOF +signal is put at the end of the buffer and any buffered data will still be +flushed.

    +

    The readable.unshift() method pushes a chunk of data back into the internal +buffer. This is useful in certain situations where a stream is being consumed by +code that needs to "un-consume" some amount of data that it has optimistically +pulled out of the source, so that the data can be passed on to some other party.

    +

    The stream.unshift(chunk) method cannot be called after the 'end' event +has been emitted or a runtime error will be thrown.

    +

    Developers using stream.unshift() often should consider switching to +use of a Transform stream instead. See the API for stream implementers section for more information.

    +
    // Pull off a header delimited by \n\n.
    // Use unshift() if we get too much.
    // Call the callback with (error, header, stream).
    const { StringDecoder } = require('string_decoder');
    function parseHeader(stream, callback) {
    stream.on('error', callback);
    stream.on('readable', onReadable);
    const decoder = new StringDecoder('utf8');
    let header = '';
    function onReadable() {
    let chunk;
    while (null !== (chunk = stream.read())) {
    const str = decoder.write(chunk);
    if (str.includes('\n\n')) {
    // Found the header boundary.
    const split = str.split(/\n\n/);
    header += split.shift();
    const remaining = split.join('\n\n');
    const buf = Buffer.from(remaining, 'utf8');
    stream.removeListener('error', callback);
    // Remove the 'readable' listener before unshifting.
    stream.removeListener('readable', onReadable);
    if (buf.length)
    stream.unshift(buf);
    // Now the body of the message can be read from the stream.
    callback(null, header, stream);
    return;
    }
    // Still reading the header.
    header += str;
    }
    }
    } +
    +

    Unlike push, stream.unshift(chunk) will not +end the reading process by resetting the internal reading state of the stream. +This can cause unexpected results if readable.unshift() is called during a +read (i.e. from within a _read implementation on a +custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, +however it is best to simply avoid calling readable.unshift() while in the +process of performing a read.

    +
    +
    +

    Parameters

    +
      +
    • +
      chunk: any
      +

      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array or null. For object mode +streams, chunk may be any JavaScript value.

      +
      +
    • +
    • +
      Optional encoding: BufferEncoding
      +

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      +
      +
    +

    Returns void

    +
    +

    Since

    v0.9.11

    +
+
+ +
    + +
  • +

    Prior to Node.js 0.10, streams did not implement the entire stream module API +as it is currently defined. (See Compatibility for more information.)

    +

    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable +stream that uses +the old stream as its data source.

    +

    It will rarely be necessary to use readable.wrap() but the method has been +provided as a convenience for interacting with older Node.js applications and +libraries.

    +
    const { OldReader } = require('./old-api-module.js');
    const { Readable } = require('stream');
    const oreader = new OldReader();
    const myReader = new Readable().wrap(oreader);

    myReader.on('readable', () => {
    myReader.read(); // etc.
    }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      stream: ReadableStream
      +

      An "old style" readable stream

      +
      +
    +

    Returns SliceStream

    +
    +

    Since

    v0.9.4

    +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
    • +
    • +
      Optional encoding: BufferEncoding
    • +
    • +
      Optional cb: ((error) => void)
      +
        +
      • +
          +
        • (error): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            error: undefined | null | Error
          +

          Returns void

    +

    Returns boolean

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
    • +
    • +
      Optional cb: ((error) => void)
      +
        +
      • +
          +
        • (error): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            error: undefined | null | Error
          +

          Returns void

    +

    Returns boolean

+
+ +
    + +
  • Experimental +

    Listens once to the abort event on the provided signal.

    +

    Listening to the abort event on abort signals is unsafe and may +lead to resource leaks since another third party with the signal can +call e.stopImmediatePropagation(). Unfortunately Node.js cannot change +this since it would violate the web standard. Additionally, the original +API makes it easy to forget to remove listeners.

    +

    This API allows safely using AbortSignals in Node.js APIs by solving these +two issues by listening to the event such that stopImmediatePropagation does +not prevent the listener from running.

    +

    Returns a disposable so that it may be unsubscribed from more easily.

    +
    import { addAbortListener } from 'node:events';

    function example(signal) {
    let disposable;
    try {
    signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
    disposable = addAbortListener(signal, (e) => {
    // Do something when signal is aborted.
    });
    } finally {
    disposable?.[Symbol.dispose]();
    }
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      signal: AbortSignal
    • +
    • +
      resource: ((event) => void)
      +
        +
      • +
          +
        • (event): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            event: Event
          +

          Returns void

    +

    Returns Disposable

    Disposable that removes the abort listener.

    + +
    +

    Since

    v18.18.0

    +
+
+ +
    + +
  • +

    A utility method for creating duplex streams.

    +
      +
    • Stream converts writable stream into writable Duplex and readable stream +to Duplex.
    • +
    • Blob converts into readable Duplex.
    • +
    • string converts into readable Duplex.
    • +
    • ArrayBuffer converts into readable Duplex.
    • +
    • AsyncIterable converts into a readable Duplex. Cannot yield null.
    • +
    • AsyncGeneratorFunction converts into a readable/writable transform +Duplex. Must take a source AsyncIterable as first parameter. Cannot yield +null.
    • +
    • AsyncFunction converts into a writable Duplex. Must return +either null or undefined
    • +
    • Object ({ writable, readable }) converts readable and +writable into Stream and then combines them into Duplex where the +Duplex will write to the writable and read from the readable.
    • +
    • Promise converts into readable Duplex. Value null is ignored.
    • +
    +
    +
    +

    Parameters

    +
      +
    • +
      src: string | Object | Stream | Promise<any> | Iterable<any> | AsyncIterable<any> | ArrayBuffer | Blob | AsyncGeneratorFunction
    +

    Returns Duplex

    +
    +

    Since

    v16.8.0

    +
+
+ +
    + +
  • Experimental +

    A utility method for creating a Readable from a web ReadableStream.

    +
    +
    +

    Parameters

    +
      +
    • +
      readableStream: ReadableStream<any>
    • +
    • +
      Optional options: Pick<ReadableOptions, "encoding" | "highWaterMark" | "objectMode" | "signal">
    +

    Returns Readable

    +
    +

    Since

    v17.0.0

    +
+
+ +
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName.

    +

    For EventEmitters this behaves exactly the same as calling .listeners on +the emitter.

    +

    For EventTargets this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes.

    +
    const { getEventListeners, EventEmitter } = require('events');

    {
    const ee = new EventEmitter();
    const listener = () => console.log('Events are fun');
    ee.on('foo', listener);
    getEventListeners(ee, 'foo'); // [listener]
    }
    {
    const et = new EventTarget();
    const listener = () => console.log('Events are fun');
    et.addEventListener('foo', listener);
    getEventListeners(et, 'foo'); // [listener]
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter | _DOMEventTarget
    • +
    • +
      name: string | symbol
    +

    Returns Function[]

    +
    +

    Since

    v15.2.0, v14.17.0

    +
+
+ +
    + +
  • +

    Returns the currently set max amount of listeners.

    +

    For EventEmitters this behaves exactly the same as calling .getMaxListeners on +the emitter.

    +

    For EventTargets this is the only way to get the max event listeners for the +event target. If the number of event handlers on a single EventTarget exceeds +the max set, the EventTarget will print a warning.

    +
    import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

    {
    const ee = new EventEmitter();
    console.log(getMaxListeners(ee)); // 10
    setMaxListeners(11, ee);
    console.log(getMaxListeners(ee)); // 11
    }
    {
    const et = new EventTarget();
    console.log(getMaxListeners(et)); // 10
    setMaxListeners(11, et);
    console.log(getMaxListeners(et)); // 11
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter | _DOMEventTarget
    +

    Returns number

    +
    +

    Since

    v18.17.0

    +
+
+ +
    + +
  • +

    Returns whether the stream has been read from or cancelled.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable | ReadableStream
    +

    Returns boolean

    +
    +

    Since

    v16.8.0

    +
+
+ +
    + +
  • +

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    +
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2 +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      +

      The emitter to query

      +
      +
    • +
    • +
      eventName: string | symbol
      +

      The event name

      +
      +
    +

    Returns number

    +
    +

    Since

    v0.9.12

    + +

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    +
+
+ +
    + +
  • +
    const { on, EventEmitter } = require('events');

    (async () => {
    const ee = new EventEmitter();

    // Emit later on
    process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
    });

    for await (const event of on(ee, 'foo')) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
    }
    // Unreachable here
    })(); +
    +

    Returns an AsyncIterator that iterates eventName events. It will throw +if the EventEmitter emits 'error'. It removes all listeners when +exiting the loop. The value returned by each iteration is an array +composed of the emitted event arguments.

    +

    An AbortSignal can be used to cancel waiting on events:

    +
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
    const ee = new EventEmitter();

    // Emit later on
    process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
    });

    for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
    }
    // Unreachable here
    })();

    process.nextTick(() => ac.abort()); +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
    • +
    • +
      eventName: string
      +

      The name of the event being listened for

      +
      +
    • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    + +
    +

    Since

    v13.6.0, v12.16.0

    +
+
+ +
    + +
  • +

    Creates a Promise that is fulfilled when the EventEmitter emits the given +event or that is rejected if the EventEmitter emits 'error' while waiting. +The Promise will resolve with an array of all the arguments emitted to the +given event.

    +

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event +semantics and does not listen to the 'error' event.

    +
    const { once, EventEmitter } = require('events');

    async function run() {
    const ee = new EventEmitter();

    process.nextTick(() => {
    ee.emit('myevent', 42);
    });

    const [value] = await once(ee, 'myevent');
    console.log(value);

    const err = new Error('kaboom');
    process.nextTick(() => {
    ee.emit('error', err);
    });

    try {
    await once(ee, 'myevent');
    } catch (err) {
    console.log('error happened', err);
    }
    }

    run(); +
    +

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the +'error' event itself, then it is treated as any other kind of event without +special handling:

    +
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
    .then(([err]) => console.log('ok', err.message))
    .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom +
    +

    An AbortSignal can be used to cancel waiting for the event:

    +
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
    try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
    } catch (error) {
    if (error.name === 'AbortError') {
    console.error('Waiting for the event was canceled!');
    } else {
    console.error('There was an error', error.message);
    }
    }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled! +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: _NodeEventTarget
    • +
    • +
      eventName: string | symbol
    • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns Promise<any[]>

    +
    +

    Since

    v11.13.0, v10.16.0

    +
  • + +
  • +
    +

    Parameters

    +
      +
    • +
      emitter: _DOMEventTarget
    • +
    • +
      eventName: string
    • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns Promise<any[]>

+
+ +
    + +
  • +
    const {
    setMaxListeners,
    EventEmitter
    } = require('events');

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional n: number
      +

      A non-negative number. The maximum number of listeners per EventTarget event.

      +
      +
    • +
    • +
      Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]
    +

    Returns void

    +
    +

    Since

    v15.4.0

    +
+
+ +
    + +
  • Experimental +

    A utility method for creating a web ReadableStream from a Readable.

    +
    +
    +

    Parameters

    +
      +
    • +
      streamReadable: Readable
    +

    Returns ReadableStream<any>

    +
    +

    Since

    v17.0.0

    +
+
+ +
+
\ No newline at end of file diff --git a/7.x/docs/classes/SlugParser.html b/7.x/docs/classes/SlugParser.html new file mode 100644 index 000000000..2a716aac3 --- /dev/null +++ b/7.x/docs/classes/SlugParser.html @@ -0,0 +1,198 @@ +SlugParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SlugParser

+
+

Converts the contents of the slug header to metadata.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SparqlDataAccessor.html b/7.x/docs/classes/SparqlDataAccessor.html new file mode 100644 index 000000000..04a18defd --- /dev/null +++ b/7.x/docs/classes/SparqlDataAccessor.html @@ -0,0 +1,607 @@ +SparqlDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SparqlDataAccessor

+
+

Stores all data and metadata of resources in a SPARQL backend. +Communication is done by sending SPARQL queries. +Queries are constructed in such a way to keep everything consistent, +such as updating containment triples and deleting old data when it is overwritten.

+

Since metadata is hidden, no containment triples are stored for metadata files.

+

All input container metadata is stored in its metadata identifier. +The containment triples are stored in the graph corresponding to the actual identifier +so those don't get overwritten.

+
+
+
+

Hierarchy

+
    +
  • SparqlDataAccessor
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
endpoint: string
+
+ +
fetcher: SparqlEndpointFetcher
+
+ +
generator: SparqlGenerator
+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Creates the name for the metadata of a resource.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of the (non-metadata) resource.

      +
      +
    +

    Returns NamedNode<string>

    +
+
+ +
    + +
  • +

    Helper function to get named nodes corresponding to the identifier and its parent container. +In case of a root container only the name will be returned.

    +
    +
    +

    Parameters

    +
    +

    Returns {
        name: NamedNode<string>;
        parent?: NamedNode<string>;
    }

    +
      +
    • +
      name: NamedNode<string>
    • +
    • +
      Optional parent?: NamedNode<string>
    +
+
+ +
+
+ +
    + +
  • +

    Sends a SPARQL CONSTRUCT query to the endpoint and returns a stream of quads.

    +
    +
    +

    Parameters

    +
      +
    • +
      sparqlQuery: ConstructQuery
      +

      Query to execute.

      +
      +
    +

    Returns Promise<Guarded<Readable>>

    +
+
+ +
    + +
  • +

    Sends a SPARQL update query to the stored endpoint.

    +
    +
    +

    Parameters

    +
      +
    • +
      sparqlQuery: Update
      +

      Query to send.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Creates a CONSTRUCT query that returns all quads contained within a single resource.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of the resource to query.

      +
      +
    +

    Returns ConstructQuery

    +
+
+ +
    + +
  • +

    Creates a query that deletes everything related to the given name.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of resource to delete.

      +
      +
    • +
    • +
      Optional parent: NamedNode<string>
      +

      Parent of the resource to delete so the containment triple can be removed (unless root).

      +
      +
    +

    Returns Update

    +
+
+ +
    + +
  • +

    Creates an update query that overwrites the data and metadata of a resource. +If there are no triples we assume it's a container (so don't overwrite the main graph with containment triples).

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of the resource to update.

      +
      +
    • +
    • +
      metadata: RepresentationMetadata
      +

      New metadata of the resource.

      +
      +
    • +
    • +
      Optional parent: NamedNode<string>
      +

      Name of the parent to update the containment triples.

      +
      +
    • +
    • +
      Optional triples: Quad[]
      +

      New data of the resource.

      +
      +
    +

    Returns Update

    +
+
+ +
    + +
  • +

    Creates an update query that overwrites metadata of a resource.

    +
    +
    +

    Parameters

    +
      +
    • +
      metaName: NamedNode<string>
      +

      Name of the metadata resource to update.

      +
      +
    • +
    • +
      metadata: RepresentationMetadata
      +

      New metadata of the resource.

      +
      +
    +

    Returns Update

    +
+
+ +
+
+ +
    + +
  • +

    Helper function for creating SPARQL update queries. +Creates an operation for deleting all triples in a graph.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of the graph to delete.

      +
      +
    +

    Returns InsertDeleteOperation

    +
+
+ +
    + +
  • +

    Helper function for creating SPARQL update queries. +Creates a Graph selector with the given triples.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of the graph.

      +
      +
    • +
    • +
      triples: Quad[]
      +

      Triples/triple patterns to select.

      +
      +
    +

    Returns GraphQuads

    +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SparqlUpdateBodyParser.html b/7.x/docs/classes/SparqlUpdateBodyParser.html new file mode 100644 index 000000000..c49d7885b --- /dev/null +++ b/7.x/docs/classes/SparqlUpdateBodyParser.html @@ -0,0 +1,184 @@ +SparqlUpdateBodyParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SparqlUpdateBodyParser

+
+

BodyParser that supports application/sparql-update content. +Will convert the incoming update string to algebra in a SparqlUpdatePatch.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: BodyParserArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SparqlUpdateModesExtractor.html b/7.x/docs/classes/SparqlUpdateModesExtractor.html new file mode 100644 index 000000000..e17fea55b --- /dev/null +++ b/7.x/docs/classes/SparqlUpdateModesExtractor.html @@ -0,0 +1,304 @@ +SparqlUpdateModesExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SparqlUpdateModesExtractor

+
+

Generates permissions for a SPARQL DELETE/INSERT body. +Updates with only an INSERT can be done with just append permissions, +while DELETEs require write permissions as well.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
resourceSet: ResourceSet
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SparqlUpdatePatcher.html b/7.x/docs/classes/SparqlUpdatePatcher.html new file mode 100644 index 000000000..0dc866b81 --- /dev/null +++ b/7.x/docs/classes/SparqlUpdatePatcher.html @@ -0,0 +1,311 @@ +SparqlUpdatePatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SparqlUpdatePatcher

+
+

Supports application/sparql-update PATCH requests on RDF resources.

+

Only DELETE/INSERT updates without variables are supported.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
engine: QueryEngine<IQueryContextCommon>
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Checks if the composite update only contains supported update components.

    +
    +
    +

    Parameters

    +
      +
    • +
      op: CompositeUpdate
    +

    Returns void

    +
+
+ +
    + +
  • +

    Checks if the input DELETE/INSERT is supported. +This means: no GRAPH statements, no DELETE WHERE containing terms of type Variable.

    +
    +
    +

    Parameters

    +
      +
    • +
      op: DeleteInsert
    +

    Returns void

    +
+
+ +
    + +
  • +

    Checks if the input operation is of a supported type (DELETE/INSERT or composite of those)

    +
    +
    +

    Parameters

    +
      +
    • +
      op: Operation
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StateHandler.html b/7.x/docs/classes/StateHandler.html new file mode 100644 index 000000000..2ec51d88f --- /dev/null +++ b/7.x/docs/classes/StateHandler.html @@ -0,0 +1,185 @@ +StateHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StateHandlerAbstract

+
+

Handles the state feature of notifications. +Every implementation of a specific notification channel type should make sure an instance of this class +gets called when a state notification can be sent out.

+

Implementations of this class should handle all channels and filter out those that need a state notification.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StateNotificationGenerator.html b/7.x/docs/classes/StateNotificationGenerator.html new file mode 100644 index 000000000..635773bf5 --- /dev/null +++ b/7.x/docs/classes/StateNotificationGenerator.html @@ -0,0 +1,200 @@ +StateNotificationGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StateNotificationGenerator

+
+

Determines the most relevant activity for a Notification in case none was provided. +This is relevant for the state feature where a notification channel needs to know the current state of a resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
resourceSet: ResourceSet
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticAssetEntry.html b/7.x/docs/classes/StaticAssetEntry.html new file mode 100644 index 000000000..d11397859 --- /dev/null +++ b/7.x/docs/classes/StaticAssetEntry.html @@ -0,0 +1,119 @@ +StaticAssetEntry | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticAssetEntry

+
+

Used to link file paths with relative URLs. +By using a separate class instead of a key/value map it is easier to replace values in Components.js.

+
+
+
+

Hierarchy

+
    +
  • StaticAssetEntry
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
filePath: string
+
+ +
relativeUrl: string
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticAssetHandler.html b/7.x/docs/classes/StaticAssetHandler.html new file mode 100644 index 000000000..02fc597e9 --- /dev/null +++ b/7.x/docs/classes/StaticAssetHandler.html @@ -0,0 +1,283 @@ +StaticAssetHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticAssetHandler

+
+

Handler that serves static resources on specific paths. +Relative file paths are assumed to be relative to the current working directory. +Relative file paths can be preceded by @css:, e.g. @css:foo/bar, +in case they need to be relative to the module root. +File paths ending in a slash assume the target is a folder and map all of its contents.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
expires: number
+
+ +
logger: Logger = ...
+
+ +
mappings: Record<string, string>
+
+ +
pathMatcher: RegExp
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: HttpHandlerInput
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticFolderGenerator.html b/7.x/docs/classes/StaticFolderGenerator.html new file mode 100644 index 000000000..610db917a --- /dev/null +++ b/7.x/docs/classes/StaticFolderGenerator.html @@ -0,0 +1,156 @@ +StaticFolderGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticFolderGenerator

+
+

Stores a static template folder that will be used to call the wrapped TemplatedResourcesGenerator.

+
+
+
+

Hierarchy

+
    +
  • StaticFolderGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
resourcesGenerator: TemplatedResourcesGenerator
+
+ +
templateFolder: string
+
+

Methods

+
+ +
    + +
  • +

    Generates resources with the given options. +The output Iterable should be sorted so that containers always appear before their contents.

    +
    +
    +

    Parameters

    +
      +
    • +
      location: ResourceIdentifier
      +

      Base identifier.

      +
      +
    • +
    • +
      options: Dict<unknown>
      +

      Options that can be used when generating resources.

      +
      +
    +

    Returns AsyncIterable<Resource>

    A map where the keys are the identifiers and the values the corresponding representations to store.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticHandler.html b/7.x/docs/classes/StaticHandler.html new file mode 100644 index 000000000..4f451093a --- /dev/null +++ b/7.x/docs/classes/StaticHandler.html @@ -0,0 +1,196 @@ +StaticHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticHandler<T>

+
+

A handler that always resolves and always returns the stored value. +Will return undefined if no value is stored.

+

The generic type extends any due to Components.js requirements.

+
+
+
+

Type Parameters

+
    +
  • +

    T = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
value?: T
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<T>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticInteractionHandler.html b/7.x/docs/classes/StaticInteractionHandler.html new file mode 100644 index 000000000..2e9dd4d68 --- /dev/null +++ b/7.x/docs/classes/StaticInteractionHandler.html @@ -0,0 +1,185 @@ +StaticInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticInteractionHandler

+
+

An JsonInteractionHandler that always returns the same JSON response on all requests.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
response: Record<string, Json>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticStorageDescriber.html b/7.x/docs/classes/StaticStorageDescriber.html new file mode 100644 index 000000000..789560e0a --- /dev/null +++ b/7.x/docs/classes/StaticStorageDescriber.html @@ -0,0 +1,208 @@ +StaticStorageDescriber | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticStorageDescriber

+
+

Adds a fixed set of triples to the storage description resource, +with the resource identifier as subject.

+

This can be used to add descriptions that a storage always needs to have, +such as the <> a pim:Storage triple.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
terms: ReadonlyMap<NamedNode<string>, Quad_Object[]>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticTemplateEngine.html b/7.x/docs/classes/StaticTemplateEngine.html new file mode 100644 index 000000000..d728cf4a0 --- /dev/null +++ b/7.x/docs/classes/StaticTemplateEngine.html @@ -0,0 +1,218 @@ +StaticTemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticTemplateEngine<T>

+
+

Template engine that renders output based on a static template file.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
template: Template
+
+ +
templateEngine: AsyncHandler<TemplateEngineInput<T>, string>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticThrowHandler.html b/7.x/docs/classes/StaticThrowHandler.html new file mode 100644 index 000000000..3025065fa --- /dev/null +++ b/7.x/docs/classes/StaticThrowHandler.html @@ -0,0 +1,182 @@ +StaticThrowHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticThrowHandler

+
+

Utility handler that can handle all input and always throws the given error.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
error: HttpError<number>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<never>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StorageDescriber.html b/7.x/docs/classes/StorageDescriber.html new file mode 100644 index 000000000..a8c9f0698 --- /dev/null +++ b/7.x/docs/classes/StorageDescriber.html @@ -0,0 +1,174 @@ +StorageDescriber | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StorageDescriberAbstract

+
+

Generates Quads that need to be added to the given storage description resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StorageDescriptionAdvertiser.html b/7.x/docs/classes/StorageDescriptionAdvertiser.html new file mode 100644 index 000000000..0e1e7839d --- /dev/null +++ b/7.x/docs/classes/StorageDescriptionAdvertiser.html @@ -0,0 +1,208 @@ +StorageDescriptionAdvertiser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StorageDescriptionAdvertiser

+
+

Adds a link header pointing to the relevant storage description resource. +Recursively checks parent containers until a storage container is found, +and then appends the provided relative path to determine the storage description resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
relativePath: string
+
+ +
storageStrategy: StorageLocationStrategy
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StorageDescriptionHandler.html b/7.x/docs/classes/StorageDescriptionHandler.html new file mode 100644 index 000000000..be03f6ee4 --- /dev/null +++ b/7.x/docs/classes/StorageDescriptionHandler.html @@ -0,0 +1,228 @@ +StorageDescriptionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StorageDescriptionHandler

+
+

Generates the response for GET requests targeting a storage description resource. +The input path needs to match the relative path used to generate storage description resources +and will be used to verify if the container it is linked to is an actual storage.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
describer: StorageDescriber
+
+ +
path: string
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SubdomainExtensionBasedMapper.html b/7.x/docs/classes/SubdomainExtensionBasedMapper.html new file mode 100644 index 000000000..e8d00ce52 --- /dev/null +++ b/7.x/docs/classes/SubdomainExtensionBasedMapper.html @@ -0,0 +1,551 @@ +SubdomainExtensionBasedMapper | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SubdomainExtensionBasedMapper

+
+

Extends the functionality of an ExtensionBasedMapper to support identifiers containing subdomains. +This is mostly only relevant in case you want to support multiple pods with subdomain identifiers +in a single ResourceStore.

+

When converting to/from file paths, the subdomain is interpreted as a folder in the rootFilePath. +The rest of the path is then interpreted relative to that folder. +E.g. http://alice.test.com/foo results in the relative path /alice/foo.

+

In case there is no subdomain in the URL, the baseSubdomain parameter is used instead. +E.g., if the baseSubdomain is "www", http://test.com/foo would result in the relative path /www/foo. +This means that there is no identifier that maps to the rootFilePath itself. +To prevent the possibility of 2 identifiers linking to the same file, +identifiers containing the default subdomain are rejected. +E.g., http://www.test.com/foo would result in a 403, even if http://test.com/foo exists.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseParts: {
    rest: string;
    scheme: string;
}
+
+

Type declaration

+
    +
  • +
    rest: string
  • +
  • +
    scheme: string
+
+ +
baseRequestURI: string
+
+ +
baseSubdomain: string
+
+ +
logger: Logger = ...
+
+ +
regex: RegExp
+
+ +
rootFilepath: string
+
+ +
unknownMediaTypeExtension: "unknown" = 'unknown'
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Maps the given document identifier to a file path, +possibly making alterations to the direct translation +(for instance, based on its content type)). +Determines the content type if none was provided.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
    • +
    • +
      filePath: string
      +

      The direct translation of the identifier onto the file path.

      +
      +
    • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
    + +
  • +

    Maps the given resource identifier / URL to a file path. +Determines the content type if none was provided. +For containers the content-type input is ignored.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
    • +
    • +
      isMetadata: boolean
      +

      If we need the data or metadata file path.

      +
      +
    • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SubdomainIdentifierGenerator.html b/7.x/docs/classes/SubdomainIdentifierGenerator.html new file mode 100644 index 000000000..26e03c85c --- /dev/null +++ b/7.x/docs/classes/SubdomainIdentifierGenerator.html @@ -0,0 +1,167 @@ +SubdomainIdentifierGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SubdomainIdentifierGenerator

+
+

Generates identifiers by using the name as a subdomain on the base URL. +Non-alphanumeric characters will be replaced with -.

+

When extracting the pod, the base URl is also seen as a pod as there is no issue of nested containers here.

+
+
+
+

Hierarchy

+
    +
  • SubdomainIdentifierGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseParts: {
    rest: string;
    scheme: string;
}
+
+

Type declaration

+
    +
  • +
    rest: string
  • +
  • +
    scheme: string
+
+

Methods

+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SubdomainIdentifierStrategy.html b/7.x/docs/classes/SubdomainIdentifierStrategy.html new file mode 100644 index 000000000..b1e167989 --- /dev/null +++ b/7.x/docs/classes/SubdomainIdentifierStrategy.html @@ -0,0 +1,220 @@ +SubdomainIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SubdomainIdentifierStrategy

+
+

An IdentifierStrategy that interprets all subdomains of the given base URL as roots.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseUrl: string
+
+ +
logger: Logger = ...
+
+ +
regex: RegExp
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SubfolderResourcesGenerator.html b/7.x/docs/classes/SubfolderResourcesGenerator.html new file mode 100644 index 000000000..b3c9d8641 --- /dev/null +++ b/7.x/docs/classes/SubfolderResourcesGenerator.html @@ -0,0 +1,167 @@ +SubfolderResourcesGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SubfolderResourcesGenerator

+
+

Generates all resources found in specific subfolders of the given template folder. +In case the same resource is defined in several subfolders, +the data of the last subfolder in the list will be used.

+

The results of all the subfolders will be merged so the end result is still a sorted stream of identifiers.

+

One of the main use cases for this class is so template resources can be in a separate folder +than their corresponding authorization resources, +allowing for authorization-independent templates.

+
+
+
+

Hierarchy

+
    +
  • SubfolderResourcesGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
resourcesGenerator: TemplatedResourcesGenerator
+
+ +
subfolders: string[]
+
+

Methods

+
+ +
    + +
  • +

    Generates resources with the given options, based on the given template folder. +The output Iterable should be sorted so that containers always appear before their contents.

    +
    +
    +

    Parameters

    +
      +
    • +
      templateFolder: string
      +

      Folder where the templates are located.

      +
      +
    • +
    • +
      location: ResourceIdentifier
      +

      Base identifier.

      +
      +
    • +
    • +
      options: Dict<unknown>
      +

      Options that can be used when generating resources.

      +
      +
    +

    Returns AsyncIterable<Resource>

    A map where the keys are the identifiers and the values the corresponding representations to store.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SuffixAuxiliaryIdentifierStrategy.html b/7.x/docs/classes/SuffixAuxiliaryIdentifierStrategy.html new file mode 100644 index 000000000..84ad3da54 --- /dev/null +++ b/7.x/docs/classes/SuffixAuxiliaryIdentifierStrategy.html @@ -0,0 +1,218 @@ +SuffixAuxiliaryIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SuffixAuxiliaryIdentifierStrategy

+
+

Helper class that uses a suffix to determine if a resource is an auxiliary resource or not. +Simple string matching is used, so the dot needs to be included if needed, e.g. ".acl".

+
+
+
+

Hierarchy

+
    +
  • SuffixAuxiliaryIdentifierStrategy
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
suffix: string
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SuffixIdentifierGenerator.html b/7.x/docs/classes/SuffixIdentifierGenerator.html new file mode 100644 index 000000000..8a8b666e3 --- /dev/null +++ b/7.x/docs/classes/SuffixIdentifierGenerator.html @@ -0,0 +1,159 @@ +SuffixIdentifierGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SuffixIdentifierGenerator

+
+

Generates identifiers by appending the name to a stored base identifier. +Non-alphanumeric characters will be replaced with -.

+
+
+
+

Hierarchy

+
    +
  • SuffixIdentifierGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
base: string
+
+

Methods

+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TargetExtractor.html b/7.x/docs/classes/TargetExtractor.html new file mode 100644 index 000000000..34e710fef --- /dev/null +++ b/7.x/docs/classes/TargetExtractor.html @@ -0,0 +1,182 @@ +TargetExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TargetExtractorAbstract

+
+

Extracts a ResourceIdentifier from an incoming HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TemplateEngine.html b/7.x/docs/classes/TemplateEngine.html new file mode 100644 index 000000000..cd6ffe7da --- /dev/null +++ b/7.x/docs/classes/TemplateEngine.html @@ -0,0 +1,186 @@ +TemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TemplateEngine<T>Abstract

+
+

Generic interface for classes that implement a template engine. +A template engine renders content into a template.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TemplatedPodGenerator.html b/7.x/docs/classes/TemplatedPodGenerator.html new file mode 100644 index 000000000..1b6fdb11f --- /dev/null +++ b/7.x/docs/classes/TemplatedPodGenerator.html @@ -0,0 +1,211 @@ +TemplatedPodGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TemplatedPodGenerator

+
+

Creates a new ResourceStore when creating a pod based on a Components.js configuration.

+

Part of the dynamic pod creation.

+
    +
  1. It calls a VariableHandler to add necessary variable values. +E.g. setting the base url variable for components.js to the pod identifier.
  2. +
  3. It filters/cleans the input agent values using VariableHandlers
  4. +
  5. It calls a ComponentsJsFactory with the variables and template location to instantiate a new ResourceStore.
  6. +
  7. It stores these values in the configuration storage, which is used as a permanent storage for pod configurations.
  8. +
+
+
+
+

Hierarchy

+
    +
  • TemplatedPodGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseUrl: string
+
+ +
configStorage: KeyValueStorage<string, unknown>
+
+ +
configTemplatePath: string
+
+ +
logger: Logger = ...
+
+ +
storeFactory: ComponentsJsFactory
+
+ +
variableHandler: VariableHandler
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TokenOwnershipValidator.html b/7.x/docs/classes/TokenOwnershipValidator.html new file mode 100644 index 000000000..b1ec1fe6b --- /dev/null +++ b/7.x/docs/classes/TokenOwnershipValidator.html @@ -0,0 +1,287 @@ +TokenOwnershipValidator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TokenOwnershipValidator

+
+

Validates ownership of a WebId by seeing if a specific triple can be added. +expiration parameter is how long the token should be valid in minutes.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
expiration: number
+
+ +
logger: Logger = ...
+
+ +
storage: ExpiringStorage<string, string>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: {
          webId: string;
      }
      +

      Input that needs to be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input data that will be handled if it can be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TypedNotificationHandler.html b/7.x/docs/classes/TypedNotificationHandler.html new file mode 100644 index 000000000..55b7128ca --- /dev/null +++ b/7.x/docs/classes/TypedNotificationHandler.html @@ -0,0 +1,199 @@ +TypedNotificationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TypedNotificationHandler

+
+

A NotificationHandler that only accepts input for a specific notification channel type.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
type: string
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TypedRepresentationConverter.html b/7.x/docs/classes/TypedRepresentationConverter.html new file mode 100644 index 000000000..bfdf7e42e --- /dev/null +++ b/7.x/docs/classes/TypedRepresentationConverter.html @@ -0,0 +1,192 @@ +TypedRepresentationConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TypedRepresentationConverterAbstract

+
+

A RepresentationConverter that allows requesting the supported types.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnauthorizedHttpError.html b/7.x/docs/classes/UnauthorizedHttpError.html new file mode 100644 index 000000000..bb07df824 --- /dev/null +++ b/7.x/docs/classes/UnauthorizedHttpError.html @@ -0,0 +1,228 @@ +UnauthorizedHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnauthorizedHttpError

+
+

An error thrown when an agent is not authorized.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • UnauthorizedHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 401
+
+ +
isInstance: ((error) => error is HttpError<401>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<401>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<401>

      +
+
+ +
statusCode: 401
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnionCredentialsExtractor.html b/7.x/docs/classes/UnionCredentialsExtractor.html new file mode 100644 index 000000000..6ec252e09 --- /dev/null +++ b/7.x/docs/classes/UnionCredentialsExtractor.html @@ -0,0 +1,259 @@ +UnionCredentialsExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnionCredentialsExtractor

+
+

Combines the results of several CredentialsExtractors into one. +If multiple of these extractors return a value for the same key, +the last result will be used.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnionHandler.html b/7.x/docs/classes/UnionHandler.html new file mode 100644 index 000000000..e3b5bc949 --- /dev/null +++ b/7.x/docs/classes/UnionHandler.html @@ -0,0 +1,280 @@ +UnionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnionHandler<T>Abstract

+
+

Utility handler that allows combining the results of multiple handlers into one. +Will run the handlers and then call the abstract combine function with the results, +which then generates the handler's output.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
    + +
  • +

    Creates a new UnionHandler.

    +

    When requireAll is false or ignoreErrors is true, +the length of the input to combine can vary; +otherwise, it is exactly the number of handlers.

    +
    +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
      +
    • +
      handlers: T[]
      +

      The handlers whose output is to be combined.

      +
      +
    • +
    • +
      requireAll: boolean = false
      +

      If true, will fail if any of the handlers do not support the input. + If false, only the handlers that support the input will be called; + will fail only if none of the handlers can handle the input.

      +
      +
    • +
    • +
      ignoreErrors: boolean = !requireAll
      +

      If true, ignores handlers that fail by omitting their output; + if false, fails when any handlers fail.

      +
      +
    +

    Returns UnionHandler<T>

    +
+
+

Properties

+
+ +
handlers: T[]
+
+ +
ignoreErrors: boolean
+
+ +
requireAll: boolean
+
+

Methods

+
+ +
    + +
  • +

    Checks if all handlers can handle the input. +If not, throw an error based on the errors of the failed handlers.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: AsyncHandlerInput<T>
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<Awaited<ReturnType<T["handle"]>>>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnionPermissionReader.html b/7.x/docs/classes/UnionPermissionReader.html new file mode 100644 index 000000000..4b0344c06 --- /dev/null +++ b/7.x/docs/classes/UnionPermissionReader.html @@ -0,0 +1,271 @@ +UnionPermissionReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnionPermissionReader

+
+

Combines the results of multiple PermissionReaders. +Every permission in every credential type is handled according to the rule false > true > undefined.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
handlers: PermissionReader[]
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnionPreferenceParser.html b/7.x/docs/classes/UnionPreferenceParser.html new file mode 100644 index 000000000..1c50b392e --- /dev/null +++ b/7.x/docs/classes/UnionPreferenceParser.html @@ -0,0 +1,243 @@ +UnionPreferenceParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnionPreferenceParser

+
+

Combines the results of multiple PreferenceParsers. +Will throw an error if multiple parsers return a range as these can't logically be combined.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
handlers: PreferenceParser[]
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnlinkWebIdHandler.html b/7.x/docs/classes/UnlinkWebIdHandler.html new file mode 100644 index 000000000..5263903c0 --- /dev/null +++ b/7.x/docs/classes/UnlinkWebIdHandler.html @@ -0,0 +1,199 @@ +UnlinkWebIdHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnlinkWebIdHandler

+
+

Allows users to remove WebIDs linked to their account.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
webIdRoute: WebIdLinkRoute
+
+ +
webIdStore: WebIdStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnsecureConstantCredentialsExtractor.html b/7.x/docs/classes/UnsecureConstantCredentialsExtractor.html new file mode 100644 index 000000000..d909c858e --- /dev/null +++ b/7.x/docs/classes/UnsecureConstantCredentialsExtractor.html @@ -0,0 +1,201 @@ +UnsecureConstantCredentialsExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnsecureConstantCredentialsExtractor

+
+

Credentials extractor that authenticates a constant agent +(useful for development or debugging purposes).

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
credentials: Credentials
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnsecureWebIdExtractor.html b/7.x/docs/classes/UnsecureWebIdExtractor.html new file mode 100644 index 000000000..cfba05721 --- /dev/null +++ b/7.x/docs/classes/UnsecureWebIdExtractor.html @@ -0,0 +1,183 @@ +UnsecureWebIdExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnsecureWebIdExtractor

+
+

Credentials extractor which simply interprets the contents of the Authorization header as a WebID.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnsecureWebSocketsProtocol.html b/7.x/docs/classes/UnsecureWebSocketsProtocol.html new file mode 100644 index 000000000..3ca415b8a --- /dev/null +++ b/7.x/docs/classes/UnsecureWebSocketsProtocol.html @@ -0,0 +1,227 @@ +UnsecureWebSocketsProtocol | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnsecureWebSocketsProtocol

+
+

Provides live update functionality following +the Solid WebSockets API Spec solid-0.1.

+

The baseUrl parameter should be the same one that is used to advertise with the Updates-Via header.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
listeners: Set<WebSocketListener> = ...
+
+ +
logger: Logger = ...
+
+ +
path: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnsupportedAsyncHandler.html b/7.x/docs/classes/UnsupportedAsyncHandler.html new file mode 100644 index 000000000..363ff748d --- /dev/null +++ b/7.x/docs/classes/UnsupportedAsyncHandler.html @@ -0,0 +1,174 @@ +UnsupportedAsyncHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnsupportedAsyncHandler

+
+

Handler that does not support any input and will always throw an error.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
errorMessage?: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +

    Returns Promise<never>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<never>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnsupportedMediaTypeHttpError.html b/7.x/docs/classes/UnsupportedMediaTypeHttpError.html new file mode 100644 index 000000000..0f7b86278 --- /dev/null +++ b/7.x/docs/classes/UnsupportedMediaTypeHttpError.html @@ -0,0 +1,228 @@ +UnsupportedMediaTypeHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnsupportedMediaTypeHttpError

+
+

An error thrown when the media type of incoming data is not supported by a parser.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • UnsupportedMediaTypeHttpError
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode: string
+
+ +
message: string
+
+ +
+
+ +
name: string
+
+ +
stack?: string
+
+ +
statusCode: 415
+
+ +
isInstance: ((error) => error is HttpError<415>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<415>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<415>

      +
+
+ +
statusCode: 415
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UpdateOwnerHandler.html b/7.x/docs/classes/UpdateOwnerHandler.html new file mode 100644 index 000000000..3cff883e3 --- /dev/null +++ b/7.x/docs/classes/UpdateOwnerHandler.html @@ -0,0 +1,240 @@ +UpdateOwnerHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UpdateOwnerHandler

+
+

Responsible for adding/updating/deleting owners in pods.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
podRoute: PodIdRoute
+
+ +
podStore: PodStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Extract the pod ID from the path and find the associated pod. +Asserts that the given account ID is the creator of this pod.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<{
        accountId: string;
        baseUrl: string;
        id: string;
    }>

    +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UpdatePasswordHandler.html b/7.x/docs/classes/UpdatePasswordHandler.html new file mode 100644 index 000000000..4b8a2a13c --- /dev/null +++ b/7.x/docs/classes/UpdatePasswordHandler.html @@ -0,0 +1,221 @@ +UpdatePasswordHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UpdatePasswordHandler

+
+

Allows the password of a login to be updated.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
passwordRoute: PasswordIdRoute
+
+ +
passwordStore: PasswordStore
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/V6MigrationInitializer.html b/7.x/docs/classes/V6MigrationInitializer.html new file mode 100644 index 000000000..f463ea4d5 --- /dev/null +++ b/7.x/docs/classes/V6MigrationInitializer.html @@ -0,0 +1,331 @@ +V6MigrationInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class V6MigrationInitializer

+
+

Handles migrating account data from v6 to the newer format. +Will only trigger if it is detected that this server was previously started on an older version +and at least one account was found. +Confirmation will be asked to the user through a CLI prompt. +After migration is complete the old data will be removed.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accountStorage: KeyValueStorage<string, Account | Settings>
+
+ +
cleanupStorages: KeyValueStorage<string, unknown>[]
+
+ +
clientCredentialsStorage: KeyValueStorage<string, ClientCredentials>
+
+ +
logger: Logger = ...
+
+ +
newAccountStorage: AccountLoginStorage<{
    account: {
        rememberLogin: "boolean?";
    };
    clientCredentials: {
        accountId: "id:account";
        label: "string";
        secret: "string";
        webId: "string";
    };
    owner: {
        podId: "id:pod";
        visible: "boolean";
        webId: "string";
    };
    password: {
        accountId: "id:account";
        email: "string";
        password: "string";
        verified: "boolean";
    };
    pod: {
        accountId: "id:account";
        baseUrl: "string";
    };
    webIdLink: {
        accountId: "id:account";
        webId: "string";
    };
}>
+
+

Type declaration

+
    +
  • +
    Readonly account: {
        rememberLogin: "boolean?";
    }
    +
      +
    • +
      Readonly rememberLogin: "boolean?"
  • +
  • +
    Readonly clientCredentials: {
        accountId: "id:account";
        label: "string";
        secret: "string";
        webId: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
    • +
    • +
      Readonly label: "string"
    • +
    • +
      Readonly secret: "string"
    • +
    • +
      Readonly webId: "string"
  • +
  • +
    Readonly owner: {
        podId: "id:pod";
        visible: "boolean";
        webId: "string";
    }
    +
      +
    • +
      Readonly podId: "id:pod"
    • +
    • +
      Readonly visible: "boolean"
    • +
    • +
      Readonly webId: "string"
  • +
  • +
    Readonly password: {
        accountId: "id:account";
        email: "string";
        password: "string";
        verified: "boolean";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
    • +
    • +
      Readonly email: "string"
    • +
    • +
      Readonly password: "string"
    • +
    • +
      Readonly verified: "boolean"
  • +
  • +
    Readonly pod: {
        accountId: "id:account";
        baseUrl: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
    • +
    • +
      Readonly baseUrl: "string"
  • +
  • +
    Readonly webIdLink: {
        accountId: "id:account";
        webId: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
    • +
    • +
      Readonly webId: "string"
+
+ +
newSetupStorage: KeyValueStorage<string, string>
+
+ +
setupStorage: KeyValueStorage<string, string>
+
+ +
skipConfirmation: boolean
+
+ +
versionKey: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Creates a new account based on the account data found in the old storage. +Will always create an account and password entry. +In case useIdp is true, will create a WebID link entry. +In case there is an associated podBaseUrl, will create a pod and owner entry.

    +
    +
    +

    Parameters

    +
      +
    • +
      account: Account | Settings
    +

    Returns Promise<undefined | {
        accountId: string;
        webId: string;
    }>

    +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ValidatingDataAccessor.html b/7.x/docs/classes/ValidatingDataAccessor.html new file mode 100644 index 000000000..c359c8c79 --- /dev/null +++ b/7.x/docs/classes/ValidatingDataAccessor.html @@ -0,0 +1,343 @@ +ValidatingDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ValidatingDataAccessor

+
+

A ValidatingDataAccessor wraps a DataAccessor such that the data stream is validated while being written. +An AtomicDataAccessor can be used to prevent data being written in case validation fails.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
validator: Validator
+
+

Methods

+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/Validator.html b/7.x/docs/classes/Validator.html new file mode 100644 index 000000000..2e534815c --- /dev/null +++ b/7.x/docs/classes/Validator.html @@ -0,0 +1,174 @@ +Validator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ValidatorAbstract

+
+

Generic interface for classes that validate Representations in some way.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: ValidatorInput
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VariableHandler.html b/7.x/docs/classes/VariableHandler.html new file mode 100644 index 000000000..1a7d19213 --- /dev/null +++ b/7.x/docs/classes/VariableHandler.html @@ -0,0 +1,193 @@ +VariableHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VariableHandlerAbstract

+
+

Updates the variables stored in the given agent. +Can be used to set variables that are required for the Components.js instantiation +but which should not be provided by the request. +E.g.: The exact file path (when required) should be determined by the server to prevent abuse.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VariableSetter.html b/7.x/docs/classes/VariableSetter.html new file mode 100644 index 000000000..926f2cdac --- /dev/null +++ b/7.x/docs/classes/VariableSetter.html @@ -0,0 +1,222 @@ +VariableSetter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VariableSetter

+
+

A VariableHandler that will set the given variable to the given value, +unless there already is a value for the variable and override is false.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
override: boolean
+
+ +
value: string
+
+ +
variable: string
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VersionHandler.html b/7.x/docs/classes/VersionHandler.html new file mode 100644 index 000000000..1463f8796 --- /dev/null +++ b/7.x/docs/classes/VersionHandler.html @@ -0,0 +1,191 @@ +VersionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VersionHandler

+
+

Adds the current version of the API to the JSON output. +This version number should be updated every time the API changes.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ViewInteractionHandler.html b/7.x/docs/classes/ViewInteractionHandler.html new file mode 100644 index 000000000..7a53b14c2 --- /dev/null +++ b/7.x/docs/classes/ViewInteractionHandler.html @@ -0,0 +1,194 @@ +ViewInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ViewInteractionHandler

+
+

Utility class for the common case of a JsonInteractionHandler +describing the expected input on a GET request which is needed to do a POST request.

+

Returns the result of a JsonView on GET requests. +POST requests are sent to the JsonInteractionHandler. +Other methods will be rejected.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VoidLocker.html b/7.x/docs/classes/VoidLocker.html new file mode 100644 index 000000000..3344fd9fe --- /dev/null +++ b/7.x/docs/classes/VoidLocker.html @@ -0,0 +1,217 @@ +VoidLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VoidLocker

+
+

A ReadWriteLocker where the locks expire after a given time.

+
+
+
+

Hierarchy

+
    +
  • VoidLocker
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    As ReadWriteLocker.withReadLock but the locked function gets called with a maintainLock callback function +to reset the lock expiration every time it is called. +The resulting promise will reject once the lock expires.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      Identifier of the resource that needs to be locked.

      +
      +
    • +
    • +
      whileLocked: ((maintainLock) => PromiseOrValue<T>)
      +

      A function to execute while the resource is locked. +Receives a callback as input parameter to maintain the lock.

      +
      +
      +
        +
      • +
          +
        • (maintainLock): PromiseOrValue<T>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            maintainLock: (() => void)
            +
              +
            • +
                +
              • (): void
              • +
              • +

                Returns void

          +

          Returns PromiseOrValue<T>

    +

    Returns Promise<T>

    +
+
+ +
    + +
  • +

    As ReadWriteLocker.withWriteLock but the locked function gets called with a maintainLock +callback function to reset the lock expiration every time it is called. +The resulting promise will reject once the lock expires.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      Identifier of the resource that needs to be locked.

      +
      +
    • +
    • +
      whileLocked: ((maintainLock) => PromiseOrValue<T>)
      +

      A function to execute while the resource is locked. +Receives a callback as input parameter to maintain the lock.

      +
      +
      +
        +
      • +
          +
        • (maintainLock): PromiseOrValue<T>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            maintainLock: (() => void)
            +
              +
            • +
                +
              • (): void
              • +
              • +

                Returns void

          +

          Returns PromiseOrValue<T>

    +

    Returns Promise<T>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VoidLogger.html b/7.x/docs/classes/VoidLogger.html new file mode 100644 index 000000000..bc73b7b3e --- /dev/null +++ b/7.x/docs/classes/VoidLogger.html @@ -0,0 +1,245 @@ +VoidLogger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VoidLogger

+
+

A logger that does nothing on a log message.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VoidLoggerFactory.html b/7.x/docs/classes/VoidLoggerFactory.html new file mode 100644 index 000000000..c6891a639 --- /dev/null +++ b/7.x/docs/classes/VoidLoggerFactory.html @@ -0,0 +1,133 @@ +VoidLoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VoidLoggerFactory

+
+

A factory that always returns VoidLogger, which does nothing on log messages.

+
+
+
+

Hierarchy

+
    +
  • VoidLoggerFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: VoidLogger = ...
+
+

Methods

+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WacAllowHttpHandler.html b/7.x/docs/classes/WacAllowHttpHandler.html new file mode 100644 index 000000000..b33d90796 --- /dev/null +++ b/7.x/docs/classes/WacAllowHttpHandler.html @@ -0,0 +1,243 @@ +WacAllowHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WacAllowHttpHandler

+
+

Adds all the available permissions to the response metadata, +which can be used to generate the correct WAC-Allow header.

+

This class does many things similar to the AuthorizingHttpHandler, +so in general it is a good idea to make sure all these classes cache their results.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
credentialsExtractor: CredentialsExtractor
+
+ +
logger: Logger = ...
+
+ +
modesExtractor: ModesExtractor
+
+ +
operationHandler: OperationHttpHandler
+
+ +
permissionReader: PermissionReader
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WacAllowMetadataWriter.html b/7.x/docs/classes/WacAllowMetadataWriter.html new file mode 100644 index 000000000..051ead4fe --- /dev/null +++ b/7.x/docs/classes/WacAllowMetadataWriter.html @@ -0,0 +1,213 @@ +WacAllowMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WacAllowMetadataWriter

+
+

Add the necessary WAC-Allow header values. +Solid, §10.1: "Servers exposing client’s access privileges on a resource URL MUST advertise +by including the WAC-Allow HTTP header in the response of HTTP HEAD and GET requests." +https://solid.github.io/specification/protocol#web-access-control

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WaterfallHandler.html b/7.x/docs/classes/WaterfallHandler.html new file mode 100644 index 000000000..4c8e47463 --- /dev/null +++ b/7.x/docs/classes/WaterfallHandler.html @@ -0,0 +1,220 @@ +WaterfallHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WaterfallHandler<TIn, TOut>

+
+

A composite handler that tries multiple handlers one by one +until it finds a handler that supports the input. +The handlers will be checked in the order they appear in the input array, +allowing for more fine-grained handlers to check before catch-all handlers.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn

  • +
  • +

    TOut

+
+

Hierarchy

+
    +
  • WaterfallHandler
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
handlers: AsyncHandler<TIn, TOut>[]
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether any of the stored handlers can handle the given input.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      The data that would need to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if at least 1 handler supports to input, or rejecting if none do.

    + +
+
+ +
    + +
  • +

    Finds a handler that supports the given input and then lets it handle the given data.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      The data that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise corresponding to the handle call of a handler that supports the input. +It rejects if no handlers support the given data.

    + +
+
+ +
    + +
  • +

    Identical to AsyncHandler.handleSafe but optimized for composite +by only needing 1 canHandle call on members.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      The input data.

      +
      +
    +

    Returns Promise<TOut>

    A promise corresponding to the handle call of a handler that supports the input. +It rejects if no handlers support the given data.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebAclReader.html b/7.x/docs/classes/WebAclReader.html new file mode 100644 index 000000000..886bf9bcc --- /dev/null +++ b/7.x/docs/classes/WebAclReader.html @@ -0,0 +1,389 @@ +WebAclReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebAclReader

+
+

Finds the permissions of a resource as defined in the corresponding ACL resource. +Does not make any deductions such as checking parent containers for create permissions +or applying control permissions for ACL resources.

+

Specific access checks are done by the provided AccessChecker.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
accessChecker: AccessChecker
+
+ +
aclStore: ResourceStore
+
+ +
+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
logger: Logger = ...
+
+ +
resourceSet: ResourceSet
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Determines the available permissions for the given credentials.

    +
    +
    +

    Parameters

    +
      +
    • +
      acl: Store<Quad, Quad, Quad, Quad>
      +

      Store containing all relevant authorization triples.

      +
      +
    • +
    • +
      credentials: Credentials
      +

      Credentials to find the permissions for.

      +
      +
    +

    Returns Promise<AclPermissionSet>

    +
+
+ +
    + +
  • +

    Extracts all rules from the store that are relevant for the given target, +based on either the acl:accessTo or acl:default predicates.

    +
    +
    +

    Parameters

    +
      +
    • +
      store: Store<Quad, Quad, Quad, Quad>
      +

      Store to filter.

      +
      +
    • +
    • +
      target: string
      +

      The identifier of which the acl rules need to be known.

      +
      +
    • +
    • +
      directAcl: boolean
      +

      If the store contains triples from the direct acl resource of the target or not. + Determines if acl:accessTo or acl:default are used.

      +
      +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    A store containing the relevant triples for the given target.

    + +
+
+ +
    + +
  • +

    For every ACL/identifier combination it finds the relevant ACL triples for that identifier. +This is done in such a way that store results are reused for all matching identifiers. +The split is based on the acl:accessTo and acl:default triples.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Map<Store<Quad, Quad, Quad, Quad>, ResourceIdentifier[]>>

    +
+
+ +
    + +
  • +

    Finds the permissions in the provided WebACL quads.

    +

    Rather than restricting the search to only the required modes, +we collect all modes in order to have complete metadata (for instance, for the WAC-Allow header).

    +
    +
    +

    Parameters

    +
      +
    • +
      aclMap: Map<Store<Quad, Quad, Quad, Quad>, ResourceIdentifier[]>
      +

      A map containing stores of ACL data linked to their relevant identifiers.

      +
      +
    • +
    • +
      credentials: Credentials
      +

      Credentials to check permissions for.

      +
      +
    +

    Returns Promise<PermissionMap>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocket2023Emitter.html b/7.x/docs/classes/WebSocket2023Emitter.html new file mode 100644 index 000000000..e1be521f7 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Emitter.html @@ -0,0 +1,199 @@ +WebSocket2023Emitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocket2023Emitter

+
+

Emits notifications on WebSocketChannel2023 subscription. +Uses the WebSockets found in the provided map. +The key should be the identifier of the matching channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
socketMap: SetMultiMap<string, WebSocket>
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocket2023Handler.html b/7.x/docs/classes/WebSocket2023Handler.html new file mode 100644 index 000000000..9ef4c58b2 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Handler.html @@ -0,0 +1,173 @@ +WebSocket2023Handler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocket2023HandlerAbstract

+
+

A handler that is called when a valid WebSocketChannel2023 connection has been made.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocket2023Listener.html b/7.x/docs/classes/WebSocket2023Listener.html new file mode 100644 index 000000000..5ace58b5a --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Listener.html @@ -0,0 +1,216 @@ +WebSocket2023Listener | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocket2023Listener

+
+

Listens for WebSocket connections and verifies whether they are valid WebSocketChannel2023 connections, +in which case its WebSocket2023Handler will be alerted.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
baseUrl: string
+
+ +
+
+ +
logger: Logger = ...
+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocket2023Storer.html b/7.x/docs/classes/WebSocket2023Storer.html new file mode 100644 index 000000000..220fcb7b3 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Storer.html @@ -0,0 +1,226 @@ +WebSocket2023Storer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocket2023Storer

+
+

Keeps track of the WebSockets that were opened for a WebSocketChannel2023 channel. +The WebSockets are stored in the map using the identifier of the matching channel.

+

cleanupTimer defines in minutes how often the stored WebSockets are closed +if their corresponding channel has expired. +Defaults to 60 minutes. +Open WebSockets will not receive notifications if their channel expired.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
socketMap: SetMultiMap<string, WebSocket>
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocketAdvertiser.html b/7.x/docs/classes/WebSocketAdvertiser.html new file mode 100644 index 000000000..bbbf057e9 --- /dev/null +++ b/7.x/docs/classes/WebSocketAdvertiser.html @@ -0,0 +1,193 @@ +WebSocketAdvertiser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocketAdvertiser

+
+

Handler that advertises a WebSocket through the Updates-Via header.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
socketUrl: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocketChannel2023Type.html b/7.x/docs/classes/WebSocketChannel2023Type.html new file mode 100644 index 000000000..b7c7879eb --- /dev/null +++ b/7.x/docs/classes/WebSocketChannel2023Type.html @@ -0,0 +1,336 @@ +WebSocketChannel2023Type | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocketChannel2023Type

+
+

The notification channel type WebSocketChannel2023 as described in +https://solid.github.io/notifications/websocket-channel-2023

+

Requires read permissions on a resource to be able to receive notifications.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
features: NamedNode<string>[]
+
+ +
logger: Logger = ...
+
+ +
path: string
+
+ +
shacl: unknown
+
+ +
shaclQuads?: Store<Quad, Quad, Quad, Quad>
+
+ +
type: NamedNode<string>
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns an N3.js Store containing quads corresponding to the stored SHACL representation. +Caches this result so the conversion from JSON-LD to quads only has to happen once.

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Converts the given channel to a JSON-LD description. +All fields found in the channel, except lastEmit, will be part of the result subject, +so subclasses should remove any fields that should not be exposed.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Record<string, unknown>>

    +
+
+ +
    + +
  • +

    Validates whether the given data conforms to the stored SHACL shape. +Will throw an UnprocessableEntityHttpError if validation fails. +Along with the SHACL check, this also makes sure there is only one matching entry in the dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      The data to validate.

      +
      +
    +

    Returns Promise<Term>

    The focus node that corresponds to the subject of the found notification channel description.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocketHandler.html b/7.x/docs/classes/WebSocketHandler.html new file mode 100644 index 000000000..7767bb426 --- /dev/null +++ b/7.x/docs/classes/WebSocketHandler.html @@ -0,0 +1,174 @@ +WebSocketHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocketHandlerAbstract

+
+

A handler to support requests trying to open a WebSocket connection.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocketMap.html b/7.x/docs/classes/WebSocketMap.html new file mode 100644 index 000000000..cd4d009c1 --- /dev/null +++ b/7.x/docs/classes/WebSocketMap.html @@ -0,0 +1,456 @@ +WebSocketMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocketMap

+
+

A SetMultiMap linking identifiers to a set of WebSockets. +An extension of WrappedSetMultiMap to make sure Components.js allows us to create this in the config, +as WrappedSetMultiMap has a constructor not supported.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Accessors

+
+
+

Methods

+
+
+

Constructors

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      mapConstructor: (new () => Map<string, Set<WebSocket>>) = Map
      +

      Will be used to instantiate the internal Map.

      +
      +
      +
        +
      • +
          +
        • new (): Map<string, Set<WebSocket>>
        • +
        • +

          Returns Map<string, Set<WebSocket>>

    • +
    • +
      Optional iterable: Iterable<readonly [string, WebSocket | ReadonlySet<WebSocket>]>
      +

      Entries to add to the map.

      +
      +
    +

    Returns WebSocketMap

    +
+
+

Properties

+
+ +
[toStringTag]: "WrappedSetMultiMap" = 'WrappedSetMultiMap'
+
+

Accessors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Loops over all key/value bindings.

    +
    +
    +

    Parameters

    +
      +
    • +
      callbackfn: ((value, key, map) => void)
      +
        +
      • +
          +
        • (value, key, map): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            value: WebSocket
          • +
          • +
            key: string
          • +
          • +
            map: SetMultiMap<string, WebSocket>
          +

          Returns void

    • +
    • +
      Optional thisArg: unknown
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns all values stored for the given key. +Returns undefined if there are no values for this key.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
    +

    Returns undefined | ReadonlySet<WebSocket>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocketServerConfigurator.html b/7.x/docs/classes/WebSocketServerConfigurator.html new file mode 100644 index 000000000..016c664c6 --- /dev/null +++ b/7.x/docs/classes/WebSocketServerConfigurator.html @@ -0,0 +1,198 @@ +WebSocketServerConfigurator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocketServerConfigurator

+
+

ServerConfigurator that adds WebSocket functionality to an existing Server.

+

Listens for WebSocket requests and sends them to its handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      server: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebhookChannel2023Type.html b/7.x/docs/classes/WebhookChannel2023Type.html new file mode 100644 index 000000000..6bc5da81f --- /dev/null +++ b/7.x/docs/classes/WebhookChannel2023Type.html @@ -0,0 +1,366 @@ +WebhookChannel2023Type | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebhookChannel2023Type

+
+

The notification channel type WebhookChannel2023 as described in +https://solid.github.io/notifications/webhook-channel-2023

+

Requires read permissions on a resource to be able to receive notifications.

+

Also handles the state feature if present.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
features: NamedNode<string>[]
+
+ +
logger: Logger = ...
+
+ +
path: string
+
+ +
shacl: unknown
+
+ +
shaclQuads?: Store<Quad, Quad, Quad, Quad>
+
+ +
stateHandler: StateHandler
+
+ +
type: NamedNode<string>
+
+ +
webId: string
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Returns an N3.js Store containing quads corresponding to the stored SHACL representation. +Caches this result so the conversion from JSON-LD to quads only has to happen once.

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Validates whether the given data conforms to the stored SHACL shape. +Will throw an UnprocessableEntityHttpError if validation fails. +Along with the SHACL check, this also makes sure there is only one matching entry in the dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      The data to validate.

      +
      +
    +

    Returns Promise<Term>

    The focus node that corresponds to the subject of the found notification channel description.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebhookEmitter.html b/7.x/docs/classes/WebhookEmitter.html new file mode 100644 index 000000000..126e770f9 --- /dev/null +++ b/7.x/docs/classes/WebhookEmitter.html @@ -0,0 +1,229 @@ +WebhookEmitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebhookEmitter

+
+

Emits a notification representation using the WebhookChannel2023 specification.

+

At the time of writing it is not specified how exactly a notification sender should make its requests verifiable, +so for now we use a token similar to those from Solid-OIDC, signed by the server itself.

+

Generates a DPoP token and proof, and adds those to the HTTP request that is sent to the target.

+

The expiration input parameter is how long the generated token should be valid in minutes. +Default is 20.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
expiration: number
+
+ +
issuer: string
+
+ +
jwkGenerator: JwkGenerator
+
+ +
logger: Logger = ...
+
+ +
webId: string
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebhookWebId.html b/7.x/docs/classes/WebhookWebId.html new file mode 100644 index 000000000..55decd825 --- /dev/null +++ b/7.x/docs/classes/WebhookWebId.html @@ -0,0 +1,192 @@ +WebhookWebId | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebhookWebId

+
+

Generates a fixed WebID that we use to identify the server for notifications sent using a WebhookChannel2023. +This is used in tandem with the tokens generated by the WebhookEmitter. +This is a minimal WebID with only the solid:oidcIssuer triple.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
turtle: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WinstonLogger.html b/7.x/docs/classes/WinstonLogger.html new file mode 100644 index 000000000..d91b0a49b --- /dev/null +++ b/7.x/docs/classes/WinstonLogger.html @@ -0,0 +1,282 @@ +WinstonLogger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WinstonLogger

+
+

A WinstonLogger implements the Logger interface using a given winston logger.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Log the given message at the given level. +If the internal level is higher than the given level, the message may be voided.

    +
    +
    +

    Parameters

    +
      +
    • +
      level: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
      +

      The level to log at.

      +
      +
    • +
    • +
      message: string
      +

      The message to log.

      +
      +
    • +
    • +
      Optional meta: unknown
      +

      Optional metadata to include in the log message.

      +
      +
    +

    Returns WinstonLogger

    +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WinstonLoggerFactory.html b/7.x/docs/classes/WinstonLoggerFactory.html new file mode 100644 index 000000000..3e4d8e970 --- /dev/null +++ b/7.x/docs/classes/WinstonLoggerFactory.html @@ -0,0 +1,167 @@ +WinstonLoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WinstonLoggerFactory

+
+

Uses the winston library to create loggers for the given logging level. +By default, it will print to the console with colorized logging levels.

+

This creates instances of WinstonLogger.

+
+
+
+

Hierarchy

+
    +
  • WinstonLoggerFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
level: string
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WorkerManager.html b/7.x/docs/classes/WorkerManager.html new file mode 100644 index 000000000..30c414ada --- /dev/null +++ b/7.x/docs/classes/WorkerManager.html @@ -0,0 +1,182 @@ +WorkerManager | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WorkerManager

+
+

Spawns the necessary workers when starting in multithreaded mode.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clusterManager: ClusterManager
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WrappedExpiringReadWriteLocker.html b/7.x/docs/classes/WrappedExpiringReadWriteLocker.html new file mode 100644 index 000000000..e278e1df5 --- /dev/null +++ b/7.x/docs/classes/WrappedExpiringReadWriteLocker.html @@ -0,0 +1,289 @@ +WrappedExpiringReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WrappedExpiringReadWriteLocker

+
+

Wraps around an existing ReadWriteLocker and adds expiration logic to prevent locks from getting stuck.

+
+
+
+

Hierarchy

+
    +
  • WrappedExpiringReadWriteLocker
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
expiration: number
+
+ +
+
+ +
logger: Logger = ...
+
+

Methods

+
+ +
    + +
  • +

    Creates a Promise that either resolves the given input function or rejects if time runs out, +whichever happens first. The input function can reset the timer by calling the maintainLock function +it receives. The ResourceIdentifier is only used for logging.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WrappedExpiringStorage.html b/7.x/docs/classes/WrappedExpiringStorage.html new file mode 100644 index 000000000..b59a0fd74 --- /dev/null +++ b/7.x/docs/classes/WrappedExpiringStorage.html @@ -0,0 +1,390 @@ +WrappedExpiringStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WrappedExpiringStorage<TKey, TValue>

+
+

A storage that wraps around another storage and expires resources based on the given (optional) expiry date. +Will delete expired entries when trying to get their value. +Has a timer that will delete all expired data every hour (default value).

+
+
+
+

Type Parameters

+
    +
  • +

    TKey

  • +
  • +

    TValue

+
+

Hierarchy

+
    +
  • WrappedExpiringStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
source: KeyValueStorage<TKey, Expires<TValue>>
+
+ +
timer: Timeout
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Tries to get the data for the given key. +In case the data exists but has expired, +it will be deleted and undefined will be returned instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns Promise<undefined | TValue>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Creates a new object where the expires field is a Date instead of a string.

    +
    +
    +

    Parameters

    +
    +

    Returns {
        expires?: Date;
        payload: TValue;
    }

    +
      +
    • +
      Optional expires?: Date
    • +
    • +
      payload: TValue
    +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WrappedIndexedStorage.html b/7.x/docs/classes/WrappedIndexedStorage.html new file mode 100644 index 000000000..7e1ddb31b --- /dev/null +++ b/7.x/docs/classes/WrappedIndexedStorage.html @@ -0,0 +1,1018 @@ +WrappedIndexedStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WrappedIndexedStorage<T>

+
+

An IndexedStorage that makes use of 2 KeyValueStorages to implement the interface. +Due to being limited by key/value storages, there are some restrictions on the allowed type definitions:

+
    +
  • There needs to be exactly 1 type with no references to other types.
  • +
  • All other types need to have exactly 1 reference to another type.
  • +
  • Types can't reference each other to create a cycle of references.
  • +
+

All of the above to create a tree-like structure of references. +Such a tree is then stored in one of the storages. +The other storage is used to store all indexes that are used to find the correct tree object when solving queries.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • WrappedIndexedStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
indexStorage: KeyValueStorage<string, string[]>
+
+ +
indexes: {
    [K in string]?: Set<StringKey<T[K]>>
}
+

For every type, the keys on which an index tracks the values and which root object they are contained in. +All types for which a defineType call was made will have a key in this object. +For all types that are not the root, there will always be an index on their ID value.

+
+
+
+ +
logger: Logger = ...
+
+ +
relations: IndexRelation<T>[]
+

All parent/child relations between all types in the storage, +including the keys in both types that are used to reference each other.

+
+
+
+ +
rootTypeVar: undefined | StringKey<T>
+

The variable in which the root type is stored. +A separate getter is used to always return the value +so the potential undefined does not have to be taken into account.

+
+
+
+ +
validDefinition: boolean = false
+

Keeps track of type validation. +If true the defined types create a valid structure that can be used.

+
+
+
+ +
valueStorage: KeyValueStorage<string, VirtualObject>
+
+

Accessors

+
+ +
    +
  • get rootType(): string
  • +
  • +

    The root type for this storage. +Use this instead of rootTypeVar to prevent having to check for undefined. +This value will always be defined if the type definitions have been validated.

    +
    +

    Returns string

    +
+
+

Methods

+
+ +
    + +
  • +

    Creates an object of the given type. +The storage will generate an identifier for the newly created object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type to create.

      +
      +
    • +
    • +
      value: CreateTypeObject<T[TType]>
      +

      The value to set for the created object.

      +
      +
    +

    Returns Promise<TypeObject<T[TType]>>

    A representation of the newly created object, including its new identifier.

    + +
+
+ +
    + +
  • +

    Creates an index on a key of the given type, to allow for better queries involving those keys. +Similar to IndexedStorage.defineType these calls need to happen first.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type to create an index on.

      +
      +
    • +
    • +
      key: StringKey<T[TType]>
      +

      The key of that type to create an index on.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Informs the storage of the definition of a specific type. +A definition is a key/value object with the values being a valid ValueTypeDescription. +Generally, this call needs to happen for every type of this storage, +and before any calls are made to interact with the data.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type to define.

      +
      +
    • +
    • +
      description: T[TType]
      +

      A description of the values stored in objects of that type.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Deletes the given object. +This will also delete all objects that reference that object if the corresponding key is not optional.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to delete.

      +
      +
    • +
    • +
      id: string
      +

      The identifier of the object.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
+
+ +
    + +
  • +

    Finds all objects matching a specific IndexedQuery.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of objects to find.

      +
      +
    • +
    • +
      query: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
      +

      The query to execute.

      +
      +
    +

    Returns Promise<TypeObject<T[TType]>[]>

    A list of objects matching the query.

    + +
+
+ +
    + +
  • +

    Similar to IndexedStorage.find, but only returns the identifiers of the found objects.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of objects to find.

      +
      +
    • +
    • +
      query: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
      +

      The query to execute.

      +
      +
    +

    Returns Promise<string[]>

    A list of identifiers of the matching objects.

    + +
+
+ +
    + +
  • +

    Finds the IDs of all root objects that contain objects of the given type matching the given query +by making use of the indexes applicable to the keys in the query. +This function only looks at the keys in the query with primitive values, +object values in the query referencing parent objects are not considered. +Similarly, only indexes are used, keys without index are also ignored.

    +

    If an array of root IDs is provided as input, +the result will be an intersection of this array and the found identifiers.

    +

    If the result is an empty array, it means that there is no valid identifier matching the query, +while an undefined result means there is no index matching any of the query keys, +so a result can't be determined.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
    • +
    • +
      match: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
    • +
    • +
      Optional rootIds: string[]
    +

    Returns Promise<undefined | string[]>

    +
+
+ +
    + +
  • +

    Returns the object of the given type with the given identifier.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of object to get.

      +
      +
    • +
    • +
      id: string
      +

      The identifier of that object.

      +
      +
    +

    Returns Promise<undefined | TypeObject<T[TType]>>

    A representation of the object, or undefined if there is no object of that type with that identifier.

    + +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Finds the record in the given object that contains the given type/id combination. +This function assumes it was already verified through an index that this object contains the given combination.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
    +

    Returns Record<string, VirtualObject>

    +
+
+ +
    + +
  • +

    Generate the key used to store the index in the index storage.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
    • +
    • +
      key: string
    • +
    • +
      value: string | number
    +

    Returns string

    +
+
+ +
    + +
  • +

    Returns the relation where the given type is the child. +Will return undefined for the root type as that one doesn't have a parent.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
    +

    Returns undefined | IndexRelation<T>

    +
+
+ +
+
+ +
    + +
  • +

    Returns the sequence of virtual keys that need to be accessed to reach the given type, starting from the root.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
    +

    Returns `**${string}**`[]

    +
+
+ +
+
+ +
    + +
  • +

    Returns true if the object of the given type with the given identifier exists.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of object to get.

      +
      +
    • +
    • +
      id: string
      +

      The identifier of that object.

      +
      +
    +

    Returns Promise<boolean>

    Whether this object exists.

    + +
+
+ +
    + +
  • +

    Sets the value of a specific object. +The identifier in the object is used to identify the object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to set.

      +
      +
    • +
    • +
      value: TypeObject<T[TType]>
      +

      The new value for the object.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Sets the value of one specific field in an object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    • +
    • +

      TKey extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to update.

      +
      +
    • +
    • +
      id: string
      +

      The identifier of the object to update.

      +
      +
    • +
    • +
      key: TKey
      +

      The key to update.

      +
      +
    • +
    • +
      value: ValueType<T[TType][TKey]>
      +

      The new value for the given key.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Finds all objects of the given type matching the query. +The rootIds array can be used to restrict the IDs of root objects to look at, +which is relevant for the recursive calls the function does.

    +

    Will throw an error if there is no index that can be used to solve the query.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
    • +
    • +
      query: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
    • +
    • +
      Optional rootIds: string[]
    +

    Returns Promise<VirtualObject[]>

    +
+
+ +
+
+ +
    + +
  • +

    Update all indexes for an object of the given type, and all its children.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Updates the index for a specific key of an object of the given type.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
    • +
    • +
      key: string
    • +
    • +
      value: string
    • +
    • +
      rootId: string
    • +
    • +
      add: boolean
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Updates all indexes for an object of the given type.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Replaces an object of the given type. +The identifier in the value is used to determine which object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
    • +
    • +
      value: TypeObject<T[TType]>
    • +
    • +
      replace: true
    +

    Returns Promise<void>

    +
  • + +
  • +

    Replaces part of an object of the given type with the given partial value. +The identifier in the value is used to determine which object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
    • +
    • +
      partial: Partial<TypeObject<T[TType]>> & {
          id: string;
      }
    • +
    • +
      replace: false
    +

    Returns Promise<void>

    +
+
+ +
    + +
  • +

    Makes sure the defined types fulfill all the requirements necessary for types on this storage. +Will throw an error if this is not the case. +This should be called before doing any data interactions. +Stores success in a variable so future calls are instantaneous.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WrappedSetMultiMap.html b/7.x/docs/classes/WrappedSetMultiMap.html new file mode 100644 index 000000000..cf651a2b7 --- /dev/null +++ b/7.x/docs/classes/WrappedSetMultiMap.html @@ -0,0 +1,485 @@ +WrappedSetMultiMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WrappedSetMultiMap<TKey, TVal>

+
+

A SetMultiMap that uses an internal Map based on the provided constructor.

+

In case no input constructor is provided, the default Map implementation will be used.

+

It is required that the value type of this map is not Set or any extension of Set, +otherwise the set and add functions wil break.

+
+
+
+

Type Parameters

+
    +
  • +

    TKey

  • +
  • +

    TVal

+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Accessors

+
+
+

Methods

+
+
+

Constructors

+
+ +
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      TKey

    • +
    • +

      TVal

    +
    +

    Parameters

    +
      +
    • +
      mapConstructor: (new () => Map<TKey, Set<TVal>>) = Map
      +

      Will be used to instantiate the internal Map.

      +
      +
      +
        +
      • +
          +
        • new (): Map<TKey, Set<TVal>>
        • +
        • +

          Returns Map<TKey, Set<TVal>>

    • +
    • +
      Optional iterable: Iterable<readonly [TKey, TVal | ReadonlySet<TVal>]>
      +

      Entries to add to the map.

      +
      +
    +

    Returns WrappedSetMultiMap<TKey, TVal>

    +
+
+

Properties

+
+ +
[toStringTag]: "WrappedSetMultiMap" = 'WrappedSetMultiMap'
+
+ +
count: number
+
+ +
map: Map<TKey, Set<TVal>>
+
+

Accessors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Iterates over all distinct keys in this Map, together with a Set of their values.

    +
    +

    Returns IterableIterator<[TKey, ReadonlySet<TVal>]>

    +
+
+ +
    + +
  • +

    Loops over all key/value bindings.

    +
    +
    +

    Parameters

    +
      +
    • +
      callbackfn: ((value, key, map) => void)
      +
        +
      • +
          +
        • (value, key, map): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            value: TVal
          • +
          • +
            key: TKey
          • +
          • +
            map: SetMultiMap<TKey, TVal>
          +

          Returns void

    • +
    • +
      Optional thisArg: unknown
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns all values stored for the given key. +Returns undefined if there are no values for this key.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns undefined | ReadonlySet<TVal>

    +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WrappingLogger.html b/7.x/docs/classes/WrappingLogger.html new file mode 100644 index 000000000..deb28b7fd --- /dev/null +++ b/7.x/docs/classes/WrappingLogger.html @@ -0,0 +1,283 @@ +WrappingLogger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WrappingLogger

+
+

Implements BaseLogger around a SimpleLogger, +which can be swapped out a runtime.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: SimpleLogger
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+ +
    + +
  • +

    Log the given message at the given level. +If the internal level is higher than the given level, the message may be voided.

    +
    +
    +

    Parameters

    +
      +
    • +
      level: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
      +

      The level to log at.

      +
      +
    • +
    • +
      message: string
      +

      The message to log.

      +
      +
    • +
    • +
      Optional meta: LogMetadata
      +

      Optional metadata to include in the log message.

      +
      +
    +

    Returns WrappingLogger

    +
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WwwAuthMetadataWriter.html b/7.x/docs/classes/WwwAuthMetadataWriter.html new file mode 100644 index 000000000..61c831be7 --- /dev/null +++ b/7.x/docs/classes/WwwAuthMetadataWriter.html @@ -0,0 +1,195 @@ +WwwAuthMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WwwAuthMetadataWriter

+
+

Adds the WWW-Authenticate header with the injected value in case the response status code is 401.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
auth: string
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/YargsCliExtractor.html b/7.x/docs/classes/YargsCliExtractor.html new file mode 100644 index 000000000..b417e9b33 --- /dev/null +++ b/7.x/docs/classes/YargsCliExtractor.html @@ -0,0 +1,227 @@ +YargsCliExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class YargsCliExtractor

+
+

Parses CLI args using the yargs library. +Specific settings can be enabled through the provided options.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
yargsArgOptions: Record<string, Options>
+
+ +
yargvOptions: CliOptions
+
+

Methods

+
+ +
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: CliArgv
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+ +
    + +
  • +

    Creates the yargs Argv object based on the input CLI argv.

    +
    +
    +

    Parameters

    +
      +
    • +
      argv: readonly string[]
    +

    Returns Argv<{}>

    +
+
+ +
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      argv: readonly string[]
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<{
        $0: string;
        _: (string | number)[];
        [argName: string]: unknown;
    }>

    A promise resolving when handling is finished.

    + +
+
+ +
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: CliArgv
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<Shorthand>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/YargsParameter.html b/7.x/docs/classes/YargsParameter.html new file mode 100644 index 000000000..d5c0bddc7 --- /dev/null +++ b/7.x/docs/classes/YargsParameter.html @@ -0,0 +1,128 @@ +YargsParameter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class YargsParameter

+
+

This class exists as wrapper around a yargs Options object, +thereby allowing us to create these in a Components.js configuration.

+

Format details can be found at https://yargs.js.org/docs/#api-reference-optionskey-opt

+
+
+
+

Hierarchy

+
    +
  • YargsParameter
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      name: string
      +

      Name of the parameter. Corresponds to the first parameter passed to the yargs.options function.

      +
      +
    • +
    • +
      options: Record<string, unknown>
      +

      Options for a single parameter that should be parsed.

      +
      +
    +

    Returns YargsParameter

    +
    +

    Range

+
+

Properties

+
+ +
name: string
+
+ +
options: Options
+
+
\ No newline at end of file diff --git a/7.x/docs/enums/AccessMode.html b/7.x/docs/enums/AccessMode.html new file mode 100644 index 000000000..960d846e8 --- /dev/null +++ b/7.x/docs/enums/AccessMode.html @@ -0,0 +1,113 @@ +AccessMode | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Enumeration AccessMode

+
+

Different modes that require permission.

+
+
+
+
+
+ +
+
+

Enumeration Members

+
+
+

Enumeration Members

+
+ +
append: "append"
+
+ +
create: "create"
+
+ +
delete: "delete"
+
+ +
read: "read"
+
+ +
write: "write"
+
+
\ No newline at end of file diff --git a/7.x/docs/enums/AclMode.html b/7.x/docs/enums/AclMode.html new file mode 100644 index 000000000..a2806f4db --- /dev/null +++ b/7.x/docs/enums/AclMode.html @@ -0,0 +1,81 @@ +AclMode | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/functions/absoluteFilePath.html b/7.x/docs/functions/absoluteFilePath.html new file mode 100644 index 000000000..0f903afe8 --- /dev/null +++ b/7.x/docs/functions/absoluteFilePath.html @@ -0,0 +1,79 @@ +absoluteFilePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function absoluteFilePath

+
+
    + +
  • +

    Resolves a path to its absolute form. +Absolute inputs will not be changed (except changing Windows to POSIX). +Relative inputs will be interpreted relative to process.cwd().

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check (POSIX or Windows).

      +
      +
    +

    Returns string

    The potentially changed path (POSIX).

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/addGeneratedResources.html b/7.x/docs/functions/addGeneratedResources.html new file mode 100644 index 000000000..528bc7ef4 --- /dev/null +++ b/7.x/docs/functions/addGeneratedResources.html @@ -0,0 +1,87 @@ +addGeneratedResources | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function addGeneratedResources

+
+
    + +
  • +

    Generates resources with the given generator and adds them to the given store.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<number>

    The amount of resources that were added.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/addHeader.html b/7.x/docs/functions/addHeader.html new file mode 100644 index 000000000..40f91813c --- /dev/null +++ b/7.x/docs/functions/addHeader.html @@ -0,0 +1,77 @@ +addHeader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function addHeader

+
+
    + +
  • +

    Adds a header value without overriding previous values.

    +
    +
    +

    Parameters

    +
      +
    • +
      response: HttpResponse
    • +
    • +
      name: string
    • +
    • +
      value: string | string[]
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/addResourceMetadata.html b/7.x/docs/functions/addResourceMetadata.html new file mode 100644 index 000000000..610dca41e --- /dev/null +++ b/7.x/docs/functions/addResourceMetadata.html @@ -0,0 +1,81 @@ +addResourceMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function addResourceMetadata

+
+
    + +
  • +

    Helper function to generate type quads for a Container or Resource.

    +
    +
    +

    Parameters

    +
      +
    • +
      metadata: RepresentationMetadata
      +

      Metadata to add to.

      +
      +
    • +
    • +
      isContainer: boolean
      +

      If the identifier corresponds to a container.

      +
      +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/addTemplateMetadata.html b/7.x/docs/functions/addTemplateMetadata.html new file mode 100644 index 000000000..31299f2d8 --- /dev/null +++ b/7.x/docs/functions/addTemplateMetadata.html @@ -0,0 +1,86 @@ +addTemplateMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function addTemplateMetadata

+
+
    + +
  • +

    Links a template file with a given content-type to the metadata using the SOLID_META.template predicate.

    +
    +
    +

    Parameters

    +
      +
    • +
      metadata: RepresentationMetadata
      +

      Metadata to update.

      +
      +
    • +
    • +
      templateFile: string
      +

      Path to the template.

      +
      +
    • +
    • +
      contentType: string
      +

      Content-type of the template after it is rendered.

      +
      +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/allFulfilled.html b/7.x/docs/functions/allFulfilled.html new file mode 100644 index 000000000..154e092df --- /dev/null +++ b/7.x/docs/functions/allFulfilled.html @@ -0,0 +1,81 @@ +allFulfilled | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function allFulfilled

+
+
    + +
  • +

    Obtains the values of all fulfilled promises. +If there are rejections (and ignoreErrors is false), throws a combined error of all rejected promises.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      promises: Promise<T>[]
    • +
    • +
      ignoreErrors: boolean = false
    +

    Returns Promise<T[]>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/assertAccountId.html b/7.x/docs/functions/assertAccountId.html new file mode 100644 index 000000000..07cf7cb7f --- /dev/null +++ b/7.x/docs/functions/assertAccountId.html @@ -0,0 +1,73 @@ +assertAccountId | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function assertAccountId

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/assertOidcInteraction.html b/7.x/docs/functions/assertOidcInteraction.html new file mode 100644 index 000000000..2fce32b14 --- /dev/null +++ b/7.x/docs/functions/assertOidcInteraction.html @@ -0,0 +1,78 @@ +assertOidcInteraction | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function assertOidcInteraction

+
+
    + +
  • +

    Asserts oidcInteraction is defined, throws the correct error in case this is not the case. +The error contains the relevant error code that can be used to explain more extensively what the issue is +and why an OIDC interaction is needed.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional oidcInteraction: Interaction
      +

      Interaction object to check.

      +
      +
    +

    Returns asserts oidcInteraction is Interaction

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/assertReadConditions.html b/7.x/docs/functions/assertReadConditions.html new file mode 100644 index 000000000..2fc3f4207 --- /dev/null +++ b/7.x/docs/functions/assertReadConditions.html @@ -0,0 +1,94 @@ +assertReadConditions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function assertReadConditions

+
+
    + +
  • +

    Verify whether the given Representation matches the given conditions. +If true, add the corresponding ETag to the body metadata. +If not, destroy the data stream and throw a NotModifiedHttpError with the same ETag. +If conditions is not defined, nothing will happen.

    +

    This uses the strict conditions check which takes the content type into account; +therefore, this should only be called after content negotiation, when it is certain what the output will be.

    +

    Note that browsers only keep track of one ETag, and the Vary header has no impact on this, +meaning the browser could send us the ETag for a Turtle resource even though it is requesting JSON-LD; +this is why we have to check ETags after content negotiation.

    +
    +
    +

    Parameters

    +
      +
    • +
      body: Representation
      +

      The representation to compare the conditions against.

      +
      +
    • +
    • +
      eTagHandler: ETagHandler
      +

      Used to generate the ETag to return with the 304 response.

      +
      +
    • +
    • +
      Optional conditions: Conditions
      +

      The conditions to assert.

      +
      +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/asyncToArray.html b/7.x/docs/functions/asyncToArray.html new file mode 100644 index 000000000..be3fd7032 --- /dev/null +++ b/7.x/docs/functions/asyncToArray.html @@ -0,0 +1,78 @@ +asyncToArray | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function asyncToArray

+
+
    + +
  • +

    Converts an AsyncIterator to an array.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      iterable: AsyncIterable<T>
    +

    Returns Promise<T[]>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/cleanPreferences.html b/7.x/docs/functions/cleanPreferences.html new file mode 100644 index 000000000..44a46c0f6 --- /dev/null +++ b/7.x/docs/functions/cleanPreferences.html @@ -0,0 +1,79 @@ +cleanPreferences | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function cleanPreferences

+
+
    + +
  • +

    Cleans incoming preferences to prevent unwanted behaviour. +Makes sure internal types have weight 0, unless specifically requested in the preferences, +and interprets empty preferences as accepting everything.

    +
    +
    +

    Parameters

    +
      +
    • +
      preferences: ValuePreferences = {}
      +

      Preferences that need to be updated.

      +
      +
    +

    Returns ValuePreferences

    A copy of the the preferences with the necessary updates.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/cloneRepresentation.html b/7.x/docs/functions/cloneRepresentation.html new file mode 100644 index 000000000..7d9a3e896 --- /dev/null +++ b/7.x/docs/functions/cloneRepresentation.html @@ -0,0 +1,78 @@ +cloneRepresentation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function cloneRepresentation

+
+
    + +
  • +

    Helper function to clone a representation, the original representation can still be used. +This function loads the entire stream in memory.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<BasicRepresentation>

    The cloned representation.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/concat.html b/7.x/docs/functions/concat.html new file mode 100644 index 000000000..b9a04f622 --- /dev/null +++ b/7.x/docs/functions/concat.html @@ -0,0 +1,81 @@ +concat | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function concat

+
+
    + +
  • +

    Creates a new iterable that is a concatenation of all the iterables in the input.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      iterables: Iterable<Iterable<T>>
      +

      An iterable of which the contents will be concatenated into a new iterable.

      +
      +
    +

    Returns Iterable<T>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/createAggregateError.html b/7.x/docs/functions/createAggregateError.html new file mode 100644 index 000000000..1edfbaa9c --- /dev/null +++ b/7.x/docs/functions/createAggregateError.html @@ -0,0 +1,78 @@ +createAggregateError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function createAggregateError

+
+
    + +
  • +

    Combines a list of errors into a single HttpError. +Status code depends on the input errors. If they all share the same status code that code will be re-used. +If they are all within the 4xx range, 400 will be used, otherwise 500.

    +
    +
    +

    Parameters

    +
      +
    • +
      errors: Error[]
      +

      Errors to combine.

      +
      +
    +

    Returns HttpError

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/createErrorMessage.html b/7.x/docs/functions/createErrorMessage.html new file mode 100644 index 000000000..e20f2ead6 --- /dev/null +++ b/7.x/docs/functions/createErrorMessage.html @@ -0,0 +1,73 @@ +createErrorMessage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function createErrorMessage

+
+
    + +
  • +

    Creates a string representing the error message of this object.

    +
    +
    +

    Parameters

    +
      +
    • +
      error: unknown
    +

    Returns string

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/createGenericEventEmitterClass.html b/7.x/docs/functions/createGenericEventEmitterClass.html new file mode 100644 index 000000000..4ce14ac4d --- /dev/null +++ b/7.x/docs/functions/createGenericEventEmitterClass.html @@ -0,0 +1,81 @@ +createGenericEventEmitterClass | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function createGenericEventEmitterClass

+
+
    + +
  • +

    Creates a class that is an implementation of EventEmitter +but with specific typings based on GenericEventEmitter. +Useful in case a class needs to extend EventEmitter and wants specific internal typings.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends EventEmitter

    +

    Returns (new () => T)

    +
      +
    • +
        +
      • new (): T
      • +
      • +

        Returns T

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/createSubdomainRegexp.html b/7.x/docs/functions/createSubdomainRegexp.html new file mode 100644 index 000000000..f08cb910a --- /dev/null +++ b/7.x/docs/functions/createSubdomainRegexp.html @@ -0,0 +1,85 @@ +createSubdomainRegexp | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function createSubdomainRegexp

+
+
    + +
  • +

    Creates a regular expression that matches URLs containing the given baseUrl, or a subdomain of the given baseUrl. +In case there is a subdomain, the first match of the regular expression will be that subdomain.

    +

    Examples with baseUrl http://test.com/foo/:

    +
      +
    • Will match http://test.com/foo/
    • +
    • Will match http://test.com/foo/bar/baz
    • +
    • Will match http://alice.bob.test.com/foo/bar/baz, first match result will be alice.bob
    • +
    • Will not match http://test.com/
    • +
    • Will not match http://alicetest.com/foo/
    • +
    +
    +
    +

    Parameters

    +
      +
    • +
      baseUrl: string
      +

      Base URL for the regular expression.

      +
      +
    +

    Returns RegExp

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/createVocabulary.html b/7.x/docs/functions/createVocabulary.html new file mode 100644 index 000000000..e53b8b1c7 --- /dev/null +++ b/7.x/docs/functions/createVocabulary.html @@ -0,0 +1,84 @@ +createVocabulary | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function createVocabulary

+
+
    + +
  • +

    Creates a Vocabulary with the given baseUri as namespace and all localNames as entries. +The values are the local names expanded from the given base URI as strings. +The terms field contains all the same values but as NamedNode instead.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TBase extends string

    • +
    • +

      TLocal extends string

    +
    +

    Parameters

    +
      +
    • +
      baseUri: TBase
    • +
    • +
      Rest ...localNames: TLocal[]
    +

    Returns string extends TLocal
        ? PartialVocabulary<TBase>
        : Vocabulary<TBase, TLocal>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/decodeUriPathComponents.html b/7.x/docs/functions/decodeUriPathComponents.html new file mode 100644 index 000000000..5bdd5cca6 --- /dev/null +++ b/7.x/docs/functions/decodeUriPathComponents.html @@ -0,0 +1,80 @@ +decodeUriPathComponents | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function decodeUriPathComponents

+
+
    + +
  • +

    This function is used when converting a URI to a file path. Decodes all components of a URI path, +with the exception of encoded slash characters, as this would lead to unexpected file locations +being targeted (resulting in erroneous behaviour of the file based backend). +Characters that would result in an illegal file path remain percent encoded.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to decode the URI path components of.

      +
      +
    +

    Returns string

    A decoded copy of the provided URI path (ignoring encoded slash characters).

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/encodeUriPathComponents.html b/7.x/docs/functions/encodeUriPathComponents.html new file mode 100644 index 000000000..2110dcd59 --- /dev/null +++ b/7.x/docs/functions/encodeUriPathComponents.html @@ -0,0 +1,79 @@ +encodeUriPathComponents | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function encodeUriPathComponents

+
+
    + +
  • +

    This function is used in the process of converting a file path to a URI. Encodes all (non-slash) +special characters in a URI path, with the exception of encoded slash characters, as this would +lead to unnecessary double encoding, resulting in a URI that differs from the expected result.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to encode the URI path components of.

      +
      +
    +

    Returns string

    An encoded copy of the provided URI path (ignoring encoded slash characters).

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/endOfStream.html b/7.x/docs/functions/endOfStream.html new file mode 100644 index 000000000..f53546ccf --- /dev/null +++ b/7.x/docs/functions/endOfStream.html @@ -0,0 +1,70 @@ +endOfStream | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function endOfStream

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      arg1: Stream
    +

    Returns Promise<void>

+
+
\ No newline at end of file diff --git a/7.x/docs/functions/ensureLeadingSlash.html b/7.x/docs/functions/ensureLeadingSlash.html new file mode 100644 index 000000000..e26304e33 --- /dev/null +++ b/7.x/docs/functions/ensureLeadingSlash.html @@ -0,0 +1,79 @@ +ensureLeadingSlash | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function ensureLeadingSlash

+
+
    + +
  • +

    Makes sure the input path has exactly 1 slash at the beginning. +Multiple slashes will get merged into one. +If there is no slash it will be added.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check.

      +
      +
    +

    Returns string

    The potentially changed path.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/ensureTrailingSlash.html b/7.x/docs/functions/ensureTrailingSlash.html new file mode 100644 index 000000000..f40f92b89 --- /dev/null +++ b/7.x/docs/functions/ensureTrailingSlash.html @@ -0,0 +1,79 @@ +ensureTrailingSlash | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function ensureTrailingSlash

+
+
    + +
  • +

    Makes sure the input path has exactly 1 slash at the end. +Multiple slashes will get merged into one. +If there is no slash it will be added.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check.

      +
      +
    +

    Returns string

    The potentially changed path.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/errorTermsToMetadata.html b/7.x/docs/functions/errorTermsToMetadata.html new file mode 100644 index 000000000..b785c84a1 --- /dev/null +++ b/7.x/docs/functions/errorTermsToMetadata.html @@ -0,0 +1,83 @@ +errorTermsToMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function errorTermsToMetadata

+
+
    + +
  • +

    Adds the given terms to error metadata. +The keys will be converted to predicates by prepending them with the SOLID_ERROR_TERM namespace. +The values will become literals.

    +
    +
    +

    Parameters

    +
      +
    • +
      terms: Dict<string>
      +

      Terms to add to the metadata.

      +
      +
    • +
    • +
      Optional metadata: RepresentationMetadata
      +

      Metadata to add the terms to. A new metadata object will be created if this is undefined.

      +
      +
    +

    Returns RepresentationMetadata

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/extendVocabulary.html b/7.x/docs/functions/extendVocabulary.html new file mode 100644 index 000000000..9dac94519 --- /dev/null +++ b/7.x/docs/functions/extendVocabulary.html @@ -0,0 +1,90 @@ +extendVocabulary | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function extendVocabulary

+
+
    + +
  • +

    Creates a new Vocabulary that extends an existing one by adding new local names.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TBase extends string

    • +
    • +

      TLocal extends string

    • +
    • +

      TNew extends string

    +
    +

    Parameters

    +
      +
    • +
      vocabulary: Vocabulary<TBase, TLocal>
      +

      The Vocabulary to extend.

      +
      +
    • +
    • +
      Rest ...newNames: TNew[]
      +

      The new local names that need to be added.

      +
      +
    +

    Returns ReturnType<typeof createVocabulary>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/extractErrorTerms.html b/7.x/docs/functions/extractErrorTerms.html new file mode 100644 index 000000000..6c4b741dc --- /dev/null +++ b/7.x/docs/functions/extractErrorTerms.html @@ -0,0 +1,79 @@ +extractErrorTerms | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function extractErrorTerms

+
+
    + +
  • +

    Extracts all the error metadata terms and converts them to a simple object. +All predicates in the SOLID_ERROR_TERM namespace will be found. +The namespace will be removed from the predicate and the remainder will be used as a key. +The object literal values will be used as values in the resulting object.

    +
    +
    +

    Parameters

    +
    +

    Returns Dict<string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/extractScheme.html b/7.x/docs/functions/extractScheme.html new file mode 100644 index 000000000..f335ad5c9 --- /dev/null +++ b/7.x/docs/functions/extractScheme.html @@ -0,0 +1,82 @@ +extractScheme | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function extractScheme

+
+
    + +
  • +

    Splits a URL (or similar) string into a part containing its scheme and one containing the rest. +E.g., http://test.com/ results in { scheme: 'http://', rest: 'test.com/' }.

    +
    +
    +

    Parameters

    +
      +
    • +
      url: string
      +

      String to parse.

      +
      +
    +

    Returns {
        rest: string;
        scheme: string;
    }

    +
      +
    • +
      rest: string
    • +
    • +
      scheme: string
    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/fetchDataset.html b/7.x/docs/functions/fetchDataset.html new file mode 100644 index 000000000..9fa16b22b --- /dev/null +++ b/7.x/docs/functions/fetchDataset.html @@ -0,0 +1,74 @@ +fetchDataset | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function fetchDataset

+
+
    + +
  • +

    Fetches an RDF dataset from the given URL.

    +

    Response will be a Representation with content-type internal/quads.

    +
    +
    +

    Parameters

    +
      +
    • +
      url: string
    +

    Returns Promise<Representation>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/filter.html b/7.x/docs/functions/filter.html new file mode 100644 index 000000000..beabb9991 --- /dev/null +++ b/7.x/docs/functions/filter.html @@ -0,0 +1,106 @@ +filter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function filter

+
+
    + +
  • +

    Creates a new iterable with all elements that pass the test implemented by the provided function. +Similar to the Array.prototype.filter function. +See the documentation of the above function for more details.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      iterable: Iterable<T>
      +

      Iterable on which to call the map function.

      +
      +
    • +
    • +
      callbackFn: ((element, index) => boolean)
      +

      Function that is called to test every element.

      +
      +
      +
        +
      • +
          +
        • (element, index): boolean
        • +
        • +
          +

          Parameters

          +
            +
          • +
            element: T
          • +
          • +
            index: number
          +

          Returns boolean

    • +
    • +
      Optional thisArg: unknown
      +

      Value to use as this when executing callbackFn.

      +
      +
    +

    Returns Iterable<T>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/filterHandlers.html b/7.x/docs/functions/filterHandlers.html new file mode 100644 index 000000000..a1dd9ba92 --- /dev/null +++ b/7.x/docs/functions/filterHandlers.html @@ -0,0 +1,89 @@ +filterHandlers | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function filterHandlers

+
+
    + +
  • +

    Filters a list of handlers to only keep those that can handle the input. +Will error if no matching handlers are found.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

    • +
    • +

      TOut

    +
    +

    Parameters

    +
      +
    • +
      handlers: AsyncHandler<TIn, TOut>[]
      +

      Handlers to filter.

      +
      +
    • +
    • +
      input: TIn
      +

      Input that needs to be supported.

      +
      +
    +

    Returns Promise<AsyncHandler<TIn, TOut>[]>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/find.html b/7.x/docs/functions/find.html new file mode 100644 index 000000000..b1f89f4a5 --- /dev/null +++ b/7.x/docs/functions/find.html @@ -0,0 +1,107 @@ +find | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function find

+
+
    + +
  • +

    Returns the first element in the provided iterable that satisfies the provided testing function. +If no values satisfy the testing function, undefined is returned. +Similar to the Array.prototype.find function. +See the documentation of the above function for more details.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      iterable: Iterable<T>
      +

      Iterable on which to call the map function.

      +
      +
    • +
    • +
      callbackFn: ((element, index) => boolean)
      +

      Function that is called to test every element.

      +
      +
      +
        +
      • +
          +
        • (element, index): boolean
        • +
        • +
          +

          Parameters

          +
            +
          • +
            element: T
          • +
          • +
            index: number
          +

          Returns boolean

    • +
    • +
      Optional thisArg: unknown
      +

      Value to use as this when executing callbackFn.

      +
      +
    +

    Returns T | undefined

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/findHandler.html b/7.x/docs/functions/findHandler.html new file mode 100644 index 000000000..67358b700 --- /dev/null +++ b/7.x/docs/functions/findHandler.html @@ -0,0 +1,90 @@ +findHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function findHandler

+
+
    + +
  • +

    Finds a handler that can handle the given input data. +Otherwise an error gets thrown.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

    • +
    • +

      TOut

    +
    +

    Parameters

    +
      +
    • +
      handlers: AsyncHandler<TIn, TOut>[]
      +

      List of handlers to search in.

      +
      +
    • +
    • +
      input: TIn
      +

      The input data.

      +
      +
    +

    Returns Promise<AsyncHandler<TIn, TOut>>

    A promise resolving to a handler that supports the data or otherwise rejecting.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/finishInteraction.html b/7.x/docs/functions/finishInteraction.html new file mode 100644 index 000000000..f31e0eb9c --- /dev/null +++ b/7.x/docs/functions/finishInteraction.html @@ -0,0 +1,86 @@ +finishInteraction | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function finishInteraction

+
+
    + +
  • +

    Updates the oidcInteraction object with the necessary data in case a prompt gets updated.

    +
    +
    +

    Parameters

    +
      +
    • +
      oidcInteraction: Interaction
      +

      Interaction to update.

      +
      +
    • +
    • +
      result: AccountInteractionResults
      +

      New data to add to the interaction.

      +
      +
    • +
    • +
      mergeWithLastSubmission: boolean
      +

      If this new data needs to be merged with already existing data in the interaction.

      +
      +
    +

    Returns Promise<string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/forgetWebId.html b/7.x/docs/functions/forgetWebId.html new file mode 100644 index 000000000..22f635ea4 --- /dev/null +++ b/7.x/docs/functions/forgetWebId.html @@ -0,0 +1,83 @@ +forgetWebId | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function forgetWebId

+
+
    + +
  • +

    Removes the WebID, the accountId, from the OIDC session object, +allowing us to replace it with a new value. +If there is no session in the Interaction, nothing will happen.

    +
    +
    +

    Parameters

    +
      +
    • +
      provider: default
      +

      The OIDC provider.

      +
      +
    • +
    • +
      oidcInteraction: Interaction
      +

      The current interaction.

      +
      +
    +

    Returns Promise<void>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/generateHttpErrorClass.html b/7.x/docs/functions/generateHttpErrorClass.html new file mode 100644 index 000000000..9f7488707 --- /dev/null +++ b/7.x/docs/functions/generateHttpErrorClass.html @@ -0,0 +1,86 @@ +generateHttpErrorClass | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function generateHttpErrorClass

+
+
    + +
  • +

    Generates a new HttpError class with the given status code and name. +In general, status codes are used to uniquely identify error types, +so there should be no 2 classes with the same value there.

    +

    To make sure Components.js can work with these newly generated classes, +the generated class should be called BaseHttpError as that name is an entry in .componentsignore. +The actual class should then extend BaseHttpError and have a correct constructor, +so the Components.js generator can generate the correct components JSON-LD file during build.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TCode extends number

    +
    +

    Parameters

    +
      +
    • +
      statusCode: TCode
    • +
    • +
      name: string
    +

    Returns HttpErrorClass<TCode>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/generateHttpErrorUri.html b/7.x/docs/functions/generateHttpErrorUri.html new file mode 100644 index 000000000..aba85b477 --- /dev/null +++ b/7.x/docs/functions/generateHttpErrorUri.html @@ -0,0 +1,73 @@ +generateHttpErrorUri | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function generateHttpErrorUri

+
+
    + +
  • +

    Returns a URI that is unique for the given status code.

    +
    +
    +

    Parameters

    +
      +
    • +
      statusCode: number
    +

    Returns NamedNode

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/generateRedirectHttpErrorClass.html b/7.x/docs/functions/generateRedirectHttpErrorClass.html new file mode 100644 index 000000000..3cafd3132 --- /dev/null +++ b/7.x/docs/functions/generateRedirectHttpErrorClass.html @@ -0,0 +1,82 @@ +generateRedirectHttpErrorClass | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function generateRedirectHttpErrorClass

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/generateWebSocketUrl.html b/7.x/docs/functions/generateWebSocketUrl.html new file mode 100644 index 000000000..af78027b8 --- /dev/null +++ b/7.x/docs/functions/generateWebSocketUrl.html @@ -0,0 +1,76 @@ +generateWebSocketUrl | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function generateWebSocketUrl

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getAccessControl.html b/7.x/docs/functions/getAccessControl.html new file mode 100644 index 000000000..fd1e65bc0 --- /dev/null +++ b/7.x/docs/functions/getAccessControl.html @@ -0,0 +1,81 @@ +getAccessControl | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getAccessControl

+
+
    + +
  • +

    Finds the IAccessControl with the given identifier in the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Dataset to look in.

      +
      +
    • +
    • +
      accessControl: Term
      +

      Identifier of the access control.

      +
      +
    +

    Returns IAccessControl

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getAccessControlResource.html b/7.x/docs/functions/getAccessControlResource.html new file mode 100644 index 000000000..815869bf3 --- /dev/null +++ b/7.x/docs/functions/getAccessControlResource.html @@ -0,0 +1,81 @@ +getAccessControlResource | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getAccessControlResource

+
+
    + +
  • +

    Finds the IAccessControlResource with the given identifier in the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Dataset to look in.

      +
      +
    • +
    • +
      acr: Term
      +

      Identifier of the access control resource.

      +
      +
    +

    Returns IAccessControlResource

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getAccessControlledResources.html b/7.x/docs/functions/getAccessControlledResources.html new file mode 100644 index 000000000..110517a19 --- /dev/null +++ b/7.x/docs/functions/getAccessControlledResources.html @@ -0,0 +1,76 @@ +getAccessControlledResources | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getAccessControlledResources

+
+
    + +
  • +

    Finds all IAccessControlledResource in the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Dataset to look in.

      +
      +
    +

    Returns Iterable<IAccessControlledResource>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getBestPreference.html b/7.x/docs/functions/getBestPreference.html new file mode 100644 index 000000000..ee35f40bb --- /dev/null +++ b/7.x/docs/functions/getBestPreference.html @@ -0,0 +1,84 @@ +getBestPreference | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getBestPreference

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getConversionTarget.html b/7.x/docs/functions/getConversionTarget.html new file mode 100644 index 000000000..4e6494d1d --- /dev/null +++ b/7.x/docs/functions/getConversionTarget.html @@ -0,0 +1,88 @@ +getConversionTarget | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getConversionTarget

+
+
    + +
  • +

    For a media type converter that can generate the given types, +this function tries to find the type that best matches the given preferences.

    +

    This function combines several other conversion utility functions +to determine what output a converter should generate: +it cleans the preferences with cleanPreferences to support empty preferences +and to prevent the accidental generation of internal types, +after which the best match gets found based on the weights.

    +
    +
    +

    Parameters

    +
    +

    Returns string | undefined

    The best match. Undefined if there is no match.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getDefault.html b/7.x/docs/functions/getDefault.html new file mode 100644 index 000000000..0e501e76a --- /dev/null +++ b/7.x/docs/functions/getDefault.html @@ -0,0 +1,142 @@ +getDefault | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getDefault

+
+
    + +
  • +

    Finds the result of calling map.get(key). +If there is no result, it instead returns the result of the default function. +The Map will also be updated to assign that default value to the given key.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TKey

    • +
    • +

      TValue

    +
    +

    Parameters

    +
      +
    • +
      map: Map<TKey, TValue>
      +

      Map to use.

      +
      +
    • +
    • +
      key: TKey
      +

      Key to find the value for.

      +
      +
    • +
    • +
      defaultFn: (() => TValue)
      +

      Function to generate default value to insert and return if no result was found.

      +
      +
      +
        +
      • +
          +
        • (): TValue
        • +
        • +

          Returns TValue

    +

    Returns TValue

    +
  • + +
  • +

    Finds the result of calling map.get(key). +If there is no result, it instead returns the result of the default function. +The Map will also be updated to assign the resolved default value to the given key.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TKey

    • +
    • +

      TValue

    +
    +

    Parameters

    +
      +
    • +
      map: Map<TKey, TValue>
      +

      Map to use.

      +
      +
    • +
    • +
      key: TKey
      +

      Key to find the value for.

      +
      +
    • +
    • +
      defaultFn: (() => Promise<TValue>)
      +

      Function to generate default value to insert and return if no result was found.

      +
      +
      +
        +
      • +
          +
        • (): Promise<TValue>
        • +
        • +

          Returns Promise<TValue>

    +

    Returns Promise<TValue>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getExtension.html b/7.x/docs/functions/getExtension.html new file mode 100644 index 000000000..bd5897d49 --- /dev/null +++ b/7.x/docs/functions/getExtension.html @@ -0,0 +1,77 @@ +getExtension | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getExtension

+
+
    + +
  • +

    Extracts the extension (without dot) from a path. +Custom function since path.extname does not work on all cases (e.g. ".acl")

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Input path to parse.

      +
      +
    +

    Returns string

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getLoggerFor.html b/7.x/docs/functions/getLoggerFor.html new file mode 100644 index 000000000..5984d94bc --- /dev/null +++ b/7.x/docs/functions/getLoggerFor.html @@ -0,0 +1,82 @@ +getLoggerFor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getLoggerFor

+
+
    + +
  • +

    Gets a logger instance for the given class instance.

    +

    The following shows a typical pattern on how to create loggers:

    +
    class MyClass {
    protected readonly logger = getLoggerFor(this);
    } +
    +

    If no class is applicable, a logger can also be created as follows:

    +
    const logger = getLoggerFor('MyFunction');
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      loggable: string | Instance
      +

      A class instance or a class string name.

      +
      +
    +

    Returns Logger

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getMatcher.html b/7.x/docs/functions/getMatcher.html new file mode 100644 index 000000000..2105a4930 --- /dev/null +++ b/7.x/docs/functions/getMatcher.html @@ -0,0 +1,81 @@ +getMatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getMatcher

+
+
    + +
  • +

    Finds the IMatcher with the given identifier in the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Dataset to look in.

      +
      +
    • +
    • +
      matcher: Term
      +

      Identifier of the matcher.

      +
      +
    +

    Returns IMatcher

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getModuleRoot.html b/7.x/docs/functions/getModuleRoot.html new file mode 100644 index 000000000..57dc98bb1 --- /dev/null +++ b/7.x/docs/functions/getModuleRoot.html @@ -0,0 +1,68 @@ +getModuleRoot | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getModuleRoot

+
+
    + +
  • +

    Returns the folder corresponding to the root of the Community Solid Server module

    +
    +

    Returns string

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getPolicy.html b/7.x/docs/functions/getPolicy.html new file mode 100644 index 000000000..bed7783d5 --- /dev/null +++ b/7.x/docs/functions/getPolicy.html @@ -0,0 +1,81 @@ +getPolicy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getPolicy

+
+
    + +
  • +

    Finds the IPolicy with the given identifier in the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Dataset to look in.

      +
      +
    • +
    • +
      policy: Term
      +

      Identifier of the policy.

      +
      +
    +

    Returns IPolicy

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getRelativeUrl.html b/7.x/docs/functions/getRelativeUrl.html new file mode 100644 index 000000000..4c02dfbd3 --- /dev/null +++ b/7.x/docs/functions/getRelativeUrl.html @@ -0,0 +1,87 @@ +getRelativeUrl | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getRelativeUrl

+
+
    + +
  • +

    Creates a relative URL by removing the base URL. +Will throw an error in case the resulting target is not withing the base URL scope.

    +
    +
    +

    Parameters

    +
      +
    • +
      baseUrl: string
      +

      Base URL.

      +
      +
    • +
    • +
      request: HttpRequest
      +

      Incoming request of which the target needs to be extracted.

      +
      +
    • +
    • +
      targetExtractor: TargetExtractor
      +

      Will extract the target from the request.

      +
      +
    +

    Returns Promise<string>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getSingleItem.html b/7.x/docs/functions/getSingleItem.html new file mode 100644 index 000000000..c2005d5e2 --- /dev/null +++ b/7.x/docs/functions/getSingleItem.html @@ -0,0 +1,78 @@ +getSingleItem | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getSingleItem

+
+
    + +
  • +

    Converts the stream to a single object. +This assumes the stream is in object mode and only contains a single element, +otherwise an error will be thrown.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable
      +

      Object stream with single entry.

      +
      +
    +

    Returns Promise<unknown>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getTemplateFilePath.html b/7.x/docs/functions/getTemplateFilePath.html new file mode 100644 index 000000000..79a0037ca --- /dev/null +++ b/7.x/docs/functions/getTemplateFilePath.html @@ -0,0 +1,74 @@ +getTemplateFilePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getTemplateFilePath

+
+
    + +
  • +

    Returns the absolute path to the template. +Returns undefined if the input does not contain a file path.

    +
    +
    +

    Parameters

    +
    +

    Returns string | undefined

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getTypeWeight.html b/7.x/docs/functions/getTypeWeight.html new file mode 100644 index 000000000..62cbf3ad5 --- /dev/null +++ b/7.x/docs/functions/getTypeWeight.html @@ -0,0 +1,83 @@ +getTypeWeight | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getTypeWeight

+
+
    + +
  • +

    Tries to match the given type to the given preferences. +In case there are multiple matches the most specific one will be chosen as per RFC 7231.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      +

      Type for which the matching weight is needed.

      +
      +
    • +
    • +
      preferred: ValuePreferences
      +

      Preferences to match the type to.

      +
      +
    +

    Returns number

    The corresponding weight from the preferences or 0 if there is no match.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getWeightedPreferences.html b/7.x/docs/functions/getWeightedPreferences.html new file mode 100644 index 000000000..2f0b88a9b --- /dev/null +++ b/7.x/docs/functions/getWeightedPreferences.html @@ -0,0 +1,84 @@ +getWeightedPreferences | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getWeightedPreferences

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/guardStream.html b/7.x/docs/functions/guardStream.html new file mode 100644 index 000000000..e4dbfeb5b --- /dev/null +++ b/7.x/docs/functions/guardStream.html @@ -0,0 +1,87 @@ +guardStream | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function guardStream

+
+
    + +
  • +

    Makes sure that listeners always receive the error event of a stream, +even if it was thrown before the listener was attached.

    +

    When guarding a stream it is assumed that error listeners already attached should be ignored, +only error listeners attached after the stream is guarded will prevent an error from being logged.

    +

    If the input is already guarded the guard will be reset, +which means ignoring error listeners already attached.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends EventEmitter

    +
    +

    Parameters

    +
      +
    • +
      stream: T
      +

      Stream that can potentially throw an error.

      +
      +
    +

    Returns Guarded<T>

    The stream.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/guardedStreamFrom.html b/7.x/docs/functions/guardedStreamFrom.html new file mode 100644 index 000000000..e88a73010 --- /dev/null +++ b/7.x/docs/functions/guardedStreamFrom.html @@ -0,0 +1,81 @@ +guardedStreamFrom | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function guardedStreamFrom

+
+
    + +
  • +

    Converts a string or array to a stream and applies an error guard so that it is Guarded.

    +
    +
    +

    Parameters

    +
      +
    • +
      contents: string | Iterable<unknown>
      +

      Data to stream.

      +
      +
    • +
    • +
      Optional options: ReadableOptions
      +

      Options to pass to the Readable constructor. See Readable.from.

      +
      +
    +

    Returns Guarded<Readable>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/hasScheme.html b/7.x/docs/functions/hasScheme.html new file mode 100644 index 000000000..85c14cdc9 --- /dev/null +++ b/7.x/docs/functions/hasScheme.html @@ -0,0 +1,82 @@ +hasScheme | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function hasScheme

+
+
    + +
  • +

    Checks if the scheme part of the specified url matches at least one of the provided options.

    +
    +
    +

    Parameters

    +
      +
    • +
      url: string
      +

      A string representing the URL.

      +
      +
    • +
    • +
      Rest ...schemes: string[]
      +

      Scheme value options (the function will check whether at least one matches the URL scheme).

      +
      +
    +

    Returns boolean

    True if the URL scheme matches at least one of the provided options, false otherwise.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/identifierHashFn.html b/7.x/docs/functions/identifierHashFn.html new file mode 100644 index 000000000..c7a52a5df --- /dev/null +++ b/7.x/docs/functions/identifierHashFn.html @@ -0,0 +1,73 @@ +identifierHashFn | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function identifierHashFn

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/importOidcProvider.html b/7.x/docs/functions/importOidcProvider.html new file mode 100644 index 000000000..3cf1e302f --- /dev/null +++ b/7.x/docs/functions/importOidcProvider.html @@ -0,0 +1,74 @@ +importOidcProvider | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function importOidcProvider

+
+
    + +
  • +

    Import the OIDC-provider package.

    +

    As oidc-provider is an ESM package and CSS is CJS, we have to use a dynamic import here. +Unfortunately, there is a Node/Jest bug that causes segmentation faults when doing such an import in Jest: +https://github.com/nodejs/node/issues/35889 +To work around that, we do the import differently, in case we are in a Jest test run. +This can be detected via the env variables: https://jestjs.io/docs/environment-variables. +There have been reports of JEST_WORKER_ID being undefined, so to be sure we check both.

    +
    +

    Returns CanBePromise<__module>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isContainerIdentifier.html b/7.x/docs/functions/isContainerIdentifier.html new file mode 100644 index 000000000..ac5eef7e1 --- /dev/null +++ b/7.x/docs/functions/isContainerIdentifier.html @@ -0,0 +1,76 @@ +isContainerIdentifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isContainerIdentifier

+
+
    + +
  • +

    Checks whether the identifier corresponds to a container identifier.

    +
    +
    +

    Parameters

    +
    +

    Returns boolean

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isContainerPath.html b/7.x/docs/functions/isContainerPath.html new file mode 100644 index 000000000..e9fca675d --- /dev/null +++ b/7.x/docs/functions/isContainerPath.html @@ -0,0 +1,76 @@ +isContainerPath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isContainerPath

+
+
    + +
  • +

    Checks whether the path corresponds to a container path (ending in a /).

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check.

      +
      +
    +

    Returns boolean

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isError.html b/7.x/docs/functions/isError.html new file mode 100644 index 000000000..57dc97b5b --- /dev/null +++ b/7.x/docs/functions/isError.html @@ -0,0 +1,73 @@ +isError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isError

+
+
    + +
  • +

    Checks if the input is an Error.

    +
    +
    +

    Parameters

    +
      +
    • +
      error: unknown
    +

    Returns error is Error

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isGuarded.html b/7.x/docs/functions/isGuarded.html new file mode 100644 index 000000000..4731b3954 --- /dev/null +++ b/7.x/docs/functions/isGuarded.html @@ -0,0 +1,78 @@ +isGuarded | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isGuarded

+
+
    + +
  • +

    Determines whether the stream is guarded against emitting errors.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends EventEmitter

    +
    +

    Parameters

    +
      +
    • +
      stream: T
    +

    Returns stream is Guarded<T>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isHttpRequest.html b/7.x/docs/functions/isHttpRequest.html new file mode 100644 index 000000000..5734c0a64 --- /dev/null +++ b/7.x/docs/functions/isHttpRequest.html @@ -0,0 +1,73 @@ +isHttpRequest | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isHttpRequest

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isHttpsServer.html b/7.x/docs/functions/isHttpsServer.html new file mode 100644 index 000000000..177584bb9 --- /dev/null +++ b/7.x/docs/functions/isHttpsServer.html @@ -0,0 +1,73 @@ +isHttpsServer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isHttpsServer

+
+
    + +
  • +

    Returns true if the server is an HTTPS server.

    +
    +
    +

    Parameters

    +
      +
    • +
      server: Server<typeof IncomingMessage, typeof ServerResponse>
    +

    Returns server is Server<typeof IncomingMessage, typeof ServerResponse>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isInternalContentType.html b/7.x/docs/functions/isInternalContentType.html new file mode 100644 index 000000000..ae9ee7625 --- /dev/null +++ b/7.x/docs/functions/isInternalContentType.html @@ -0,0 +1,78 @@ +isInternalContentType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isInternalContentType

+
+
    + +
  • +

    Checks if the given content type is an internal content type such as internal/quads. +Response will be false if the input type is undefined.

    +

    Do not use this for media ranges.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional contentType: string
      +

      Type to check.

      +
      +
    +

    Returns boolean

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isPromise.html b/7.x/docs/functions/isPromise.html new file mode 100644 index 000000000..3ac69649d --- /dev/null +++ b/7.x/docs/functions/isPromise.html @@ -0,0 +1,81 @@ +isPromise | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isPromise

+
+
    + +
  • +

    Verifies if the given value is a Promise or not.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns object is Promise<T>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isRepresentationMetadata.html b/7.x/docs/functions/isRepresentationMetadata.html new file mode 100644 index 000000000..534154921 --- /dev/null +++ b/7.x/docs/functions/isRepresentationMetadata.html @@ -0,0 +1,73 @@ +isRepresentationMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isRepresentationMetadata

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isResourceIdentifier.html b/7.x/docs/functions/isResourceIdentifier.html new file mode 100644 index 000000000..b9bc4f1c3 --- /dev/null +++ b/7.x/docs/functions/isResourceIdentifier.html @@ -0,0 +1,73 @@ +isResourceIdentifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isResourceIdentifier

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isSystemError.html b/7.x/docs/functions/isSystemError.html new file mode 100644 index 000000000..d75d6a039 --- /dev/null +++ b/7.x/docs/functions/isSystemError.html @@ -0,0 +1,70 @@ +isSystemError | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/functions/isTerm.html b/7.x/docs/functions/isTerm.html new file mode 100644 index 000000000..873422f29 --- /dev/null +++ b/7.x/docs/functions/isTerm.html @@ -0,0 +1,74 @@ +isTerm | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isTerm

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional input: unknown
      +

      Checks if this is a Term.

      +
      +
    +

    Returns input is Term

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isUrl.html b/7.x/docs/functions/isUrl.html new file mode 100644 index 000000000..5f0199563 --- /dev/null +++ b/7.x/docs/functions/isUrl.html @@ -0,0 +1,77 @@ +isUrl | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isUrl

+
+
    + +
  • +

    Checks whether the given string is a valid URL.

    +
    +
    +

    Parameters

    +
      +
    • +
      url: string
      +

      String to check.

      +
      +
    +

    Returns boolean

    True if the string is a valid URL.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isValidFileName.html b/7.x/docs/functions/isValidFileName.html new file mode 100644 index 000000000..31cff0fe5 --- /dev/null +++ b/7.x/docs/functions/isValidFileName.html @@ -0,0 +1,77 @@ +isValidFileName | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isValidFileName

+
+
    + +
  • +

    Checks the validity of a file name. A valid name consists of word characters, '-' or '.'.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +

      The name of the file to validate.

      +
      +
    +

    Returns boolean

    True if the filename is valid, false otherwise.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isValidVariable.html b/7.x/docs/functions/isValidVariable.html new file mode 100644 index 000000000..a2b5177bd --- /dev/null +++ b/7.x/docs/functions/isValidVariable.html @@ -0,0 +1,74 @@ +isValidVariable | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isValidVariable

+
+
    + +
  • +

    Checks if the given variable is one that is supported. +This can be used to weed out irrelevant parameters in an object.

    +
    +
    +

    Parameters

    +
      +
    • +
      variable: string
    +

    Returns boolean

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isWebSocket2023Channel.html b/7.x/docs/functions/isWebSocket2023Channel.html new file mode 100644 index 000000000..00c97fb99 --- /dev/null +++ b/7.x/docs/functions/isWebSocket2023Channel.html @@ -0,0 +1,70 @@ +isWebSocket2023Channel | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/functions/isWebhook2023Channel.html b/7.x/docs/functions/isWebhook2023Channel.html new file mode 100644 index 000000000..b583a2db7 --- /dev/null +++ b/7.x/docs/functions/isWebhook2023Channel.html @@ -0,0 +1,70 @@ +isWebhook2023Channel | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/functions/joinFilePath.html b/7.x/docs/functions/joinFilePath.html new file mode 100644 index 000000000..ec46f92ab --- /dev/null +++ b/7.x/docs/functions/joinFilePath.html @@ -0,0 +1,82 @@ +joinFilePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function joinFilePath

+
+
    + +
  • +

    Adds the paths to the base path.

    +
    +
    +

    Parameters

    +
      +
    • +
      basePath: string
      +

      The base path (POSIX or Windows).

      +
      +
    • +
    • +
      Rest ...paths: string[]
      +

      Subpaths to attach (POSIX).

      +
      +
    +

    Returns string

    The potentially changed path (POSIX).

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/joinUrl.html b/7.x/docs/functions/joinUrl.html new file mode 100644 index 000000000..68b7df0e2 --- /dev/null +++ b/7.x/docs/functions/joinUrl.html @@ -0,0 +1,88 @@ +joinUrl | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function joinUrl

+
+
    + +
  • +

    Concatenates all the given strings into a normalized URL. +Will place slashes between input strings if necessary.

    +
    +
    +

    Parameters

    +
      +
    • +
      Rest ...parts: string[]
    +

    Returns string

    +
  • + +
  • +

    Concatenates all the given strings into a normalized URL. +Will place slashes between input strings if necessary.

    +
    +
    +

    Parameters

    +
      +
    • +
      parts: string[]
    +

    Returns string

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/listSingleThreadedComponents.html b/7.x/docs/functions/listSingleThreadedComponents.html new file mode 100644 index 000000000..786724130 --- /dev/null +++ b/7.x/docs/functions/listSingleThreadedComponents.html @@ -0,0 +1,82 @@ +listSingleThreadedComponents | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function listSingleThreadedComponents

+
+
    + +
  • +

    Will list class names of components instantiated implementing the SingleThreaded +interface while the application is being run in multithreaded mode.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      componentsManager: ComponentsManager<T>
      +

      The componentsManager being used to set up the application

      +
      +
    +

    Returns Promise<string[]>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/map.html b/7.x/docs/functions/map.html new file mode 100644 index 000000000..b14717901 --- /dev/null +++ b/7.x/docs/functions/map.html @@ -0,0 +1,108 @@ +map | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function map

+
+
    + +
  • +

    Creates a new iterable with the results of calling a provided function on every element in the calling array. +Similar to the Array.prototype.map function. +See the documentation of the above function for more details.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

    • +
    • +

      TOut

    +
    +

    Parameters

    +
      +
    • +
      iterable: Iterable<TIn>
      +

      Iterable on which to call the map function.

      +
      +
    • +
    • +
      callbackFn: ((element, index) => TOut)
      +

      Function that is called for every element.

      +
      +
      +
        +
      • +
          +
        • (element, index): TOut
        • +
        • +
          +

          Parameters

          +
            +
          • +
            element: TIn
          • +
          • +
            index: number
          +

          Returns TOut

    • +
    • +
      Optional thisArg: unknown
      +

      Value to use as this when executing callbackFn.

      +
      +
    +

    Returns Iterable<TOut>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/matchesAuthorizationScheme.html b/7.x/docs/functions/matchesAuthorizationScheme.html new file mode 100644 index 000000000..23a13b59a --- /dev/null +++ b/7.x/docs/functions/matchesAuthorizationScheme.html @@ -0,0 +1,82 @@ +matchesAuthorizationScheme | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function matchesAuthorizationScheme

+
+
    + +
  • +

    Checks if the value of an HTTP Authorization header matches a specific scheme (e.g. Basic, Bearer, etc).

    +
    +
    +

    Parameters

    +
      +
    • +
      scheme: string
      +

      Name of the authorization scheme (case insensitive).

      +
      +
    • +
    • +
      Optional authorization: string
      +

      The value of the Authorization header (may be undefined).

      +
      +
    +

    Returns boolean

    True if the Authorization header uses the specified scheme, false otherwise.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/matchesMediaPreferences.html b/7.x/docs/functions/matchesMediaPreferences.html new file mode 100644 index 000000000..1248c0826 --- /dev/null +++ b/7.x/docs/functions/matchesMediaPreferences.html @@ -0,0 +1,81 @@ +matchesMediaPreferences | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function matchesMediaPreferences

+
+
    + +
  • +

    Checks if the given type matches the given preferences.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      +

      Type to match.

      +
      +
    • +
    • +
      Optional preferred: ValuePreferences
      +

      Preferences to match against.

      +
      +
    +

    Returns boolean

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/matchesMediaType.html b/7.x/docs/functions/matchesMediaType.html new file mode 100644 index 000000000..46b19f1ed --- /dev/null +++ b/7.x/docs/functions/matchesMediaType.html @@ -0,0 +1,83 @@ +matchesMediaType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function matchesMediaType

+
+
    + +
  • +

    Checks whether the given two media types/ranges match each other. +Takes wildcards into account.

    +
    +
    +

    Parameters

    +
      +
    • +
      mediaA: string
      +

      Media type to match.

      +
      +
    • +
    • +
      mediaB: string
      +

      Media type to match.

      +
      +
    +

    Returns boolean

    True if the media type patterns can match each other.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/modify.html b/7.x/docs/functions/modify.html new file mode 100644 index 000000000..c6e55efa8 --- /dev/null +++ b/7.x/docs/functions/modify.html @@ -0,0 +1,87 @@ +modify | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function modify

+
+
    + +
  • +

    Modifies a SetMultiMap in place by removing and adding the requested entries. +Removals happen before additions.

    +
    +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
    +

    Returns T

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/modulePath.html b/7.x/docs/functions/modulePath.html new file mode 100644 index 000000000..40381c0a2 --- /dev/null +++ b/7.x/docs/functions/modulePath.html @@ -0,0 +1,74 @@ +modulePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function modulePath

+
+
    + +
  • +

    Creates a path starting from the @solid/community-server module root, +to be resolved by the resolveAssetPath function.

    +
    +
    +

    Parameters

    +
      +
    • +
      relativePath: string = ''
    +

    Returns string

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/msToDuration.html b/7.x/docs/functions/msToDuration.html new file mode 100644 index 000000000..0389189ab --- /dev/null +++ b/7.x/docs/functions/msToDuration.html @@ -0,0 +1,78 @@ +msToDuration | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function msToDuration

+
+
    + +
  • +

    Converts milliseconds to an ISO 8601 duration string. +The only categories used are days, hours, minutes, and seconds, +because months have no fixed size in milliseconds.

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
      +

      The duration in ms to convert.

      +
      +
    +

    Returns string

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/normalizeFilePath.html b/7.x/docs/functions/normalizeFilePath.html new file mode 100644 index 000000000..ecf17bbe0 --- /dev/null +++ b/7.x/docs/functions/normalizeFilePath.html @@ -0,0 +1,77 @@ +normalizeFilePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function normalizeFilePath

+
+
    + +
  • +

    Resolves relative segments in the path.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check (POSIX or Windows).

      +
      +
    +

    Returns string

    The potentially changed path (POSIX).

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseAccept.html b/7.x/docs/functions/parseAccept.html new file mode 100644 index 000000000..351d519a6 --- /dev/null +++ b/7.x/docs/functions/parseAccept.html @@ -0,0 +1,83 @@ +parseAccept | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseAccept

+
+
    + +
  • +

    Parses an Accept header string.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept header string.

      +
      +
    • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns Accept[]

    An array of Accept objects, sorted by weight. Accept parts +with invalid syntax are ignored and removed from the returned array.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseAcceptCharset.html b/7.x/docs/functions/parseAcceptCharset.html new file mode 100644 index 000000000..43d003920 --- /dev/null +++ b/7.x/docs/functions/parseAcceptCharset.html @@ -0,0 +1,83 @@ +parseAcceptCharset | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseAcceptCharset

+
+
    + +
  • +

    Parses an Accept-Charset header string.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept-Charset header string.

      +
      +
    • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns AcceptCharset[]

    An array of AcceptCharset objects, sorted by weight. Invalid ranges +are ignored and not returned.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseAcceptDateTime.html b/7.x/docs/functions/parseAcceptDateTime.html new file mode 100644 index 000000000..7940d325c --- /dev/null +++ b/7.x/docs/functions/parseAcceptDateTime.html @@ -0,0 +1,83 @@ +parseAcceptDateTime | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseAcceptDateTime

+
+
    + +
  • +

    Parses an Accept-DateTime header string.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept-DateTime header string.

      +
      +
    • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns AcceptDatetime[]

    An array with a single AcceptDatetime object, +or an empty array if a range in an invalid format is detected.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseAcceptEncoding.html b/7.x/docs/functions/parseAcceptEncoding.html new file mode 100644 index 000000000..ce97529ca --- /dev/null +++ b/7.x/docs/functions/parseAcceptEncoding.html @@ -0,0 +1,83 @@ +parseAcceptEncoding | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseAcceptEncoding

+
+
    + +
  • +

    Parses an Accept-Encoding header string.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept-Encoding header string.

      +
      +
    • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns AcceptEncoding[]

    An array of AcceptEncoding objects, sorted by weight. Invalid ranges +are ignored and not returned.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseAcceptLanguage.html b/7.x/docs/functions/parseAcceptLanguage.html new file mode 100644 index 000000000..792a5cc27 --- /dev/null +++ b/7.x/docs/functions/parseAcceptLanguage.html @@ -0,0 +1,83 @@ +parseAcceptLanguage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseAcceptLanguage

+
+
    + +
  • +

    Parses an Accept-Language header string.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept-Language header string.

      +
      +
    • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns AcceptLanguage[]

    An array of AcceptLanguage objects, sorted by weight. Invalid ranges +are ignored and not returned.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseContentType.html b/7.x/docs/functions/parseContentType.html new file mode 100644 index 000000000..ad99cf842 --- /dev/null +++ b/7.x/docs/functions/parseContentType.html @@ -0,0 +1,80 @@ +parseContentType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseContentType

+
+
    + +
  • +

    Parses the Content-Type header and also parses any parameters in the header.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Content-Type header string.

      +
      +
    +

    Returns ContentType

    A ContentType object containing the value and optional parameters.

    + +
    +

    Throws

    BadRequestHttpError +Thrown on invalid header syntax.

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseForwarded.html b/7.x/docs/functions/parseForwarded.html new file mode 100644 index 000000000..ad0fedf91 --- /dev/null +++ b/7.x/docs/functions/parseForwarded.html @@ -0,0 +1,77 @@ +parseForwarded | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseForwarded

+
+
    + +
  • +

    Parses a Forwarded header value and will fall back to X-Forwarded-* headers.

    +
    +
    +

    Parameters

    +
      +
    • +
      headers: IncomingHttpHeaders
      +

      The incoming HTTP headers.

      +
      +
    +

    Returns Forwarded

    The parsed Forwarded header.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseLinkHeader.html b/7.x/docs/functions/parseLinkHeader.html new file mode 100644 index 000000000..2ec6ed21c --- /dev/null +++ b/7.x/docs/functions/parseLinkHeader.html @@ -0,0 +1,77 @@ +parseLinkHeader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseLinkHeader

+
+
    + +
  • +

    Parses the link header(s) and returns an array of LinkEntry objects.

    +
    +
    +

    Parameters

    +
      +
    • +
      link: string | string[] = []
      +

      A single link header or an array of link headers

      +
      +
    +

    Returns LinkEntry[]

    A LinkEntry array, LinkEntry contains a link and a params Record<string,string>

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseParameters.html b/7.x/docs/functions/parseParameters.html new file mode 100644 index 000000000..562d0295d --- /dev/null +++ b/7.x/docs/functions/parseParameters.html @@ -0,0 +1,88 @@ +parseParameters | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseParameters

+
+
    + +
  • +

    Parses a list of split parameters and checks their validity. Parameters with invalid +syntax are ignored and not returned.

    +
    +
    +

    Parameters

    +
      +
    • +
      parameters: string[]
      +

      A list of split parameters (token [ "=" ( token / quoted-string ) ])

      +
      +
    • +
    • +
      replacements: Record<string, string>
      +

      The double quoted strings that need to be replaced.

      +
      +
    • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns {
        name: string;
        value: string;
    }[]

    An array of name/value objects corresponding to the parameters.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parsePath.html b/7.x/docs/functions/parsePath.html new file mode 100644 index 000000000..34b0afef2 --- /dev/null +++ b/7.x/docs/functions/parsePath.html @@ -0,0 +1,88 @@ +parsePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parsePath

+
+
    + +
  • +

    Parses the given path with the given InteractionRoute. +This assumes this call will succeed and thus expects the path to have the correct format. +If not, a 500 error will be thrown.

    +
    +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
      +
    • +
      route: T
      +

      Route to parse with.

      +
      +
    • +
    • +
      path: string
      +

      Path to parse.

      +
      +
    +

    Returns NonNullable<ReturnType<T["matchPath"]>>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseQuads.html b/7.x/docs/functions/parseQuads.html new file mode 100644 index 000000000..173b51b1b --- /dev/null +++ b/7.x/docs/functions/parseQuads.html @@ -0,0 +1,82 @@ +parseQuads | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseQuads

+
+
    + +
  • +

    Helper function to convert a Readable into an array of quads.

    +
    +
    +

    Parameters

    +
      +
    • +
      readable: Guarded<Readable>
      +

      The readable object.

      +
      +
    • +
    • +
      options: ParserOptions = {}
      +

      Options for the parser.

      +
      +
    +

    Returns Promise<Quad[]>

    A promise containing the array of quads.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseSchema.html b/7.x/docs/functions/parseSchema.html new file mode 100644 index 000000000..d0118edf7 --- /dev/null +++ b/7.x/docs/functions/parseSchema.html @@ -0,0 +1,78 @@ +parseSchema | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseSchema

+
+
    + +
  • +

    Generates a simplified representation of a yup schema.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends BaseObjectSchema

    +
    +

    Parameters

    +
      +
    • +
      schema: T
    +

    Returns Pick<SchemaType<T>, "fields">

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseWebSocketRequest.html b/7.x/docs/functions/parseWebSocketRequest.html new file mode 100644 index 000000000..afe6905e2 --- /dev/null +++ b/7.x/docs/functions/parseWebSocketRequest.html @@ -0,0 +1,81 @@ +parseWebSocketRequest | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseWebSocketRequest

+
+
    + +
  • +

    Parses a IncomingMessage to extract its path used for authentication.

    +
    +
    +

    Parameters

    +
      +
    • +
      baseUrl: string
      +

      The base URL of the server.

      +
      +
    • +
    • +
      request: IncomingMessage
      +

      The request to parse.

      +
      +
    +

    Returns string

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/pipeSafely.html b/7.x/docs/functions/pipeSafely.html new file mode 100644 index 000000000..959696529 --- /dev/null +++ b/7.x/docs/functions/pipeSafely.html @@ -0,0 +1,105 @@ +pipeSafely | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function pipeSafely

+
+
    + +
  • +

    Pipes one stream into another and emits errors of the first stream with the second. +If the first stream errors, the second one will be destroyed with the given error. +This will also make the stream Guarded.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends Writable

    +
    +

    Parameters

    +
      +
    • +
      readable: ReadableStream
      +

      Initial readable stream.

      +
      +
    • +
    • +
      destination: T
      +

      The destination for writing data.

      +
      +
    • +
    • +
      Optional mapError: ((error) => Error)
      +

      Optional function that takes the error and converts it to a new error.

      +
      +
      +
        +
      • +
          +
        • (error): Error
        • +
        • +
          +

          Parameters

          +
            +
          • +
            error: Error
          +

          Returns Error

    +

    Returns Guarded<T>

    The destination stream.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/preferencesToString.html b/7.x/docs/functions/preferencesToString.html new file mode 100644 index 000000000..440f96815 --- /dev/null +++ b/7.x/docs/functions/preferencesToString.html @@ -0,0 +1,76 @@ +preferencesToString | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function preferencesToString

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/promiseSome.html b/7.x/docs/functions/promiseSome.html new file mode 100644 index 000000000..c0c78b29a --- /dev/null +++ b/7.x/docs/functions/promiseSome.html @@ -0,0 +1,82 @@ +promiseSome | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function promiseSome

+
+
    + +
  • +

    A function that simulates the Array.some behaviour but on an array of Promises. +Returns true if at least one promise returns true. +Returns false if all promises return false or error.

    +
    +
    +

    Parameters

    +
      +
    • +
      predicates: Promise<boolean>[]
    +

    Returns Promise<boolean>

    +
    +

    Remarks

    Predicates provided as input must be implemented considering +the following points:

    +
      +
    1. if they throw an error, it won't be propagated;
    2. +
    3. throwing an error should be logically equivalent to returning false.
    4. +
    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/readJsonStream.html b/7.x/docs/functions/readJsonStream.html new file mode 100644 index 000000000..70d835ff7 --- /dev/null +++ b/7.x/docs/functions/readJsonStream.html @@ -0,0 +1,77 @@ +readJsonStream | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function readJsonStream

+
+
    + +
  • +

    Interprets the stream as JSON and converts it to a Dict.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable
      +

      Stream of JSON data.

      +
      +
    +

    Returns Promise<Json>

    The parsed object.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/readPackageJson.html b/7.x/docs/functions/readPackageJson.html new file mode 100644 index 000000000..4790002ae --- /dev/null +++ b/7.x/docs/functions/readPackageJson.html @@ -0,0 +1,68 @@ +readPackageJson | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function readPackageJson

+
+
    + +
  • +

    Reads the project package.json and returns it.

    +
    +

    Returns Promise<Record<string, Json>>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/readTemplate.html b/7.x/docs/functions/readTemplate.html new file mode 100644 index 000000000..cbab09163 --- /dev/null +++ b/7.x/docs/functions/readTemplate.html @@ -0,0 +1,73 @@ +readTemplate | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function readTemplate

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/readableToQuads.html b/7.x/docs/functions/readableToQuads.html new file mode 100644 index 000000000..36ff14c09 --- /dev/null +++ b/7.x/docs/functions/readableToQuads.html @@ -0,0 +1,77 @@ +readableToQuads | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function readableToQuads

+
+
    + +
  • +

    Imports quads from a stream into a Store.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable
      +

      Stream of quads.

      +
      +
    +

    Returns Promise<Store>

    A Store containing all the quads.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/readableToString.html b/7.x/docs/functions/readableToString.html new file mode 100644 index 000000000..f80cfbaab --- /dev/null +++ b/7.x/docs/functions/readableToString.html @@ -0,0 +1,77 @@ +readableToString | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function readableToString

+
+
    + +
  • +

    Joins all strings of a stream.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable
      +

      Stream of strings.

      +
      +
    +

    Returns Promise<string>

    The joined string.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/reduce.html b/7.x/docs/functions/reduce.html new file mode 100644 index 000000000..92ebb2eba --- /dev/null +++ b/7.x/docs/functions/reduce.html @@ -0,0 +1,152 @@ +reduce | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function reduce

+
+
    + +
  • +

    Similar to the Array.prototype.reduce function, but for an iterable. +See the documentation of the above function for more details. +The first element will be used as the initial value.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

    +
    +

    Parameters

    +
      +
    • +
      iterable: Iterable<TIn>
      +

      Iterable of which to reduce the elements.

      +
      +
    • +
    • +
      callbackFn: ((previousValue, currentValue, currentIndex) => TIn)
      +

      A reducer function.

      +
      +
      +
        +
      • +
          +
        • (previousValue, currentValue, currentIndex): TIn
        • +
        • +
          +

          Parameters

          +
            +
          • +
            previousValue: TIn
          • +
          • +
            currentValue: TIn
          • +
          • +
            currentIndex: number
          +

          Returns TIn

    +

    Returns TIn

    +
  • + +
  • +

    Similar to the Array.prototype.reduce function, but for an iterable. +See the documentation of the above function for more details.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

    • +
    • +

      TOut

    +
    +

    Parameters

    +
      +
    • +
      iterable: Iterable<TIn>
      +

      Iterable of which to reduce the elements.

      +
      +
    • +
    • +
      callbackFn: ((previousValue, currentValue, currentIndex) => TOut)
      +

      A reducer function.

      +
      +
      +
        +
      • +
          +
        • (previousValue, currentValue, currentIndex): TOut
        • +
        • +
          +

          Parameters

          +
            +
          • +
            previousValue: TOut
          • +
          • +
            currentValue: TIn
          • +
          • +
            currentIndex: number
          +

          Returns TOut

    • +
    • +
      initialValue: TOut
      +

      The value to start from.

      +
      +
    +

    Returns TOut

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/resetInternalLoggerFactory.html b/7.x/docs/functions/resetInternalLoggerFactory.html new file mode 100644 index 000000000..16b302d19 --- /dev/null +++ b/7.x/docs/functions/resetInternalLoggerFactory.html @@ -0,0 +1,74 @@ +resetInternalLoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function resetInternalLoggerFactory

+
+
    + +
  • +

    Resets the internal logger factory, which holds the global logger factory. +For testing purposes only.

    +
    +
    +

    Parameters

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/resolveAssetPath.html b/7.x/docs/functions/resolveAssetPath.html new file mode 100644 index 000000000..b8f5ae315 --- /dev/null +++ b/7.x/docs/functions/resolveAssetPath.html @@ -0,0 +1,75 @@ +resolveAssetPath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function resolveAssetPath

+
+
    + +
  • +

    Converts file path inputs into absolute paths. +Works similar to absoluteFilePath but paths that start with the modulePathPlaceholder +will be relative to the module directory instead of the cwd.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string = modulePathPlaceholder
    +

    Returns string

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/resolveModulePath.html b/7.x/docs/functions/resolveModulePath.html new file mode 100644 index 000000000..a35223ea7 --- /dev/null +++ b/7.x/docs/functions/resolveModulePath.html @@ -0,0 +1,73 @@ +resolveModulePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function resolveModulePath

+
+
    + +
  • +

    Creates an absolute path starting from the @solid/community-server module root.

    +
    +
    +

    Parameters

    +
      +
    • +
      relativePath: string = ''
    +

    Returns string

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/resolvePromiseOrValue.html b/7.x/docs/functions/resolvePromiseOrValue.html new file mode 100644 index 000000000..4cdcc1c01 --- /dev/null +++ b/7.x/docs/functions/resolvePromiseOrValue.html @@ -0,0 +1,95 @@ +resolvePromiseOrValue | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function resolvePromiseOrValue

+
+
    + +
  • +

    Calls callback with the resolved value of object. +In case object is a Promise, the result will also be a Promise, +otherwise the result will be sync.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

    • +
    • +

      TOut

    +
    +

    Parameters

    +
      +
    • +
      object: PromiseOrValue<TIn>
    • +
    • +
      callback: ((val) => TOut)
      +
        +
      • +
          +
        • (val): TOut
        • +
        • +
          +

          Parameters

          +
            +
          • +
            val: TIn
          +

          Returns TOut

    +

    Returns PromiseOrValue<TOut>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/responseToDataset.html b/7.x/docs/functions/responseToDataset.html new file mode 100644 index 000000000..f02c1f474 --- /dev/null +++ b/7.x/docs/functions/responseToDataset.html @@ -0,0 +1,80 @@ +responseToDataset | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function responseToDataset

+
+
    + +
  • +

    Converts a given Response (from a request that was already made) to an RDF dataset. +In case the given Response object was already parsed its body can be passed along as a string.

    +

    The converter will be used to convert the response body to RDF.

    +

    Response will be a Representation with content-type internal/quads.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Representation>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/sanitizeUrlPart.html b/7.x/docs/functions/sanitizeUrlPart.html new file mode 100644 index 000000000..ff10fb081 --- /dev/null +++ b/7.x/docs/functions/sanitizeUrlPart.html @@ -0,0 +1,77 @@ +sanitizeUrlPart | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function sanitizeUrlPart

+
+
    + +
  • +

    Sanitizes part of a URL by replacing non-word content with a '-'.

    +
    +
    +

    Parameters

    +
      +
    • +
      urlPart: string
      +

      The URL part to sanitize.

      +
      +
    +

    Returns string

    The sanitized output.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/serializeQuads.html b/7.x/docs/functions/serializeQuads.html new file mode 100644 index 000000000..885ba9e6f --- /dev/null +++ b/7.x/docs/functions/serializeQuads.html @@ -0,0 +1,82 @@ +serializeQuads | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function serializeQuads

+
+
    + +
  • +

    Helper function for serializing an array of quads, with as result a Readable object.

    +
    +
    +

    Parameters

    +
      +
    • +
      quads: Quad[]
      +

      The array of quads.

      +
      +
    • +
    • +
      Optional contentType: string
      +

      The content-type to serialize to.

      +
      +
    +

    Returns Guarded<Readable>

    The Readable object.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/setGlobalLoggerFactory.html b/7.x/docs/functions/setGlobalLoggerFactory.html new file mode 100644 index 000000000..ce44a04ed --- /dev/null +++ b/7.x/docs/functions/setGlobalLoggerFactory.html @@ -0,0 +1,77 @@ +setGlobalLoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function setGlobalLoggerFactory

+
+
    + +
  • +

    Sets the global logger factory. +This causes loggers created by getLoggerFor to delegate to a logger from the given factory.

    +
    +
    +

    Parameters

    +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/setSafeInterval.html b/7.x/docs/functions/setSafeInterval.html new file mode 100644 index 000000000..9ff607a5d --- /dev/null +++ b/7.x/docs/functions/setSafeInterval.html @@ -0,0 +1,100 @@ +setSafeInterval | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function setSafeInterval

+
+
    + +
  • +

    Wraps the callback for setInterval so errors get caught and logged. +Parameters are identical to the setInterval parameters starting from the 3rd argument. +The logger and message will be used when the callback throws an error. +Supports asynchronous callback functions.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TArgs

    +
    +

    Parameters

    +
      +
    • +
      logger: Logger
    • +
    • +
      message: string
    • +
    • +
      callback: ((...cbArgs) => void | Promise<void>)
      +
        +
      • +
          +
        • (...cbArgs): void | Promise<void>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...cbArgs: TArgs[]
          +

          Returns void | Promise<void>

    • +
    • +
      Optional ms: number
    • +
    • +
      Rest ...args: TArgs[]
    +

    Returns NodeJS.Timeout

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/sortedAsyncMerge.html b/7.x/docs/functions/sortedAsyncMerge.html new file mode 100644 index 000000000..8e4961c3a --- /dev/null +++ b/7.x/docs/functions/sortedAsyncMerge.html @@ -0,0 +1,100 @@ +sortedAsyncMerge | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function sortedAsyncMerge

+
+
    + +
  • +

    Merges the results of several sorted iterators. +In case the results of the individual iterators are not sorted the outcome results will also not be sorted.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      iterators: AsyncIterator<T, any, undefined>[]
      +

      The iterators whose results need to be merged.

      +
      +
    • +
    • +
      Optional comparator: ((left, right) => number)
      +

      The comparator to use to compare the results.

      +
      +
      +
        +
      • +
          +
        • (left, right): number
        • +
        • +
          +

          Parameters

          +
            +
          • +
            left: T
          • +
          • +
            right: T
          +

          Returns number

    +

    Returns AsyncIterable<T>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/splitAndClean.html b/7.x/docs/functions/splitAndClean.html new file mode 100644 index 000000000..a72ae3761 --- /dev/null +++ b/7.x/docs/functions/splitAndClean.html @@ -0,0 +1,77 @@ +splitAndClean | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function splitAndClean

+
+
    + +
  • +

    Splits the input string on commas, trims all parts and filters out empty ones.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      Input header string.

      +
      +
    +

    Returns string[]

    An array of trimmed strings.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/splitCommaSeparated.html b/7.x/docs/functions/splitCommaSeparated.html new file mode 100644 index 000000000..11abac413 --- /dev/null +++ b/7.x/docs/functions/splitCommaSeparated.html @@ -0,0 +1,77 @@ +splitCommaSeparated | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function splitCommaSeparated

+
+
    + +
  • +

    Splits a string by comma.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      String instance to split.

      +
      +
    +

    Returns string[]

    A String array containining the split parts.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/termToInt.html b/7.x/docs/functions/termToInt.html new file mode 100644 index 000000000..2b8193903 --- /dev/null +++ b/7.x/docs/functions/termToInt.html @@ -0,0 +1,81 @@ +termToInt | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function termToInt

+
+
    + +
  • +

    Converts a term to a number. Returns undefined if the term was undefined.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional term: Term
      +

      Term to parse.

      +
      +
    • +
    • +
      radix: number = 10
      +

      Radix to use when parsing. Default is 10.

      +
      +
    +

    Returns number | undefined

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toCanonicalUriPath.html b/7.x/docs/functions/toCanonicalUriPath.html new file mode 100644 index 000000000..0d5c75307 --- /dev/null +++ b/7.x/docs/functions/toCanonicalUriPath.html @@ -0,0 +1,80 @@ +toCanonicalUriPath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toCanonicalUriPath

+
+
    + +
  • +

    Converts a URI path to the canonical version by splitting on slashes, +decoding any percent-based encodings, and then encoding any special characters. +This function is used to clean unwanted characters in the components of +the provided path.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to convert to its canonical URI path form.

      +
      +
    +

    Returns string

    The canonical URI path form of the provided path.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toComponentsJsType.html b/7.x/docs/functions/toComponentsJsType.html new file mode 100644 index 000000000..f74d359c9 --- /dev/null +++ b/7.x/docs/functions/toComponentsJsType.html @@ -0,0 +1,87 @@ +toComponentsJsType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toComponentsJsType

+
+
    + +
  • +

    Convert an exported interface name to the properly expected Components.js type URI.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      componentsManager: ComponentsManager<T>
      +

      The currently used ComponentsManager

      +
      +
    • +
    • +
      interfaceName: string
      +

      An interface name

      +
      +
    +

    Returns Promise<string>

    A Components.js type URI

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toLiteral.html b/7.x/docs/functions/toLiteral.html new file mode 100644 index 000000000..340fd8c73 --- /dev/null +++ b/7.x/docs/functions/toLiteral.html @@ -0,0 +1,81 @@ +toLiteral | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toLiteral

+
+
    + +
  • +

    Creates a literal by first converting the dataType string to a named node.

    +
    +
    +

    Parameters

    +
      +
    • +
      object: string | number
      +

      Object value.

      +
      +
    • +
    • +
      dataType: NamedNode<string>
      +

      Object data type (as string).

      +
      +
    +

    Returns Literal

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toNamedTerm.html b/7.x/docs/functions/toNamedTerm.html new file mode 100644 index 000000000..25f080df0 --- /dev/null +++ b/7.x/docs/functions/toNamedTerm.html @@ -0,0 +1,106 @@ +toNamedTerm | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toNamedTerm

+
+
    + +
  • +

    Converts a string to a named node when needed.

    +
    +
    +

    Parameters

    +
      +
    • +
      subject: string
      +

      Subject to potentially transform.

      +
      +
    +

    Returns NamedNode

    +
  • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      subject: T
    +

    Returns T

  • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      subject: string | T
    +

    Returns T | NamedNode

+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toObjectTerm.html b/7.x/docs/functions/toObjectTerm.html new file mode 100644 index 000000000..c7ff04e29 --- /dev/null +++ b/7.x/docs/functions/toObjectTerm.html @@ -0,0 +1,115 @@ +toObjectTerm | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toObjectTerm

+
+
    + +
  • +

    Converts an object term when needed.

    +
    +
    +

    Parameters

    +
      +
    • +
      object: string
      +

      Object to potentially transform.

      +
      +
    • +
    • +
      Optional preferLiteral: boolean
      +

      Whether strings are converted to literals or named nodes.

      +
      +
    +

    Returns NamedNode

    +
  • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      object: T
    • +
    • +
      Optional preferLiteral: boolean
    +

    Returns T

  • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      object: string | T
    • +
    • +
      Optional preferLiteral: boolean
    +

    Returns T | NamedNode

+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toPredicateTerm.html b/7.x/docs/functions/toPredicateTerm.html new file mode 100644 index 000000000..37d3c7898 --- /dev/null +++ b/7.x/docs/functions/toPredicateTerm.html @@ -0,0 +1,106 @@ +toPredicateTerm | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toPredicateTerm

+
+
    + +
  • +

    Converts a string to a named node when needed.

    +
    +
    +

    Parameters

    +
      +
    • +
      subject: string
      +

      Subject to potentially transform.

      +
      +
    +

    Returns NamedNode

    +
  • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      subject: T
    +

    Returns T

  • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      subject: string | T
    +

    Returns T | NamedNode

+
+
\ No newline at end of file diff --git a/7.x/docs/functions/transformQuotedStrings.html b/7.x/docs/functions/transformQuotedStrings.html new file mode 100644 index 000000000..8894e7aa3 --- /dev/null +++ b/7.x/docs/functions/transformQuotedStrings.html @@ -0,0 +1,85 @@ +transformQuotedStrings | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function transformQuotedStrings

+
+
    + +
  • +

    Replaces all double quoted strings in the input string with "0", "1", etc.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept header string.

      +
      +
    +

    Returns {
        replacements: Record<string, string>;
        result: string;
    }

    The transformed string and a map with keys "0", etc. and values the original string that was there.

    + +
      +
    • +
      replacements: Record<string, string>
    • +
    • +
      result: string
    +
    +

    Throws

    BadRequestHttpError +Thrown if invalid characters are detected in a quoted string.

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/transformSafely.html b/7.x/docs/functions/transformSafely.html new file mode 100644 index 000000000..200d4c291 --- /dev/null +++ b/7.x/docs/functions/transformSafely.html @@ -0,0 +1,87 @@ +transformSafely | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function transformSafely

+
+
    + +
  • +

    Transforms a stream, ensuring that all errors are forwarded.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = unknown

    +
    +

    Parameters

    +
      +
    • +
      source: ReadableStream
      +

      The stream to be transformed.

      +
      +
    • +
    • +
      options: AsyncTransformOptions<T> = {}
      +

      The transformation options.

      +
      +
    +

    Returns Guarded<Transform>

    The transformed stream

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/trimLeadingSlashes.html b/7.x/docs/functions/trimLeadingSlashes.html new file mode 100644 index 000000000..c6cfdf6d1 --- /dev/null +++ b/7.x/docs/functions/trimLeadingSlashes.html @@ -0,0 +1,77 @@ +trimLeadingSlashes | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function trimLeadingSlashes

+
+
    + +
  • +

    Makes sure the input path has no slashes at the beginning.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check.

      +
      +
    +

    Returns string

    The potentially changed path.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/trimTrailingSlashes.html b/7.x/docs/functions/trimTrailingSlashes.html new file mode 100644 index 000000000..9c015e2d8 --- /dev/null +++ b/7.x/docs/functions/trimTrailingSlashes.html @@ -0,0 +1,77 @@ +trimTrailingSlashes | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function trimTrailingSlashes

+
+
    + +
  • +

    Makes sure the input path has no slashes at the end.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check.

      +
      +
    +

    Returns string

    The potentially changed path.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/uniqueQuads.html b/7.x/docs/functions/uniqueQuads.html new file mode 100644 index 000000000..e2257cf30 --- /dev/null +++ b/7.x/docs/functions/uniqueQuads.html @@ -0,0 +1,77 @@ +uniqueQuads | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function uniqueQuads

+
+
    + +
  • +

    Filter out duplicate quads from an array.

    +
    +
    +

    Parameters

    +
      +
    • +
      quads: Quad[]
      +

      Quads to filter.

      +
      +
    +

    Returns Quad[]

    A new array containing the unique quads.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/updateModifiedDate.html b/7.x/docs/functions/updateModifiedDate.html new file mode 100644 index 000000000..9d468c430 --- /dev/null +++ b/7.x/docs/functions/updateModifiedDate.html @@ -0,0 +1,81 @@ +updateModifiedDate | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function updateModifiedDate

+
+
    + +
  • +

    Updates the dc:modified time to the given time.

    +
    +
    +

    Parameters

    +
      +
    • +
      metadata: RepresentationMetadata
      +

      Metadata to update.

      +
      +
    • +
    • +
      date: Date = ...
      +

      Last modified date. Defaults to current time.

      +
      +
    +

    Returns void

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/validateWithError.html b/7.x/docs/functions/validateWithError.html new file mode 100644 index 000000000..611fb152c --- /dev/null +++ b/7.x/docs/functions/validateWithError.html @@ -0,0 +1,82 @@ +validateWithError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function validateWithError

+
+
    + +
  • +

    Same functionality as the yup validate function, but throws a BadRequestHttpError if there is an error.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends BaseObjectSchema

    +
    +

    Parameters

    +
      +
    • +
      schema: T
    • +
    • +
      data: unknown
    • +
    • +
      Optional options: ValidateOptions<AnyObject>
    +

    Returns Promise<T["__outputType"]>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/verifyAccountId.html b/7.x/docs/functions/verifyAccountId.html new file mode 100644 index 000000000..c8d7ede3d --- /dev/null +++ b/7.x/docs/functions/verifyAccountId.html @@ -0,0 +1,82 @@ +verifyAccountId | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function verifyAccountId

+
+
    + +
  • +

    Asserts that the two given IDs are identical. +To be used when a request tries to access a resource to ensure they're not accessing someone else's data.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional input: string
      +

      Input ID.

      +
      +
    • +
    • +
      Optional expected: string
      +

      Expected ID.

      +
      +
    +

    Returns asserts expected is string

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/index.html b/7.x/docs/index.html new file mode 100644 index 000000000..2ce3e01c6 --- /dev/null +++ b/7.x/docs/index.html @@ -0,0 +1,126 @@ +Community Solid Server - v7.0.5
+
+ +
+
+
+
+

Community Solid Server - v7.0.5

+

Community Solid Server

[Solid logo]

+

MIT license +npm version +Node.js version +Build Status +Coverage Status +DOI +GitHub discussions +Chat on Gitter

+

The Community Solid Server is open software +that provides you with a Solid Pod and identity. +This Pod acts as your own personal storage space +so you can share data with people and Solid applications.

+

As an open and modular implementation of the +Solid specifications, +the Community Solid Server is a great companion:

+
    +
  • 🧑🏽 for people who want to try out having their own Pod

    +
  • +
  • 👨🏿‍💻 for developers who want to quickly create and test Solid apps

    +
  • +
  • 👩🏻‍🔬 for researchers who want to design new features for Solid

    +
  • +
+

And, of course, for many others who like to experience Solid.

+

⚡ Running the Community Solid Server

Use Node.js 18.0 or up and execute:

+
npx @solid/community-server
+
+

Now visit your brand new server at http://localhost:3000/!

+

To persist your pod's contents between restarts, use:

+
npx @solid/community-server -c @css:config/file.json -f data/
+
+

Find more ways to run the server in the documentation.

+

🔧 Configure your server

Substantial changes to server behavior can be achieved via JSON configuration files. +The Community Solid Server uses Components.js +to specify how modules and components need to be wired together at runtime.

+

Recipes for configuring the server can be found at CommunitySolidServer/recipes.

+

Examples and guidance on custom configurations +are available in the config folder, +and the configurations tutorial. +There is also a configuration generator.

+

👩🏽‍💻 Developing server code

The server allows writing and plugging in custom modules +without altering its base source code.

+

The 📗 API documentation and +the 📓 user documentation +can help you find your way. +There is also a repository of 📚 comprehensive tutorials

+

📜 License

The Solid Community Server code +is copyrighted by Inrupt Inc. +and imec +and available under the MIT License.

+

🎤 Feedback and questions

Don't hesitate to start a discussion +or report a bug.

+

There's also a Matrix-based, CSS-focused chat

+

Learn more about Solid at solidproject.org.

+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AccessCheckerArgs.html b/7.x/docs/interfaces/AccessCheckerArgs.html new file mode 100644 index 000000000..0bcbeb8e0 --- /dev/null +++ b/7.x/docs/interfaces/AccessCheckerArgs.html @@ -0,0 +1,108 @@ +AccessCheckerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AccessCheckerArgs

+
+

Hierarchy

+
    +
  • AccessCheckerArgs
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
acl: Store<Quad, Quad, Quad, Quad>
+

A store containing the relevant triples of the authorization.

+
+
+
+ +
credentials: Credentials
+

Credentials of the entity that wants to use the resource.

+
+
+
+ +
rule: Term
+

Authorization rule to be processed.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AccountInitializerArgs.html b/7.x/docs/interfaces/AccountInitializerArgs.html new file mode 100644 index 000000000..e57bc77fd --- /dev/null +++ b/7.x/docs/interfaces/AccountInitializerArgs.html @@ -0,0 +1,138 @@ +AccountInitializerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AccountInitializerArgs

+
+

Hierarchy

+
    +
  • AccountInitializerArgs
+
+
+
+ +
+
+

Properties

+
+ +
accountStore: AccountStore
+

Creates the accounts.

+
+
+
+ +
email: string
+

Email address for the account login.

+
+
+
+ +
name?: string
+

Name to use for the pod. If undefined the pod will be made in the root of the server.

+
+
+
+ +
password: string
+

Password for the account login.

+
+
+
+ +
passwordStore: PasswordStore
+

Adds the login methods.

+
+
+
+ +
podCreator: PodCreator
+

Creates the pods.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AccountStore.html b/7.x/docs/interfaces/AccountStore.html new file mode 100644 index 000000000..46a2a5f04 --- /dev/null +++ b/7.x/docs/interfaces/AccountStore.html @@ -0,0 +1,184 @@ +AccountStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AccountStore

+
+

Used to store account data.

+
+
+
+

Hierarchy

+
    +
  • AccountStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
create: (() => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<string>
    • +
    • +

      Creates a new and empty account. +Since this account will not yet have a login method, +implementations should restrict what is possible with this account, +and should potentially have something in place to clean these accounts up if they are unused.

      +
      +

      Returns Promise<string>

      +
+
+ +
getSetting: (<T>(id, setting) => Promise<AccountSettings[T]>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(id, setting): Promise<AccountSettings[T]>
    • +
    • +

      Finds the setting of the account with the given identifier.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T extends "rememberLogin"

      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        The account identifier.

        +
        +
      • +
      • +
        setting: T
        +

        The setting to find the value of.

        +
        +
      +

      Returns Promise<AccountSettings[T]>

      +
+
+ +
updateSetting: (<T>(id, setting, value) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(id, setting, value): Promise<void>
    • +
    • +

      Updates the settings for the account with the given identifier to the new values.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T extends "rememberLogin"

      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        The account identifier.

        +
        +
      • +
      • +
        setting: T
        +

        The setting to update.

        +
        +
      • +
      • +
        value: AccountSettings[T]
        +

        The new value for the setting.

        +
        +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AdapterFactory.html b/7.x/docs/interfaces/AdapterFactory.html new file mode 100644 index 000000000..925677d6a --- /dev/null +++ b/7.x/docs/interfaces/AdapterFactory.html @@ -0,0 +1,110 @@ +AdapterFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AdapterFactory

+
+

A factory that generates an Adapter to be used by the IDP to persist information.

+

The oidc-provider library will call the relevant functions when it needs to find/create/delete metadata. +For a full explanation of how these functions work and what is expected, +have a look at https://github.com/panva/node-oidc-provider/blob/main/example/my_adapter.js

+
+
+
+

Hierarchy

+
    +
  • AdapterFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
createStorageAdapter: ((name) => Adapter)
+
+

Type declaration

+
    +
  • +
      +
    • (name): Adapter
    • +
    • +
      +

      Parameters

      +
        +
      • +
        name: string
      +

      Returns Adapter

+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AlgJwk.html b/7.x/docs/interfaces/AlgJwk.html new file mode 100644 index 000000000..8874aa382 --- /dev/null +++ b/7.x/docs/interfaces/AlgJwk.html @@ -0,0 +1,304 @@ +AlgJwk | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AlgJwk

+
+

A JWK where the alg parameter is always defined.

+
+
+
+

Hierarchy

+
    +
  • JWK +
      +
    • AlgJwk
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
alg: AsymmetricSigningAlgorithm
+
+ +
crv?: string
+
+ +
d?: string
+
+ +
dp?: string
+
+ +
dq?: string
+
+ +
e?: string
+
+ +
ext?: boolean
+

JWK "ext" (Extractable) Parameter.

+
+
+
+ +
k?: string
+
+ +
key_ops?: string[]
+

JWK "key_ops" (Key Operations) Parameter.

+
+
+
+ +
kid?: string
+

JWK "kid" (Key ID) Parameter.

+
+
+
+ +
kty?: string
+

JWK "kty" (Key Type) Parameter.

+
+
+
+ +
n?: string
+
+ +
oth?: {
    d?: string;
    r?: string;
    t?: string;
}[]
+
+

Type declaration

+
    +
  • +
    Optional d?: string
  • +
  • +
    Optional r?: string
  • +
  • +
    Optional t?: string
+
+ +
p?: string
+
+ +
q?: string
+
+ +
qi?: string
+
+ +
use?: string
+

JWK "use" (Public Key Use) Parameter.

+
+
+
+ +
x?: string
+
+ +
x5c?: string[]
+

JWK "x5c" (X.509 Certificate Chain) Parameter.

+
+
+
+ +
x5t?: string
+

JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter.

+
+
+
+ +
x5t#S256?: string
+

"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter.

+
+
+
+ +
x5u?: string
+

JWK "x5u" (X.509 URL) Parameter.

+
+
+
+ +
y?: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AppRunnerInput.html b/7.x/docs/interfaces/AppRunnerInput.html new file mode 100644 index 000000000..dbd495358 --- /dev/null +++ b/7.x/docs/interfaces/AppRunnerInput.html @@ -0,0 +1,147 @@ +AppRunnerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AppRunnerInput

+
+

Parameters that can be used to instantiate the server through code.

+
+
+
+

Hierarchy

+
    +
  • AppRunnerInput
+
+
+
+ +
+
+

Properties

+
+ +
argv?: string[]
+

An array containing CLI arguments passed to start the process. +Entries here have the lowest priority for assigning values to variables.

+
+
+
+ +
config?: string | string[]
+

Path to the server config file(s). Defaults to @css:config/default.json.

+
+
+
+ +
loaderProperties?: Partial<IComponentsManagerBuilderOptions<App>>
+

Properties that will be used when building the Components.js manager. +Default values:

+
    +
  • typeChecking: false, as the server components would otherwise error.
  • +
  • mainModulePath: @css:, which resolves to the directory of the CSS package. + This is useful for packages that depend on the CSS + but do not create any new modules themselves.
  • +
+
+
+
+ +
shorthand?: Shorthand
+

CLI argument names and their corresponding values. +E.g.: { rootFilePath: '.data' }. +Abbreviated parameter names can not be used, so { f: '.data' } would not work.

+

In case both shorthand and variableBindings have entries that would result in a value for the same variable, +variableBindings has priority.

+
+
+
+ +
variableBindings?: VariableBindings
+

Values to apply to the Components.js variables. +These are the variables CLI values will be converted to. +The keys should be the variable URIs. +E.g.: { 'urn:solid-server:default:variable:rootFilePath': '.data' }.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AsyncTransformOptions.html b/7.x/docs/interfaces/AsyncTransformOptions.html new file mode 100644 index 000000000..46100da70 --- /dev/null +++ b/7.x/docs/interfaces/AsyncTransformOptions.html @@ -0,0 +1,426 @@ +AsyncTransformOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AsyncTransformOptions<T>

+
+

Type Parameters

+
    +
  • +

    T = unknown

+
+

Hierarchy

+
    +
  • DuplexOptions +
      +
    • AsyncTransformOptions
+
+
+
+ +
+
+

Properties

+
+ +
allowHalfOpen?: boolean
+
+ +
autoDestroy?: boolean
+
+ +
decodeStrings?: boolean
+
+ +
defaultEncoding?: BufferEncoding
+
+ +
emitClose?: boolean
+
+ +
encoding?: BufferEncoding
+
+ +
flush?: ((this) => unknown)
+
+

Type declaration

+
    +
  • +
      +
    • (this): unknown
    • +
    • +

      Performs any final actions after the source has ended

      +
      +
      +

      Parameters

      +
        +
      • +
        this: Transform
      +

      Returns unknown

      +
+
+ +
highWaterMark?: number
+
+ +
objectMode?: boolean
+
+ +
readableHighWaterMark?: number
+
+ +
readableObjectMode?: boolean
+
+ +
signal?: AbortSignal
+

When provided the corresponding AbortController can be used to cancel an asynchronous action.

+
+
+
+ +
transform?: ((this, data, encoding) => unknown)
+
+

Type declaration

+
    +
  • +
      +
    • (this, data, encoding): unknown
    • +
    • +

      Transforms data from the source by calling the push method

      +
      +
      +

      Parameters

      +
        +
      • +
        this: Transform
      • +
      • +
        data: T
      • +
      • +
        encoding: string
      +

      Returns unknown

      +
+
+ +
writableCorked?: number
+
+ +
writableHighWaterMark?: number
+
+ +
writableObjectMode?: boolean
+
+

Methods

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
    • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
    • +
    • +
      error: null | Error
    • +
    • +
      callback: ((error) => void)
      +
        +
      • +
          +
        • (error): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
    • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
    • +
    • +
      size: number
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
    • +
    • +
      chunk: any
    • +
    • +
      encoding: BufferEncoding
    • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
    • +
    • +
      chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AtomicDataAccessor.html b/7.x/docs/interfaces/AtomicDataAccessor.html new file mode 100644 index 000000000..23edc1621 --- /dev/null +++ b/7.x/docs/interfaces/AtomicDataAccessor.html @@ -0,0 +1,347 @@ +AtomicDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AtomicDataAccessor

+
+

The AtomicDataAccessor interface has identical function signatures as +the DataAccessor, with the additional constraint that every function call +must be atomic in its effect: either the call fully succeeds, reaching the +desired new state; or it fails, upon which the resulting state remains +identical to the one before the call.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
canHandle: ((representation) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (representation): Promise<void>
    • +
    • +

      Should throw a NotImplementedHttpError if the DataAccessor does not support storing the given Representation.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
      +

      Throws

      BadRequestHttpError +If it does not support the incoming data.

      +
+
+ +
deleteResource: ((identifier) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<void>
    • +
    • +

      Deletes the resource and its corresponding metadata.

      +

      Solid, §5.4: "When a contained resource is deleted, the server MUST also remove the corresponding containment +triple, which has the effect of removing the deleted resource from the containing container." +https://solid.github.io/specification/protocol#deleting-resources

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+ +
getChildren: ((identifier) => AsyncIterableIterator<RepresentationMetadata>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): AsyncIterableIterator<RepresentationMetadata>
    • +
    • +

      Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

      +

      It can be safely assumed that the incoming identifier will always correspond to a container.

      +
      +
      +

      Parameters

      +
      +

      Returns AsyncIterableIterator<RepresentationMetadata>

      +
+
+ +
getData: ((identifier) => Promise<Guarded<Readable>>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<Guarded<Readable>>
    • +
    • +

      Returns a data stream stored for the given identifier. +It can be assumed that the incoming identifier will always correspond to a document.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Guarded<Readable>>

      +
+
+ +
getMetadata: ((identifier) => Promise<RepresentationMetadata>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<RepresentationMetadata>
    • +
    • +

      Returns the metadata corresponding to the identifier. +If possible, it is suggested to add a posix:size triple to the metadata indicating the binary size. +This is necessary for range requests.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<RepresentationMetadata>

      +
+
+ +
writeContainer: ((identifier, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, metadata): Promise<void>
    • +
    • +

      Writes metadata for a container. +If the container does not exist yet it should be created, +if it does its metadata should be overwritten, except for the containment triples.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+ +
writeDocument: ((identifier, data, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, data, metadata): Promise<void>
    • +
    • +

      Writes data and metadata for a document. +If any data and/or metadata exist for the given identifier, it should be overwritten.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+ +
writeMetadata: ((identifier, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, metadata): Promise<void>
    • +
    • +

      Writes metadata for a resource. +It can safely be assumed that the subject resource already exists.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AtomicResourceStore.html b/7.x/docs/interfaces/AtomicResourceStore.html new file mode 100644 index 000000000..e398fe6b9 --- /dev/null +++ b/7.x/docs/interfaces/AtomicResourceStore.html @@ -0,0 +1,303 @@ +AtomicResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AtomicResourceStore

+
+

A ResourceStore of which all operations are atomic.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
addResource: ((container, representation, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (container, representation, conditions?): Promise<ChangeMap>
    • +
    • +

      Creates a new resource in the container.

      +
      +
      +

      Parameters

      +
        +
      • +
        container: ResourceIdentifier
        +

        Container in which to create a resource.

        +
        +
      • +
      • +
        representation: Representation
        +

        Representation of the new resource

        +
        +
      • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+ +
deleteResource: ((identifier, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, conditions?): Promise<ChangeMap>
    • +
    • +

      Deletes a resource.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to delete.

        +
        +
      • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+ +
getRepresentation: ((identifier, preferences, conditions?) => Promise<Representation>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, preferences, conditions?): Promise<Representation>
    • +
    • +

      Retrieves a representation of a resource.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Representation>

      A representation corresponding to the identifier.

      + +
+
+ +
hasResource: ((identifier) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<boolean>
    • +
    • +

      Checks whether a resource exists in this ResourceSet.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<boolean>

      A promise resolving if the resource already exists.

      + +
+
+ +
modifyResource: ((identifier, patch, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, patch, conditions?): Promise<ChangeMap>
    • +
    • +

      Sets or updates the representation of a resource, +creating a new resource and intermediary containers as needed.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to update.

        +
        +
      • +
      • +
        patch: Patch
        +

        Description of which parts to update.

        +
        +
      • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+ +
setRepresentation: ((identifier, representation, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, representation, conditions?): Promise<ChangeMap>
    • +
    • +

      Sets or replaces the representation of a resource, +creating a new resource and intermediary containers as needed.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to update.

        +
        +
      • +
      • +
        representation: Representation
        +

        New representation of the resource.

        +
        +
      • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AuthorizerInput.html b/7.x/docs/interfaces/AuthorizerInput.html new file mode 100644 index 000000000..d0677c484 --- /dev/null +++ b/7.x/docs/interfaces/AuthorizerInput.html @@ -0,0 +1,108 @@ +AuthorizerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AuthorizerInput

+
+

Hierarchy

+
    +
  • AuthorizerInput
+
+
+
+ +
+
+

Properties

+
+ +
availablePermissions: PermissionMap
+

Actual permissions available per resource and per credential group.

+
+
+
+ +
credentials: Credentials
+

Credentials of the entity that wants to use the resource.

+
+
+
+ +
requestedModes: AccessMap
+

Requested access modes per resource.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AuthorizingHttpHandlerArgs.html b/7.x/docs/interfaces/AuthorizingHttpHandlerArgs.html new file mode 100644 index 000000000..a691cfd15 --- /dev/null +++ b/7.x/docs/interfaces/AuthorizingHttpHandlerArgs.html @@ -0,0 +1,128 @@ +AuthorizingHttpHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AuthorizingHttpHandlerArgs

+
+

Hierarchy

+
    +
  • AuthorizingHttpHandlerArgs
+
+
+
+ +
+
+

Properties

+
+ +
authorizer: Authorizer
+

Verifies if the requested operation is allowed.

+
+
+
+ +
credentialsExtractor: CredentialsExtractor
+

Extracts the credentials from the incoming request.

+
+
+
+ +
modesExtractor: ModesExtractor
+

Extracts the required modes from the generated Operation.

+
+
+
+ +
operationHandler: OperationHttpHandler
+

Handler to call if the operation is authorized.

+
+
+
+ +
permissionReader: PermissionReader
+

Reads the permissions available for the Operation.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AuxiliaryIdentifierStrategy.html b/7.x/docs/interfaces/AuxiliaryIdentifierStrategy.html new file mode 100644 index 000000000..cabdc79f5 --- /dev/null +++ b/7.x/docs/interfaces/AuxiliaryIdentifierStrategy.html @@ -0,0 +1,204 @@ +AuxiliaryIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AuxiliaryIdentifierStrategy

+
+

A strategy for handling auxiliary related ResourceIdentifiers.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
getAuxiliaryIdentifier: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier
    • +
    • +

      Returns the identifier of the auxiliary resource corresponding to the given resource. +This does not guarantee that this auxiliary resource exists.

      +

      Should error if there are multiple results: see getAuxiliaryIdentifiers.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        The ResourceIdentifier of which we need the corresponding auxiliary resource.

        +
        +
      +

      Returns ResourceIdentifier

      The ResourceIdentifier of the corresponding auxiliary resource.

      + +
+
+ +
getAuxiliaryIdentifiers: ((identifier) => ResourceIdentifier[])
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier[]
    • +
    • +

      Returns all the identifiers of corresponding auxiliary resources. +This can be used when there are potentially multiple results. +In the case of a single result this should be an array containing the result of getAuxiliaryIdentifier.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        The ResourceIdentifier of which we need the corresponding auxiliary resources.

        +
        +
      +

      Returns ResourceIdentifier[]

      The ResourceIdentifiers of the corresponding auxiliary resources.

      + +
+
+ +
getSubjectIdentifier: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier
    • +
    • +

      Returns the identifier of the resource which this auxiliary resource is referring to. +This does not guarantee that this resource exists.

      +
      +
      +

      Parameters

      +
      +

      Returns ResourceIdentifier

      The ResourceIdentifier of the subject resource.

      + +
+
+ +
isAuxiliaryIdentifier: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
    • +
    • +

      Checks if the input identifier corresponds to an auxiliary resource. +This does not check if that auxiliary resource exists, +only if the identifier indicates that there could be an auxiliary resource there.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      true if the input identifier points to an auxiliary resource.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AuxiliaryStrategy.html b/7.x/docs/interfaces/AuxiliaryStrategy.html new file mode 100644 index 000000000..b8703b930 --- /dev/null +++ b/7.x/docs/interfaces/AuxiliaryStrategy.html @@ -0,0 +1,324 @@ +AuxiliaryStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AuxiliaryStrategy

+
+

A strategy for handling one or more types of auxiliary resources. +References to "an auxiliary resource" implicitly imply a specific type of auxiliary resources +supported by this strategy.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
addMetadata: ((metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (metadata): Promise<void>
    • +
    • +

      Adds metadata related to this auxiliary resource, +in case this is required for this type of auxiliary resource. +The metadata that is added depends on the given identifier being an auxiliary or subject resource: +the metadata will be used to link to the other one, and potentially add extra typing info.

      +

      Used for: +Solid, §4.3.1: "For any defined auxiliary resource available for a given Solid resource, all representations of +that resource MUST include an HTTP Link header pointing to the location of each auxiliary resource." +https://solid.github.io/specification/protocol#auxiliary-resources-server

      +

      The above is an example of how that metadata would only be added in case the input is the subject identifier.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+ +
getAuxiliaryIdentifier: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier
    • +
    • +

      Returns the identifier of the auxiliary resource corresponding to the given resource. +This does not guarantee that this auxiliary resource exists.

      +

      Should error if there are multiple results: see getAuxiliaryIdentifiers.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        The ResourceIdentifier of which we need the corresponding auxiliary resource.

        +
        +
      +

      Returns ResourceIdentifier

      The ResourceIdentifier of the corresponding auxiliary resource.

      + +
+
+ +
getAuxiliaryIdentifiers: ((identifier) => ResourceIdentifier[])
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier[]
    • +
    • +

      Returns all the identifiers of corresponding auxiliary resources. +This can be used when there are potentially multiple results. +In the case of a single result this should be an array containing the result of getAuxiliaryIdentifier.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        The ResourceIdentifier of which we need the corresponding auxiliary resources.

        +
        +
      +

      Returns ResourceIdentifier[]

      The ResourceIdentifiers of the corresponding auxiliary resources.

      + +
+
+ +
getSubjectIdentifier: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier
    • +
    • +

      Returns the identifier of the resource which this auxiliary resource is referring to. +This does not guarantee that this resource exists.

      +
      +
      +

      Parameters

      +
      +

      Returns ResourceIdentifier

      The ResourceIdentifier of the subject resource.

      + +
+
+ +
isAuxiliaryIdentifier: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
    • +
    • +

      Checks if the input identifier corresponds to an auxiliary resource. +This does not check if that auxiliary resource exists, +only if the identifier indicates that there could be an auxiliary resource there.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      true if the input identifier points to an auxiliary resource.

      + +
+
+ +
isRequiredInRoot: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
    • +
    • +

      Whether the root storage container requires this auxiliary resource to be present. +If yes, this means they can't be deleted individually from such a container.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      +
+
+ +
usesOwnAuthorization: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
    • +
    • +

      Whether this auxiliary resources uses its own authorization instead of the subject resource authorization.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      +
+
+ +
validate: ((representation) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (representation): Promise<void>
    • +
    • +

      Validates if the representation contains valid data for an auxiliary resource. +Should throw an error in case the data is invalid.

      +
      +
      +

      Parameters

      +
        +
      • +
        representation: Representation
        +

        Representation of the auxiliary resource.

        +
        +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BasePodCreatorArgs.html b/7.x/docs/interfaces/BasePodCreatorArgs.html new file mode 100644 index 000000000..6a03708c0 --- /dev/null +++ b/7.x/docs/interfaces/BasePodCreatorArgs.html @@ -0,0 +1,130 @@ +BasePodCreatorArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BasePodCreatorArgs

+
+

Hierarchy

+
    +
  • BasePodCreatorArgs
+
+
+
+ +
+
+

Properties

+
+ +
baseUrl: string
+

Base URL of the server. +Used to potentially set the solid:oidcIssuer triple +and/or the pod URL if it is a root pod.

+
+
+
+ +
identifierGenerator: IdentifierGenerator
+

Generates the base URL of the pod based on the input name.

+
+
+
+ +
podStore: PodStore
+

Pod data store.

+
+
+
+ +
relativeWebIdPath: string
+

The path of where the WebID will be generated by the template, relative to the pod URL.

+
+
+
+ +
webIdStore: WebIdStore
+

WebID data store.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BaseRouterHandlerArgs.html b/7.x/docs/interfaces/BaseRouterHandlerArgs.html new file mode 100644 index 000000000..686f18ea4 --- /dev/null +++ b/7.x/docs/interfaces/BaseRouterHandlerArgs.html @@ -0,0 +1,130 @@ +BaseRouterHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BaseRouterHandlerArgs<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+ +
allowedMethods?: string[]
+

The allowed method(s). * can be used to indicate all methods are allowed. +Default is [ '*' ].

+
+
+
+ +
allowedPathNames?: string[]
+

Regular expression(s) used to match the target URL. +The base URl without trailing slash will be stripped of before applying the regular expressions, +so the input will always start with a /. +Default is [ '.*' ].

+
+
+
+ +
baseUrl?: string
+

The base URL of the server. +Not required if no value is provided for allowedPathNames.

+
+
+
+ +
handler: T
+

The handler to call if all checks pass.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BaseServerFactoryOptions.html b/7.x/docs/interfaces/BaseServerFactoryOptions.html new file mode 100644 index 000000000..5cf3144e5 --- /dev/null +++ b/7.x/docs/interfaces/BaseServerFactoryOptions.html @@ -0,0 +1,123 @@ +BaseServerFactoryOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BaseServerFactoryOptions

+
+

Options to be used when creating the server. +Due to Components.js not supporting external types, this has been simplified (for now?). +The common https keys here (key/cert/pfx) will be interpreted as file paths that need to be read +before passing the options to the createServer function.

+
+
+
+

Hierarchy

+
    +
  • BaseServerFactoryOptions
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
cert?: string
+
+ +
https?: boolean
+

If the server should start as an HTTP or HTTPS server.

+
+
+
+ +
key?: string
+
+ +
passphrase?: string
+
+ +
pfx?: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BasicConditionsOptions.html b/7.x/docs/interfaces/BasicConditionsOptions.html new file mode 100644 index 000000000..9d4b0915a --- /dev/null +++ b/7.x/docs/interfaces/BasicConditionsOptions.html @@ -0,0 +1,106 @@ +BasicConditionsOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BasicConditionsOptions

+
+

Hierarchy

+
    +
  • BasicConditionsOptions
+
+
+
+ +
+
+

Properties

+
+ +
matchesETag?: string[]
+
+ +
modifiedSince?: Date
+
+ +
notMatchesETag?: string[]
+
+ +
unmodifiedSince?: Date
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BasicRequestParserArgs.html b/7.x/docs/interfaces/BasicRequestParserArgs.html new file mode 100644 index 000000000..b0d21183c --- /dev/null +++ b/7.x/docs/interfaces/BasicRequestParserArgs.html @@ -0,0 +1,117 @@ +BasicRequestParserArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BasicRequestParserArgs

+
+

Input parsers required for a BasicRequestParser.

+
+
+
+

Hierarchy

+
    +
  • BasicRequestParserArgs
+
+
+
+ +
+
+

Properties

+
+ +
bodyParser: BodyParser
+
+ +
conditionsParser: ConditionsParser
+
+ +
metadataParser: MetadataParser
+
+ +
preferenceParser: PreferenceParser
+
+ +
targetExtractor: TargetExtractor
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BodyParserArgs.html b/7.x/docs/interfaces/BodyParserArgs.html new file mode 100644 index 000000000..cca1fe43d --- /dev/null +++ b/7.x/docs/interfaces/BodyParserArgs.html @@ -0,0 +1,99 @@ +BodyParserArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BodyParserArgs

+
+

Hierarchy

+
    +
  • BodyParserArgs
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ + +

Metadata that has already been parsed from the request. +Can be updated by the BodyParser with extra metadata.

+
+
+
+ +
request: HttpRequest
+

Request that contains the (potential) body.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/CliOptions.html b/7.x/docs/interfaces/CliOptions.html new file mode 100644 index 000000000..0c79ae525 --- /dev/null +++ b/7.x/docs/interfaces/CliOptions.html @@ -0,0 +1,106 @@ +CliOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface CliOptions

+
+

Hierarchy

+
    +
  • CliOptions
+
+
+
+ +
+
+

Properties

+
+ +
envVarPrefix?: string
+
+ +
loadFromEnv?: boolean
+
+ +
strictMode?: boolean
+
+ +
usage?: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ClientCredentials.html b/7.x/docs/interfaces/ClientCredentials.html new file mode 100644 index 000000000..0d05bb97c --- /dev/null +++ b/7.x/docs/interfaces/ClientCredentials.html @@ -0,0 +1,113 @@ +ClientCredentials | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/interfaces/ClientCredentialsStore.html b/7.x/docs/interfaces/ClientCredentialsStore.html new file mode 100644 index 000000000..2f5503587 --- /dev/null +++ b/7.x/docs/interfaces/ClientCredentialsStore.html @@ -0,0 +1,223 @@ +ClientCredentialsStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ClientCredentialsStore

+
+

Stores and creates ClientCredentials.

+
+
+
+

Hierarchy

+
    +
  • ClientCredentialsStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
create: ((label, webId, accountId) => Promise<ClientCredentials>)
+
+

Type declaration

+
    +
  • +
      +
    • (label, webId, accountId): Promise<ClientCredentials>
    • +
    • +

      Creates new token.

      +
      +
      +

      Parameters

      +
        +
      • +
        label: string
        +

        Identifier to use for the new token.

        +
        +
      • +
      • +
        webId: string
        +

        WebID to identify as when using this token.

        +
        +
      • +
      • +
        accountId: string
      +

      Returns Promise<ClientCredentials>

      +
+
+ +
delete: ((id) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<void>
    • +
    • +

      Deletes the token with the given ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the token.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
findByAccount: ((accountId) => Promise<ClientCredentials[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId): Promise<ClientCredentials[]>
    • +
    • +

      Find all tokens created by the given account.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        ID of the account.

        +
        +
      +

      Returns Promise<ClientCredentials[]>

      +
+
+ +
findByLabel: ((label) => Promise<undefined | ClientCredentials>)
+
+

Type declaration

+
+
+ +
get: ((id) => Promise<undefined | ClientCredentials>)
+
+

Type declaration

+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ComponentsJsFactory.html b/7.x/docs/interfaces/ComponentsJsFactory.html new file mode 100644 index 000000000..79d84c6d0 --- /dev/null +++ b/7.x/docs/interfaces/ComponentsJsFactory.html @@ -0,0 +1,128 @@ +ComponentsJsFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ComponentsJsFactory

+
+

Used for instantiating new object using Components.js configurations.

+
+
+
+

Hierarchy

+
    +
  • ComponentsJsFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
generate: (<T>(configPath, componentIri, variables) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(configPath, componentIri, variables): Promise<T>
    • +
    • +

      Instantiates a new object using Components.js.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T

      +
      +

      Parameters

      +
        +
      • +
        configPath: string
        +

        Location of the config to instantiate.

        +
        +
      • +
      • +
        componentIri: string
        +

        IRI of the object in the config that will be the result.

        +
        +
      • +
      • +
        variables: Record<string, unknown>
        +

        Variables to send to Components.js

        +
        +
      +

      Returns Promise<T>

      The resulting object, corresponding to the given component IRI.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ComposedNotificationHandlerArgs.html b/7.x/docs/interfaces/ComposedNotificationHandlerArgs.html new file mode 100644 index 000000000..9f22a6fd0 --- /dev/null +++ b/7.x/docs/interfaces/ComposedNotificationHandlerArgs.html @@ -0,0 +1,106 @@ +ComposedNotificationHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/interfaces/Conditions.html b/7.x/docs/interfaces/Conditions.html new file mode 100644 index 000000000..3b760a417 --- /dev/null +++ b/7.x/docs/interfaces/Conditions.html @@ -0,0 +1,159 @@ +Conditions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Conditions

+
+

The conditions of an HTTP conditional request.

+
+
+
+

Hierarchy

+
    +
  • Conditions
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
matchesETag?: string[]
+

Valid if matching any of the given ETags.

+
+
+
+ +
matchesMetadata: ((metadata?, strict?) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (metadata?, strict?): boolean
    • +
    • +

      Checks validity based on the given metadata.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional metadata: RepresentationMetadata
        +

        Metadata of the representation. Undefined if the resource does not exist.

        +
        +
      • +
      • +
        Optional strict: boolean
        +

        How to compare the ETag related headers. + If true, the comparison will happen on representation level. + If false, the comparison happens on resource level, ignoring the content-type.

        +
        +
      +

      Returns boolean

      +
+
+ +
modifiedSince?: Date
+

Valid if modified since the given date.

+
+
+
+ +
notMatchesETag?: string[]
+

Valid if not matching any of the given ETags.

+
+
+
+ +
unmodifiedSince?: Date
+

Valid if not modified since the given date.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ConstantConverterOptions.html b/7.x/docs/interfaces/ConstantConverterOptions.html new file mode 100644 index 000000000..d6c5c1c53 --- /dev/null +++ b/7.x/docs/interfaces/ConstantConverterOptions.html @@ -0,0 +1,132 @@ +ConstantConverterOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ConstantConverterOptions

+
+

Extra options for the ConstantConverter.

+
+
+
+

Hierarchy

+
    +
  • ConstantConverterOptions
+
+
+
+ +
+
+

Properties

+
+ +
container?: boolean
+

Whether this should trigger on containers.

+
+
+
+ +
disabledMediaRanges?: string[]
+

Media ranges for which the conversion should not happen.

+
+
+
+ +
document?: boolean
+

Whether this should trigger on documents.

+
+
+
+ +
enabledMediaRanges?: string[]
+

Media ranges for which the conversion should happen.

+
+
+
+ +
minQuality?: number
+

The minimum requested quality/preference before this should trigger.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ContainerInitializerArgs.html b/7.x/docs/interfaces/ContainerInitializerArgs.html new file mode 100644 index 000000000..d2cfd739e --- /dev/null +++ b/7.x/docs/interfaces/ContainerInitializerArgs.html @@ -0,0 +1,138 @@ +ContainerInitializerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ContainerInitializerArgs

+
+

Hierarchy

+
    +
  • ContainerInitializerArgs
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
baseUrl: string
+

Base URL of the server.

+
+
+
+ + +

Generator that should be used to generate container contents.

+
+
+
+ +
path: string
+

Relative path of the container.

+
+
+
+ +
storage: KeyValueStorage<string, boolean>
+

Used to store initialization status.

+
+
+
+ +
storageKey: string
+

Key that is used to store the boolean in the storage indicating the container is initialized.

+
+
+
+ + +

ResourceStore where the container should be stored.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ConvertingStoreEntry.html b/7.x/docs/interfaces/ConvertingStoreEntry.html new file mode 100644 index 000000000..e4af5eb90 --- /dev/null +++ b/7.x/docs/interfaces/ConvertingStoreEntry.html @@ -0,0 +1,92 @@ +ConvertingStoreEntry | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/interfaces/CookieStore.html b/7.x/docs/interfaces/CookieStore.html new file mode 100644 index 000000000..d4582c3c5 --- /dev/null +++ b/7.x/docs/interfaces/CookieStore.html @@ -0,0 +1,192 @@ +CookieStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface CookieStore

+
+

Used to generate and store cookies.

+
+
+
+

Hierarchy

+
    +
  • CookieStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
delete: ((cookie) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (cookie): Promise<boolean>
    • +
    • +

      Deletes the given cookie.

      +
      +
      +

      Parameters

      +
        +
      • +
        cookie: string
        +

        Cookie to delete.

        +
        +
      +

      Returns Promise<boolean>

      +
+
+ +
generate: ((accountId) => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId): Promise<string>
    • +
    • +

      Generates and stores a new cookie for the given accountId. +This does not replace previously generated cookies.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        Account to create a cookie for.

        +
        +
      +

      Returns Promise<string>

      The generated cookie.

      + +
+
+ +
get: ((cookie) => Promise<undefined | string>)
+
+

Type declaration

+
    +
  • +
      +
    • (cookie): Promise<undefined | string>
    • +
    • +

      Return the accountID associated with the given cookie.

      +
      +
      +

      Parameters

      +
        +
      • +
        cookie: string
        +

        Cookie to find the account for.

        +
        +
      +

      Returns Promise<undefined | string>

      +
+
+ +
refresh: ((cookie) => Promise<undefined | Date>)
+
+

Type declaration

+
    +
  • +
      +
    • (cookie): Promise<undefined | Date>
    • +
    • +

      Refreshes the cookie expiration and returns when it will expire if the cookie exists.

      +
      +
      +

      Parameters

      +
        +
      • +
        cookie: string
        +

        Cookie to refresh.

        +
        +
      +

      Returns Promise<undefined | Date>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/DataAccessor.html b/7.x/docs/interfaces/DataAccessor.html new file mode 100644 index 000000000..03eea40c5 --- /dev/null +++ b/7.x/docs/interfaces/DataAccessor.html @@ -0,0 +1,346 @@ +DataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface DataAccessor

+
+

A DataAccessor is the building block closest to the actual data storage. +It should not worry about most Solid logic, most of that will be handled before it is called. +There are a few things it still needs to do, and it is very important every implementation does this:

+
    +
  • If the input identifier ends with a slash, it should be assumed the identifier is targeting a container.
  • +
  • Similarly, if there is no trailing slash it should assume a document.
  • +
  • It should always throw a NotFoundHttpError if it does not have data matching the input identifier.
  • +
  • DataAccessors should not generate containment triples. This will be done externally using getChildren.
  • +
+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
canHandle: ((representation) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (representation): Promise<void>
    • +
    • +

      Should throw a NotImplementedHttpError if the DataAccessor does not support storing the given Representation.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
      +

      Throws

      BadRequestHttpError +If it does not support the incoming data.

      +
+
+ +
deleteResource: ((identifier) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<void>
    • +
    • +

      Deletes the resource and its corresponding metadata.

      +

      Solid, §5.4: "When a contained resource is deleted, the server MUST also remove the corresponding containment +triple, which has the effect of removing the deleted resource from the containing container." +https://solid.github.io/specification/protocol#deleting-resources

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+ +
getChildren: ((identifier) => AsyncIterableIterator<RepresentationMetadata>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): AsyncIterableIterator<RepresentationMetadata>
    • +
    • +

      Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

      +

      It can be safely assumed that the incoming identifier will always correspond to a container.

      +
      +
      +

      Parameters

      +
      +

      Returns AsyncIterableIterator<RepresentationMetadata>

      +
+
+ +
getData: ((identifier) => Promise<Guarded<Readable>>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<Guarded<Readable>>
    • +
    • +

      Returns a data stream stored for the given identifier. +It can be assumed that the incoming identifier will always correspond to a document.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Guarded<Readable>>

      +
+
+ +
getMetadata: ((identifier) => Promise<RepresentationMetadata>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<RepresentationMetadata>
    • +
    • +

      Returns the metadata corresponding to the identifier. +If possible, it is suggested to add a posix:size triple to the metadata indicating the binary size. +This is necessary for range requests.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<RepresentationMetadata>

      +
+
+ +
writeContainer: ((identifier, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, metadata): Promise<void>
    • +
    • +

      Writes metadata for a container. +If the container does not exist yet it should be created, +if it does its metadata should be overwritten, except for the containment triples.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+ +
writeDocument: ((identifier, data, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, data, metadata): Promise<void>
    • +
    • +

      Writes data and metadata for a document. +If any data and/or metadata exist for the given identifier, it should be overwritten.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+ +
writeMetadata: ((identifier, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, metadata): Promise<void>
    • +
    • +

      Writes metadata for a resource. +It can safely be assumed that the subject resource already exists.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ETagHandler.html b/7.x/docs/interfaces/ETagHandler.html new file mode 100644 index 000000000..0ac4a4d3a --- /dev/null +++ b/7.x/docs/interfaces/ETagHandler.html @@ -0,0 +1,183 @@ +ETagHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ETagHandler

+
+

Responsible for everything related to ETag generation and comparison. +ETags are constructed in such a way they can both be used for the standard ETag usage of comparing representations, +but also to see if two ETags of different representations correspond to the same resource state.

+
+
+
+

Hierarchy

+
    +
  • ETagHandler
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
getETag: ((metadata) => undefined | string)
+
+

Type declaration

+
    +
  • +
      +
    • (metadata): undefined | string
    • +
    • +

      Generates an ETag for the given metadata. Returns undefined if no ETag could be generated.

      +
      +
      +

      Parameters

      +
      +

      Returns undefined | string

      +
+
+ +
matchesETag: ((metadata, eTag, strict) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (metadata, eTag, strict): boolean
    • +
    • +

      Validates whether the given metadata corresponds to the given ETag.

      +
      +
      +

      Parameters

      +
        +
      • +
        metadata: RepresentationMetadata
        +

        Metadata of the resource.

        +
        +
      • +
      • +
        eTag: string
        +

        ETag to compare to.

        +
        +
      • +
      • +
        strict: boolean
        +

        True if the comparison needs to be on representation level. + False if it is on resource level and the content-type doesn't matter.

        +
        +
      +

      Returns boolean

      +
+
+ +
sameResourceState: ((eTag1, eTag2) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (eTag1, eTag2): boolean
    • +
    • +

      Validates whether 2 ETags correspond to the same state of a resource, +independent of the representation the ETags correspond to.

      +
      +
      +

      Parameters

      +
        +
      • +
        eTag1: string
        +

        First ETag to compare.

        +
        +
      • +
      • +
        eTag2: string
        +

        Second ETag to compare.

        +
        +
      +

      Returns boolean

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/EmailArgs.html b/7.x/docs/interfaces/EmailArgs.html new file mode 100644 index 000000000..150a2ccd3 --- /dev/null +++ b/7.x/docs/interfaces/EmailArgs.html @@ -0,0 +1,106 @@ +EmailArgs | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/interfaces/EmailSenderArgs.html b/7.x/docs/interfaces/EmailSenderArgs.html new file mode 100644 index 000000000..3258bf1c8 --- /dev/null +++ b/7.x/docs/interfaces/EmailSenderArgs.html @@ -0,0 +1,106 @@ +EmailSenderArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface EmailSenderArgs

+
+

Hierarchy

+
    +
  • EmailSenderArgs
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
emailConfig: {
    auth: {
        pass: string;
        user: string;
    };
    host: string;
    port: number;
}
+
+

Type declaration

+
    +
  • +
    auth: {
        pass: string;
        user: string;
    }
    +
      +
    • +
      pass: string
    • +
    • +
      user: string
  • +
  • +
    host: string
  • +
  • +
    port: number
+
+ +
senderName?: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ErrorHandlerArgs.html b/7.x/docs/interfaces/ErrorHandlerArgs.html new file mode 100644 index 000000000..e80617075 --- /dev/null +++ b/7.x/docs/interfaces/ErrorHandlerArgs.html @@ -0,0 +1,92 @@ +ErrorHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ErrorHandlerArgs

+
+

Hierarchy

+
    +
  • ErrorHandlerArgs
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
error: HttpError<number>
+
+ +
request: HttpRequest
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ExpiringReadWriteLocker.html b/7.x/docs/interfaces/ExpiringReadWriteLocker.html new file mode 100644 index 000000000..2872fce27 --- /dev/null +++ b/7.x/docs/interfaces/ExpiringReadWriteLocker.html @@ -0,0 +1,203 @@ +ExpiringReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ExpiringReadWriteLocker

+
+

A ReadWriteLocker where the locks expire after a given time.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
withReadLock: (<T>(identifier, whileLocked) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(identifier, whileLocked): Promise<T>
    • +
    • +

      As ReadWriteLocker.withReadLock but the locked function gets called with a maintainLock callback function +to reset the lock expiration every time it is called. +The resulting promise will reject once the lock expires.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T

      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of the resource that needs to be locked.

        +
        +
      • +
      • +
        whileLocked: ((maintainLock) => PromiseOrValue<T>)
        +

        A function to execute while the resource is locked. +Receives a callback as input parameter to maintain the lock.

        +
        +
        +
          +
        • +
            +
          • (maintainLock): PromiseOrValue<T>
          • +
          • +
            +

            Parameters

            +
              +
            • +
              maintainLock: (() => void)
              +
                +
              • +
                  +
                • (): void
                • +
                • +

                  Returns void

            +

            Returns PromiseOrValue<T>

      +

      Returns Promise<T>

      +
+
+ +
withWriteLock: (<T>(identifier, whileLocked) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(identifier, whileLocked): Promise<T>
    • +
    • +

      As ReadWriteLocker.withWriteLock but the locked function gets called with a maintainLock +callback function to reset the lock expiration every time it is called. +The resulting promise will reject once the lock expires.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T

      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of the resource that needs to be locked.

        +
        +
      • +
      • +
        whileLocked: ((maintainLock) => PromiseOrValue<T>)
        +

        A function to execute while the resource is locked. +Receives a callback as input parameter to maintain the lock.

        +
        +
        +
          +
        • +
            +
          • (maintainLock): PromiseOrValue<T>
          • +
          • +
            +

            Parameters

            +
              +
            • +
              maintainLock: (() => void)
              +
                +
              • +
                  +
                • (): void
                • +
                • +

                  Returns void

            +

            Returns PromiseOrValue<T>

      +

      Returns Promise<T>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ExpiringStorage.html b/7.x/docs/interfaces/ExpiringStorage.html new file mode 100644 index 000000000..cd4145cb1 --- /dev/null +++ b/7.x/docs/interfaces/ExpiringStorage.html @@ -0,0 +1,260 @@ +ExpiringStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ExpiringStorage<TKey, TValue>

+
+

A KeyValueStorage in which the values can expire. +Entries with no expiration date never expire.

+
+
+
+

Type Parameters

+
    +
  • +

    TKey

  • +
  • +

    TValue

+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Methods

+
set +
+
+

Properties

+
+ +
delete: ((key) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<boolean>
    • +
    • +

      Deletes the value stored for the given key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
        +

        Key to delete.

        +
        +
      +

      Returns Promise<boolean>

      If there was a value to delete.

      + +
+
+ +
entries: (() => AsyncIterableIterator<[TKey, TValue]>)
+
+

Type declaration

+
    +
  • +
      +
    • (): AsyncIterableIterator<[TKey, TValue]>
    • +
    • +

      An iterable of entries in the storage.

      +
      +

      Returns AsyncIterableIterator<[TKey, TValue]>

      +
+
+ +
get: ((key) => Promise<undefined | TValue>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<undefined | TValue>
    • +
    • +

      Returns the value stored for the given identifier. +undefined if no value is stored.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns Promise<undefined | TValue>

      +
+
+ +
has: ((key) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<boolean>
    • +
    • +

      Checks whether there is a value stored for the given key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns Promise<boolean>

      +
+
+

Methods

+
+ +
    + +
  • +

    Sets the value for the given key. +Should error if the data is already expired.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: TKey
      +

      Key to set/update.

      +
      +
    • +
    • +
      value: TValue
      +

      Value to store.

      +
      +
    • +
    • +
      Optional expiration: number
      +

      How long this data should stay valid in milliseconds.

      +
      +
    +

    Returns Promise<ExpiringStorage<TKey, TValue>>

    The storage.

    + +
  • + +
  • +

    Sets the value for the given key. +Should error if the data is already expired.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: TKey
      +

      Key to set/update.

      +
      +
    • +
    • +
      value: TValue
      +

      Value to store.

      +
      +
    • +
    • +
      Optional expires: Date
      +

      When this value expires. Never if undefined.

      +
      +
    +

    Returns Promise<ExpiringStorage<TKey, TValue>>

    The storage.

    + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/FileIdentifierMapper.html b/7.x/docs/interfaces/FileIdentifierMapper.html new file mode 100644 index 000000000..9c9adff4e --- /dev/null +++ b/7.x/docs/interfaces/FileIdentifierMapper.html @@ -0,0 +1,158 @@ +FileIdentifierMapper | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface FileIdentifierMapper

+
+

Supports mapping a file to an URL and back.

+
+
+
+

Hierarchy

+
    +
  • FileIdentifierMapper
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
mapFilePathToUrl: ((filePath, isContainer) => Promise<ResourceLink>)
+
+

Type declaration

+
    +
  • +
      +
    • (filePath, isContainer): Promise<ResourceLink>
    • +
    • +

      Maps the given file path to an URL and determines the content-type

      +
      +
      +

      Parameters

      +
        +
      • +
        filePath: string
        +

        The input file path.

        +
        +
      • +
      • +
        isContainer: boolean
        +

        If the path corresponds to a file.

        +
        +
      +

      Returns Promise<ResourceLink>

      A ResourceLink with all the necessary metadata.

      + +
+
+ +
mapUrlToFilePath: ((identifier, isMetadata, contentType?) => Promise<ResourceLink>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, isMetadata, contentType?): Promise<ResourceLink>
    • +
    • +

      Maps the given resource identifier / URL to a file path. +Determines the content-type, if no content-type was provided, by finding the corresponding file. +If there is no corresponding file, a file path will be generated. +For containers, the content-type input gets ignored.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        The input identifier.

        +
        +
      • +
      • +
        isMetadata: boolean
        +

        If we are mapping the metadata of the resource instead of its data.

        +
        +
      • +
      • +
        Optional contentType: string
        +

        The (optional) content-type of the resource.

        +
        +
      +

      Returns Promise<ResourceLink>

      A ResourceLink with all the necessary metadata.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/FileIdentifierMapperFactory.html b/7.x/docs/interfaces/FileIdentifierMapperFactory.html new file mode 100644 index 000000000..e252245a5 --- /dev/null +++ b/7.x/docs/interfaces/FileIdentifierMapperFactory.html @@ -0,0 +1,114 @@ +FileIdentifierMapperFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface FileIdentifierMapperFactory<T>

+
+

Factory that can create FileIdentifierMappers so the base and rootFilePath can be set dynamically. +Specifically used when identifiers need to be generated for a new pod (since pod identifiers are generated).

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • FileIdentifierMapperFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
create: ((base, rootFilePath) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (base, rootFilePath): Promise<T>
    • +
    • +
      +

      Parameters

      +
        +
      • +
        base: string
      • +
      • +
        rootFilePath: string
      +

      Returns Promise<T>

+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Finalizable.html b/7.x/docs/interfaces/Finalizable.html new file mode 100644 index 000000000..d43893d21 --- /dev/null +++ b/7.x/docs/interfaces/Finalizable.html @@ -0,0 +1,105 @@ +Finalizable | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Finalizable

+
+

Allows for cleaning up an object and stopping relevant loops when the application needs to be stopped. +Use this interface to add finalization logic to classes that already extend some other type. +NOTE: classes without an existing extends-relation should extend from Finalizer instead!

+
+
+
+

Hierarchy

+
    +
  • Finalizable
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
finalize: (() => Promise<void>)
+
+

Type declaration

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

      Returns Promise<void>

+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ForgotPasswordHandlerArgs.html b/7.x/docs/interfaces/ForgotPasswordHandlerArgs.html new file mode 100644 index 000000000..508bfeefb --- /dev/null +++ b/7.x/docs/interfaces/ForgotPasswordHandlerArgs.html @@ -0,0 +1,133 @@ +ForgotPasswordHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ForgotPasswordHandlerArgs

+
+

Hierarchy

+
    +
  • ForgotPasswordHandlerArgs
+
+
+
+ +
+
+

Properties

+
+ +
emailSender: EmailSender
+

Sender to send the actual email.

+
+
+
+ +
forgotPasswordStore: ForgotPasswordStore
+

Store containing the forgot password records.

+
+
+
+ +
passwordStore: PasswordStore
+

Store containing the password login information.

+
+
+
+ +
resetRoute: InteractionRoute<never>
+

Route used to generate the reset link for the user.

+
+
+
+ +
templateEngine: TemplateEngine<{
    resetLink: string;
}>
+

Template engine that will be used to generate the email body.

+
+
+

Type declaration

+
    +
  • +
    resetLink: string
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ForgotPasswordStore.html b/7.x/docs/interfaces/ForgotPasswordStore.html new file mode 100644 index 000000000..c1396d8e7 --- /dev/null +++ b/7.x/docs/interfaces/ForgotPasswordStore.html @@ -0,0 +1,169 @@ +ForgotPasswordStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ForgotPasswordStore

+
+

Responsible for storing the records that are used when a user forgets their password.

+
+
+
+

Hierarchy

+
    +
  • ForgotPasswordStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
delete: ((recordId) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (recordId): Promise<boolean>
    • +
    • +

      Deletes the Forgot Password Confirmation Record.

      +
      +
      +

      Parameters

      +
        +
      • +
        recordId: string
        +

        The record id of the forgot password confirmation record.

        +
        +
      +

      Returns Promise<boolean>

      +
+
+ +
generate: ((id) => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<string>
    • +
    • +

      Creates a Forgot Password Confirmation Record. This will be to remember that +a user has made a request to reset a password. Throws an error if the email doesn't +exist.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the email/password login object.

        +
        +
      +

      Returns Promise<string>

      The record id. This should be included in the reset password link.

      + +
+
+ +
get: ((recordId) => Promise<undefined | string>)
+
+

Type declaration

+
    +
  • +
      +
    • (recordId): Promise<undefined | string>
    • +
    • +

      Gets the email associated with the forgot password confirmation record +or undefined if it's not present.

      +
      +
      +

      Parameters

      +
        +
      • +
        recordId: string
        +

        The record id retrieved from the link.

        +
        +
      +

      Returns Promise<undefined | string>

      The user's email.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Forwarded.html b/7.x/docs/interfaces/Forwarded.html new file mode 100644 index 000000000..2230ea5eb --- /dev/null +++ b/7.x/docs/interfaces/Forwarded.html @@ -0,0 +1,122 @@ +Forwarded | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Forwarded

+
+

The Forwarded header from RFC7239

+
+
+
+

Hierarchy

+
    +
  • Forwarded
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
by?: string
+

The user-agent facing interface of the proxy

+
+
+
+ +
for?: string
+

The node making the request to the proxy

+
+
+
+ +
host?: string
+

The host request header field as received by the proxy

+
+
+
+ +
proto?: string
+

The protocol used to make the request

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/GenericEventEmitter.html b/7.x/docs/interfaces/GenericEventEmitter.html new file mode 100644 index 000000000..decbb7718 --- /dev/null +++ b/7.x/docs/interfaces/GenericEventEmitter.html @@ -0,0 +1,446 @@ +GenericEventEmitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface GenericEventEmitter<TEvent, TFunc>

+
+

A typed interface of EventEmitter.

+

Use the & operator to combine multiple event/function pairs into a single event emitter. +The result needs to be a type and not an interface because of https://github.com/microsoft/TypeScript/issues/16936.

+

Use the createGenericEventEmitterClass function to generate an event emitter class with the correct typings +in case EventEmitter needs to be extended.

+
+
+
+

Type Parameters

+
    +
  • +

    TEvent extends string | symbol

  • +
  • +

    TFunc extends ((...args) => void)

+
+

Hierarchy

+
    +
  • EventEmitter +
      +
    • GenericEventEmitter
+
+
+
+ +
+
+

Properties

+
+ +
addListener: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+ +
emit: ((event, ...args) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (event, ...args): boolean
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: TEvent
      • +
      • +
        Rest ...args: Parameters<TFunc>
      +

      Returns boolean

+
+ +
eventNames: (() => TEvent[])
+
+

Type declaration

+
    +
  • +
      +
    • (): TEvent[]
    • +
    • +

      Returns TEvent[]

+
+ +
listenerCount: ((event) => number)
+
+

Type declaration

+
    +
  • +
      +
    • (event): number
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: TEvent
      +

      Returns number

+
+ +
listeners: ((event) => TFunc[])
+
+

Type declaration

+
    +
  • +
      +
    • (event): TFunc[]
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: TEvent
      +

      Returns TFunc[]

+
+ +
off: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+ +
on: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+ +
once: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+ +
prependListener: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+ +
prependOnceListener: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+ +
rawListeners: ((event) => TFunc[])
+
+

Type declaration

+
    +
  • +
      +
    • (event): TFunc[]
    • +
    • +
      +

      Parameters

      +
        +
      • +
        event: TEvent
      +

      Returns TFunc[]

+
+ +
removeAllListeners: ((event) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+ +
removeListener: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+

Methods

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      error: Error
    • +
    • +
      event: string
    • +
    • +
      Rest ...args: any[]
    +

    Returns void

+
+ +
    + +
  • +

    Returns the current max listener value for the EventEmitter which is either +set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    +
    +

    Returns number

    +
    +

    Since

    v1.0.0

    +
+
+ +
    + +
  • +

    By default EventEmitters will print a warning if more than 10 listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The emitter.setMaxListeners() method allows the limit to be +modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
    +

    Returns GenericEventEmitter<TEvent, TFunc>

    +
    +

    Since

    v0.3.5

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/HttpErrorClass.html b/7.x/docs/interfaces/HttpErrorClass.html new file mode 100644 index 000000000..e42351358 --- /dev/null +++ b/7.x/docs/interfaces/HttpErrorClass.html @@ -0,0 +1,153 @@ +HttpErrorClass | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface HttpErrorClass<TCode>

+
+

Interface describing what an HttpError class should look like. +This helps us make sure all HttpError classes have the same utility static functions.

+
+
+
+

Type Parameters

+
    +
  • +

    TCode extends number = number

+
+

Hierarchy

+
    +
  • HttpErrorClass
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
isInstance: ((error) => error is HttpError<TCode>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<TCode>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<TCode>

      +
+
+ +
statusCode: TCode
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/HttpErrorOptions.html b/7.x/docs/interfaces/HttpErrorOptions.html new file mode 100644 index 000000000..844b14ec4 --- /dev/null +++ b/7.x/docs/interfaces/HttpErrorOptions.html @@ -0,0 +1,103 @@ +HttpErrorOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface HttpErrorOptions

+
+

Hierarchy

+
    +
  • HttpErrorOptions
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
cause?: unknown
+
+ +
errorCode?: string
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/HttpHandlerInput.html b/7.x/docs/interfaces/HttpHandlerInput.html new file mode 100644 index 000000000..05cd3f2e7 --- /dev/null +++ b/7.x/docs/interfaces/HttpHandlerInput.html @@ -0,0 +1,94 @@ +HttpHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface HttpHandlerInput

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
request: HttpRequest
+
+ +
response: HttpResponse
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/HttpServerFactory.html b/7.x/docs/interfaces/HttpServerFactory.html new file mode 100644 index 000000000..1b62ae5e6 --- /dev/null +++ b/7.x/docs/interfaces/HttpServerFactory.html @@ -0,0 +1,101 @@ +HttpServerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface HttpServerFactory

+
+

A factory for HTTP servers.

+
+
+
+

Hierarchy

+
    +
  • HttpServerFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
createServer: (() => Promise<Server<typeof IncomingMessage, typeof ServerResponse>>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<Server<typeof IncomingMessage, typeof ServerResponse>>
    • +
    • +

      Returns Promise<Server<typeof IncomingMessage, typeof ServerResponse>>

+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/IdentifierGenerator.html b/7.x/docs/interfaces/IdentifierGenerator.html new file mode 100644 index 000000000..554f02d8f --- /dev/null +++ b/7.x/docs/interfaces/IdentifierGenerator.html @@ -0,0 +1,135 @@ +IdentifierGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface IdentifierGenerator

+
+

Utility class for generating container identifiers.

+
+
+
+

Hierarchy

+
    +
  • IdentifierGenerator
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
extractPod: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
+
+ +
generate: ((name) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (name): ResourceIdentifier
    • +
    • +

      Generates container identifiers based on an input name. +This is simply string generation, no resource-related checks are run.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
      +

      Returns ResourceIdentifier

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/IdentifierStrategy.html b/7.x/docs/interfaces/IdentifierStrategy.html new file mode 100644 index 000000000..fa9a56f58 --- /dev/null +++ b/7.x/docs/interfaces/IdentifierStrategy.html @@ -0,0 +1,191 @@ +IdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface IdentifierStrategy

+
+

Captures the behavior of container identifiers in a certain storage configuration.

+
+
+
+

Hierarchy

+
    +
  • IdentifierStrategy
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
contains: ((container, identifier, transitive) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (container, identifier, transitive): boolean
    • +
    • +

      Checks if the given container would contain the given identifier. +This does not check that either of these identifiers actually exist. +This is similar to calling getParentContainer on an identifier +and comparing the result.

      +

      If transitive is false this only checks if container is the direct parent container of identifier.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      +
+
+ +
getParentContainer: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier
    • +
    • +

      Generates the identifier of the container this resource would be a member of. +This does not check if that identifier actually exists. +Will throw an error if the input identifier is a root container or is not supported.

      +
      +
      +

      Parameters

      +
      +

      Returns ResourceIdentifier

      +
+
+ +
isRootContainer: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
    • +
    • +

      Checks if the input corresponds to the identifier of a root container. +This does not check if this identifier actually exists.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      +
+
+ +
supportsIdentifier: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
    • +
    • +

      Verifies if this identifier is supported. +This does not check if this identifier actually exists, +but checks if the identifier is in scope for this class.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/IdentityProviderFactoryArgs.html b/7.x/docs/interfaces/IdentityProviderFactoryArgs.html new file mode 100644 index 000000000..7e0d2ba53 --- /dev/null +++ b/7.x/docs/interfaces/IdentityProviderFactoryArgs.html @@ -0,0 +1,188 @@ +IdentityProviderFactoryArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface IdentityProviderFactoryArgs

+
+

Hierarchy

+
    +
  • IdentityProviderFactoryArgs
+
+
+
+ +
+
+

Properties

+
+ +
adapterFactory: AdapterFactory
+

Factory that creates the adapter used for OIDC data storage.

+
+
+
+ +
baseUrl: string
+

Base URL of the server.

+
+
+
+ +
clientCredentialsStore: ClientCredentialsStore
+

Store containing the generated client credentials with their associated WebID.

+
+
+
+ +
errorHandler: ErrorHandler
+

Used to convert errors thrown by the OIDC library.

+
+
+
+ +
interactionRoute: InteractionRoute<never>
+

The route where requests should be redirected to in case of an OIDC interaction.

+
+
+
+ +
jwkGenerator: JwkGenerator
+

Generates the JWK used for signing and decryption.

+
+
+
+ +
oidcPath: string
+

Path for all requests targeting the OIDC library.

+
+
+
+ +
promptFactory: PromptFactory
+

Used to generate new prompt that are needed in addition to the defaults prompts.

+
+
+
+ +
responseWriter: ResponseWriter
+

Used to write out errors thrown by the OIDC library.

+
+
+
+ +
showStackTrace: boolean
+

Extra information will be added to the error output if this is true.

+
+
+
+ +
storage: KeyValueStorage<string, string[]>
+

Storage used to store cookie keys, so they can be re-used in case of multithreading.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/IdentityProviderHttpHandlerArgs.html b/7.x/docs/interfaces/IdentityProviderHttpHandlerArgs.html new file mode 100644 index 000000000..8fd3aed75 --- /dev/null +++ b/7.x/docs/interfaces/IdentityProviderHttpHandlerArgs.html @@ -0,0 +1,108 @@ +IdentityProviderHttpHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface IdentityProviderHttpHandlerArgs

+
+

Hierarchy

+
    +
  • IdentityProviderHttpHandlerArgs
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
cookieStore: CookieStore
+

Used to determine the account of the requesting agent.

+
+
+
+ + +

Handles the requests.

+
+
+
+ +
providerFactory: ProviderFactory
+

Used to generate the OIDC provider.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/IndexedStorage.html b/7.x/docs/interfaces/IndexedStorage.html new file mode 100644 index 000000000..9845b02fa --- /dev/null +++ b/7.x/docs/interfaces/IndexedStorage.html @@ -0,0 +1,507 @@ +IndexedStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface IndexedStorage<T>

+
+

A storage solution that allows for more complex queries than a key/value storage +and allows setting indexes on specific keys.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • IndexedStorage
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
create: (<TType>(type, value) => Promise<TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, value): Promise<TypeObject<T[TType]>>
    • +
    • +

      Creates an object of the given type. +The storage will generate an identifier for the newly created object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to create.

        +
        +
      • +
      • +
        value: CreateTypeObject<T[TType]>
        +

        The value to set for the created object.

        +
        +
      +

      Returns Promise<TypeObject<T[TType]>>

      A representation of the newly created object, including its new identifier.

      + +
+
+ +
createIndex: (<TType>(type, key) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, key): Promise<void>
    • +
    • +

      Creates an index on a key of the given type, to allow for better queries involving those keys. +Similar to IndexedStorage.defineType these calls need to happen first.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to create an index on.

        +
        +
      • +
      • +
        key: StringKey<T[TType]>
        +

        The key of that type to create an index on.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
defineType: (<TType>(type, description) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, description): Promise<void>
    • +
    • +

      Informs the storage of the definition of a specific type. +A definition is a key/value object with the values being a valid ValueTypeDescription. +Generally, this call needs to happen for every type of this storage, +and before any calls are made to interact with the data.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to define.

        +
        +
      • +
      • +
        description: T[TType]
        +

        A description of the values stored in objects of that type.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
delete: (<TType>(type, id) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<void>
    • +
    • +

      Deletes the given object. +This will also delete all objects that reference that object if the corresponding key is not optional.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to delete.

        +
        +
      • +
      • +
        id: string
        +

        The identifier of the object.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
entries: (<TType>(type) => AsyncIterableIterator<TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type): AsyncIterableIterator<TypeObject<T[TType]>>
    • +
    • +

      Returns an iterator over all objects of the given type.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to iterate over.

        +
        +
      +

      Returns AsyncIterableIterator<TypeObject<T[TType]>>

      +
+
+ +
find: (<TType>(type, query) => Promise<TypeObject<T[TType]>[]>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, query): Promise<TypeObject<T[TType]>[]>
    • +
    • +

      Finds all objects matching a specific IndexedQuery.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of objects to find.

        +
        +
      • +
      • +
        query: {
            [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
                ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
                : never)
        }
        +

        The query to execute.

        +
        +
      +

      Returns Promise<TypeObject<T[TType]>[]>

      A list of objects matching the query.

      + +
+
+ +
findIds: (<TType>(type, query) => Promise<string[]>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, query): Promise<string[]>
    • +
    • +

      Similar to IndexedStorage.find, but only returns the identifiers of the found objects.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of objects to find.

        +
        +
      • +
      • +
        query: {
            [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
                ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
                : never)
        }
        +

        The query to execute.

        +
        +
      +

      Returns Promise<string[]>

      A list of identifiers of the matching objects.

      + +
+
+ +
get: (<TType>(type, id) => Promise<undefined | TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<undefined | TypeObject<T[TType]>>
    • +
    • +

      Returns the object of the given type with the given identifier.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of object to get.

        +
        +
      • +
      • +
        id: string
        +

        The identifier of that object.

        +
        +
      +

      Returns Promise<undefined | TypeObject<T[TType]>>

      A representation of the object, or undefined if there is no object of that type with that identifier.

      + +
+
+ +
has: (<TType>(type, id) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<boolean>
    • +
    • +

      Returns true if the object of the given type with the given identifier exists.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of object to get.

        +
        +
      • +
      • +
        id: string
        +

        The identifier of that object.

        +
        +
      +

      Returns Promise<boolean>

      Whether this object exists.

      + +
+
+ +
set: (<TType>(type, value) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, value): Promise<void>
    • +
    • +

      Sets the value of a specific object. +The identifier in the object is used to identify the object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to set.

        +
        +
      • +
      • +
        value: TypeObject<T[TType]>
        +

        The new value for the object.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
setField: (<TType, TKey>(type, id, key, value) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType, TKey>(type, id, key, value): Promise<void>
    • +
    • +

      Sets the value of one specific field in an object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      • +
      • +

        TKey extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to update.

        +
        +
      • +
      • +
        id: string
        +

        The identifier of the object to update.

        +
        +
      • +
      • +
        key: TKey
        +

        The key to update.

        +
        +
      • +
      • +
        value: ValueType<T[TType][TKey]>
        +

        The new value for the given key.

        +
        +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Initializable.html b/7.x/docs/interfaces/Initializable.html new file mode 100644 index 000000000..56c17ed06 --- /dev/null +++ b/7.x/docs/interfaces/Initializable.html @@ -0,0 +1,104 @@ +Initializable | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Initializable

+
+

Allows for initializing state or executing logic when the application is started. +Use this interface to add initialization logic to classes that already extend some other type. +NOTE: classes without an existing extends-relation should extend from Initializer instead!

+
+
+
+

Hierarchy

+
    +
  • Initializable
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
initialize: (() => Promise<void>)
+
+

Type declaration

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

      Returns Promise<void>

+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/InteractionHandlerInput.html b/7.x/docs/interfaces/InteractionHandlerInput.html new file mode 100644 index 000000000..ed7bbebe4 --- /dev/null +++ b/7.x/docs/interfaces/InteractionHandlerInput.html @@ -0,0 +1,109 @@ +InteractionHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface InteractionHandlerInput

+
+

Hierarchy

+
    +
  • InteractionHandlerInput
+
+
+
+ +
+
+

Properties

+
+ +
accountId?: string
+

The account id of the agent doing the request if one could be found.

+
+
+
+ +
oidcInteraction?: Interaction
+

Will be defined if the OIDC library expects us to resolve an interaction it can't handle itself, +such as logging a user in.

+
+
+
+ +
operation: Operation
+

The operation to execute.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/InteractionRoute.html b/7.x/docs/interfaces/InteractionRoute.html new file mode 100644 index 000000000..491d302b7 --- /dev/null +++ b/7.x/docs/interfaces/InteractionRoute.html @@ -0,0 +1,150 @@ +InteractionRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface InteractionRoute<T>

+
+

Routes are used to handle the pathing for API calls.

+

They can have dynamic values in the paths they support. +Typings are used to indicate the keys used to indicate what the corresponding values are.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends string = never

+
+

Hierarchy

+
    +
  • InteractionRoute
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
getPath: ((parameters?) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (parameters?): string
    • +
    • +

      Returns the path that is the result of having the specified values for the dynamic parameters.

      +

      Will throw an error in case the input parameters object is missing one of the expected keys.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional parameters: Record<T, string>
        +

        Values for the dynamic parameters.

        +
        +
      +

      Returns string

      +
+
+ +
matchPath: ((path) => undefined | Record<T, string>)
+
+

Type declaration

+
    +
  • +
      +
    • (path): undefined | Record<T, string>
    • +
    • +

      Checks if the provided path matches the route (pattern).

      +

      The result will be undefined if there is no match.

      +

      If there is a match the result object will have the corresponding values for all the parameters.

      +
      +
      +

      Parameters

      +
        +
      • +
        path: string
        +

        The path to verify.

        +
        +
      +

      Returns undefined | Record<T, string>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/JsonInteractionHandlerInput.html b/7.x/docs/interfaces/JsonInteractionHandlerInput.html new file mode 100644 index 000000000..da19a4bf2 --- /dev/null +++ b/7.x/docs/interfaces/JsonInteractionHandlerInput.html @@ -0,0 +1,139 @@ +JsonInteractionHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface JsonInteractionHandlerInput

+
+

Hierarchy

+
    +
  • JsonInteractionHandlerInput
+
+
+
+ +
+
+

Properties

+
+ +
accountId?: string
+

The account id of the agent doing the request if one could be found.

+
+
+
+ +
json: unknown
+

The JSON body of the request.

+
+
+
+ + +

The metadata of the request.

+
+
+
+ +
method: string
+

The operation to execute.

+
+
+
+ +
oidcInteraction?: Interaction
+

Will be defined if the OIDC library expects us to resolve an interaction it can't handle itself, +such as logging a user in.

+
+
+
+ + +

The resource that is being targeted.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/JsonRepresentation.html b/7.x/docs/interfaces/JsonRepresentation.html new file mode 100644 index 000000000..e057c647d --- /dev/null +++ b/7.x/docs/interfaces/JsonRepresentation.html @@ -0,0 +1,103 @@ +JsonRepresentation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface JsonRepresentation<T>

+
+

Contains a JSON object and any associated metadata. +Similar to a Representation but with all the data in memory instead of as a stream +and specific to JSON.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • JsonRepresentation
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
json: T
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/JsonView.html b/7.x/docs/interfaces/JsonView.html new file mode 100644 index 000000000..3561d11f5 --- /dev/null +++ b/7.x/docs/interfaces/JsonView.html @@ -0,0 +1,117 @@ +JsonView | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface JsonView

+
+

An interface that can be used by classes that can provide a view besides doing an action. +Designed to be used by a JsonInteractionHandler that has a view explaining what JSON input it supports.

+
+
+
+

Hierarchy

+
    +
  • JsonView
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
getView: ((input) => Promise<JsonRepresentation<Dict<Json>>>)
+
+

Type declaration

+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/JwkGenerator.html b/7.x/docs/interfaces/JwkGenerator.html new file mode 100644 index 000000000..f21bbfdb1 --- /dev/null +++ b/7.x/docs/interfaces/JwkGenerator.html @@ -0,0 +1,131 @@ +JwkGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface JwkGenerator

+
+

Generates an asymmetric JWK.

+

The functions always need to return the same value.

+
+
+
+

Hierarchy

+
    +
  • JwkGenerator
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
alg: AsymmetricSigningAlgorithm
+

The algorithm used for the keys.

+
+
+
+ +
getPrivateKey: (() => Promise<AlgJwk>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<AlgJwk>
    • +
    • +

      Returns Promise<AlgJwk>

      The private key of the asymmetric JWK.

      + +
+
+ +
getPublicKey: (() => Promise<AlgJwk>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<AlgJwk>
    • +
    • +

      Returns Promise<AlgJwk>

      The public key of the asymmetric JWK.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/KeyValueStorage.html b/7.x/docs/interfaces/KeyValueStorage.html new file mode 100644 index 000000000..64222aa43 --- /dev/null +++ b/7.x/docs/interfaces/KeyValueStorage.html @@ -0,0 +1,224 @@ +KeyValueStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface KeyValueStorage<TKey, TValue>

+
+

A simple storage solution that can be used for internal values that need to be stored. +To prevent potential issues, keys should be urlencoded before calling the storage.

+
+
+
+

Type Parameters

+
    +
  • +

    TKey

  • +
  • +

    TValue

+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
delete: ((key) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<boolean>
    • +
    • +

      Deletes the value stored for the given key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
        +

        Key to delete.

        +
        +
      +

      Returns Promise<boolean>

      If there was a value to delete.

      + +
+
+ +
entries: (() => AsyncIterableIterator<[TKey, TValue]>)
+
+

Type declaration

+
    +
  • +
      +
    • (): AsyncIterableIterator<[TKey, TValue]>
    • +
    • +

      An iterable of entries in the storage.

      +
      +

      Returns AsyncIterableIterator<[TKey, TValue]>

      +
+
+ +
get: ((key) => Promise<undefined | TValue>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<undefined | TValue>
    • +
    • +

      Returns the value stored for the given identifier. +undefined if no value is stored.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns Promise<undefined | TValue>

      +
+
+ +
has: ((key) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<boolean>
    • +
    • +

      Checks whether there is a value stored for the given key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns Promise<boolean>

      +
+
+ +
set: ((key, value) => Promise<KeyValueStorage<TKey, TValue>>)
+
+

Type declaration

+
    +
  • +
      +
    • (key, value): Promise<KeyValueStorage<TKey, TValue>>
    • +
    • +

      Sets the value for the given key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
        +

        Key to set/update.

        +
        +
      • +
      • +
        value: TValue
        +

        Value to store.

        +
        +
      +

      Returns Promise<KeyValueStorage<TKey, TValue>>

      The storage.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/LinkWebIdHandlerArgs.html b/7.x/docs/interfaces/LinkWebIdHandlerArgs.html new file mode 100644 index 000000000..a217a8516 --- /dev/null +++ b/7.x/docs/interfaces/LinkWebIdHandlerArgs.html @@ -0,0 +1,139 @@ +LinkWebIdHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface LinkWebIdHandlerArgs

+
+

Hierarchy

+
    +
  • LinkWebIdHandlerArgs
+
+
+
+ +
+
+

Properties

+
+ +
baseUrl: string
+

Base URL of the server. +Used to indicate in the response what the object of the solid:oidcIssuer triple should be.

+
+
+
+ +
ownershipValidator: OwnershipValidator
+

Validates whether the user trying to link the WebID is the actual owner of that WebID.

+
+
+
+ +
podStore: PodStore
+

Pod store to find out if the account created the pod containing the WebID.

+
+
+
+ +
storageStrategy: StorageLocationStrategy
+

Before calling the OwnershipValidator, we first check if the target WebID is in a pod owned by the user.

+
+
+
+ +
webIdRoute: WebIdLinkRoute
+

Route used to generate the WebID link resource URL.

+
+
+
+ +
webIdStore: WebIdStore
+

WebID store to store WebID links.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/LogMetadata.html b/7.x/docs/interfaces/LogMetadata.html new file mode 100644 index 000000000..213dbf47e --- /dev/null +++ b/7.x/docs/interfaces/LogMetadata.html @@ -0,0 +1,98 @@ +LogMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface LogMetadata

+
+

Hierarchy

+
    +
  • LogMetadata
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
isPrimary: boolean
+

Is the current process the Primary process

+
+
+
+ +
pid: number
+

The process id of the current process

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Logger.html b/7.x/docs/interfaces/Logger.html new file mode 100644 index 000000000..eabf7d848 --- /dev/null +++ b/7.x/docs/interfaces/Logger.html @@ -0,0 +1,284 @@ +Logger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Logger

+
+

Logs messages, with convenience methods to log on a specific level.

+
+
+

See

getLoggerFor on how to instantiate loggers.

+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
debug: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
    • +
    • +

      Log a message at the 'debug' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+ +
error: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
    • +
    • +

      Log a message at the 'error' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+ +
info: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
    • +
    • +

      Log a message at the 'info' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+ +
log: ((level, message, meta?) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (level, message, meta?): Logger
    • +
    • +

      Log the given message at the given level. +If the internal level is higher than the given level, the message may be voided.

      +
      +
      +

      Parameters

      +
        +
      • +
        level: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
        +

        The level to log at.

        +
        +
      • +
      • +
        message: string
        +

        The message to log.

        +
        +
      • +
      • +
        Optional meta: LogMetadata
        +

        Optional metadata to include in the log message.

        +
        +
      +

      Returns Logger

      +
+
+ +
silly: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
    • +
    • +

      Log a message at the 'silly' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+ +
verbose: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
    • +
    • +

      Log a message at the 'verbose' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+ +
warn: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
    • +
    • +

      Log a message at the 'warn' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/LoggerFactory.html b/7.x/docs/interfaces/LoggerFactory.html new file mode 100644 index 000000000..23268bc5f --- /dev/null +++ b/7.x/docs/interfaces/LoggerFactory.html @@ -0,0 +1,114 @@ +LoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface LoggerFactory

+
+

Instantiates new logger instances.

+
+
+
+

Hierarchy

+
    +
  • LoggerFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
createLogger: ((label) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (label): Logger
    • +
    • +

      Create a logger instance for the given label.

      +
      +
      +

      Parameters

      +
        +
      • +
        label: string
        +

        A label that is used to identify the given logger.

        +
        +
      +

      Returns Logger

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/LoginStorage.html b/7.x/docs/interfaces/LoginStorage.html new file mode 100644 index 000000000..fa469d385 --- /dev/null +++ b/7.x/docs/interfaces/LoginStorage.html @@ -0,0 +1,524 @@ +LoginStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface LoginStorage<T>

+
+

A IndexedStorage where the defineType function +takes an extra parameter to indicate if the type corresponds to a login method. +This is useful for storages that want to add extra requirements based on the data being edited.

+

In practice, we use this because we want to require accounts to have at least 1 login method.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
create: (<TType>(type, value) => Promise<TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, value): Promise<TypeObject<T[TType]>>
    • +
    • +

      Creates an object of the given type. +The storage will generate an identifier for the newly created object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to create.

        +
        +
      • +
      • +
        value: CreateTypeObject<T[TType]>
        +

        The value to set for the created object.

        +
        +
      +

      Returns Promise<TypeObject<T[TType]>>

      A representation of the newly created object, including its new identifier.

      + +
+
+ +
createIndex: (<TType>(type, key) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, key): Promise<void>
    • +
    • +

      Creates an index on a key of the given type, to allow for better queries involving those keys. +Similar to IndexedStorage.defineType these calls need to happen first.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to create an index on.

        +
        +
      • +
      • +
        key: StringKey<T[TType]>
        +

        The key of that type to create an index on.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
defineType: (<TType>(type, description, isLogin) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, description, isLogin): Promise<void>
    • +
    • +

      Defines a type in the storage, just like in an IndexedStorage, +but additionally it needs to be indicated if the type corresponds to a login method or not.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        Type to define.

        +
        +
      • +
      • +
        description: T[TType]
        +

        Description of the type.

        +
        +
      • +
      • +
        isLogin: boolean
        +

        Whether this type corresponds to a login method or not.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
delete: (<TType>(type, id) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<void>
    • +
    • +

      Deletes the given object. +This will also delete all objects that reference that object if the corresponding key is not optional.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to delete.

        +
        +
      • +
      • +
        id: string
        +

        The identifier of the object.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
entries: (<TType>(type) => AsyncIterableIterator<TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type): AsyncIterableIterator<TypeObject<T[TType]>>
    • +
    • +

      Returns an iterator over all objects of the given type.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to iterate over.

        +
        +
      +

      Returns AsyncIterableIterator<TypeObject<T[TType]>>

      +
+
+ +
find: (<TType>(type, query) => Promise<TypeObject<T[TType]>[]>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, query): Promise<TypeObject<T[TType]>[]>
    • +
    • +

      Finds all objects matching a specific IndexedQuery.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of objects to find.

        +
        +
      • +
      • +
        query: {
            [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
                ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
                : never)
        }
        +

        The query to execute.

        +
        +
      +

      Returns Promise<TypeObject<T[TType]>[]>

      A list of objects matching the query.

      + +
+
+ +
findIds: (<TType>(type, query) => Promise<string[]>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, query): Promise<string[]>
    • +
    • +

      Similar to IndexedStorage.find, but only returns the identifiers of the found objects.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of objects to find.

        +
        +
      • +
      • +
        query: {
            [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
                ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
                : never)
        }
        +

        The query to execute.

        +
        +
      +

      Returns Promise<string[]>

      A list of identifiers of the matching objects.

      + +
+
+ +
get: (<TType>(type, id) => Promise<undefined | TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<undefined | TypeObject<T[TType]>>
    • +
    • +

      Returns the object of the given type with the given identifier.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of object to get.

        +
        +
      • +
      • +
        id: string
        +

        The identifier of that object.

        +
        +
      +

      Returns Promise<undefined | TypeObject<T[TType]>>

      A representation of the object, or undefined if there is no object of that type with that identifier.

      + +
+
+ +
has: (<TType>(type, id) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<boolean>
    • +
    • +

      Returns true if the object of the given type with the given identifier exists.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of object to get.

        +
        +
      • +
      • +
        id: string
        +

        The identifier of that object.

        +
        +
      +

      Returns Promise<boolean>

      Whether this object exists.

      + +
+
+ +
set: (<TType>(type, value) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, value): Promise<void>
    • +
    • +

      Sets the value of a specific object. +The identifier in the object is used to identify the object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to set.

        +
        +
      • +
      • +
        value: TypeObject<T[TType]>
        +

        The new value for the object.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
setField: (<TType, TKey>(type, id, key, value) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType, TKey>(type, id, key, value): Promise<void>
    • +
    • +

      Sets the value of one specific field in an object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      • +
      • +

        TKey extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to update.

        +
        +
      • +
      • +
        id: string
        +

        The identifier of the object to update.

        +
        +
      • +
      • +
        key: TKey
        +

        The key to update.

        +
        +
      • +
      • +
        value: ValueType<T[TType][TKey]>
        +

        The new value for the given key.

        +
        +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/MetadataWriterInput.html b/7.x/docs/interfaces/MetadataWriterInput.html new file mode 100644 index 000000000..5112eb2dc --- /dev/null +++ b/7.x/docs/interfaces/MetadataWriterInput.html @@ -0,0 +1,92 @@ +MetadataWriterInput | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationChannel.html b/7.x/docs/interfaces/NotificationChannel.html new file mode 100644 index 000000000..030fcc8a8 --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannel.html @@ -0,0 +1,209 @@ +NotificationChannel | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationChannel

+
+

Internal representation of a notification channel. +Most of the fields are those defined in +https://solidproject.org/TR/2022/notifications-protocol-20221231#notification-channel-data-model

+

We only support notification channels with a single topic.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+ +
accept?: string
+

The media type in which the receiver expects the notifications.

+
+
+
+ +
endAt?: number
+

When the channel should stop existing, in milliseconds since epoch.

+
+
+
+ +
id: string
+

The unique identifier of the channel.

+
+
+
+ +
lastEmit?: number
+

Internal value that we use to track when this channel last sent a notification.

+
+
+
+ +
rate?: number
+

The minimal time required between notifications, in milliseconds.

+
+
+
+ +
receiveFrom?: string
+

The resource receivers can use to establish a connection and receive notifications.

+
+
+
+ +
sendTo?: string
+

The resource on the receiver where notifications can be sent.

+
+
+
+ +
sender?: string
+

Can be used to identify the sender.

+
+
+
+ +
startAt?: number
+

When the channel should start sending notifications, in milliseconds since epoch.

+
+
+
+ +
state?: string
+

The state parameter sent by the receiver. +This is used to send a notification when the channel is established and the topic resource has a different state.

+
+
+
+ +
topic: string
+

The resource this channel sends notifications about.

+
+
+
+ +
type: string
+

The channel type.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationChannelStorage.html b/7.x/docs/interfaces/NotificationChannelStorage.html new file mode 100644 index 000000000..89677f640 --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannelStorage.html @@ -0,0 +1,222 @@ +NotificationChannelStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationChannelStorage

+
+

Stores all the information necessary to keep track of notification channels. +Besides the standard channel info it also stores features specific to a certain channel type.

+

This storage assumes that a channel can only have a single identifier as its topic.

+
+
+
+

Hierarchy

+
    +
  • NotificationChannelStorage
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
add: ((channel) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (channel): Promise<void>
    • +
    • +

      Adds the given channel to the storage.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+ +
delete: ((id) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<boolean>
    • +
    • +

      Deletes the given notification channel from the storage. +Returns true if the channel existed.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        The identifier of the notification channel

        +
        +
      +

      Returns Promise<boolean>

      +
+
+ +
get: ((id) => Promise<undefined | NotificationChannel>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<undefined | NotificationChannel>
    • +
    • +

      Returns the requested channel. +undefined if no match was found or if the notification channel expired.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        The identifier of the notification channel.

        +
        +
      +

      Returns Promise<undefined | NotificationChannel>

      +
+
+ +
getAll: ((topic) => Promise<string[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (topic): Promise<string[]>
    • +
    • +

      Returns the identifiers of all notification channel entries that have the given identifier as their topic. +The identifiers can potentially correspond to expired channels.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<string[]>

      +
+
+ +
update: ((channel) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (channel): Promise<void>
    • +
    • +

      Updates the given notification channel. +The id and the topic can not be updated.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationChannelType.html b/7.x/docs/interfaces/NotificationChannelType.html new file mode 100644 index 000000000..65b31cdaa --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannelType.html @@ -0,0 +1,218 @@ +NotificationChannelType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationChannelType

+
+

A specific channel type as defined at +https://solidproject.org/TR/2022/notifications-protocol-20221231#notification-channel-types.

+

All functions that take a NotificationChannel as input +only need to support channels generated by an initChannel on the same class.

+
+
+
+

Hierarchy

+
    +
  • NotificationChannelType
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
completeChannel: ((channel) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (channel): Promise<void>
    • +
    • +

      This function will be called after the serialized channel is sent back as a response, +allowing for any final actions that need to happen.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+ +
extractModes: ((channel) => Promise<AccessMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (channel): Promise<AccessMap>
    • +
    • +

      Determines which modes are required to allow the given notification channel.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<AccessMap>

      The required modes.

      + +
+
+ +
getDescription: (() => SubscriptionService)
+
+

Type declaration

+
+
+ +
initChannel: ((data, credentials) => Promise<NotificationChannel>)
+
+

Type declaration

+
+
+ +
toJsonLd: ((channel) => Promise<Record<string, unknown>>)
+
+

Type declaration

+
    +
  • +
      +
    • (channel): Promise<Record<string, unknown>>
    • +
    • +

      Converts a NotificationChannel to a serialized JSON-LD representation.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Record<string, unknown>>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationEmitterInput.html b/7.x/docs/interfaces/NotificationEmitterInput.html new file mode 100644 index 000000000..354c409ef --- /dev/null +++ b/7.x/docs/interfaces/NotificationEmitterInput.html @@ -0,0 +1,92 @@ +NotificationEmitterInput | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationHandlerInput.html b/7.x/docs/interfaces/NotificationHandlerInput.html new file mode 100644 index 000000000..db03e6179 --- /dev/null +++ b/7.x/docs/interfaces/NotificationHandlerInput.html @@ -0,0 +1,106 @@ +NotificationHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationHandlerInput

+
+

Hierarchy

+
    +
  • NotificationHandlerInput
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
activity?: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
+
+ +
+
+ +
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationSerializerInput.html b/7.x/docs/interfaces/NotificationSerializerInput.html new file mode 100644 index 000000000..47d2610b2 --- /dev/null +++ b/7.x/docs/interfaces/NotificationSerializerInput.html @@ -0,0 +1,92 @@ +NotificationSerializerInput | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationSubscriberArgs.html b/7.x/docs/interfaces/NotificationSubscriberArgs.html new file mode 100644 index 000000000..4330d2264 --- /dev/null +++ b/7.x/docs/interfaces/NotificationSubscriberArgs.html @@ -0,0 +1,151 @@ +NotificationSubscriberArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationSubscriberArgs

+
+

Hierarchy

+
    +
  • NotificationSubscriberArgs
+
+
+
+ +
+
+

Properties

+
+ +
authorizer: Authorizer
+

Used to determine if the request has the necessary permissions.

+
+
+
+ + +

The NotificationChannelType with all the necessary information.

+
+
+
+ + +

RepresentationConverter used to convert input data into RDF.

+
+
+
+ +
credentialsExtractor: CredentialsExtractor
+

Used to extract the credentials from the request.

+
+
+
+ +
maxDuration?: number
+

Overrides the expiration feature of channels, by making sure they always expire after the maxDuration value. +If the expiration of the channel is shorter than maxDuration, the original value will be kept. +Value is set in minutes. 0 is infinite. +Defaults to 20160 minutes, which is 2 weeks.

+
+
+
+ +
permissionReader: PermissionReader
+

Used to determine which permissions the found credentials have.

+
+
+
+ + +

Storage used to store the channels.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/OAuthErrorFields.html b/7.x/docs/interfaces/OAuthErrorFields.html new file mode 100644 index 000000000..8a490955c --- /dev/null +++ b/7.x/docs/interfaces/OAuthErrorFields.html @@ -0,0 +1,113 @@ +OAuthErrorFields | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface OAuthErrorFields

+
+

These are the fields that can occur in an OAuth error response as described in RFC 6749, §4.1.2.1. +https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1

+

This interface is identical to the ErrorOut interface of the oidc-provider library, +but having our own version reduces the part of the codebase that is dependent on that library.

+
+
+
+

Hierarchy

+
    +
  • OAuthErrorFields
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
error: string
+
+ +
error_description?: string
+
+ +
scope?: string
+
+ +
state?: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Operation.html b/7.x/docs/interfaces/Operation.html new file mode 100644 index 000000000..5602cc866 --- /dev/null +++ b/7.x/docs/interfaces/Operation.html @@ -0,0 +1,132 @@ +Operation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Operation

+
+

A single REST operation.

+
+
+
+

Hierarchy

+
    +
  • Operation
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ + +

Representation of the body and metadata headers.

+
+
+
+ +
conditions?: Conditions
+

Conditions the resource must fulfill for a valid operation.

+
+
+
+ +
method: string
+

The HTTP method (GET/POST/PUT/PATCH/DELETE/etc.).

+
+
+
+ + +

Representation preferences of the response. Will be empty if there are none.

+
+
+
+ + +

Identifier of the target.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/OperationHandlerInput.html b/7.x/docs/interfaces/OperationHandlerInput.html new file mode 100644 index 000000000..8c64baaca --- /dev/null +++ b/7.x/docs/interfaces/OperationHandlerInput.html @@ -0,0 +1,85 @@ +OperationHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface OperationHandlerInput

+
+

Hierarchy

+
    +
  • OperationHandlerInput
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
operation: Operation
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/OperationHttpHandlerInput.html b/7.x/docs/interfaces/OperationHttpHandlerInput.html new file mode 100644 index 000000000..6dad10c58 --- /dev/null +++ b/7.x/docs/interfaces/OperationHttpHandlerInput.html @@ -0,0 +1,103 @@ +OperationHttpHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface OperationHttpHandlerInput

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
operation: Operation
+
+ +
request: HttpRequest
+
+ +
response: HttpResponse
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/OriginalUrlExtractorArgs.html b/7.x/docs/interfaces/OriginalUrlExtractorArgs.html new file mode 100644 index 000000000..ac6af39a3 --- /dev/null +++ b/7.x/docs/interfaces/OriginalUrlExtractorArgs.html @@ -0,0 +1,98 @@ +OriginalUrlExtractorArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface OriginalUrlExtractorArgs

+
+

Hierarchy

+
    +
  • OriginalUrlExtractorArgs
+
+
+
+ +
+
+

Properties

+
+ +
identifierStrategy: IdentifierStrategy
+

The IdentifierStrategy to use for checking the scope of the request

+
+
+
+ +
includeQueryString?: boolean
+

Specify whether the OriginalUrlExtractor should include the request query string.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ParsingHttpHandlerArgs.html b/7.x/docs/interfaces/ParsingHttpHandlerArgs.html new file mode 100644 index 000000000..f504e2f5b --- /dev/null +++ b/7.x/docs/interfaces/ParsingHttpHandlerArgs.html @@ -0,0 +1,118 @@ +ParsingHttpHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ParsingHttpHandlerArgs

+
+

Hierarchy

+
    +
  • ParsingHttpHandlerArgs
+
+
+
+ +
+
+

Properties

+
+ +
errorHandler: ErrorHandler
+

Converts errors to a serializable format.

+
+
+
+ +
operationHandler: OperationHttpHandler
+

Handler to send the operation to.

+
+
+
+ +
requestParser: RequestParser
+

Parses the incoming requests.

+
+
+
+ +
responseWriter: ResponseWriter
+

Writes out the response of the operation.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PasswordLoginHandlerArgs.html b/7.x/docs/interfaces/PasswordLoginHandlerArgs.html new file mode 100644 index 000000000..d0e3e9a24 --- /dev/null +++ b/7.x/docs/interfaces/PasswordLoginHandlerArgs.html @@ -0,0 +1,99 @@ +PasswordLoginHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/interfaces/PasswordStore.html b/7.x/docs/interfaces/PasswordStore.html new file mode 100644 index 000000000..e290c0478 --- /dev/null +++ b/7.x/docs/interfaces/PasswordStore.html @@ -0,0 +1,318 @@ +PasswordStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PasswordStore

+
+

Responsible for storing everything related to email/password based login combinations.

+
+
+
+

Hierarchy

+
    +
  • PasswordStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
authenticate: ((email, password) => Promise<{
    accountId: string;
    id: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (email, password): Promise<{
          accountId: string;
          id: string;
      }>
    • +
    • +

      Authenticate if the email and password are correct and return the account and login ID if they are. +Throw an error if they are not.

      +
      +
      +

      Parameters

      +
        +
      • +
        email: string
        +

        The user's email.

        +
        +
      • +
      • +
        password: string
        +

        This user's password.

        +
        +
      +

      Returns Promise<{
          accountId: string;
          id: string;
      }>

      +
+
+ +
confirmVerification: ((id) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<void>
    • +
    • +

      Confirms that the login has been verified. +This can be used with, for example, email verification. +The login can only be used after it is verified. +In case verification is not required, this should be called immediately after the create call.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the login.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
create: ((email, accountId, password) => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (email, accountId, password): Promise<string>
    • +
    • +

      Creates a new login entry for this account.

      +
      +
      +

      Parameters

      +
        +
      • +
        email: string
        +

        Email to log in with.

        +
        +
      • +
      • +
        accountId: string
        +

        Account ID.

        +
        +
      • +
      • +
        password: string
        +

        Password to authenticate with.

        +
        +
      +

      Returns Promise<string>

      +
+
+ +
delete: ((id) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<void>
    • +
    • +

      Delete the login entry.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the login object.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
findByAccount: ((accountId) => Promise<{
    email: string;
    id: string;
}[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId): Promise<{
          email: string;
          id: string;
      }[]>
    • +
    • +

      Find all login objects created by this account.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        ID of the account to find the logins for.

        +
        +
      +

      Returns Promise<{
          email: string;
          id: string;
      }[]>

      +
+
+ +
findByEmail: ((email) => Promise<undefined | {
    accountId: string;
    id: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (email): Promise<undefined | {
          accountId: string;
          id: string;
      }>
    • +
    • +

      Finds the account and login ID associated with this email.

      +
      +
      +

      Parameters

      +
        +
      • +
        email: string
        +

        Email to find the information for.

        +
        +
      +

      Returns Promise<undefined | {
          accountId: string;
          id: string;
      }>

      +
+
+ +
get: ((id) => Promise<undefined | {
    accountId: string;
    email: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<undefined | {
          accountId: string;
          email: string;
      }>
    • +
    • +

      Finds the account and email associated with this login ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        The ID of the login object.

        +
        +
      +

      Returns Promise<undefined | {
          accountId: string;
          email: string;
      }>

      +
+
+ +
update: ((id, password) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (id, password): Promise<void>
    • +
    • +

      Changes the password.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the login object.

        +
        +
      • +
      • +
        password: string
        +

        The new password.

        +
        +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Patch.html b/7.x/docs/interfaces/Patch.html new file mode 100644 index 000000000..feda349f4 --- /dev/null +++ b/7.x/docs/interfaces/Patch.html @@ -0,0 +1,133 @@ +Patch | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Patch

+
+

Represents the changes needed for a PATCH request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
binary: boolean
+

Whether the data stream consists of binary/string chunks +(as opposed to complex objects).

+
+
+
+ +
data: Guarded<Readable>
+

The raw data stream for this representation.

+
+
+
+ +
isEmpty: boolean
+

Whether the data stream is empty. +This being true does not imply that the data stream has a length of more than 0, +only that it is a possibility and should be read to be sure.

+
+
+
+ + +

The corresponding metadata.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PermissionReaderInput.html b/7.x/docs/interfaces/PermissionReaderInput.html new file mode 100644 index 000000000..0b56725c4 --- /dev/null +++ b/7.x/docs/interfaces/PermissionReaderInput.html @@ -0,0 +1,99 @@ +PermissionReaderInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PermissionReaderInput

+
+

Hierarchy

+
    +
  • PermissionReaderInput
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
credentials: Credentials
+

Credentials of the entity requesting access to resources.

+
+
+
+ +
requestedModes: AccessMap
+

For each credential, the reader will check which of the given per-resource access modes are available. +However, non-exhaustive information about other access modes and resources can still be returned.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodCreatorInput.html b/7.x/docs/interfaces/PodCreatorInput.html new file mode 100644 index 000000000..18e83cc89 --- /dev/null +++ b/7.x/docs/interfaces/PodCreatorInput.html @@ -0,0 +1,122 @@ +PodCreatorInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodCreatorInput

+
+

Hierarchy

+
    +
  • PodCreatorInput
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
accountId: string
+

The ID of the account to create the pod for.

+
+
+
+ +
name?: string
+

The name to use when generating the base URL of the pod. +If undefined, the pod will be created in the root of the server.

+
+
+
+ +
settings?: Record<string, unknown>
+

Additional settings to use when generating a pod.

+
+
+
+ +
webId?: string
+

The WebID to use for creation of the pod. +This WebID will be used in the templates to, for example, determine who has access. +If none is provided, the WebID generated by the creator will be used, +in which case that WebID will also be linked to the account.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodCreatorOutput.html b/7.x/docs/interfaces/PodCreatorOutput.html new file mode 100644 index 000000000..a9cb54615 --- /dev/null +++ b/7.x/docs/interfaces/PodCreatorOutput.html @@ -0,0 +1,118 @@ +PodCreatorOutput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodCreatorOutput

+
+

Hierarchy

+
    +
  • PodCreatorOutput
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
podId: string
+

The ID of the generated pod.

+
+
+
+ +
podUrl: string
+

The URl of the generated pod.

+
+
+
+ +
webId: string
+

The WebID that was used to generate the pod.

+
+
+
+ +
webIdLink?: string
+

The ID of the WebID link if one was generated.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodGenerator.html b/7.x/docs/interfaces/PodGenerator.html new file mode 100644 index 000000000..5be268f8d --- /dev/null +++ b/7.x/docs/interfaces/PodGenerator.html @@ -0,0 +1,116 @@ +PodGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodGenerator

+
+

Generates an empty resource store to be used as a new pod. +It is also responsible for storing any relevant variables needed to instantiate this resource store. +These can then be used when the server is restarted to re-instantiate those stores.

+
+
+
+

Hierarchy

+
    +
  • PodGenerator
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
generate: ((settings) => Promise<ResourceStore>)
+
+

Type declaration

+
    +
  • +
      +
    • (settings): Promise<ResourceStore>
    • +
    • +

      Creates a ResourceStore based on the given input. +Should error if there already is a store for the given identifier.

      +
      +
      +

      Parameters

      +
        +
      • +
        settings: PodSettings
        +

        Parameters to be used for the new pod.

        +
        +
      +

      Returns Promise<ResourceStore>

      A new ResourceStore to be used for the new pod.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodManager.html b/7.x/docs/interfaces/PodManager.html new file mode 100644 index 000000000..5db47f071 --- /dev/null +++ b/7.x/docs/interfaces/PodManager.html @@ -0,0 +1,119 @@ +PodManager | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodManager

+
+

Covers all functions related to pod management. +In the future this should also include delete, and potentially recovery functions.

+
+
+
+

Hierarchy

+
    +
  • PodManager
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
createPod: ((settings, overwrite) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (settings, overwrite): Promise<void>
    • +
    • +

      Creates a pod for the given settings.

      +
      +
      +

      Parameters

      +
        +
      • +
        settings: PodSettings
        +

        Settings describing the pod.

        +
        +
      • +
      • +
        overwrite: boolean
        +

        If the creation should proceed if there already is a resource there.

        +
        +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodSettings.html b/7.x/docs/interfaces/PodSettings.html new file mode 100644 index 000000000..359b13a6f --- /dev/null +++ b/7.x/docs/interfaces/PodSettings.html @@ -0,0 +1,145 @@ +PodSettings | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodSettings

+
+

Metadata related to pod generation.

+
+
+
+

Hierarchy

+
    +
  • Dict<unknown> +
      +
    • PodSettings
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ + +

The root of the pod. Determines where the pod will be created.

+
+
+
+ +
email?: string
+

E-mail of the owner. Used in provisioning templates.

+
+
+
+ +
name?: string
+

Name of the owner. Used in provisioning templates.

+
+
+
+ +
oidcIssuer?: string
+

The OIDC issuer of the owner's WebId. Necessary if the WebID in the pod is registered with the IDP.

+
+
+
+ +
template?: string
+

Required for dynamic pod configuration. +Indicates the name of the config to use for the pod.

+
+
+
+ +
webId: string
+

The WebId of the owner of this pod.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodStore.html b/7.x/docs/interfaces/PodStore.html new file mode 100644 index 000000000..4a5496f57 --- /dev/null +++ b/7.x/docs/interfaces/PodStore.html @@ -0,0 +1,300 @@ +PodStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodStore

+
+

Can be used to create new pods and find relevant information. +Also keeps track of the owners of a pod. +The visible parameter indicates if an owner should be publicly exposed or not.

+
+
+
+

Hierarchy

+
    +
  • PodStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
create: ((accountId, settings, overwrite) => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId, settings, overwrite): Promise<string>
    • +
    • +

      Creates a new pod and updates the account accordingly.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        Identifier of the account that is creating the account.

        +
        +
      • +
      • +
        settings: PodSettings
        +

        Settings to create a pod with.

        +
        +
      • +
      • +
        overwrite: boolean
        +

        If the pod is allowed to overwrite existing data.

        +
        +
      +

      Returns Promise<string>

      The ID of the new pod resource.

      + +
+
+ +
findByBaseUrl: ((baseUrl) => Promise<undefined | {
    accountId: string;
    id: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (baseUrl): Promise<undefined | {
          accountId: string;
          id: string;
      }>
    • +
    • +

      Find the ID of the account that created the given pod.

      +
      +
      +

      Parameters

      +
        +
      • +
        baseUrl: string
        +

        The pod base URL.

        +
        +
      +

      Returns Promise<undefined | {
          accountId: string;
          id: string;
      }>

      +
+
+ +
findPods: ((accountId) => Promise<{
    baseUrl: string;
    id: string;
}[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId): Promise<{
          baseUrl: string;
          id: string;
      }[]>
    • +
    • +

      Find all the pod resources created by the given account ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        Account ID to find pod resources for.

        +
        +
      +

      Returns Promise<{
          baseUrl: string;
          id: string;
      }[]>

      +
+
+ +
get: ((id) => Promise<undefined | {
    accountId: string;
    baseUrl: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<undefined | {
          accountId: string;
          baseUrl: string;
      }>
    • +
    • +

      Returns the baseURl and account that created the pod for the given pod ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the pod.

        +
        +
      +

      Returns Promise<undefined | {
          accountId: string;
          baseUrl: string;
      }>

      +
+
+ +
getOwners: ((id) => Promise<undefined | {
    visible: boolean;
    webId: string;
}[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<undefined | {
          visible: boolean;
          webId: string;
      }[]>
    • +
    • +

      Find all owners for the given pod ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the pod.

        +
        +
      +

      Returns Promise<undefined | {
          visible: boolean;
          webId: string;
      }[]>

      +
+
+ +
removeOwner: ((id, webId) => Promise<void>)
+
+

Type declaration

+
+
+ +
updateOwner: ((id, webId, visible) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (id, webId, visible): Promise<void>
    • +
    • +

      Add or update an owner of a pod. +In case there already is an owner with this WebID, it will be updated, +otherwise a new owner will be added.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the pod.

        +
        +
      • +
      • +
        webId: string
        +

        WebID of the owner.

        +
        +
      • +
      • +
        visible: boolean
        +

        Whether the owner wants to be exposed or not.

        +
        +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ProviderFactory.html b/7.x/docs/interfaces/ProviderFactory.html new file mode 100644 index 000000000..4c25d9d35 --- /dev/null +++ b/7.x/docs/interfaces/ProviderFactory.html @@ -0,0 +1,106 @@ +ProviderFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ProviderFactory

+
+

Returns a Provider of OIDC interactions.

+
+
+
+

Hierarchy

+
    +
  • ProviderFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
getProvider: (() => Promise<default>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<default>
    • +
    • +

      Gets a provider from the factory. +Multiple calls to this function should return providers that produce the same results. +This is mostly relevant for signing keys.

      +
      +

      Returns Promise<default>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RdfStorePatcherInput.html b/7.x/docs/interfaces/RdfStorePatcherInput.html new file mode 100644 index 000000000..a02d78eae --- /dev/null +++ b/7.x/docs/interfaces/RdfStorePatcherInput.html @@ -0,0 +1,110 @@ +RdfStorePatcherInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RdfStorePatcherInput

+
+

Hierarchy

+
    +
  • RdfStorePatcherInput
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
identifier: ResourceIdentifier
+

Identifier of the resource that will be patched

+
+
+
+ +
patch: Patch
+

The changes represented by a Patch object

+
+
+
+ +
store: Store<Quad, Quad, Quad, Quad>
+

The store on which the patch will be executed. +Note the RdfStorePatcher is allowed to make changes to the store. +This means the store object might be modified by the patch.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ReadWriteLocker.html b/7.x/docs/interfaces/ReadWriteLocker.html new file mode 100644 index 000000000..022bb4644 --- /dev/null +++ b/7.x/docs/interfaces/ReadWriteLocker.html @@ -0,0 +1,179 @@ +ReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ReadWriteLocker

+
+

Allows the locking of resources which is needed for non-atomic ResourceStores.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
withReadLock: (<T>(identifier, whileLocked) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(identifier, whileLocked): Promise<T>
    • +
    • +

      Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T

      +
      +

      Parameters

      +
      +

      Returns Promise<T>

      A promise resolving when the lock is released.

      + +
+
+ +
withWriteLock: (<T>(identifier, whileLocked) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(identifier, whileLocked): Promise<T>
    • +
    • +

      Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T

      +
      +

      Parameters

      +
      +

      Returns Promise<T>

      A promise resolving when the lock is released.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RedirectHttpErrorClass.html b/7.x/docs/interfaces/RedirectHttpErrorClass.html new file mode 100644 index 000000000..066bfa078 --- /dev/null +++ b/7.x/docs/interfaces/RedirectHttpErrorClass.html @@ -0,0 +1,161 @@ +RedirectHttpErrorClass | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RedirectHttpErrorClass<TCode>

+
+

Interface describing what a RedirectHttpError class should look like. +Makes sure a location value is always needed.

+
+
+
+

Type Parameters

+
    +
  • +

    TCode extends number = number

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
isInstance: ((error) => error is HttpError<TCode>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<TCode>
    • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<TCode>

      +
+
+ +
statusCode: TCode
+

The status code corresponding to this error class.

+
+
+
+ +
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RedisSettings.html b/7.x/docs/interfaces/RedisSettings.html new file mode 100644 index 000000000..dcde265a1 --- /dev/null +++ b/7.x/docs/interfaces/RedisSettings.html @@ -0,0 +1,106 @@ +RedisSettings | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RedisSettings

+
+

Hierarchy

+
    +
  • RedisSettings
+
+
+
+ +
+
+

Properties

+
+ +
db?: number
+
+ +
namespacePrefix?: string
+
+ +
password?: string
+
+ +
username?: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Representation.html b/7.x/docs/interfaces/Representation.html new file mode 100644 index 000000000..5cc3dc04b --- /dev/null +++ b/7.x/docs/interfaces/Representation.html @@ -0,0 +1,131 @@ +Representation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Representation

+
+

A representation of a resource.

+
+
+
+

Hierarchy

+
    +
  • Representation +
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
binary: boolean
+

Whether the data stream consists of binary/string chunks +(as opposed to complex objects).

+
+
+
+ +
data: Guarded<Readable>
+

The raw data stream for this representation.

+
+
+
+ +
isEmpty: boolean
+

Whether the data stream is empty. +This being true does not imply that the data stream has a length of more than 0, +only that it is a possibility and should be read to be sure.

+
+
+
+ + +

The corresponding metadata.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RepresentationConverterArgs.html b/7.x/docs/interfaces/RepresentationConverterArgs.html new file mode 100644 index 000000000..cd315292a --- /dev/null +++ b/7.x/docs/interfaces/RepresentationConverterArgs.html @@ -0,0 +1,108 @@ +RepresentationConverterArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RepresentationConverterArgs

+
+

Hierarchy

+
    +
  • RepresentationConverterArgs
+
+
+
+ +
+
+

Properties

+
+ +
identifier: ResourceIdentifier
+

Identifier of the resource. Can be used as base IRI.

+
+
+
+ + +

Preferences indicating what is requested.

+
+
+
+ +
representation: Representation
+

Representation to convert.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RepresentationPatcherInput.html b/7.x/docs/interfaces/RepresentationPatcherInput.html new file mode 100644 index 000000000..52f634bbc --- /dev/null +++ b/7.x/docs/interfaces/RepresentationPatcherInput.html @@ -0,0 +1,104 @@ +RepresentationPatcherInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RepresentationPatcherInput<T>

+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
    +
  • RepresentationPatcherInput
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
identifier: ResourceIdentifier
+
+ +
patch: Patch
+
+ +
representation?: T
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RepresentationPreferences.html b/7.x/docs/interfaces/RepresentationPreferences.html new file mode 100644 index 000000000..55f1bb176 --- /dev/null +++ b/7.x/docs/interfaces/RepresentationPreferences.html @@ -0,0 +1,133 @@ +RepresentationPreferences | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RepresentationPreferences

+
+

Contains preferences along multiple content negotiation dimensions.

+

All dimensions are optional for ease of constructing; either undefined +or an empty ValuePreferences can indicate that no preferences were specified.

+
+
+
+

Hierarchy

+
    +
  • RepresentationPreferences
+
+
+
+ +
+
+

Properties

+
+ +
+
+ +
datetime?: ValuePreferences
+
+ +
encoding?: ValuePreferences
+
+ +
language?: ValuePreferences
+
+ +
range?: {
    parts: {
        end?: number;
        start: number;
    }[];
    unit: string;
}
+
+

Type declaration

+
    +
  • +
    parts: {
        end?: number;
        start: number;
    }[]
  • +
  • +
    unit: string
+
+ +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Resource.html b/7.x/docs/interfaces/Resource.html new file mode 100644 index 000000000..fec940f01 --- /dev/null +++ b/7.x/docs/interfaces/Resource.html @@ -0,0 +1,92 @@ +Resource | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourceIdentifier.html b/7.x/docs/interfaces/ResourceIdentifier.html new file mode 100644 index 000000000..791d554e4 --- /dev/null +++ b/7.x/docs/interfaces/ResourceIdentifier.html @@ -0,0 +1,92 @@ +ResourceIdentifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourceIdentifier

+
+

The unique identifier of a resource.

+
+
+
+

Hierarchy

+
    +
  • ResourceIdentifier
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
path: string
+

Path to the relevant resource.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourceLink.html b/7.x/docs/interfaces/ResourceLink.html new file mode 100644 index 000000000..994292645 --- /dev/null +++ b/7.x/docs/interfaces/ResourceLink.html @@ -0,0 +1,118 @@ +ResourceLink | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourceLink

+
+

Hierarchy

+
    +
  • ResourceLink
+
+
+
+ +
+
+

Properties

+
+ +
contentType?: string
+

Content-type for a document (not defined for containers).

+
+
+
+ +
filePath: string
+

File path of a resource.

+
+
+
+ +
identifier: ResourceIdentifier
+

Identifier of a resource.

+
+
+
+ +
isMetadata: boolean
+

If the resource is a metadata file.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourceLocker.html b/7.x/docs/interfaces/ResourceLocker.html new file mode 100644 index 000000000..144051043 --- /dev/null +++ b/7.x/docs/interfaces/ResourceLocker.html @@ -0,0 +1,145 @@ +ResourceLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourceLocker

+
+

An interface for classes that only have 1 way to lock interfaces. +In general this should only be used by components implementing the ReadWriteLocker interface. +Other components that require locking of resources should use that interface.

+
+
+
+

Hierarchy

+
    +
  • ResourceLocker
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
acquire: ((identifier) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<void>
    • +
    • +

      Acquires a lock on the requested identifier. +The promise will resolve when the lock has been acquired.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+ +
release: ((identifier) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<void>
    • +
    • +

      Releases a lock on the requested identifier. +The promise will resolve when the lock has been released. +If there is no lock on the resource, an error should be thrown.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourceSet.html b/7.x/docs/interfaces/ResourceSet.html new file mode 100644 index 000000000..f5a9caed3 --- /dev/null +++ b/7.x/docs/interfaces/ResourceSet.html @@ -0,0 +1,115 @@ +ResourceSet | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourceSet

+
+

A set containing resources.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
hasResource: ((identifier) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<boolean>
    • +
    • +

      Checks whether a resource exists in this ResourceSet.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<boolean>

      A promise resolving if the resource already exists.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourceStore.html b/7.x/docs/interfaces/ResourceStore.html new file mode 100644 index 000000000..39747a0e1 --- /dev/null +++ b/7.x/docs/interfaces/ResourceStore.html @@ -0,0 +1,311 @@ +ResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourceStore

+
+

A ResourceStore represents a collection of resources. +It has been designed such that each of its methods +can be implemented in an atomic way: for each CRUD operation, only one +dedicated method needs to be called. A fifth method enables the optimization +of partial updates with PATCH. It is up to the implementer of the interface to +(not) make an implementation atomic.

+

ResourceStores are also responsible for taking auxiliary resources into account +should those be relevant to the store.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
addResource: ((container, representation, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (container, representation, conditions?): Promise<ChangeMap>
    • +
    • +

      Creates a new resource in the container.

      +
      +
      +

      Parameters

      +
        +
      • +
        container: ResourceIdentifier
        +

        Container in which to create a resource.

        +
        +
      • +
      • +
        representation: Representation
        +

        Representation of the new resource

        +
        +
      • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+ +
deleteResource: ((identifier, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, conditions?): Promise<ChangeMap>
    • +
    • +

      Deletes a resource.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to delete.

        +
        +
      • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+ +
getRepresentation: ((identifier, preferences, conditions?) => Promise<Representation>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, preferences, conditions?): Promise<Representation>
    • +
    • +

      Retrieves a representation of a resource.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Representation>

      A representation corresponding to the identifier.

      + +
+
+ +
hasResource: ((identifier) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<boolean>
    • +
    • +

      Checks whether a resource exists in this ResourceSet.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<boolean>

      A promise resolving if the resource already exists.

      + +
+
+ +
modifyResource: ((identifier, patch, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, patch, conditions?): Promise<ChangeMap>
    • +
    • +

      Sets or updates the representation of a resource, +creating a new resource and intermediary containers as needed.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to update.

        +
        +
      • +
      • +
        patch: Patch
        +

        Description of which parts to update.

        +
        +
      • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+ +
setRepresentation: ((identifier, representation, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, representation, conditions?): Promise<ChangeMap>
    • +
    • +

      Sets or replaces the representation of a resource, +creating a new resource and intermediary containers as needed.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to update.

        +
        +
      • +
      • +
        representation: Representation
        +

        New representation of the resource.

        +
        +
      • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourcesGenerator.html b/7.x/docs/interfaces/ResourcesGenerator.html new file mode 100644 index 000000000..4a5efd04f --- /dev/null +++ b/7.x/docs/interfaces/ResourcesGenerator.html @@ -0,0 +1,120 @@ +ResourcesGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourcesGenerator

+
+

Generator used to create resources relative to a given base identifier. +Note that this is not an AsyncHandler since it returns an AsyncIterable instead of a promise.

+
+
+
+

Hierarchy

+
    +
  • ResourcesGenerator
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
generate: ((location, options) => AsyncIterable<Resource>)
+
+

Type declaration

+
    +
  • +
      +
    • (location, options): AsyncIterable<Resource>
    • +
    • +

      Generates resources with the given options. +The output Iterable should be sorted so that containers always appear before their contents.

      +
      +
      +

      Parameters

      +
        +
      • +
        location: ResourceIdentifier
        +

        Base identifier.

        +
        +
      • +
      • +
        options: Dict<unknown>
        +

        Options that can be used when generating resources.

        +
        +
      +

      Returns AsyncIterable<Resource>

      A map where the keys are the identifiers and the values the corresponding representations to store.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RouterHandlerArgs.html b/7.x/docs/interfaces/RouterHandlerArgs.html new file mode 100644 index 000000000..b9e149723 --- /dev/null +++ b/7.x/docs/interfaces/RouterHandlerArgs.html @@ -0,0 +1,136 @@ +RouterHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RouterHandlerArgs

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+ +
allowedMethods?: string[]
+

The allowed method(s). * can be used to indicate all methods are allowed. +Default is [ '*' ].

+
+
+
+ +
allowedPathNames?: string[]
+

Regular expression(s) used to match the target URL. +The base URl without trailing slash will be stripped of before applying the regular expressions, +so the input will always start with a /. +Default is [ '.*' ].

+
+
+
+ +
baseUrl?: string
+

The base URL of the server. +Not required if no value is provided for allowedPathNames.

+
+
+
+ +
handler: HttpHandler
+

The handler to call if all checks pass.

+
+
+
+ +
targetExtractor: TargetExtractor
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SeededAccountInitializerArgs.html b/7.x/docs/interfaces/SeededAccountInitializerArgs.html new file mode 100644 index 000000000..a6d9776ba --- /dev/null +++ b/7.x/docs/interfaces/SeededAccountInitializerArgs.html @@ -0,0 +1,118 @@ +SeededAccountInitializerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SeededAccountInitializerArgs

+
+

Hierarchy

+
    +
  • SeededAccountInitializerArgs
+
+
+
+ +
+
+

Properties

+
+ +
accountStore: AccountStore
+

Creates the accounts.

+
+
+
+ +
configFilePath?: string
+

File path of the JSON describing the accounts to seed.

+
+
+
+ +
passwordStore: PasswordStore
+

Adds the login methods.

+
+
+
+ +
podCreator: PodCreator
+

Creates the pods.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SetMultiMap.html b/7.x/docs/interfaces/SetMultiMap.html new file mode 100644 index 000000000..69d315823 --- /dev/null +++ b/7.x/docs/interfaces/SetMultiMap.html @@ -0,0 +1,474 @@ +SetMultiMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SetMultiMap<TKey, TVal>

+
+

A SetMultiMap is a Map where a single key can have multiple unique values. +Deleting a key removes all bindings with this key from the Map. +Setting a value for a key replaces all previous bindings with this key. +Using an empty Set when calling the set function is the same as deleting that key.

+
+
+
+

Type Parameters

+
    +
  • +

    TKey

  • +
  • +

    TVal

+
+

Hierarchy

+
    +
  • Map<TKey, TVal | ReadonlySet<TVal>> +
      +
    • SetMultiMap
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
[iterator]: (() => IterableIterator<[TKey, TVal]>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<[TKey, TVal]>
    • +
    • +

      Iterates over all key/value bindings in this Map.

      +
      +

      Returns IterableIterator<[TKey, TVal]>

      +
+
+ +
[toStringTag]: string
+
+ +
add: ((key, value) => SetMultiMap<TKey, TVal>)
+
+

Type declaration

+
    +
  • +
      +
    • (key, value): SetMultiMap<TKey, TVal>
    • +
    • +

      Adds the given key/value binding to the Map.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      • +
      • +
        value: TVal | ReadonlySet<TVal>
      +

      Returns SetMultiMap<TKey, TVal>

      +
+
+ +
asMap: (() => ReadonlyMap<TKey, ReadonlySet<TVal>>)
+
+

Type declaration

+
    +
  • +
      +
    • (): ReadonlyMap<TKey, ReadonlySet<TVal>>
    • +
    • +

      Returns a Readonly Map representation of this Map.

      +
      +

      Returns ReadonlyMap<TKey, ReadonlySet<TVal>>

      +
+
+ +
deleteEntry: ((key, value) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (key, value): boolean
    • +
    • +

      Deletes the given key/value binding from the Map.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      • +
      • +
        value: TVal
      +

      Returns boolean

      +
+
+ +
distinctKeys: (() => IterableIterator<TKey>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<TKey>
    • +
    • +

      Iterates over all distinct keys in this Map.

      +
      +

      Returns IterableIterator<TKey>

      +
+
+ +
entries: (() => IterableIterator<[TKey, TVal]>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<[TKey, TVal]>
    • +
    • +

      Iterates over all key/value bindings in this Map.

      +
      +

      Returns IterableIterator<[TKey, TVal]>

      +
+
+ +
entrySets: (() => IterableIterator<[TKey, ReadonlySet<TVal>]>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<[TKey, ReadonlySet<TVal>]>
    • +
    • +

      Iterates over all distinct keys in this Map, together with a Set of their values.

      +
      +

      Returns IterableIterator<[TKey, ReadonlySet<TVal>]>

      +
+
+ +
forEach: ((callbackfn, thisArg?) => void)
+
+

Type declaration

+
    +
  • +
      +
    • (callbackfn, thisArg?): void
    • +
    • +

      Loops over all key/value bindings.

      +
      +
      +

      Parameters

      +
        +
      • +
        callbackfn: ((value, key, map) => void)
        +
          +
        • +
            +
          • (value, key, map): void
          • +
          • +
            +

            Parameters

            +
              +
            • +
              value: TVal
            • +
            • +
              key: TKey
            • +
            • +
              map: SetMultiMap<TKey, TVal>
            +

            Returns void

      • +
      • +
        Optional thisArg: unknown
      +

      Returns void

      +
+
+ +
get: ((key) => undefined | ReadonlySet<TVal>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): undefined | ReadonlySet<TVal>
    • +
    • +

      Returns all values stored for the given key. +Returns undefined if there are no values for this key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns undefined | ReadonlySet<TVal>

      +
+
+ +
hasEntry: ((key, value) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (key, value): boolean
    • +
    • +

      Returns true if this key/value binding exists in the Map.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      • +
      • +
        value: TVal
      +

      Returns boolean

      +
+
+ +
size: number
+
+

Returns

the number of elements in the Map.

+
+
+ +
valueSets: (() => IterableIterator<ReadonlySet<TVal>>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<ReadonlySet<TVal>>
    • +
    • +

      Iterates over all distinct keys and returns their Set of values.

      +
      +

      Returns IterableIterator<ReadonlySet<TVal>>

      +
+
+ +
values: (() => IterableIterator<TVal>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<TVal>
    • +
    • +

      Iterates over all values in this Map.

      +
      +

      Returns IterableIterator<TVal>

      +
+
+

Methods

+
+ +
    + +
  • +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns boolean

    true if an element in the Map existed and has been removed, or false if the element does not exist.

    + +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns boolean

    boolean indicating whether an element with the specified key exists or not.

    + +
+
+ +
    + +
  • +

    Returns an iterable of keys in the map

    +
    +

    Returns IterableIterator<TKey>

    +
+
+ +
    + +
  • +

    Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: TKey
    • +
    • +
      value: TVal | ReadonlySet<TVal>
    +

    Returns SetMultiMap<TKey, TVal>

    +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SimpleLogger.html b/7.x/docs/interfaces/SimpleLogger.html new file mode 100644 index 000000000..beab8f49b --- /dev/null +++ b/7.x/docs/interfaces/SimpleLogger.html @@ -0,0 +1,123 @@ +SimpleLogger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SimpleLogger

+
+

Logs messages on a specific level.

+
+
+

See

getLoggerFor on how to instantiate loggers.

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
log +
+
+

Properties

+
+ +
log: ((level, message, meta?) => SimpleLogger)
+
+

Type declaration

+
    +
  • +
      +
    • (level, message, meta?): SimpleLogger
    • +
    • +

      Log the given message at the given level. +If the internal level is higher than the given level, the message may be voided.

      +
      +
      +

      Parameters

      +
        +
      • +
        level: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
        +

        The level to log at.

        +
        +
      • +
      • +
        message: string
        +

        The message to log.

        +
        +
      • +
      • +
        Optional meta: LogMetadata
        +

        Optional metadata to include in the log message.

        +
        +
      +

      Returns SimpleLogger

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SingleThreaded.html b/7.x/docs/interfaces/SingleThreaded.html new file mode 100644 index 000000000..5428086bb --- /dev/null +++ b/7.x/docs/interfaces/SingleThreaded.html @@ -0,0 +1,75 @@ +SingleThreaded | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SingleThreaded

+
+

Indicates a class is only meant to work in singlethreaded setups and is thus not threadsafe.

+
+
+
+

Hierarchy

+
    +
  • SingleThreaded
+
+

Implemented by

+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Size.html b/7.x/docs/interfaces/Size.html new file mode 100644 index 000000000..c9229b3f8 --- /dev/null +++ b/7.x/docs/interfaces/Size.html @@ -0,0 +1,96 @@ +Size | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Size

+
+

Describes the size of something by stating how much of a certain unit is present.

+
+
+
+

Hierarchy

+
    +
  • Size
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
amount: number
+
+ +
unit: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SizeReporter.html b/7.x/docs/interfaces/SizeReporter.html new file mode 100644 index 000000000..d22e194e7 --- /dev/null +++ b/7.x/docs/interfaces/SizeReporter.html @@ -0,0 +1,196 @@ +SizeReporter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SizeReporter<T>

+
+

A SizeReporter's only purpose (at the moment) is to calculate the size +of a resource. How the size is calculated or what unit it is in is defined by +the class implementing this interface. +One might use the amount of bytes and another might use the amount of triples +stored in a resource.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
    +
  • SizeReporter
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
calculateChunkSize: ((chunk) => Promise<number>)
+
+

Type declaration

+
    +
  • +
      +
    • (chunk): Promise<number>
    • +
    • +

      Calculate the size of a chunk based on which SizeReporter is being used

      +
      +
      +

      Parameters

      +
        +
      • +
        chunk: T
        +

        the chunk of which you want the size

        +
        +
      +

      Returns Promise<number>

      the size of the passed chunk as a number

      + +
+
+ +
estimateSize: ((metadata) => Promise<undefined | number>)
+
+

Type declaration

+
    +
  • +
      +
    • (metadata): Promise<undefined | number>
    • +
    • +

      Estimate the size of a body / request by looking at its metadata

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<undefined | number>

      the estimated size of the body / request or undefined if no +meaningful estimation can be made

      + +
+
+ +
getSize: ((identifier) => Promise<Size>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<Size>
    • +
    • +

      Get the size of a given resource

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Size>

      The size of the resource as a Size object calculated recursively +if the identifier leads to a container

      + +
+
+ +
getUnit: (() => string)
+
+

Type declaration

+
    +
  • +
      +
    • (): string
    • +
    • +

      Get the unit as a string in which a SizeReporter returns data

      +
      +

      Returns string

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SliceStreamOptions.html b/7.x/docs/interfaces/SliceStreamOptions.html new file mode 100644 index 000000000..7c9711af0 --- /dev/null +++ b/7.x/docs/interfaces/SliceStreamOptions.html @@ -0,0 +1,432 @@ +SliceStreamOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SliceStreamOptions

+
+

Hierarchy

+
    +
  • TransformOptions +
      +
    • SliceStreamOptions
+
+
+
+ +
+
+

Properties

+
+ +
allowHalfOpen?: boolean
+
+ +
autoDestroy?: boolean
+
+ +
decodeStrings?: boolean
+
+ +
defaultEncoding?: BufferEncoding
+
+ +
emitClose?: boolean
+
+ +
encoding?: BufferEncoding
+
+ +
end?: number
+
+ +
highWaterMark?: number
+
+ +
objectMode?: boolean
+
+ +
readableHighWaterMark?: number
+
+ +
readableObjectMode?: boolean
+
+ +
signal?: AbortSignal
+

When provided the corresponding AbortController can be used to cancel an asynchronous action.

+
+
+
+ +
size?: number
+
+ +
start: number
+
+ +
writableCorked?: number
+
+ +
writableHighWaterMark?: number
+
+ +
writableObjectMode?: boolean
+
+

Methods

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
    • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
    • +
    • +
      error: null | Error
    • +
    • +
      callback: ((error) => void)
      +
        +
      • +
          +
        • (error): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
    • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
    • +
    • +
      callback: TransformCallback
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
    • +
    • +
      size: number
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
    • +
    • +
      chunk: any
    • +
    • +
      encoding: BufferEncoding
    • +
    • +
      callback: TransformCallback
    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
    • +
    • +
      chunk: any
    • +
    • +
      encoding: BufferEncoding
    • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
    • +
    • +
      chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SparqlUpdatePatch.html b/7.x/docs/interfaces/SparqlUpdatePatch.html new file mode 100644 index 000000000..e4f8d0ebd --- /dev/null +++ b/7.x/docs/interfaces/SparqlUpdatePatch.html @@ -0,0 +1,141 @@ +SparqlUpdatePatch | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SparqlUpdatePatch

+
+

A specific type of Patch corresponding to a SPARQL update.

+
+
+
+

Hierarchy

+
    +
  • Patch +
      +
    • SparqlUpdatePatch
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
algebra: Update
+

Algebra corresponding to the SPARQL update.

+
+
+
+ +
binary: boolean
+

Whether the data stream consists of binary/string chunks +(as opposed to complex objects).

+
+
+
+ +
data: Guarded<Readable>
+

The raw data stream for this representation.

+
+
+
+ +
isEmpty: boolean
+

Whether the data stream is empty. +This being true does not imply that the data stream has a length of more than 0, +only that it is a possibility and should be read to be sure.

+
+
+
+ + +

The corresponding metadata.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/StorageLocationStrategy.html b/7.x/docs/interfaces/StorageLocationStrategy.html new file mode 100644 index 000000000..526f3b752 --- /dev/null +++ b/7.x/docs/interfaces/StorageLocationStrategy.html @@ -0,0 +1,111 @@ +StorageLocationStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface StorageLocationStrategy

+
+

Interface used to find the storage a specific identifier is located in.

+
+
+
+

Hierarchy

+
    +
  • StorageLocationStrategy
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
getStorageIdentifier: ((identifier) => Promise<ResourceIdentifier>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<ResourceIdentifier>
    • +
    • +

      Returns the identifier of the storage that contains the given resource. +Can error if the input identifier is not part of any storage.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<ResourceIdentifier>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SubfolderResourcesGeneratorArgs.html b/7.x/docs/interfaces/SubfolderResourcesGeneratorArgs.html new file mode 100644 index 000000000..26aad0321 --- /dev/null +++ b/7.x/docs/interfaces/SubfolderResourcesGeneratorArgs.html @@ -0,0 +1,133 @@ +SubfolderResourcesGeneratorArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SubfolderResourcesGeneratorArgs

+
+

Input arguments required for BaseResourcesGenerator

+
+
+
+

Hierarchy

+
    +
  • SubfolderResourcesGeneratorArgs
+
+
+
+ +
+
+

Properties

+
+ + +

Factory used to generate mapper relative to the base identifier.

+
+
+
+ +
metadataStrategy: AuxiliaryStrategy
+

The metadataStrategy

+
+
+
+ + +

The default ResourceStore

+
+
+
+ +
templateEngine: TemplateEngine<Dict<unknown>>
+

Template engine for generating the resources.

+
+
+
+ +
templateExtension?: string
+

The extension of files that need to be interpreted as templates. +Will be removed to generate the identifier.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SubscriptionService.html b/7.x/docs/interfaces/SubscriptionService.html new file mode 100644 index 000000000..71ec3d1e1 --- /dev/null +++ b/7.x/docs/interfaces/SubscriptionService.html @@ -0,0 +1,111 @@ +SubscriptionService | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SubscriptionService

+
+

A subscription service description as based on the specification data model +https://solidproject.org/TR/2022/notifications-protocol-20221231#subscription-service-data-model

+
+
+
+

Hierarchy

+
    +
  • SubscriptionService
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
@context: ["https://www.w3.org/ns/solid/notification/v1"]
+
+ +
channelType: string
+
+ +
feature: string[]
+
+ +
id: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SystemError.html b/7.x/docs/interfaces/SystemError.html new file mode 100644 index 000000000..f3a10ebdc --- /dev/null +++ b/7.x/docs/interfaces/SystemError.html @@ -0,0 +1,192 @@ +SystemError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SystemError

+
+

Interface for Node.js System errors

+

Node.js generates system errors when exceptions occur within its runtime environment. +These usually occur when an application violates an operating system constraint. +For example, a system error will occur if an application attempts to read a file that does not exist.

+
+
+
+

Hierarchy

+
    +
  • Error +
      +
    • SystemError
+
+
+
+ +
+
+

Properties

+
+ +
address?: string
+

If present, the address to which a network connection failed.

+
+
+
+ +
code: string
+

The string error code. +Full list: https://man7.org/linux/man-pages/man3/errno.3.html

+
+
+
+ +
dest?: string
+

If present, the file path destination when reporting a file system error.

+
+
+
+ +
errno: string | number
+

The system-provided error number.

+
+
+
+ +
info?: unknown
+

If present, extra details about the error condition.

+
+
+
+ +
message: string
+
+ +
name: string
+
+ +
path?: string
+

If present, the file path when reporting a file system error.

+
+
+
+ +
port?: string
+

If present, the network connection port that is not available.

+
+
+
+ +
stack?: string
+
+ +
syscall: string
+

The name of the system call that triggered the error.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/TemplateEngineInput.html b/7.x/docs/interfaces/TemplateEngineInput.html new file mode 100644 index 000000000..43449f332 --- /dev/null +++ b/7.x/docs/interfaces/TemplateEngineInput.html @@ -0,0 +1,101 @@ +TemplateEngineInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface TemplateEngineInput<T>

+
+

Utility interface for representing TemplateEngine input.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
    +
  • TemplateEngineInput
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
contents: T
+
+ +
template?: Template
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/TemplateOptions.html b/7.x/docs/interfaces/TemplateOptions.html new file mode 100644 index 000000000..a58524018 --- /dev/null +++ b/7.x/docs/interfaces/TemplateOptions.html @@ -0,0 +1,106 @@ +TemplateOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface TemplateOptions

+
+

Hierarchy

+
    +
  • TemplateOptions
+
+
+
+ +
+
+

Properties

+
+ +
codeTemplatesPath?: string
+
+ +
contentType?: string
+
+ +
extension?: string
+
+ +
mainTemplatePath?: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/TemplatePath.html b/7.x/docs/interfaces/TemplatePath.html new file mode 100644 index 000000000..f70ab7fe5 --- /dev/null +++ b/7.x/docs/interfaces/TemplatePath.html @@ -0,0 +1,92 @@ +TemplatePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface TemplatePath

+
+

Hierarchy

+
    +
  • TemplatePath
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
templateFile: string
+
+ +
templatePath?: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/TemplateString.html b/7.x/docs/interfaces/TemplateString.html new file mode 100644 index 000000000..aa213b651 --- /dev/null +++ b/7.x/docs/interfaces/TemplateString.html @@ -0,0 +1,85 @@ +TemplateString | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface TemplateString

+
+

Hierarchy

+
    +
  • TemplateString
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
templateString: string
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/TemplatedResourcesGenerator.html b/7.x/docs/interfaces/TemplatedResourcesGenerator.html new file mode 100644 index 000000000..74e0e2ea8 --- /dev/null +++ b/7.x/docs/interfaces/TemplatedResourcesGenerator.html @@ -0,0 +1,127 @@ +TemplatedResourcesGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface TemplatedResourcesGenerator

+
+

Generator used to create resources relative to a given base identifier. +Similar to ResourcesGenerator, but takes as input a string +indicating where the templates are stored that need to be used for resource generation.

+
+
+
+

Hierarchy

+
    +
  • TemplatedResourcesGenerator
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
generate: ((templateFolder, location, options) => AsyncIterable<Resource>)
+
+

Type declaration

+
    +
  • +
      +
    • (templateFolder, location, options): AsyncIterable<Resource>
    • +
    • +

      Generates resources with the given options, based on the given template folder. +The output Iterable should be sorted so that containers always appear before their contents.

      +
      +
      +

      Parameters

      +
        +
      • +
        templateFolder: string
        +

        Folder where the templates are located.

        +
        +
      • +
      • +
        location: ResourceIdentifier
        +

        Base identifier.

        +
        +
      • +
      • +
        options: Dict<unknown>
        +

        Options that can be used when generating resources.

        +
        +
      +

      Returns AsyncIterable<Resource>

      A map where the keys are the identifiers and the values the corresponding representations to store.

      + +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/V6MigrationInitializerArgs.html b/7.x/docs/interfaces/V6MigrationInitializerArgs.html new file mode 100644 index 000000000..fc1e6ff7c --- /dev/null +++ b/7.x/docs/interfaces/V6MigrationInitializerArgs.html @@ -0,0 +1,159 @@ +V6MigrationInitializerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface V6MigrationInitializerArgs

+
+

Hierarchy

+
    +
  • V6MigrationInitializerArgs
+
+
+
+ +
+
+

Properties

+
+ +
accountStorage: KeyValueStorage<string, Account | Settings>
+

The storage in which account data of the previous version is stored.

+
+
+
+ +
cleanupStorages: KeyValueStorage<string, any>[]
+

Storages for which all entries need to be removed.

+
+
+
+ +
clientCredentialsStorage: KeyValueStorage<string, ClientCredentials>
+

The storage in which client credentials are stored from the previous version.

+
+
+
+ +
newAccountStorage: AccountLoginStorage<Record<string, never>>
+

The storage that will contain the account data in the new format. +Wrong typings to prevent Components.js typing issues.

+
+
+
+ +
newSetupStorage: KeyValueStorage<string, string>
+

The storage that will contain the setup entries in the new format.

+
+
+
+ +
setupStorage: KeyValueStorage<string, string>
+

The storage in which all setup values are stored, including the version of the server.

+
+
+
+ +
skipConfirmation?: boolean
+

If true, no confirmation prompt will be printed to the stdout.

+
+
+
+ +
versionKey: string
+

The key necessary to get the version from the setupStorage.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WacAllowHttpHandlerArgs.html b/7.x/docs/interfaces/WacAllowHttpHandlerArgs.html new file mode 100644 index 000000000..98e6c85ba --- /dev/null +++ b/7.x/docs/interfaces/WacAllowHttpHandlerArgs.html @@ -0,0 +1,106 @@ +WacAllowHttpHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WacAllowHttpHandlerArgs

+
+

Hierarchy

+
    +
  • WacAllowHttpHandlerArgs
+
+
+
+ +
+
+

Properties

+
+ +
credentialsExtractor: CredentialsExtractor
+
+ +
modesExtractor: ModesExtractor
+
+ +
operationHandler: OperationHttpHandler
+
+ +
permissionReader: PermissionReader
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WebIdStore.html b/7.x/docs/interfaces/WebIdStore.html new file mode 100644 index 000000000..2c82d7dc2 --- /dev/null +++ b/7.x/docs/interfaces/WebIdStore.html @@ -0,0 +1,221 @@ +WebIdStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WebIdStore

+
+

Stores and updates WebID to Account links.

+
+
+
+

Hierarchy

+
    +
  • WebIdStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
create: ((webId, accountId) => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (webId, accountId): Promise<string>
    • +
    • +

      Creates a new WebID link for the given WebID and account.

      +
      +
      +

      Parameters

      +
        +
      • +
        webId: string
        +

        WebID to link.

        +
        +
      • +
      • +
        accountId: string
      +

      Returns Promise<string>

      ID of the link.

      + +
+
+ +
delete: ((linkId) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (linkId): Promise<void>
    • +
    • +

      Deletes the link with the given ID

      +
      +
      +

      Parameters

      +
        +
      • +
        linkId: string
        +

        ID of the link.

        +
        +
      +

      Returns Promise<void>

      +
+
+ +
findLinks: ((accountId) => Promise<{
    id: string;
    webId: string;
}[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId): Promise<{
          id: string;
          webId: string;
      }[]>
    • +
    • +

      Finds all links associated with the given account.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        ID of the account.

        +
        +
      +

      Returns Promise<{
          id: string;
          webId: string;
      }[]>

      +
+
+ +
get: ((linkId) => Promise<undefined | {
    accountId: string;
    webId: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (linkId): Promise<undefined | {
          accountId: string;
          webId: string;
      }>
    • +
    • +

      Finds the account and WebID of the link with the given ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        linkId: string
      +

      Returns Promise<undefined | {
          accountId: string;
          webId: string;
      }>

      +
+
+ +
isLinked: ((webId, accountId) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (webId, accountId): Promise<boolean>
    • +
    • +

      Determines if a WebID is linked to an account.

      +
      +
      +

      Parameters

      +
        +
      • +
        webId: string
        +

        WebID to check.

        +
        +
      • +
      • +
        accountId: string
        +

        ID of the account.

        +
        +
      +

      Returns Promise<boolean>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WebSocket2023HandlerInput.html b/7.x/docs/interfaces/WebSocket2023HandlerInput.html new file mode 100644 index 000000000..fd3ceff2d --- /dev/null +++ b/7.x/docs/interfaces/WebSocket2023HandlerInput.html @@ -0,0 +1,92 @@ +WebSocket2023HandlerInput | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/interfaces/WebSocketChannel2023.html b/7.x/docs/interfaces/WebSocketChannel2023.html new file mode 100644 index 000000000..7ed5cbde3 --- /dev/null +++ b/7.x/docs/interfaces/WebSocketChannel2023.html @@ -0,0 +1,217 @@ +WebSocketChannel2023 | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WebSocketChannel2023

+
+

A NotificationChannel containing the necessary fields for a WebSocketChannel2023 channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+ +
accept?: string
+

The media type in which the receiver expects the notifications.

+
+
+
+ +
endAt?: number
+

When the channel should stop existing, in milliseconds since epoch.

+
+
+
+ +
id: string
+

The unique identifier of the channel.

+
+
+
+ +
lastEmit?: number
+

Internal value that we use to track when this channel last sent a notification.

+
+
+
+ +
rate?: number
+

The minimal time required between notifications, in milliseconds.

+
+
+
+ +
receiveFrom: string
+

The WebSocket through which the channel will send notifications.

+
+
+
+ +
sendTo?: string
+

The resource on the receiver where notifications can be sent.

+
+
+
+ +
sender?: string
+

Can be used to identify the sender.

+
+
+
+ +
startAt?: number
+

When the channel should start sending notifications, in milliseconds since epoch.

+
+
+
+ +
state?: string
+

The state parameter sent by the receiver. +This is used to send a notification when the channel is established and the topic resource has a different state.

+
+
+
+ +
topic: string
+

The resource this channel sends notifications about.

+
+
+
+ +
type: "http://www.w3.org/ns/solid/notifications#WebSocketChannel2023"
+

The "notify:WebSocketChannel2023" type.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WebSocketHandlerInput.html b/7.x/docs/interfaces/WebSocketHandlerInput.html new file mode 100644 index 000000000..7eba206cc --- /dev/null +++ b/7.x/docs/interfaces/WebSocketHandlerInput.html @@ -0,0 +1,92 @@ +WebSocketHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WebSocketHandlerInput

+
+

Hierarchy

+
    +
  • WebSocketHandlerInput
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
upgradeRequest: HttpRequest
+
+ +
webSocket: WebSocket
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WebhookChannel2023.html b/7.x/docs/interfaces/WebhookChannel2023.html new file mode 100644 index 000000000..47d238e40 --- /dev/null +++ b/7.x/docs/interfaces/WebhookChannel2023.html @@ -0,0 +1,217 @@ +WebhookChannel2023 | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WebhookChannel2023

+
+

A NotificationChannel containing the necessary fields for a WebhookChannel2023 channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+ +
accept?: string
+

The media type in which the receiver expects the notifications.

+
+
+
+ +
endAt?: number
+

When the channel should stop existing, in milliseconds since epoch.

+
+
+
+ +
id: string
+

The unique identifier of the channel.

+
+
+
+ +
lastEmit?: number
+

Internal value that we use to track when this channel last sent a notification.

+
+
+
+ +
rate?: number
+

The minimal time required between notifications, in milliseconds.

+
+
+
+ +
receiveFrom?: string
+

The resource receivers can use to establish a connection and receive notifications.

+
+
+
+ +
sendTo: string
+

Where the notifications have to be sent.

+
+
+
+ +
sender?: string
+

Can be used to identify the sender.

+
+
+
+ +
startAt?: number
+

When the channel should start sending notifications, in milliseconds since epoch.

+
+
+
+ +
state?: string
+

The state parameter sent by the receiver. +This is used to send a notification when the channel is established and the topic resource has a different state.

+
+
+
+ +
topic: string
+

The resource this channel sends notifications about.

+
+
+
+ +
type: "http://www.w3.org/ns/solid/notifications#WebhookChannel2023"
+

The "WebhookChannel2023" type.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/modules.html b/7.x/docs/modules.html new file mode 100644 index 000000000..99ddd5517 --- /dev/null +++ b/7.x/docs/modules.html @@ -0,0 +1,884 @@ +Community Solid Server - v7.0.5
+
+ +
+
+
+
+

Community Solid Server - v7.0.5

+
+
+

Index

+
+

Enumerations

+
+
+

Classes

+
AbsolutePathInteractionRoute +AcceptPreferenceParser +AccessChecker +AccountInitializer +AccountPromptFactory +AcpHeaderHandler +AcpReader +ActivityNotificationGenerator +AddRemoveNotificationGenerator +AgentAccessChecker +AgentClassAccessChecker +AgentGroupAccessChecker +AllStaticReader +AllowAcceptHeaderWriter +App +AppRunner +ArrayUnionHandler +AssetPathExtractor +AsyncHandler +AtomicFileDataAccessor +AuthAuxiliaryReader +AuthorizationParser +AuthorizedRouteHandler +Authorizer +AuthorizingHttpHandler +AuxiliaryLinkMetadataWriter +AuxiliaryReader +BadRequestHttpError +Base64EncodingStorage +BaseAccountIdRoute +BaseAccountStore +BaseChannelType +BaseClientCredentialsIdRoute +BaseClientCredentialsStore +BaseComponentsJsFactory +BaseCookieStore +BaseEmailSender +BaseFileIdentifierMapper +BaseForgotPasswordStore +BaseIdentifierStrategy +BaseLogger +BaseLoginAccountStorage +BasePasswordIdRoute +BasePasswordStore +BasePodCreator +BasePodIdRoute +BasePodStore +BaseReadWriteLocker +BaseResourceStore +BaseResourcesGenerator +BaseRouterHandler +BaseServerFactory +BaseStateHandler +BaseTypedRepresentationConverter +BaseUrlExtractor +BaseUrlHandler +BaseUrlRouterRule +BaseUrlVerifier +BaseWebIdLinkRoute +BaseWebIdStore +BasicConditions +BasicConditionsParser +BasicETagHandler +BasicRepresentation +BasicRequestParser +BasicResponseWriter +BearerWebIdExtractor +BinarySliceResourceStore +BodyParser +BooleanHandler +CachedHandler +CachedJwkGenerator +CachedResourceSet +CancelOidcHandler +ChainedConverter +ChainedTemplateEngine +CliExtractor +CliResolver +ClientCredentialsAdapter +ClientCredentialsAdapterFactory +ClientCredentialsDetailsHandler +ClientIdAdapter +ClientIdAdapterFactory +ClientInfoHandler +ClusterManager +CombinedShorthandResolver +ComposedAuxiliaryStrategy +ComposedNotificationHandler +ConditionalHandler +ConditionsParser +ConfigPodInitializer +ConfigPodManager +ConflictHttpError +ConsentHandler +ConstantConverter +ConstantMetadataWriter +ContainerInitializer +ContainerPathStorage +ContainerToTemplateConverter +ContentLengthParser +ContentTypeMetadataWriter +ContentTypeParser +ContentTypeReplacer +ContextDocumentLoader +ControlHandler +ConvertingErrorHandler +ConvertingNotificationSerializer +ConvertingOperationHttpHandler +ConvertingPatcher +ConvertingRouterRule +CookieInteractionHandler +CookieMetadataWriter +CookieParser +CorsHandler +CreateAccountHandler +CreateClientCredentialsHandler +CreateModesExtractor +CreatePasswordHandler +CreatePodHandler +CreatedResponseDescription +CredentialsExtractor +DPoPWebIdExtractor +DataAccessorBasedStore +DeleteClientCredentialsHandler +DeleteNotificationGenerator +DeleteOperationHandler +DeleteParentExtractor +DeletePasswordHandler +DynamicJsonToTemplateConverter +EjsTemplateEngine +EmailSender +EqualReadWriteLocker +ErrorHandler +ErrorToJsonConverter +ErrorToQuadConverter +ErrorToTemplateConverter +ExpiringAdapter +ExpiringAdapterFactory +ExtensionBasedMapper +ExtensionBasedMapperFactory +ExtensionBasedTemplateEngine +FileDataAccessor +FileSizeReporter +FileSystemResourceLocker +FilterMetadataDataAccessor +FilterPattern +FinalizableHandler +Finalizer +FixedContentTypeMapper +ForbiddenHttpError +ForgetWebIdHandler +ForgotPasswordHandler +FormToJsonConverter +FoundHttpError +GeneratedPodManager +GetOperationHandler +GlobalQuotaStrategy +GreedyReadWriteLocker +HandlebarsTemplateEngine +HandlerServerConfigurator +HashEncodingStorage +HashMap +HeadOperationHandler +HeaderHandler +HtmlViewEntry +HtmlViewHandler +HttpError +HttpHandler +IdInteractionRoute +IdentifierMap +IdentifierSetMultiMap +IdentityProviderFactory +IdentityProviderHttpHandler +ImmutableMetadataPatcher +InMemoryDataAccessor +IndexRepresentationStore +InitializableHandler +Initializer +InteractionHandler +InteractionRouteHandler +IntermediateCreateExtractor +InternalServerError +JsonConversionHandler +JsonFileStorage +JsonInteractionHandler +JsonLdNotificationSerializer +JsonResourceStorage +KeyExtractor +KeyValueChannelStorage +LazyLoggerFactory +LinkMetadataGenerator +LinkRelMetadataWriter +LinkRelObject +LinkRelParser +LinkWebIdHandler +ListeningActivityHandler +LocationInteractionHandler +LockingInteractionHandler +LockingResourceStore +LoggerInitializer +LogoutHandler +MappedMetadataWriter +MarkdownToHtmlConverter +MaxKeyLengthStorage +MemoryMapStorage +MemoryResourceLocker +MetadataGenerator +MetadataParser +MetadataWriter +MethodFilterHandler +MethodModesExtractor +MethodNotAllowedHttpError +ModesExtractor +ModifiedMetadataWriter +ModuleVersionVerifier +MonitoringStore +MovedPermanentlyHttpError +N3PatchBodyParser +N3PatchModesExtractor +N3Patcher +NoCheckOwnershipValidator +NotFoundHttpError +NotImplementedHttpError +NotificationDescriber +NotificationEmitter +NotificationGenerator +NotificationHandler +NotificationSerializer +NotificationSubscriber +NotificationUnsubscriber +OAuthHttpError +OidcControlHandler +OidcHttpHandler +OkResponseDescription +OperationHandler +OperationHttpHandler +OperationRouterHandler +OriginalUrlExtractor +OwnerMetadataWriter +OwnerPermissionReader +OwnershipValidator +ParallelHandler +ParentContainerReader +ParsingHttpHandler +PartialReadWriteLocker +PassthroughAdapter +PassthroughAdapterFactory +PassthroughConverter +PassthroughDataAccessor +PassthroughKeyValueStorage +PassthroughStore +PasswordLoginHandler +PatchHandler +PatchOperationHandler +PatchingStore +PathBasedReader +PermissionBasedAuthorizer +PermissionReader +PickWebIdHandler +PlainJsonLdFilter +PodCreator +PodQuotaStrategy +PodStorageLocationStrategy +PostOperationHandler +PreconditionFailedHttpError +PreferenceParser +PreferenceSupport +ProcessHandler +PromptFactory +PromptHandler +PublicCredentialsExtractor +PutOperationHandler +QuadToRdfConverter +QuotaStrategy +QuotaValidator +RangeMetadataWriter +RangeNotSatisfiedHttpError +RangePreferenceParser +RawBodyParser +RdfPatcher +RdfStorePatcher +RdfToQuadConverter +RdfValidator +ReadOnlyStore +RecordObject +RedirectHttpError +RedirectingErrorHandler +RedirectingHttpHandler +RedisLocker +RegexRouterRule +RegexRule +RelativePathInteractionRoute +RepresentationConverter +RepresentationConvertingStore +RepresentationMetadata +RepresentationPatchHandler +RepresentationPatcher +RequestParser +ResetPasswordHandler +ResetResponseDescription +ResolveLoginHandler +ResponseDescription +ResponseWriter +RootFilePathHandler +RootStorageLocationStrategy +RouterHandler +RouterRule +RoutingAuxiliaryIdentifierStrategy +RoutingAuxiliaryStrategy +RoutingResourceStore +SafeErrorHandler +SeededAccountInitializer +SequenceHandler +ServerConfigurator +ServerInitializer +ShorthandExtractor +ShorthandResolver +SingleContainerJsonStorage +SingleRootIdentifierStrategy +SliceStream +SlugParser +SparqlDataAccessor +SparqlUpdateBodyParser +SparqlUpdateModesExtractor +SparqlUpdatePatcher +StateHandler +StateNotificationGenerator +StaticAssetEntry +StaticAssetHandler +StaticFolderGenerator +StaticHandler +StaticInteractionHandler +StaticStorageDescriber +StaticTemplateEngine +StaticThrowHandler +StorageDescriber +StorageDescriptionAdvertiser +StorageDescriptionHandler +SubdomainExtensionBasedMapper +SubdomainIdentifierGenerator +SubdomainIdentifierStrategy +SubfolderResourcesGenerator +SuffixAuxiliaryIdentifierStrategy +SuffixIdentifierGenerator +TargetExtractor +TemplateEngine +TemplatedPodGenerator +TokenOwnershipValidator +TypedNotificationHandler +TypedRepresentationConverter +UnauthorizedHttpError +UnionCredentialsExtractor +UnionHandler +UnionPermissionReader +UnionPreferenceParser +UnlinkWebIdHandler +UnsecureConstantCredentialsExtractor +UnsecureWebIdExtractor +UnsecureWebSocketsProtocol +UnsupportedAsyncHandler +UnsupportedMediaTypeHttpError +UpdateOwnerHandler +UpdatePasswordHandler +V6MigrationInitializer +ValidatingDataAccessor +Validator +VariableHandler +VariableSetter +VersionHandler +ViewInteractionHandler +VoidLocker +VoidLogger +VoidLoggerFactory +WacAllowHttpHandler +WacAllowMetadataWriter +WaterfallHandler +WebAclReader +WebSocket2023Emitter +WebSocket2023Handler +WebSocket2023Listener +WebSocket2023Storer +WebSocketAdvertiser +WebSocketChannel2023Type +WebSocketHandler +WebSocketMap +WebSocketServerConfigurator +WebhookChannel2023Type +WebhookEmitter +WebhookWebId +WinstonLogger +WinstonLoggerFactory +WorkerManager +WrappedExpiringReadWriteLocker +WrappedExpiringStorage +WrappedIndexedStorage +WrappedSetMultiMap +WrappingLogger +WwwAuthMetadataWriter +YargsCliExtractor +YargsParameter +
+
+

Interfaces

+
AccessCheckerArgs +AccountInitializerArgs +AccountStore +AdapterFactory +AlgJwk +AppRunnerInput +AsyncTransformOptions +AtomicDataAccessor +AtomicResourceStore +AuthorizerInput +AuthorizingHttpHandlerArgs +AuxiliaryIdentifierStrategy +AuxiliaryStrategy +BasePodCreatorArgs +BaseRouterHandlerArgs +BaseServerFactoryOptions +BasicConditionsOptions +BasicRequestParserArgs +BodyParserArgs +CliOptions +ClientCredentials +ClientCredentialsStore +ComponentsJsFactory +ComposedNotificationHandlerArgs +Conditions +ConstantConverterOptions +ContainerInitializerArgs +ConvertingStoreEntry +CookieStore +DataAccessor +ETagHandler +EmailArgs +EmailSenderArgs +ErrorHandlerArgs +ExpiringReadWriteLocker +ExpiringStorage +FileIdentifierMapper +FileIdentifierMapperFactory +Finalizable +ForgotPasswordHandlerArgs +ForgotPasswordStore +Forwarded +GenericEventEmitter +HttpErrorClass +HttpErrorOptions +HttpHandlerInput +HttpServerFactory +IdentifierGenerator +IdentifierStrategy +IdentityProviderFactoryArgs +IdentityProviderHttpHandlerArgs +IndexedStorage +Initializable +InteractionHandlerInput +InteractionRoute +JsonInteractionHandlerInput +JsonRepresentation +JsonView +JwkGenerator +KeyValueStorage +LinkWebIdHandlerArgs +LogMetadata +Logger +LoggerFactory +LoginStorage +MetadataWriterInput +NotificationChannel +NotificationChannelStorage +NotificationChannelType +NotificationEmitterInput +NotificationHandlerInput +NotificationSerializerInput +NotificationSubscriberArgs +OAuthErrorFields +Operation +OperationHandlerInput +OperationHttpHandlerInput +OriginalUrlExtractorArgs +ParsingHttpHandlerArgs +PasswordLoginHandlerArgs +PasswordStore +Patch +PermissionReaderInput +PodCreatorInput +PodCreatorOutput +PodGenerator +PodManager +PodSettings +PodStore +ProviderFactory +RdfStorePatcherInput +ReadWriteLocker +RedirectHttpErrorClass +RedisSettings +Representation +RepresentationConverterArgs +RepresentationPatcherInput +RepresentationPreferences +Resource +ResourceIdentifier +ResourceLink +ResourceLocker +ResourceSet +ResourceStore +ResourcesGenerator +RouterHandlerArgs +SeededAccountInitializerArgs +SetMultiMap +SimpleLogger +SingleThreaded +Size +SizeReporter +SliceStreamOptions +SparqlUpdatePatch +StorageLocationStrategy +SubfolderResourcesGeneratorArgs +SubscriptionService +SystemError +TemplateEngineInput +TemplateOptions +TemplatePath +TemplateString +TemplatedResourcesGenerator +V6MigrationInitializerArgs +WacAllowHttpHandlerArgs +WebIdStore +WebSocket2023HandlerInput +WebSocketChannel2023 +WebSocketHandlerInput +WebhookChannel2023 +
+
+

Type Aliases

+
+
+

Variables

+
+
+

Functions

+
absoluteFilePath +addGeneratedResources +addHeader +addResourceMetadata +addTemplateMetadata +allFulfilled +assertAccountId +assertOidcInteraction +assertReadConditions +asyncToArray +cleanPreferences +cloneRepresentation +concat +createAggregateError +createErrorMessage +createGenericEventEmitterClass +createSubdomainRegexp +createVocabulary +decodeUriPathComponents +encodeUriPathComponents +endOfStream +ensureLeadingSlash +ensureTrailingSlash +errorTermsToMetadata +extendVocabulary +extractErrorTerms +extractScheme +fetchDataset +filter +filterHandlers +find +findHandler +finishInteraction +forgetWebId +generateHttpErrorClass +generateHttpErrorUri +generateRedirectHttpErrorClass +generateWebSocketUrl +getAccessControl +getAccessControlResource +getAccessControlledResources +getBestPreference +getConversionTarget +getDefault +getExtension +getLoggerFor +getMatcher +getModuleRoot +getPolicy +getRelativeUrl +getSingleItem +getTemplateFilePath +getTypeWeight +getWeightedPreferences +guardStream +guardedStreamFrom +hasScheme +identifierHashFn +importOidcProvider +isContainerIdentifier +isContainerPath +isError +isGuarded +isHttpRequest +isHttpsServer +isInternalContentType +isPromise +isRepresentationMetadata +isResourceIdentifier +isSystemError +isTerm +isUrl +isValidFileName +isValidVariable +isWebSocket2023Channel +isWebhook2023Channel +joinFilePath +joinUrl +listSingleThreadedComponents +map +matchesAuthorizationScheme +matchesMediaPreferences +matchesMediaType +modify +modulePath +msToDuration +normalizeFilePath +parseAccept +parseAcceptCharset +parseAcceptDateTime +parseAcceptEncoding +parseAcceptLanguage +parseContentType +parseForwarded +parseLinkHeader +parseParameters +parsePath +parseQuads +parseSchema +parseWebSocketRequest +pipeSafely +preferencesToString +promiseSome +readJsonStream +readPackageJson +readTemplate +readableToQuads +readableToString +reduce +resetInternalLoggerFactory +resolveAssetPath +resolveModulePath +resolvePromiseOrValue +responseToDataset +sanitizeUrlPart +serializeQuads +setGlobalLoggerFactory +setSafeInterval +sortedAsyncMerge +splitAndClean +splitCommaSeparated +termToInt +toCanonicalUriPath +toComponentsJsType +toLiteral +toNamedTerm +toObjectTerm +toPredicateTerm +transformQuotedStrings +transformSafely +trimLeadingSlashes +trimTrailingSlashes +uniqueQuads +updateModifiedDate +validateWithError +verifyAccountId +
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AccessMap.html b/7.x/docs/types/AccessMap.html new file mode 100644 index 000000000..5c51bdef4 --- /dev/null +++ b/7.x/docs/types/AccessMap.html @@ -0,0 +1,64 @@ +AccessMap | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/AccountIdKey.html b/7.x/docs/types/AccountIdKey.html new file mode 100644 index 000000000..f0a096680 --- /dev/null +++ b/7.x/docs/types/AccountIdKey.html @@ -0,0 +1,61 @@ +AccountIdKey | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/AccountIdRoute.html b/7.x/docs/types/AccountIdRoute.html new file mode 100644 index 000000000..079c99e29 --- /dev/null +++ b/7.x/docs/types/AccountIdRoute.html @@ -0,0 +1,64 @@ +AccountIdRoute | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/AccountInteractionResults.html b/7.x/docs/types/AccountInteractionResults.html new file mode 100644 index 000000000..9f762fdd7 --- /dev/null +++ b/7.x/docs/types/AccountInteractionResults.html @@ -0,0 +1,69 @@ +AccountInteractionResults | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AccountInteractionResults

+
AccountInteractionResults: {
    account?: string;
} & InteractionResults
+

InteractionResults extended with our custom key for tracking a user's account ID.

+
+
+

Type declaration

+
    +
  • +
    Optional account?: string
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AccountLoginStorage.html b/7.x/docs/types/AccountLoginStorage.html new file mode 100644 index 000000000..a2ae32d3a --- /dev/null +++ b/7.x/docs/types/AccountLoginStorage.html @@ -0,0 +1,70 @@ +AccountLoginStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AccountLoginStorage<T>

+
AccountLoginStorage<T>: LoginStorage<T & {
    account: unknown;
}>
+

A LoginStorage with specific typings to ensure other types can reference account IDs +without actually needing to specify it explicitly in their storage type.

+
+
+

Type Parameters

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AccountSettings.html b/7.x/docs/types/AccountSettings.html new file mode 100644 index 000000000..aeaca5a5f --- /dev/null +++ b/7.x/docs/types/AccountSettings.html @@ -0,0 +1,66 @@ +AccountSettings | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AccountSettings

+
AccountSettings: {
    rememberLogin?: boolean;
}
+
+

Type declaration

+
    +
  • +
    Optional rememberLogin?: boolean
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AclPermissionSet.html b/7.x/docs/types/AclPermissionSet.html new file mode 100644 index 000000000..329c2c4ce --- /dev/null +++ b/7.x/docs/types/AclPermissionSet.html @@ -0,0 +1,61 @@ +AclPermissionSet | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/ActivityEmitter.html b/7.x/docs/types/ActivityEmitter.html new file mode 100644 index 000000000..47bebcadf --- /dev/null +++ b/7.x/docs/types/ActivityEmitter.html @@ -0,0 +1,65 @@ +ActivityEmitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ActivityEmitter

+
ActivityEmitter: GenericEventEmitter<"changed", ((target, activity, metadata) => void)> & GenericEventEmitter<VocabularyValue<typeof AS>, ((target, metadata) => void)>
+

An event emitter used to report changes made to resources. +Both generic change events and ActivityStream-specific events are emitted.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ArrayElement.html b/7.x/docs/types/ArrayElement.html new file mode 100644 index 000000000..5597bcf9d --- /dev/null +++ b/7.x/docs/types/ArrayElement.html @@ -0,0 +1,66 @@ +ArrayElement | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ArrayElement<TArray>

+
ArrayElement<TArray>: TArray[number]
+
+

Type Parameters

+
    +
  • +

    TArray extends readonly unknown[]

+
+
\ No newline at end of file diff --git a/7.x/docs/types/AsyncHandlerInput.html b/7.x/docs/types/AsyncHandlerInput.html new file mode 100644 index 000000000..88bdd0ce3 --- /dev/null +++ b/7.x/docs/types/AsyncHandlerInput.html @@ -0,0 +1,66 @@ +AsyncHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AsyncHandlerInput<T>

+
AsyncHandlerInput<T>: Parameters<T["handle"]>[0]
+
+

Type Parameters

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AsyncHandlerOutput.html b/7.x/docs/types/AsyncHandlerOutput.html new file mode 100644 index 000000000..a8ce0dac3 --- /dev/null +++ b/7.x/docs/types/AsyncHandlerOutput.html @@ -0,0 +1,66 @@ +AsyncHandlerOutput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AsyncHandlerOutput<T>

+
AsyncHandlerOutput<T>: Awaited<ReturnType<T["handle"]>>
+
+

Type Parameters

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ChangeMap.html b/7.x/docs/types/ChangeMap.html new file mode 100644 index 000000000..bd6a07b99 --- /dev/null +++ b/7.x/docs/types/ChangeMap.html @@ -0,0 +1,66 @@ +ChangeMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ChangeMap

+ +

An IdentifierMap containing one entry for each resource that was created, updated or deleted +by this operation. Where the value is a RepresentationMetadata +containing extra information about the change of the resource.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ClientCredentialsIdRoute.html b/7.x/docs/types/ClientCredentialsIdRoute.html new file mode 100644 index 000000000..f90f1bf76 --- /dev/null +++ b/7.x/docs/types/ClientCredentialsIdRoute.html @@ -0,0 +1,64 @@ +ClientCredentialsIdRoute | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/CreateTypeObject.html b/7.x/docs/types/CreateTypeObject.html new file mode 100644 index 000000000..115fe832b --- /dev/null +++ b/7.x/docs/types/CreateTypeObject.html @@ -0,0 +1,70 @@ +CreateTypeObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias CreateTypeObject<T>

+
CreateTypeObject<T>: Omit<TypeObject<T>, typeof INDEX_ID_KEY>
+

Input expected for create() call in IndexedStorage. +This is the same as TypeObject but without the index key.

+
+
+

Type Parameters

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Credentials.html b/7.x/docs/types/Credentials.html new file mode 100644 index 000000000..312feb5d3 --- /dev/null +++ b/7.x/docs/types/Credentials.html @@ -0,0 +1,84 @@ +Credentials | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Credentials

+
Credentials: {
    agent?: {
        webId: string;
    };
    client?: {
        clientId: string;
    };
    issuer?: {
        url: string;
    };
    [key: string]: unknown;
}
+

Credentials identifying an entity accessing or owning data.

+
+
+

Type declaration

+
    +
  • +
    [key: string]: unknown
  • +
  • +
    Optional agent?: {
        webId: string;
    }
    +
      +
    • +
      webId: string
  • +
  • +
    Optional client?: {
        clientId: string;
    }
    +
      +
    • +
      clientId: string
  • +
  • +
    Optional issuer?: {
        url: string;
    }
    +
      +
    • +
      url: string
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/CredentialsIdKey.html b/7.x/docs/types/CredentialsIdKey.html new file mode 100644 index 000000000..df21af17d --- /dev/null +++ b/7.x/docs/types/CredentialsIdKey.html @@ -0,0 +1,61 @@ +CredentialsIdKey | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/EmptyMapConstructor.html b/7.x/docs/types/EmptyMapConstructor.html new file mode 100644 index 000000000..68674f300 --- /dev/null +++ b/7.x/docs/types/EmptyMapConstructor.html @@ -0,0 +1,72 @@ +EmptyMapConstructor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias EmptyMapConstructor

+
EmptyMapConstructor: (new () => Map<unknown, unknown>)
+
+

Type declaration

+
    +
  • +
      +
    • new (): Map<unknown, unknown>
    • +
    • +

      A simplified version of MapConstructor that only allows creating an empty Map.

      +
      +

      Returns Map<unknown, unknown>

      +
+
+
\ No newline at end of file diff --git a/7.x/docs/types/EmptyObject.html b/7.x/docs/types/EmptyObject.html new file mode 100644 index 000000000..f193da689 --- /dev/null +++ b/7.x/docs/types/EmptyObject.html @@ -0,0 +1,61 @@ +EmptyObject | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/Expires.html b/7.x/docs/types/Expires.html new file mode 100644 index 000000000..955655d12 --- /dev/null +++ b/7.x/docs/types/Expires.html @@ -0,0 +1,73 @@ +Expires | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Expires<T>

+
Expires<T>: {
    expires?: string;
    payload: T;
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
    +
  • +
    Optional expires?: string
  • +
  • +
    payload: T
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ExtendedRoute.html b/7.x/docs/types/ExtendedRoute.html new file mode 100644 index 000000000..03bb4e48b --- /dev/null +++ b/7.x/docs/types/ExtendedRoute.html @@ -0,0 +1,71 @@ +ExtendedRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ExtendedRoute<TRoute, TParam>

+
ExtendedRoute<TRoute, TParam>: InteractionRoute<RouteParameter<TRoute> | TParam>
+

A route that adds a parameter to an existing route type.

+
+
+

Type Parameters

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Guarded.html b/7.x/docs/types/Guarded.html new file mode 100644 index 000000000..133416368 --- /dev/null +++ b/7.x/docs/types/Guarded.html @@ -0,0 +1,71 @@ +Guarded | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Guarded<T>

+
Guarded<T>: T & Guard
+

A stream that is guarded from emitting errors when there are no listeners. +If an error occurs while no listener is attached, +it will store the error and emit it once a listener is added (or a timeout occurs).

+
+
+

Type Parameters

+
    +
  • +

    T extends NodeJS.EventEmitter = NodeJS.EventEmitter

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/HttpRequest.html b/7.x/docs/types/HttpRequest.html new file mode 100644 index 000000000..e75715eb8 --- /dev/null +++ b/7.x/docs/types/HttpRequest.html @@ -0,0 +1,64 @@ +HttpRequest | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/HttpResponse.html b/7.x/docs/types/HttpResponse.html new file mode 100644 index 000000000..dcf5282bf --- /dev/null +++ b/7.x/docs/types/HttpResponse.html @@ -0,0 +1,64 @@ +HttpResponse | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/IndexRelation.html b/7.x/docs/types/IndexRelation.html new file mode 100644 index 000000000..d712248ee --- /dev/null +++ b/7.x/docs/types/IndexRelation.html @@ -0,0 +1,86 @@ +IndexRelation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias IndexRelation<TTypes>

+
IndexRelation<TTypes>: {
    child: {
        key: string;
        type: StringKey<TTypes>;
    };
    parent: {
        key: VirtualKey<string>;
        type: StringKey<TTypes>;
    };
}
+

A parent/child relation description in a WrappedIndexedStorage.

+
+
+

Type Parameters

+
    +
  • +

    TTypes

+
+

Type declaration

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/IndexTypeCollection.html b/7.x/docs/types/IndexTypeCollection.html new file mode 100644 index 000000000..fc60bfc15 --- /dev/null +++ b/7.x/docs/types/IndexTypeCollection.html @@ -0,0 +1,69 @@ +IndexTypeCollection | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias IndexTypeCollection<T>

+
IndexTypeCollection<T>: Record<string, IndexTypeDescription<keyof T>>
+

The full description of all the types of an IndexedStorage.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/IndexTypeDescription.html b/7.x/docs/types/IndexTypeDescription.html new file mode 100644 index 000000000..02018b5c1 --- /dev/null +++ b/7.x/docs/types/IndexTypeDescription.html @@ -0,0 +1,69 @@ +IndexTypeDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias IndexTypeDescription<TType>

+
IndexTypeDescription<TType>: Record<string, ValueTypeDescription<TType>>
+

The description of a single type in an IndexedStorage.

+
+
+

Type Parameters

+
    +
  • +

    TType = never

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/IndexedQuery.html b/7.x/docs/types/IndexedQuery.html new file mode 100644 index 000000000..9705267fa --- /dev/null +++ b/7.x/docs/types/IndexedQuery.html @@ -0,0 +1,83 @@ +IndexedQuery | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias IndexedQuery<T, TType, TDepth>

+
IndexedQuery<T, TType, TDepth>: [TDepth] extends [never]
    ? never
    : {
        [K in keyof T[TType] | typeof INDEX_ID_KEY]?: ValueType<T[TType][K]> | (T[TType][K] extends `${typeof INDEX_ID_KEY}:${infer U}`
            ? IndexedQuery<T, U, Prev[TDepth]>
            : never)
    }
+

Object that represents a valid query starting from a specific type on an IndexedStorage. + The keys of the object need to be one or more keys from the starting type, + with the values being corresponding valid values of an object of that type. + If the value definition of a key is one that contains the identifier of a different type, + the value in the query can also be a nested object that has the same IndexedQuery requirements for that type. + This can be done recursively.

+

E.g., if the storage has the following definition:

+
 {
account: {},
pod: { baseUrl: 'string', account: 'id:account' },
pod: { owner: 'string', pod: 'id:pod' },
} +
+

A valid query on the pod type could be { pod: '123456' }, +but also { pod: { baseUrl: 'http://example.com/pod/', account: { id: '789' }}}.

+
+
+

Type Parameters

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Interaction.html b/7.x/docs/types/Interaction.html new file mode 100644 index 000000000..6b4185753 --- /dev/null +++ b/7.x/docs/types/Interaction.html @@ -0,0 +1,61 @@ +Interaction | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/Json.html b/7.x/docs/types/Json.html new file mode 100644 index 000000000..6686f3834 --- /dev/null +++ b/7.x/docs/types/Json.html @@ -0,0 +1,64 @@ +Json | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/LogLevel.html b/7.x/docs/types/LogLevel.html new file mode 100644 index 000000000..2cb748044 --- /dev/null +++ b/7.x/docs/types/LogLevel.html @@ -0,0 +1,64 @@ +LogLevel | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/LoginOutputType.html b/7.x/docs/types/LoginOutputType.html new file mode 100644 index 000000000..32948c719 --- /dev/null +++ b/7.x/docs/types/LoginOutputType.html @@ -0,0 +1,78 @@ +LoginOutputType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias LoginOutputType

+
LoginOutputType: {
    accountId: string;
    remember?: boolean;
}
+

Output type that is expected of handlers logging an account in.

+
+
+

Type declaration

+
    +
  • +
    accountId: string
    +

    The ID of the account that logged in.

    +
    +
  • +
  • +
    Optional remember?: boolean
    +

    If this account should be remembered or not. +Setting this to undefined will keep the setting as it currently is.

    +
    +
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/MapEntry.html b/7.x/docs/types/MapEntry.html new file mode 100644 index 000000000..9f21ae194 --- /dev/null +++ b/7.x/docs/types/MapEntry.html @@ -0,0 +1,66 @@ +MapEntry | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias MapEntry<T>

+
MapEntry<T>: T extends Map<unknown, unknown>
    ? [MapKey<T>, MapValue<T>]
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
\ No newline at end of file diff --git a/7.x/docs/types/MapKey.html b/7.x/docs/types/MapKey.html new file mode 100644 index 000000000..809da6976 --- /dev/null +++ b/7.x/docs/types/MapKey.html @@ -0,0 +1,66 @@ +MapKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias MapKey<T>

+
MapKey<T>: T extends Map<infer TKey, unknown>
    ? TKey
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
\ No newline at end of file diff --git a/7.x/docs/types/MapValue.html b/7.x/docs/types/MapValue.html new file mode 100644 index 000000000..16633f7d1 --- /dev/null +++ b/7.x/docs/types/MapValue.html @@ -0,0 +1,66 @@ +MapValue | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias MapValue<T>

+
MapValue<T>: T extends Map<unknown, infer TValue>
    ? TValue
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
\ No newline at end of file diff --git a/7.x/docs/types/MetadataGraph.html b/7.x/docs/types/MetadataGraph.html new file mode 100644 index 000000000..a9c1b961b --- /dev/null +++ b/7.x/docs/types/MetadataGraph.html @@ -0,0 +1,61 @@ +MetadataGraph | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/MetadataIdentifier.html b/7.x/docs/types/MetadataIdentifier.html new file mode 100644 index 000000000..902cbb179 --- /dev/null +++ b/7.x/docs/types/MetadataIdentifier.html @@ -0,0 +1,61 @@ +MetadataIdentifier | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/MetadataRecord.html b/7.x/docs/types/MetadataRecord.html new file mode 100644 index 000000000..ddacb355b --- /dev/null +++ b/7.x/docs/types/MetadataRecord.html @@ -0,0 +1,61 @@ +MetadataRecord | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/MetadataValue.html b/7.x/docs/types/MetadataValue.html new file mode 100644 index 000000000..c78836bd6 --- /dev/null +++ b/7.x/docs/types/MetadataValue.html @@ -0,0 +1,61 @@ +MetadataValue | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/ModifyOptions.html b/7.x/docs/types/ModifyOptions.html new file mode 100644 index 000000000..39dfba449 --- /dev/null +++ b/7.x/docs/types/ModifyOptions.html @@ -0,0 +1,82 @@ +ModifyOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ModifyOptions<T>

+
ModifyOptions<T>: {
    add?: Iterable<MapEntry<T>>;
    remove?: Iterable<MapKey<T>>;
}
+

Options describing the necessary changes when calling modify.

+
+
+

Type Parameters

+
+
+

Type declaration

+
    +
  • +
    Optional add?: Iterable<MapEntry<T>>
    +

    Entries that need to be added to the Map.

    +
    +
  • +
  • +
    Optional remove?: Iterable<MapKey<T>>
    +

    Keys that need to be removed from the Map.

    +
    +
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/OptionalKey.html b/7.x/docs/types/OptionalKey.html new file mode 100644 index 000000000..5ca9e0be4 --- /dev/null +++ b/7.x/docs/types/OptionalKey.html @@ -0,0 +1,69 @@ +OptionalKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias OptionalKey<T>

+
OptionalKey<T>: {
    [K in keyof T]: T[K] extends `${string}?`
        ? K
        : never
}[keyof T]
+

Used to filter on optional keys in a IndexedStorage definition.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PartialVocabulary.html b/7.x/docs/types/PartialVocabulary.html new file mode 100644 index 000000000..410c70b8c --- /dev/null +++ b/7.x/docs/types/PartialVocabulary.html @@ -0,0 +1,80 @@ +PartialVocabulary | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PartialVocabulary<TBase>

+
PartialVocabulary<TBase>: {
    namespace: TBase;
} & Partial<Record<string, string>> & {
    terms: {
        namespace: NamedNode<TBase>;
    } & Partial<Record<string, NamedNode>>;
}
+

A Vocabulary where all the non-namespace fields are of unknown value. +This is a fallback in case createVocabulary gets called with a non-strict string array.

+
+
+

Type Parameters

+
    +
  • +

    TBase extends string

+
+

Type declaration

+
    +
  • +
    namespace: TBase
+
+

Type declaration

+
    +
  • +
    terms: {
        namespace: NamedNode<TBase>;
    } & Partial<Record<string, NamedNode>>
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PasswordIdKey.html b/7.x/docs/types/PasswordIdKey.html new file mode 100644 index 000000000..d5936b829 --- /dev/null +++ b/7.x/docs/types/PasswordIdKey.html @@ -0,0 +1,61 @@ +PasswordIdKey | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/PasswordIdRoute.html b/7.x/docs/types/PasswordIdRoute.html new file mode 100644 index 000000000..c157ed2f6 --- /dev/null +++ b/7.x/docs/types/PasswordIdRoute.html @@ -0,0 +1,64 @@ +PasswordIdRoute | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/PatchHandlerInput.html b/7.x/docs/types/PatchHandlerInput.html new file mode 100644 index 000000000..267d4f3c0 --- /dev/null +++ b/7.x/docs/types/PatchHandlerInput.html @@ -0,0 +1,75 @@ +PatchHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PatchHandlerInput<T>

+
PatchHandlerInput<T>: {
    identifier: ResourceIdentifier;
    patch: Patch;
    source: T;
}
+
+

Type Parameters

+
+
+

Type declaration

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PermissionMap.html b/7.x/docs/types/PermissionMap.html new file mode 100644 index 000000000..5421e3e9c --- /dev/null +++ b/7.x/docs/types/PermissionMap.html @@ -0,0 +1,64 @@ +PermissionMap | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/PermissionSet.html b/7.x/docs/types/PermissionSet.html new file mode 100644 index 000000000..d3af7be7a --- /dev/null +++ b/7.x/docs/types/PermissionSet.html @@ -0,0 +1,64 @@ +PermissionSet | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PermissionSet

+
PermissionSet: Partial<Record<AccessMode, boolean>>
+

A data interface indicating which permissions are required (based on the context).

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PodIdKey.html b/7.x/docs/types/PodIdKey.html new file mode 100644 index 000000000..90057afee --- /dev/null +++ b/7.x/docs/types/PodIdKey.html @@ -0,0 +1,61 @@ +PodIdKey | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/PodIdRoute.html b/7.x/docs/types/PodIdRoute.html new file mode 100644 index 000000000..7bc600630 --- /dev/null +++ b/7.x/docs/types/PodIdRoute.html @@ -0,0 +1,64 @@ +PodIdRoute | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/PromiseOrValue.html b/7.x/docs/types/PromiseOrValue.html new file mode 100644 index 000000000..7636aa633 --- /dev/null +++ b/7.x/docs/types/PromiseOrValue.html @@ -0,0 +1,66 @@ +PromiseOrValue | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/RouteParameter.html b/7.x/docs/types/RouteParameter.html new file mode 100644 index 000000000..e7ba7cb63 --- /dev/null +++ b/7.x/docs/types/RouteParameter.html @@ -0,0 +1,69 @@ +RouteParameter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias RouteParameter<TRoute>

+
RouteParameter<TRoute>: TRoute extends InteractionRoute<infer TParam>
    ? TParam
    : never
+

The parameters supported for the given route.

+
+
+

Type Parameters

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/StringKey.html b/7.x/docs/types/StringKey.html new file mode 100644 index 000000000..d8c2d137a --- /dev/null +++ b/7.x/docs/types/StringKey.html @@ -0,0 +1,69 @@ +StringKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias StringKey<T>

+
StringKey<T>: keyof T & string
+

Key of an object that is also a string.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Template.html b/7.x/docs/types/Template.html new file mode 100644 index 000000000..833cb956e --- /dev/null +++ b/7.x/docs/types/Template.html @@ -0,0 +1,61 @@ +Template | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/TemplateFileName.html b/7.x/docs/types/TemplateFileName.html new file mode 100644 index 000000000..45ffa60b4 --- /dev/null +++ b/7.x/docs/types/TemplateFileName.html @@ -0,0 +1,61 @@ +TemplateFileName | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/TypeObject.html b/7.x/docs/types/TypeObject.html new file mode 100644 index 000000000..c2a79d98a --- /dev/null +++ b/7.x/docs/types/TypeObject.html @@ -0,0 +1,75 @@ +TypeObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias TypeObject<TDesc>

+
TypeObject<TDesc>: {
    -readonly [K in Exclude<keyof TDesc, OptionalKey<TDesc>>]: ValueType<TDesc[K]>
} & {
    -readonly [K in keyof TDesc]?: ValueType<TDesc[K]>
} & {
    id: string;
}
+

Converts a IndexedStorage definition of a specific type +to the typing an object would have that is returned as an output on function calls.

+
+
+

Type Parameters

+
+
+

Type declaration

+
    +
  • +
    id: string
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ValidatorInput.html b/7.x/docs/types/ValidatorInput.html new file mode 100644 index 000000000..0f7f7bffb --- /dev/null +++ b/7.x/docs/types/ValidatorInput.html @@ -0,0 +1,68 @@ +ValidatorInput | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/ValuePreference.html b/7.x/docs/types/ValuePreference.html new file mode 100644 index 000000000..d61fef7b3 --- /dev/null +++ b/7.x/docs/types/ValuePreference.html @@ -0,0 +1,72 @@ +ValuePreference | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ValuePreference

+
ValuePreference: {
    value: string;
    weight: number;
}
+

A single entry of a ValuePreferences object. +Useful when doing operations on such an object.

+
+
+

Type declaration

+
    +
  • +
    value: string
  • +
  • +
    weight: number
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ValuePreferences.html b/7.x/docs/types/ValuePreferences.html new file mode 100644 index 000000000..b359ee41d --- /dev/null +++ b/7.x/docs/types/ValuePreferences.html @@ -0,0 +1,76 @@ +ValuePreferences | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ValuePreferences

+
ValuePreferences: {
    [key: string]: number;
}
+

Represents preferred values along a single content negotiation dimension.

+

The number represents how preferred this value is from 0 to 1. +Follows the quality values rule from RFC 7231: +"The weight is normalized to a real number in the range 0 through 1, +where 0.001 is the least preferred and 1 is the most preferred; a +value of 0 means "not acceptable"."

+

Because of an open issue in Components.js we cannot use Record<string, number> right now. +https://github.com/LinkedSoftwareDependencies/Components-Generator.js/issues/103

+
+
+

Type declaration

+
    +
  • +
    [key: string]: number
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ValueType.html b/7.x/docs/types/ValueType.html new file mode 100644 index 000000000..0e65ddb1e --- /dev/null +++ b/7.x/docs/types/ValueType.html @@ -0,0 +1,69 @@ +ValueType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ValueType<T>

+
ValueType<T>: (T extends "boolean" | "boolean?"
    ? boolean
    : T extends "number" | "number?"
        ? number
        : string) | (T extends `${string}?`
    ? undefined
    : never)
+

Converts a ValueTypeDescription to the type it should be interpreted as.

+
+
+

Type Parameters

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ValueTypeDescription.html b/7.x/docs/types/ValueTypeDescription.html new file mode 100644 index 000000000..50e701548 --- /dev/null +++ b/7.x/docs/types/ValueTypeDescription.html @@ -0,0 +1,73 @@ +ValueTypeDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ValueTypeDescription<TType>

+
ValueTypeDescription<TType>: `${"string" | "boolean" | "number" | (TType extends string
    ? `${typeof INDEX_ID_KEY}:${TType}`
    : never)}${"?" | ""}`
+

Used to define the value of a key in a type entry of a IndexedStorage. +Valid values are "string", "boolean", "number" and "id:TYPE", +with TYPE being one of the types in the definition. +In the latter case this means that key points to an identifier of the specified type. +A ? can be appended to the type to indicate this key is optional.

+
+
+

Type Parameters

+
    +
  • +

    TType = string

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/VirtualKey.html b/7.x/docs/types/VirtualKey.html new file mode 100644 index 000000000..77184f892 --- /dev/null +++ b/7.x/docs/types/VirtualKey.html @@ -0,0 +1,69 @@ +VirtualKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias VirtualKey<TChild>

+
VirtualKey<TChild>: TChild extends string
    ? `**${TChild}**`
    : never
+

Key used to link to child objects in a WrappedIndexedStorage.

+
+
+

Type Parameters

+
    +
  • +

    TChild

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/VirtualObject.html b/7.x/docs/types/VirtualObject.html new file mode 100644 index 000000000..7297e145e --- /dev/null +++ b/7.x/docs/types/VirtualObject.html @@ -0,0 +1,71 @@ +VirtualObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias VirtualObject

+
VirtualObject: {
    id: string;
    [key: VirtualKey<string>]: Record<string, VirtualObject>;
}
+

Object stored in the wrapped KeyValueStorage in a WrappedIndexedStorage.

+
+
+

Type declaration

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Vocabulary.html b/7.x/docs/types/Vocabulary.html new file mode 100644 index 000000000..9648274f4 --- /dev/null +++ b/7.x/docs/types/Vocabulary.html @@ -0,0 +1,77 @@ +Vocabulary | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Vocabulary<TBase, TKey>

+
Vocabulary<TBase, TKey>: ValueVocabulary<TBase, TKey> & {
    terms: TermVocabulary<ValueVocabulary<TBase, TKey>>;
}
+

Contains a namespace and keys linking to the entries in this namespace. +The terms field contains the same values but as NamedNode instead of string.

+
+
+

Type Parameters

+
    +
  • +

    TBase extends string

  • +
  • +

    TKey extends string

+
+

Type declaration

+
    +
  • +
    terms: TermVocabulary<ValueVocabulary<TBase, TKey>>
+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/VocabularyLocal.html b/7.x/docs/types/VocabularyLocal.html new file mode 100644 index 000000000..0f05bebb4 --- /dev/null +++ b/7.x/docs/types/VocabularyLocal.html @@ -0,0 +1,69 @@ +VocabularyLocal | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias VocabularyLocal<T>

+
VocabularyLocal<T>: T extends Vocabulary<string, infer TKey>
    ? TKey
    : never
+

A local name of a Vocabulary.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/VocabularyTerm.html b/7.x/docs/types/VocabularyTerm.html new file mode 100644 index 000000000..7da19c4ee --- /dev/null +++ b/7.x/docs/types/VocabularyTerm.html @@ -0,0 +1,69 @@ +VocabularyTerm | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias VocabularyTerm<T>

+
VocabularyTerm<T>: T extends Vocabulary<string, infer TKey>
    ? T["terms"][TKey]
    : never
+

A NamedNode entry of a Vocabulary.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/VocabularyValue.html b/7.x/docs/types/VocabularyValue.html new file mode 100644 index 000000000..39699fef4 --- /dev/null +++ b/7.x/docs/types/VocabularyValue.html @@ -0,0 +1,69 @@ +VocabularyValue | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias VocabularyValue<T>

+
VocabularyValue<T>: T extends Vocabulary<string, infer TKey>
    ? T[TKey]
    : never
+

A URI string entry of a Vocabulary.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/WebIdLinkKey.html b/7.x/docs/types/WebIdLinkKey.html new file mode 100644 index 000000000..b4baa3cc6 --- /dev/null +++ b/7.x/docs/types/WebIdLinkKey.html @@ -0,0 +1,61 @@ +WebIdLinkKey | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/WebIdLinkRoute.html b/7.x/docs/types/WebIdLinkRoute.html new file mode 100644 index 000000000..838a2482d --- /dev/null +++ b/7.x/docs/types/WebIdLinkRoute.html @@ -0,0 +1,64 @@ +WebIdLinkRoute | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/types/YargsOptions.html b/7.x/docs/types/YargsOptions.html new file mode 100644 index 000000000..bdb148ba2 --- /dev/null +++ b/7.x/docs/types/YargsOptions.html @@ -0,0 +1,61 @@ +YargsOptions | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/ACCOUNT_ID_KEY.html b/7.x/docs/variables/ACCOUNT_ID_KEY.html new file mode 100644 index 000000000..06cdd5fe9 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_ID_KEY.html @@ -0,0 +1,61 @@ +ACCOUNT_ID_KEY | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/ACCOUNT_PROMPT.html b/7.x/docs/variables/ACCOUNT_PROMPT.html new file mode 100644 index 000000000..57bf875cf --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_PROMPT.html @@ -0,0 +1,66 @@ +ACCOUNT_PROMPT | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACCOUNT_PROMPTConst

+
ACCOUNT_PROMPT: "account" = 'account'
+

The prompt that is used to track the account ID of a user during an OIDC interaction. +The already existing login prompt in the InteractionResults +is used to track the WebID that is chosen in an OIDC interaction.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACCOUNT_SETTINGS_REMEMBER_LOGIN.html b/7.x/docs/variables/ACCOUNT_SETTINGS_REMEMBER_LOGIN.html new file mode 100644 index 000000000..461e82e87 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_SETTINGS_REMEMBER_LOGIN.html @@ -0,0 +1,64 @@ +ACCOUNT_SETTINGS_REMEMBER_LOGIN | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACCOUNT_SETTINGS_REMEMBER_LOGINConst

+
ACCOUNT_SETTINGS_REMEMBER_LOGIN: "rememberLogin" = 'rememberLogin'
+

Settings parameter used to determine if the user wants the login to be remembered.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACCOUNT_STORAGE_DESCRIPTION.html b/7.x/docs/variables/ACCOUNT_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..560c50ad0 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_STORAGE_DESCRIPTION.html @@ -0,0 +1,66 @@ +ACCOUNT_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACCOUNT_STORAGE_DESCRIPTIONConst

+
ACCOUNT_STORAGE_DESCRIPTION: {
    rememberLogin: "boolean?";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly rememberLogin: "boolean?"
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACCOUNT_TYPE.html b/7.x/docs/variables/ACCOUNT_TYPE.html new file mode 100644 index 000000000..df60d13c3 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_TYPE.html @@ -0,0 +1,61 @@ +ACCOUNT_TYPE | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/ACL.html b/7.x/docs/variables/ACL.html new file mode 100644 index 000000000..17e6238de --- /dev/null +++ b/7.x/docs/variables/ACL.html @@ -0,0 +1,61 @@ +ACL | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACLConst

+
ACL: Vocabulary<"http://www.w3.org/ns/auth/acl#", "default" | "accessTo" | "agent" | "agentClass" | "agentGroup" | "AuthenticatedAgent" | "Authorization" | "mode" | "Write" | "Read" | "Append" | "Control"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACP.html b/7.x/docs/variables/ACP.html new file mode 100644 index 000000000..ce175e828 --- /dev/null +++ b/7.x/docs/variables/ACP.html @@ -0,0 +1,61 @@ +ACP | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACPConst

+
ACP: Vocabulary<"http://www.w3.org/ns/solid/acp#", "agent" | "AccessControlResource" | "grant" | "attribute" | "resource" | "accessControl" | "memberAccessControl" | "apply" | "allow" | "deny" | "allOf" | "anyOf" | "noneOf" | "client" | "issuer" | "vc"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/APPLICATION_JSON.html b/7.x/docs/variables/APPLICATION_JSON.html new file mode 100644 index 000000000..62eb92b13 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_JSON.html @@ -0,0 +1,61 @@ +APPLICATION_JSON | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/APPLICATION_LD_JSON.html b/7.x/docs/variables/APPLICATION_LD_JSON.html new file mode 100644 index 000000000..63dec600a --- /dev/null +++ b/7.x/docs/variables/APPLICATION_LD_JSON.html @@ -0,0 +1,61 @@ +APPLICATION_LD_JSON | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/APPLICATION_OCTET_STREAM.html b/7.x/docs/variables/APPLICATION_OCTET_STREAM.html new file mode 100644 index 000000000..7d63536c7 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_OCTET_STREAM.html @@ -0,0 +1,61 @@ +APPLICATION_OCTET_STREAM | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable APPLICATION_OCTET_STREAMConst

+
APPLICATION_OCTET_STREAM: "application/octet-stream" = 'application/octet-stream'
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/APPLICATION_SPARQL_UPDATE.html b/7.x/docs/variables/APPLICATION_SPARQL_UPDATE.html new file mode 100644 index 000000000..18d00dd77 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_SPARQL_UPDATE.html @@ -0,0 +1,61 @@ +APPLICATION_SPARQL_UPDATE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable APPLICATION_SPARQL_UPDATEConst

+
APPLICATION_SPARQL_UPDATE: "application/sparql-update" = 'application/sparql-update'
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/APPLICATION_X_WWW_FORM_URLENCODED.html b/7.x/docs/variables/APPLICATION_X_WWW_FORM_URLENCODED.html new file mode 100644 index 000000000..044c219c0 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_X_WWW_FORM_URLENCODED.html @@ -0,0 +1,61 @@ +APPLICATION_X_WWW_FORM_URLENCODED | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable APPLICATION_X_WWW_FORM_URLENCODEDConst

+
APPLICATION_X_WWW_FORM_URLENCODED: "application/x-www-form-urlencoded" = 'application/x-www-form-urlencoded'
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/AS.html b/7.x/docs/variables/AS.html new file mode 100644 index 000000000..adc505f00 --- /dev/null +++ b/7.x/docs/variables/AS.html @@ -0,0 +1,61 @@ +AS | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ASConst

+
AS: Vocabulary<"https://www.w3.org/ns/activitystreams#", "object" | "Add" | "Create" | "Delete" | "Remove" | "Update"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/AUTH.html b/7.x/docs/variables/AUTH.html new file mode 100644 index 000000000..253c138bc --- /dev/null +++ b/7.x/docs/variables/AUTH.html @@ -0,0 +1,61 @@ +AUTH | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/BaseActivityEmitter.html b/7.x/docs/variables/BaseActivityEmitter.html new file mode 100644 index 000000000..b7e516191 --- /dev/null +++ b/7.x/docs/variables/BaseActivityEmitter.html @@ -0,0 +1,72 @@ +BaseActivityEmitter | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_DESCRIPTION.html b/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..c865ae385 --- /dev/null +++ b/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_DESCRIPTION.html @@ -0,0 +1,72 @@ +CLIENT_CREDENTIALS_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable CLIENT_CREDENTIALS_STORAGE_DESCRIPTIONConst

+
CLIENT_CREDENTIALS_STORAGE_DESCRIPTION: {
    accountId: "id:account";
    label: "string";
    secret: "string";
    webId: "string";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly accountId: "id:account"
  • +
  • +
    Readonly label: "string"
  • +
  • +
    Readonly secret: "string"
  • +
  • +
    Readonly webId: "string"
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_TYPE.html b/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_TYPE.html new file mode 100644 index 000000000..af2f26c8a --- /dev/null +++ b/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +CLIENT_CREDENTIALS_STORAGE_TYPE | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/CONTENT_LENGTH.html b/7.x/docs/variables/CONTENT_LENGTH.html new file mode 100644 index 000000000..ac932c7ae --- /dev/null +++ b/7.x/docs/variables/CONTENT_LENGTH.html @@ -0,0 +1,61 @@ +CONTENT_LENGTH | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/CONTENT_LENGTH_TERM.html b/7.x/docs/variables/CONTENT_LENGTH_TERM.html new file mode 100644 index 000000000..fd4199ca3 --- /dev/null +++ b/7.x/docs/variables/CONTENT_LENGTH_TERM.html @@ -0,0 +1,61 @@ +CONTENT_LENGTH_TERM | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable CONTENT_LENGTH_TERMConst

+
CONTENT_LENGTH_TERM: NamedNode<"http://www.w3.org/2011/http-headers#content-length"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/CONTENT_TYPE.html b/7.x/docs/variables/CONTENT_TYPE.html new file mode 100644 index 000000000..3fb5cc0cd --- /dev/null +++ b/7.x/docs/variables/CONTENT_TYPE.html @@ -0,0 +1,61 @@ +CONTENT_TYPE | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/CONTENT_TYPE_TERM.html b/7.x/docs/variables/CONTENT_TYPE_TERM.html new file mode 100644 index 000000000..d3ae475af --- /dev/null +++ b/7.x/docs/variables/CONTENT_TYPE_TERM.html @@ -0,0 +1,61 @@ +CONTENT_TYPE_TERM | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable CONTENT_TYPE_TERMConst

+
CONTENT_TYPE_TERM: NamedNode<"http://www.w3.org/ns/ma-ont#format"> = MA.terms.format
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/DC.html b/7.x/docs/variables/DC.html new file mode 100644 index 000000000..a80d45b22 --- /dev/null +++ b/7.x/docs/variables/DC.html @@ -0,0 +1,61 @@ +DC | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html b/7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html new file mode 100644 index 000000000..f9633d453 --- /dev/null +++ b/7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html @@ -0,0 +1,70 @@ +DEFAULT_CUSTOM_TYPES | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable DEFAULT_CUSTOM_TYPESConst

+
DEFAULT_CUSTOM_TYPES: {
    acl: string;
    acr: string;
    meta: string;
} = ...
+
+

Type declaration

+
    +
  • +
    acl: string
  • +
  • +
    acr: string
  • +
  • +
    meta: string
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/DEFAULT_NOTIFICATION_FEATURES.html b/7.x/docs/variables/DEFAULT_NOTIFICATION_FEATURES.html new file mode 100644 index 000000000..e03a272e0 --- /dev/null +++ b/7.x/docs/variables/DEFAULT_NOTIFICATION_FEATURES.html @@ -0,0 +1,64 @@ +DEFAULT_NOTIFICATION_FEATURES | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable DEFAULT_NOTIFICATION_FEATURESConst

+
DEFAULT_NOTIFICATION_FEATURES: string[] = ...
+

The default notification features that are available on all channel types.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/DEFAULT_SUBSCRIPTION_SHACL.html b/7.x/docs/variables/DEFAULT_SUBSCRIPTION_SHACL.html new file mode 100644 index 000000000..7a370426f --- /dev/null +++ b/7.x/docs/variables/DEFAULT_SUBSCRIPTION_SHACL.html @@ -0,0 +1,77 @@ +DEFAULT_SUBSCRIPTION_SHACL | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable DEFAULT_SUBSCRIPTION_SHACLConst

+
DEFAULT_SUBSCRIPTION_SHACL: {
    @context: readonly ["https://w3c.github.io/shacl/shacl-jsonld-context/shacl.context.ld.json"];
    @type: "sh:NodeShape";
    closed: true;
    property: readonly [{
        maxCount: 1;
        minCount: 1;
        nodeKind: "sh:IRI";
        path: "http://www.w3.org/1999/02/22-rdf-syntax-ns#type";
    }, {
        maxCount: 1;
        minCount: 1;
        nodeKind: "sh:IRI";
        path: "http://www.w3.org/ns/solid/notifications#topic";
    }, unknown];
    targetSubjectsOf: "http://www.w3.org/ns/solid/notifications#topic";
} = ...
+

The SHACL shape for the minimum requirements on a notification channel subscription request.

+
+
+

Type declaration

+
    +
  • +
    Readonly @context: readonly ["https://w3c.github.io/shacl/shacl-jsonld-context/shacl.context.ld.json"]
  • +
  • +
    Readonly @type: "sh:NodeShape"
  • +
  • +
    Readonly closed: true
  • +
  • +
    Readonly property: readonly [{
        maxCount: 1;
        minCount: 1;
        nodeKind: "sh:IRI";
        path: "http://www.w3.org/1999/02/22-rdf-syntax-ns#type";
    }, {
        maxCount: 1;
        minCount: 1;
        nodeKind: "sh:IRI";
        path: "http://www.w3.org/ns/solid/notifications#topic";
    }, unknown]
  • +
  • +
    Readonly targetSubjectsOf: "http://www.w3.org/ns/solid/notifications#topic"
+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/FOAF.html b/7.x/docs/variables/FOAF.html new file mode 100644 index 000000000..99c5b5efb --- /dev/null +++ b/7.x/docs/variables/FOAF.html @@ -0,0 +1,61 @@ +FOAF | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/HH.html b/7.x/docs/variables/HH.html new file mode 100644 index 000000000..7ee05443d --- /dev/null +++ b/7.x/docs/variables/HH.html @@ -0,0 +1,61 @@ +HH | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/HTTP.html b/7.x/docs/variables/HTTP.html new file mode 100644 index 000000000..e42827a9f --- /dev/null +++ b/7.x/docs/variables/HTTP.html @@ -0,0 +1,61 @@ +HTTP | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/IANA.html b/7.x/docs/variables/IANA.html new file mode 100644 index 000000000..a600e9e5a --- /dev/null +++ b/7.x/docs/variables/IANA.html @@ -0,0 +1,61 @@ +IANA | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/INDEX_ID_KEY.html b/7.x/docs/variables/INDEX_ID_KEY.html new file mode 100644 index 000000000..f6d07c4eb --- /dev/null +++ b/7.x/docs/variables/INDEX_ID_KEY.html @@ -0,0 +1,64 @@ +INDEX_ID_KEY | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/INTERNAL_ALL.html b/7.x/docs/variables/INTERNAL_ALL.html new file mode 100644 index 000000000..38db3922c --- /dev/null +++ b/7.x/docs/variables/INTERNAL_ALL.html @@ -0,0 +1,61 @@ +INTERNAL_ALL | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/INTERNAL_ERROR.html b/7.x/docs/variables/INTERNAL_ERROR.html new file mode 100644 index 000000000..1523ec12b --- /dev/null +++ b/7.x/docs/variables/INTERNAL_ERROR.html @@ -0,0 +1,61 @@ +INTERNAL_ERROR | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/INTERNAL_QUADS.html b/7.x/docs/variables/INTERNAL_QUADS.html new file mode 100644 index 000000000..b8637a84b --- /dev/null +++ b/7.x/docs/variables/INTERNAL_QUADS.html @@ -0,0 +1,61 @@ +INTERNAL_QUADS | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/JSON_LD.html b/7.x/docs/variables/JSON_LD.html new file mode 100644 index 000000000..118b8d25f --- /dev/null +++ b/7.x/docs/variables/JSON_LD.html @@ -0,0 +1,61 @@ +JSON_LD | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/LDP.html b/7.x/docs/variables/LDP.html new file mode 100644 index 000000000..01ba67e7b --- /dev/null +++ b/7.x/docs/variables/LDP.html @@ -0,0 +1,61 @@ +LDP | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable LDPConst

+
LDP: Vocabulary<"http://www.w3.org/ns/ldp#", "contains" | "BasicContainer" | "Container" | "Resource"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/LOG_LEVELS.html b/7.x/docs/variables/LOG_LEVELS.html new file mode 100644 index 000000000..d416f2f5f --- /dev/null +++ b/7.x/docs/variables/LOG_LEVELS.html @@ -0,0 +1,61 @@ +LOG_LEVELS | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/MA.html b/7.x/docs/variables/MA.html new file mode 100644 index 000000000..135ea26b4 --- /dev/null +++ b/7.x/docs/variables/MA.html @@ -0,0 +1,61 @@ +MA | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/NOTIFY.html b/7.x/docs/variables/NOTIFY.html new file mode 100644 index 000000000..15baf7de6 --- /dev/null +++ b/7.x/docs/variables/NOTIFY.html @@ -0,0 +1,61 @@ +NOTIFY | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable NOTIFYConst

+
NOTIFY: Vocabulary<"http://www.w3.org/ns/solid/notifications#", "accept" | "channelType" | "endAt" | "feature" | "rate" | "receiveFrom" | "startAt" | "state" | "sender" | "sendTo" | "subscription" | "topic" | "webhookAuth" | "WebhookChannel2023" | "WebSocketChannel2023"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/OIDC.html b/7.x/docs/variables/OIDC.html new file mode 100644 index 000000000..de88c8cdb --- /dev/null +++ b/7.x/docs/variables/OIDC.html @@ -0,0 +1,61 @@ +OIDC | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/OWNER_STORAGE_DESCRIPTION.html b/7.x/docs/variables/OWNER_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..915bd2138 --- /dev/null +++ b/7.x/docs/variables/OWNER_STORAGE_DESCRIPTION.html @@ -0,0 +1,70 @@ +OWNER_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable OWNER_STORAGE_DESCRIPTIONConst

+
OWNER_STORAGE_DESCRIPTION: {
    podId: "id:pod";
    visible: "boolean";
    webId: "string";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly podId: "id:pod"
  • +
  • +
    Readonly visible: "boolean"
  • +
  • +
    Readonly webId: "string"
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/OWNER_STORAGE_TYPE.html b/7.x/docs/variables/OWNER_STORAGE_TYPE.html new file mode 100644 index 000000000..ff369f29f --- /dev/null +++ b/7.x/docs/variables/OWNER_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +OWNER_STORAGE_TYPE | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/PASSWORD_METHOD.html b/7.x/docs/variables/PASSWORD_METHOD.html new file mode 100644 index 000000000..d0346ccc5 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_METHOD.html @@ -0,0 +1,64 @@ +PASSWORD_METHOD | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable PASSWORD_METHODConst

+
PASSWORD_METHOD: "password" = 'password'
+

The constant used to identify email/password based login combinations in the map of logins an account has.

+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/PASSWORD_STORAGE_DESCRIPTION.html b/7.x/docs/variables/PASSWORD_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..0f6af6093 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_STORAGE_DESCRIPTION.html @@ -0,0 +1,72 @@ +PASSWORD_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable PASSWORD_STORAGE_DESCRIPTIONConst

+
PASSWORD_STORAGE_DESCRIPTION: {
    accountId: "id:account";
    email: "string";
    password: "string";
    verified: "boolean";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly accountId: "id:account"
  • +
  • +
    Readonly email: "string"
  • +
  • +
    Readonly password: "string"
  • +
  • +
    Readonly verified: "boolean"
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/PASSWORD_STORAGE_TYPE.html b/7.x/docs/variables/PASSWORD_STORAGE_TYPE.html new file mode 100644 index 000000000..e60c54f21 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +PASSWORD_STORAGE_TYPE | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/PIM.html b/7.x/docs/variables/PIM.html new file mode 100644 index 000000000..3fb9619d5 --- /dev/null +++ b/7.x/docs/variables/PIM.html @@ -0,0 +1,61 @@ +PIM | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/POD_STORAGE_DESCRIPTION.html b/7.x/docs/variables/POD_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..e7335ea21 --- /dev/null +++ b/7.x/docs/variables/POD_STORAGE_DESCRIPTION.html @@ -0,0 +1,68 @@ +POD_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable POD_STORAGE_DESCRIPTIONConst

+
POD_STORAGE_DESCRIPTION: {
    accountId: "id:account";
    baseUrl: "string";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly accountId: "id:account"
  • +
  • +
    Readonly baseUrl: "string"
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/POD_STORAGE_TYPE.html b/7.x/docs/variables/POD_STORAGE_TYPE.html new file mode 100644 index 000000000..48e5f4c68 --- /dev/null +++ b/7.x/docs/variables/POD_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +POD_STORAGE_TYPE | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/POSIX.html b/7.x/docs/variables/POSIX.html new file mode 100644 index 000000000..a28d705ef --- /dev/null +++ b/7.x/docs/variables/POSIX.html @@ -0,0 +1,61 @@ +POSIX | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/PREFERRED_PREFIX.html b/7.x/docs/variables/PREFERRED_PREFIX.html new file mode 100644 index 000000000..37df8354c --- /dev/null +++ b/7.x/docs/variables/PREFERRED_PREFIX.html @@ -0,0 +1,61 @@ +PREFERRED_PREFIX | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable PREFERRED_PREFIXConst

+
PREFERRED_PREFIX: "http://purl.org/vocab/vann/preferredNamespacePrefix" = VANN.preferredNamespacePrefix
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/PREFERRED_PREFIX_TERM.html b/7.x/docs/variables/PREFERRED_PREFIX_TERM.html new file mode 100644 index 000000000..163a0edee --- /dev/null +++ b/7.x/docs/variables/PREFERRED_PREFIX_TERM.html @@ -0,0 +1,61 @@ +PREFERRED_PREFIX_TERM | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable PREFERRED_PREFIX_TERMConst

+
PREFERRED_PREFIX_TERM: NamedNode<"http://purl.org/vocab/vann/preferredNamespacePrefix"> = VANN.terms.preferredNamespacePrefix
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/RDF.html b/7.x/docs/variables/RDF.html new file mode 100644 index 000000000..5a68c270d --- /dev/null +++ b/7.x/docs/variables/RDF.html @@ -0,0 +1,61 @@ +RDF | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/RDFS.html b/7.x/docs/variables/RDFS.html new file mode 100644 index 000000000..584085bae --- /dev/null +++ b/7.x/docs/variables/RDFS.html @@ -0,0 +1,61 @@ +RDFS | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID.html b/7.x/docs/variables/SOLID.html new file mode 100644 index 000000000..da01ba6b6 --- /dev/null +++ b/7.x/docs/variables/SOLID.html @@ -0,0 +1,61 @@ +SOLID | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable SOLIDConst

+
SOLID: Vocabulary<"http://www.w3.org/ns/solid/terms#", "deletes" | "inserts" | "oidcIssuer" | "oidcIssuerRegistrationToken" | "oidcRegistration" | "storageDescription" | "where" | "InsertDeletePatch"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID_AS.html b/7.x/docs/variables/SOLID_AS.html new file mode 100644 index 000000000..b60d5c751 --- /dev/null +++ b/7.x/docs/variables/SOLID_AS.html @@ -0,0 +1,61 @@ +SOLID_AS | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID_ERROR.html b/7.x/docs/variables/SOLID_ERROR.html new file mode 100644 index 000000000..909b5f473 --- /dev/null +++ b/7.x/docs/variables/SOLID_ERROR.html @@ -0,0 +1,61 @@ +SOLID_ERROR | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable SOLID_ERRORConst

+
SOLID_ERROR: Vocabulary<"urn:npm:solid:community-server:error:", "disallowedMethod" | "errorCode" | "errorResponse" | "stack"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID_ERROR_TERM.html b/7.x/docs/variables/SOLID_ERROR_TERM.html new file mode 100644 index 000000000..c5e78c370 --- /dev/null +++ b/7.x/docs/variables/SOLID_ERROR_TERM.html @@ -0,0 +1,61 @@ +SOLID_ERROR_TERM | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID_HTTP.html b/7.x/docs/variables/SOLID_HTTP.html new file mode 100644 index 000000000..51985544b --- /dev/null +++ b/7.x/docs/variables/SOLID_HTTP.html @@ -0,0 +1,61 @@ +SOLID_HTTP | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable SOLID_HTTPConst

+
SOLID_HTTP: Vocabulary<"urn:npm:solid:community-server:http:", "accountCookie" | "accountCookieExpiration" | "end" | "location" | "start" | "slug" | "unit"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID_META.html b/7.x/docs/variables/SOLID_META.html new file mode 100644 index 000000000..217623069 --- /dev/null +++ b/7.x/docs/variables/SOLID_META.html @@ -0,0 +1,61 @@ +SOLID_META | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable SOLID_METAConst

+
SOLID_META: Vocabulary<"urn:npm:solid:community-server:meta:", "value" | "ResponseMetadata" | "template" | "contentTypeParameter" | "preserve" | "requestedAccess" | "accessTarget" | "accessMode"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/TEMPLATE-1.html b/7.x/docs/variables/TEMPLATE-1.html new file mode 100644 index 000000000..5bf5481c1 --- /dev/null +++ b/7.x/docs/variables/TEMPLATE-1.html @@ -0,0 +1,61 @@ +TEMPLATE | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/TEMPLATE_VARIABLE.html b/7.x/docs/variables/TEMPLATE_VARIABLE.html new file mode 100644 index 000000000..04e510172 --- /dev/null +++ b/7.x/docs/variables/TEMPLATE_VARIABLE.html @@ -0,0 +1,61 @@ +TEMPLATE_VARIABLE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable TEMPLATE_VARIABLEConst

+
TEMPLATE_VARIABLE: Vocabulary<"urn:solid-server:template:variable:", "baseUrl" | "rootFilePath" | "sparqlEndpoint" | "templateConfig"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/TEXT_HTML.html b/7.x/docs/variables/TEXT_HTML.html new file mode 100644 index 000000000..421373bb9 --- /dev/null +++ b/7.x/docs/variables/TEXT_HTML.html @@ -0,0 +1,61 @@ +TEXT_HTML | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/TEXT_MARKDOWN.html b/7.x/docs/variables/TEXT_MARKDOWN.html new file mode 100644 index 000000000..84619b705 --- /dev/null +++ b/7.x/docs/variables/TEXT_MARKDOWN.html @@ -0,0 +1,61 @@ +TEXT_MARKDOWN | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/TEXT_N3.html b/7.x/docs/variables/TEXT_N3.html new file mode 100644 index 000000000..25eb11ce6 --- /dev/null +++ b/7.x/docs/variables/TEXT_N3.html @@ -0,0 +1,61 @@ +TEXT_N3 | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/TEXT_TURTLE.html b/7.x/docs/variables/TEXT_TURTLE.html new file mode 100644 index 000000000..f84b2688a --- /dev/null +++ b/7.x/docs/variables/TEXT_TURTLE.html @@ -0,0 +1,61 @@ +TEXT_TURTLE | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/UNIT_BYTES.html b/7.x/docs/variables/UNIT_BYTES.html new file mode 100644 index 000000000..ce685d082 --- /dev/null +++ b/7.x/docs/variables/UNIT_BYTES.html @@ -0,0 +1,61 @@ +UNIT_BYTES | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/URL_SCHEMA.html b/7.x/docs/variables/URL_SCHEMA.html new file mode 100644 index 000000000..bf08b334d --- /dev/null +++ b/7.x/docs/variables/URL_SCHEMA.html @@ -0,0 +1,61 @@ +URL_SCHEMA | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/VANN.html b/7.x/docs/variables/VANN.html new file mode 100644 index 000000000..269b8b654 --- /dev/null +++ b/7.x/docs/variables/VANN.html @@ -0,0 +1,61 @@ +VANN | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/VCARD.html b/7.x/docs/variables/VCARD.html new file mode 100644 index 000000000..0f4080ee9 --- /dev/null +++ b/7.x/docs/variables/VCARD.html @@ -0,0 +1,61 @@ +VCARD | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/WEBID_STORAGE_DESCRIPTION.html b/7.x/docs/variables/WEBID_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..df3ee2c14 --- /dev/null +++ b/7.x/docs/variables/WEBID_STORAGE_DESCRIPTION.html @@ -0,0 +1,68 @@ +WEBID_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable WEBID_STORAGE_DESCRIPTIONConst

+
WEBID_STORAGE_DESCRIPTION: {
    accountId: "id:account";
    webId: "string";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly accountId: "id:account"
  • +
  • +
    Readonly webId: "string"
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/WEBID_STORAGE_TYPE.html b/7.x/docs/variables/WEBID_STORAGE_TYPE.html new file mode 100644 index 000000000..dff6d5df2 --- /dev/null +++ b/7.x/docs/variables/WEBID_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +WEBID_STORAGE_TYPE | Community Solid Server - v7.0.5
+
+ +
+ +
\ No newline at end of file diff --git a/7.x/docs/variables/XSD.html b/7.x/docs/variables/XSD.html new file mode 100644 index 000000000..6328785f3 --- /dev/null +++ b/7.x/docs/variables/XSD.html @@ -0,0 +1,61 @@ +XSD | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable XSDConst

+
XSD: Vocabulary<"http://www.w3.org/2001/XMLSchema#", "string" | "dateTime" | "duration" | "integer"> = ...
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/modulePathPlaceholder.html b/7.x/docs/variables/modulePathPlaceholder.html new file mode 100644 index 000000000..32b042f8c --- /dev/null +++ b/7.x/docs/variables/modulePathPlaceholder.html @@ -0,0 +1,65 @@ +modulePathPlaceholder | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable modulePathPlaceholderConst

+
modulePathPlaceholder: "@css:" = '@css:'
+

A placeholder for the path to the @solid/community-server module root. +The resolveAssetPath function will replace this string with the actual path.

+
+
+
+
\ No newline at end of file