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..d0a845987 --- /dev/null +++ b/7.x/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8y9W3Mcx5H3/VU2hNs1bcm29nD1QBAkwSZFGADJ2Nh4QtGYaQBtDqbHPTMguU+83/3tnmMd8vDP6hyuryhhKit/VZ2Zda76f9907aflN//53//vm4/NfPrNf3773b//6zfz6rn+5j+/+aGuurr7UN9fTS8/r7pqsmq7b/71m3U363+czKrlsl7+nkr06mn1POtT7tL0qb/5//51r+HP33530DBp58tVt7ZlfBZLBUr+9ZtFLzNfcexHiG//8N2fDhSz9vGxtgAcBI66V8vp75rl7xZdu6onq3payvJSd83DFwPLQYBgaV6qVW0g+e4Pfzp+/Uk1/6WaT2e15csEMkXfJSJ4sqp/8tZ9Wz3Y9e+Esu/RzJ/6b2Wzje/+8B//9u2fjw5z0dXTXrCpZssD1+rLoqcKfhHd7/s///mP3x/y++23QVrJ6uyQiq7XEIox6+pxSAqpebVPqyp7tePyKNxW6y7H331rUL/jZQr+afiyRQiv9qI2kLxSIp7JrMG/xCHx1/0UW7X7ivjOUgU7YrHw8PdIOF4F4kYg5aM0y+U6aIBkqkPir/tRtmr3lfFHSx3siJnCD8qLEF5tJY0YxKcIujyBGN/loRK5dHnYjNkuj9S0kGUxN/YCE9nYexExjT+PQzT+vixkZ0DjMXUGFKbQUH+8bq+VnnmexMVImWyhXjlBzUSFtmsem3k1e9fNzCU8Y4SRHjJOyPTUOSZTPx2nYMYuHIVx5CJygAGEtRd1rIBrZ4IFp1oZJ1j1koFB1m0KC7I1BEHhen0/ayZQG8YndQkSSvZF7ZlQOptZaHCKedg5eOdQ68ncxpbWEmnEWE2ZjBniC4363bxp55BNsyldTFrOHWr++KJwhtM+3zfz/LuoLHsxJ45lvXpfzdZmkEAOafYQrqj129pft7RyBXJ8Q/gvkhnbPyUbA7SPaQ4BZjYmTkKVeDqqaja7KK20RPZrfWQhlEKVaYqkkLdEgXRZT9ZdfTFEqmq+AmOqLuQUXkFFYKQFysrNEhFzrAWUUS5Y9CtnZoYBOK40MBhLisUalFTpnY1hk2I0/N0LwvXY2mQCjq1GjbHHZqtEGFJmL+hkrqHGMouBVMaoEbsEZRy1qzxGoy8bvdsolLBQMIov0S86ktNoXreWwFnOJ5N6ubx4qicfCZuJfnVxjTzHIo+Isc2GR1GYwyrEwJgdAWDs7Rq0k0bHEphsjaX48/e0iZ13j8dOTzNf1d1DNUlxhkSitcVLv5MZnuPZNjXt0Tkpo7JbB99U17lLPlIp1W3UdXPdRBghDBbD+q8SMbIkPmGDzrYsduSlMDovA6O0F7heIXBx9WCPXsZaoIOIWBO2SCLxZEZ4MeQJWGKezs8cmbzLbZIoVIFhcliIdeIEiomydVNmp9aa4Y1Vrh27xYpkmdn+3LXrBWC2eTo/s2XyhmY9uEIUmCmHgZgpTtAs39TP93X39mEjY0PJhZG5CyPhQ72aPP1tXU3zuSARLpI7AZfi4KwVlTm41aZ4B5ftyu7gIlk4jpq9aadHpnq+fh76ZJu/yn3Z70PfXXXtTMjk7JiE68ptOfgdnn2K67p7bpbLpp3f1ulWvfRnmT3e2dRb3KBc3tmUJfLa2URnDMU1kp3phi/bdTch9+kwAAcBxEstJF29zTr8iDpOLOXAhO/z4r6QOtVjIeD3dTHqlRbHrpvbxyXqt+7jEq0k3MdVz+pVfb2RFDY6Ual8dnOxOWMbukh8m2sKCCbfNLFIzikA2b3TRNVs5gIemrq77VOu6kdifxkPR0p7MKI7vQRb0jd7WRi4/V48gLbly66d3vWlEdg2fmm2EwSSq2Gq6bmeNv233cYfPpwIaV2CipY/FFqkAhU4tcpkd+0CwiXn1ire0ubSJWx0eNbJLEEa4wIDjm5natgp4GGCjwqjhKBiEjIQgTSmcATaVBCUlOHGCQYaliGGVNax3Wm8Iz2egjFIsDPtpZ80Q6cONdSVflOvntqpZnJEIh/D4zKGGjuSvaCV4ynszZvChDoCXy9qcLYQcE7AqlfCsV037QCKfpsbKFYSOMOvf7yuVpMnxRvIVC7uwOcM+QONX+AQAofdIzQq0CWkulF9wsTAOIUAoHhFgXbSLVQCk19oVOl+GnIqeP8DOhvcd4CmciZnuyTSqn4yGxzkXy0W9VzTcEhUpuPTUJWKin2aMg2TTT9RUXFIVKZjuhkmKzoOiQw68rn5TaLquFC1n5Tf/V20nTQ3aZofn+Pnc805o9/glYPbvpL+MXu3mOrrB3xSl0ZFyR5qWYTSFDQvGpG9jYH4wIZGrS+1tbHTME2OhqK0O3aOZrmVMZMEgqf5Xr2C9WLRdttGzAwXyJ6KbzvveDVf1p3d5DPxU1H+2uYbBnS4rdRpmJ6q5UU7nzarPsLm+wV0F4ilT8a4/TJFgEfRk9FtraeI7ih6Kjq2Q4vFN1OvFmupos3ii5u+x0luFN/94rRJPMwN25l0QLOdikhUGQ9CqFqrCb/QlqiOkyL2hWlvO2rzd656m85FL7DKmBAUryxSLNgG/Ei/tutM01JvPefY/yV2c8UaSQmXEm8HO32kX/U6VN9KErsQPNary4eH3lual/q6nTWThgi3CQgj48VzPu9HUL2NXx0MDSGipVyYhqH7+aT7sVpVGkic1MdGhKMxsX0UHIuBPJI5lEJ4pfFASq79+z+FlvBmmMkJWoKH9Xyy6RH9/vij2IrF2W1s9Qud2/Y3Q2a7fYbJNsAozyhJadY3dbIWy6vYJy1VNaun+yyWgLowOTyBcD6b3a6qVTPheifx7z59FCJPrKeSwDJt6IKcvBG1pyJQpGBpoFaUwtDaUkyjEKHImrfHKUvJ6WjFl94Ws3iS8BjdevXUds3/1N3VfLE+mkR4BCxOgh+h046WEfliB8sSZnYC7B/rvp2ttytPMEEmNgqieqmaWXU/q6lOnIbCCJuBwqB2SJUb3uEnn1AWZ1d2gOlIa3foVL/dl1XtXABLVFsP4YJ66fBB6rZFDkp/bESfm1lTdV+4ljH+3cmc8jyxljGBNY7kKbXW8TxG0OGVeXZIC7XGmP5qn4wfXlMolNg4KszFCBStj4BpfOj/tE9KDjEp1bmQYx0Mc9PDgmkvdJDAsBhJRzYpAFMeWxCFDXbChETWVoxxkfWjIDi+/TSvu2ODzYRIMpVLoORzhsIljW8LmgKCMXSaaBbtlJ6YFHgCGcQpTDxV346ysVRgSuTcuYa5p+qxLkHLRT3okIAvQClh36R9iOPXLXFsVtAfyPhYdUa0ETAzHaROQMWHfSn+mIN/geWQTYBqPaaGQPW28HLjjdAwD1U1vRTTHJCpXJoDPmeoOaDxbc2BgGBsDkw0TH9aoDH1qk0swNqVwFW8jqUxQtdO81zajdMW7ZsguhHI45yAEIu518kw3b5JH88hAWCZpDtbNZ0eUkpLhAIkn4U77Waua9HVK0KhyRfkfNy5hUvQhchqv//c7qn01eeat9puPddiXNTQrZ5+qJbDSgsTd6PfnRq3PE+wWYthrQ0aodbclEEE932Sd12+HZBEOCbG3AAiWPTJqKBC6N8nHacda5QI9WpzBGl8HhZrt0nAYicSjqUfWjeDO51F6R05pCBIeWBB+DNYAxP4WIswhjzWK8Jgd2hzNmmFVRU2pU8AFHPHQiFbFGNQlFGs4dFKJW13V9Dsu90ROiiMyWBaQLNSdPWwB3u7M+Ky6+z2RGVwkvoaFmGbbrN/VOomarR0JichbpZDmmGcNqmoLfIKay5+EkohkCuRxB7Sy3yEDu6In9jCPEIX7JNIZ3vY3RJkQrc9E3zu0M4JuhTF+ycEGnAXhQpEtrlcl+gUyym2lRTM5Io7W06zqiOn4uFZeD8GJSqM7fNhU7mbl2tUKyRTuZginzP+jBdshNITXhxD/nyX/N6Dgee57h6DVvxNtWBez6LZaHGkiR1DOQbRi8/w8JjkT6MfHRsf/STTK3tsbGQcVCvtNDT6A2PMsrLf42IOwVutPPujYmAYH/p6+g62LI3bpsgRO9lycOtuNka9eUcbTMLuamNIjDvbYA5xMwZLU7AVQ2ZCt4+W7W+DNW+3q62ecN2BhHMtRCs64QkVlYmQ9LBfwwZjtz1uRptht/767XUTPSsIpx/q+/PJjImj4Y8uATTLEIqcEaMtZOYKjbES0V1NZmxsygHi1Ig3IgzSBGrOYJ8zheuB2sHHVAK+cQ/RDmzSyDmK92Zg9SE96kFVSpx+BAfSUOUASguF6Nrs6BCGULnSXMKr3NN6uDq0H9TagBgxL6rN6cbZ9lApgpOm9+W4GZ4FXDYviHnkEl4s++7JMIlbDYdAh7Nv9TO5nYi2IF7aj3G2qpm7EyimMLUXA9+dIVpWcz8GjyVkB4aLJ6aeC8cQHXrcdWyu+Igfnc1jk+MT+4Pp5/mUqDtjs+KGBXxpg8PWf/7zH4819Ntvw9VrjnSvDjmaIV8x5TVVNHPosqgs0hnMf4KqXu7q+nffOdY2+37ksHDpY9ZcTv8UVU3C7Sv6+6KKpsvLW/Xt+v7v/ehifPCgMvqnqGSKbV/Hfyo15ry0SqMANQX2BmDd//z20zzqZuAqzhhxpUo8vpbOsf9G3wIR55AbWSA2yNxs93JMr+Y3bctcU0DyEqJfvc5ShkN9/cFQX1lBuDHjdPqmXlXT8AogHTGW+uo1FKiHewqHHEJ2plJeqlkzrVYWpEDkq1fHXvfBUIDod8jhAO7XEzX3P6FjtP71JvY9kf7QV+xz2nua/1SVujQ0zF+vb2ntUf4vVanYm/x3U6Nwyj6ksef4v2efbK8R6JmjfcXoVdL2edFutg1qV2awKV1WQ+TcsUdK2aKUz5IrWMVT5mbW51234Od6Xvcp7TVIZXAS0l2jbScMBU9C1nJjFhCQkD8JZ0ePEEDKTNqLMZsxF1o0kNU4/+dEmc+jF2Hyk2dmTrl7gAYj06xTSV3ybS5ekfiUjZlQnJcACU2TEwXfmRn9w58YnAIwk1FjbRAKGXCbebJhrq0R4ce6UDQOOkivm/nHN2rjS6Zy6RjxOUOdIhqf2zjSJ7YA7NIjDYyJA+iYCVTFnTKNEdlIIHApOwpM2vnFT8lezKugBTVCLoeqtWJaF1VtKX6TUnHd07it0WWVRwfHGoWbQYx1D9w1HCm4dyGdzBE1xZvpw3t2bBT+6GKAWYZQcxExcgf72vlL3a2I3h+p85AW22TIECDGlatXQi6ii3cqorRmf8JLSxoxV2KT/XLfPDTddr1q5o/IbpMDmiriY+aYGsz49VIyLpHe32+lO8qDTmIhLRm3o+DGAbw3d3mNW4f05eTY2B7ltg3yR9W3Pto3VDY+7B/FvNka2kvfxs93FABnOZ3AM6UQCwfWk4bT8UHUK3T6BkyXqSQZ0TSTZOVTJ5JkNngeycolTSPJSMgskpWGnUSSUdQ5JCuHPTCdKhydqHvguqvCh9kaUcZuW7B78PiKHrcroKCe7V0Cx4V3pGUJX81ePzw0ny1DFlXCpYnFtGBPaatF5BrdjWAp2kEai0EWypJgBFIbhyrO1MRzumOw+YFKMTcWkEBq2zBlTF3rIQmvaHyQYiP+j3/79s/H4HCYbIlv3hp2+Sx/H/8oBhxxsxGb25myKTWhY7coLLp62UvEPWNN66tMDoHY76NVV4twjkb/xCpD0Nbw87q+k7rgjK7Uio6Y8Bw921k6savP6jpoJSdYx8+uktqDwxo/tNMv11W3rLvz7pHcZxunwI9p7C6uA7M8Oyan/SEBVfapoVqftTEfrzbwv2Oi7Asef3LxwCS7IhcMaM0+mOk3O6GunfHCVLXRDVG9pB/Suk2OSOoPjejXP14Pg2zBlrIULiZF51pkWXkRzAbG0ZB2VqSbMS9GsbKEB2tdDL9u0qKaIwlk/4jEInbWYJBXx//83bfa8aI8NzIjLpJP61m9IiZmiyBfHXMbBat1Bee9JHFPQhnzMbdTMvd+Pm1W5H0cZdhRhs7k2U0Vf1tXxBNjDHgoMNahMpL3VdcMLwybaEIhV6KXPjg/fDHVTiziSiO0rGLYNTWwEk200lV9EtrY6FefNa0sx6K2NcbmdlDSV28RCMa7tzjt0L6YXLu2MQbRJuyMIWrcvjUGLzG9N4YrtW1zDPfVw5nmPvU/Zu8Ww5qRYNl0Mp85ZT7rIltnSmQzegnKaP0qD2iYYj2pPVwbBeOMEoLilSX6SdfQGUw+oltLOFSvls3k4tBF4UbtVCqfATybM7TkQuPbHENAMPqFiaa+qx63Fm5CisV8uKDpBh5J8ROT9k1v98fecn+h7/0UMHJRpNNmpxs+QBlcKOnOJkxSCT5mn6+y2xI9haTZk202SfO86Iy1Eu1OEuhsMU4q63iD8LKFkSEFjiZ+DKQpulmhxBKsMbztmsdmXs3edbPLz6uuGr4+t9rApcXXHYTTW6ge7QxXWAds4dg5oslsPa3/tq43W0ia+WMBHpVHOV4QK6jkmf1QiVxiBpsx1Dci2cuP+PEwxSf8TIS8nQCEsoEUEyJRjqdS+k0W3XysF2zIHO/ttUHGW61GTDFXs6HAme+q7rFe8X6c/O7iwlSeRa1+Cm82BJrEbAMgB+MMJISxxTcRkAYoUJhsjydJn4U5bDlnupxEGhfz4/KFn4VJwZnoPDxn8qZa4PqPAkgYlknQp09IEODpE1Cz/KAH/RWKHvQw1QT7oIdQG+YHPQQriQdeq17mdT1/XD3xY680jdfwi8y3dASWFcQ258TiGGecZBJwEEaTKI5h0CwORJmvUjIWtdUENxSUasM6GpSsJHeMuy+LWnaLYwpPp0hyHeMSQRGKzDBFwYxQ16qaYFYHpQaI1oBkfnQtlBgfSRObXvux4a3u+KOTwSUZgjcJBozsto0hDdUFoXQe0yK9D0Y/ZtapctWidV2SMWdlLbBjtLSMCdMlNlov/cWTi6Bu6hljudGvLqab5whf+HTEtHUSCJXG7gGmfZuI8h2KIEyNeA/HgF7flOgHrm1StcnXNaVfueiaJrDE7PVMZKnN1zKR3z53orebczYcx/ZXTycKcrQ40Q6TMeOXarZm6zLUuE84Qle9eKqf667Kn5Qk9IWJR+isZrP20+tmiXynszCxTWdkpO3m1/Mhs41xqXpTAUOAkEmq6fSuZc+yUzWQCBhrnrizjGlq4p9d3ITIctRVZaXRkOQovqSsqAWgEAqvJyuOxzxD0cVkYkS+nlXN/C/Ldv56+tPmnbaMJkvhYnJ0rlB0zpFt3RxGtbGrI1EghsZQKN0NWOvQbfqlWm6GZZ9Xfcih7zDh6oKTRuIrzMgHAs46zLHA+JVIdxS/lMkjRcsNd5TO1o/cLtLDTz47R+PsynaLHmmNO0QT5dZdoZReaA9molfbd6nqEXacpvVrtmC0lPROT7Kktt2d5NcNl5smk3qxuu7qh7oXmXBzO3Qyn0UnPusig2ZKZFwAEqC0NSCTfmEZSKoX+0pQQa3Qi0FqzdjWgzSuqLujmelJDNTPNMcbhZc5jHQP2DH8GOjG3csMQQO8qeaPtWqFZCqn01BczoWnoqjiWM8nsUjqOSWDdum8El8nBeeWzDXCnF9SasV4jkmmCk303XxYWNdMlEzlYqJ8ztDwkMbnjKJ9vm/mee2LDHsRrJuq8UQ95e2nJa6LEoACGZ7oXyTrsFUZ60dSpZn9yMTERBa10k5DU81mFyWVlMh9jY8pBCC18kwBSKUK78QZDlfcbO+j2SZk78YhU+J71VfMDk1MxVkuTockpkAM1IILvSAVIe+B9UxPS4NQmbQH0oQ7WQNCEfIeWPf5IWAQKJIsRUlPW0aJMzfPk/ids8yzxQ9ZxtRG/9UoJMdVjsdBXKwLa2Ci73qQMV6scQnu60HFOjJgTrwHe5ARvqwxMU5cSAOflSVIkIOykF7lrCf1YcoOehpqgT/lydaE/YgnayPhkF6Mr/6h1RBVxSHhuA/v8s3HGD1m707a6SG6i50hJvbj5vqst4vhgak+2HHH+OlkLkYnZA216UwJmKi77LPK61ti2Esg8VZlAV1ArBP1OhEbBeMEEoIS/Uv0k26gM5j8QbeUwDF+rleqVxBpXFyCyxfyBwrc5AysdosnGCik60NYFvXyECMR6Jj8l1G90qCfcUlWueKPZs2kMyraTZ6oWEfghsMtI6ofUolcHJHNGPJEkt3kirx+iy9aOCRn5Gns3qgwge4ofB/VHy0EjEPy6hWPtOsmXVLTb/JJjSm89iNJFr83EF52QSXEJ1Hbvbgt77NQjv4AdAnoEKSGn5OEHlvYEe8VGO1mFhfzIOHun0BdzY+BvvXBy+XANvB6uP1UtUIylc8mEzZnbFctiW/cWcsjWHfXWmjoVlmAsTTLGgm67Ub4OmojaGLgNtzwANqeY7t2equNRmDbb6NZSOia7VIfJlKJfByTyxjzS4rd6JYsgNUrDSyMU7IoJp+UOVCX5L+L7pEGAs4hWfWaP5p10+6o6Ld5o2IZoTOuAV/M0/i4IpMv5okEuNEROfVWP8RJGDfkQExeiFPslw/Zy95YIEJyPBsaIFhr0eMDrp8LD5xyLTpYNdPBQdZuiw2yncT3krzU3fDK52XXtR0XHehkLgFCyBq8OoIsAb/sPaS2FfEslEJ8wcakbl2Q0Aq3L9gIl0/tp9tVNfl411XEW8oSXybqQoff/MJ/UzWi2Cj4W29YBP3qG7N+7s4ZhSGLLuUc9XaLzybpj31T0szyrbUSEC1/Aqvp6l7+pl4u+iBjNJ1U1IcumEgMk3A7MdM0+PRhPUjCWZ7tk9PWkaEySoXHEWm12vOIkuKghRPbNffWDG/DpPZ7XNRDY91YAibiQXHORzcZ7eAYV8AQb0KaNl0/UND6Tkw6p41JfN6FW5ToQhVsVpLI1LbXyMFuWBIgtJNOJQTMpiWVwrh9SSOLTrb3WYv2mSbwOeVOZQr15zNe4wl3UrH1nDvIUJvr9SwRQXoOKI3SS6d5ivrnAhF0GwBJot0JAOoUbgagbdJ+P4Cp9PQtAUIN2O4KEGwjvDFguK5pe2x7+zzNhyEn4lw/nc7nzgAhb+yyaqYQnDusF4u2H7RP39Srp5Z4FVIEIqQRzzAyVpuUwxWeRrxY0IcMejEXpdLeyuXyCQvGzZeQbwobwV7tcynGU16ZXbTEPW5myFYYADkwrh0Q186E0FUfEqR214fqCMlLt8O1Qbv77opCCZODj9NGrM1yWBXiLvMTIVPR09Cti+HWp2bbboIuxEuFT0D4WM+HGf2tEhtfKnpKuo1EId5e9gR8wpU9YrfEfmePjUu6tEePcbZbe/SuSfSkyedm1lTdl+H+zP29hlyvkU/r03NU8gefOuELZBtiqjjG0WYBWbUXYZd3VUgqC8jx7LTLRT1pHppJOSyRw4lYu93Ni3dk51fjTKT9GLEHcBQ69SEcM4n0II7mswUP4xTWFPNADlRbxodyIHuL19+Xq2q+UiIsncxr/Z3LGl1/p0rAuNfTpuUhVwRZiqMMuM4m84CrtjyOumpr0C+uXfPfpeTpEnOtcGvJSs1YHzFRrId+REf3Fzqll8sIuY99XGes4Upo+GM7DuYr1tGYx3c8jFivpdLHeEBT3jxQo1lxnsjJgJmMDY/1YPFee7SHZih5vGek23Aw0GM+452FrYvCx30cXESukYLHfiDH2D3XoHgGmcrFNficLe+YgONL9VkecnRZ+DzPqDGvxFP0YNEodxVosMeDxjqsZCWljwmNdlm1VkoeF4KctrfFxWZqW/JZKpGLy7IZQx5LsoujF8pfeYZQBvFWhQd6UYWHkb3Dolt4U4b/HvaXZcy1Qb/votSI7ZUXhSnYxxknYo+DE8nw3ZxduoUVyPisozavRoUkyJWjJiaAQKgIgHi9iYs7J4g4TqO+0Z7m42OjYg0WZbz0i683jfVrqKlrp81Dozd2ZDIf4+OzLjNCukRGMxCgtEbHpF9wBqle7E5RUCu0cao1YzNSjSt7+kCxVCKNz9ZkJt/yRw9GDWBYHOPwRSaBH18o8BODZuXhBR8PMdcE/+iCk28oVhJuiu6Nr3qsf6yXk65ZDCt259PN6RzyATAhsc9maU0BtnFaKpNxE7UKZN1QXcC23Mqwi8Y6ZJ4DMgArYd2u+77U19Uq35mogybijpTQdmyVT9uaXcAibNPWvcG+Zbu4tujt22CN2bZyg3YXhLEP1WSzq0dp4ulkLqFLyLqooWdKZDNoCUoxZZv+ajK7a6/r7rlZLhvirU8JJJdF3N7Gtz2oOuz5Wg63tVfPtu9HSJ+AkQ0EIps5BJRYFun8unWZ3F7lihz+06fz9epJ83cqlY+7szlDXRQan93jRrSlAsAuPWShCgcUZHgSLcZYtAvuIXwLu3fYa4R2Dq1WbL6h2Uu4or6JVtP9qfygGc0g+aQ+q+ty9tgaO18atrtcrdbLi3ZKrOUqQJEouKJr5stmiVE6cqbYl62I6wRM4eWqHxFLJlO5GDGfM2S/NL7ddAWMAqs1UbEGKzCZbdVEZKXxJYmuPljWK8Q+uYROlx8ImUNWypbDbqgyTIGtWtlYc5XJzBZr5SpgcueJTRex2lMZ7Chb9TFTk4UWEkjGaLDDQu02zWO05g//bZMzAzMijYthcfla3v6LwG3Txax64yyxgeRZHgGzRJkcMlyUuWzPthHfSL0Mx6Bffq4uV469V4drlp6I47SXvBHH2QgR6bl1T383tHig0qSNMjXcysZTsDcvQbbmpZ+5d8nF4iBj25nlout7I/NVRXYriDSe0T/L1xL9I3BLs8oqF5tVg1a2K8FqVrsSBu33zbzq8rVHVvchfYnm777/7ts/HXU3y8vnxcqg/ChQpD3Yt3gdXbES7Ofb/IDvTZS2Bh6zsg9CtnyIndIK/ZQlBkKrI6yiWGFqFbRGyhQsKkNjYMJaoNgQ1GDzKPLsgkCmqHRQx5tIQQTBVApGUhI4WKXfhyrjVG/Sb/uwnk+GH5a/55KKhvPdH/7j377987FF3AtdTftshi1xx4ZxuFDouCv0mKAo//fVbF0zWW9+K8r1pp603ZTJdvtjUb4/d9Xiicl285vsnFH3Wfyax06W+Uvi3Wk2a3DGhCyBcd+gAGHdOmjioZ+RkHAsL0nYWJr8QiQJpEGvQFIpoq7+sl69fam7rpnW+QUCYsXEgv5k/1hXxKVgEtJeotBy055iHgOx7xSIlZIkX6gkUJzFch4k1XT6t76KTRRHGUcCm1kEQh4MXf3cvtTmiojEfDls1RHLOX0V6wdxrYOC4jvpf2g7+wcIhPyj5rZ457NZQaVspTzq5amyVck2vYfmx3plLfxBxEm/VblfO2FtH/w0B1d1WCFiUX+PeCyny0RP5a+lgJS0D2PcF5oU8k0YMieWt/d/7wcEpUQHaVeu1/X8kdhjCTAdJIt9Mh6+bgbS14enrI4ReTuCTX8Wh5fiNdZCfmfKjdUZI1wcWbtzYUrKwo37Xoi5D0Hdq316SKlyN/Wnunl8WhmUHwQKtfNTnpRhsjNqqJlGhY0+K5z1mfiN+TIwEJOn4QU58oICheMo6YTSh4t61TyX1Ekg6gTT/9hOm/ljAUwg6gQzq+aP6+qxpGYCUSeYbjhwWUCylyvHEOOiEUR7qoDPY1sOpnLW86bEl0KkV7s8iri0u/+rblUQzmK+fSZOgMlywrJdd5OamOCPlxLSZPLEeRTlWQ1RfZgUpE9VkMuoTJ5ni/QAaFydGS5drtte5B+zd4shFLIruVkivFTV7LG+78glNDrXs6MEXbScuGDFkNFtXlyGYYwgp4HgVxcZDONiNAwirDkyJNZFagkltP/D28cUy+FH0zL1UzvVMzs7JKSt/MjFdQOr7pHugCWKDgkLFS3kHm2iLU5dqLIfOU6bTdAGNEaJCxXet1PSGBNVu2QGJcEi6bv5sp6su/pDfX/bTj7Wq+V1167aSZtP6/FJXRZLleyhBVOhNLZFUw3GuHBq51pQ9zBoVFnjy09KFdRUs1wN75zkk81qZQWSbmzgTlLVqtS9y3YaZkephqLsZLZztPN9h+viaeiu5gtHGhKVw2m+oLALFqs3045YzPrDx2Qmk3Y9X/Wp+vb+p2oIQsQjIEQil9DIZoy9G0Ox28IhD2B9KcbA8qm+v5rekptIeJ5ICDFVC9H2Xm8rUix1GqZfq2c70k7IgQh63IWl0V51MeiuptMouYGCEPWumV7Fh8E+3/cR6aGZ7CYV7Jx8Jt7EwvM4vHHZ38UxWxf9II5iYbaXcBQfDC9uqCZP9fQvnz7+vH0HjrpRIUvi0jAw2WIXNOTU/GwJrHmbdqzGj3XeunIat2kRw8f17+5dgxmO6X05dsJ9UhglEnGmWd/PmokJJpAYzZJuNLjeyv/VYCupVIGdZhSbIlohAqEShmCqaDuXuvrSB6qXZlp3u1B13j2S0xRCcsOkMNkNNmg5S3OgK0EqGxerptVidUhZxJZl4QZ3Xy3rd92siOoo64bTNtPJNTO/r/IEwm5AG/3VZmHkpl2vyPUwFYzIxA1wMmt6mYuu3ohWs2U8FrBgslm5waaNmIWOatBG4vyd6h9ZmJIM/Orpqf10u6omH+96symsrjQLN7i669pu250uq7UkAzewjj6cbkHLshgFF3TIGYmshWbSuXTNpbyh/jlXCNvMjYhhnLwxEtG9BAiM7x7wfUcjXf8JHpp8XKN9tq3MCXiYjgvEJfRY3PjSvgsERnVa3Iiy7guERPZb3JjYHgzEJnZd/Cxf7sRgnqD3Xtx4ucG4CGgbkRuJyK4MhMX2Yfxqi+7NYJXGd2Pc+MgODUTH9mTc2Jg+DUQndGbc+Ba7ZObGdC/lw5RPxJRgxYKlfSDitvAynEz2BHU16ZvpdVdfDoa8v5QnX06XMZksTkDbzJvhRI65lxTJncTiNgG03r7J+tf6i7EKSflT1N9ye/P8Xfuxzu9SkqswET2FLW6+UG9KF7OqebZaYSZ8CsKNRxZ0o2LBU9bdRkdp3R2ET0m4CRSlhAdhJ8Jg2vp89hguJATTBttfTHt5lWzERakdCE1JrukFSuAFPYTYtpiGLNiQyxOiRmhtglGNnmiQte721P/uO0j9qwhYqIZ8rUgl0heKTlIRB7XaqY6sHo7A9LSYvHvJf9uSYb+SeLPXuI0KLjsUxmx8wXa8OGknN0b47IhgKcJr95gZ1/CON8Nka+7GSddeyRcaZPANFurImmrNk1P5kJo8WzRk0q12W1Sujvs6j8eKkhTyEd3oTNUyfgPumOXhNzSzl2GH0heJMkkhZvzHY9A5v7h4++7Xu99uL+/urn79+fa3m8s3l29+uLz57fXbn69+PSh6qbqmup8NvQFZQj5wlZyN3uHe1qtVM39MT3onv449G01lp52NTgHZ2Y7n+vm+7l63j80cV/sqlYMg5NPK+8Tcamr4Ox4wtuMAKL+zQ1q5NBtAe4Dg9GmBIZLbIfLzMLu6xgCi9KZCR2rXm7NMJs2piEk5FQXu3t6c/3z524+Xtxc3V9d3V2/FCJCnLvdRPHvVZ4XCmPzXjIT6s5Bbfk43vli6Jv173ztJE7j0PclM0fuka8b4wKcECMXSSit1Wz9EwC2M0Ai2FRGUYZjsa6pZ8z/E6RKaI5YYyQI+HUBg6O8GQDqTNkYxP7mRQXUSoV7WC8R6VDcd72X1WMCHa1x6oIKqdPNgz2Zv3IMRrM1ZX4tg/TAJshfC6ZTkd7cQm+YJR9gQtiC8ZXrt0Q0gWK3y/Q6k9m3CcZrJNQ5MfZDaWuPqfXqMQv7oNqirqx+6eplv3iD1HROP0jmtZzVap4e0ZhtO3HLTrQpcmDNpIp2bm3J5w+5KFcLeL2IxzN0jG08zH66gy1dBNKajHLZBzkgmBTgWSwx045nqz4smuXoCworkTvAVq20qcrVXBIsFveosCSsPzbwm72sU0SK5Ut8jeqNX82n92RgHIkFHlhIMLwLqYlxRvXQzrlE315SyurUm1aD7YfiTSflOwk37FXFLswpwJdyRbWSgrueVo6pf7fdZ/dTUM+MXCKRcKISujhCP1C6PgaAX6hpro3sUcoxBu7R3zXPdro2GweRwknZk8lRPPu6SGiljydPQzepq/na9WpirMBJ0YwuWD6iRbzAFjQ58k9XGZAQmZKgPwOihArp8wOrTN0uEogdKfoEV1M4HS/eCrvZl/BNYxhU/Xx6POCW92oDTuZg7dfuifg8Vdc/IFDdpAST1SuB3LuxWm7b0FYrt+MRVoLv/ur48qM8XQYaf5VXeIJ5sIk86Vg+KFP6ORxRimCDliQwPIlD7p5F0at8nkg1QkT6piJD1RaXpUaYCxI6IqJ3qgIwFCMchovJ0/DFWMRPQc8VpRB+rmLmEO1ec9rvHKuaX/HPdxGBzrHo+5lKulgVdn9LHw3+gCvJh/1iQdAyoOnw69nMwwHgQpllhPvgqQiB3CpHNSbTPBm5QGA1X03Bna5T15ifrxqqrH3/76+V/Cc3pNkEZaryjP4Hd/Ci3qfTegjRfYiUOyb1gf0GYrXWHwZ5aOFxFnXDltB/Tm1cXFZLn4bZiE0so4UATXbgVDsq5s4RUIpdPz2aMXbtFsfOf/31TfzIQHCXGa59F+4p03fv0RZqRJSRRtXaRwb9IlmeBq6S9TDxiIvYVQKXbKiUbVm6rdMBEdu3whMbN8xaW7U6Vm92GOG6XC4/GyX+FauS3xQjf2rw1xv5hye0x2sc1bZFRmILuzcXrq8u+83Jxc/lj/+/V+evbw3ZGZvpAkUD7VUI28q5VTNBjA6tBk7aXFSwtF/yr+3rmAvhqn9UYTOURmio73TCKOMzuhNTLuh/5rXyQD3mdkHdzq7MP7j4rZ9p0Lx52xwqf1G+HHp89vlmPLo19A5AEY94DZKMSdxMKWAUbC01c2gZqia1sK7XKh26qltCA7dU2DnZvogChblM0EQzzVD98eR01TyhJLOtLJK0Y60zUqvE4KmHjjxiM9L0/Ng5pt6fAgWz8tNWHuGFdrJKiresl/s1uYtd93LydHeCLZw6DpNREZ/qzaVYyg6HnJ7lkpplKVZdY8d6zl6KC8q7BiBlNmahkbtNKJ89yynxl850IYbjTJU1OLXBkifA16oZcMaEzPGuEfnTGCY32dJ3KkA5VGw8odLXKqAFVm48WddXAkBBVnwz7dN3a2E5QLFotv1XLPhiCtjAVdhLVpgreBCMD7Df+/LuRRNruRHVXQSKkt/pVqiYAAfZG0RmFhRGrKu1Hmxi1bvRXrK4dCrBvTqqwfYHMdyuM6ON/lUrCbl5gcsjuYEC33JUPOL5KpUR78qTtpHQe2Qa9aLU2lTnfXledrwowCX1WbaXMsZVbrhzGVUwRxHglu5VJeFNP5jK/q2clA2+lVj7jmGupAWL9mI3MJ56zsdbY5h+b/p1I6XKkEXD7cqgR8SB0OshkyXe4KMsIeRACVygLLOuHL+96HRft1FqBmfBJGZsSF9jLnYZsiOVrs2scpU5DNa37BqYlXgkTqY5Sp6Hq6pf2Y/3Dl5+7KhqWYnS5tBsl0oHgbrJU0p+0O2F+5kUrnF9DPu6d3ELOkc2636MTOD+xmLHbmmvtuBK3Umc5uVqFscWNH384UcOrvJ2aSv1Yr6pmtmR3dcrpT+PbhI4y304KN3LgQGGNHT9ghKVeTVakq1cX8tPrMGX8lovncX5ozyTCq6zMFxIJ2w+hSrTvRBxTc/SmRLz2bPsTcRvN9rhnsvJudy654753UYVhBzxbspI94TKUNSYW8UkdMoDR3h8rokQDN/KpR8VtH3ombJfQm6I2Sm84zSHjYuc6rETi1nsZSGtFini0PezKJy3czV5Wa8K+dqTmCna4I94SNCA/bubk4QZETu7SgAAqoAZEKdm40AdBjgl9TvR06Cuit4Q+mB4JNAitEmjKePhAA1WgOdCMqTUy0OA1Zwo0uG0GgeZ1+9gbEBdXol9dwkieIxQ1YsyCM3OkXuWwXOY/HAXiLgSA4h2QNt4ZqBKbbd9QYtLU2VKbLJuniPeDbk7iby+rim5q2W4DTX4tP3fFZ6cdrkoB4Z1mqkrg8FEqLZ/a2T8sYEAIREoJgsh0Uy/b2cv2IjEuPhFpXKIUl6/2BBY5JKUKYhsnszjGwbGBRDwozfLA56QLqaQIL3wz7FA0zoTEexZHifoGzdiBZxbEft65kJO+i0AyauEqAoNevm3kbcXcQpothWwnFWsxtZaKP4XTlNV8Us/eNtMJOzOZpvCZjCRzLXpfMC+CcbqERtFmSFCtwqQIUwf2eRBbDdBTH1It2GY7BJp86fBq/tDKi4VBCsflwTRXw4JgiMy0UgvmHUWFIRfDF6FoKnzZKYOBFpoArdrSUv4lCheT4BoQlo+YWihYMGKsJHSA4fF34QKk6Gcf08+zxOw+Ji01ekJ7ocVzPJC5ExiarUP6HuvVZicVpDFI7FfibX8Oh4jTe3NcDXvXqwn5GAVPE0v5MQlhiPIKewwy2CQdgFi7tEUf1leD0PNT2/UG+GFYtOTCT57EJQQx2UJhiKAuDEUcRVk4ErmQkMThKGEJ18sbP/s9zA5grQXSCeSaMDmCbC3Zu+qcH0S/urhAniNk/TGmbfqIUGm6rwXSvdgk2qxG5c9GEARJ+jEc+DvuFv+CtGkv14/0KkOJhbfjx/oS+/1DN2omH8UWJU3g40xUppg/pbxGlyIV27wKJBD2JtEU5t1IKInWrtI4Za2qwATty6FZtJ04qFYuyJBKtTgD6hRCDe0F9mhjKj0dcIQasMUcgSW4nODyuWpmt/W8t6/z7pG8UCNJgl9HUA+CfYf6oSHfRqfyPYtl6A+eMtsPA2uqtfPRqXxIzVTGU7skD9eDKK928mYeZZVy0XajsHby3ljVekU+VYNi7eQdsJxNakO2P2n+7QjEbRGZ6lsvgyZ3LOSrXW6jSDUz7LP2A97ldkrg5SaDX8NDyBp2JGKNbOltWkHKrA1JfnfpKFJ5wtdkhbC2biKp1nxXJqB/SHHXVfPlENBQkFzIkYiwMBGGMa8SDvQKzIwBuPcS0ChfGZhbYdE9gXDJ2csBmdKbbwRkbCFx+GE+pl1d95l+ajtmOMOkcwsAXN5wIKAKwZm/cGMty2G/rtZAtH3m3kCzFfAhScZsyeuMEI76TKOZgr51VQCQL1o16BZuN2XVA1ebygTBlfbX57e3H97e/KjdoE+mE/1RUiLfli8lL9+rachf27wplkcaQ46AebXPwI4EdFkHKxkDF+ThzvfStzYPTT2KL8jDnU96OwAG1DftGgmTVldvb0/T0o5oY6G2TOhuE6rNHe7RLbxL245RVLNhEWXOvNlOgYQSrizabfgETNkl+FAbK3T8CRCg6w9pFe5Pp5xCvzZ9VF+moBcD6dveA3UZNW6K3ljERb90dz5LgFyZj33pYc6le36/aWMmFbnRhY+FhOhInmHWZzjyNTHYXyIzkmC7hQfVfUg9UqvQly7rRWNfXxzkU9+8aJhviHTsQJ+NduahPkuTrsiIazG2VZiunjSLYUulnt9ZmFaYoUznJqP2dH3/93qCKDumLFS1qj8jenbJCpXs6llTkn8OTUnQ05Qmc70ncuFJXMmWR03iOUzglU9bIlOWLprJaOIxZcgQBBFEmioMLNg6U5hcNZ9MQQEZ6zNQ8vwLuhSn6tdveqayONCzVUJGo6LpsJNXBHBBOl0H7J3o/PXfpTNyJ66E6NZvUy1kF36n56j3yakHe6LfRIfjc6Ue6Ul+lV2ZmeaQnuSx5F8y1VH0AE8Kzg/vrrl3bUj9Jc/tgCzyKzskTdnjOjwPNcf85vLul7c/SnNx2xSyxQatkNr+FLY8/NsL9vmBsbGF1ahH11hUflmBaVmMbcoJChu0I9/yjSnchFCzIjIAMilygnIHag/l/wNY/hBZrAfhRZbiyZmT1UXy7Ar/lA9VGdprK8JEkeKMhnmiU8SCXL3e9UwCA1ECYc9cNn8lA0LTVyeomFCv1gGLxSNibvdbPI0moyizaCco/FbjIW6gTcQO1Nz7tve7T1Dm+IUd/hUrpZ+dXxG7F2CPAVOpfE4Dszkb7oFN8W3LdQJC0a2vIM0isg8DVCqILFcVkUk3o4pk9ntQeTLD9ackE3brKahfvOyUVA/dcQpq1642pb2o8EZTU40IF5kKtVJwf6lgwdm1pVpQI1O5BDU+Z8PdpC5hRCApCSNFZNIto25hRCPDrxItcWOTdu3iUCc3LqgR4ZpQLzdWqdgZ+F1abk2PTYzPidCuBOsQPIqfCg1LxY1jSxYiMjg6FyfEVf28mPUeeTl/bOYldFkGTmA1sSaIU8XSTkhdvaxXcUzEiSLhEUDJNRxZ+iwKkKlcGks+Z/g+jhzfNgIQEIwjABON3HQLUCVNt4lMCjkAnxZrnCiZqAMACuHGiY0KPAAYF3GcqIjYA0AxQaecCRrTCUDamM6kX7gOh1EP3IgDax/Om90M9fuG2sQoQKSC7t9Fvq6Hi9hFN/YYvxV7aY/4vcz39ohUxBJdeNMp10vl0uKdVPJGZFQDfzMyNX2YFai03ywzYd1mKxR1RzOMxN3VbAUKb6YhkmdGTCVy6WSxGWO31FDsti4WD2DsYVlY5A4Wj1TSv1K4sNtiWCL1xhiDdvoebPEDCRdhW76HeJs7DwBf5y6+LWoBlS54l1wJu+F9DCZ0/w9LaNymaWHBboHn0ezXwLtVo3ClEf+t7dcamT8sfbWR8nFt1xspPhG/g1GrswRUIpf2i80Yar9Idlv7xQPYH7+AWeT2i0cqab8sXMj0AE9XPjugMEJtLM+ltbEW7fxrHIxy/TkOWHcXpjUgpHLeX0R8B4Pz7pKHMIxfiXsJQ/xS1qcwRN8Kwuy7TTOoxVkylUug5XOGIi2Nbwu1AoLpCLWJRQ61AlJJrC0io6ftADLLzJ1GBoVYgUmLsSb9TJAV1CtR1qSdD2eSD5njWUGNkAFNrRVTRFOpgvmxzS76drrZwNGyM2N5KnxO7L6XfdeRu52ZbM+OIrQpENDcdQObFy4fmrr7eXu0qSWXGjkQWnwsVFfPqlXzUm/uLo2OSQBIlPBYIOL6YICEuUO4DGHR2gECmRL16QGhQ8LMPeOf/Y4FxVniJ4KOpLbGm1JqHCFh+lOflwAoZx9PIDm+RKN5/Hgy3vslLtntx1MJN4hTONr94cUcWRyQKMgAUMQA3wqTECBXwqj69qduh9RXB/uD9LOi/vWxsTxDpezTe5Jsz5D16bB4GqR2pZDv9Ugpyi71AL8Kf6MH+VHs13lQHOHhyrf6BYFvC+8GfAtfC0inFBWhNwIKWauXATIFABtNE8Qrrc/M5THiBjuACri8DuUKLOPth18vbzSzyxOhhhdLyqbHpvUwPjlzzfz4Ykh9gFKMV5+yeA/BaFc8NsvmflZcOa+O8r5cfddjRF3tpccz5YMYsfvkfIVjmKFl+FJ8cWOk0H5no6JZvK4xUl1wU6Oi+7maV1ixjym9dKdOxuum3GmcbvVCyEh/4V2QOYOhw2+8AVLRJV3+GLsTcO+joou98jFSpN72qGjZHnD/QR7yZ6fpf1D6K6jmPg1zrWmmdJd0VH2+/dQPuBCFYdpyjduNF5uMAJ1x6nKtXf3cvsBa49QjPEMbVo2/KRGKA9KQyuF+RCIeBo34phrf1Kuq/5LVhyGH/BMQaVyadC5fqGWnwG0NPKveOEVpIGFnm1gW85STgWbXqbhdDTM6j/nbeSxULujBhjSRLJLSUho082GBt1dzdDDXBBkklNowxQqFKNzifpiiuZov1vRlOnES84b2YKij5HoGjPgTXkb15h9U6y7xKIXx8FfTKA93QZXL7U5K+jQCpTUQsCqmTebteqXazDaN4ahuNDbWsjyTB8MZKq+UWWVmtYrTZaBawGhCrajVAEpfN/OPRsU7Ebvy8KgEv0zqvESKLo+Ke2hHTOaPn8gvXmoClpk89NJ7mMcvHND64/jDH/5BZqnQ6xItI2qiZw5fB0XoUS/92suUXYwID+HdihXchCjcbrUXUe9ATCcMWL3YfIFbMSN1wF12e+EYUyh6NGMhYogTFq4FHjQBF3qGZd3A8UabTJRIVqXMk3ga8FYVcIVjYMY7PKao1AwNS4BM0LgVN1CG3GC6lw0Z2S0s+fwQi4FMD7mVOVCG3Fq6lw0Z6W7PxX4vAbfrO03g0gUiM7XcvdcWbvOmFZsWXFACdg6GZpAnYMZQcN1aluMo4Ely6KmLN/wlNJmQc91wt6azdXNVcs+gStLMbydP9XMFcgTJR1JYLjpsbbvqUa3y9YataS89qlO91DCNTKX3GYKll64yJGug5BZDmiV5p6ClHz5oS948yN0ryK3gpQPeXeOfPfcBlD1t0I561aB1eNBAJVDeMmhdnjGgKPKDZ5v+iXzqLEzieOQsy9Zw3iyitvYBOPXGXoCJRDrLRZLYz3AxJIYDXDkIdnoL0Swe3coVQ+e2EL3DqPL97jnea2KPLweQy2HLXziZdpyM8I/Cs2T49xEOknHfqOAUGeczQXA6v1+2s/Vw4Gz1dDUMzKrJcIc/7UZSYpeApSqAQpdYJvYsKNFI6DgL9jBHFjxAKqgF1cGo9nQsDd+a6jx021ry1ULjXa+e2m7YT7ZJxbWudDIfg+WzxkyVLoFtvC9BmEb9Kg3S0kg0Smtjq42OjlGC+o5v65Gbb2x4y3bdTWx8B5FTAYLtomjV5raxxKrI9lG3LFMbqX/OINRcTdXWMU/iEmKYbKHwQlAL51dg1bvESEjBCZrpr+GmEY3hkNyXop4v11192+eZt3IcSiwzmgfqAXAsWruPa+Zbe0633sYr2uOplc3v11XX/1+4kXI7vRL/aJqyufy8Gq4BJmdtot/kXIMVcTY0BEsdptiQrsddM/cMFNoA/w3QhRtRsbZ4ngnvgdnTFaklqiSAKZ6qEg6q9eXnLIMjNtMKJQJcj5dJ59MeCXljjRJTCFM3T6TQ+3kjeJh+nQgEdOxsRGBHTv5WZE9uBAczIBAhlBFBEQHZeQQoTL1HwGqiOx63N0BA0yxSYhcXVhWAdz8KZbJ0M3UcQ4ezhKoLZAroEnFHSqgrqANqHYISGr57qPPorTNIFJz7/nD5w5V6m0GeCD1WHkvKx8rZtB7HyuXMtWPlfDGMx8ohDOVYOZ9H+b0GGJd+zsHClizhfpBv4zn+7LaEm2QJL+EGpPbj3KlS84FuXbt0pDtVbz/UrevXjjenDGUHnEkO9IhzigAcctb1cUePU2Xa4WNdU7Mc9j2h1XtMPEbnsOI4ZEQfBE6VhqnHaBWOjmfuqx8e1/UlDy5L+pTnlsHyiQeAsyIWHQFGPYU9BEx7i/kYMM0RTAgRTUAwbwC2AMhJAotHktToXAehSD9PEAgJJwqyGCCoVUOAayH32vQt54HkAVE4RRCHH4FAjz6uBT6o048TBKJHSPMZH2Pocy0sdtInkJLP+vAv3BvjrWsh44ft+anIQC571T6MbMN33qTdzXdwlw5T6fBoJ1w7zGasXjxMojMA7ebYyFOzeN9356bczcM8Cyk/HivbagfBkPvtShHk64Z5CODCYTMGu9iiYMjPvFowuFsfIBbp5gcLUDD+TJNmvaA0gcsYlMwUGoVmvLZxKK3YNBJFCbhbkWkE8V7kYgYhKsk4SjgaT8buAaZ5jDuAUQrhHmSaQ7sJeRwJPbsvkFj2IqMk2r00NA50KY2FCdodTbNoe6NRrcwsCq1UmUdBdfKjYiZmmsfFttKTI2OpBkxjY8kmwwMR85nWTOVJfA5E0NliByJyansY4gDMgchIwxyLkGhMByMkGuh4AkOiHU+A9QqHADibsB8CMNYCfQhArAnbIQCZJ94V9WF/CDU/GBf+ZNppdRCktlrFP5oOyTH5ZjN9WO7mlZY4W9tqy5G64NAcpb3k4BxGIh+eo1jKDtCxNNER/na+6toZ117EP7t8biJL7PB+TMpNiW1T5WsQjNp9YiQaYwTMPiZKv7R9CdeOHk6mKkDdqoRp5Y5hEyq1Q9iQvmbJnLwnFB7TErVMbBLDCPZvjFxY7I0QOiHTLbHaCFDdJksd47me6+7RVlGphCeNdGietVfbkXk2TkSBd3h6O9iDw4dgOqFTMBYyB8MyUw5reJRAjIHSRiS+8S5z6e+8j6aTHnbXvp7yuHsJG9zYiGRAs2MjYRsgCUNtikoYmMCicxhDjG5FQbD5pVczzPVc9oEpn6qKfnUJK3mOUCyJMU371gmN+W51s66HZkZvXiXUBWmNGokPxTUGye+uH8sc+lNY9gDa4mo+rT9jioPUSMgCGVb182LWi17OH5s5bz0RSSZzAp68OySioCMVngKM37RNqGEb1MtEa1KpEqRBjcNWirtdJWJ6EwnHWhfaCaEGTM2DRBJPJQVNSDKPFPxScmBvp5q9fZ1Jiu9laBfDqCXkBnM/CyVpq+LKwaE00wlVkTBQJu+CJd5TLwLp+7gBFPp8HdeynWiAYx3agEeTigOrrUvsQ6OfH9MirieHdopsbOwTeb4PvKPPq1u9ZVz3YT3f/GH5ezKdfOIk2pTYLJ9kBVkaOPO2e6xX8RO0QbbHX02LC39ZZk3B8Ce4DRgS39SLrl7234MN0HkqPPL/fWnK82yXng5kBC53XHr37ohFdSBToD44J3V+cfH23a93v13fvH1zfXdAOB7QiROYvvj5LtoH58Hq5Xq2WiZmwKaDF5mG0l6085e6WwpNAZnKpTXgc4YGPDS+baJLQDDNcplYJpuEK1Ndn4VCHkRgCykRqQMQEwPTLgoAymCkQDvZGqoEpgZRpUqCt6ETLyTHw3kfI59aso+qZX92EOW/h7HPvKo65kiICnMQdYORGjoRRW3xjCBa06d9JL0N9B9xqVzoqKsATxx5qWD66AtESlpeYBRGJ3Nrez1HY0yJitobv1GZjUpogZxGZyU8bJvkOErTuZJWKdrYmnjT8JvpyB+UmbpB9oBlP05EKtKOTB2E9mDMWYV2shlIAO7OJ/U5vyBnj51k4EtjPNOgwNhON5ipmOGARmUaE0BU6D5q7dupfXE7DbeTXEHR9pQXctB7uiEW2+5uyJZiB+//+Ij5N53Sy72F3FHvZorCOvfko7mgZwcp0ItsTLv+GnMsRSZLZE/Cx4ceicwaeVQmPPCIVoXEHRsLH3YkED3qlFBwQUcnscYc3YbCF9j7sZKyVThP4hJkmGyLhgxEKUq3d3JYxVs8cTbh7W+uruxPf8M03BvoDIpx+IJzcFuCORBkW7B4KXixMVH7ckFz0vbmOgHLG3Y5VnzTrhOm9Oi8aH62N+clnjBG3g7rNxOgV8YldImXYuZQn4wtB7chr14u+mzzjyCjBGJIDwOgQuKSzKS06VYGPlIrX8kcr8tqh3QdpIZMDoTYU+BG7+XFwff+q4JElpCjvB+zDkgpNXW5We2gCZKlVjvXmFbG+SiVistZ9JHmzOs0GTH/rUPTbepPQPynk/mYMp81ZtJ0CYymLUDYTFyjQU1dqhXd5E0UnOkLCJoLFOinXUFlsLmExhVsVeqFlnXyTO1xq1LwK7r36WV74Ur9oVk9XXZd4ArHbLM0YubBZpt3N69/u7345fLN+SHX40ab44/wtpdf24unevLxrX7NDJvSJTrIuRcNqfmi2WbnFTRpcp4YTCNUiNcqVIrjmin4CKZ9OXOHsbCGyLgC1ZIptEBWFU5P6Z51Ipfy9CUPQ/GzkNHOY/AaTw56PsDPNmGjvGs/1nPAMpl0LuYp5Q11CLlC2KK7iGGM7UYi7q5zEcl26bmRqP68aJKTKxBUJOfDhbixyKS0gEaCx3q1kQivyoEwYsET1M1+HnYjZmWLRU/y5ZYFYIHUCZhWT137Ke6ZQ1SR3Am4+KZTjpXm9rPI+8jGC/BAUwsGkAWbr86n1aIf5P1UDe0EeRNrnALfiLW99/l2G2t3mYD5nzGydBhKimDfroUSaDu4knzIQtCdiYtZUw9bQtNq2ttI8rtL54HKE7sTJIG1dRZItcZOAkjAn4vgym46EcFTZIeTMYBdSmutR9o2ky0304d9ckwzITWuBqLvsPkH4tilLFxbBHG4O2oooLFvS4Nfbb0YTiFiSIe0WHNgsNIfvrzrs75op2DlZDKnIGoMzrNP7soxhMQ1asDHxK4M07qPym3ebSYZjoldGbr6pe9Z/PDl567CA0suNJZJaDbTTgxDhvRkChvRuAthb0vzPkxZg5ZyjGnXcibihSammwfhWfp6tvrCIn1E4xzwCcDAfi+HMX8zf+SqLfndxWKpPCFTTWFt3T5SrbHbBxKQ3Q1SP9/dyJwC1M3NR5HqbfNQPEE8lzFE2r/WX35Cv30s4Eiy3nUMLDCZjCdPMzWhBMkdKT4aED6eohboriZdBXlXs0AjOQAi9YkDIIM2oSPL6mU6suUERMdVUt6MLjnXSSS1Up3EAp1ap5DULXUKCxi4Djrb0qUddDDO8w031/Gkk52iGTd3PJkSjGvW4p7UmNbNo9MpVpGl06nXVWAa130Owyz3+vGJA8uTuJgEky1kDgS1pXfFqVbnc8oYmH49RwH06WEOpC3lOJTmFNdLtqicVrFRtekU2lVJO9C0mjmI1lVBEBpYXDvX1ki+JzU3uGaudec0aw08rllr4zkCtJmX/V4MrVzDy6Y8UaA1N798UcaGPOtshpXK3g5r1WVpiiHCcHlzf6nZ/ol59ulVOiW+3EneM4/lz180HxadKQqDs+iz+NR2/JujEk8q7ALUTi+GL02/CSvShJIeKPVz1ZCv5EoUeyHPj1P6XZwwoq4ciJD16Gzqg2ieJ84iR57EJX4z2UKBm6C2TYRyyo1zoTiH+AAGR1Pw9AVORMcmDYkPSi5MeXhSgei45EETRygNJA9Nnl/J/IHcScghJ0dhmNMXCZDNkxyDsm8S18tvZ2NjmHknm7UWyE1sck2Y9q/JPOF19NNeoFl9ue7al2Zad7+sVovdMSWuk6eI4L29xS4DYd8coussz4c2Ga2s7IJx/ryQFZF7aMgB7yk5QmlFO8qPxgqvs+elMrsX0rp0VbT8oT6LVCBb50XFMfZiCsg4z4MRJZfj24oCUultL+C7Wp/3KiBM/Q+moxxvLBn0qAEGNtIT0Mce1G9of/WhtKboZxew2rK9vwARBkd5m+dFu31gYS9y4Dye5c0TwadvByEpQie/+xwLJPKEInEKa4u+pFpjxAUJtChLopRFVp4IvYnKGgVAjfJNXA7ebio5exGSh1cLVhFtt1wv+w7am2pe0Tv7w5+dtldmWYLbKiNS6wmFXKnp+lhMez9U/lh3xIu5hPpjWj/9k10qers3Ue9R+lEckXkvF9Wn+QdDZSQCRgtIrpW7beaPs/ruqauraU1tas71E0LjGK675rki9y1Tyo+px2nd1iCo9JDYqDPoCKzai7Zv5ue9xPIvy7vwLNaxI5AnEuNIkP2sWa7i73LMiVAkJRdVhjMQjPEEw9g4Bdyp2VY3F2ijX13ibJ4jFGZjTCXOwIU5yySQYMOxIJ0IgkHpQkDa+A4EVWhz98FQYrLzwJba1HVgKQI/+amZDzN5ww07lJMEP+MzcA9bISjDsyAx/T1DQvsBUlafdmI0FDww0iEhSMoNdfIkLsGByRaKEAS1/D0jG9EIYhlsACQSIcGCg1EiBq6XDxvslzDHDmstkAFErglTFJHtJHcD3vp9jX7MfdRH1NIPPfr7lhp34X3OoFbJmMbbkHRa8PLzqqu4g3yHH71OBsYZFtlQxGw2I4LBbEkIAWNMuXqjPeG6SZPi9JusimWIX9n8r6p7XL5dbAYXB5Dtw5rhT/AIYCN0XXX9/1F76uKfXQyWyBJq4hNSyxo+pVLcYITpapPPIKk7pjVqDPu3vY2knz7oHR5/xXu362V43ILP7GyfkBuXH8DYkx1dM1lFk0CCtih1qcpZW01/6trny/kLojNOXqq0nr+8r7rrrn5oPiNak/QWtakXi+1OlsLPl/EWKDN4JuhFNfplSHjePaaWrzDkYli/3cT1UgD14kmENI8MizKOgLVu91X/V1/VL7B9RCLIrAtOw3ZSOBZzT8X4Pcgug/hNTP0G0V7DdyU2M4TDExRVM6+74RXAW+a0HZ/UJWgo2Rf1X4XScefX69VNvT23cDnvm5s6d2INlMwC82mIF1lE0hiBZVvxngk7KHOCRAMdeyGGHXSyT1tioQfJU+KmBltioSd0oafK7jNbmVMRLQvqaHnSOprWs5p4T0qDOoidiqsujHk1H+i8vmHf+s2+/HyMrfYvSuTw1dz0Y/3lrt3uXnpoCmJLLv/V0JuD1ruWujxXQ8/lT4oeDIzff/+meex275+qR/D41PjAuY8a60XagcJ1nCXydB9cKBaD9bJ9YCb8egaoSNoLKTjiU1hXWQ5eaJPNJVoXXb0x3Gq2HAEp5OWHW1fzg9WUmPZZnoUX3Lz+dD76S1OZOALejnTaPAsvuOXHZtHHu4eme47vdLeElDyPMXjhi1SkQNY+0MlcxoxC1tiLVHQJbGMtCcK0cc9Gw9oGwiUahRch0eogbExz41ZvlLdDdcb5uBcZ0yQibEJb6EWntoqQUyLNoR8x3TBioHyL6MXHt40IodwoOjKSzSNIyLaLI/igF/EELO1FPJP+Zrn7CCaEUAqbGbRRbWfSS8hSyZPQ8W8pSmTmGfkSS6LfNlStyfa2oeqBQSerbwb55bvwR5cOVZYh1I2KGJlA8pHoBeTaPsKNPqJzWj9U69nqfTVb5x81V54kH0GBhKhcvxKYEF28axFf1uxQeGlJN+JKbHIe7ruHV7v02ayuq9UT7zh5Ehf3YbLFrnbJqQ2uxGnGHQrXv/OTIS3MEcuM5oGux2BQtOsxYL3C9RicHdivxzDWAn09hlgTtusxRCsJnPCHalm/62a8C6YJXByQzBRyv4xXMf6WuHmT1h5LIKYvsCCGT2MoZo/q5I2eqXuzydtKTxq8VAMmc5esItxF8dR/3CF73tzzJD67Juhsy3ZL5KUwGwHLYzYDnIZxAw7FuAvYykEapMxiMkmRJ9pw3j7fN/N6ehAY1j1nL9ShSy6lz1Z0MXfsQDVbFCZKd7vfiSO9Mk0oWM4CbU+XQZRwbaYQtukr38e+Z7+shuhN9Egt2XbUI7ZExXbWfU7jNkZ3gUJGuZG4GcdYt8HdxZFCjumjTRI1xfPFIu/bLxY+Q9ddPthYtQdhIm8jXai61xEngkaDvMYH9kzeQV+YZKQ25Tz5sRr5U+S8pnjH06oixhgHBfufC/JteTM62/0K5RredL1Y3Kzn87q7mi/WR+rwWt8oBb6lZjiAUXfXXbuou1W4N03O+4yQYwsVovPbQh+aR1T5IfUYlS9V1wxHUn/of2rmzL3hhHJCbgzGch+dUP2hwBjFVXh2QNFZpYcGMHVxcN0monxj+4tXoA1yQ8PtDs22MyFRZdqMQOmM32VY51sOEoXbJHiZiDUstfr2qQq19IgXs+b2y3wCFOaYcpQ2TNPYmgMUhQkLdT0Os4GTj30bd1uvVlGUYpSSEuNKerg6R2iViXITYmNrnB0jcDUfCLh4Zb2dFLjNYjYDQqT3iQ7bcsEcRHoXjt16Nt1xzr/INqFnDVx2nd4IJGlL9RPz7+/70Qa54Tz53XP2PcrTMvl+gGWaufttMkzvMbFhyl0j2L0qR21pIyGi9P4cJghfAqbLQQKYOh68fsPaR6wfW/rQNKorH4ndly58YCWX1j2o0pcse1A2EN9owk8pH3/zmURO8kOfN9cmiifKrSyJ0jh1sdalPiWfqqZETPqjlYFhdHrdTqVt21Qip/UAJmNwKYBgt8UoHsB4m7GFZQjCNXefMU+UiCEB1EK1nafgNneKXyqS8+bq2vUwNLCDZYIOZNhqDkekLuTguqU1HPZLFSzfWGuDWbmRa8S4aCMzhbfh7M8HAkf+uLT47GTaJUUzJ7unSYnpYjAgi3A3FkyxSPdjjUHYxCo7w17MB+Kx7tNy7/zJIKGoX40kwwVTtRBDBwecYpZRIHH/I0tOxY8skVf/g84Y7X/k7Ob+BwNg73/ALLFz6ii5V4rtJ8xxuCSDeMpX/DKBlDdTHjN0IjpY+PAIswzyBzNNNRQQ2XF8WMAeGIOi98Bg3WIPjLPdkh6YsTa4HphYI9YemMgUvoy3T8HduB0lwPtax10DWKZnkQD98WPWo2L07m1Rq3b/diwc0NLNZpScfRKOSOTSbLIZY4/AUezadyZv4+Y5UjmsEVXIoHfBWCTtQTCDbuElMP7L2J8AM9cG/faXUiO2R78U26FcRPIMb4cYszVvVJvj0NSUt7dIM+uiWTYwD7tizen1pj8uGVWWwsW06FyhQJsji4MTbkaSIUiFkL6dRIQYGoOihFZYK+9e3FcwO5mxBkiDF2vBZPaihQTG/6adrmf1++1tHOw6MpnKxQn4nCFHoPHtIy4BwzzkKmEqAHKiQZxTgFEc1KSdd1LJSsyOWlAjpLOqtWJyWJUqfBOsrqf1NH/EnJsBl9LjI7Pg+hlylKRqOUtyoE1GLBw7L75cfmq76Qi2NAtHuHZ6Mew7omerAbJQ3g9ru7r3UzOrr5lVBR0ty2McXngghxHJvJBL6HM8R8ocaqDYcthmk2UQ44yylYl0fIyM9Xi+wbLS0b6P4fFO78iXuz8IR/u9HxkTAWDj51x/FCF0PEwkU7okVgbhuJxcQfZTc0W1Qx9bA2rIdnoNsK0ofHcv8pg6S+EUsKlcwUidIltDNKnaHJtBiuUmITeyZ2BSIcxnQaIFdVsGA7LA78nAa6SdfKzpC2u46gglfFk2CW2fxYEBC54kgxo1Qa3Zm6mKXvXZVFizFKjpqFAQoU11z4Rmof6NMVmwxnCCs/qfL6/licA0hc8EJ5krNsGZIXPngk0lOnuwTWoKFN99/923f4InWmkafqIVpsiPwbymmyfuY8QyBQTBvESf5k29qqbVqqLGk8HPhvXg7Ol6IUfg6fqQkWvIGvIUbKZsm86iJn7Y/XkxS79W9Kz78XfLQWry+HKW2dk2IRNyQzT7cjmpTFsmj4QGONbEmPpyqim0joprh66X332vaErqJH54MDp+xuiqs3Nn7sXZqNgX6DutQFsgpkifqo68CD9Ut0tzwgINGvbl+VYt0IaH3e7w0GradmlOWJ5Bw748f9KKs8FhitP3O+7bparvmOyEhdopOXynP2gF21MxZZvW92s1NOwTnbBcGxVa2NwJbHG4wUgzm3HN50HbPtEJC7RRsf9M/64VaQvEn3tl+jnHn9xOu4ZlQA+6ZhUW9dTCtofTJDU+uobHejX0P1Qtx3RIh1jXW5MnoVOtcluka4laB06J2DzoOqKIzekQQ7auIw2jnBotjuqa4qDG6ZGjmq4ljjScFjnUkFpC5//QVYtFM39kAkD8s0sQILKEAkFCaptPpJQSk4mQPjX4MMpGaqKDAaUrDwjSxAemnQwSlPIsUIzXTQYPSncWQMbr5oIKpZ4KLOMJ6GBD6c8DznjtdBCitOeBqEx7Nj5N54GyDhEyzRav1VFzO2K24NQOM61j69+xerHu6148Ij6y/PEYpV+//fm315fvL1/fHmD2F6H1LIcfxXr97g//8W/f/vm78JO9rl/q4/HOgXhTss2fxby+D88XrXalCWLew3o+2bz4/vvwZzTLZb36edbeVzPaqo6Z0wlRNV3dy18N33Suq+ITy8YcPinXNlOm8T7+5NJwJ9kVbd4OaA0NaqpZakx1DXRDmuqwNaK6VrIBTZWaGk9dJ9lwpjpNjaauk2swU7XWxlLXTDeUqV5bI6lrpRvIVKutcSS10k7PLZJkKZxDgHkRKke29eAZ1bbnIgUGfPGHqwSkhyDWQjgsa/oabefcqCz81WdQluWIjckiTOOQLFdp+picbn14Rio2lxEZnOWajGMzRDc9NMtV20ZmiGZ6YJZrto3LEM3ssCxXbh6VIfqZQVmu3TgmQ3QzQ7Jct3FExvkyF5a4podK5B+kzA0Qyc6FrGgIo+vfpzfHLa0d2l6JfqX6WVwbkZQ7k9Q2ClBI82jnuOuq+XLYAJffoquxRKJELREbCjUbym8T5Q6dxz+7ra4kWRaN0RJy24Y4CgK7TLL4MDdZ7tKrJMsPcPMlL7lIUj60fdO2q/1ucc7CiDQuZsblCwVhCpzbjNYne1MtFoainUUySOCTeRCDZ1kUqzdo5k2f/xZm+zfXBOkESm2YPEGxlXA4vJu15Fwh+d1nKEzkWTYllsCbjYAmsb/9jHFwz4dTEMb7DUwE9LPTPIXtvWmW5PtwM+X7atZM92kPMMfp3SSFaHfBvPzd5Zvr1+d3l4ccj7Py+59+9601s9/en99cnf/wWsr1kAaffd7lMTxMIDje9mdXvwuyxOafYlJuK1b6MSW1QWJo9gkkmBFPb9PqZ/Cr25juth8rd80UUx8kHkVgiS6hfqV9xfTpUTWys+KgipRajGh5yYsCWv79kyHL8YmPvyy5AT6Tzm0Qw+UN7xejCsGZ/GITqm0cRyHE8nWiyBju181syj3LImIlkidg213hSA9+WK5AqvSbRXv91/cP7Wxad8Od7etuUi9/3t8syd7ZIIvgOwfSEzJGHeSRmbAmtLIxWKv6eTHra/hy/tjM6WMECF2WzWkgP6/q+XAxx3jOICdX1OfdaZPb1WC3j+Xfm8jIFZS9QBqik++RNiAljUguQAaMPJlbE8JkDbcgRAlsq1sShPEUs42HO8MnAdkO8tl4mNCEYAnhyJ0ui0kmQDIOeTGywQhBFAOQFyF9U7aEZbkrW2XBuygcDtRDwRl6N+6TLX/aRE8TSCrpXz+r9m5nta+b+UebuaeiJ/h6XbteDLnTPXL2+4Vip7OpvUSRbQXCpyPMTgxbCANhf8K9ZTfMCo7mEQ08z6JzRW+f8OPd6LEH23CXuiyf7KeVD5rkARO65VjVr206pjI4sJPzptV0uvsq9fTwnYjZUzKdvBk5vFJ92jNt7v3LO6HhbeR5Mp8Py2Wsf1iK3P5hVf360WIqC+LTxqent4+9XbfkqX8WKhL7X6mWI4F6Bz2RRcBPm2P/i2iH4e8+BpjlqFteBGmvW16jVqWRJGFiYU1mjXBAsP8Nr8Hm8DHV/M6itMyq7h6OUdfVi2HP/3xVrZgJkFhllh5WS1UZMR4nNIPDcdgQizvdYiOOGqWmXTNNQp6KgeF1bcPHmmy78PwECJnKZf6Dzxm7uo3EZ+1ZnekRcEhppItnYtyP0pnhmMCXSXqwYaNVgUr1G7V2QmNd30/b56qZS/2lA5SQ2Md0NQWYBUtlYoxkeFzwuqK2EepMoSxkIRifGOEK6NRLg6SsjmXk5oAmT/WzB9+rQ05jMPeF5eMWcb2inXWXjy8pGCFUWj1QYIYYn3TIO/g4EdDNR503jmHcQgXFyKX1imBi/mgAYws0oiHW0MqbYzvvci9CBlyZM5L144PdTqZDvA6prcjAHx6az1gLzaR0Mm4pd9C0uaIIDbMVZCeDmYbOgxqGyASYhZFEjMQiCxSGge8UmOh+ZWBKTnTsuchULqbJ5wyZJY1vW/IVEIwrviaa5L17mCmRQ5zFxPWibMoW0HJRd7rtjfvHR+8t1hQJnohsL3JN3cCt4iXS7ozpG+4AGPV6ezkNFpIFHDUcqwTB/NohLTbRJiT3mXHTFBhK7zIHB/NoQ1QpI2XauP+Mw+bXZk7vEAx+xr9B1DcRMss7JMnk94GMUfSpvr8iF1QyTfuUxar2c16QtiBxscLNP4iyXcJiRXU/qpxBmvYpi1W1zXRytVyu6VWFTF+U3KQ06IFdbCJ/n47bO5wmcOl3kZlCXa6M19bbohUbO1oow0Lq1NIkiQjS6KE0XbseDIHrvNA8mZArkT77wFCVTjmgZPTWNBrGsilN0E+cUqfGaIznBOntfhOEg8PWCSEiEGlcggKXLxQXKHBbaGDVG6ODgYQ2MxbEYmkGCsANWaRiT5T5QGfgLUb1B0V/3AVMPSFulREfIC6SZDa72ItClsCw+4JWB2y+2AseEekaPF+vntqu+Z++IflltVrsxufcqRs+tamGN3NQ1Wx5uZ21osdUiq4zJh+6RoRicnu022k9DjDLwQttUXfPzXLYnX5TV1Pa9jU4Ig8vvGonUQYWSXshtYshoPSFTaeuDGBEHmPwgoadFsgiKp3MpXkXsoZaeKYEtkZegjDdI2ejEeMRVEFaIPIiZUISwijEIi86NiohfGI48iIkAhPCxkQkLyo2NiFsYlAaQYgc4Ze4lKP8Nv3VdHhZtV4u3wxWfNdeklczip+QycG/rvjrB8QQYr6GoOQLktcR6F/RdC2BzhV0PodzHbfhm6tvk7P7QfPMpcU7nk89jz3rs70YbclsERiIjzV5GkVG2Ar5AEzq4BlamGAn5YOwePhsJ9gKOQH0mSyeOmauX+EIZctxkvPVt+JzxVkKt1PVea7wgeoY2X6WmlBdcIwaotguoa7p+RO+GkIZpKWAeaQrSggU++UkHAUxd3NLP8XM1UosY7cOliAN/QaQt271E7rlrunaJr2QLIhN6eKmcu6Qu/JFsbmtgmJ0X4Qqv5KbuaZWQYtF/fjiDgbTgVfYnkxddzPV8qn9dLuqJh/v+sFf3v9T4DJpL0ZkhAFV3CirJ8LRZmzwph8rUCtxmjNSOZykxvhxhoZoHmoUfk1ytAF9UdOAA6ILxhzBqORqvliTfeE0DT7G6Op/rMODCFqmZ0cBxohTXH6haNG3BGSHltN8kLCrDttJYcrSe54SnpwULWbMKN5h6F4+44JMs7hopn3XYXqAJoiuYB2S3CRuFF7AGvwuXx2QvGNG5bt9ymxcjonfhVlufxLzzIq+TDrkadF3v8O3Jgwy9OgyiRD4AJNYME2g1ayxgUTObl9EBfRry6l5FhE9Xe9vDzOzQIPDJsa/w2Em2J7/WShLVwFfGntDqMBQLaIUUgrQ+KZSZSPazNFwQWNKpc8CMZXIpXllMy5qZ8mymBtcgcnc8lqImCaYxzG2xXYWslHWeEyts8YU7rypuiW2Z4ROae5SD9kw23x4BWepMLNfhi4Mt+t4GN4JGwkknkTWA2cfkz4Mn7OgghJpDyRku4UEBW+10LGC2JonzrwpT+ISV5lsobk7gto2accpN22pwClod9VgeD/1YCI9VkNiXdWnlkin1auJ9VYPKnUrAsdVuA1BJENaY45HmRm06k2HjZj6G74jS843W6nobRAyk7DxYRQR339jY5+592atH7K/JFePqbck+1V42F9fQjrR2pF10UgqrsfctN+k9Oi1BcOigicHaZSO0+HwPPiHanI+m7WfgB48k9R/y7ekyLbfmytd8WZvEQ3c6W2EQrZ5i1jwHm8jGNK9F8Hg/j0AFr5lm6fOXI1I4xJpuXyxh2wJcFsnn1Vve4Ab54B2TfOVUr5l2sCo7Jdm6Yo2Sxu41J3SLFnhNmkDmzoEYNkKxwAyG9KSs0TKKMCguZpO96nZ+9hZDFrYuW74PhfvhOZOl/lbkb0d5XuZujsKUdjfqe9v28nHeqWtxZAJ8b7Op724Le+zUI6xV7IEDMZ68dj1ESIduWIsmXAhUNg2J2lzq0gS+LTKVKZFo5+M3+6HNIvdCUESLlqSGMZRj42BjgIChy0E8CykAQKjcSGtr1mO2dQpFcjYedRwjBs7C8i4rZMqmm3zJEZmcqPCzYkFJEBo8ZtfKa4p2dkdZzpAKwsXgNrp7rKU1+1k01VlH+Dik/osCMnZYwtDfGkYJ3tk75DQeB6NN0hAbMmNb6udxPGGygJMMpMx9ReYz/B6PWo/QloXA9LyhyxIKhC3btWL2GF2UojlYEx201EZTbYD1lz2hMRO5sd6OemaewKTTuazFsBnbXhFIisBYyj9MOOZuAhaYNhLIFaiskArAAKM0nrb9O/vMbzrmsWsttVKLutfP8J6jWQz9jWbgq9Gr5eoX862ZqJaduTIqgufxHktbisXdrxReJnDSPcFHdePgTFGNzO0G+BCmqplU/qbZJY72KRwReHOsq2oS9kUEsvVbGaiBXWbswK0wO9wNvNMsbiUQ4WCXmQlAYWwJDKyjGJBQkoOonYKjBRQx1VhUrut0kRNYb3pYZCru/J4yNEFM/za2CyY+y4ZmiVDaeHTgYpsQw59uIGeiDEzqc9MMRmS5aMbtfPJ4pfNiibXlqUJXJowMlPswrOUlxsGVV1fC8KdXSRBLoVEZJRpyU1a0DBBck+KzSI7iLBP66m/Wq365m69giEigZEk0PVaJIV2sRaoU7imivYJ+wVVptLTV1MJNWC7lEqwiei+9W7JxZ/gN5fQk+YHXrB+BOT25RjKcBYnRmyaJoDeNZS060+SH5NOSATEozICxZnowoJ+lBfX7EKAfsF7mNKaHIcxuPD0v9hq+zfZhe011CQ8bRLl7QEVhA5JEa8Z0wzY24CRDYBL9B8b+n3iPhL0t5N/531uq8v5irh8LU3gOBmfZGqYhg942RNGsz7hC/moE609lhin/aGZ0Q9d0aqD5Ha99MfkJ8XSJN4ftGAaLKPmOs3VYhG9d6SpDwTwdQOEZJjDelOtJk94FZ/FMr489edF07FrKznLMb0vB7PFhsMwbc8WKahnGQq+ESXpy9aPbH8CokM6y/UTFSJc6kpZ/SLqCJiQRLWLa5O5amhdEvwKF1X/fX9h+jzCl0jkfL+GuurH1UnBih/nz9SuwfPpS92tGupMM5HGd5dgkq9td2AAzs0HbdJR/QSWIBRBvr9MY9pvl6Kg++x0zcD+uuxLlO+rQ2tC3k9H10bZPjraUqJJ2r572Ky+/NoOc7nbyV7+XSIxtdP0raYBnMuVimVaiQSILKuRRWT1XfXIz6KrfLG4JyU8Aal/VbUBLmJiJ2JVIHVWtpiGmRgFiYyzpKC1hSFhOr2pn9uXGowJYnKfoKCrwKKCXDJbWACYTHGhiE0MDABhQWRAOdHQgHxbPTYUUXHBAUDSosMIHjo8wEy2+ABbXRAgfqxn9QqMDkJal9Cg5V+0n04qoNnAdULVugt4GNNWYRS7LiYhjRqkMVk0RhiaM2bIpzNhZ+N1MluzwboxMaZrM1pnGtJ8fQ3XYrLDXAcYgPmkbnPkY7tlQmnY6Y3hEVwzzEEMnd+yUe0f572t8/M0Glos68aHzkuOaBLsHPLsrL2p1GYF3dorrKbMs5am1uqinW+mdOaPodRtn3M1I59B1ASctr4ASsD9MEr5bCEBAzMFhlLCyVau9BOdhfLOnPD+F4hT7c+WkrF7gBAsdWPQGCZmtw7OZdzCg1tgEDr+smznr6dg2JASu4QMVUFR71cso82sdEDFpEpYeOcD6svcOpbXFmnwaI2ZjB1lDE4N0InZ24GE5PjpgXmQSYmSsyQD2qSkknHNTl/n83pWxHSUHYXDDLaF6HPCuOMdcbz829ezXSKgMfZ586iDbofoonJFj/l8qO+f2vbjd3/47o8XiVuFb/rkyUTLTa40G0R3YkMOlOPmqfBAxR0hYvI8EzdxE7hc/7yeT+9ai+KDxFjVzdSidpMaXmYHEVbtopmYan0n4A2yXG1HCfhX2AmcAKRbnXO32HEoOxFvmN7SbCh7AW+Qzvh1utN8nGoyqRemCjlIuNdIPambl/qnrn02VUwk5m68/fenD4dKwYweuY9E6bNbXT43po8VyHjgxHvrkoR31LkhOpnXDjsua3STHVUC29ZgCcJ+8Z6BZxOtuQ0BElUiCG4ANJB9qu+vpiakvYQLS9S9bObNKu2/IUSxXKH9RCSrdju8NWEEQh4Mk/Z5MayZltRILuvhVeRZQ7FG0j5q6lH/YotuEhx5O4gEx18N4g+3fKomti+4l/h6eH9bV9N8c7rKuBf7KqAPdbVaU2dPJMxA6FSQ6X7/4CINE2omWtoPUPhuyz54KvlVqvOlH/tP+3bldn1fVqlMBl8F/h9DTd21JTE8E/0qwPX2Jow35JUREm4i6GS4RCd26CFTq3Xxz56d1jBLS2d1T1rUSY2UlnVOFf3NcrkG9R+SGjp9inax4xkpL+hwKrr//ukjvzOHQkgE/Eg2ZyMrKaRFHFHyURT4cZzcA9SFZEwrf/woU6mfPIL1cYd8GJ3W8z3MN8/D2AfJ/jc/eoawY4aWALZl5EYD627Ff75A4SGhwWBTzQbDCTRjZiPqUl0jrNmSI2pgaSWzzUpcYrTZt6aOZg4ttND+Zol8D2emGdtOZ4bs5haZASh9rQFg2Z77fFMtDDihDOhsEo/psGgGg54WBXQDx0Vz2yg/LwrXhnxglKmRshOjDBP16tKQdDdlqL+8lCbGFyyFDQxy7ur2Bb4kfF8SeAiKhjE8BiXhcNFSmPTNEvlHS+h+FNj+im93EJjGeWnZjQ88jnH3hJ1Fjxhj71tQmFhDfd0sV8MQR6bbp/I31Shne8t+wB/RtMcIY9p2jWa5vavVgnMUMbfsGs0TEqNimqOIO819tSRv0hJojiIeNCVBLbFeZISMMyBhjPo8ntr1wEURlEcuykq40DXcfKyZ7zaNf9gK8rUHrR34iJAVqh8TsGQSKFyFKCOClUKCjYoiljGDoozG7JghisUtZc2TWbusLzcXq023MuRsPWOnpLBz3YCBM+Ia1xlEvpUexvLvVR7EMqJg1+r+taGDQNjmHXetUsnEKPZ9uCTeLY+C6fu0Rx1kOnkgSIVi0Sv7H32D7z7DccOagZk1GMGlDtq3qVy10nejkqr3Sf30PxKHZHPVj/Rx2GKtS0jr0llrNSUn4BOt21R+WqebmxAAxYeE3rpRA4tT+1FMZnUFefYuneMXX0JB6myfzk9zn7Jr6CX1RPcxpa/2L7diJyHSv0/rR/Cx/oIo3yVztPh+HNH0Dd1fMf1Jcj+Ol2q2hj7/IaGzbvDrh2n9CB7a7rKakPvzEv3HlOO0f//dt38Khg3N/yARd5fMr9z/3QttNg38X0D7b/vEv41liIZM/71qb/uIMn+8qx4hjCD9aJL0mNaxb6wc1MoSWo5qbYX1w1pZOpfjWnSu6oGtHLr46AVDwB2+KAVhD3Ax+m1HuGAM6RAX9y2sx7hgGOkgFwNjPsplgREOc/E41uNcMJB0oIvBMR/pwv3I/KWsx7pgFPFgFwNjP9qF2410KJQzm/xYqCcOe6xLwLEd7IJxZvLRLgZoVnC4S0SipmCAA15kQt+pmTGHvOhyFM6QOx300pgsh5gEMPAYk6mGuCM7AsboQzsmQO7YjgA4+uCOCZA9uiMQjj+8Y0dkT3NonOMPc5hgpSM8AqrLIR6TI+vHeATc8oM8Vkb5KI+M6HSYx4SMHucRyN0P9JgKoB/pEdAdD/WYoKUDrVJbQB1p9eTSjhsJbKUHjkx8wCFcsc/DH8MdTfkf//btn48ds/2LAunu7KE1P75igGzL/uMx0x+qZc1l/FJ1TXU/6zMnUsH9yeQBUz3TM+X5UgqZLNuPlz+dv3t999uvb++ufrq6OL+7evvrbz9dnt+9u7m8JYDE9GiF7jO5fffD7cXN1fUmk9tfzi9eCxrzxPICsPRCLJy7Vs9CSZiG///0I4BV77TFLK9+O+Zghdq/esuxjaqkV6VVpVBt3ybvW7m/9w3C8u1DOSCRkzPrZk/JtJzwIO/M1Teni7pbfSknC3JwYAtG7UOo2gV4crCe/O4yRqfy1HZQkMPiFN4y/iQh1GFngXZycElqV8eUBdrpkSOpXh8wluqnRwY8hD4aKCBhx3wkBzTUwygsAzqSRRjHFRBIc0OkemRKCC+9MFTkCg+OEAt4oHEgiWUe/hXQKYM8ksswtisgYkdwdDTV7iICtYrjM1IzOywr0K6NvpjWDLv7SIhdSSN9K93elSZwa6azTKEp9IzXNnVOKzZOmaMM3LkTGsJ25ARl4La20wy2fe0CA7KNXKqGku8Pbs9mbM+8N9tWenJjtlQDpl3ZEkuwdeSiDx3DMCS8fXgncd4FT8EHC36KCL6h5DG7kMSo5eyRvKEkrAatfOz6a3YhuJUtysIVrk7mpaxkR3lfLOIFSDMa8wpkIV70Wg0rlTmhkNalrdPyB5+n4QsEOxxMRHsa3xAU0BE+B+MxzubKl7odDEf5my+Z8PaqTmd+eBUjhF/y0XwBeMTHzMP0P1QYpStSTMK82gPRGB/sgawrCJx/rb+8H3ZI7wYOt0zvkU7mEi6FrKFIyZTANkyQIIyDBRsP112XgGyddmv9TD6a62cn4kKjHt6SUNJjXKM0n8/yAbqifCvioZ86yiUpTw91lWteL6YVcZxLUn4Q8dDPHCeT9BMHy8bq52ZodAxxumykPzTLEq5Q6iQ++rqPAL2Q1VuOYj5xLGjWtrctNPPH/dI514HiEro0bWLmUOPGlsPWvMkgxgbOysQ1cTKUrZGzMnEzdTKTbcYOYIqnpsMt2BhQzey/dqBh+tBIBcHdVSsTP85QPM0811dWW2Q/H6kxUycfYWMeKUxbD+aNvl0yfK6PPjjFZZmemwoLR9EaT6yxasVNLRbF3PksXnN2PKtQNXsai1WdH8YqV82dvZKUZ0evCtWzJ61Y5flBq0LV3LkqVnN2rKpQMX+KilVNHKIqLbV8KpMvPHAo02J27NEt3urkB/2Myun5blG5ML1tUD4TjmWx6mfUqSwcQGk40ukhmQiZJUpmsNHCwqN+oRDgDlMbyG6H3O/+VED0aigIXzXhfIQNSpqW+NoV1LPs6+j7wjoaisNFzCnaE4FnT75qBfUgr5SNykIWQzGYiklmdQxIyuTOV62eLcvefv69pI52xWGqKZl8MqApc1BftZq2LPtq+q6kmnbFoVuGcKPabd29NBMSk0iGtwXZ7nog4zN1Qz1FbhrTsKqFMY1B6STYv2XRHsuNxtjtWDUhHGVK1CsdD65CmKSmLge1hxZUgW6n5Urk4vocTVFXZJNZUirOQYjNvygpsg/4K1VagFLUMdnkFJaHnTVI9ruigOrW169UUXuOouZ3k82hJNwYn9qci+JB+3S/UlWFLEXN8CarqERcg8HsKEZJ0c3FX6niEpyCvvAmr7RU9CJRKL2Nd/fEkgCZymV5iM8ZWhui8Vk7mb/UHbXBSaY4CCFrDCaiZdAfyLfiC1SpoAcZsvQhICkbh0za+UUO6UuZVzgKaoRc3lBrxbS2oVIx3cTdyWj2eSAuLd5R7OpFVy97yvhxQ1THWSavm0pUKHnAYOfR3ixCQJhYyj2oRqRxj6PQc2qoBRa/4sUTjfLTshfNWBjjaq2ZRI0XYx8TU4iYWKE9JcalxWMFtECYv9yFrxIib4iBkcH+mpkVpNotU9tJAkkflOd6VU2rVWVHCSTLUZh4ye1NOtUBBfPBBNQHi7dvGLeHO/EA8XLM7hafbeKe28MVIiZe7ibu7vkzY3xqPGYqM5+KCmgCVCgUPGqyIJGjp5FAXT3tZZtqtrzczg7Q5+tUNjofL8xF3T03y2Wf/qaugBV0CpHIwwuvWq+e2o47/6eBRdJeSOkmSQMPtVNyHMxz9fnHdfKKuwEoFh8DxTSYRwExXB6TuTebSdbm+ZqgBLadvBKEcR+vjYeKz1DNMIEZm6sBuKCJLeJ7Fc9sAUxSlIbwtPDsRcoGaoRSjNBehESsRtiYIO1Fxe1pl5BsO9ptPFTERpi4UD2Cy9rFTpEMc6m6/oMZlBnPSeoEGwZlIWHUSAj9UuoQhP5axaMQ2rKZZv/dfIk1/GFC96Y/y9zc+EflKG/+c5ARHQCECQl6OVR52GOYrAEmRzKEGIQBc2jCbka5NF47qlNzNVTs1pw1BY4t3kHlfv8UfveUVMRx9xB53EE04vYl6OYlH92kwbnce8TdgBUY1jDSgO6B4RK6GJyYOdRisOVAjkNhGPwVpVlcttIs23U3sfIchJyIQMdUvpV6Q4mVhHFQGUNps8oYSEdFOExOi7AFc8/D3WY37bofnCtXlZEJ8Rnn+148fKMayvnsKEV/CJoePIaMIVDHkIsRqtms/VRP39T9kGdqrOazTNgP6LpaPf3a/6UQKRQvhEouzYzSZk6TpXBpRehci++3josgu8Xrev7IXDZNEKVCzkzccX2GRjynP4aDcRYFR/ASLyo70SlpIge8qR8vPxurKhMez0j3BeJNIJrbpVLOVEy/QDRyPLzZ+0VaNcAdAGMNsFensrVgvjuVteToTsnNGkEzf3y7qLdzpL+sVgv+Kj4puUtzAKgAL5cUS2ZeaQG5TCsuZYztIW35VzojMnElhu9OBGoVuD6xhIoJRQiSEpfG8DD3KKJMxqsUUfsLQsYhqdxZpJO5hAghayg0MCUwG6/IoRqtSmHosUokeLdVfLzOhst1ZiVQpEfriKj0cyVSQ2fXF7gQ9uuDAr1joIINXeRx+JaOM+T1eu/ZEZhpyHRfgxuKEh6yIdOZTA2YbpdBw3VTT5uur/u+uZP6uHQyl4ZLyBpquJgS2JZXJQhpcTXrC9poul3qPHhJQKGUP1M6O4oQUXOjXjzbF//47VQSVy57im+4XPRmWn8YHNGGl4n60w23wK2XF+00DzsSWSTmQgV2H8VooHYfbRRMEyEhKGMcm/6H/k97CRNFIuj/fYTGSq8dU2OlcwULRNDi0IiFIS7UqLmLgSYqLroYIqxRGdanxJp3WKsyrFO5oOhrVvb1Kk8wce2qZN2qGC7s4olTEv4zEYUTENAoSu0M5LoL+wDjZkGKJj8c5jxON9UxaobjFBMbHvMZJ5zGGDt7caJJC8e5itNPUXjMTJxwQmLMPMT46Yexsw4+kw0sRdBtO1+1z83kx2pVnU/6hnBJ96zyVIYzpFkg1jMuWM4kCnIEQq9BUnG0u4+IDI5FYSpouNiNOf7O8RxF/gkqZwej39NGZLAvCF81b4TbAQSiN9TVAP+bVbQH0i9qo6vpUCC+qi6emtm0z8RIFoj9c1TVHki/K5GuqkOBmKr6NJTox3ayfh5yMbClgv8E1RUh7SvsW/5aOyKfuFRSnV2081XVzOnxpkgYSv6z1NqB6VBtfzBX27FcUr2VxLBU8J+l1tI49q3JO+NSMXW2veb4pk62qwOEmeQ/Qa3FTPrFk0Q+SbHoqYSt3E/NrCZ7c/uuJZ3MZXJByBqaZWBKwE031M+LIe0woDGhJILIjINKFnXs6fYFQeMbmPJ6YlbVJAzgyKI4+LIBdju7flMtFkbQTPRUwODUkugBhUMalCodRiBMZeMIA1HW8oFUhQ2fgSzrLINkhb1lU+zI+1lw8CjtaJn4ir7qmA4NSsf0HBC8UV0Hg90NhyXzGUXF6PZCXyW8RR9qECr/zDvpr4L90mfw8OXyc7McFiwvP6/q+ZK6eUOC5/P4ejX/Y3Gt//gVajyYOtQmDU8wXYi2qmGZRnbrR0wGuk0DYg33SQsNT/I5Tu/hPYNTFx2fvHOetsO7IKeuAnxSzn06rnSc5F4N1sm2U0yzmfp9p68NyyTaKabPLP3M09eGYXLsFNNipl7tSWvDOulln+5SJ7pOMsVVPrk1crqmeKKmhEGZkRk9FwMygZMulumWEs3cxAo+pVKolR1m26ZNCrWzEyS2qZES7fIE6pipU6dpGPMETDGD0Qawxs9pOsU8kVJoifSUyYjJkkKOIandJxMpZLnBEpk2O7Tb7osdjBL1pNPnkTxmkArrbbhvwF5liZTzt7ypPtmRYiFnok1EtzOlYp5U1XR63S6bz0YqQsyTCp189Jt2LG9XC7wRmllEe5pxJ74fROy/idadZ5J6deyl7NEuPlcapqP9sJEg2zaR5igHGrHOZeuAiXRwV6yESuyU6VhQ98zI1Q94Zl9+KvyUibDb90xeeyrzqrNAsHBJwV6d4khPdlLzErudThgNimzWpfYiMqlR1OjMS7OFDlzMWLaAXFSP0thXq0fzBgE7oT4uEyELl7qxsBO07lfzN/VzP74Q23UqkUuLzmYMteUkOxNdm82zIA9N3d2uuj5WP34xwJDCSCtgIRyue8/thIfap3fgEOeQQRJtoZUU35aBqZBermvqvLXGQF4dxa1A+6KY2z7BnNWZTuUTQe0br1+b8TRqZ9sHkUCd8zJSsC2ASKHOgFoo5E44z4F1v80kfMdbQdG73GaWAhvBZkYtJEorzKOAM6QWlmY5pLrsw5Kp7YmkHIJ96kW/9M1a1U2eLFCJ2Amorjdy1srKBE9AVsDkSBP23a773FZPXbt+fBK7b0w6lx6clDfUieMKYR0liyDQENlGZWgGRDSsJSjh4RsDHUhvD4xEfKdJtiC132Tk4LpOIoXWe7IzsI2jxqG2jiWWUkaDtdb2umG7dVrdqD07I4vSeRBxwP4DEP3Cp596uX/MxFifJ3EJ80y2UIQnqG37ajjlxp01OEc9ny7ahojkHEkggLTxOAkwbcExFU9a4HQP9WryZPhgx/S+HI/1fLiy02C3ocRoFvQZM86H1DYO1841b3w9yC2bSTPbjAja1fbDRMA2HQKB2mrgBEq3i4MAe1xGDrY7KmKoPVEjhdkmsF4FTqE04hwG2H6brPOmnvVhZRpfcAdYaCI3Ol5B070gz6vk/3/3rTYRTGSs5MmF/c0/3tyvdrl6weeTyfE74tuc3UtxyPd05eDC/6/UZblAE/Arflsu7nbNcp/91aE/hHehaGFfwuUm5cW+Iw3D5XKn4Lrt4+Bk9XNXLfILHGSyWPIUbFfzZd1ZK+wgdDoic5vHCJ+C8MdNu2YkOwidgujdoi9uvVVxPsvvTZfRcunTMZZ4QSzpzNYPO29Lowcpeyq+bS0UwB0Exw8Yg3mU99Ws6fNt5o/iXAqdzGU+RcgamlNhSsB0Ml62qY0coRRS/SqTYYwicWHjlAIafuSm4uijN9sXY5c5JJLxGwFtlcZPdYjmbd4AaKPipkAkJuvGPzMR2yVQqMxb6QrMvoitbKOfud7YCR2l3swb/GxkyqSCBFe4sU/nix8CbyZ9SJo2wzNGy7eLzT8HzPg9aCIlfhPIczXM6C4v76pHY/ZnsSgdNJmCcPMB7epNOU8m7YH03E6HUeP0tpnTx8HFGkqEPYDW81FIuXgpVPxIeJg4c6fkd5cOGJUn1PNKYbklpN6GuCcjSN2xALaiBbJQTiqyFLim0SdF9WWeaHNBufwlNm71OJGg0M+49mr3QdmWXrICdS5eqIfUyS81rwgS+Ll5minu5yGvsCOMtexM8zH1OK2qS2eaYZ8GtC/7f/Y9mOEkN2PUGQMlZycJOjpEoxE0ZGCTYenQlETK4iAp6AVDZGl0lEoMxaXysCioRoMi3CJKlxaVRkNSOXpJj6JUW1oLxFNc2n+oeBzgoNE4vS2Ns2JzOKQjAFqbnDqtGkO5PWFZuCiKws6FDlTqdzyF0iErd2aJbQgkIrwZcK6KTLF+UV6YR87NdnXquz7b6U296Opln9HmOeHeO1/qjnrjVBPw6grpStCukVw+bjPb8FzUIEgO8QC4KAN4iFTE2q5XI2HjHNxp007o29HAWSajvz44WwxaprpNrpSMeWIMwzK+OjaOkXyIzMJpepvM4jtB+Lt4GlZCpny4SxO4hDcyUyicZby23cm0YuPeZJRhsk+QOzlbAUcBZBVPIAHdmQFR3RfVzLgrrVZ5cBrVObwYfU09YkJrDZJ71vlu1zL9nApNkoh40qw3a/NDxh/q5vGJuP6NRqLkPLmGyv+hXuaLyvy32iX3pOjq5/al/qHa2AFaNZmQJ9Gq+th3W+sFyBIk96TYDOG/DM2KzWooOU+u5XqxaPsEx5QoGS3pbdGHRNdd/VD3GRBTybyB09KejEIHRYrMpg6JxBLPCi5X1Xx1SCcsgHJp8fmOiXQTuJj92UTdNcIWhYGZCle0yyxTbUONFeW5mf9tXc2a1Rc7TCTrg1PPq/vZ8C71tKluqvljbTeHMzIPpw/XLMfz0ZmUA4ad+jR57uVpCp9uPZkr1q/PkI0de1q11LPPoyfK8MC9ksdQBOldOYaQ1IvcUUdC+G8RiLjStEngVkiOycdSoEMdpkb0sQ6qmxvs0Iq10Y5NK92YS5ptrblkBXHo2baSd+1d/bwYjqSIUYhN7BWQZAVobOLLVH4WWIcrPhVcQrzaJbycP/aSBbRZBqciVcKe/sXtERBhxMOQRohEJDMRH5wUHD1OmVn2mz73CzRko6FgUXmc6mserio6CBcSE7mckPl1O6lmv1IHLyHYUPxUviwsMwHxEVtiEnfRl0BL6006NbrW5IFtWXiCbIJbdPJmlTs1UMSy9m8gM0i6OruG5Kb+/5n72i63cRzd/7L5mq2xSOrtfsvNy3R2kk4mqczsnjl7ctxlJfG2y66xXenO3j9/JVKuEiEABGR5e790p0yQeMQXgHwIkm2OG2KGA2Rmm9hg5YrnMxB42tW+XSJkJAMjzie1HzQubVdGcQm3TRVIeEePV47Ivwv1M24dVS7w5irN5BBltI9G5vRe0IvccvNBqieM857fS4vB2Nk0y+0jhfvYS7/cb2/82vdPUIS1DUUUtvVIriPlRumKQkOGZsWjxgUVarodHIQZjzTEMorCg9nunvu4Xu7bv/HioZRUwUOo3mq95GuJkJyiKOrZuIZORFr0+vC6Iym3y82gLyPlo3JSJXePn3y9a5ev6+1XRAUixZP50P/+fjwdLn2zW64oDwyl5vPBaMlyLzyCz/nh37H9NxbEKY/YrjF4Isu7aVM1WHr5iTUxaPQXP9p/rG/+7dAOXAHDxIvP0g0EKkT9IfFl01gbCbhJvI0YrXCyJKrF9NPkk1ARUygJpMRsamItnXoLNe1WdTndHHwa4m7XGp1+SZAOMl8OITNZlbezakUpH88D8/Zyv9+1S9AuE23UMKFZTBlZsMiAodh1Q44GkBhoGt3No6wCQJxL0lETmKQ0GA1pDvpLA5KjvWiUs9BdmvZNcAM00on0lgYb7QCZsae+g0M/ElHDmBqNKnOY6mhjI/jX+yUTl4wJzWkExwVrjGCMfZIRRADIjCClW2lwEP0zGhwRSIHBQVDOaXBE7SgzOAjS8wyOCFvS4GD9fKrBUfR6zuCQPX+KwSExDWIQT7MzJvQQiGjOKK+3p8xRzFCi8CdIRnzYQ/QkhbBqTqIHFRIs51lQmtFzvikIDfqE76RaGDNe6e/HIwaE6seeLc1bUIJzergzuAryO6axFDygSfyEFiE5TGUY2cE6H0p6DEvblhvJ8+EcD3AZPnyYz1l/dORQclQoo4YE2BSzwWn8k7Z+0rPCC0ZiaMEKZoeXjMDQtq9sljhv5IUWY3K2qGJm50SWnjXOx9xJOuLAqb/a7W9TlB0iM4srp8oVeXEMuM44keoTdonXLDVJpPY5rJECImeISIyz2CBFCybMD4lzouVRIGOepyd7t/5dem1fR01Nor+rrEyigw0MzNvl/tfV7rft9e6nVhdtZAi5WQwNV7bI2FAfMW3FwMKZtGBI45MYRBZXwigqa4gxjCyKOYyjEipnIFmssxhJZcsmDCWLd6KxVCKkDSY/StVGc9KYQA2nYFyojKegA+Jv79LWExOaxXSSBZN2k/ty9Ft0RooGlLBQGt2iN2TP7qH62kC7Z6pGVH0zgWnYMTty+nr3YfWF7pZjkVk6JVGsyJUjqFnDj8VJpnBgOSVunMUmGRwUoMTQkNcJ47cp3XO4bG2j6RDO4qjlbZfw0RTKie5Zjos2euR4U5s8bQ9HDR7fy1Xmju9YA2PXiqQ29ccisxg7oliRsUNQJ67zIAKRKRCjbBIzx6KSmDkKTcLMyWuDMXOU7jnMnBwgZ+YohLOYOXnbJcwchXKimZPjos0cOdLUZk7bw1Ezx/dylZnj8QyCCYj7F5/tv6KBBYy4PMhgPX4uU6HiyRp/MDP6fOarCFD7KMskYKMiZgN3h8xJNcjuiJnpBFhDFym8g/iSVw9PunGYHTlzXT074cbZGXFRjnTG+2bnu2Z27ttldZfKqu7Tvvhd2tPv0eZq5AI3P8926/O8Nz5Pve157tojBuDstz7PfOPzRW57nnDTc3dBdOFebm92q/X268e2ry+/jtGiUrMMQ7pk8T32Y/hEcxx3Pze//aUZ37nEgBjkoSf2ZyB6t19/XW+XGzWsOOM82OKHIfCHERlQ9HuIsiWQquqGZ7gF2IK4bBipcHxb4pf1EziC+AVwHHT1cbhUfazw18kZKCvyafLz0bRZ9mvEqTJwHrPMgwe9B6+LsqSMLSY029F0tGDdfXdD7ITt+KWtEzQQlYYwyCIzZgk8om5Aw8F6wVTtpN+h1avdjg4P53U4UFOcjqbfED6HhnSuy9FUG+ZxaGQah6NBgfkbGoXG3WhQYN6GaaUL1QXha2ggSleTwjJ8hu33u/UemUEP37KKRViTTlZ2orxRVQ8/B2IkBuFXhTpNL6fVi18DIyAI3gADOTvcxOcPB1hKt2Z4XejzWwinzy/En9/hpvar4jGVUq8cUReqhIAi+SggyNpjp06rgDlDCoN23nihquhhCN4JBLlP+PGZ60/Lw7cUS4DIzDJvpcoVTVsx4ESLE5fIk+qVD0TxSGQzRhKLesKoQsPNFxlIU6aLivYiZoskoHMni4oqw+aKJC6NE1VgwGaKJAaNJ1NgwOaJdPtcph6IWSIJQ+nSFEioZSgJRetTeCz20dy+/vnFy3///PrF57+8/I8HON+X+3X3+MjhT8PkxDy1LrP8sdy/LTf3/sHBF83hZr++i/Z4O4d0+BMmMk0HVbCqtHA0OzZtobxBiqrEDsK7X/6rtSegwMcEVXnP983y2JClwmRV2eFyxfG3P/yuKu31dtX8zrc+JjJNx/PdZtPccCoeJfQamtVf75s9rJZhEl/mYGnYZ2JWhrGEfGG4ar60q1Pq1gKk1CdRDnzCBOBSG4O+13lZqe44y/nKdXrPVEmsCjF90JXqlRErcEwZnDvolXUX7Um19bLnqnu9Elfmo/g5SgkGBVPIEShiZa/WzUZcqQP5c9TSC3fcEIwmOXqVzBIZ05ni1Emlw4VodzTy1XrTUItQkD7LAhQrU7T4hGCJhQz5chiqWPlumBDDZnfzK7L4RRE8yM6s//U4YDGJ4zUepTgFT3IFh4LgLLBQF7ZSQ3VxrkWoC1uRobo4QyjURay8UHUJgyTUSK2wUJUpeyTvKZ1kF6mzGdMjVJ+JsszYb8PTzFpASK55xxJ6rypXN+dbF+A0Ti9CcY4DyMzmPLByxQ4EAtexl6R6JXupQELwciQSAS83Ecn4YV9JqyAP+k7HI3IqKJKUYxHqpJwLqjPlYIQ6KSeDN/8838k4G1StwOEINXNOB1UtcTzyHnWSfKmFgeadvc8fvEP586MuRc9Ass6O79fmx/UuMfNE0Y0zzo7t8QjO9Q7beyGxjTPOgm3AarWlesKVobWAiPzgEsF/YOWxVhJi1G+xUirTEQcwpz7iANXNGegLfa4owmCUk44wIMgYVDfnGy70uYfH1q3En3ugW5fmZVD1Cbd0oY+WBVDArJMDKFAMKa94oU8XB0zA3HzAxNvl722GN832Kx3pi8jMsuSgyhVeyTUGrltykOqVSw4FEmJmQSJRTicUSG4HonI8INfsqFpz/K27NmX9uxxTlGcORMllCQdlYn9NLr9IndzEQqETWwrR3XIencRSiFSb8DkKzdRSiFSdMvoK3b/tl3fvlz/QR+hI/XGm2Xt524la0b+vj9+ef2tuflX1PpDxQti0kOayTkNX2dzu9j/eLu9IPwkE5nGSWKEyDwnxUjO/5XEpVNuLShhPRnva2KHKWUsn1Iaac1Qba8uF2lCjimpjLapQG2VO8ZZM2FKhTtKQokqTVpTpsfiNiNTy/oSDFp1lcCaKT53NRw0S83W6WWUKnHJyKcKVHNopUNwg1yPAhnsKATfw9QgwE5BsmFnrgDALKRAJA6HHQZmKFJCU0dAjIcPWU1DU0etTsHFB7GmAU2LZhSjj8EN/LmPQnCHysP+VNa4sDTIu5onkuEzDPNeUwtkruHqUZBWd2CdC3x2Y2tP67pD5vEzfwBf+vV0Y3DUr6lzfqePgYrP4QKZo0TSV+AIdl8OBUNI5OjyE7+XwcH53NI3WoTmub5WVc8oxC5ak9+eQcJ5fpxnz+pxmzuPrNGPenu0Ks30z4eU55QkPr9NPeXcOQMqz6xDs28XD9yYYzRW1yczBIQq4yMj4tA3eZkwBJYbIMOP8yNaHlxNgDXPNj+m4g1MNkV0b5LoEphcYacIDeiEnT5Jo2DmUHM5V+N+/ZqktNaKoqBTpDGw6vOQUTQJTOX87A21qgjcN7eic2Xp/vMcOhj0m6M6thWzoIa4o7dxJ/riw1FQ/hkY04BrOvUk9V2u6beJMyUbwZwI+NJslddDrlHZupY0LS1VaDI3s9V5aqOvqQVygclx553xmrzq9DY5hOOEmKuHX0RASw7hq8/5rNgVMwhydUzdX/n+XQHXzbb2Bw4yGdZL+n+8sXvOpPpQVEVDP0FViEFe/AmZGBmTObgIAya1HCtGYlyAOlQKnqjhYqmQl0IOWclKCPuol5yQwCNMoCRma79x+CIMJ5FNMU2W41p3UBFwg32Vw0dNTEpJ2aSFuvfXqRXf8eR1NJWQNCLLOjm6/2/nbm/+2VHX3ONv8qHrzpGrDYaY5EKVOvAsgCU69q1Bgh98l9lFwAF6Fg+HjtAfTVXoZBlJ7Rn1CveurfB7tDAepPUiu1RufJ5cp58+UK0cdx4FOOF6u0g5vDBCoT90aoNavVT6P5gT3O+WMvUr/cYfcOiMAAfLNMxczhcnc2GNOcZfzYYJHsVoFSsvYZ7kMnu6agOudtppgxsth+9Dc7Pa6oT3KeRl0z7uVWOjBWngg64XwhWOq6+3XUBNajOPsF8AZTpX7uAcNvjjbBdv3w5T5LZb5UiOkyzgiP6WDBGS+AEa/MGqb6oxlFcx9AZR+MhAkO2Orn0jEeS+A8LDbfG/i+8Ykc7xhrsv0QC+IxUvxfW+Q7WJW5UXT3HX+Sb0Kw7NfDOcZGP9H8LXNNBHeIOdMbBt4l6i71+PxfPXbLjP+gBAmOAvZyRYufqAI/Q4d5ckDUbKeWkzd0xwfmn/eN4fjpw+vldhGmS+DsZvad/J32DVaPEKQ9TL47re/bne/bd82q/WyG9cvfz822wPmMXmwXDmXQX7bHJfd8ZSP91+w44M83FFmCSMoQBgZstvl3af95nr3irpGLYFxnH3yWEZxRc9ITAQHy5itrVHEL/rXp88ADIq4DN5+JdMKd2Ph1X532+pWAqbKuFgNn/rZ9U4PFsk+T199XBM2+8l1OMh9sfY+9atJIOPM/1N9csIoIgu5GOZnv7TrifvjFAM6zn0xlGE9+30iSpD7MihPy9ozoBJFXAbv+vC2d9ITkI4yzzcHGSwGHiY5Xb4VsRDAhGZZBJAFixYAKHYq+uf+cNzd4s8AMyiiXJIJlh7TQw49sCjrDOj0ExYa4VmTFQ3OhOOiEU50WkpsEofFYjzHWWmwtsNtfUevnWiMo4yzYJMs3WlMgmU7+x6NBlxiDU+DVKzfZwPLLuZpqOKF/GxA5at6GvW0Ff05n6BbPKetJ7pwnhsfv4hOg5QvoGerWtnqVGNXUy5gzl7BL1PZCqeXqDNXLblcTVaqaKk6Z09g11csXPHaak647OqFhStetMwGV7TiojGrV1uzAU8svWjIimXXWb4usQZ7teyWPuPdQUb2YiuyYfmTF2anD9LFH6bh8FGIQiSDy3dPV/S+WW8f7xQbXHQ5TGdrHBzwOq3GRWU+ieTxT4uAEmpHr5+wStHXT7Qqbx7dqkxrnGG64seBK6ziobxK7bC7sBupA/3qfVRw8yUxZ5BokDPbCd5IehesHEnqCC9a0uhz6ErDp99SqLKtq/+JSouQpM8RUtUWf5C8Q0NnlIAt8UexzSAfnUsVn7L/3NfM00YImim9+lRM/z34ROHV+vdmNVi3EHQtLjbL9IApWjQzIL5A4UuESFCXwtFROmQdD0Ls2nPAomyXwNVCmQBrmGsmVBNW6xzC83aSz0WLLiF0cFW0rQ6viKjn0Cap+rPqkiPnE3U4hZ7XjReCWOZwnUst6wAmyGUO6Fz0sg4wSzBzcOehmJXmUkwys+Zzfpp5mgUgiWbJ6FdTzdMw8mSzBOhMdLMaPs/aJpBP420nOS6SuRV4rPO5WzVklr1NQJ6Hv1VDZtnQBOR5qFAdZBGLy+Gel8fVgU8wuRzsubjctFMZLNI+3v+y2t22A0kUWsNKz7JkS2sQrdz4z2JmLw8ZpyCDBUiCXCYh3TdfkYMaAoSnjBdD1lXB++UeOVwlrL9T5jkRiu7y0+BLcSZ8WY+fSVTi4eZbczsLwquHos4Cmrgbad9O2mdB2xc0M1bVtEMAe2qQs7S7atakMrhTlqaT0O57l4vPOkUGKi7gsjXLTjFkVTspNHcSXhFzIgCtjnVkZxtTq15CWsnHooa7mv9zEsGIgs9QRCXOAl9CKwlgn8suTZ5iMCST0O/MwTVNm7txlJPEQs7CPE2CLiegBN9xAR7qLLNK0lEKk6pmpc5CzJNTCtgzcVQzuYLzZmWKTZeL9CWed5M1yjT6bWr1s5SWrOLnYbYmfYCILRJ8xbyk0aRPSXBHgo+Yi0ISe4cBk9QOvu/N/rjefm11t6vO8YRiJDELY4SXKmKJxpB1MyRCtfIWBjGKO1W9PnkUl3ApYhQ3QVCOY5hhViQ+1uW2mz8c8ZtACUBIvllxrZovy/sNHghCQIqznIsmjlVdbn9ablcbMZZhBv24AfeSahR/m1Xrx+UXpeY+h8zbsr1hYBZf397eH5e/bJqBZUZHMSU4i5FkCxfZSvI7dCaTB6K0nFpMlAHlQensqBbTw8Uox31b0tdxDD0PDsl+CZTrk3wr1xpP5PQvDxPLPxNOobFLjICkzdMiIUwfDyNhAadhQA2hBIfKHkp61MAs/mwpO/iQMovhi0sTWbpHaDrTBlQpbVlSa7P92i7RU1ofpCSjK6nza7NtWruSrteh4FTNwoEMWzQ5cpO6iKEKFCXGZlKLdyMpJSehWeqwXa1tfrTzlNUav9sU6B6Lz4KCMUJoDausDq49fjnKS4Q+sn+9vbuHjzCN0lnDI3gtBy8w9YrUGCa1Oxw/iCrQeYU8iMqqTuz3IufDJCgEx8S0SOJBJQExHmFa/QMvNhQf9e5h4iy+bFQg6c64IRNhVltfBANqgM9FQNjksXrELM+jG7VYlH6V0SIwDDvWh9UXan70mDRLpwLFiWZIA3S6KRJUppwjpfVSKzyoWLemQ/UKB8yofpPzlbQ2YnBAVYkZi1QPOhBwXaphgOsfHm5efenuBm56qdh3D0/LInKzHXamyhYdesY+QOTJRAh4V6ZRfugEdcpPWaYpj03dUBTracP0uYzeqMxJzhSCn2IeECRqlyrEQRuOMQilY1UhoEwKhUJrVygk0c0Jd/vm0ObwzyIkTQwpPd+tCqwG2R0L5CepjU4CTcL0qIHsoxxTEI1KOAfa0DxhGcZ9F5Oax1SRJU8zWOjn6M0Wg0pvvDSYKBNGA9IaMj0a3JylEOmMWgJVostSa1Ra9FKdV7R+TXw5snaSLD4SYLSLETUucnGSAKZcrEhwTRxSqZX3eThU5uZMDmJqLUmH+rkcgax3DQ9ytVn/ufnkH2ShvBQiM8+hLaJc2VEtBLgyUJlSrxzRCiTEZgyJRLUtw+MQDhm6TZIEhEI/YTpI5QmbodC8PgyF5QhG+WZukfXhhX/y9PX20OyRU1E0LpBvdlzPd7d3u8NaV1nDTDMjOkVcaltwlO9CuKa1I5H7QhgntCmWdWZ0+FYniUiz6am2TajDTtgnladOeI2Bi/7zZvfLcvPX+x0T7YPIzOKiqXJFLhoDzhzOkSvvpSUNz2OAMe3XrdimbZmb5tOhGb+JSgLCssomD4o62jd3OzSAloQ1yCHrlAo0m/XtemzfSCgn8TlwjE4ifF+uN10Mka9+VauNss6Orzkc17etxMf1fyuggVyzowo38HnRP98vked/6YE/zjlL3xpuj+9WvLWDAvNsk2OFiuzcCG+SydV92RM0o8T6SZEtb26aw0FcKQPxM1EoDTAOZ7r1lSI7NMv9zbf369vTo6MyYEi2OVuNdAg4GrU3kOLAXQEOQucHFD0n4QTInjPRA0iRseYfBzXJ9kvxJA0/YQanWn2uDw1MPm/v5zf2Ey39ecNSOibVGvEBKBp9El3KoaYeZ1MwJBzFrF7i/IGuGeVqzckhrR3Pov4H3tr+tN982N23PfnDPULsjSRmGcR4qeJntWPIzML0YxTmktA+zCBx9mIkPnJmHI1NwHiQPheDhLclMCRYW7HWL+1PqjYYZpj1+2nenOqL6h0mZVugPBXbHiqWikUzCIt5PNbo6/3l9ojfpI/JyUNhyHgzsthEvBkKm1J+f9f56uffmptf8VgcBgXMOw0OemyeMbuY0MyH56cYXxQ7UetdFH0Yy2PTR6OIc0lMgAZTf+oaN0k0KJBtBlS6Q9NK86zRTVtoWr3WSGvwSA6vn2+q9a2TOFw+g8FO9eMhzbZvvjRttpvmYzBP47UglJiHaENLlTFtI8hUzMyD4NhsEPrjLCKeRoqGvvuCrgvV3RcckpjICsniShnIT2iRKLjsa/M76qQeUmYKHRuWJowUO0EjF/TYtblA0/iKXJWOA2o9gY5E8DymY9QE9GwBpM/YHBPmCBCsZt8QVarYMxTq3rdp44GEKj+JnqddHPWG1Xn6/JBMLxn1hyhNhvqJNN52u+P47ALVGsnPWOPH3emSLxmOSH5GHGxEIdkKyjBCcgQMDQpjS2Y2I0ILwn7TOUPq7Lni9IGVHlNz6MW70ww9KdWJuksLOw70A8WaQ4FZOhRaqPBxN4CX8A5fuDczeRhEVokJkaJbf9229vHVbrNq9mMfhsOCeebEc7qd9j3++gUGB2Q5Ew3cX/i0RXZUcCCP0uoeA7WimwekVnbrQKr1Zrm5uW/dVPP82/32VwUANON5WNg9FByFaBtF0QJhi0jVDMMs5/bCAaUagRiwjN3vcsr0ftiPsVKe3HN914OggkZud/fbROEPMqLi7aPx/vTz6+vP//c/rl9+fFDwfblfdxuIhz89JrIVAWtz5GIAZJGHARcdxYaCKzBpJ4g+IX23lVR4ekq3EGm+OsGkP5nrmTojdYlP9p2v/2Qn/mSuozMmkgWjsJCzV8RYd/LxmWEZCHTqSAtms1loIpM9e4UMtaYfl47yR4CZ+JW/hRB5KtzkIXm+CJa4SHkIyyNSko7iQnGA2oGwxP+RCCTLIUx/gmaQ6aMXf2hNqxeAmq9GF2P0l6sWZDSOgbd8dtzdrm8+NOECsJh7GYwyREzlOz8kj+9TGp5guWUVgH2b3sDIgaV9EVbW+PuokXpWNWK5/1dU4wjYqRqzhaoexx9IzWZXq1NOFdA43/+KuhtASjl9rIzhF5E74N0ptUn1Ncr6v6LKYlTp+QFWEPgyoupud6v1lx+Tqm6U9X9F1cWoTlVXqaoOfBlRdd+Wh0n1Fuf7X1FpA0jp5RlayuCb6KhM3IMPw8TkzlsTlYl8sTQqk6pyME0a94SEfqoTTNJPz10SKPhpyyQs9AQggYX3/ZOwYE40gYLyn5P0E34pAYFxSZNQECY+gYKx7lIU0fBfb5f7Hx8365uUFSAE5zEGXOGTtvHI76LORuCXf/DAlDeACDBpzQcLT2FFlLVFdVkWDu1aZc9GaauPtf4s0ikzAS061gay6KYsJbToUhaSBThx7q7FmLKfLMaJk2QtRoHX5cfM5IW3ZEgPA8WXN9+ah371sRnvao4k5gkRR0uVxYePIOusFaGaM1PjaGMphptOUPz1vfC5CMTmkMAhmQyzNTDoYC+Wx+Wz/kC4f+4Pn2bgYrN0NaZoUX8jvkA3oeBAKKcTOjzk2X0OkfIEvw6R4J4DDtvk2w6U9Xb/+3qz7kzpFJBY7vkxJl/54iBOfOMriVBsfDhwEgukQ5KeVHN45FNqHSpuNsj2L8GyWIckPWPh8MjJAh2qxFyP7d+yBbMOT2J+zOER0gg6PKdr116PbwGXYEKzz+SFiJvlyHejJDhT70idjbMd5z/v9retuv9uVqc357SWAi3hQmi7zd3zEZOlXAL1b92aZRJSmPNi6F5MQvbicqjCTn73Ev1yvW32anx4/ksg3Te3u++dmbtrR+m0ZiaLuATe+7vesISaedt5jXWzerFEbr/kQPPlXAJ5uKTj04fXuhXPINclLf3Hzf3XSTa+z3iRGts0y60a2DDX5dqxM8Gf9usJbfmY8xLoust6+z6NPj3OLtVGeS9jG8+AiGS+TC1+2O382X7seji+DuOcF6rB9/vdXbN//m29WbVFaKtwlPsSKA9tP9/8CDcgPzutr0/zad18MlnU5cb5h+bmfn9Yf390FTroXCmXQN2uNJ/dHNff18cfk5w5nn9+pqHV81AXJ4VaoFgB87A2A0L09XbV/B4vlnFKlBKchRRlCxfRouR3ULRfJ/9z928dlmE+SWNocd02q/Xyw3KL2GUeWJRxJmRKyooHKCettMj8Germ8J65RiNRd1gBl2hdgqjh0Z27Y62tTo4l5ZFO2bHWouM4Sh7dlB1rLboEI8cDnLhjrR4uPIuZGCrTdqy1GNP8b2LMTN6xlgzpgf98s7v5tbu/iI1awoRm8ZtkwSKfiWLXbSTSAJTbiBosRMelsag203W1cvPr2NlwlRLk58aR3h6kMU3dHEzgE7sUGplk202DIj2DobHIZy8aRJwzY1pMsN2mQZE2tszQuki9JNwoDUe4raXBknCXNBbhlp+yB3fizP4a24NHeWexzRHCzsJ1gTjDLvHhXtOj6BLmRxvoi5e/3633PsvEQZAoZn7cvy3Xx1e7LuSkWd5e715ux/do02jRzPN46cHE6O1uu26TT9fDjvCB9FmmQ1iZopkQBKubeKBqVXMOWr/YjaIgJB5UqDvtPFEEcr8pxMG5TBSBxFsKdSfcEqpe6JGECNKuGu+Mc7dCwimiIIT+UIiguV0fn3/r+K6x7UPVxxlmHJXrw1+2u9+2JM2LohlnOg8RPB78Zn04NltkgkCNkUEG2UJZiEXaRRVLdLFmac/sJWfVHsIGdM0wyjNvfXz5IqwOL3iB2ni22Zw+brxqZmoE5JsV2UYHaHMpHPvlb9q6iXPMiqbB3ughzeql2uR5dGeXqF2ej67wmgFP6znvmq3Spo4zXQLTu9Z0TcIFMs7be7634t0mmbAnR/JnIxneGt8Wdfy2391/Je7khQKzLEPQQmVXxkO8uoUIrliwfyTEIF6M4EAkqxGp9vRyBMcgX49IkXALEhyDZEUi1Z5YkuAAhGsSKYbEYgDHIFwNSDGkF0bE4JijP8Qm53jzjWQ9otSZjA0sUWhphjApH9MJhavDRIqBvGRFQ+HQdbAREnHvEtSCXOu5O/WiyuDt7gjTlD15EQ6JBR6hmX4TmggTb4tHaKZEBIhwJK3yCMrEvX8RGoltHPfl2Vsqft5j2c5ANz9wKxmlzmIlxyUKH/YYwpzQ6RC9Eu8v0pvoZIhqod8XaU/YZES70CaLtKe7NAJA7uspDBK/gCk+0y+IqoTzCwimKX5BhCPtFxA00/0C2VSRtRkWDR4uROAx0jNZo5QGoXXiPksXyCOApIzomYQueYZcgHPiUfJJeNcnwWlVGme/GMrd/fEsmCD/BWuTi+EV1ac+hleKVG3kkmjlXMQkjPy8JIlONk+ZgEviu5PoNL58Qk+cXm3n+/oJVcr7/iTmaXOBCTiTU9Yk1InrpElok1PctCuaFi0tRju4BR27NGtwuav0xizNHbaTbmrC72iS3lHLqUxdHx3lRW+kNYu6zPLHOVwIF3i7vHuA0ik4/Onhd7Yq0daJZpzYhyUnmfp76c8KZ6VivdQtxihP3zoflzLvffNnRbVeoHqm3CYfFzPXPfITY48vUCeKW+Lj3LPcDz890PgCVaG9/T0uYq5736fHO1+gSrS3usdFzHKfu+L4Au/5Z68c1e3tIH/y3vbuxcxRQPBoooQIzcOjUAXL6BMMOxWdQ70bi6vvxUXLTx6FfJpPghHNyhQoBGtfEoti3qFAxK50SSwiV6ZAIVjXklgUEw4FotRyi4Qj9W4KLKnFFIlF6lZ0PVhpqZ4MsswwquOnL9pu+M/75nD86Xi8e7nfo89UjGTka4RD26PuD893q/H3UuU+eczzr5nYeWFfQmC6R+4WIsHc49cJnYthfXjdOoklFiVMQonyzIGIdewKOKlZMVbE4GP0vpfEJHs7RdxK5/XeS/Sbm+X9QQHmJD47jqZL1FXMMMvseG6pC3lIOLfMFTwT0AAbv226/R/ymiASFZJzIpebqLzhxfe77ZfN+oZxASOJWRwAXuo08z/+BoXxJ4BoTL9YP2P4CRgTzD6HRmT0k1BSJn9cwFkGn8AjeiNB2jLn9NT5+wlu6Kl6UJl5MQbayBM49CZejIU08AQUtXnnkOiMO4FoPtPODu+hqYmt+Zf77Y2/MfpPfQprxQcF9UfMuyxvm8NheG/jY5ljId5JDBzQq93+l/Vq1WxpDzQWmcUFEcVO80HIZyicEAVF44XkCBg3RAGZ4IdYPCJHlAaT8kRICWe5IgqRxBfJ2+esPnuB/oK7I7IuVP5IjoJ2SBQSvUeSoyFdEgVG7ZNYLDqnRGGazyvxFReZ+/vtijP1w+SZzPyoyKkmPoKuMu9jCDrTLtHMmvUxgEkmncAhNOcciLQpj3KfacbHSGQmXNIOm90NzsJjagfCc/aFyeNhZhyU60DqX+k2JNo5lzFGMMVdSFAwrmIMYoKbIDBoXcQYy5zugTIcbgTxQWz4DMDjUgMTk65lRnmfdxkkSrygOOjqIdu7u/iRn8GGOZSR+7p4TKWKRAbWsGVGUMVDKakYH09TlI9GUFI3OoykqgfTFXqmIpukgPt6SAct883oB0zwfxNc3zkeR+ZsVNpwv5J0KSodtPcQOQ6VLtJHSNxDSpPOE5zjBJJIMCMZG2FsaKetb6or8qWqumSAK5j9J3TCBYBeGWJPEjo1dgWqlkaC8XpT03yQe9I0PwFGZe5GtQDsw3Wzvz1c70aj6XEugYlJJyzN78f98ub48qEIrHwoo2N2n339um++nthbktuNxcTs7uuuKbbLzcdm/73Z454UkZll4U+VO231j32JggIgwWh4AAUGZq5BQpnACPCIRLSAAE7KaGBFnEUQkJhkL8KIW+m83nuJfoNPrOj6UK3aFTjoyReJRb9+V+AhJ2gkHPVKnkejm8SRqOZb0ycqb3gjc3P8tlv9vDs+22x2vzUM/UtKzuIQ+NKnuQX62xTOIQFM4yLUeBhHkYA1wV1I0ImchhhaynXQBZ3lQBL4RFeDa1vy1mdAbj7ksTxmmwnHHCPwcv0dd3Cp9lK5OTUm2tklcOld3pRehbuYdLfSuT8JMp0TTCCczxWKKjV6ouB7s3rfrtWW27aAzQ/GIVKS8zhEtvSJDpH8No1D5IGpHKIWD+cQeVhTHKIAncwhSqElHSJZ0HkOkccneytD2ZLkRmwCjHpPVo1sjjF5OXSEi0y0oM5FajExLpLHNcFFarHRLpKHpneRAmRKF8kjnNFFSip14CJbZ5oIFRpJzOIS8VKnucLxNyhcIAFE4/rE+hmXR8CY4Oo4NCIXl4SScm3jAs5yaQQeiSsTt8w5PXX+foI7BqoeVA5BjIF2BAQOvQMQYyENPwFFbfA5JDpDTyCaz8CzlRYb9te3d5vmts3GUYGE3FxGnix7sqlHv0pn8GlQSrOvwcIbfxrSNBeQQCZ1BBJYAneAFnOuU6CxCV2DpvXO7+WX6leks2DqR+syNHhYx0FjmuQ+NLg4J0LDmuJKEqjUDoVGN6tbScEexBS9e3Z//OYFXq2bzQqNKoIyco/SRI4qVeSTkzg+zkdQOaWfV83hZr++o26SYwCArOeBOdzs8KAfHMBJ/Eylx3DHiVRpL65XOpileDF6chInzxIBihQpCdcCQPUOC9Mr8VOk4ti4Lbft+N/tf4DxyGkf5zkHAeMgMeUT/KIMB+4O0dpXeUGZdtr5YQj0Pk/YGyhngnYDrYcjMegcG4ZlPn9GV9TwKad90w7B1bqz2a+W6w23TmJkZ1krpcqftl7ivlCxZkqC06ybJmBi7HkS2oT1kwyhaA2lgJdaR3FFnbWWSmIUvTemb9V5RsMl+x3uTNL1pfIsE3DRbiaJTe9zJuAjHVASntobydDpXFMS5Xx+Sli5wxtZu6vJ2+Xax+Vxffiy5nwWLTqLy0oUP81jMZ+ncFgpaBp/pUfEuKsUsAneSoRP5Kzk4JJ3dNMlneWqUghF1wKr23OWMXDB/oa7qWRdqbyUHhXtpFLI9D5Kj450USlwag8lwqZzUCmM8/knmXEZH/3+0KzWrWt7vD4rdQQczyA+ADXKPq4zKDELnYSXKmGUxognmENcu+xtOVq9LLqLUI5GdU3SzJldXPcUaytFQxhZogV0tlWKgTGpOI4JllSKhTagOBS93WSQKM0ljmhGK8lBjV4JYq1i9M6D3hzKz2Yzpc8yhqac3eYwqabrKjD82W4O05SZegqa/BUQCa70QzpoKeeeBefAUZ7pvFobNufHH4djcxtPAYaXcg7S+QnAYNhiZQ4+WFokfJlp3+BjH5b35FEWb8ghPsp7EZZgpOuGu5xBoGjVHND36UaKesHJilrXtt2JNJ0kJ6tab7/INPWCkxXdLY/fRIp6wemKdntZK/WCkxUdfhxulpuNSNejrErdYBXwabu8P37b7df/zdFiqNQsjBhd8jQyDP8eBQ/GANL4VBUOZrXEwJngTlOoRJyXCFLKk+KFnMV0MbgkyztVi53boy/Tj/AFF1cvqkWXCgu98GLw6BdfKkzkAoyBpF6EpRDpFmIMsvkWY8lKjBzG4f6u83HN6m07zVxet6OccxyM9EwOJKVhqiPhvlPlUJIAdY5lAi7WwSThTXI0MpRCh6OAmHY8XGFnOqAkTpkjmtDCc42Qy/ZDykGl603pqCZg4xxWEt8UxzUBI+PAkhAnODIZQq1DSyKd07EJK3ng4J7t98sfn7br3fan5Xa1acbjfCTBOjKp9cBLFVmMMWSidW52t7+st+MeTuo+idP1L8UR9eNvIXkcdUsAGchP7AnyKlr2EuJKGmSQDSwxlm8qIN8uhGK52TzXVgrIc+lGC5/+cflFWVl9jjkqrC6z/HGgPzv82N70Yq+3d/eP1FE3OWlRwfTE1ipd+rv7I198EBBvCw+zjitzkDiP0YMFyuzdEKN+HI91ol1Vq5EarSN1yECdpgvv8IS+UV8X6Iwe5d3tNs2SdIpx8iydAylS9pRqjJTcpf/6VfYdTx5EZW5Qpp/0gRgC3gGO3lomEQiHCFrzyUEi08p0XfrL2c6r0avQOaF/DZ8vXd58a1bUaIlSZxks4xJl71BGMKnFJf5AOaISeZGc7qUi3V/w41mI7i/jQ1ln6r7phEQ13Queo1k4NFHtqZEp0kkMEERhYnyItH1tjn9pfoga9lFUZn9F+r+0P71oDsf1Fo/VQjsYzDIjHsYski2gmr6SPT5+czkE1i83pOUaicxjvvBipW/pQtRKQ0Yo11kzOYr2Y4avlSZhPMhfBEc7trRQQpaLoPnbcnOvrppTpnkR9YNM2Vow17yYWhu0PnzzI1sGZ5DhbCRSF0WN5bSfEmvnzCXfMNxMUqtfqXsGva0Nv/n1QVxe9TDb2X2hiPrkaKL7GEA2SGU9RVTg5tjsf4ILpGGZQwExtxFuw301zDyqQURmFgdHlau4cTsGTm8RMHdtI/qxW7bpPqFAQjhbEojK2/I4hIaKbpOkpVLoJ0wFqTxhKxSau6EXxOXaozwztwRjtBO1oZrpJvro8DqD5X652TTkZBekz2IIsDJl58UBWC2vhCpWEks0BuGQw78+OdyEeomhxnz5PBrRLs1oVXVnpt2jmzl2N83hQPbkKHmejjwuUnjvQYSU4l4294d2/L5dbpcYTYsqh1lEPVqEhvBlGAqVG5Npb35vbu6Pzbvt+/36drkfL9cwHEimsxBJBzjWMOnxLdJKDW9EZWp0S7/yZahF6Wc+is9X15yJIb9cZ2HIXjgwMB+bf94325uGsjAgfRYTg5UpsjEQrNZXooqVvpLGIOnUDIIJXy0cvHh9qwMcVF+Odmzm61U9m+kHw659XB7X5KZ3lDpPtx6VKOvUEUyiS39H+TNE43cFZ0ZpFnXksepUN5ZoYzoxUrv6Liz/YrwDU1+t675Ui4867/W3/e43vgcPRWbsxqNiFX05Qs3FZYp1j682TfVqAoO8a49BiPq3RG+qkyN1P7Gny2uB6e5UTUzo81TPiE4iMDGas4dnTovMPCsYcmIcpFb/vvWR633zbHDmkEYQCUsGmQTB+ut2tw/vN0tqAYifgUI42KRBn1qNhFkRhXZqdbFRnGcEcKprmQhBPj/6+MxA0VliRKnejh+gYmMtCbmZjBldtvaMChU6OPLhb9slJraRyoIBOWVjPYVNPOy5WhJYABUO0hgwIJJ2YQICYnAkUSjHSbL/DIbM35f+CPyG5OmhwCyDBC1UNDpGeHUhqLhiZRCqFAM5+8BRKDkQBoVwEBKtkBx9Us3EsOO+fiad6EDj9LKhC1x7D6O4l4fm9arNsv6ybvYfj905q69jQhkXmyeqmy5aFt2NfwFR1b2ZOTzmUAFCs8+B62tzfO9zPt9tj8t2mqPDhWafA9f68GG3mwhqnHcORDehPCROnu9Ip0xTMQxuM2IGzOB2FuV4ifeX6G6a1qDppew3Sy/TkuPoT2P/a6EAdIV8DlFtzCgSwFUMootW2xjHqdqMptqQz6HW28QgF2CVjvGLVhgAcaotp6kt+CHUNjS0PgJ4SeNz0co5aU9dhIDkfwBOMM3r7ddN01WbYAbBCc/DPqcUyHho7puIPvFL6zs+7cdsWRrRY04RPz0BG7GkSENTLi+E2LRzsTROha+bgjE1/0kDlFrIKegEs8Y0wITbY7n5CZjJ+ZtoAI8N6Qz4IqN2/8tqd9tqkdg0WnYek5YoX2bRmA/SGrQUHqU90yPbN1+b3/W4TtkuhIoysilYWhsrQqY2sSmUGgurR5g0sCl4YvuqxyYxryl451hXPWLauApMidK2ysYJ4Jo+NMvV37uy3uxufiX4BCAzG8uElZu6Txk/0I98CLleuN8eld/6JM40B6aok/y2Pn7rRDspOSiQi6ZRhCiWN37nWA9knFFi1hXI9s2m6aV1yMYZZ0bWtcHrbsm3XW6enzqJrgmx7DOjbE3eQ+kJnhWFSeaffSTc7lbrLz+8Mjm8ONPsFmOjNBabtJ1gL1VSdr8HMV23G2aT+RclLj0kuvPPUG0Dtvjl73frfbsQoVzfgMMhROW8MWrahQpkFp76Gj1hJcaSYq6ogqLvYSps3KU1KPGe/QdV2cOPacaYq7XHb8Jnci//eb/cpKZymNAsczmyYNF6GMWus8U0AIExVmCRz9poRLJBrcRBOwEeiGCsKJFMAJG0+5reMhgUr9abJjyw8KEJh76IgUEJzjI42MJFA4T8Dh37wQNRUh9aTMtjK3p3/Ngcj62JGy+HeXDj3JIZsr7ebn59d+cvMFBX3jDnpbC92m1WE9p1kPESyL6s28VLdzG9Etgw30y4Yqbtt+Vms/uNCFrmscG8M+ETXaauQHYV/fWvWWpeRhbNlJpgC7QD+SHXZFOHMQNKFI+55kFx3HXpX9pc74evHcnAjDJfYjCcbuyeZt7GuS+Bcb1dH9feJCjhRRnnadGTcZpo02bDcXN/OO5u322f725bN3y7PqjNLF7CXI5gMNv6875pVj9SaxBUapZ5Fl2yaJKFw6eiwYgrxxgM7B1xyARLhWffin28//JlPd6KYyBFuS6AyrPmelhxtnlwTaFDGYhnEqKT0GK3AAogkjcBnouLo2oZXFPIWn2vU1sf8RYPy0GqKpDlDxikJIFwDjIJy8JgOpfzVlccTXgkak7Pe6uxTYF1HvedbN3ojr3b3f5HghHBhGbx0mTBwmv2EOw6FoQGoGRAdFh0tcyOJ+SCNzmS+21X9PN2gffL8uZX7BZCCtI45wzYREtKGlNqOanRTi0lae2pZaRGe+uuOwHcndIQQLY5ekt8+163sErN6XGxWcwFU7T0Sj7sC5hpNN4CHI5hLkkDJDFNmaxyAM+crerwctNCDuSUeaGudbmJId/PZpgZ6iqRnRpyWCfNDXXVSPgyDtW5s0N95dHTw1Tt6eeHenSTgJ03Q0yDHARICAIjLhYQMX3P9Pzd/LMDHy4S8HDG5u0Fq0QR2CANaIi74Gp9GO0WRsAGAvLu1/3vcNeW8H7fDHkptuQn41zUlw5RU1PwQxfvd0tU90j3QPwMpXdtzt92+5VQ6UD8DKWrX4TqvKBS0WCe6mUIzz5Im2VGCssTTUOHAHXL1ZE65SpVoHnfiaQVn8QkU1yp1g+/CfV6wTk1oy4Y10073inaU4EQIwzTYh8ESChTSCLhrOBZSOgQghEGbdQArj3eY2sXcMfGCz7frBtk3TIe80iWmdC0i7UHf4lR/iMs4wxzIgksgRzIUH4mHH04wqvlBmFnRiiA9HQMomANVv3V8I90dMawLLKYSSvGEUrhfDrZNPxSC1UrmbQm9VJM4dh4JghCgS6KF0ScBU8HCnQxIRAjdYKoB4FGMtCBtLznaLtpa2jfiQj8XiR7himJFhXopkc0NxXveMReHXRIvkhBt5wSQSZTmjZDUdYTVHIyFY+OBIb0GLnAh/dKJQvVKPMJLL7o+Pt+eXfXrFKHSU79mxefZWkiUCG7HY//Mt0CRgJKe3PeRHxT20V7iGAavqYTx586lWCMss+MUz7TkCAVTT6mY6PnI1Jw6SnKNHRNL/4+xOFNb+aoDIlrlPfIgYH72269IozZY9IshgsUJzJSA3Q6gwSVKY0Pqlc+QKB20WCQ6aQ7PqY03cnxGh50kJ+Wh29vl3cjdf3vs3SNYVmifnECRXSKbwLMTx6FJINLoPHV2KaPFL6Svvo51idaqiIKU1PBhywBHtH32tSkMkVzQQ6CLzsITCr7kCr7ML3sVTt1RB6liop/kJmkwS+PEsOlF5lUfiu0XzeJln0UmqTjV+x9+UjBr/BZeUXp/v2cRPkPMpM0fNntXy5vxgc+IhWPQmIdhcncINgcW57HHZVblie+4R+tG2jnjbv9f/I6Pp/kPk81vf847j4eu+nH9fJrStlAVKNv8ETx+iHQ5afYAD8+UgxF+OX+wPE9BtFgriRKncUJjksUucIYpsJ6I/qgDediDUR6McuO6IX2/Wy9mNVH9ELbf7ZewiMgqhG/cLZ23Ftg/WrkM87WTXkSRDvmT87Wj3oZRPnI15ytmfBAiG7ED52tnfJOiHrMR03SL/Bc2GCD/uvsb2e8GqKf8G1TUCg8HgaE9HuTsKAu62NzfHu/Oa551zWQmtmFwZKVrmwIf5JLG+mf5tpkOF62Bm28dcqDOeW5ACLe6Y7ATHO+Ahy8Ex7hmOaMBTiWq3HIAYMjiF8AR3JyMIIyeZIgRqPuunG2C+BKTWLGlmXiZEbScw46+/nklOECWNITrBGa6RMtIZ4frZwa0SnTBTAlJoEjOBMng5LRtT4c1+0S9C9KRCDfBZAlp6sjTJOnrVI02l40zHQBTOkp9QjR9Kk1gUc1xR670mlTbUHdiKbcIzxnTb1xVJOm4GNgZ07FcWwDgioceEJoqZDAzroHxbRztBfNl2WrCinqMZEtzizqMssfJ/LP9vvlj5eb5rYZBEN2OwWHPw2TVGW+vL07/nj3y381N7DIQYqqxLZmh3GJobDwo7acv0Vvsj+U5H/WlhXPmx7K8j/ra6zN+RxZVg1qLpYQL9bALhFf4JPUhZ8IVKaSfAeHVxH1NTVM48cAt+lFFZb6kBgaFew1WDUkFF3BJQOp7LQXR8ZZ3e6+i7/v6kF8kuZhzBxGFwziraQ8AXwVTFIWu7lH2FdhmBim6hQfltFvoQ2zdeDoLd/YCnCa0RX/Bb/0pO/hcyvR5z7AFAwKTj03IGb+0lZVOuZvmKvDRh1lQtbEnG5qMXzBzx2oTL/qN8w9xEq17kE4/pF17iVbuFOWfl0uauMDM1uEK2lON7aEvuCn9uoeRu1C9LUnkMz3xiv1FITxEv3C3+wVPny1bBw/AqVGM7YGZ8cWtfi+5Hge6DxVgMxWR2iJKgCLfQ5IIkhi5s8O2h4Mt6zFe4jct4q7Oc4hXPqLh93cyAb3I1DqXB2gKzgQqTCVmb+5V/cwsGXG+wSSWuyPKQgOgyCkZeavftSYCr0bZh18FnsUgdvZG4vMeeRg0p4egppo1xv0Nhlat/wuHjmGW3mlPrkVx46y+pObmpR+LuBSpRHfA2LU8hNeuW5so5JSy60S5RqxLUlKIxcYKteIbT5SGrlVk1wjsc1IKU0EqGr16jqTZAElR4BvHZIWhA2cVbQwuklItjG7cpJrpbYDKb2phYxOM77xx+nmlxRy7egWH6WYDSxW9GxuM4/s2pLFhBwDsW1HaU/M5pV6Va2dnlnLtVNbcZTu1PyW1yzYdCOdBRecLf9eZnuN0iyY38rnP/xGGglBFMjNoxhMdJ9/6x5sXV03t3ebZecdvrZ/jsCgUrNMd+mSRTNeHD61eFvvD0f1Fz6Js0nmoCpUN0E4CI1HPldBMOfs2No8q2bfrH7u/lQgA/nmwBVPPpbbn5bb1UYFaphpWm8Ck3ktgG+za/+4/DIBQZ9Ltv+e7C/DN/P+65AwJCOJWYwIXqrsqbwRZGIoUA/GE7p1z8RzKCSdjgCR6HDib++fR++OOx+b7QF974aAgGdF6kRy5aa4mmj7QHUV1DbMgoUZqWyzqUYp25TDEXpqhe5t15TX54TnGbcpBZOeLme/8ZwenkSr7ewTUEu7ebpmk95wCiLKPiXhIKaK7e+TseEDUYhPNyaF/TA6/99p+WW5T/lRSnCWYckWLrwygPgOpXPlkeh8rACTpCvzkBIeV1svErPEA5rV/2qrkLZPiS6m9sbTGhe1BZIGVtkBSaMPbMDH4/K4vkmMf0xolrFPFiwa9yh2om8feykFhEEWyYifgkZb309GGWdAJhxETFslnbsGAWEJafUJK6jXjQ7UlH7VIE1iigNur2HnDeGjp59VUcmnTN3rkBHREpd5SubLHsSZnjIGuvCh1MFueiwhjzY9Tin5ySgX3jsAbP7b3g9fh0X0d+n67+qqWlTqE5CD/yIPNqFa/EFPQA6VaqwqQ59/vb27R0OJETF5xba+o5194NFCVMFPBpn4jxsilzobCQDU3SgADJx6wp1fwJFPWE2jhvFcJzXP/O4sRzXDevNsZzWTmyJxxOeXhj4jsijRQSYoJT0g1T3PNXKAjyUPk9ki7eB81Pv3b14/f3b9+t3Pn//t47ufH4r9vtyvl79sunNSQGRK0W9eSErvpaYoePf8+uX154/XH14+e5vQMhSdourj+2cf/vrm86f3L55dv0zoimSnKPv3z3//+98/v3r34e3nTx/evPz5+bsXL18klKJ5pMqvX/779eefrt++QZQ8pKkKe/vsw19evPs71vhRuqrQny1V3M9WVdD1pw/Xb7BmHKRKC3z98/XLDz8/e/P52Rus+obJ6iL/+unZi49coV5AXezLDx/efeCK9QLSYl+8fPXs05vrz88/fbx+9/bz9X+8f4lhxsSmH5ATlJs6K4fips6P3GwmqL4K2eTqE4foljf7aShoDmECitvmuJwCo893Do6BW/zSHG++vVgel8PAx0e3OEyWe9rDXZu3ud7R5Y5kpIWHJ1f+3GzbacbNy+/tV7+8XR/bafHzLiOiic8w9ZysqvwnCZnEAEvkTtQIvn5CxLFVBiImXz8tV6s368OxK0JT9pM4H14nGH59YL4EQqp1sDKGX0BUzuB6dwkgcJ37/2BV7LaCU1dY7t2W/vYbLYYbVQPM+/03jeB4Cl4DN4mD3JPGxyjrH1IvMYqHI0u6GgKfQvWXL190Tebl/5je8uWL4Ggm2lla0GxfebbZnCoKpaQSLQWy/4F9ZohEcL6P7jfRJxF1t5lUZZs/uqY2sILoE59YGZtUteyXv03sTHHGP6YbDTAIzkqiHWj4GdSp6FZWhavP8IfUSac7fcsBlt2jToye+B13TQcev+T+B4wiDyJ9GQI3ksJ3ENV0t2/umu202e447x9SVQCG4BIUrCj4MXx9vWvnR+fUGcj/R9bbEIrgRhWm7qKPoixTl6/bVtXZ7ijbH2OlHhCkb+tAbdXjF6DswPrw5/vlfjV4QXZwzf8pTUo1fO3EPx7b5fUtUtwgVbVxDgGG/XIltON+uT182e1v/3q/OzarsOuMsR+44HS+UFTyEyItsZImchHfSs6VD/gdeJPxXj0UOQPs5PVed5t2BN1G287zfENU8EW+ZNA/D3eb9fHZdvV80yyxJzeidGmnb3EemvfLffvXcThtfSwWSKgKfnZz09xhHWeQOqHA59+6fyfK7YUmFP9ye7NbDcNZ0PJPUhMUvFluW0v3FbMAiNQEBS+Wx+Z6fZtQcJKSKliuVj81y9VgXvFY7EOaCu3zENhxjVtDKKIq+tVu/xvltWIBVbFv1ttfyUoAEtKCb5fHm2/N4dn98dtuv/5v/9Dkx/YXtP1oYam6b8sDWfpDmji2bFzPgzmLrI7jAHD0Dri4oCe/0PcWPOKhzn7u0Hkx0PCFiW1Nqvi2O6ALO6CjF5uopAvU3gm0nOTkaqKueYf2Qf6Gm+FW2HpzRMdKSBDvUO22N0vM4IcEOZotZg+6n+Ubcav7GzzYpUuQFnPwofjPDj+2N2+bPeoKoIjYTHc5rnf+NmHMUg+SpUVu24mKf6CcCSMayUgL/6/desuUO0wWV8Evh93mno16giLSopvt4X7fXO+X603r/D+20ljpiJR8GbK+jTI2+Kx1JKX7gjeti0p+wFBIg3+Yj4QfC4kXkM3x4QALtoIcJIsR754vt7vt+ma5+bRfE/1lLCQtftW0E8Wmz/R8d3u32xJLEUJS3rBSRYSkVNH60M3KutPge6K2gMSEgh9ve+eLf5QTV9Pv7eLr5kjOgaL0OVb14wKfxD8l1vCxcAyfOi4m/zgUy9VDAWpIydX4AfPjUlx99hlQxTblQ7Npp9Lfo7OHkVUZCOjCaj7e/7La3bZ99UPztfkdm06hcgp7+Ha3ut80H3Y74pmCx3TxisTnIMb2Y6IieGm3+d685UodySgLf9YKHfmyH0Q04c3vlze/tovwfzug7gZISMMSH6vwfccgfdtthgvKx7g1VE4zr8K7c58it8rv97vb9QGzJw9pyubqc73bx89DjNoslhMv1UOujzucAnlMFU8oN5tX95t2zbJBCYVhsoq4Jqoh8NfTvv3QtL2nm4f/9X65wpx/LKBiP6giHxOlxd1v1/+8J8sbpIoncc3+9nr3eovS1Kc0noYYnNJ55Ven7cBr/zt+Xz5KneWMzrhE0SnbGCY1F7iPX4ZhdD6KnqHvrl0Jt9Nk5DwvonEofIbOnfgTdxO/cNA5PrTT9P3qHa5ymDhL1xgVKOoZEUaKzf3Q2tj7/U3ztjkuV8tB5HTE60Ip8RC/a6Ub/xzKulm9WKJHhMZCCjb6dLaIxw+lxNO3Tbsq+tC0PfTQ1qknWrHJ21hKTtS0pridWC5X7WpmtY6f7BkSNmMxMT37cbO+acKOKnwUaHiZ9khKTtgejss9/uQMXuiTUwa84yKAqQ37Lf4qCqE2iJ+rNLqeUvKx3A2VvNrhTRCPgiP7MEibxd7A8mTXPQwAUjXnjUha3YPcoybutiSB5n3TLas6qunX9fjK4BEAKD4/jm4sK3D04ufgiA6nfn7YfE6DiGQ1bR9p/GW9Xe5/eMG0ylh4tq8Ojl+IIRaeDcPNt+bm15dbQeMPJM/RDhaz3aryegcua4hXs0MRzTo55KMm9EBCU3C3riYDhmIBBWfysf28TfP62KBhSMN08QJpfedPcG+wTZfHRHU0ElkmkFBFYDV9lNWrdomJVQCUkVPQq3dfyNYapIonMH7/6/r0qcwcBhWUT2PGNlFU9pO0fcS/QB8AKAGRjlbGS3n8CmrXfHN/QK8jYVCd8vxh1eIBpNh1PH/ATsdhPd/d3i4/Nm0pyyNKCSFSYgZnuW1n+f/dUc3vh3PrQeGxhJzI+9tys16Nrhca0nmRhLxgnGj0v4tJ58P17sX9nlpoDZPluK6bPWaJQoJ8g7CrjBVR1iBVXmBYmZMlPibLi3zjr6THmuEhTV7Y+xMvQ0KMJOTk5LHzVq+74fsdxQokdHstf9vdLH+53yz3mL+EIor9wtZxsUVDERUHjJQc+N+J5XUWYb3ckMWO0ieifdP+a0NC9qkTS8bIcJA6seSoN8OCkx15eCXKc+xCjfZXeQHv0QLeiwvALrJ4Jr5w49mn65+wAtqfpUW8eI4U8OK5NPurd89eIQV0P0uL+An7hJ/EH/DT9TXWCN3P0iJeP/v5GVJE97O0iO6Goc9vsDt0+hRpQW9eYF/T/iot4C32KW/FH/Lzu+vXr/4DKSIkSIt59xrtWN3P0iLev8buXGp/FRfw7uPrf8eK6H6XFvLhBda/218VBWCDvPtZWsTHd29eY13L/64q5DNqcE5JuqKoS34GqRMK/Hz98gPW7lBEVzRhJB4TdcW9fXmNjbLHRGlxf3v2M3aDVfezuIjnzz5gncP/Li3k3z9iRbS/Sgt4/u7n65c/X39+8/LnP6M+KRaYVizVNxAprYLuPiCm5C55SpEpxA8yYpv24eWrdhC8fPG5+xdu3oDI1KIp7KgcpuQ/n7ZL/FXz+7/8n//3L9+bvQ/2/D//Yq7sVd1Kflk3m1Ur+I+gv83arrO71fx/9ml/a7rdik4iiPxp8S9P/7F4Wi2u8ir7z/98+o9TDp/gf/BiWftX9tS4qyKvI7EsEjPtX+apza+KOo/ETCRm27/s0zK/cqWNxGwk5tq/3FNTXZUuLs1FYnn7V/7U1FeLqozE8kisaP8qMLEiEivbv8qnRdlWSBWJlZFY1f5VPbWLK1u4SKyKxNpG+UeNVW8dV++CKi4D7eAbYvG0yK4yY2LJuCm6+3P+kWWY7ixujcySyuP26C6k+Udm0CLjJsm6qs/QJs7iVumOfBPK43bJuvrPHKo8bpruJPQ/svxp4a4caOosbp2sJrt13D7dfQ94VzRx+5iM6owGjBRDdUcTt47p2iArsO82cfMYR32NiVvH+NYpsdYxceuYghqpJm4dU5IjP24cU5E1GbeNqcmajNvGLqiatHHbWD92Kqwmbdw41lA1aYEhsxRIG7eNJW2ZjdvG5uTXxE1juwbIUNti47axJfk1cdvYrgXMAjN+Nm4c2zWBQY2LjVvHdW1gzNPCtAYr7kIubh6XkeY+bh1nqEp3ceu4rg2Mxb7HAU/jqFp3cfO4rhEMaoVc3D6uoGrdxc3jSI/j4uZxFTXGXNw6jhw6Lm6cnDRredw2eUbVTx63Te5nADlWP3ncOLml6ieP2yZ31GfnYB6Qk18TN01ekDOGuGnykvzsuGly3zQFZijzuG1y0uXkcdsUZNsUcdsUpMsp4rYpSJdTxE1T+HFTYo1YxG1T+Lapnpbt6F7EnbeIG6fwA6fGaqgA87SCGg9F3DpF1wYWnbwWcfMUFVXpRdw6BTlyirh1SrJ1yrh1SnLklHHrlF0bWNSklnHzlOTIKePWKR31NWXcOCU5csq4bUpyEl2CWbRvG3SqWMZtU5JtU8ZtU5JtU8ZtU3UtYC2mu4obp+qawKLWvIpbpzJUDVVx41SWqqEqbpyqawKLWsoqbp2qawOLzgCruHkqP11DB24Vt0/l2wedC1VgoUO2TxW3T9W1gq2fuuKqgEXGDVT7wYMuYuq4gWpyTlDH7VOTc4I6bp+abJ86bp/az9jQ8VjH7VPnVA3VcfPUBVlDddw8dUnXUNw8tZ9Pm6d5eVXV8QKqBkvRmqxLuBhdUJUZkoaipHkLSUNRP4TQYRnShrKkiQtJQ1FHVlVIG8p6O+cwdxXShrJ0Y4W0oWxJVW1IGopWdN2CxemipusWtJhnCVyOOc1sxCDQXA6kEDLS6mWQQ8jIlVAGWYSMnGxnkEbwZIFDTV8GiYSMnHBnkErI6OGVQTIhIxesGWQTMtJDZYBPyAy5aM0Ao5B54sChRj0zkPMhF64ZoBUyTx4QdQCIhcyQq9cMUAuZIdm4DHALmSEnExlgFzJPIjjUXWWAYMgCw4AujDPAMWSBZECnkBmgGTLPJuQ4oQaYhszzCXlrldvZbg7GI+AaMk8p5Papq6+MKYAsZOr8KMNJMMA4ZJ5YyHOUgwOkQ+a5hRwfZ4B3yDy7kOP9ETAPGU09ZIB7yDzDQPRHwD5klnRlGaAfMkf7MsA/ZJ5myPFOBiiILHAQeCcDLETmuYZigTaEgwyrt414JwNUROYJh4KgY0Gjec6hwJ0v4CMyTzsUeCcDlETmmQd8DANSIvPcQ4FOeDPAS2SefsD7DWAmMk9AoPRABriJzDMQBd7LATuReRKiwHs5ICgyz0Pgc7Ash8Q4bR8BS5F5MqLA+yMgKrLAVOD9EXAVmWckStzoAbYi86REifdHQFhknpco8f4IOIusICf2GWAtMpq2yABvkXl2osR7OWAuMs9PlHgvB9xF5hmKEu+6BdzP8PQF3skAgZF5mqLEOxmgMDLPVJR4bwAsRlbQ+xqAx8g8XUF4CUBlZCXJNGWAzMhKeuYI2IysJFdkGeAzMk9blHgvB5RG5pkLlEbKAKmRee6iwg10CXehumap8AEBmI3MExiVwTGAJivpJgP0RlaR3FMG+I2solsMEBxZRQ8zQHFknsmo8GEGWI6sIjelMkBzZJ7MwC054Dkyz2ZU+EIOMB2Z5zMqfG0EuI6soldngO3IPKdR4eMc8B2ZZzUqfJwDxiOjKY8McB5ZTTcZYD0yT25UuPUAxEdW000GmI+sppsMcB+ZZziqGtsIygD7kXmOo8YHJOA/Ms9y1BnavIAByWp6gQY4EOOJjtpgPcwAEsR4pqNGx4MBLIhZkIbRABLELEjDaAAJYjzRUaPOzAASxCxIusoADsR4ngPf1QUUiPE8Bz4iDeBAzILmrAwgQcyC3gYGJIjxREeNemkDSBDjmY4a31UHLIjxVEeNjl4DaBDjuY4aHWcG8CAmI1fVBvAgJiN3hQ2gQYznOmrURxrAg5iMXJ4ZQIOYjNx8NIAGMSGqYrF4mrur2hogDBrNsx3ZAnWoBgZXMNEVo/AKz4Qs0NmogSEWIcZigY9gGGVBkyEGxlkYutlgoIVnPLIFPoRhsIWh2w2GWxi63WDAhSc88BW4AWSIseSy2gAuxISwiwU+LgEZYkLkxYIId4GRMaHZ8JEJ6BBDR2AYwIYYOgbDADLEhCiMBT7gARtiLLnTbwAbYjzjgU9JDWBDjA3jrcYCngzgQ4wjV9YG8CGGDsgwgA4xdEiGAWyIcbRXA2SI8YRHlqErVQPYEONotwbIEOMJDzzOxQAyxHjCI8Pj6AxgQ4ynPDI8Qs4APsR4zgOPjDGADzF0oIYBfIjJaRsJ+BATgjXQ+BgD+BCT080G6BCTh2bDrSngQ0xONxvgQ0xOz0YAHWJyZjYC6BDjKQ98smkAHWJyejYC2BDjGY8MD1g0gA4xnvPIMtxGAkLEFPQUEhAipqBbDfAhpgithlteQIiYgm41wIeYgm41QIeYIow13J4DPsQUNF9sAB9iAh+Ch/4ZwIiYENqBz04BI2I87YHH/RhAiZiStpGAEjEhwgMP7jOAFDFliMrFrSRgRYynPjI8cs8AXsR47qOtXFwYBoD6xjP4qAfMiAlBH3gcnQHUiClJtt8AasRU5LaaAdSI8fxHhoeqGUCOGM+AZG1DF/lVnQGDAugRU5Hx1AawIyawI6bEywVt50kQolzQclVouQovF7RcIEjwcmHwbmi3Gi8XtFtgSPByQbsFggTlaAwgSIxnQTK7QI07oEiM50FwDIAiMZ4GyWyGlwsazhMhRLmg2UJ4iMWpBMCSmJoMhzeAJDGeCMmsxcsFDVeT5xUMIEmMZ0Kovg5oErsgDy5YwJLYRUb3dQtoErsg280CmsSGWBG8r1tAlNgF2W4W8CQ28CR4X7eAKbELst0sYErsIrQbavssoErsgoy+soApsZ4Owf2WBVSJ9XRIZlHa3wKuxIaAEVtgHc0CssSGYyd4DJoFbInNwpAjQvJB0/WnT9B+aQFhYsMBFKKzAcrEZoy1tIAzsYEzIboFYE1sOIqC2yoLeBMbeBPcAFnAm9jAm+BWxQLexJqMNhUWMCc2MCcWP1kAmBNryEAtC3gTG46nOHSeYgFzYj09QnRmQJ1YQ4ZzW0CcWEMGallAnFhD7mxbQJxYUzOjCZ5WseQC3MLzKpZcgFt4YMWSk0s7OrJCrgksPLRiQ5Ph5zzgwRVLrgksPLoSWJOueesrW0Jh0GaeGiE+DbSZJWO1LDzAYsngOgsoExsoEzxy0QLSxDoyus4C0sR6ZiTrwhGRbgNoE+ssY/0AcWIdM620gDixgTghrB+gTmw41UJYP8Cd2MCdOHxcAO7EBu4Ej/WzgDuxjtwttYA6sSGUhKhlQJ7YnJlbWkCf2Nww9hrwJzYcdyHsNWBQbGBQCHsNGBQbGBSilgGHYvOC6UaARbF5yXQjQKPYvGK6EeBRbDgFQ3QjwKTYwKTgEZAWMCm2oMcf4FFsEcYfPvsATIotuPEHuBRbcOMPcCm24MYfYFNswY0/wKfYwKfgoZAW8Cm2IFcIFtApNtAp+QIHAVrPUyZZnj0t7JWxwCoDPsWW3FQTECq2pE9pAkLFes4EdwyATrH0oRkLyBRb0mc1AZViA5WSo1SKBVSKDVRKbp8W9VVeQ7yg3QKVkrun+eLKjeoBtFyIMunCfbD6BS1X0TMVQKbYip6pACrFVvRMBRAplj5LYwGRYgORgkewWkCk2IqeqQAixXquhPgw0GoVPU8BNIoNNAoeQ2sBjWJpGsUCGsXWYazhFg3wKDbwKHgMqwU8ivVkSVbgjhEwKTYwKXgUqwVMig3RJngYqwVcig1cCh7HagGXYmsyvtwCLsUGLgWPebWAS7E1vSYHXIr1dAlKflvApDj60I0DTIpb0CelAY/iFmSIkAM8igs8Ch6g6wCP4hZkjJADPIpbkDFCDrAobkGONgdYFLcgR5sDHIpbkCs5BzgU53mSDA8RdoBEcRlpHx2gUFxGBik7QKC4QKAUJXpiHhAojj514wB94gJ9gocTO0CfuECf4PHEDtAnLqNbDZAnLiMPVDtAnbhAnZSoxXGAOnH0RR4OECeOvsrDAdrE0eEmDpAmjr7OwwHKxAXKBI+pdoA0cYYOLXeAM3H9tR4GWwg4QJq4EG+C3gHiAGvi6HATB1gTZ+jQLgdoExdoEwovaDY64MQB2sTRtIkDtImzdLMB2sSFYJPSYlEWDhAnztLmEdAmzpJnrx2gTZwliS4HSBNn6YEGSBNnw0DD77QAtImz9ECDF38E2gSPmnfw7g9HDzV4+4cjt78dvP+DjjVxowtAfIvhcfsOXgJCx5o4eAuII7e/HbwHxNEuDd4E4kiiy8G7QBxJdDlAlbhAleDnERygSlxOLrQdIEpcTl/YAmgSl5MLNQdIEpfTd7YAisQFigQ/POEAReJy+uIWQJC4QJCU6K0WDhAkLidjyx2gR1xO7ng7QI64gtzxdoAacYEaqVAC3gFyxBXk4toBasSF60LQLg6IEReIkSpDKwwQI64gj0o5QIu4gp6CAFLEFbRlBJSIC9eGVOjSxAFSxNFnbhygRFygRCp0fe8AJeICJVLh5hlQIi5QIhVucwEp4kKUCX6EwQFaxIUoE/wMgwPEiAtRJhV6L4wD1Igr6fEGiBFXkts3DtAirqRHGyBFXElbSECJuECJVPi8GJAirqItJCBFXEVenOgAKeIqesoPSBEXSJEaH/CAFHEVPQ8BpIiryIW1A6SI88xHVuOTXUCLOPqqEQdIEVeRC2sHSBFX0zNHQIk4+uyNA4SIo8/eOECHuECH1LgZAXSIow/fOECGuJq2j4AKcTVtHwEV4mraPgIixAUipMbtGKBCXE3bR0CF5AvmWjJwL9mCnDfmgArJaSokB1RIHqgQ/DxNDqiQnKZCckCF5Av6qlJAheQ0FZIDKiRf0LeUASokD+Ek+BmZHJAh+YK+qgxQIbnnO/CI6hxwIXngQtC45xyQITl9AUkOqJCcpkJyQIXknu3A455zwITk9MmbHPAgeQgjwQ8V5YAJyUMYCb6czAEXkmfMQMsBF5IHLgR3vjlgQ/IQRoKzLDngQ/IQRoLvHuSAEclDGAl+bCoHnEhOh5HkgBHJQxgJUXGAEskDJUJUHKBE8kCJEBUHOJE8cCJUxYH2MxVXcaD96ItPc0CK5JY2lIAUyS19gyMgRfJwBqfG6wHQIrllrnEELUefwMkBKZJb2lACUiS35GQkB6RIHm4jwc/G5YAWyS05GckBKZKH21DDgTcHDrzlgBbJHd1mgBTJaVIkB6RI7mjnBkiRPNyKip+4ywEtkjvauQFSJA9XoxK1AGiRPMSR4Cx3DoiR3JHT/hwQI7kjp/05IEZymhjJ4TWpeXBv6Awuh1el0sRIDi9LDQdwiCqD96WGCBKiyuCdqTk91ka3ptJjDd6bmtNjDd6c6tkPgx+pzOHtqeH61IVDzTS8QDUPoy3HAgpyQI/kBblHkwN6JKevJMkBOZIXJKGVA3Ikp0/g5IAcycNlqvjZxxyQIzl9AicH5EhOn8DJATmSFyXTIQE9khckCZkDciSn71XNATmSlyShlQNqJA+nb/DznzmgRnI6WiQHxEhekoRWDmiRvHRMhQFaJKevWc0BKZKX9BXFgBTJS+aSYtBiZRhnKA+aA1okp28kyQEtknvmA68wQIrkVcZUGKBF8kCLLNBopxwQI3lFUsc5IEbyiozxyQEtklf0/B/QIrnnPgx+XDUHxEhekXtqOaBF8kCL4NGyOSBGcs9+UDNeQI3knv8wGXp5Rg7IkZwmR3JAjuT0baw5IEdy+j7WHFAjuec/DH66NgfkSB5uJsEPoeaAHsnr0HL4eh8QJLlnQUyG+x9AkeSBIsFDuXJAkeQhWiRDYwxzQJIUC9KzFYAkKeh4kQKQJMWCbLkCkCQFfT1JASiSYhFaDr9RHJAkBX0/SQFIkoImSQpAkhR0vEgBSJKCjhcpAEVSLEKLoQa1ACRJQceLFIAjKeh4kQJQJIXnQYhOUwCSpPBMCDHgC0CTFBlpJQvAkhQZ6dkKwJIUGf0OD+BIiiyMNHS9VgCOpMjoO94BQ1Jk4eQ9fnM8YEgKEx6wQJdLBWBICk+CoLF6BeBHCk+BmI4HG/MYBeBHCk+CGPxwbQEYksKTIAY/XFsAhqSg72stAD9SeArE4CdmC8CPFOFBGINOZgvAjxThkhLixQHAjxQmtB4+5gBDUtjQengXAhxJ4YkQQ7woAFiSwpLUZAE4koI+cVMAjqSwgZrEextgSQr6xE0BWJLCkmuAArAkhaXvSysASVKEF2Pwe/4LQJMUgSbBL+YvAE1S0Pe2FoAmKeh7SgpAkxQ0TVIAmqToH4/BRxGgSQqaJikATVIEmgQ/LFYAmqRw5DKgACRJQZMkBSBJCvrS1gKQJEW4pAR/fKAANElB39paAJKkoG8pKQBJUuT0QAMUSUFfUlIAgqQIr8rg51QLQJEU9CUlBaBIihA9goeEFIAkKXJ6UgIokiInF9sFIEiKnCS2CvjGjOdADH4At4DvzNBHawr40kyIHsHjPAr42gwdP1LA52YKekoC35sp6CnJ6MEZekoCn5wJBAl+OLaAr84wz87Ad2c8C2Lww7EFoEiKkraNgCIpSto2AoKkKGnbCAiSIhAk+LnQAlAkRaBI2uUrsgQqAEVShMgR/DRLAUiSwjMhxqHv0xWAJilKcsFdAJqkKOmxBkiSgn6UpgAkSUHfTVIAkqQIJInDfQ8gSYqKJLYKQJEUdOxIASiSoiIJ5AJQJAVNkRSAIikCReLwKSSgSAqaIikARVJU5C13BSBIiopuMUCPFDX9BBcgR4qa3F4rADlSeAbE4AddC0CPFDW5vVYAeqSoyXfSCkCOFJ7/wO9MLQA3UgRuxKGR4gXgRoqadmiAGSlqepABXqSoaYcGWJHSUx8GP9NZAl6kXJAOrQS8SEnzIiXgRcpFMI6oiygBM1IGZgR/gaIEzEi5oJ/pAsxIuaAf6gLMSOnpD4M/bFECbqSk7yMpATdSBm4kR088l4AbKTPSpZWAGykz0qWVgBspM9KllYAZKQMzkqOLkxIwI2VGTvdLwIyUnv4wrUNz1VU7nQHCoNVCBAnu/UrAjpSBHclzbD+wBOxIGa5vxc9HloAfKenTNCVgR8rAjhCfB9iRso8fwT8P8CNl4EeIzwP8SBn4EfxAZQn4kZJ+J7cE7EhpuNYD/EhpuNYD/EhpuNYD/EgZ+BH8XGcJ+JHS0K0H2JHScq0H2JHScq0H2JHScq0H+JHShtbDLSZgSEr6aE0J+JHSkicPS8CPlJaZSpaAISktudQuAUFSWjIeoQT0SEnfSFICcqQMj+oW6AH8EtAjJX0jSQnokZI+WlMCeqR05FSyBORIST+uWwJypAzkCH5yuATkSEm/sFsCcqR03GgD9EjpmBP1JSBIykCQFOjqpgQESRniSAp0N6gEFEkZHrbBCeISkCRluIuEwAxokjK3TG0AoqQMRAnxgYAoKfOc+0DQfoEqwa+RKAFVUoajNtQHghYM8STUB4IWzLkWBIRJWXAtCAiTsgi3g6LLuBJQJqVnRQx+/LoElEkZKBP8nHIJSJMyxJXgbxmVgDYpwzu9+DHhEhAnZYgswY8Jl4A6KQtyOVcC4qQsyOVcCYiTsmBi70r4aK9nR0y5QIcUfLg3RJfg53RL+HivZ0gM/vhRCd/vDQdv8CtRSviGb6BP8EeNSviOr2dIDH6Ws4Rv+Qb6BD+gWY7e8/UWFD8fWcInfUOcCX6QsITP+nqexJQVXhugBUOkCU6vloBGKQONgh94KwGNUoZYE/xlnxIQKaVnS0xlnub2Kl9AYdCCni8xFXqbUwnIlDI8glP5KZmtQX8GdEoZ6JQqx2GAFvScicGPe5WAUCkDoYIf9yoBpVKGwzj46zIlIFXKEHNSobfVl4BWKT13YvATTCUgVspArOBnjUpArJSePTH4oZwSUCslfdtrCaiVMsSd4I/BlIBbKenbXkvArJThhhL8zGAJuJXSEygGP79SAnalDFEn+JmQEvArVeBX6uJpsbgyWdw9K8CvVIvQevh71IBhqRah9fAnqQHHUgWOBY/krgDHUnkaxS7QTlQBjqXyRIrFo6MrwLJU9K2vFWBZKk+k2AV62UEFWJbKUykWD56tAM9SeSrF4i+HVIBnqTyZYvHHOCrAtFSeTrGLAptGVYBrqTyhYvFgzAqwLZUnVCweiFgBtqUKbAs+9asA31L1fAs69asA31JlBT31qwDfUgW+BZ/6VYBvqTImorkCfEuVhRZEnVoFGJfKkyo2Q98rqADjUnlSxWboFYUVYFwqw9zxVAHGpfKkisWD8SrAuFSeVrF4MF4FOJfKkJutFWBcKkNGNVSAb6lMyfRlwLdUnlKxGfp+RAX4lsqQh/UrwLdU9CUmFWBbKhtaDh+ogG2p6GtMKsC1VDa0GzoLqADXUtFcSwW4lormWirAtVSeTrFZifoQwLVUnlCxWYW981ABtqWyod1wtwD4lsqSG0EV4FsqT6lYPGCsAnxL5UkViweMVYBxqWjGpQKMS0VfZlIBxqXytIrFH26oAOdS0ZeZVIBxqTytYg06k60A51J5WsUahy3vK8C5VJ5WsaadybbNbOHngZbztIrFY8sqwLlUeWg73C8BzqXKQ9tVqHEFnEvlaRVrcLMNOJfK0yoWjy2rAOdSeVrF4jfLVoBzqTytYvGbZSvAuVSBc8HfZqsA51J5WsValBStAOdSeVrFWtxmAs6l8rSKtWgMdQU4l6pYMH0DcC6Vp1WsLVDHCziXKnAueDhsBTiXKnAueKBtBTiXqudcUG6rApxLVYQWxLso4FyqgmQ9K8C4VCFYBbXJgHGpiorpcYBzqYrQevgoAZxL5WkVqnsCzqUKl50Q3RNwLpWnVajuCTiXqrRM9wScS1U6pnsCzqXytArVPQHnUnlaheqegHOpAudCdE/AuVSBcyG6J+BcqsC5EN0TcC5VFVoQ96qAc6k8rWIdPj0FnEvlaRWLxxFVgHOpPK1iHe7UAOdSeVrF4ne2V4BzqTytYvFwmwpwLpWnVSwewlIBzqXytIrFYz0qwLlUnlax+D3XFeBcKk+rWDzQoQKcS+VpFYuHJFSAc6k8rWLxkIQKcC5VbZgZAeBcqtoynR9wLlXtuJJBC9Y544oB61LRrEsFWJeqLpn5AGBdKvqNnQpwLlVdM+YWcC41fdKnBoxLTZ/0qQHfUtMRLTVgW2r6pE8NuJY6cC04tV0DrqUOXAtuK2rAtdQ011IDrqUOXAt+2XYNuJY6cC144EcNuJY6cC05ailqwLXUgWvJUUtRA66lDlwLHqBRA66lzsjXkWrAtNSBacnR8K0aMC11FloPXWzVgGmpPZnSVnLeFpxXQBY0XkY3HqBZ6iw0HjqUa0Cz1J5JsQXegwDNUgeaBd9crgHNUhvyYasakCx1IFmIKgYkS+15FItfd10DkqWmr0WpAcVSGzL6rwYES22YCUsNKJba8yi2QC/LqQHJUhsy/K8GFEvtWRSi9wCGpTY10yUAx1J7IoXqEoBlqemrYmvAsdQ0x1IDjqUOHAu+71sDjqWmOZYacCy15RoOsCx1YFkK9JxJDViWOrAsRfE0L66KBRj4gGWpw6EffIuqBixLbcOgwwcH4FnqcOjHPnX1lTFFLAtoljrQLPhGdQ1oltqRMdI1oFlqR55GqAHNUgeaBd/+rgHNUjuu8QDRUgeipduoHs+UakC01IFowTeqa0C01IFoKVHKuwZESx2IlhKlvGtAtNSeSyFGNOBZ6hDbgu+f1oBnqcMtKUR/AzxLHXiW0mE8bw14ljrwLGWOfh/gWeoQ24JvttaAZ6nz0IDoVLcGPEsdjgHh3R7QLHWgWcqyQ7EooDBov0Cz4Pfe1oBmqQPNUuK9GdAsdaBZ8K31GtAstWdSCA63BjRLXVjGFAGapS7IjdkakCx1wWys14BkqQt6vgJIlrooGQMHaJaafmSnBiRLHa5MwTsF4Fjqkp6sAIalLkPD4cYCMCx1YFjwC3BrwLDUgWEhLAtgWOqSbjjAr9SBXyFGNOBX6sCvEMMD8Ct14FcIKwT4lbrkvB7gV+rArxC2AvArdcUYTkCv1J5BIXoFYFfqwK4Q1huwK3VgVwhTCNiVOrArhHUD7Eod2JUKX2ABdqUO7Ap+23EN2JU6sCv4bcc1YFfqwK7g4S81YFfqwK7g4S81YFfqml6fA26lDtxKVaF9GXArdeBWukgZTBi0X+BW8EiZGnArNX3JbA2YlTowK3WGXT5TA2al9vRJOzgwWqMG3Epdk+x0DZiVug5rdNyBAG6lDtwK4W0At5It6Gd3+rRI2DdfjXJSfWokTm7u9WmRMEmy9GmRsB+AeIBPnxqJh0ZEB0qfGomT3q9Pi4T9IKwLzP/1qZG4b8oavcWuT43EfWPWKAHXpw7FwxUrC6zp+8RIOjQnOuPpUyNxchHRp0XC5DKiT4uEA9eJrg361EjcNye+Ju9TI3HyEoE+LRIuaTfXp0bi/hTfAl1t96mRuI+VWGSY4+hTh+KG9ox9YiRN+8Y+MZJmBqeBrWmYwWlga4Y3e/DbIvvUSNyf6sODvfrUSNzfeYSHe/WpkTgZdd2nRcIV7Z761Ei8ph1UnzoUD7fV4rFnfWokHuKv0WDtPjUSN5wdsrBFw721hKWwsEmt46yWhU0aiBrKalnYpIGqwbcb+9RInB2iFjaqJdccfVokXHPj2cImdeTCo0+LhDNu8DvYoI4kufu0SNgylsLB5nTk6qNPi4Rzxqw42JaO8Z0OtmS4swW/8bNPjcTJw7d9WiRMvpDQpw2FQ5AMHpLVp0biGddhc9iSIVAGX8H1qZG4v8hxUeJjM4eNGUic+qkrropRHeawNfNgbSu8E+awOfNgbWtCHDaoZ2tchvJ2fWok7r1nRoyIHDZpeBYoQ1fYfepQ3HM2LkPXf31qJO6HJ34JYp8aiTOzoQI2aSB1qP5VwCYtmPiLPjUS922aoVdW9amReMF0mAI2aRGalBijBWxS+s6XPi0SZsZoAZuzD6QhKqWEzRlufule+MPWKiVszpLcDu7TImHyqtU+LRImj3/2aZFwaEqUsexTI3EyGKpPi4TJBWefFglXXI8tYUuWTEBbnzoUrxZc41SwLUNQDb4I71MjcaYtK9iW9LW5fVokzLRlBdsyvCiER+P2qZE405YVbMtA/VD1XcHWrCq2vmFr0nfE9GlDYfqWmD4tEibvienTImG/RMHDjvvUSJzcLe7TIuEQko+yJH1qJE5eE9mnRcLktax9WiRMXl/dp0XCvh3x2Oo+NRKv6ckYZIIyz/ZQc/wMckFZCLXBY6z71Eg8tCW+yssgG5Qt6LbMIBuULci9/z4tEvZrE5xL61Mj8YLpJxlkgzL6mt0+LRIOXBBOp2WQC8p6LghlF/vUoXhGj8sMUkFZRo/LDBJBWXiVCL9gtU+NxJm2hFRQRl+626dFwuSFQH1aJExeCdSnRcJ+1oPf9dqnRuL0rCeDJFAW4nDwGLE+dShuaIY2gxxQZsiAjj4tEiZDOvq0SNj7SfzQQZ8aiZMUe58WCedcjUAKKDM0oZdBAigzoSXRrYw+NRIPFhafgGWQAsrC4Sf8ft0+dShOP1jUp0XCzJiE9E8WruPFz1f0qZE4MyYh+5NZJqixT43EaV+ZQe4ns7SvzCDzk9GvOvdpkbBvSfwq4T41EievDerThsKOfPChT4uE/ZjELwnuUyNxevaaQd4nc/TsNYO0T0ZfRNOnRcLetuK3FfepkTg9e80g75M5eiWSQdYnc9xKJIO8T+ZY6wqZnywwP8TSIoPMT0bf29unRcI0xZ5B1iej7+7t0yJhT7HjlzP3qZF4aEvCm0HSJ8tpDi+DlE8WKB+L884ZpHyyQPlYfCWSQcony5lL9PrUoXhB87EZJHyyQPjgl//2qZF4sLCEqYeUT+ZJHYcHd/epkbhvUfwoSJ8aiZOHFvu0SJg8JtynRcK+PfFjJn1qJF6xnwnbk34IqU8bCpeMt4R8T1Yy3hKyPZlndBx+PKZPjcQZbwn5nqzkNjMzyPhkIbwHj1PtUyPxENaKhof1qZE4t1eSQdYnC69G41x/BkmfzNM6Dj831KcOxQPpg58c6lMjcfItiT4tEg4Nikbk9KmReBicJSEOmzRcBowfNupTI/Gw/UWspCHxk3lyx+Gnk/rUSJze0cwg8ZPRFwP3aZFwzfVcSPxkgfjBD0r1qZF4CFjGd+0zSP5k9BtKfVokzGx/ZZD7ycJNwdSggNxP5vkdl6OXufepkXjYMsE3NTLI/2Se43E5ejFKnxqJe3ubo4c++9RI3A/RHL2Ho08diJsFHYDeJ0bS9GLTQALI0M9P92mRsB+f+NGhPjUS9+MTPzzUp0bioUHRkNU+NRL3DYrfPtqnRuKhQfHhbCAJZDzN4/BbR/rUSJxephhIARmGAjKQAjIZPbU1kAIy9M3CfVok7FuzwEeEgRSQCdFAhIszkAQynujB/YSBJJAJN94QQ99AGsh4oocqG7ZkxjhPA1kgk9HcrIEckPE8j8NPTfWpkbgfmAU+vTGQBzIhFAg/r9OnRuL0bMhAHsiEq2+IkBoDmSATmCAipMZAJsiEYCD80sg+NRL3Q7PrWVXbs0bYYYMyZ7T6xEiaaVBIBJlw8zDVDyEVZCw9FzKQCjKBCiL8lYFUkPF0D1U2bM7whjXh3AykgoxlxiakgkyggghPaCAZZCwzNiEZZCznNg0kg4xl2hKSQSa8aE34WAPpIOOYtoRkkAlkEGFTIBtkHNOUkA0ynvFx+LWofWokTq84DWSDjKNXnAayQcaxoxLyQcYFh4k+z96nRuJh1wQneAzkg0xOs+0GskEmZyZAkA0yOeMyIRtkQgwQfrSuT43EabbdQDbIBDaIqm/IBpkQAkTVN+SDDP2mU58WCZOPYPRpkTB5QXifNhQOwT8lvjgxkAsygQui6gRyQSZwQdSMBnJBJnBBZYZSmAZyQSZwQdSUEHJBJoT/lITdhGyQ8YyPwy/U7VMjcXq5aSAbZOiLi/u0SLhm6xy2aGCDqDqHfJAJ8T9UnUNGyARGiKpzyAiZEAFE1TnkhEzghCgjBDkhU9I7KAYyQqYM7UnM3iAjZEry8v4+LRImX8rr0yJh3574fcp96lA8XKtDbMQbSAeZih2hkBAyFXPmsk+NxEN7EitISAiZirG3kA4yFXk1YJ8WCRfsZ8LWDHFAVMeCdJAJh8CIEAIDCSETCCGyiWCLhmt2qDqHhJCpmQUnpINMOAxGxEoYSAiZmt4XM5APMjW9L2YgG2QCG4Tf7d2nRuL0vpiBXJChj4T1aZFwxfUUyASZwARR5hMyQXbB7YtZSAXZBd2WFlJBNsQC4cey+9RInG5LC6kgu6Db0kIiyAYiCD/y3adG4nRbWkgD2QXdlhaSQHbBtaWFJJBd1MyUzEIayGZsW0IiyDJEkIVEkM3oPU4LiSCb0XucFtJA1hM9Dj9i36dG4n59gl+d16dG4t7OVugNVH1qJO69ZoX7ewupIJtxe9YWckE2cEE46WEhGWQDGYQfKO5TI3Hy/Zs+LRI2dK+FRJANRBBV5ZAKsuFcGFXlkAqy4VwYVeWQCrKGuVW3T43ES6bKIRNkDfmMUZ8WCfvRiZ/h7lOH4iEmCD/F3adG4n4eVOE7XRaSQZZ+prtPi4SZ8QmpIBuoIPyMeJ8aiYfmJIw+JIOspWMQLKSCrKd7yI4IySBruTO4FpJBNpwJqwgvAekgG+gg/CR6nxqJ03SQhXSQDff44Kf2LKSDbAgOqnEi0EJCyAZCqCYGHCSEbAgQwl966FMjccZ5QkrIMgFCFhJClrs7uU+NxH1zEmfHLSSEbL7gKhFSQjbndjktJIVsTu9yWkgK2ZzZ5bSQE7I5t8tpIStkAytU43EIFrJC1vM+xELCQlLIhiAh4nCqhbSQDbRQjW/QWUgM2XAujDhuaiE1ZAt6V8xCYsgWdFiJhbSQDbQQcaDeQlrIFvRGioWkkC3oIHcLKSHrSR/Ku0FGyHrOB38Ot0+MpGmCz0JCyBY0wWchIWQLmuCzkA6y4RFw/FWTPjUSzzibD+kgG+gg4gymhXSQLZnT1BayQdbzPTn+xkqfGol7Nog4T28hH2QDH0SZccgHWc/55MTxewsZIetZH/JLYYuG58GJw/oWUkI23AS0yLFrmfvUSJyZ2UJCyFbMRAjSQZZ+KLxPi4SZJSckg2zFjUzIBlnP91AWH5JBtqJ3xCykgmzF3OfUp0bi9I6YhUSQDZFBlC+BRJCtmSkQJIKsp3ooxwN5IFvTO2IW8kC2dpyXgkyQrenNTQt5IBuigiiXBpkgWzNNCZkgG5ggyv9BJsgyp8Is5IFciAgijug7yAM5+knxPi0SphebDrJAzjM9xMBxkAZyC8dYEgeJILcIJhZvHQeJIOfJnnyBV7iDVJALh8IW+LTAQTLI9cfCcLrGQTLILeiQWgepIMdEBDlIBDnmUJiDRJDzZE+e4f7YQSrIebqHrEJIBrlwLCzDXaaDZJDL6M1qB6kgl4U71/AQFQepIBcuaKZ6IqSCXIgKwh+K6lMjcTq+y0EmyIVLmgkkkAhy4X4g/BWqPjUSN1w3hGSQM7TLdJAKciY0Jz4vcJAKcoY+5+cgEeQMfc7PQRrIhRub8Wem+tRInD7n5yAP5ML1QPiTW33qUDxc3Ex1Q8gDufBAFtX4kAdyNgxPwo5DJsgx58McZIKcpZcmDvJAjjkd5iAL5DzTkxPn1h3kgVy4xhm/2cJBGshZem3iIAnk6NfJ+7ShcLjHmbjFwUEKyNEvlPdpkXBoyBr3bJADcv3FQIRZhhyQ8yxPThwwd5ADcuFSZ6rPQg7IhWudqT4LWSDnmZ6cOGLuIA/kXAjXI+wb5IFcCAzCX8TpU4fiOTs8IQ/kcnpO6yAL5HLmpss+NRKnJ7UO0kAuDy1KmFpIA7mc8ZyQBHI5OzwhC+RybnhCEsgxsUEOUkAuZyZBkABynuQhxjIkgJwneXLiJLiDFJBjrgVykABynuQhxzKkgFyggBwxS4UkkCvYwQlZIFewgxPSQC7QQMR5cAeJIFeEwYnvFjhIBbmCXqM4SAW5krn10kEmyLFMkINMkAsXAxEHwh1kghxzVMxBIsiVjOOENJDj3tnqUyNx5uGKPjUSp1k9B0kgx90F3adG4n5w4q8T9alD8cACWfxIoYMskAtXQuMciYM0kKuYgFoHeSDHXA7kIA/kGB7IQR7IhTNixHalg0SQq7hzCw4yQY5hghxkglxVcc0DmSDHMEEOMkGuZtsSMkGOYYIcZIJcOCFGNDxkghzDBDnIBDnP9VC9BBJBjiGCHCSCnKd6cuJaAgeJIFdzW5sOUkGuDmdQcHrMQSrI1UzggYNcUL7gbknMIReUh5ggi4ds5ZANyj3jQ+xC5JAOyj3jkxMn4HPIB+ULOmAvh2xQvqAD9nLIBeUhKIhooBxyQXnggogGyiEXlHu2h2igHFJBebghiGwg2J7ZgmsgSAflnvKhGgjyQXnG0Qc55IPyjKYPcsgG5SE0CDXLOeSCcs/34Gb5/zN2d8uy3DiWoN8lr9NkwR8ARL/BPEPbWJo6dapK1kopR1K1TU3bvPvsIBCh4BIXcm4qowTsOHs73en0zwlS0IIk1oomKyUIWpA0PjlaUIKknBQkKEHSvGwdbMximSBBCpJimSBBCJJimSBBBpJgoHEfFgpCkAQEEXgVhCDpsRbtfRQpSEHS+ZwDQQqS2CGdDJcFKUhyrWhyaSIGSY/WvA8jBTFIBt1TIWNHcnS0d18WpCDJlaKvj2GCEiSDD4EEJUgGX71LUIIkJIgsHSFoQRIWNO8TMQQtSDb3yLy/BhXEINngI/NeICbIQVJwkCAHSXAQWSdBkIOk4CBBDpJZNSZqkMzYDfE+Q1tQg2RWiyQKapBMzrSCFiSTL+IlKEEy+cJPgg4k4UBknQlBB5LJxV1QgSTKw4h4CCqQxHJBz2UpbvdMdCCJ2UD3HXAzeqTzZ01BB5JwILKGhaADSUwHIuUzghIkIUFkDQtBCRLhRSiCECTCJ18KQpAEBJFFKQQpSAoKEqQgCQqS+9BdkIJkc4/ct2HN6JG+d8x43MtIBTFINvcIqWgVxCDRak0SQQySzT1y3+g1o0d6MQ5CCpJiTpAgBEmxYJAgBIkVrYkOJBatSboJdCAJByJrTAg6kGzr+TqXSTq2ZkwJkvuMfkELkpgSRNaYELQgMS2/HVtze89X5/dXeXw9WWN7ogZJLBqk5JJDDZLQoPs2tBn9TA8NIksfCGqQFHOCBDFIVnXzRAySDT7ta0RxfaJBDpJVPKQgB8nib8UEMUgWf8MpSEGyuUfIWhCCGCRRIfa4Y5AgBklUiDUyhkMOkuAgdiIiB8kmH3oiIghJgBDrElGEJLcMI10impCECZFVMgRRSJy/SBFEISlWjBYkIXFOtYIgJM4rOAU5SDwuTdIlogdpWSOm6EH64LinqEEa27PrvbtV5CAt1otWxCAt1otWxCDNvcOufYSiBumDN6SiBWmxWLSiBOmDN6QiBGnMCSJrOyhCkDb+tKnIQBrlYXp/TlZ0II15QWQlA0UH0tivnRxuhCAtIEgRgrTxPlYRgrRYLVqRgXRTj5DFBhQhSIvVohUZSIOByGOvIgNp5xO8FBlIO6/0U2Qg7fFwcu/qFSFIA4LI87ciBGlAEHn+VoQg7Rz1FBlIY73o+wbRGT3S+WBWkYF0Q0+f9z1pFBlIOx/OKiKQFqtFKyKQFqtFKxKQxmwguw+qFA1Ii9lAigako9iPSBGBdHAzUCQgHdwMFAFIi8WiFflHg3/IohiK/KPFYtGK/KPzURwQ1B+dnGYV9UeLtaIV8Ucnr+5TpB+NiUBkVQlF+tHYJIys/aCIPxr4Q5ZbUOQfjYlApOZeEYC02CdMkX+02CdMkX+0WB1IEX+0WB1IkX60WB1IEX40CsHISyRF+tFidSBF+FEpLkhkH5XigkT0USkuSEQfDfQhawQoso9KcUEi+qjy1dsV0Udjp3cy7UIRfTT2erf7DmiK6KPKX3spko8G+ZDlChTJRzfqCCmgVyQfDfK574ye0SN9X5P3vdEzeqRz9FFEHy0KwRTRR3NfMHIxIPto7gt23yxNkX3U+C6MiuijgT6kMl8RfdSK6xLJR42/lFYEH419wQhVKIKPbtJhGxQqgo8G+JACd0Xw0VgXiNTSKYKPrup2id6jsSwQ2c9QUXw0qsDIfoaK5KMx/4fsZ6hIPhrkQ/YzVEQfzQ3CyNgR2UdjaSCyn6Ei/GjAD1lXQBF+dBU3TWQf3bBDzy9kH416MHbNIftorBRNzgBUHw31uW9sn9EjvRjLovmoF1KA4qOxMhA7z9F8NDaLZzcWVB8N9SHLLSi6j8ZEILLcgqL8aMgPWeNAUX4sqsLIGgeG8mOP6iI1tB979KI7MrQfi/WByDVtqD8Wi0WTa9rQf+xRXaSGAGSP6iI1JCCLxaJJj2GIQLahR/x+jzZkICsWizZEIItVgsj5aMhA1qr7qCEDWTCQ34cLhgxkxZ5hhgpkoUDkwjN0IGuF6BlCkMVCQezcRQqyVt1KDSnIcv94cu4iBlnsH8/OXcQgCwxiZxdykMWsIHaqIwhZLBvNTnUEIQsQIuuFGIKQFRuIGXKQ9apJ0YMsVo1mpy56kEWNGFkwxFCELCYGkTkWhiJkvVoF09CEbFQl8oYqZLFaENkXw9CFLFYLIvtiGLqQxdwgduGhDFnMDvL7iMSQhmzwNyiGNGSDrzhsSEMWdWKsiRCHbFSrsxnikA0vmwhbNNYLYk2EPmThQ6yJUIhsVgtZGBqRTf48amhENrm+GwqRTS62hj5k4UN+H9MZ+pDNaM/7nl+GPmS5oxhpfhQi2wokbtfBrqERWRiR30dehkpkwl9YGyqRCa+YN1Qik1EdFVQik2qyl6ET2bYgelRQiqyQIkMpsmJ6kKEUmfAXY4ZOZDE9iKzQYyhFFtODyCIzhlZkWrQlSpFp0ZboRKZlW6IUmfJ5mIZOZMrFz1CJTPl7MUMjsq1ASnYLMDQiK/aONzQiK/aONzQii4lBZAkdQyOy2EuMrIljaES2HUjJKjeGSmTbgfRBboOoRBb7xz/uq5IYOpFtC9LH/TnRUIpsW5A+SG+FUmQWLUquH5Qii/WjyaIQhlJk24KUrPJgKEW2+GtrQyiy1apzEaHIij3kDZnIijIxQySyokzMkIhsI5C2+1tUQyKymBnEhuRIRFaUiRkCka1oS3KWIxHZKp49EYhsExD9MxGIrFg52tCHzPnCT4Y6ZM7fkRnqkMW60e2+zJGhD1kxI8hQh6yYEWRoQ1bMCDKUIStmBBm6kHlckaTzQRdaD35FLlShVWwfttCE1oNfjwtFaD14Ky70oBUrRrd7h7nQg9Yjrsh7h7nQg1axZvRCDVqhQWSwvlCDVkwJanc8WKhBa4uPkqUgFnrQ2uKjZCmIhR60YrEgsljDQg9asYEYWaxhoQetWDmarGKwUITWNh8lRfsLRWgVywUtBKEVM4NI4ftCEFqbfJQUvi8EodX4ZPeFHLRatCg5F5GDVjE3aCEGrc7nkyykoBUlYmQb9IUUtIodxBZC0NrYo6SEeCEFrc7fky2UoBWLRt/daCEErU09Ou4LWC+EoNWrKvmFELQ29fTV/yrjO3n86ZfBxswdxOSejhC0skbsWtG80IFWlIiZPb/8oX9Kx/aMdaPH/fa90IHWiBa9z/Va6EBrW48+F2q5pmObbu1RUsK50IJWTBMi+1cvtKC1tUfHvWBxoQWtqBMb92XOFlrQ2tqj4z77eqEFra09SqbkLbSgtbVHyVTChRa0Yr4QmcG3UINW7C5PZvAt9KAVHkSK4haK0CqWj17oQatYPnqhBq3tPfz3xhadXp0AqEFLHtXphRq0tvjQ8wU9aMWsIXa+oAit2GOenS8oQktmdb6gCC2R6nxBEVqFCC0UoRVzh0hN30ITWmFCk9yjUYVWLCB9vzGiCa2iZGyhCK1YPppU9C00oVWsHrTQhFaY0NeY6ObMC01oabQmGSygCi3ls6UXqtBS/rSyUIWW8nlgC01oabQkGVmgCi3lT50LVWjFzCF2AFGFVqgQKS1cqELLiicWNKFlXBAWitAyLggLPWiFB5GixYUetKzoZ1GDVmgQqXBcqEHLirEtWtCy4ppECVqruCZRglZIkJBHD5SgtYprEiVoFRK0UILW4kq7UILW4u9PFjrQCgci5ZsLHWgVW8ovdKAVDkTqJhc60Fp8xvtCB1pePKGgAi0vnlBQgdaWHhVyH0YHWsUsoYUOtJy/B1uoQMuLfhUVaDnX9oUKtDyuRnKvQQdazrV9oQOtcCAh4xJ0IH+E591lzFGC/FHZrKMFeWwlL/dRj6MGeWgQqU919CAPDyL1qY4e5OFBpD7V0YN8m88gAzxHEfJtPkqqNx1FyEOESI2iowh5iBCp93MUIQ8RIjV5jiLkjb8Nc/Qgb/xtmKMGeWgQKW9z1CCPxaPvC4U5YpDHekF6Hyc5cpAHB5H6NkcO8uAgUirmyEG+yUdJ6ZIjCHmAEKnrcQQh3+ijpOrFkYQ8SIjUhDiikAcKkZoQRxTyDT9KakIcWciDhUhNiCMLeRSMkXoCRxjyYuUgRxfyXq3R5uhC3qNN/Tr9yNGFPJaRJvPyHF3IBy9ucFQhH/xFiiMKebGVmCMJebGVmCMIeYAQqVRwBCEvJgY5cpAHB5E3GI4c5MFBZJzgyEEeHESKJhw5yIu6MUcM8lm0JFKQBwWR3fIcKciDgtYdPRwpyIOC1p3gHCnIJx/YOkKQF6sGOTKQTz4gcmQgj1WDyAx4RwjyKBtjlzFCkM9qeXdHCPJNPT2+ff7p2xGCPCDouc3fV/qf/lSEIA8IYn0KQpDH1CDWpyAEeUAQmXvuCEFerCHtyEAufOKeIwP5hh5+ELFFg4HIJHhHBvLYYJ4ec2zRgCB2zJGCvCwkc6QgV84HjhTkyh87HSHIlfOBIwP5ph5dZKyNEOQxPcjv26g7UpArn4DgSEEeFEQmvztSkBcU5EhBHhOE2J+JFORW3DcRgtyK+yZCkFtx30QI8oAg8lTmSEFuxXWJEOTGSc8RgrxYPdqRgbzYVN6RgTymBJG6AUcI8mJKkCMEeUAQ2VPcEYK8mBLkCEFeQJAjBHkxJcgRgjwgiExHd6QgX8VIFiHIl1VdGlKQr2rnTUcK8oKCHCnICwpypCAvKMiRgjwoiExDd6Qg92rNREcM8sAgMlnckYM8OIhMFncEIQ8QIluUOZKQBwk5uXEjCXlBQo4k5M4nYDqA0Ncd+8EPYkaP9MYPYkaP9M4PYkaP9MEPYkaPdDqazdiRTEezGTuS6Wg2Y0dytOV1MJPRI522ZcaOZNqWGftMDga6z6HO6JG+23Jcl8zM6JH+bC27T7nO6JE+dvp1UJDRI71oy4ZtGRJ0n02Z0SOd3jEzdiTTl2AZO5LX/iOvN8GMHul05JOxz+StPPa43gQzeqQX98yMHunRmtdFLTN6pEdrXrvmjB7pxdTojB7psr/9KkwZPdJ1p187z4we6bbT170T6tim23muQ9+MHcnF9dmxRcej+kUGtuigy7Jl7EjeTPssnftzHUJGj3S66ULGjuS5f+/r4COjRzrddSFjR/Juy2fh5PWYYFsO+lySsSN5X53tujB+Ro90un9Gxj6Tt/PYsyTz9t0T25JvJp+xI3lfm+26Q0xGj/SiLSe25VYeu08Wz+iRTp9MMnYka3V+T2zL7Tx23+Ivo0f6qs7wia25nYeetBPbUx7VeSjYntt56Kkl2KLSq7NFsEW389ATQLBNJdqUdJ+CbcoVKGNHMlWgjB3JZU8r2KJStqhgi0rZooItqmWLKraoli2q2KJatqhii2rZoootGhLEbuaKLapS3cwV23RrD+kwFNtU4yolN1vFNtXoc8lgWLFNt/dYI0NWxTbd3mP3mfIZPdJ3m95nymf0SN9tep8pn9EjnU5FyNiRPKtLw7BFY1EhdmkYtqhpdWkYtqlZdWkYtqmV91HDNjWvLg3DNl2P6tJY2KYr2vT6ajSjRzqdJJSxI3nwzm5hi65ZXXQLW3T7j90LJTJ6pFMdytiRTKfVZuxIXtWZuLA1t//QM3Fha/qjOhMdW9NbdSY6tqb36kx0bE8f1Zno2KI+qzPRsUU9WpSMXxxb1IsWdWzRLUB2r2XJ6JG+2/Rey5LRI92rUxeNqD2i17336Q2NqD3iCr336Q2NqD34FdpQiNqDLoOQsSOZTv/K2JFMp/Fl7Eje/e2434caClF70Gl8GTuSd1ve96HL6JFO7TZjn8l8l/mMHcnUbjN2JO8r815pktEjnd87G9pQ44tJZ+xIptP4MnYkc+drKENt64+N+52noQ21sKExr71JQxtq23/sXh2T0c/00KH7dl4ZPdLplK+MHcnRlvfepKENtSgaW3eNa2hDbeuP3TfcyuiRXrQnylDrXPoaulDrXPoaqlDr0ZqkU0MXap1LX0MXaiMmZV7LRTN6pO/+dZLOB2WoRcnYk+z1O310TMfW3Ppjk3Q/aEMtbej+pNLQhtoodi/K6JG++9l75UpGj/SYhXDdtjmjR/p+/rxPWsjokb6v0EmufxSiNukbz4wdyY2O4Br6UAsfYsccfahtA6LHHIWohRCxY45C1LYC0WOORtS2AtFjjkbUYgEhdvKiEbWtQHavXcvokR4tSvpcNKIWRnQvXsrokR7XKelG0YhaGNFczz/10SamY6uGEd3rbzJ6pO9WvdfIZPRIl+q4oxI14aLQUIlaKNG98CWjR/pe5Gtdi3szeqR7+Ztjm24HIr85GlELI5LrisYZPdLpEsUZO5J3e973yMnokT6rPxOFqCk3+YY+1LYB2b1IJaNHeuxKdV0CKaNH+n7/KfdHvoZC1EKI5LomYEY/06N0jB0XFKJm3OUb+lALH7rvNJbRI70Y46IPtfAh9meiD7UtQHYvKcnoka7lUcEWDR8SMkRDH2rG32g31KEWOnSvEcnoZ/oqrk+0oRY2pNdJbhk90nd7KulZUIfaFiB6ENGHWvgQ6yzQh1r40L1cJaNHOteEhj7UllUnFwpRCyG617Zk9Egve1wUohZCdC+FyeiRXjy5oA+1WHK6kcEI+lDzskXRh5qXLYo+1MKH7kU8GT3SixZFH2rOxa+hDrVYWOg+BT2jR3o8ibJ0aM8eJWX3GesZPdLjGr13oh11qIcO3ed+Z/RIr1q0oxD1rUB2r1fK6JFejYo6KlF/8FFRRyPq24HsXt2U0SN9FWd6RyXqseD04zrLqyMT9Ra4cKeLjlDUYyLRfXWkjB7psZbtdV3VjB7pe2B0r+PK6JG+m/Rex5XRI52/DO3IRb3xl6EduagHF5EBXUcu6lFQdq/kyOiRXg2LOnJR70WRQ0aP9N2iizQRglEPMLoXw2X0SOcDo45c1Dtd6T9jR7KUfya2Z0wkYgcRwahvFOJHBVs0yOhe85fRI93Lb8cWHXxg1JGMepDRvZ4wo0f67nTlVm6RwSN7+wI5iAhGfZNQe3rB9cuxRWMy0f0NTkcv6rHY9OP+sqqjF/UtQnavm8zokc7HuR21qA8+M6yjFfWwInLAEYt6rDRNDjhqUZ+9OuCoRT1mE5EDjljUNwfRA45Y1CfH3I5U1GM60b1MNaNHOl2bOGNHMi11yNiRvPvaewFsRj/Tg4nuBbAZPdKj/Oi62ElGj/Toa8k4AZmoBxPdt6bK6JG+7573gs+MHul7iHuvsszokc6HuB2ZqAsf4nZEor4ZyO6bXmX0SI/VM+/i3hGJekwlYkNcZKIeTHTfhimjR/pu0Xs1ZEaP9OLuiUzUtbh7IhL1mEZ037Ano0d6rAV/XWg8o0f6bk/y7r4jE3Wla9Jk7EjeV+i6rv2V0c90469BOxJRN/4atCMR9SCie2FjRo/03ZZyf3XWEYn6ZiCyp2lGj/RoT3LtIxJ1vsJQxo7kordFIOp8faGMHcl0j7mMfSbH5KH7fkcZPdL3lXmvVMzokb5b817jltEjffe1941UMnqk7772Xi+W0SNdqk4Igaiv4uETgagHEN0rrzJ6pMeLs/v8kY5A1GPFaXaWIxD1TUD0LEcg6jGF6L4lRUaPdD7dpCMQdafFghk7knkJS0cc6s6nm3Skob75x+7VYhk90jfI+7o6VUce6h7TcPU+AEEe6lFepne/78hD4/EoRogDeWgED5FiqoE8NIrJQwNxaDz49L6BNDQ2/rCDOJCGxkOKgziQhsbmH3YQB+LQeFh5EA3TeX87kIbG1h8jVWMDbWhs/VmkDGygDY1G1xLP2JHc6UUx0IXGlp9FCswGutBodNuqjB3JvFhwoAqNRtfLzNiRzCedDDShsdVnkfKygSY0orzs/hQ5kIRGLDp9f4ocKEIjJhCRp8iBIjS2+dATFkVo9GjL+51zoAkNvgVZxo5kuu50xo5kLQ4hgtAIEGKHEFuzr/IQYmtGaRk9hNicsf/Y/cRCDxpRWnbfGCWjRzpdKCFjRzJdKCFjR/Lcv8h94DFQg0ZoEKkrHMhBY4PPIoWCAzloRHHZfcuVjB7pnIMGctAYdNXMjH0mz6ItUYPG5M8nAzFobO5Z921iMnqk82fNgRY0Jn/WHChBYxa7VGX0SC/6WJSgUUjQQAkahQQNlKCxrWfdt83J6Ge68ClgAx1oVAsLZfRI3y1530Iyo0f67mEbuZWgAw2+M33GjuR9VTbSe6MCjZgsRH9zbM1tPYtULA6UoCHFVYkONCTak3Q/6EBDi+sSFWhs51mkKm+gAg0t+lg0oKFFH4sGNLbzLFLBNVCBhvI3YgMNaPD1pTN2JNPFaDJ2JBfXJfrP0GhH0nOj/wwrrkv0n7GNh71TGihAYxsPWX0so0d6XJekQ0YBGsanwg/0n2Fc2wfqz7DyqkT/GVaMY9F/xjaeRcr2BgrQMC9/FWzNYorQQAEa23gWKQkcKECjKB8b6D9jC0+zce/B0X9GbEo/7w+YyD9jxYsw0oEj/4zgH1ImNxCAxiouTeSfsYGHnISIP2NxzhtIP2Pjzur3l+AD6WcUc4MGws/YuMO/GxvTeVX9QPoZBf0MpJ/hxcMl0s/gC01n7Ejet0pSkTYQfgZfVShjR/J+HBnXlaMz+pE+H/xWORF9Jt9wLGNHMkeCieQzH/E2834Tnog+88GHPRPJZz7iirzfVyeSz9yoI89pL5enxYnkMx/Rlvdb2kTymcWqQhPJZ27UWaRCbyL5zCAfUu02kXzmZp017t33RPSZfIHpjB3Juz3HvReciD5zw84iJVsT2WcW7DORfWbBPhPZZ27aWeM+iJ0IP7Pxwc9E9plbdhapHJvoPrPzwc9E9pk92pJcP8g+s9OV+DJ2JHNcn0g+s9OV+DJ2JO8rkxSwTUSfydeUztiRXKx0mtEjfV+Xatfh4ET0mZ0zwUTymQX5TCSfOTgTTASfuVFnkRq9ieQzB2eCieQzx6wOIJLPjDWl2QFE8pmDP5BMBJ85+KhnIvfMUVyTyD0z1hIi5YITwWcWtWITwWfO4m6J4DNncUUi98zJHysncs/cpLNIGeJE8JnFSkITuWfOohWRe+YsWhG5ZxbcM5F7ZnAPqYWcyD2z4J6J3DNj2s91h8MMHtlbB+7zdydizxReJT+ReqbwR8qJ1DOFv7acCD0zoGeSmzVCzxReJT+ReeamHHr4sCG35LSv3+SmjROdZyqfHzLReabSJYczdiQXg1dUnrklZ5GC04nOM7UYvKLyTL6LWMaO5OJyROWZfBexjB3JWwZIweZE55nhPKRgc6LzzG05i8w0nyg9M4rBSMHmROmZxm1govNMvo9Yxo5k/jg5UXmmFZckKs8M5bnvNZfRI30PW0mR6UTnmVtyuuu10nii88xwHrmXa010nrktp9vjyisTpWeG9Ah5DEHpmVtzltxnnUy0nrk1Z8m9Bnui9czNOUvu2DMRe2ZgjwhJx1YN7HnujXFNx1aN3eXlvvDrRO6Zm3SW3GdCTASfuaJVnaRjqwb53DeByuiRzslnIvlMLx4tEXxmgI9eN9XM6JEe89jvd2Q0n7ldZyk5u1B95padpfcZUxPdZ4b76H0+1kT3mV5epig/04v9NDL6kS6PaND7uStoP7J9Z+n93BXUH9nCs/R+7gr6j4T/6LoeGUH/kW08S+/nrqAASQiQ3TswQQGSqAeze72poABJCJDdzxlBAZKtPIvUeAgakDz4CiWCAiSN7niTsSN5X6L3eYqC/COt8+tI0H9kC88Y9zu6oP/IFp7xvGVc07E9C/8R9B8p/EfQf6SY9iOoPxLTfkhZiqD/SLGqtKD+yBaeRYoqBP1HOh/cCuqPdP4KU1B/pPNnTUH9kS08i1RgCPqPdP6sKag/0nlRn6D+SI9r8j7RXFB/pPOJeIL2I4X9CNqPxJpB929G+5GY7kNqRgT1R0J/yLBZUH8k1pImk3IE/Udiyg+pSBH0H+F7imXsSOYPKoL6I4X+COqPFPojqD8S+kOqaAT1Rwr9EdQfKVYKEtQf2cJD9gHJ6JG+3YBMyhEUIJkxBLrXZgsKkPD9xDJ2JBe9KwqQzKJ3RQGSrTyL1CwJGpDMondFARIp7pMoQCLFvlMZPdJ71fWgAUlhQIIGJNt5FimfElQgkaIlUYFE+BtMQQOSmOyzyCAGFUgk2pLcKZGBJKb7kEorQQYSLa5LZCDZ1NO/DqGM776GrZiOrRlrA5FqX0EKko09/esPneu74XipIQVJlH19/aH3Xwbbc4NP/7o/3KaaCnKQROHX+Ov073pXzMYmja3ElpG/FJs0RGit62tSQRGSEKF1r+QTFCGJ5YG+LqKvA/NQ/N1RhCREyMn4EUVItvosv5e4CZqQxNwfJwN8VCHZ8rN8XGsGBF1Itv0svz8UCsqQhAz5faseQRmSkCG/z1YUlCGJGUBfd5b7t2Orhgw5OQlQhiRmAJESBkEZkm0/TkoYBGVItv2wx2VBGZKUIfKEijIk236YagnKkKQM3VVLUIYkZYicYihDkjJ0Vy1BGZKUobtqCcqQpAwRGUAZkpAholqCMiQe3kcextGGJKYDEdUS1CEJHSKqJahDsgHISXGKIA+JF4NcxCHx4oEFaUiShsgJgDQkJQ0J0pCUNCRIQ1rSkCINaUlDijSkJQ0p0pCWNKRIQ1rSkCINaUlDijSkJQ0p0pAGDREfVKQhTRq6nwSKNKQxPYhwoiIO6QYgJ1VKijykLXrf+xBP0Ye08UUUFXlINwA5qWtR5CFtcZXex4OKPKSNL6KoyEO6CcjJU7EiEOlGIHbhKRKRbgRyUtmiSES6GchJZYsiEmmPFr3fTxWRSDcEOamKUGQi7fy9mSIT6aYgelwQinRTEOuQFKFIY6IQ65CQirRr1SEhFmlgEeuQEIs0Nh5jHRJykXYvenZFMNJYL4j1X0hGmmRE+i8kIw0yYv0XkpEGGbH+C8lIk4zIn4pkpFElxvovRCPdMOTtfq9WZCMdfJqCIhtpLDF9vVcrspFuGGL8oshGummI+YEiHOnklKsIRzo55SqykRbThhTRSDcLOSlEUkQj3TDEqqIU2UhntOX95YMiHOnGIW/3OeGKdKSzmsynSEe6echJdZEiHmkxfUgRj7SsFlPEI908RI8L4pFuIKLHBflIo1qMHRfkIy34SJGPVDgEKvKRCodARTzSzUNOCrQU8UiFQ6AiHalyCFSkI602oM/okb6n9D3vE7ejjXSkJR0p0pEmHd0fARXpSEs6UqQjjZlEQrpmtCONirG7NCnSkWo0KBkUIR2pxuVJBkVIR7pxyEmlliId6cYhJzVPinSkxWQiRThS4wtZKLKRbhiiZxeykVpVmKvIRrphyDu58SMbKd+PPmNHMq8zUiQjLZYNUgQj3STkpJhKEYx0kxAzGkUw0hKMFMFIE4zupKMIRppTichgCMFIE4zI9YxgpAlGd9JRBCNNMCIDaAQjTTAiA2gEI00wIgNoBCNNMCJjVgQjTTC6C5AiGGmCERlAIxjpJiEnBXiKYKQ+q14awUi9eBRFMNIAI9alIxlpkBH5bmzRACPW/yMY6SYh9t3QnvZ4FDcLQy6yB1/L3xCLLHamv99ZDK3IHrwY0FCKbFuQk53+DKXItgUxKDCUIouVg0hfZChFti3I+/0CNZQi2xbkpF7OUIpsW5CTEjhDKbIoJCNPuIZSZK1oUHQiCycij8OGUmStaFF0IosyMvK4auhEVjiRoRNZC/ljvze2Z+MXp6ESWUwkIg/ChkpkjV+chkZkYUSkPtHQiKzYgMxQiCyEiEzXNzQi69HV3kdmhkZknc+uNhQi6/xZxdCHrPNX3YY6ZNt/nFRVGuqQ9WrbFEMdstAhMofHUIds+4+TTQcNdchG0ZpoQ1asHmQoQzb4tAVDF7LBiwINVci2+zgpHTVUIYu1g8iozFCFLNYOYscbXci2/TgpTDWUIRuxstf8qzy+m38+4tiaM1qT3IFQhmwWrYkyZIUMGcqQzaI1UYZsFq2JLmQzWvNuK4YuZOFC7DaILmRbfmgHhC5k4UL3VcMMWchiRhFZB8yQhUxiTYTrq3BDF7JyUpGhC1m40CCDD3QhCxcihbWGLmTFKkKGKmTC12kzVCGTsj3RhUzK9kQZMqnaE2HIpGxPpCHTqj3Rhqy0IUMbMi3bE23ItLg+UYZs24+TomBDGTIt7pzoQqbFnRNVyDTunOR+jyxkypdGMEQhU75svyEJmVUCb0hCZlzgDUHIrOhnEYTMuMAbgpDFPCJS6GIIQmZ8boIhB5nxCbiGGGQFBhlikBmfgGuIQbbBx0ltsiEH2eLybohBFhhEdMcQg2xzDylUNbQgW7xM0FCCbBUDWXQgW7xM0FCBbDuPk8JnQwWy7TxsIrChAtl2HkaMhgpkKxqT9JioQLadx+f9VYehAtl2HicVqIYKZMXy0YYGZGFAk9yl0IAsVhFixwUNyLbz0OOCCmQebXq3N0MFsi09Pu/2ZuhAtqXH5x3TDB3ItvWQUxcdaD14OfZCBVoPvs7FQgVaG3qc1LcuZKD14OtcLGSgFWsJkTHHQgZasYA0We51IQOtB+9oFyLQevCOdiEBrQfvaBcC0AoAItvKLgSg1XhHu5B/VrF09EL+Wa0Xl9pC/lmtqnRYCEArJgqRS20hAK0mxaW2kIBWTBUil9pCAlrNikttIQKtxmuQFhLQavwtykICWkFAZCPfhQS0CgJaSECr89LdhQC0AoDk/mi/EIBWr+pWFhLQimoysqzfQgRavVrafSEDrVhPSDb8qw5Mx9bs/J3YQgRanfeyCwloBQHJnSQWEtAq1hNaSEBrM4+THYUXItAa1UKKCxlojbI9EYLWqN5wLoSgFdOD2LWPELSGFcOPhRC0AoLk7hgLIWgNPglhIQOtqCtjhxEZaBXrCi1koDXL/hYhaJWVZQspaM2yv0UMWrPsbxGD1iz7W8SgNcv+FjFozaK/RQtas+hvUYKWxBV6fzmzkIKWFO2JELSET7NdyEArGEju830WMtCK6jLy3diWm3pc7rNbFkLQKnaeX8hAa0OPi5PvxpaM6jLy3diS23n82e1fvxvbsth3fiECrc08/vXEfv1uRKBV7Du/kIDWZh5/vje7FOAvRKClRVsiAa3NPK7jWoa2EIGWFm2JCLQCgcg20gsRaBUItBCBVswMIjs3L2SgFTODWNMjAy3jFbwLGWht6nG9g95CCFrFMkMLIWht6qGXMULQsvLKRApaMTOIXWyIQcusOseRg9YmH3raIgitACF2JiIIrZgfpPda24UktKKgTBdJxzZd0aZO0rFNt/v4cyr2NR1bdcuPk814F7rQWpxpF7rQKjYVW6hCa1l1eqEKrVX0tmhCK0yInYtoQsuL3hZFaIUIsRMXRWh50duiCK0QIdZVoAgtL3pb9KAVHsSuIPSg5UVbogat0CB2uaEGLS/aEi1oeXltogb5g7elowb5Fh8nezA7epAX24k5apAX24k5apDHpCDSjztqkD/4VeloQf7Q4kJz1CCPKUHk2nH0II8pQeRycBQhf1TjIEcR8igeIyetowl5FI+R89BRhTxUiJxajirkUT5Gun1HFfJQIbLikqMKeagQWdbHUYU8VIjcVBxVyEOFyMI+jirkUUBGVtRxdCGPAjKyp7GjDHnIEFlwxlGGPArIyA3R0YZ8+w+7ITrqkIcOkQVnHHXIi83FHG3It/44WenF0Ya8a3VxoA15r8ZEjjbk23+crGziqEO+BcjJm2hHH/LBFd5Rh3y0qktCH/L0IdIloQ/5qJ5ZHH3Ix6x6MPQhH9VTi6MPefgQWbLE0Ye8KB9z1CHf/vN8hWDffd3vMRsbNLacJytrO/KQz+JGijjkG4DYwhmOPOTFLCFHHPJZcYIjDnngEDtZEIc8cIi1PuKQz/ISRRzyWV6iiEM+q8cWRx7yWQ2NHIHIA4jIcjiOQOQbgZwsh+NIRB5zhcj24I5I5IFEi9wyEIl8Q5CTnbMdmciFz0pwRCKP2UKsp0Mm8mAidgogE3nUkbFTAKHIhS/z5shEro/q0kAo8oAidmkgFHnMFmJnI1KRBxWxKwmpyGO+EDt5EYs8sIjsVu6IRa580wZHLPLYe/4+VEcq8igjI3uKO2KRbw5ifTRakYcVkR3IHa3IrSrzdNQiLyYNOVqRW9ntoha5ld0uapFb2e2iFnloEbuIUIvcyksUtchLLXLUIi+1yFGLPLSIbBPvqEW+eFmDoxX5ioX/7f6boxV5WJHf3z45WpGHFZEt6B2tyLcHOdkm3lGLPGYRkZ3ZHb3Iw4vILueOXuQrLlNyw0Ax8hAjskaUoxj5VqH2IItEOaKRx7rUD7Lij6MaecwjepBVUxzhyDcNfeWTYSbKkefy1GQpFEc88liB6EHWQnHUI/ei+0U98tiQftzfzznqkcdcInZxox95+hHpOsCPxuPx4IOBjB7p9C1axo7kzrvUjB7pg3epGT3SJ+/FMnqkFz1wRo905Z1eRo/0nPN3vbozfOSvyDdy3Bfmx6zqx/W1a4Y/81tesNf6zAwf+XHBtmu1aIaP/Lhg78uEZPjIp3PFMnYkFwsoZPRIl/JYNmzajUX8WDZs22b1scS2bas+lti2sWL11zG73aYy/JkfW5Y97jsMZ/jIpzONMnYkZ8NeF7vI8JE/yoPfsW1ztlG77pyY4SM/Nrwix7Jj23atfx1s227ludCxbXPXenYudGzb7uW50LFtx6M8Fwa27aCjp4wdyb26rgY2bcw7oqfCwKYd9PVMxo7k+qId2LCDvp/J2JFs5Uk2sFUHfUGTsSM5m5R09QOblK9nnbEjOfth0kYTm3Tm5UpumhPbdGab+m2+foaPfLodVsaOZLqLUsaOZFrjkrEjORr0vn5Iho98Or8hY0cyLXLJ2GdyLEv0uG+ZnOEjvxgwCbam0O3pMnYkR1Pel+3I8JEfPe99DYYMH/lxhd4r9zN85EfXe99vN8NHfrYpuY4E2zTK0B738voMH/lxnd5rsjP8ma/Zstdnogwf+XGp3kuWM3zk083OMnYkR+PeS5AzfOTvatFxXXgmo0d6tO29/DfDR3607b1CN8NHfrTtveY2w0d+tO29gDXDR3607X0n1gx/5vMt7jN2JNMZSRk7kvcle9/HOKNHeiw/da2OzOiRvpu1XdfzzuiRTt+TZ+xIpkuJZexIpkuJZexIztYkV6phaxqdxpuxz+QNSHdgzOCRvbtfa/fb3cLWjLWKWPMsbE1en5axI5nWp2XsSM4LlHReCxtz5QVKOq+F7Zk1aveawAwf+asclyxs0uXluGRhqyYwsXGJY7s6nW+fsSM5Bkn3Ar4MH/nFw6pjsyYt3ff1zPCRL/Vfii3rtLQpY0cyLW3K2JFMS5sydiRHg96338zwR357RIPeKwkzfOTH3fS+mWWGj/xs0/sdoCEutShWe9y3s8zwkZ/Ner8AG/JSe0Sz3ovnMnzkxwV7rxXL8JEfF+y9vCjDR35csPcqoAwf+dG+94KXDH/m89q1jB3J0bj3ipcMH/nRuPc6kAwf+dG491qADB/5dFJLxo5kKW4hDXWpNX69NqSl1vj12tCVWrqSkFMYXamlKwk5hdGVWqebaGXsSM4mJec7ulLjy1xn7EimCzFk7EiOK/W+Z2aGj3ypbmUNSaklKZFbWUNSaklKpINvSEqN17Bl7EimFTIZ+0xOTFLSZyAmNb6OUcaOZP6s2pCS2ouSyDFHSmpZw8aOOWpSG+VNtaEmNb4zWsaOZD72bUhJbcRFqqTfRU1qqUl6fUeZ4c/8mW16R7mGoNQSlPROYQ1Bqc1qBNzQk1p6kpKeFz2pzaLnRU9qs+x5UZTa1PJQIiq1RCV6KLFp56oPJTZtuBI9lNiym47IBYWs1KR0woay1KR0woa41KR0woa41IQ7YUNZakIX38jYkZytSu56yEpN6IzCjB3JtDoxY0ey18ccGzRBiR1zBKWWoMSOOYJSUzq9JWNHMl0TJ2NHct5SycgBOakpnX6WsSNZq6saKalpMURCR2paPqY2dKSm5WNqQ0dqVj6mNqSkZlx/G1JSMw6EDSGpWXa8ZPyFktSs6HjRkZpxyG/oSI0vcpSxI7m4l6IjtXQkIyM7dKRWOFJDR2qxytHjXhmW4SOfLleVsSO5l+chQlJbozwP0ZLamuV5iJzUeFlbxo5k/mamISS1hKR7TVGGj3z+ZqahIrVUpHtNSYY/8724hSIhNa9voahIzetbKCpS8/oWipDUvLiFoiI1L26hSEgtZic97rU2GT7yd5s+F/v88+I7GT3Si7VYM3qk713S2v1VRUNI6glJ91KeDB/5/CGmoyL1B7+FdiSk/uBPpR39qD/o8p0ZO5Lj8eVef5ThI59ON8vYkVw+j3aUo/7gz6Md2ag/6JoqGftMbhwYOppRTzO6F1ll+MjnwNARjHqCkV3X3s7wkR/9rd1fxHQ0o75V6L7MXQaP7FiR/rrafUaP9D19+763bkaP9L0m/X3324we6btFr0vBZ/Aze7sQKYTJ6JEejXqvEMvwkV80KqpRz6lI94qvDB/5s/zdsU3Tjdg5g27U043YOYNu1DcMsXMG1aj3VZ0z6Ea9e3XOoBz1TUP0nEE46huH2DmDctRjGtLjvr92ho/8Uf4y2Kyj2Dsio0c6XZ4+Y0eyVocR5agPujx9xo7kVR1EbNBBV6fP2GfyLK9SNKM++aSyjmDUcwbSveIvw0c+f7nWkYv6JqH7q/iOXNRnfYGiF/VZX6DoRX1WFyhqUZ/lBYpY1Gd5gSIWdSkvUOSiLtUFiljUtwbR0wWtqKcV3QvtMnzkx830XmmX4SM/2vVeapfhIz/a9V5rl+EjPwZI92K7DB/58Vh6r83K8JGfK2KTmx66UU83uldFZfjIj5vqveImw0d+XLFOrliko55zke51MRk+8uO+et3DI6NH+h4r2XU7kYwe6Xvaytd1It9NWZiNbavlWAn9qGt50SIf9e1D4+u56vZE2FGPeiyQ/fUkc/1LEY96zENi1zjyUbe4aq97LmT0SB9Fl4B81K0cKyEg9Vgl+3GvjcrwkV880KAh9Vgom0y56qhIfTMR2SAwo0d6Xq2kt0FH6utRnTLISD3Wy2YnJEJSzwlJ5BxAR+qralRUpL7KRkVE6jkn6V6SluEjP/rhe01aho/86IfvRWkZPvJ3P9zuRWkZPvI5D3akpO50y8qMHcmtGBkgJPUtRWyuZkdH6l7sWJnRI31WJxhCUt9YRE8wpKS+rYidYAhJfVMRPcEQknpMSBrXlUwyeqTvd+HjXirREZLGliId97eDAx1pxMrZ4/5ycKAkjZiP1O4Vjxk+8qtWHchJ48FrKwZy0ojFs8kpMFCTxoOXVgzUpPGw4nwZiEnjwSsrBmLSeBT0MFCTRqMLdmTsSC4W7MjokU5XMcvYkTyi6e/jr4GYNIrZRwMlaTS6D0zGjmTl/dBARxpR19buRbQZPvKzv72PAwdK0mjVI81AShq9upEOpKTRq9HRQEkane9wmMEje1SnC0rSiClI7V4unOEjXyL/PsYYSEkjKOnrUZXkY8v2bNn7nXcgJo3OX8oMpKQRlCRyHU8NpKQxymZFShqjGh8NtKQxqvHRQEoaoxgfDZSkMarx0UBJGiNb9T5+GYhJY/BB70BKGqPAh4GWNEb1HDMQk8Yor1TkpDErfBjISWMW+DDQk8as8GEgJ41ZSv5AURqzlPyBqDS2Gq1x3fguo0d6cS9FUBrbjPh3Y6PG/KPW7uOjgaQ0Yme1Rmq0B5rSED6ld6AoDeFFMgNBaQjf9SeDR3bcTxu5n6InDanAdyAnDSlHR6hJQ7Q62RGTxtYidrIjJY1tRfRkR0kaki1K7tgoSSMkqTVyx0ZJGiFJrZH7GErSCElqpBR2oCQNzZYl9zGUpMGX187YkVxeqehII0ra6NWEkjSipK01ck9FShqaVyu5G6AlDeWgP1CSxrYisu1xRo/0aFdSPjuQkoYVw1+EpGHFIjsZPdKLNkVHGhuKvsZP16kFAxlpbCoim5Fl9EiPJiW1vAMlaVjxMIOONDYU8V8dWzQYif3qyEhjZYuSPhIdaSz+InWgIo1Fl/LN2JEcY19SVjxQkUYoUiNlxQMVaYQiNVJWPFCRxspGJX0SKtJIRSJlxQMVaYQiNVJWPBCShgf63jV8ICWNoCSi4QMtaXivbmZoSaO0pIGWNGILtru1D6SkUVLSQEoaW4uYVw+0pOHVjRUpaXjcWO/UPpCShleQP5CS5qN6nzqRkuYjL9b7rWCiJc20JFJZPtGSZtS2NVIsPhGTZtS2NVL9PdGTZkxPaqT6eyIozZie1Ej190RTmjFDqZHq74moNKO2rZHq74muNKO2rZF65ImyNKO2rZHi24m4NGOqUiPFtxN1acZUpUaKbycC00xgIvWrE4FpBjA1UpI60ZhmLKDUSG3nRGaasYBSI7WdE6FpJjSR2s6J0DQTmkht50Romo3D/kRmmp3D/kRkmjFfqU279iMTlWn2bNl1fTc10Zlmz5a9P41OhKaZ0ESqRidC00xoek7lvP4+2LIJTXK/W02EppnQJPfb1URomgFNz63b7/nYsrF8Unti0/X3x8aNircm95vKRG2aUfHWhLQvctOMqUtN7tow0Ztm1L01Ie2L4jSj7u253NU9H9s3yUnvDz0TyWkGOTUl7YvqNGMhpaakZ0B3moND4kR1mlH61u6bFmX4Mz9K39p9I6IMH/mtPDlRnubs5cmA9DTnKE8GpKc5s3Gvu15k+Mjn9D8RnubUsqdCe5rTyp4K8WkmPrGeCvFpJj6xngfxacqj7HnQn6a0sidBgprSy54EEWomQrGeBBFqyiyvdFSoKVJe6chQU7S80tGhplh5paNEzZjU1EiZ3USKmlLcc9Gh5oYm8hwxUaFmKhSpPpuoUDMUipQrTESouZWJTR+ZaFBTQxfvVZwTFWpqtisZCyJDzWSo+/YdGT7yrTyPkaGmcrOYaFBT64sWGWoafwU7EaFmIhQpuJqIUDNWViInDSrU3M7EfhVs0yiGa6RoaSJDTeP1jRMRagZCsRMGEWomQpEap4kINaMorpFinokONc3LjhIhaq5HeVdDiZqrvsuiRM1V32URo2aBURMxaiZGsbsgYtRMjGJ3QcSomRjF7oKIUTMxil1QiFEzMYrdBRGj5qrHx4hR0+vxMWrU9Fbe1ZCjZtTI0bsaetSMGjl6V0OQmj7LuxqS1IzFlhopHptoUpOv452xIzmvXPKYiiY1Pa/c6067GT7yn61nct0HKqMf6cJ3gsvYkfxsOSPL6gqKlGxyMr1PWRMEKXmUgydBkJIEKdInCIKUJEjdd9TK8JGv1WkpCFLyKB9rBUFKEqRInykIUpIgRZ4EBEFKGjcLQY2SVpqFoEZJK81CUKOklWYhqFGSGkX6QEGNktQo0gcKapSkRpEbnKBGSStHUIIaJalRpA8U1ChpXvVpgiAl/VH1aYImJWlS9x3cMnzk81c/giAlnd9tBTVKUqMWuaxQoyQ06rl245+3Pc/okR4NS+r5BDFKEqNIXZkgRkmx8JKgREnnha6CDCWDF7oKGpSkQZECKkGDklG0JwKUjKI9UZ9k1O2J+iSbl/rDr684BfFJEp9InZAgPsnWJdI+KE8y+EougvIkg6+iJchOkuxEypUE2UkmL0AXNCeJ5Zbu7YPgJAlOi9w2EJxkixLZLimjRzpfJELQm2Ty1WMFsUm2JvXeyS+CbZnWRAq4BK1JZtGcCE2S0ESqvQShSYQXQwoqk1QTnQSNScKYCFwIEpPEPCd2FFGYJIVp3cePgsIkwse+grwkUlybaEtSrLIkCEsiRWMiLElOcCKldYK0JFpcm+hKosW1iaokObWJ9Z3ISqJ8tQ9BVBLl6/EIipIoX75FkJMkOYnUGgpyksSsJnbKIijJFiN6yqInSUxrum/ZmdEjPe6cpPBRUJTEijsngpIYX9tZEJTE+NrOgpokxtduEdQkicq4Roo1BTlJrFq7RVCTZHMRbSDEJAlMIku9CFqSpCWRylFBS5JVXJ4ISbL42i2CiiSLr90iqEiy+NotgoQkSUik1FGQkGQV3Sz6kSy6U2PGjuRVdkGIR7KKIS3KkWwaIkcb2UiK1bkFzUjSjEjBpaAZSbE6tyAYifMFBAS1SFKL2PgKtUiKpbkFtUiKpbkFqUiSikippSAVSZTC3d8hCEqRPvKyvA+BFLFIc/4SKcxU1CKN+UudFGYqcpEGF3VSO6fIRfqoBkKKWqQP3t8qUpEGFXVSzKVIRfrgy00qOpFuCJJ2f2BSZCINJuqPcWU3RSbSmLfUH/Oej1KkIUX9ISQf27Vlu153LszwkZ/tet/jSVGKNKSok824FKVIQ4o6KbhRlCJtvOtVZCLdDkT2mVBEIt0KxLZRVDQibXXLohFpGFFv5IpCI9LeyjMBjUh7L88EZCLtozwTUIq0z/JMQCnSLuWZgFSkQUWdlLooUpH24qpFJ9KYtMQPJjZu9/pgYuOOR3kwEYx0tPLkQTDS0cuDj2akY5QHH9lIg406qddRZCMd/G2qIhrpyJa9j38V0UhjxlInJS+KbqSFGym6kcaMpU72lVOkI5180KToRjr5oEnRjTTmKnVSeaNIR7ptiD1ZKcqRzmzS+/hDkY40ll7qpDhGUY90Fj0x6pHObFLSzSMfafBRJ9Uuinykk4+DFflI5VGeAshHWuz/pshHKnwFYEU90tCjTqpXFPlIhZedK+KRbh1ii3Qq2pGGHRHZV9QjjclJnVSvKAKSSrYo6QTQkLSYnKRoSJqGRF7LKhqSbieilxIqksbspE7qXRQhSZU/3igqkm4pogNKdCSNyUmd1NIoUpIqf8BRpCQtFupWdCTVbFHSfyEkacxM6qRKR1GS1PgbGEVH0nCkTkp6FB1JC0dSdCQtHEnRkbRwJEVH0sKRFB1Jw5E6qUFRdCS1YoSEiqSvOUn3B1BFRtJgpE4KXBQdSdORyCtqRUfScKT+XGLn9vsgJWnMSepkKRlFTdJYrruTtWQUQUlXPfxFU9IwpU4KaBRNSbcbLb+/6FFUJd1yNB7sr8XWDVfqpDxH0ZV0ZeuSaxtpSWNSUiflOYq6pF63LgKTOq9mVdQl9VGeCghM6rycVRGY1KU8bxCY1PlqAorApDEdiZ5kaEzqfGaoIjCpZ5uSLhKJyR58LQFDX7INSPP+eGWoS/bgGw8Z0pI9eO9r6EpWrNltqEr2yLa8d6iGsGQJS/Nr3LC+08efDopiPl871hCWLCYg9dnIly/M58XmhqxkyUrP0d3ty5GVrPE3poamZBuNXMe1aNSQlKzxab6GnmTpSXOQXxybtPGlgA0xyVq253wK0dfABPOxPVvRnshJ1rI9712uoSdZUQFniEmWmMR+c8QkS0xiZy5ikiUmsZMRMckSk9j5hZhkW4voKYOWZGlJ7CxAS7K0JFJ9aGhJVliSoSVZLNt9fR9hCEmWkEQPPDbsliIy+8CQkSwZiZ0GyEiWjMSaCRnJthPRZkJFslFfrKhINqQ8yxCSLCGJbABqCEk2imZFRbItRfTIY7smI30NZ2/DAENGsllfsChJNrNlya0JMckmf54xlCSbfEaZoSPZhiLG4oaMZDED6W7uhohksdbSfRqnoSJZzEEik9UMEckSkegxxzad9bWKjmRS31TRkUxaebojJZn08nJCTTIpr1bEJAtM6qQQ2dCTLCYjdbJ9rSEoWYBSJ9vXGoqSpSiR7WsNRck2Gflzzm377uupGNOxdQOUOtnA1tCULEypkw1sDU3JYl5SJxvYGqKSJSqRrWANUckClTrZCtbQlUyzeUkPgrBkCUtkD1ZDWLKoeutkZ1JDW7KYptTJrpqGvGTJS6Ru2ZCXLHmJlCIb8pLFPnCdlCIbCpOlMJFtMg2FyUKYOqnGNEQmi93gOimZNHQmiwK4TqoUDanJogCuk53YDLXJivW8DanJgpo6KQw01CYLbeqkes9Qm8zqrhm1yUKbOqnIM9QmW8Xqz4bWZGlN7MaC1mSrHh2jNdkqR8dITbbq0TFSky0t70NoTbayccmVhdhkxf5whtJkm5LIWASZybwaHSMyWSITqRwzRCYLZCKDEVQmS2ViJwEqk/ksT2GEJktoYicNQpN53apoTbYxiZ5kSE3mqzzJUJsstYlU1hlq03rkFXvvLheC03pk4967y4XktHJCEym5WahOKyc0kW2uFsLTevBXcwvhaT2KvcUWstN6lEyxkJ1WzGdiZ9pCeVovebqfaQvlaW1dYmfOQntaL3u6n5gL7WnllCZypi3kp5VTmkiN0UJ/WjmlidQYLSSolQS17uK7kKBWTmla92XnFyrUSoVa99fRCxVqRfFbJ1McF0LUSohaRvKxeXNi07o/2i60qBX7x7W7/S6kqJUURWoaFlLU2tbk/f4ae6FErZQov7/HWihRK6c1+f1NxEKKWklRfn+5sJCiVlIUWVtzIUWtoKhO5lsv1KhVrPu9UKPW5ibW76BFrVGaxUKNWqNExoUatWqNWqhRq9SohRq1ao1aqFGr1qiFGrVSo8is8YUatQqNWqhRa+REcHKVoEetl0exPxbbdhYjqYUatWbpjAs1auXUJnYmIEitWQ6QF5rUmtUAeaFJrVm3LKrUmtmy97HLQpdas2hZVKk167stqtSa5d0WUWq9UIqcCIhSq0aphSi1qvK4hSS1pBwkLzSpJeUgeaFJrTQpMsl+oUmtokBuIUgt4ZUbCzVqbW9iNrlQo1ZqFJm/v1CjVmoUmb+/UKNWaNQg8/cXatTS+opFjVpaX7GoUSs1ip1mqFFLqxEyWtTSeoSMFrW0evZZSFFLy2efhRS1tjV9HcobTC6EqGX1bRYhahl/N7tQoVYo1CB1GQsVaoVCDVI7sVChltUXLCrUMv5+diFBLSsfaRcq1DL+fnYhQS2r+2EkqGX8fftCf1obmOgJhvy0VtGkqE9rla8FFurTWvx9+0J6WjnNiZ2MaE9rFe2J8LQCngbZrWghPK1V3FdRndaWpU7GS8hOKyc40b8TGzQnOLHzHO1ppT2xswvtaXn5wn2hPi0vx8KIT8vrsTDi0wp8GmSfqIX4tDxbloyFEZ/W5qXnu5j59esothbi0wp8Gg+9txbi0wp8Gg+7rjy3EJ+8WHfJUZ78wStcHdnJtyuxP9RRnfyR3e/6q+h3j/an32Vg/ox8J/kT83e7fv068vg6Ln/67QXTn+1mk/02iun7eh2kxMkRnnzLEj84C9O9Ogsc4ckDnthZ4AhPXkx6clQnb/yFuyM5+TYl+oeiOHmb5VmA4uRNyrMAxclDnNhZgODkW5ToWYDe5OFNgxRyOXqTb1AywlOO3OQx9WmQUiVHb/LYZI4de+Qm7708ydCbvI/yJENv8s4nmzpik3deZuUoTb4pif+h2KoBTfQkQ2jyvsqTDK3JY+YTO8kQm3xrEj3J0Jo8rGmQmjJHa/JR9sNITT5GeRagNfmY5VmA1uSDD5scocmLTeYclclH9sF3jnWEJh9lH4zO5MPLswadyeejPGtQmjykiZ01CE2+JYmeNehMHs40yOZYjs7kUUM3SImeIzR5QNMgNXeO0ORTy6OJ0OTT6qOJjRvWRI8mNm5MgBqkBNDRmlzqGyxak0sxckJocimvWJQml3rkhNLkUo+cUJpcypETQpNLOXJCanLJq/bOO47a5FJetahNLvXICbXJtW5Y1CbXYuSE1ORajJzQmTycaZBCUEdn8nCmQSoqHZ3JY9bTIGWMjtLkIU2DlDE6SpNr9aDjKE2u5YOOozS5lg86jtbkxWrfjtDkVlyuCE1u5eWKzuRWX67oTG715YrO5FZerihNbuXlitDkMd1pkIJQR2tyKy9XpCa3+nJFbfJVX67ITV5wkyM3ebHtnKM1+crL9f4u25GbfHsSPTCoTb6kPGsQnPwFTuSsQXDyACd21iA5+VYletagOXmY0yAFs47m5BuV6MFBcnJv5VmD5OTey7MGycmdO6IjOLnz6TCO2uSpTWzMitrkXj7pIDa51086qE3u9ZMOapN7+aQD2DQfj+JJJ6NHejTrvWw6w0d+0RFn9EivnnQyfORXTzoZPvLpk07GjmT6pJOxI7m4tWb0SF/FWZDhI9+LsyDDn/mhTfezIKNHeqvOgoatGtw07vXtGT7yC3HK6JE+y7OgYau+xImcBQ0bttEq2IwdyZT9M3YkF7fWjB7p1fNrhj/ze/X8muEjv3h+zeiRXjy/ZvRIz9vr9TEhw0f+vr1+Pe5eVpLM6JEerXqv6c/wkR+31/umlRk+8vf7ufuq8Bk90uOKve9xmeEjvxoMZ/gzf9AC54wdydEN3zfQzPCRX3bDA1t2VOPhDB/51Xg4w0d+MR7O6JFejIczeqTHHfa+2EGGj/zyoh3YsKMaD2f4M39W4+EMH/l0PJyxI5mOhzN2JJfd8MRWnRX8Z/jIr+A/w0d+Af8ZPdIL+M/okZ7X61XXMnzke3lwsFVf2kTOAsFWlVaeBYINK3SNiYwdyXSJn4wdycVTTkaP9OopJ8NHfvWUk+Ejv3jKyeiRXjzlZPRIj4v1vnRIhj/z05ruS4dk+Mivm1WxWTk3ZexITiC+Polk+MgvW1axZbVuWcWW1bplFVtWy5ZVbFktW1axZROb7guIZPgz34rn14we6dXza4aP/Or5NcNHPn1+zdiRTJ9fM3Yk57iJDMsMmzXmNY375tEZPvLj9nrfPDrDR350xPfNozN85EfD3jePzvBnfnrTffPoDB/5+1mnXZccz+iRvqeYfp0Hl53cM3qk7/VhxnXtt4we6XGPva/LkeEjPxr3vpZEho/8AicyeqRbedYvbNu1yrN+YdsuOm0tY5/JXoyIHVvVixfrGT3Se9n3OTarj7Lvc2zXECfW9zk260Yl2vc5tmpOcLovPZHhI7/ECcdWLSc4ZfjIrx910Jwan+CUsSOZun/GjuTqOachN7VyglOGj/zyOachN7VqglNGj/TqOachObWc4DTvd8CG5tQetDgnY0fyHg4/buWnGfzMjv3k+rWPbKhNrdElTDN2JNPVuTJ2JO8nnHH/rdGZWqPLc2XsSM6e935bbYhMLaY1jfuCFhk+8qM17wtaZPjIL1oToaltSWJHHBtzMxI54khMrdNFhjN2JEeve1+EI8NHPn+uachLrdOdGTJ2JEtxwiIttU6XLc3YkWzFEcFW7HS16IwdydHP3tckyfBnfkFKDUmpDb7oQAaP7GzJ+6CroSi1XAL8vkJRho98uptRxo5kuptRxo7kvC7vI66GmtRSk+4rqWT4yF+8+dGSWlrSfdmVDH/mz6JFEZLarFoUJaltLXq+K5X23ddfhenYoFuL1Pze1aIltbSk+3oxGT7yo7e9rxeT4SM/WvW+XkyGj3y63VjGjuSiSdGRGl/8O2OfyalI92VrMnzkx1PpfdmaDB/5cZnel63J8JEfA6L7sjUZPvL5g2lDSWopSffX8Rk+8rU4f9GRGt9ALmNHctHtoiG1NKT72jwZ/sxXulR0xo7kbFHSvSAgtQKQGgJS20LE7nLIR43vIJexI7noc1GOGt9BLmNHcnS496WKMnzkFwMhVKOmsa/RdSvdjH6mGy9MzuCRnW1JOjk0o2Z0w7GMHcl0w7GMHcnR3d6XY8rwkU9X/s7YkRx97X3tpgwf+fwNakMtarl/3P2URStqVnS2CEVt0c0zMnYkF+NaNKIWs5LGfcGpDB/5xbgWiagFEa3r1uEZPdKLCxN5qK1iYIs41FYxsEUZailD9zW1Mnzk0wVnM/aZHHORyJvkhjbUtv6QQ4Iy1Ly4KJGF2nYfckjQhFqY0LgvA5bhI5/WW2TsSNbiukEQajkJ6b6IVoaP/GxNcgtEEWpePG8iB/UHf97syEF9kw95wu/oQT086K4YHTmoP3hrdrSgnhZ0X1Iqw0c+b82OEtQf2cXe74EdKag/+OCnowP1Bx/8dHSgvqmHHRNsyaxxuy+DleEjn9teRwjqG3vuz/cdIai3YuTTEYJ64yOfjhDUG+9gOypQb3zk05GAehLQfVWwDB/5fOTTkYB6zjW6b+aZ4c/8nGu07kOljhDUY67RWPf5NB0tqKcFkftaRwvq23vuS/lm8Mie5V+LHtQ7nxjYkYN6zjSihwbbtdOVADJ2JK/6OGK7dv5KpaMI9fEoDzqiUB98LkpHE+ppQut+U+loQn3wUVBHEOoxxSg2SXLYJCmjR7rwzgJJqCcJsZMFSagnCbEmQhLqY5XnC6pQTxWirYStmjOM1v3u3BGG+iy6XXShHjOM2IFHF+pR1EY2v8rwkc/VtqMK9VQh1lCoQj1ViDUUqlDPijbWUAhDPecYsYZCG+pZ0rbImAF5qAvnvo421NOGFjnyaEM9bWit+00SbainDS1yd0Ib6lnT5vfHxI481JOH7jvHZ/jIj8Z9rn13/XuxcbOqza+7XGb4yN/DJGWHB9s2lcgnyce2zZlGLvdzB6GoJxTdlwHL8JFfNy9aUVc+IaUjFfUsbGN/LGpR1+L2ilrUc57RfRmtDB/53Bc6alHXslXRi3rOMqJHEVvVHuWBQTLqSUbsLEAy6jnN6L5SV4aP/OIei2rUreiLkYx6TjPy6xo3GT7yY0fH+xpgGT7yLfJJd4Bw1GOa0bxvQpbhI98j//403lGP+uKTFjrqUY/94uZj3psVAakHIM0HOQ0QkHoA0nyQzgANqYchzQe5pBCR+oYifS5beusqkZH6piJt5DaIkNRXNi05idGS+sqmJXcetKReWFJHS+qxijd579XRknrUtc37qjIZPvKjZe/rj2T4yB/lXQ1RqQcqzfsCJBk+8qW8C6Ir9ZxqxEYVKEs9ZYl1mChL3cv+GGGpe32XRVsaj/IuO5CXxiOb994rDASm8eCvYwb60njQnW4ydiTP4sAM5KURvDTv21Rn+MjXqocaKEzjYVUPNRCZRkw2mvfFLTJ85Ed3fF/cIsOf+Y0PjQc602jZqvfubyA1jaxvIxfhQG0abVQX1UBvGlngRi6qgeQ0cu4RuagGqtPYskTPHXSnke5ELqqB7jRyTSV2USE9jZZte+/vB9LTeNET+f2RnkbnSjHQnUa6E/tj0Z1G5+Pigew0evbG9zvVQHYaUeM2+3V98Awf+XHV3heUyPCRv1142r2h0J5G2NO8rz+R4SM/Gva+/kSGP/OLCUkD7WlsXyK9JdrTCHua9zUQMnzkxwDqvnF1ho/8aNh7tXyGj/xydDyQoMbQ8kRAghrDqtHuQIIaI1uW9IBIUGNky5JLFglqBEFNUgs6kKBGENQkxZ0DFWpMXg410KBGLqzE+g80qDHLp9mBDDWCoei9ExlqTC3vnchQYzsTG30PVKgR05PI6HsgQo1AqEnqZAci1AiEmqTwdaBDDSmffQY61Cgq3QYi1JBRHkpEqCF0gbuMHcnRrqSqdqBADb5+d8aOZLp+d8aO5GpUPNCexsal54SM+0HBFtX6/or0NF70RK4PpKcR9DRJAe5AehpR5zZJqeZAfRrKZ50NpKeh/E3AQHoaSU/0yGCjaj1yQn0aMVfp63/v3Tby01D+JDvQnoY9yi9HexqWfTC5J6A9DSsuVISnsXHpua3NZUngjB7pm57WLtz4GndjOjbq1qXnJjX3b8dm3bgk46/Tv+tdMRsbNRbufp4Dl1kDA+FpbFl6vqr/+l0e+qdvxyaNlbu9kW/HRg12+nqyuFWrDYSnEYspPUfm13Rs0g1Ly/WvOr+b+IJ6IDuNWLzbjXw7NupmpeXkQCI6jZXdLxlzoDqNWE9pkkLHgew0+ALeGTuSV3X+IjmN2DiOnb+ITiMmMLHzF9FpxAQmcv4iOY3YOY6dvyhOY5MSPX8RnIbP6vxFbxoblOj5i9w0tifR8xe1aWxOoucvYtPYnETPX8Sm4V6dv2hNM6xpkkLaidY0i8q2idA0YyYTOR8nUtPcnLSWXkcEE7FpPqrudyI2zUfV/U60prkx6bk53m263kRqmtuSyNk+EZrmlqS17o+4E51pbkhiF8dEZpqbktby+7cjNM0tSexamuhMs0X3ex+3TWSm2UZx6U1UptniSr2//J6ITLNVV+pEY5qxiJLfR/kTjWk2Ky7sicQ02you7InCNJsXF/ZEYJr9UVzYE31pxtSmSSreJxLTDGKapOJ9IjHNKHObpOJ9ojLNVCZS8T5RmWYqEykyn6hMM5WJFJlPVKYZi3dPUo48kZlmMhMpXJ3ITLOY4jTRmObIXvg+KpjITLOY4jSRmWaso8R6MlSmuRnpucvnbUA+EZlmIhMpGZ2ITDMmObFeG41pDr7s2URgmsOqGwj60tyAxL4b23PrET+K2KKTv3mdCEszVk9itwN0pVm40kRXmnNUNwNkpTm5PUw0pbnRiN45kJTmLNoSPWlOq24z6ElzFm2JmjSnVzcZxKQpRVuiJE1p1R0JIWkWkDQRkqaM6vaFjjQLR5roSFOkutchI00p2hIZaYpVdzqEpClFWyIjzZjCNEkJ+kRHmso5fyIizUCkSWq/JyLSTESS61alGT7yK3CYaEhzOxHt31CRppZdLTrS3FBEB8jISDPW5WYdIirSjDlMZICMhjTVqx4RFWnGotxsgIyINGP/N9YnoiHN7US0m0NFmrFKEuu5UJGmVc+mExVpxvZvrO9CRZqmVXeEjDSDkVgPg4w0bVWdBjLSTEYiA2RkpJmMRLoNZKSZjEROAmSkmdOXyGoAEx1pFvVvExVp5twlUrA/kZFmMhIp2J/ISDMZidTgT2SkuXitzURGmovX2kxEpLl4rc1EQpqxOtIkFfUTDWl6oQ1ISNOrSd8TCWk6r02dCEgzZyyJX19vTRSkuY2IHG/0o+m83maiHs2YqzTJogET+Wg6r7eZiEfTvf4zoT3lwatTBelIHryiUZCOZOPQ/ZgIwpHEkkiTrEggKEfy4O9iBN1IYpISOa0E3Ui2DLG/UjHZquMt6EayZYgd74XJ/MoUNCOJqUmTLNIgiEZSVMEJkpFsFLIxrz2zIBnJRqGv2/Bf9fFdb3jEkYykKIQTBCMpCuEEuUiKQjhBLJLY443+kdiUMR9pklUuBLVIcj6SzuvQUpCLpD/KfPQiSS/S+0IXgl4k6UVkDQhBL5L0Ivr92KrpRWRFBUEvkvQiso6BoBfJBiHaXMhFEpOS2DmJWiSd97qCVCSdFx4LUpEMXngs6EQy+IIAgk4kOR2JrL8gCEWS05HIkgqCUiQpRWTBAUEpkpiONEk1viAVSU5HIqXqglokOR2J1JMLcpHkdCRSTy4oRpLTkUixtSAZSU5HIvXTgmokOR2JFC4LspFEUdwklbqCciQxI+lrnE3ysX1jRtLXQJvkY/vmjKRF2hf5SHJG0iLti4Ikk1ewCvqRzHh1er8PIyBJTkciVaOCgiQ5HYkUOwoikuR0JFJzJ6hIEmVxXyN5ko9NmzOSFjl1UJKkkCRBSZKckURq7gQpSWJGUl93NBHUJJGiXdGSZHtReyLI/cuxZYWzvaAlSVjSk0yuX46cJHyTt4wdyT2+/D4zRtCSpKiFE5QkidlI/b5lbIaPfF4LJwhJotmg93XzBCVJtGhQdCTZVMSWFxeEJNGiPZGRxLI97+8+BB1JrGhPVCTZTuS93X9xVCQp1toWNCSJpZO632fiCiKSWNGcSEgSRXDdG/lybE4rmhMFSaICrvt9TrAgIYkV7YmAJLHKdnfSs6AgCd/VLWNHcvS5pFRY0I8ky99IqbAgIUkSkpPbIxKSJCE5uT0iIcnigi/oR5LVb05ueEhIktVvTm54qEgS1W+TFAoLQpIkJJFyW0FIkqyAIyWogpYkWQHn5B6GmCRRASekUFTQkySX2iaFooKeJFEBJw9yMiApSVTACSkUFVQlCVWSB2lfVCUJVZIHaV+EJckN3kjtpyAsaUxLElL7qWhLGtOShFRnKvKSRgmckOpMRWHSECYhFZSKwqQhTEIqKBWRSTcjsVmwisikUQgnpIBS0Zn05Uz3jlDRmTQK4YRUFCpSk0YhnJBCPkVt0s1Jz5W8bjOQFbFJA5uE1OUpepNGKZyQujxFcNKWrUvONhQnbdm65GxDdNIohRNSYaXoThrLcMt9y94MH/lx9ZIKK0V70rAnISVTivakYU9CSqYU7UnDnoQUNinak+aWb6SwSdGeNOxJSGGToj1p2JOQQiJFe9KwJyGFRIr2pGFPQgqJFO1JY66SkEIiRXzSmKskpPpFUZ+08xfoivqkW5hM74U7iv6k25hM78NYRYHS2PRNSCGOIkJpIJSQchZFhNJAKCFlG4oIpYFQQso2FBFKc9c3sheTIkLpyKYlpxoilI5sWnKqIUJpIJSQ+eOKCKUjd1YlpxoilM7cg5OcaohQOnO3RtK+iFAaCCVk2qAiQmkglJBpg4oIpTP3MCHtiwilM3e7IO2LCKWv/d9I+yJC6cz9pEj7okNprM4kZCagokRpSJSQ6XeKEqXF6kyKDKXbmZ4vma+jBlQoDYUSMhVHUaE0FErI7BpFhdJYnEnIVgKKEKXCV69UVCgNhRIyHUBRoTS3gCNv+BUhSgOihLzhV4QolWxYcqKhRWlYlJBX64oWpTG1Schi9YocpdubVO40oqhRGuVxQl5TK4KUxtQmMjVE0aM0toET8sZXkaRUedWjokfpNieygLYiSGmUxwl5c6ooUhrlcUJe/CmilAZKCVneXhGlNCrkhKz8ruhSGqszCXmRpwhTatmy5MREm9KwKSEv5hRtSi2blpyYyFMaPCXkNZQiT2ms0STkNZSiUGkIlZDXUIpCpbFGk5DXUIpIpYFUQl5DKSKVxjJNQl5DKTqVhlMJeQ2l6FQaTiXkNZSiU+ni7wYUkUoDqYS8s1JEKi2QShGpdGXLkjMHkUoDqYS84FJEKg2kEvKCSxGpNJBKyAsuRaTSQCohL7gUkUoDqYS8hVJEKk2kIm+hFJFKE6nIWyhFpNJEKvIWShGpNJGKvIVSRCpNpCIvlhSRShOpiNAqIpUmUhGhVUQqS6QiQmuIVJZIRYTWEKkskYqgqyFSWSIVQVdDpLJEKoKuhkhlWUF3ffIzNCpLoyJEa2hUFkYlhGgNjco2QnW5L3dkSFSWREVE15CoLCZEKRFdQ6OyMColomtoVBZGpUR0DY3KwqiUiK6hUVkYlRLRNTQqC6NSIrqGRmVhVEpE19CoLIxKiegaGpWFUSkRXUOjsjAqJaJraFQWRqVEdA2NysKolIiuoVFZGJUSojU0KgujUkKuhkZlYVRKyNXQqCyMSomhGhqVhVEpMVRDo7IwKiWGamhUFjOklBiqIVNZLNukxFANncqipE6JoRpClQVUKTFUQ6iygColhmoIVRZQpcRQDaHKAqqUGKohVFlAlRJDNYQqC6hSYqiGUGUBVUoM1RKq/s+//uXHn//Xt19///bD//HzD9/+77/8t//+3//yt7/9/l///PaXv/7vv/ztx/iP66/7a//y3/73X9bX//l///qXr/40/nfk/2r873NZ0Pwgrw/2+uD54Wukkx/m68Prxz2//7lqYn7orw/z9SGTn0uZxIfXNz/peX+w1zfb65vX66fW+7+8/i1/hbz114fXf+n5a7jO14dX6PWvu71ybL4Ozusb22O8D9h8vD/196f3T8z3T3j+Me25/1h+0tfPPvcFik/PfSBen+z96fWzz2X589N4/8QY70/vnx3vnx3vn5jvn5ivn3iuDpaf3tHxatn2boDn0trvT++fdXl/ev/E+6981ti9Pr1+4lkxlJ/e/8Z8/xvz/W/M978x3//G8+VhfrLXcbb3t7i+zsZHX69PryP09Wm8P8n70/snXkeoP+b7J+b7J14nRn+3W3+3W3/um/b69Prm52Zd+Wm98vrrzOnPjRLy03r9t/HOex/drq+TtuvrjOjqf3yy96fXb2+vI9SfY8z81N7/rf3x3+T9yd6fXt+ypL8/zfendzcgr6O73sdgvY/B0vdPvI/aWn98ev+sv3/23Wesd6fxvpL7+1Lu/uo3vvqW96fXNTPeLf316d2bvM7s8b5Wx/v6GO/rY7yvj/G+PsYffdIfndJz2dH89Ookx3i10Rjznafvn32d7WPYO8/eUXt933z3d/PV5YxnfVp8knePKa8raujrqA19HbWh/u4+353tc7T++vT6Xd5nxHifEeN9Roz3GfHVCbT3J3l/+iP6+r71boX1ukd8fXr9xLvdvjqQV5731+/s7/ZwfUffx+CP9vXXVTEfD3l9evXl833Vzsfr3J0Pe//Eq3/Z+4PHp+e2LK9P9v70ynv3rHvx+ten90+8rtW9Pujr0ytvvO4Be/2516f5+vQ6D/baA/np/a/N1xm7y97z0+ts3yXlr0/z/en9E/P9E/L+ifdvMN+/wZT3T7yu5D0LNz+9854zOF+fXr+pvNpoT2R8fZL3p/dP6Psn7P0T7/YQe/+EvX/C3j+x3j/x6jf2u9L8tOb7045+fcyxz/7/nmOhv/3+6/c///Zvv/z6j8+Rzobb92Bnc+39x7//H7/98tN//v7t33786ds/v//9P84v+RrGfnxJY7/D60ueX/Djz79/+/X7v//+4y8///rL13/7/MLnVIr39z1X2GTf9/e/f/vn78fITfSPn+zz3cfKu2fV6G3pt/3z12//9u3Xbz9/ff7+19++/Xr8od4//s64+OgXPQeVv33+dP8avL9/Wjs90l8//dtvf/+Pb3//n+e/3j/+tPftJs6kf/U13//67+evYh+/SfVn/PbbP77/59E0H6dLG//iR3/54WjW+TGubmWj/vbbL8ef7uvjwH+Np98ja3nfzN4d6nN+SHba0SHc/41f/vPn3//24w9/+5/f/uvzX3ru+PP+l3wVv+T+gn/++ss/zjPw+U7pj79SrDjb9jf89u3333/8+d9/+9uv3/7x7R//49uvf/vpl3//8efjd5LP36kVJ0584++//Pr9v3/72w/ffvv7rz/+83mFHd+m7fPb/F98Gz4bPXfy+ePHq9Pv+eM//nD8rH+cd1+3nfezwmt00t73otbWexT9fqYY9h4Jvz+9e9qnXP6rX+ZPjT0/G5t2W68f/1NH9dx26OML/kVb//jzj7//+P1PP/4/53X9FNE/joqNf3HSfnwLXtZPi/34puoSi2/6owv+9tt//vT7+WWf50nLWxH/sq9De/z4c+fWPw7N/Be/yj7n88Q9D/D4PMBSf0tcjf/29Sf98uvZ0O2jnVbVbT2/5s/3I/WPQ5FPIPznX5f0eQ1/nintX1w2lyOh47P3XO+n1yX/P77rPKayPn+V14P+a3T8dQ2+n5ZfY7r2xozn3Jj8ZK/xR7P3U/V7RNqzQ77+Xj8d96KP30bf46z3uM0evNF/wjvM+LiSFr+Ofvrnt1//8eNvv32d+F9tdZ61H1/A+4Of/nRQv/qrjzuU8ovl60d//f73b//+X+dP2+dP84vlp99/+eN3P47i/DhF8zn3+g3H3Xy///hjRGMP/if/8z++ff/Dt1//4/uff/jp7L/W57imj8XPx6+x1fM7jtP6GOnxw/Z//eePcMCfq2H/8av39wD5/Wi6Vw3PT8VFsr/5+Yv99Mvf/+fxLzz3Zfv4F4Qf1HOUOD9vK7vcjv7cn84j/bxDVv/i7TRS/fxh3kv9/uP/+vH34yd9fPSz3Qa/k8XPfvvHj7//frakPz7HaFoMU+Irfv7l9x//7ce/f/+8/fz7t5+/7kS/n4O+9Xkx9tlpP/DD9//8+l1u3f74+JWW5NmwXk/SrXjc+eEYuDzXEfrj6no9lfX32KPrH5/8/cT5+OO59f3EOd7Pt/wq/+GHP8bPXyfIt19/PQ+M2cdF0/ukF+3+oj9ujMeh+XxkW7M4Dq/2+se337+O9O/fH6f61+PUH18zzOgJ+8MPf//l59+///HnGHHg+ff1RX58Ee28P77ooxc/TsTP04bfq3/4Ic+6bz98jX5++c9f/34+rpl8dmtNiub6jz91a7u25aMP8KKNfvrxt9+fv8l5PP6/yt5syY1dSRb9l/t8HxJDTt9y7ZiMIqkqbrHI2hxUS23W/36ATMIRgYSj1n3oXrklIZgDhhg83KXjE/bUnIBoWKp+IqdCJyT6kD1rfLLP6/30T83oLNeDnXksezj897krlpKXS4kv6mVkEbX2cmjjRYRY6vrn+C92GPkYr1XKLK5TRH8kb+WkRf5ztMggppXvxh5/i3zgiM8xIYs6YcTkkTf0+NsBfzbmahA93PJ9V6dG36vkT2tqBTt3Pa28WB6+GxvL43H8+DyHdUbuYVD3QE+eYOdatTApF6axcXzt9rvz+fpVszJJb8I613ilX8efp8Of4w1zq7a7Grm7UmNv8X/JdSUc89YYmiNyYlfnB0w0sT/v7nduR9z/SJdFtPMWoqVPbsfKFcvsnN/0GCdfHsqXNl3QT3x+O/687fT7kLVcQ/e689t/vpTz53p5PvIVdj7vd5fVKVZbldz9U0iU8s49dnNjkEjvGj/x63n+dTqfjwe9crxavZ4/3DnM+Per3kxnLzOlY64toQo2ebo5x1W0ZjnXo+/rdiq8QWvEXB4M//TB0vFQvT95bo0opmPPtDgUw1mJu+cpv/WXYuo5Wi1+S3m/uQrnvrlvWLsd34IhZXJUJgEKyMgB7rdF49Er0NtcL7c5uibPIcAMu9J+G2rJM9sMdJ/9iA6jPuZkWO0aCfRPFVwOvYxlppm+y8/P40VNbbn2jKU74efn+bUD//jPXYfDC4+P8L94Uk0YOR9qdqyyQ5eEsHPdP44xDRs+wUdhTDmFjk4AYez+ubv99/zj+RlOrCIAHlWYyeeqsPbPj6+vrx+xCvTjeTsfL/sQYhwKq72y2vjY57/BFT+cHqUDbtSR7F65HGYj7Gxh79DrUeaYg3vZGH97XgrXeVBRcCNdngafLp/Ph7YgM59zR+fO7e2PHtercXTi3m67v8fz8aM4/Re6+vzuvaU7ejTwvIT3XknHBM9MLHRvOjov9EeL0FaZCuLDipLQJNMkNlc5vck12nTMeV4wuN+Pt0e9bNCLNTg3bixauJ4Oe5HYVtuKrKOY/ptbiRsomd+9zKAuzUvc0COeEcd/HrclPaGmi0zZmYnvyPe/l331Q8sINfgS/MVkA5vJHqbLrKzQHU5YuT4fGzNy0w5m6N4WzTyuyxTWL1XmQJeu9paBVMy+flY+z6hCiomelSGgOO1jJFCtOapS8tTTj7xYiXVxaknW2O3E/fLFEpIRmxSzdSpHwhPjjxhxVcsQi3ymyGkCdOD4yfZ43E4/nw/tMk3Sw7WO58qfGitg5VoG+ibMurRrjB1dB8HU7vnP6Xza3f5u3ZvgS8ttiG7awUr43/FA1MXpXgw3BtUQy0/AYKnYCo06PHlWLYy83k7/s0aPW5iBOtibvx+tqMeYVUpjHFqvYRm8FjUr20sva2amkRxJloqigKxEJrQCgGYWUEuLxEi42+9eWGX/GuUmyqP/l4GwHt4fj8/K447ypVvLvamqpbISO0pPz1qeTgjWapn8WXrACB54ciQti9Mhzu1fp2O1PmCsTBzzQk2ydj5dfqdkSSXEk0mCgXvYfMnKHKeZ6IafDNQeSUZFBtDrFMENgDOOACKOM53Jf3an8+7n+UgSy9IrNTSb8XN3uB3/+wz7d5wfm+S9cZ2MpiaaGf65uxegKDnTAXuLHL2vpzYAjVqkE4d8RfeC+EuDX4KBeF5sa8/Bh5QOvaXl62iphZYQVuaJucfCyLZ2PUhX0LIvuZpolKrk6hyajxNdnsvxXMJgQlwhTdimifMpJtxux2Vx7s73yrtR1UzT2das2NjbviZ5ypuu/YDXj8/rJfzp/T/3Sg1tlE6HNTQWW01df5+2jouT/s9M0RfRwvEjLMH78VJsFF4mm4Nv2ZrJ0RPL2+BHzC4UfoLMfDlvWk8UXMy3a3Dh7/ev6+2weTIVsAUHvDUfv9ma3agcM+rMR1Pn69tbcXoZeXp1NAv2Gn26cKCJkyW9meauo6XgujyKmpmaLABD+7m12NPrrS0LOXWMbS74xleSq8FQX3U1UmBbO7nrO0tj8mXw9RDzbkWc59Ux52ixTFsoPYpIdCysmNYXDlYq7zLSvYkD5DsL29c4q+eg2eE4Pp71i8cQQRVl2CpBc95SeMRqZzlJn7dTsYTleeQT4NwB+O18gkS7vrn7IdqqFghHlRg2rn2rNG7z8sQfmxvO8tVqKJtZZvvtSCsSGyPlRJrlXmrH5moIpv5UkRWjytDZvjUXlJFKvD7KcN2250PMbdeClVnObTvQzOpqY/OBZOjovhn9/Hm4hlNKp4nNqM4UmuuOFqIrEVzEzzBhYikvvo/9de1K1AulkxGY65qz73k767HSPUlNTOhXQhNL2EgAs01Fa+MA5/NoYOvR4jdbgP084rrUtWj71IRhx9wIaXOhJlW+bL7KDRzJf110S5rPWk+oyXyYmSi24GWjFgRadX7RmtzLwvl4edPHxSyXelil6A5F19rkW2dYMLou3tvzXM5Rq+Zoa/cOVtb6dJEZVxWgmQKqoomlyB3jv+0x4hRE7Xsrm/XWS8in4bWsYOG0JynYTi5411GYT2Gjli7sOrXMaH65MFXJ28jKg6fp/8VOiKrfajndTm1FXctZiKlCuYmo2FyWMMbWUR2tLGdsrd1FfOm+5XsVRsojx8yydYWmhl+G7p8RllvJN0jncuRhxHF3O96WmVfdJcTGSF9u8I/1eWdl3Dn61346pr6wMaUvJ/5wi837+VRgiHpZNFr4r74d3/I05FQeeRR5PRT4eAmU5D5uGFaZJr1yb15vok9OWc9DRpjbTJheAav4Y1zPx129CCYteMMn7/N0PnzsLrsyoPLqAKUJvJ9lEUN1wlEc9n63fy8/nUJSAifKm6wWG4f6wzv18GwnWi385+t31fkNwY7E4bADZzWCOXkssAPKUx+pa7XfnffPCBLbvz8vv+9FVjv28isIQkLBvTq/qwYv+xB9nA610llwOmRESE+PYOT4z3FfnIDGDapkRrPOVWiQzO2/fALgTV5PBXjQawW9/j4BmFOHecIxpyLOBDqH139TdSW1O5vkhRiD8kbqvEJDSepmNaATQBdIMpzdPUBw4OKlm0fXuEV+H/3wyAskV9KhUR096Wj0zn3UaGxGX3P6E/Q8p1eZu4dTxUH0CaPBF723abGl7nyPFtzUhQYSBp+QUmhAh2vcp9fbJy6DPr2NPvUro6kYPcVoH+5Tvztagfs0z/v062B7GNKPggVhSMDRIb35If1W5DZ9Xbx+Anj1IUUCQyrSoJl4QBY9FcPG1BmEZnl0/ozp9U6pOXNKfzKne55BzdGlCWQ6i6v0xU034SrdQrgCOQi4WAxiF5MOG2Mc/hYUHgYtS6bHAkATgAWBhoVlC5IO22OlpDkRFTvSoulwhaXlHK5AYwLqFuMm5O3xaz613Rs0uBu0oUdFqdcVcIMGh2ukok5XqdvFoEndYEpFGr50hTeJORR5mtJVWkFmcPkKZCMgQxn6fIW/xa+NIHoZcS8jGjUBgDZjivgMAIhht0mWJ9zLlFaoAYFGiO8crvC3sAwqDQMCDTPjy8x4V3OqngRnF387ItaFvRmgQFAtWFAthImTdj3MznCFP7MgOUkr0to0/yzmlcW8sg70JIjPLeZVuEpgSAd7DpurA8UISDWsA8UIyGksttGwU+PPUg7AgojBgn7BemzpyLNZUChYD+ITbKMWdB22x2/0FrkC/EaP38Astn2aV3ZIO4kd8p+hpjym1WMBtrfYjSxmXXjN+LP0fe2Y6ZtApALmpBC0p+edQJ4z4R1MPa7wlCD4sDNmyQximxl3Naf5bDHrQuAJspa0elwHapMOZCPYHR32RGcMruBEYP8LUyjZAy2PAxlPuMK/Az2JAX0KjnqXa4o9fqNHfRXfzWH3cT0oX/pM25L2PwdKBtdnipZ0TLohk7oM+FtYAZGPN+kbhSu4zBZ+QXalQOZhQOFh0G4KX8fD2fEG/gbqquEKZCjJp/LwgTzImzzomTy8hEUB93WVu3karvnLddwAHmavEB6gAppAWjTRbuv97vPxvB2XonQKtHWbskRdT7Qkv98974VLLIH2bk7fx6G/2CFv6GZQC83I1889RuArz5kuJ+UhPUgDwvaVvgVorDxWju/SThGcRFzl78gDs+NNw0tUp9MLwl8b9x5b0g4kkSub7cLypp9nNXK8vIX/6IDYqzYZTzvhXyZSy81qqrDklaXGE13ejiXAyXUy7zbR3N2rbK7gE6rjAJxOts/bNg6EkeJvWD1eQVtA8GSB+7AjbW8KJm9F3Gpl6muieeCl4+VVSlXLSBZzZwprWoYjo1iEmArbSdGHa8/NpegMGRSUknZl7t9PZz3SyMYl5yjIZR/zLlsUqJNFyhd3FRudiXaKdKwsdDlDaQQWI/fz800nCiT9inud/mz08/NV/1Z3MMjUj8GBH05H+h6DMQ1smuSuAS/cO8SVDnuRTyBI72k78vIDsZRabAoSgeUdrZytgBH9oWVZvTnshwCafMsto6hMOlrFaVje8M0oTpOOgvE3oBiNrlH35fh7Loy8esu1LYmLbGzmxFalmuqNesbGuilMHo6PiJepZbgUerOjmON/h02Shf+OVnw2traWjCIAQhWyQ4qpo91FVdTThiRFQep9jh/bc7yJpVKkIkj0Z/JT5BngrYf3jb9FnqFDlNpRWqn1bnT3g0zNU8xGGliZr72CnzQOA22iMk17BbYcvnuKy69rNfUqjfCmhWikWuRVE3tEjnPmqeXzqVL2G6za5Wm1LoyOue1YUFXDFRxnpuXY/fl6OfI63aKgI47qnt/G9a47teZOMc5QIq9l5PGfz/AYh3tE42jI1qSo1XqKm9+fn/dHxF//uuqKuexz7Ga+epfhlUrL0ClY7YB8Eah/kUAMmxp/ytV+QQg0qK1rpNW1fTHOqEDId5TGLQ5MzvZ9Cx4blC+D6NbwU+P68bPw2FXwkKI9j5wz4tUux6Z0t1utH+7v19sjLs7q1FYcfxMFCEXg6Pn4ONZcfdXx4jMpb7pHi5yi5Xio75CpvSrR8ZkbzYTF08SRhw8uQ7TG51lsSWqJKhxJRiMDd8y4uQ1syyh6HV6Ou16CnaIoqRrF+VaXIpFdDRtjnNqqOBiOIDaUY45mfov0F3crWpCLUXWdpQJKShz3lAIvGP110rQDsnNmAiP3TDmxVhM1QtRhVi2o6K3veNphsRVxm3WOwEH1Hsy0Jwh2aiVt+a6s5b7EYqPmXSlPImczLY/RFlNpfyxf0zgo4B+Pshcrzy06Ux1dvDsmjT/uz7vTR5HvksSA3KNJFpbMWWFBuJyvqkPLwuITFxbkxKNtEYuF24ckHlF+lQQ8GPQMGcv9omDwfNqzNhWj1mtjR7xEz6bq6clVYCiqJFp47IITXs+dOYXO4g5AaaUK9XIKNUapb5OxVvOT2FM598Zi6PYsnVi5mNM+kw72134I3qDXoZ7Oe1SE1/+m1EJKmqaySCr4QCcAlUqDUmmKW1CCBe6zR+kvbYO5xIZqGtALmeA/bQjpApz0oqqTHIBcz0hPnPK+qWDiQIMOBvqEvHLgRUf9JIWQLmeNkSpGnh/OEnwlJGRARo50DHL4md87fYyUvEGzeyqiePAQpi/g04vyKVbp0/30yR3q07OjnNsnTw+AWtDc96nQBvq5Pr0EEIb3qRQxpPrDkD7TkF4CiJLhiw3pt4Y0AVBwG9ILR5F3SLmsIZV0BvxoKmRCemFMX3lM9QAoK4xpyiP7O6ZvMabvjiwuwoMpVf0AKZ7S90KJGCT7c3q9c/rHOLxQ151RJu5Qyu8Ade4SaCS49PhblLs7FIy7CVcACcill6/AtgoEjkEpP4NxDHRSoKMRQmb8O+h8WHRSW8C4seiMTQVAYxFeWSxkqNEYUGcacPgbKDgYh1I5MDkGRWSDIrLB4jIeDLEez4YisvEADmA9GRSMDRZJJAZIV6mwZ4CwiVrQuAJHLZRVwL5vwKAfFeheVwO+DBaFwaqIYkLpCnc/ZJgUZsSAtzsApjAgPTRM+HeYEbnvHVoTBsvAjIBbjEgojRmVlUEWSJqBHcmAHcmgoG1Q0DbgdjITZgkItgz0Skz2fifM7AnAlQmzbsITQZHEQM/CzPha0LMwKP2ZGV9/zr72iD/LmDOsKDAUWxQBLYqAtsMRg9KfBaTIdunuLVaoRfncmoxnQ+EIa9UCXGQN6lMI5S1Wo81t7igd2wyZM/g1KBlZrFVrEdhbaMpAZSOcp/gztPhCKMo6AE1cRuHBnkOjvQMQD8ob4Qr/DkAJh8ocwEoWOkcWp6rFsRqu8GfAMnqAXrD2rc/+AL4WdDnCFdwG6OV4gDYAwLM4NW2Pr98DBNIjsQDMncXOYHF22j5rBgGQgnZxO2TQIqAaQwaQYEaM0FLCWWWBCrdYq3ZMM9ti1doxa/xAl2gCfGjCb4Dr206wN+PrQzXGzrh7rC0L+S6LKNR10Lfp0DgHtS6Hk84hde2QunY41RyATg5AJwdP0hkAOg3ALABeOJxlzkD3JzeLmgkeISAx0IlyFtpCFr8GMgmHleLAWO6wPpwDcAX6Xg6rwmG2O5xgDoA8B5Co84DiAAvqAGpyqGY7nEyuh0wFwJ4OPpvDyeSg7eJ6vOcBWkUDQD44mRxcNzcASoHzyGHuugG8oZjFDg6cGyGeAa/MjfiNUZAoICrBex7xtSaoQwEu5SaMnTyu8DZwkjikeB1E6dxs4cjja82ABc2AMs2AMs34gvDmPLTpgqsCEEnyHjy06XwHNDA8PN+NsDIjcsjJaEBR4M15A8UjAFE9zgoPIJYHEMsbFIcNisNmgpWs0gRIEQIubwF+srgDqN55ILA9INge/l8IfPDv8Bs4Uzy0vDyiMe8Q/kDLy0PLy7sMfsIbAiTQA8TqM5DaIz6Dr+d7PFGf1Y1w94hG/AsU9r+NiDsWkkv0SidTmM40Ms+X+/OjKF3KoL0DPBdwaQPQiRlp2xa4q3XVUvUtYuGhiugs5SyBQV00HCbV6tdKjb2Gs7zjqOw0coYbO2UGe1DlQy4Jkvm9d5Ecp8JGImtv4Rho5A1XQ49rSkGyHNOokv/fvK2CUUtmRT0OJQ9BQw8pvbAkW6YjJGLbUrqIuOYfGCkRkzbxI1bDCjtO2WnkrBY7JRJjUXuVBlqTIRmo3YYiMqW8Yy8r2xdiZ9nb2FwZGF+rHChA3TfPUuBuJEWG5y2wr8Hli7SSMBFssw7RikO0ElyXfAX/A9uCp51x4pc3e6AiLe8om7I00UiDDjIN2kjOJlvXn/857gusXSdfR2s1v2zUvqasTXG0XLZxO4YNYV9uBF7lh9tz6x8Ny5WwIAtfzXKavpeRw3X/jH9+vm4Y7TrZx+dMq3AXLRW57l7VnikLRhx8u6ryrfyoHGm6jqsxxympogbGebWgVacUgqenfZf1jVxN7eQ09sjAoJ/KDMhrDGCWhodvR0SEIxos0Mhis5+LqNNx7nzcaPF1FNCya83YOPx0eVtKNJW3bWWhpm9U65MhWWwOy6hy6k+Ke9t/92zBZlQlWqvXdXa9WVbJwhtsLKyXxXD4799L5iYJq3V96+B/WbkxMgWJVh9of3w2tMDCwl/dCkI9RdExUG6HlRlL8NLWlo0EvpqeskeutjbMk7IlNc3V1rRcjDQ2dikR2fD7opnl36l2clkTbRSr4+DaZq6OV/5x6mxj8tsi/kS4OOeuWGT8DTKkFllOcAiaPjezIec7Nt7IrYbHnKzSl0A3mWucMSUPuyrxhuCKT/9FUa9CvCQPSfQ4ehQAPKeVWtnCnr9+nf7R9yTDIt+IUyKrVcECImZ7ShfNKTc6p/BvTtFfTgl36AvscmcnUtEWRQeHMgB6h43PpQv0HuYeFYteI4cOKASxjjOVrE+3cv+G+axp363EKY0cwJxslN99kBgFM/FYThqoTEEn/ayZimUqM4/Tx/FaYPzl6pw5YHE18/Z2O77FRpQtwECGNW7mSP3VUKEtMCqEDccWLIP355MerLCbHIKaBmuEcBVtLT2ejjIPwWIVdzcqeA3PIaxGAI6rYSqlaoHhIq/J1MabVYKXVPpqHX5InWSkKcBKL3akvN6rsWWefIRlVAT9o9y7rIWE/HfPtgBfoyPAIbhK3M01mn0WgwtVxml//BP+6kUtukjp6F1x0idY+5nXUWqJSdXTFPjl7GYGTzgeLi2mK0yRSugI7fcWbXK2Sxkt21HaxtX6IlBXRWkrLF17+iTaxtqyUmqIlgfpL0ORj3vjNU5KAM1/M/8+ryqP5iVXoQFNhbU2XwH1wgOdZLrm9al2Es+hdKuN2/XPqQgTlRLXxPv5FgP/fV4fu7fn7lb0GKj2TdABuCFHODxftBi+HffP2/3054ism14SdlBEMN8cpWG3Pd0rbUtews29467ly8q6MelwSaytntPHrAY2FMaSzmbivSrL6Pvu17FkrlTEXG7kaezVwkKdqPdBRSyOcqblcbqwVGNfnBTvOXcqVzNrOrbWFmVUixXQKiAYMeATMaAPMZyi6vV7iW1xEVgqtGslJ5AfeF50sbQoRnxeS8JaSUVnG82Gq41q/sp0Mp/nGjjUxchmRvSK+IljEpfRf6773c/nuaAnM/2seKd4G8Zi5O9GuUYx8k2tM7XWXifWRCoCpQA0+d1jRhd8b7t6pKj5lQUFAEJGtd8BFeCAQUDkZsfW58lNcIVSvJfitiEAoSfR8x5VCv95HC8b+vgI4RJfmstDrEYiK+hHlBY83UuJJrlZe8vP18VOnLTlfcjMoKdA/lIj0UqitzFVU5EsQ8UYPBzIno0pEhtT3QxQJOfosUn1VKS2l52o0LccH9kot0yURslmu5GyXUfxrRgL6by1dHJoSuvwszjBZBDvKDneYV8scJnfGWkq+HD8qTuiR9U3ApyH7frs+eEKysYdDQ8Px9jyFDax6G7lIETfrDqlBxqdHY6/ds/z48c6UX9sZ6qizvY9VcxLhmRq88evsNU9b4XSn/J+uchQMhjOH8Q0P0Lkp6Xr5061+dDkycvapk1E6dxNtDktDb9qaopBZVAm2qv/Gl6Z/KqzbKC1yZeBTT3QyP4Lx3ttXuP/7M5P3U/i1alDWf3D+OBPbhrDZYwLKuLMHmJRJnO0K+NwjA1suv4g/f2UM0yrZu6RTkRQhp5fQGYBRTSABBoLOKYV3HuAvWZWMCQlJwQbPUBcw4ByROblAWTHAnQFOKFDls/Z/GbAIITMn3Md4FKAMrkEJXEZgO8A4nLgZHEAv7sM7gA/jqfCZuvbr7QPzrJN3A7fGfhXCRoliEGd5dXiJs8/qewDQMUewEcPWLP3tEVlNf4vVKllraRxPC/mcuWl0rInDw0uELka+tzdjkseaOt6yQCT1ouTlUY0L7+BpUmR1VBNcHseZPAzIWMBAjg7pey+BY7MAn1skUoJ8x6oyYxtBMZwBAYNqGw3YjHAmXEjRAYg8OomLKQJIyZgICdU8acBI3LnSuPUje+kOGU14xIdGQ+wn0VORC4H6ygnQBhcigXKA/nlL5CBt2tBcqFc6AyVT/06BvSSZqSlvdhtffsIxwHRaDLyTLOUmfVwukehp8PH8XDa3SLRUdkoJl31ju9Ap/vjdNk/Qrigu+pn1VUPrJ3PZGFpJnhP08UJGlDcmsJv0Lx5C1cwKlwBbTk8fF4/OZG2LH1yF+9v+CenfdTV/RaFJSmunKG+2fE/9ya9lQyOPF0Xi9KQmp+qzGJwIgPibUY4z5Zy5ixmN9otSnjU0i7gZfC2M9k7RZlBC6JMPGlQcsod3A+QlFiajRMmNw/lFIcyLYjGJLnaxK2S6gCQGK3gvm/czumx8pIV6Usl0jM1vs5WC0wpJ4Ey1w70fIramn8/dp+st9Mr/V1PI7zFTiWd5JWuu6e5huPlmy1MMRpQBqBVBPq7gE4J3jZuadWQ02GyBAPwub/hMFMZLZoWC+M03cHUK+4JFDMAA7IDBckEY9dfFeHuXul6DlQ5MYz/vJ70hj3L1FxwPOh02O5lRlYfXI8uB562Pl7uIeQ9H3eLkt95d38vvqNKmdI832pmM763SkGK1mPW4eHIOJ3JbRh1G3xqPm6nolleAv3mHlEf2tSQEOzRxjQjerEJOeBsbrRG64vtEVOhLQVtkiFWymTliIZyz7JDtAnIJpqrnAcLqEsRYfDrs1OA2AE9xxxrsAQn95LFR02yfoTB5MkG0whaqLt3vPz5s7tFYj6N8lDAXzPxk/nz/fgRTgotRTQp1DBdOv997s5N2bBZoVdo5eR4u12ueqTaUF9cY/WReiu3Mufcg8WmwxxDs5RFQ4AFU284acFQmmZbiEObv86I9UwI0OUzUMjxYmXLZtTJNOcMACPgNg54G4dkh5vRsjOjpWjGykBjpptzo32XnxgtNuisR17Ed2gl6UC5j9YybyhGhmMgpcBMigGHNPmn1P00ZSVitDE6CtCVv1Z6P1a6DT0VcV1MVIrwk2I+oT48Q0MYtQ16SzlqFgMxYlrKEivYr0DhKJoPfswuhq7Rj9dehqL1MdwzyOOZ9z8rQ3SfWA2F3YKR7aoKq6Fcjy9D38Qkg4pJKM9HCHdPH7FeuREu6WTZe0Dr5YDzB7oNDq1EbqACckw3SjG+QocCrCEpZWHRkm+hjGHRym5z62AHCEBHC6sLBib+aBGBS53I4NanBd7zjXfVWLlePm/hLRalTaVH6g0/QCLSZ4PucRLrBbppM6Dmkcm4HcWyrex5+sCVPVvWZ48APOjg5neOr+8XOqlK2yjD0YECKwsTNdrGWRHsddQBfVl61Rx1TCKDCf8SG2jYaB/kSv+TIg6SrXoLmEyCWD5FYyX2cKyIoUpP2Hha+1gN0Kq78mMpWgr14GJv6dXekjummzcT7SzVzJq0sUyQOk8zvjVDlZlj1LbiPC2da3ut7IyK6rhO5ivhtOzRL5JbffpaefrSQ0dYWQ7B4ugz6uj7xsoCdlNbwKhyfGCOgOS6HSCGNFJduJd1ks4cVCfNdzY0dm2U9UELXScLCidrvntz93106AvUjZrztOiXLCSmSfVUo4wnZnrW10gflXQ7vEwLpQdraBPGqyCsk1HSEeN7Y62WPA2qKARGhiFf0bfz6/jYv0dnrNRLU4BD/+J8YgaKTJbcjUK0yk7bZWj0nwoWOpGlob96Op4PxSpScgKG7sSRJ5EDOuRMnSkC93tpd3naOy+UQ+iHrZis7oQSc+J4GBvtbW9sVN6C4dOsQibZq7w0WMAs1M9cN+a8RfI5PPXk429EN/V2/Lxu/F0rBXDdQPtLFyN/Yx4+1emqB73CKdGMRjBW3kdvVKKq9cJiS9X5fP2KmdDH+1VPTyubjQcKNlzNvPzqYn4PSkuxbz9EirH4TJeFN963sFoLUyH8/5IwWuVFacvtakGDXyaViaQ5hNfQClhK7pX8k1xiR2HMTas9X5X/xlz0owkRYagS8QyKM3+kUNyXleJeFCt0ZoRK6ZAQJQHSQL2xZLkE51k16ZHuo85YslM8nqz5jFnDjEJUgxl1J04espDXyRRbAIAZEMEYoEoM4H0u91o4qB+96NLIXeyeBYOBLrF8N/R6Cx99wSlHsfePTTFCeu6Wop5Wayvj86k8uGU2ky+gy+FnWf/urKoLU49sGfy30szlFds56Mti5/nrCkRhxlKGhdV8RffdKwEOB441jg9YTW2roUpLHeQzhodaq6Hz7qfG8nipRB8eGJyJFNeyGnpqQhNvlBmoCg5ZSxCEgSOta7xM34+bFKnvFECoR6Ig14FBFsgZy6N9JJKywE1Rl1NiUDT8jbYijCLsDttssFKDMq2tpS4QLOWsw6HWuodT4SfKUhjywnOGlIE1zFEU+mI2mouB+bVY3sYrH47WcqORKFBf0AfIaeLRMspxANHM6jgUb6hXb6g1o65fZbfLrIKU1ttdUVd6sASVNjfard6A6qnsaAl7GUwANAoaREtFi4XC2VKYF+AdQRtleK9ztLaJSIxK5FJoVBwb000bTh+ZYW8PPpxuRRF+7hXSjCaR4/iKoyQPbwfOUDdQmodoJ6VN1HxWEOG+OQ03+NxOIcRMc1f8E07J6GkVX0C16LZOo5WW/HgochBKesBwLEMwcbq/H8s1qMj9Kfp7HSzIFfQbVOFTIwgJHm8VTyQ3Ak+bDX6d/lnk/wTtzjY6la/TU3Dar/OzLJgrRoSBwld/XXe/9AeUp2+IWun8K3ttVFv/QAtyYdzPUzimLoxEXk0g2tIczBx3e/XMk9oG+wwxBsG2A22BB7MfOIW95wHK9fZ2fCy4Nj1RRjVR6JaRh9dAruoAaqRDgpXro4WWVd3gvNxdNbTBaqmO94YLroxtNjYvd+Swy4FyAczBNstq02x4+JGPZiVQJZ151jPY2ZwZVoa4I89jXW9fu9uh2G966QP6gXb0/ApO/YFNeKfOLHYDL+C3bmiQtcY5E5eA4gIgF5ulpQFFgMCtNWB/NWA0gtSthfC5hT0LvkkLvkkLQg1ru3zFNp70PDHn8anZveSCGL59IUsqR2dwZjmezdw0PsZEOZ+nJq/EoRjedZYsVdmpJBLeQLXacCRVaU2ne3tJtGSgpmx4y1S2F8lvStixQrpM9JhIRg5MKEZmK1+Mhg0zWApbIgSn+JFmihjbmCq7ZJ1yqWZaiE+GamCHUSknm5T/cDMyqTOyHlDtdpAKcDOIa4E3CzFOxr4A8QI8F+gVPFQCfQcgFjBDHlICIQxNB5ihoI70jDWFE98pYAh1V5KNSgghd7COwnqTgeQ9tyaB5JPzHXVis8lt68coG+8tj1iTjcf191H7gUqwb6AleRi4nT4Ld3jSiHcauScTwUdYBfeKJM2kevh7Sq9S7Q4aVPYKfMgmS8o7lAgGsKxDTt1mtuS+vRo1x0lRpFJkYxSQ/laIKssdGBngOfWqzWlBzqmxZ0b7HLibI1crzkNcIT1qs6iNywFo+lsHJkAPyx7UUGCttj2Y94d8BUIo/IYD1ZSzgH9a8KfbAVfo8LHg9XaQSHcApQrlGzTw4e5dBow68FI7QAyzyA2APd43ZvljFybn+VnZAYxCYoG933ncCTicw1RjXnb8haUAUuGXHJWOaOsepYXzwjS07AyafUD67RTmXlqrbjIKcsO332DpvDLNFJlpeW7Srp51PPhSivqbtNC6g/NZLy3JsYQC/wC3b6AQxWgsinCHfSY7TvoFK6eH794PKCzWPTCjiu3QlkhVhczTn4HuKODy8772q8VnkUcHMHZgnAcGFl166HGlmJD4s39ip09MmXzu9iXoT7FCoptwAFy85cg+og9b819muW4s5y2LJsL3ZPlnr8Ir2pARrOxDTH58X3JrBfhNtVi0bmSRmK8/zKgepjGtFhtro0yRqlQtLr7hMK02bsfzbusyGcX+7Sm1QraiHIu5V9SmmSYW4dUE6ZIZ0CAoUdkZhzRCPYsqneMa6vl2Knti+Kwy98cbnqOVRNhUuCnhIBjUQQAeRDTAepBX9815tP7CggvcXwvqKaNaLT0VGnzZOdb4tCUBDa0EawO/btePytE3qSeGIAh2JJQUwhP/+x/avlk1ceFGQGrOebQl9xQ6tv7On7A4T/EF3wp3K4qWqZXe2MyWOmXBeWNUx663NP+bxkcICNn53axMAf5vs09DCz3B/Gbz6NWWDnQzVNktpEUsojs7g1FhhijSDAatzBzR0cxPvJWVzEK/KCUW7RsB84P0d0wS6Gd7ZFyGfAXvlGdxo/0lGLve/tb3XK/23MamkLqHtzNXbZZgnPCIksFl4frWjDv++hVuNPg/n9fzaV9U6FW6kqJOo5WSqWFWTA0zrYDFsY/dm14vRnVMZmliSn0XrVSxvb0SORgowjEYWBBj1Y/l1MdqvMsabGyS7GjWt4a/3XYFSEF6TMZQFGMY+36K2eb9e/ERlKPSCNYfy4hy49E87s173zakzIqMjZJjvcZGjr7z38LCqCw0VsnmxlW3h6N4s3VoCaRUFWcq27uO/To93oNztv9d/P6gfr9x62Gz3p2Xf6qPDAVOaL29uNtXOKplns671hnZOC6sjMTcSEsJLyvFZ5hVCXugQNhldGzNKqpfoxrPJYfD+ArfqKrbtOKWZWzsb9jEocYrlyhFI608S9xB9DPIJdhRsZ3X0O0BO6kDNjOt4AqVghnI9xnViNnDvR1y5gmhV8tZTLdzKRA686wOr0ZmM0L1n+djhJboTVk1sXBC02Dhcr19rOC+atecldB6N9ISVbDU4uexEgzWN3Laj+vz8fl8bAnSOjlVHejQXZdVZVJC2RkISxmoxhm48ugPcKgQOXQKOFSDnG056FskjJ8VgS5wWxxNEMyEgPr37u14Pz4W6QWV/lTJiLmVflqhNVXFrahgK/1RNKtadKuBQsvb1uIpfqQMwtTXobQDsFNxZwZ1kjY8y9XCpktFvn9LRWAwPoXIRYimwqKW/1m6IU4yYc8pEDYdSPrRiB+ODpD0I3eLhngDnVDjwS3LKeded7KGm2W4r3qkWvF1NPG4bnnvFAOPb3m5i3OrG1hkFbKVX/q8nf7sHsfibHOSiWNK4eJEG6kWQzXOaHHOTwlSMTdfxvNneJbN7Uhyj5TAnyg/xVtkhfiqu7tqprcWNpoLNwGroilxFGG62IhQq0P8x3q5KBDbTFtWk4kYwGyyCKonGsryDuAUB+2JECM1NoX0C2UQ1ssJ6FtF9cdL5uqjkjaJ6hlye2p5WS36fOUyjplEDeKyEHZ3I+jPRuQ3gG13E6ROwX3oJsSVE8oPEKp2iPfdRAGey92vPtZxyycyKLzOlFlBKHhV2NvOP1kXc5TgN5oonRPjVINRy0OKMcu3DopTDkpje3idsmpVy5QmauJzAzLxWLhRN3CcSVL+Wch82iFftRLh93Bf52NY6CUbjwKn0RaAxULZj6/2bqC73UDxpdFKmPbFoaryT5B0nik1ymJl6WOuhzyTBNxZl3ZSixKIBctmuGp9iA0a1UnOW9fcm+/PJcvOojKV6IZMdNZyTrtbVjFOb7exySXYay2JYRRnpO8pnC7aiRX/YkX2st3KDK3jNpzzkfh7M128mi6Nd7caiLWgZ0nYbSUY2Q1giBxA3drcw+PG/XU8vb2X6V3VP05h5sHC87JSGBSZd5XvchQVuBjQJG7hxRj1YtJ+PVBBkmDlz+mosF1OdqzO6DHpwKlr4PTZdHIYcDMZOyGayGhzAzcRRHc+ZfJMn0pxERjL73N92cdDrqAVfr1XrCA8XXy+/tydF8mN+yMiQt4K9bhObUbcFYgJujC1izxFr8R5OWfI2+14PPxtUTKo7hdveQnldn1+bpouRq9iDApyX2RHynY5VRjoeVS/jl252WJJpTgRVGTPvbZopcLv5hWRw0smsjJ+jeHVNxAB/Gt7Rr7jtSSgs/367+vP08ae4u7UZpemd3KQIFOGOY6JDQAu2sgswiWo16HRMi0qrC6gYUCam3amLG+TIjFwVYNQ2gq5zNeTpuDZoXAmpONfF1P23V7vI+PmoH+OVwasN/jTMuY7XaRR6cz0gNWlQBFonyxDDj33tOv0CQ/QpwOtT7fRp0/Zp7xJn369T2ifPr3nPjmnffqgwK73KZ3Sp28KqoAhPTukd6C8M6RPOaRzFWCuATqPCecxpNzNkKYPGuQgdDokIjN0e45p0xxT0mNMmaQpvfkpdbHMadSc8kmmy1MTMTya0g3UjA0I0QyyUjFlnq7SoxsDgT+TppRBzspAE9kYoN9MetlhKQCLDpUZm48RJKAsGmEtshLAhBhQ/Bkn5ASTZTfg4EH7oU9rJ9we/szl7AX+Fqg1zC/T43n7FCwacDeFFQz9Wjxlj/5p0NIZzCEzJEiLGUBKP6RJbIYMW8abHPCGhtz6COQ5ZoMZ8bcj2GPH3CKJNwk+bDOhpXhC7+cEK+DwNhPmC0jazJQWjEG22UyYOSjnGmSbDWQ+DXCO4SrdCxTUwhW2PIQiXUbVo+pqsCMag/09rUxrAd0A1s9aQTGX7DnAPhx0oYH1sy4r13j8LcrSmGvB7YeGDorbkKm02EYt8mgWjo/1eR9PW7JFydZiD7U+E4Uhb49t1HqU13v8Ro+jos/4SfwGZrHNFGRD2jwt5ppFC7oF47oF47rF/LMjIDJj+r7hCmMBfBtxpCGpYDH/7GTxt0BrgpzQoTHedYB5dxk2BhpQg4DHANeFfgwH19UZ0IAacL5DD8nhOHYGOXt0XDicyA6HkOuBDe1zpIXf6KEN2OPMhe51uIIVPMcAe4PPARv+FlZwXHgDVlHs1OEqnbHYqT006z3egTc4lA1Y0c2IfzfhbyElgVZSD+7q4BgA4woAvgeWBGe571M6yvcY0dOUw+re/dzdmgTjg/IVaaJmNYbKQCVFI8O3kUZfq51Nq9EkO/usozn5muSgLHAb5OTCnMzbGTYibHGgH7ZoaA3LNv3tCHZl5PPslA44O4FrcKJVrteNHv/7LEgXxlmJFVB8Xo2+RYktYQtMjhn6NIzJ0xgTcMjTE5MXLYeWZnrSbSyCeyuZ+3OD4h8VQsJSPr3VWEz4qaRlHpu+E7astLzTokiP+vpvchjh+b3++7KTNgqoKcMjgnsDLw1OC3w0yGPjFE5LPNPpJ/csd5XhYMW5itmCKZcPD0wpbJZAygNQj9Ry2gqx/+H7YS/DloIeUvTsOFygvRSUzWnDSklpqER7iMNgUwOXTHp2n/ZekIaBPQ7bVJ+8G3SZ9em87jGB0/mJhgWQXvfpUISn2KdvCkwZiOqGdJoP6R3CMwQ36JA+wZBc2SFtEkNy3Yb0UaDpMcyIblN4m3ZkiKyM6XuNabaCxHtKL3zuMDFzOIw5Coe7Q24IB3aYuHkK51ADgQMCFoMsEdTIjcnNJnAxUTI3OaS2XQ46cNXnq5y7QtkTLSsOvCUOAQHmsnEDAhE4/w7PBt7REHTk4ilCjTQnDVjwDeZXCDqQFcOI3iM4wVhMqXCGIySZsdKRjMAkMghdzYA3OeTeRgQTA97QkPlc8JQjSr8QDTRj1pPEE43Yq0bc1dTlfQfZDjwRpHcM6kcGOXwzIbQCbjtcpd+d8WUymSzEhAwwpCa3Ls24U5S/LaSGLBqbQqiBACN9VYvZaU2WGfY51IAIMQSQ7IxNFAJIyMxbzCsLRS/rYM9hc3UIZxyca7QaWeyiFttoCDrAKwwHHujQcIW/xZbu8buoi4ZQA/YQ9nj4GD2eo7f5YOhwhfAD4UyfA4zsvQChjxyJHbNQaKbsBIQJsy6EGjn8gL8zwbdJh2W4QqgBMdKs55ZFoDo48BBhDEFHcr2xc4UrhBBoFjMICLBLOWT7HLyX8PERksCyAXc7mJ1CqJEb3OBFZH8ChypOH9ejvgOFuhB0IPxAyNTjOQYUixAEOuwCDskrB7/SgdXJw/HwBmlBrIoQdOAc9znUgFcHlnkEXh6BV7iCFYQQcE88QjCPxr8wddF2B48CZ3m4gneAET0t8LxcvArJsSrDhudixafVwobQwk+KC6wR9RQUCsJnHuEQJg8yZ1NyFN0DO2YzbRymp00OjIPn7SziS4v4F0eiyzVFaPk6aK+77N+B38y5Oftq6CjIkSE+DafFDG8hOOuH06Y/SHLgtL7BHaHeBmhhFS3zSCVggpGK0NugKHRYkSeM3aDHJoUeQ2bae0xu4drS4miw/J6Efepc3PLpLKXfjXZ+aeyId0rOnbKqxqEfu89irOwqx4kVrDQm+vtW3CTEfqoMSpFHYfjpEsK6RwEgkV+HVfDC2M9bhILWOsjC/FCpgNYD1NpWjZW0D25Ef/KIwwIiZg4iZg6a2A4ZXAdnyk0A8qAEEPxOwHKAG52w9U/YvpG3dROlVwzPUmOXVtLWA61ph9GVDn8JDR0o5mBtaKzkRSbZtGEdraeuBor5qGBQA8WMV7oprWyAyy37juKxoo02rFiyo9Ny7LuGWgwSjOxHChV9v+r0jFqHsT/otQ4HCiZ8f3wUXJNKGJQCjOO4CCHY7HO9REKYnjK2JgO1nJhX7E8UaBtpLorXZtVraw2s8QUpEU/K5tukWFHaPhTqBRM12hAnFXfdzI+5YKTy9kZJCGF567sYfrp8PnWaTyKFLWeLjjaqWUJFWkOpn9bh98/wBnTvvwJ+vrrTyfiCfkBiwSxfbnHgkhSs0dqr5gZO23LaXXbF9HNq+jH3RruGVjbYjQjwuxywAdLWZzKB5KnZDPLkhy3BkElaWZd+OIdVokKC+gSCQocaUgg4UO+g8L98B1UiFa+OCxTmjEP8yjsPs+mqU6NQyBQzpmjnCwsKR0r7BgThwfHx8TxHDaLCkld6GxT0JCxVgEqyHQ85lpT5RFEmM7+iaIVkOvTPUCME7YuFlrrrkNQdEEcgDeQ5i2e+++gU/NXumZKuQ+OLo67Faiz48C/YfGW1Oum2TpTAhFgqyfmUtNtEO1ZLa2Qr7iXpfoh221+8aq68wV718IzUyT0dBAfnbaO4I4+6ODGplbIrsbeK1JdWkE6Hz3WEOteVggqlszq9Xa63tcpWnIxK+tNQWPhq4Nf1XLp3RjHguYGCd08fH89HJBRJiO7PbXOhMSrY4lkFGHtpCBQ9MJKJyfW01/T0ETUirqfDvtZE0svCXJhq9MEu+/PzEI/s29+wvRRgc8WK6vOO0bBWpY20cuKHXZePD//+x+nwo0Tvd+qlcH365d8fD8vjaANK+IwX9V4GqrH0rO6BZitWE8VHVdz0jVMj/vtyjRmrBE5GfqrGf1/vElNSgjyYf1mQDSUVCmWl5DJSj3L597U3qdQqXOMUjv8+Zmz2kWFqQx8cvohSGqOkb7DDFDw76aA6zsF6uvxS8qWjZL634BG0XQKY2A5gIeSOLXLHvqOu8OmyqmlfNGP/JDNeFgBJmwVQgSWzPN5ZjG+kzJ1sOZq4mxsGn6oqIjLQMCCKM1ztSJmq6YgodTwuzww7+n6k7m4YDXgAcCyOZuyyRa3bITNKM8p60CYxJuMVgX/0lCss/4p+bNngbaZUnTUzZaU+XT6OH8F9odI2itVw5mfKhcHqnYS0hP2Lz1vSCy1jWAhqBK8yF09QHgFYABhSB7bcEAtgBDJjhjY2nC5LIkvFZYpK2HBSo0pCUdPvNX6V0J0rsrbGO8TwmhMp+YlMT1NpWyubsL7vFcVt41DkrqNT4mSpGjyh2Opp3qS0WntWJW7tuYd4WfSdDqfIvns7RnDYKnFXhJUyH0w7Q6SxbX+xjExdT1lEFiOX3flHQQYYdS8kRI07zMnANjHlJ9WXQRNCMLGVb1ABtudso8nEmhyp5MgUI+3cnoxhb8nd+FniQm9Uslul+W6StYK/0ihyDb7G7us+uclUO5mvnLijdq8ICA0q1znRdF8Y/Hy8xxhvHxud9U4pM1aUBiNa+IbPUZGEoJSdKSVeFz7XhF8XPGa+VzySWYaOlifXw+BriFjup0exoFRowFu/TrmGx9JXSoadC8oJS5uexl51CQ+UpOfUrCgqAhLKenq6x+N6kzCfJ8WlwpMEr3rkS2BPIyvFOx14tPaysB50aiKroB6JPVr1iJY+o5jvJTN+KrdVJvBpN/jpfvz4fKiBqjo7Jq8aYNgxedcT5bkMRiuZfaVeQ6uKYWy1NVPFco0tpt5Up/Z/mss+3WkyXcYclvbTrQbu686tDSj5HdpQd4ol1YV/tvAEpSsH7zS8RrCyA3IPJk03A3IPVj+Xk4szkoszwAJo/vBZ+q9LwY3vUqnUdz2iqQFXI6xkDvjG7E3HHCGxNJ1KjRvuMt5/X65fl+jU/Dk9ioZSJYs98cPtHps49axR25IBetV42g16uoeI4Ofxdv219IVqj00ccHz2VLkLzKD4pxtHRRpe36xnpSAz8wzAXSTcSiYPxfTi8oGG4gRAKz1VtzndL1f1dpSMCveL7uEoe1S3XgkApxw4Yfzt9FHskkOncrlo6OmoNFM0sxWEV0oYfuDZ3HuIB6rPMMpn4FNMJ4pqE8ZKgMzY2CrjRhd32tNlw76h9HmBgQD4iJaDTwBk1Oeg4l6YaOtCMBPuiFFVqfwosG8gn/cWIB7Lc/PLL9QSZer1BVeidY9lSt8rnk50Ow6UATV645HTI1Iz7Ypja+iU5CkVYAo2Pne3/yoPUWUzPJ8C68jn52G3cRHlidPzNP/9/iw/kHwHr+XUU/hENPC5KC/r3Vdtvo3Xt4guV9wNVTLseL70HgNPvZQn1TxPRfpO9w0PkZqaQ8Pp+rM7nw6R4WOTd1aoHT9QvNDLRtKpU86Gojo1DTft6/jz/Xr9HXY7V0t8Kn2YRkrtDmUPZkm1LPWNE/DreivIGIZOdWfxL/nY1rSnWUnSZ/Fh9L27GaDItLt5nGbe0zv9z/V0qTK09EZFM5RTOBrYzB9VnR4oX1dJ8tqr5Y4+R4NOe9PTuRht/Thrf3mQu7QfKd9s1iy7k7yZAovy7x4NLRLq1RKQdP05liba+CaLp5CjPWVcrFvaZvIU1LGn3LDR3PlwucbTcL+Wd4K1bQp68oqhmNa6oj3OP9arnbNvvi5Q5dfqRSr5zClQop2Sx6YfFP6MBgH/+fpdhaIogaQpRRgQEJggxdZTj37Dyyf9DnT1TGjpB1jTgtDD5X45zjAVfqea9hwUfo7n7issNqqEMtLkTEmYPCnAVz9mAHja19Ac7zOjCFfdDPZjpbvmxQ3ygDGTyzj1xs2G4+p5fJ0NlQk3KzGpgUKNkqX6nJUho6PZ5o0ot1OIjg7EER0l2DrvLm/P4vdVvWaiNJjn3X1RkVIfT4lmoJ3CoknRcj/kvPufvy/e5gqQTsIxbUfTLudDCePs1RHAtpHz8Y9+laMStekoaPh8+igptORPuiE1fbkBzbw8rRbDd53yUbsX/RRh2KtTIa7iWhVfpY5ogTYaSrFYdUszivqWxgPRTriNEramfcLEbUNrR8nK64YWliuNiJaQvIGW3l92VqkZfUPK0aWTah0fYox7ESOoggzdHON4JiyryKsNpx0obWzAXE4lH6gs1DlGCpfYwV5SvNtZlWlTIs73dGtNtjTsTbLPQXst2EtJt77xnqO9EEimJFjlfc0SjWIHikaJtnRMutQQLsdClX1QFV2Ojzlfd0WxRfE8GAqYiANjxSki+x8lS6nyKzlNb7QRydGOlz9quFXnV+MW9tsNQX0nB11aB74+31HXLRn8zk9Vumv8GIsh10G7grdn0UozqswxPaC3JHi9lGAx2I7tAPgxure9BZ0JiH+8RWSFjm6PEph39ICPd7LCBosNXTGUN+YbVVHo5CnvLPXpFhOR6KT9kRTZIE1lvYxJV7tEdql8Ew0joqG6wmmnXgzdwML4UgdOtVlRaEVwLrRLIdMCHRqxO7Qeo403HOn425xapbFE+KEfi0NRyO3JIL6jtb3VB1LHnBj3+vEU2SeauswD8LpAtztwXuhNR0u3EMbEosAukDYB9NWCmC/NfRCpJDAN/D30DfcJy9GDQiLZAV0Z+MiGVG+BJufoUKxL4JAEnALkG13/cwKjQwVqBjFEBwqGDrQ4HSgJuqw4CtKGzLQIBW6DdmOTORYt6AKwZRigxMKZmqlMcQWCBkiAGAeqAfS0GhCMG58zIR1ysbhTsDuZAVQIaLQ2eJdmBD/c2IPHJTO64G1MoHnIAeYM+gsIKJsZbwgCymbOlJNgWEPhLawirCcok3fgPDOgLkCPiEVrtoWegLWgKQLrn7UQxARMwbrMO4OWfw/yBJC2hDgZPTGgCwARpO0Bx+xBjwBmLYs3HjwRUAiA9gDv1E5gbJtA7gDuEzujO6bLFALQ87XQr7RgEsvili6H+WDD8egPhc6C85krLNMAoNjaAzcHNhrX5/6c9I1cj7LYCM8OLG5h0093D7nE8MLRIgJ2MRABeTybt1n7Fl3M6A33EBjxHGJCY8dBFq3NjHanDhR3HW2SXo0ysOWs3LfGQRwOYR2ny84bkJBkMiaep1psZdkYBVGTOrWmo7WOxUQl76AqUjNt1FuGb2CaTlZ3uSB8GLwNtRUMqOPhwfWtKv/eKUkk2k0Uhof3VnGBvOpD6WiC4qNs0ZON6iOVc/zYnc6P2+5yX6pD+pdlB5bhIsfBxCVR122V3RULgQGLAu9a/9hddoWL4WWDQjiY2FQOQw8xJ/A3eKXnAhjoZDrNd7SHZdPMJkUNPNoC/UCxEsHCBvtkvExVhjfbGJwqHo/rVgdRSXSB7AIsxA4MNs5n0kVamwo/tlGTkEg/7ylOLAz9zDIQteSHWHFDY+58fpZqS5Oi/OfSuGFseEGPKwe9GaWYBbYqB1kfByJH19PsW/qdpE5Z+Rkl7gPFK9BFh59JV31r2iw/Uy146RZWNCw5cMKFL4+rfCDSolL4sSXBW3z7QX17vkJvvw/Xr8vjGnvb641R3aBkYOkR9lI0j7DR6+30P2vlpkbRIJcPB1O+zG1VNhW2q0vdow4ILAc+t3CVQaV8Tiy/s4CpOWG/zEYamj+RtioArU4Z4d/kZaSCbeqkpG54ZHhxlJ3nZY09mR0VtQytOC5mtuJc8izORPOgiraZTz415BqwehlEeAa7XjhLUIKloJ7lXm5bIgyjcvc0Z7wMr+QVrBJdp97Bx+6fw/O2yXPNsgZnEfnYkWadg6GwZZ+Pl7dyh1ByH66x52cD9fKOVXaYw7JM1+A4lMCeUWGER/pClraesA3V70FuHo4flouRlPWpSUxInIzn7dcfsV3/hbnXiWvVWQG2NzPQasdiKvcAxCfUzyYLiLRNq7BS9lyqMhY1UWwDiprLc4qW6h7S6/zZ+hoQyIP9B/pbILcDCRCYfzDNxxQ3TaB37TNRPXgLQdXpZlB0zYD5z/CCZhy3M0iGZpB1ZXX7GefjnBNJ4OJF3OU7BIJItXmk2nwHytUOFd/GHt8uW2lNndfd0TocjN12n2oTsPLQHWks2kawKl6oxkYE+Oq27iSpKNJr79Oxw1uLkslVQFHf0yjvia+91UCNTsLKUkqfkoIWNIbW5IYREDaMkMGdaCodP/r8tSH5Uoe3b+wZq4mNS2ZlkWKkFY+GGy73r2HEmvzuE6yWNmgcKwG4AwVLBivvV91fKt8+6ClNTzMJq4ngCz+qrFkxJykmmaF986udRaC03jmneaSaVi7XBComvEqq+3um1ZPVWhGeqj76GdA5Q/WXP06X/z535xKN3yml0Y42rm00WydJW25573rjXUpAEvKWFvSvNtO/phygbRzu10Pcm1oxpmSgG2jHeTJ0P5UdH52clQ5ngAM/ruu4PxmtlrGzrJ69dITo0G2N28lUoEf+2INe1zfcscVmtXQlwxDvuc+/WCBUf8rfNznNio0S8CSc7g4ctQ4cyW4C4CQDmiDyE+YcyPzQDD1l7SaKJVxvPSvWlQ6+9CY7ytGxCnhvsabydPaDa9zEa/gifvq+ra72Ci79ytNTSy/AZ/jPFhqm8mG8yeTjejmFNfqi0Cy+6aQAFRTa8XH9czxET3QX0Qnnv2zrG9T2Rd9xuJFaIBROAjn3uaDfxS0ENT+vh78Vz6OXd0FxRC8bG5IbuQP3tLnkNbqxDcqaNd0Eln8hRykEdge+dweJIjBHmwFyRFiLBsI1ZoTAUpahgSyVnWljXvzxRUqyQleqstA+U2w56klcjl+vRuJKhDfIndJM+YZpI3wwdz8+nrVwcVB5arD3B2NsXVyu4evvf6/C8e+nzwXkX3rl/aiwBzRUgyguQaorblGakAu+xa/wsqhnIdNfHY1jJf5Zne3yaLaettvI8bWWaOUicMXDipkaGFUChCzXwq1YK9Nks3w/dqQpY2lqpcz5WQK4ZLVnpN110lCEmRaeyaxau0Z65lbMbHzuWXZ/h1vi8zDbqoaZk4RrBt+pMRVhqIZxk5hAO/J9cmum8mxWvSe+YL/H9csZ4Cnyrm5pc2OTdC0tB18qc8+ftRnl1NSkgUrdUgmknKUzYkfKkCGtPemdyToLb+dfbGlPV7ULhZfdGvrxeV6U4HnUJHfIjuIEgy2e3VceHpggIQzpOrpsrgtjRbyrWtFQsSbw6u1ihDyenOKexxMV/K9isfEDnTrr0Eq/q5lUEbg9/n4+FW6/gkj6gdbcr79+Fa6lgkMmRJfvaeImkv0VE0zlkCiiPg585W1r8EHJ52YGOk2jFcJsOXSqUYSiuKMJyo6kcsgAU/W0lr8Y2/R8jkrXnpPILMyJZdFF9cYj78o/6e9EV0yY5ax0tRvfpwDKKrbDKavj0ezatYzZrXLTp6x1wT8NWrCi9/BWEJ9JzouJogLAfK5TiuJpIIaYFUchkGU5YqZNqS6FnqF8DGkLC4CShRa5BZTPAspnXZaepBnq8ka2uT9ZYOopBVC2Q1i7JT7YWhro1exs6bsV24KlsF4YW7rJawnFWaZqLW+aXzMsu/OWx1PueS/MKh2vcfaymdVkFR8DqC+0vFxH2x1CmP92Cjf2vJ2rUanC9wLhRm+zYq30RcyowOJ0O3o+GHeqzL5NfP0ueDJaZVcUoobGJBmVVhL4Kd8BAEPIRjtIDTqDnJVBlgt6Pw5y0OEuMpkD3WHDG4mET2o6O8USRusFkYlFAia0wyEnIvWmltj3xysq+0E2eUXpYxx19bWxDfJP0Wc62nC9WOHZXq+Ifx0tTC1mcul0Lfkr3162XNCo85vkgPTqjM/85FkOm7prn7tb8NWONYclPJZ0uQxt2go2jjp7PCvyIxQQnKNu32oD6Knti1LyALTTcknDRc65T+29esl/5nu60Yvx4XyOpPKFmVmZYZ9dmIk8GyHuKBFEiltwZuegsJP0hwo7iuaKzh9hp9bGGuwookKa217sMPqmXnEI9LQPdDESX8v75iMbWTP2ND+1WPh1vX1tib961cXKWUwWE0sz6PYmegVX5c3si424gMI+UQJ5vOSh8JyM4WUjzDZ9CypoaT7ExruWHv7cNcduKSuVCowfKDB2zXcffu3Pp1i310wu0rE2A4XdLDYqzLGjGk5TQ8vwEH3XppGSjWuuLhCZVEjgJkUSyOOCaCgsTepkyoOU4362VkonZ1TkJpZ2rgZLEYQfN9Hl6KqCkZR2GHUxX6b+XPe7n89zQaUVokalvdJ6NF0Hc52iR+MvVkv9KFkQY+ixG8d9vt92hcDNpDj9aHo/jn68B+/87T0c/5/F0d+rVgZO/721Umm4UC/QjNRvFcYYxFXhOxvnLAxxGms5X+d/85raFA3yzhxNqwpzlQKhUgWYaAItGvkq8DoK7W7gDod3hI4uj+6Zby3/2OJJvCI/sTSOgYnvPF2NXaBRxMbextmViWNjaNdNMnQ6FJGkV13XllYgsoENQ5pXnDmWliCTiaVnptZ6MkpwDOfTrNkp91E/qg/27XupPJR026FHbNAealo76mp0M8m9agK3CblvLHoLbQIQGgtRbItuROiIGjARG7RkhxuChDTAzSMgpHOCDVpez9t4KVZW4MDZMaLNDirErk9dt65HXApuLjc03PlaaVxiBXoLyy7/Blr0Gq5TsFwLeowMEMONJ9jIRBES0tQmKWQUANFxoOtipQ6OUHRYEy1yLxbaKTwxwXj+e+NQymHAzEyYn2j9MXNqALEACliPPtceVwM6HTsKAIh38TMc4IdKKChTz7SZLBr42M6fSVUwvWl8j/cyOSO9h+a4CvpSdSl4Csf73P3d8GcYqX/ioFbuHMXT5YzD8gpTfqb0GZTi3ve2im40mXQ3/FhvJD+UayCalaFAbn3OGme4HtTWMN248lL589sFqrgN+OLK8Pdjoe6gslJpZ6XT45eaF+Ooyig8TXPaU14cr7i5uEDzp47Sxk7RNtHmus+TJstUNDB+NPTNnz6P992v47kIGZTYVSM4PO9Ol5VIbwXe6lqivAfuIF2/97VUAq7hnV4bbpYiXncUlBdsLLIZRfZOkb66xP5gfJfRVB2usNVmsgrKFpN/b8tkqCqJXMMym1hT1tqGVTYar64KARl7RVqa61O0NBosFQLvKhYDeUG4GbqOr1svtzeKiJ9HdNeag6sEm8NXQ0cYrYkGO5W+4nHUvV90YVwP/31e630FRjUWOM5FGoxsH0Tx+HLEcBgb9sBH2Sk7Sp/Ycg3jOHxdSIkbqfYkk9L84l3WL2vqQQqFrDQnAPR3cF0c5LMciEggDW9ADmHgxER5bn4nRYt0L5McYU7yN3Ir9KRVwJpqubYDsUzHw5/rvfA8BvkmPUeRfRaq1lYi4gaemQjD2k6neJieQqE+Y5/N5XCKVn7tTmcK0JGAr/Cp6DuNLOf7kuNaaUOFsJ2udNT3KrhelfNK8VWfCu19qmf2FHdMqodKL2NK/k6YtiliGiiGVFh8XCsCk53qPTd8Dmc7K0W33lwka4Zr1JQWK+ED/KiAdwerYUB0oy6M/Niwdg8Khzq2pkJUTUkUfEVsJR9pQlzS8wNktRahIMSiEqBAdbvnns7t9CdM1P98KT5LBWKf+P53u8YMXoT7qs3Yqxip8anW4Zv+gFFhDg1t7HwZqJcP5ffhlB0vcYXrbUsCoGTtfaMUsJq4X8s6m1dAfsoqH8d/Pqo6x3JNpiwGGkImXhtaLFa9dYk2NzyrsBhYDukiBa6IUCjT/4tGUYseqXhr4EfB7fq46hdplNdOO/9rIrmKmH/iznpDbVpu23MmHsOJDllDk0MwA7IvNE6aEZ0MvH/x8/nzfNoHr3dpSI2ibFUEi2KUaJraLGwpnc3zQQXgSbbz8YbvMKp9GE/yMGZzb1MWVI30IwXqLeMe15ocwKioqkGwN+QrSrwcrYa3f/hFKh9KJ9c0Hoo6zUqoikuaLRaqCAyj6HXdQLeFDUeBk1klDohbxrWaD8U+OVA5vcXK5fq4h/lxj12IzMeSu25H9/7FXNtVkphE2tV1K9y0qVcNIskztz1IsgcKrrvtvkg71qD7Yfn4KlevsSovDPcsnOtsBYcZWzji0vkcaXwVxlXz3op0mCNMw/B78btW/S5bZ3FgDKXqPy69Gu7GFzYq6XDlcPXUKQiGHte48tmiVw4tnw6HX/UF6xVvPNtOY85Q5xtUDaoxKiq0rA9Q4CsUNGGgSZNso+LOK6LeYKR1+7v9bUMDJz0IPo+O8eWXbcFeQjeDL0MnwhbpJmuRqUBlARCmGN5oKeYBw3s47grdnlGRilOfPZq4Xs5/a7UV3aTZsvC52//evR1LKZZIxCLvgsYh0UalMuBVfM4xyHF4YrbTBtRb6KmaaRsOMqnPSs+v4/54+nOMDNt6x1YNTyAq7UFeymWNgsnTZwQRqYWmigsc77eyc1TbVZTnT0EMMU0QjDzYSahaHRtrpbCyPxfIlWBKdRbRrsdkKqz5xVLNi5NrkBdPhSWCTJqlX20nGg8kS7r7S+YU7EQTRHFwgY2Tvqx31PFbRsbJWoxWyKXG3v0aXU51q2iYKLHNMv72VYzt1W83n7mWJA0LbVa/3rj7Z9kBZVQw3Nh6f92Od13ClaH4nIoIMz99j2/Hsn4pEYlIeznQ+oaPyt9GsLY2O9ye52IDVjQlXOBitbEdLauqXEIm6XyU1FWK2auxQ62jy7qPlYU3rt21Dv+zAWpaiUsakKf2tDAvDbXE4ns5Sw0X20j2KtyeowIt8LDkZaEYP6kOaP/t8KWyWb4epb9uHNj3HK1UBnPHAvJnvMIDW/CvozPJO/BpOZome1mOJ+hmP3JKL4ajCm/HyE27CAMU9X0lK+a5uDcs3H+fPgsLKj1DO4SDhUWvVr1nqxJKFP6Txm4pmuXhPyf6+JnHN8dI46HTC2JTHFMF1PvG/hpN7M5q1lmpmTNSYAnGsjhPTn2wQ/megi1Wgz93hwpkRDGRdA0fN5ogwHp1R2Njl4o2XlLa4S9uhYKKMUaRMlLIxGqontyelLuc1qTvG/t2NLb0r+hASpXde5TmKGB/NRQDKj1zZOcnrbDlwUVaSzK50czROjr1oFYZCVUHquMSvLco3x6+z/JP1T4lF5H3PIVzXAh94p+VDQeq8YEC34KB6+2x4n63Dq8iCKd5zdVGOTc6dZKDv2pAJYuLHHNxQ81al8CDI+QRzAA0EGj2DbyTnkI79S+yJIPSoaQ8v8TWpkWxU7ovhsL3q/YINFD1idD64L+RkJZbcGOvk4bqmSL5kFwAtGqpli+SmxYvy1XMVdGdCkvZU7Kqwly9YKuAmSPP+W4bSzRJd6IZ7dO8tXbMzdrfmD0etuR5miXgZYlWml6GaulbWS1IaHkLpRbrGrHnIjRenNDGjYookWdhGzrlqvDCHYTFQHw1GbmnF6NEvzVC0BDFLb72JVJaMMlFWRi3Hc+ORmvVFoVRHYcU0aUMVEHyiu6L9hUudr4lVZCHYyO8j6Y2AHmVY7SA2VjamBJpEc7BL7svT7ihvVNdaRQ08DKyOdcG9V7mRtS9jKc9CEpFzrQ+UzRDOfwUkwmFHL6sNMvjyu2nteCXJe3pDgq5OjUchmXw/T0c+fGd6Pfaq/faeiElkePYK4RB48hZx9YJgp30WCaK5gYtd6kaqjpOXStW5rzeilTH0YpuMrGoVeg8nOz8sBOw83Njf32Jy2kwsiTVSgpIWdkLlXH0k4DXDwdPrrC9LrKcx9QITF93Q3CevfrQ6ScM9OEMEsY2xVuWA9K5sJ5TdPFTa69Zdj6djZHNLJARG2w+k4FKp928326pMpJreMOrlcd1oXIue9An1VncN9bcYqVSLR7ENBmTNtmUuICmEd8AHRsOdfqp9V00H8ogT0UD6tQ+6baFva/xIp/nsvdetZfzkt/xz/X38efft9uubExWDPymyxpw6JcaAd9t1EkLl2SSVq3jTngYV9dT8WoPgvixR/8UauCuT9JgjjMeyh+q9SOrDhiu4hHN/CukrqJq5jm0YG7DGWCcIiXnJ+pr8J9d4c/LTKPjnfIVsLP0CDwE/zw6+Hir1mIMff8686qYOChNZ4P5R+6VvOdMGdjw8qmTdeLOLUvJKywL92bD8KhA/PzndD7tbn/zAV1F2SjaZsreUhqtm5LJFg5PWU21jgt5SxPPuayGamyvqqgNNU1rKQdZ+bYlp9+AXkM+j8PwIl+puNoHqrNQyAQPSsx25oHU87I/n/RIBa+n/XfryPvfy16PVoQ3tEEhdg7x+qfUMqeNtmvz0eF4DqsU8wmzQb/EQaXv6JRfTb4tsdPGoR0UMnOCTqSlmYH77hxDp4vOSnqZ8oqwHzr645gnd4kK6GS1MDhGqTmWQ+bvu6jd+D+xmBP5GnSkoeXb6fzcqmWNgzpthPZYQlANtAR731+L80LhcX1HfZH7cXfbv3+ePmqMBFb1U3IY7P24v2nny6m0Nbg9Ddfmuh+DM3h4kU9TcUy1FmlWhNkq9/9hVlEZZSm6L8lojeOQPTzQo7M9JGA5GfpqrUxse68mc2ryMobWqKKdJakQ1SB1TkFutlz2Ohq4hxn836gGF86PZwEN6TpFTkVJk7Kd5+dhs7xU8+xMGZOiEY2lnhS5n4eznTWGBr7kY6rusj9W4fYKBmQar+dFNFwj/1GZCdpJWmc9npUfPEARnLfZBDt/Ct9UNVl39FhaR4bv++v09tySSysrPEu4Wqnq4M7qNvj3iAboslZirbQhrgjwFKfomCITaEfNIN6fQMkIGlcHxXJn0986m08iSFrYrJmMuAzKHg7FcYe2a+dS/te5FDE6l5xl57IqyIirGYVcSKN7muYJb4HWP2WNj8Z9wcBCmqz2a1kehPb2POF1jXgoWo0Jdt/O15/N9K9c0R0FBMc9rVZ6kdQAIwVzxtEhJj5tNWHluvcUDxXzCS+ax6IIKsvm3PWJTg+t0iktprATQfEaweyYdaxAEILZ7cYEf3ETCofQrXcT1LAmjEW6wk0jxjaOukf03ZZM/p/dufBtFCS3cfxu8VyKOC+WN/jYulyEzAWHFZ0yc7wvJFjaKnPJl0+dqffdXqN0JG1R2Bqgz56vKNRmMbY5QCaVx4SHFyziints1fzyoOIr2reIwdVenUFxXk9UmwlWUr5cG1FfClKhM/en369fwS/f/463VHwv8cH6tE0OCTozJV3naURelEL17qezZlgY1TEMDlkLFRfbodW+S1gb23EPZiHNXzc/fVRLkFfDFQ9r5nwEs+cK5d4uBKt4h2nybbUW00HfpBucDM09r/CtBh+rGquefIoWgMND7uHgV6tAkUpDRNIhy+hdhqGl7Lz3YKaHSxgOS/5RgrNRRWEoxt2GJ/n79Lm4T7ePzW4+KJ3RCawKE021LHT9NYD+oPqtaXJCjK+phvW92qFpkeZ+fr7VytjyJrj/sLBAFqfrJAuHtrcAtnOfdjFT5njHTrkIlGJiHV3CKZUwLydmCJuWznebQUnO8iLuMvLHruwb8mownYvL4C2WaFB45ZGfJXl8pclb8VSOfJdZjEScezFc9YhTdr91+EaldlBtEbxisxwXITQr6DF1lxEnBLnHdXzYxVzZorWrJ796A0Nj6pQJKdV3C8z3azGj0NGlrmbTQbnawxHxSZ7BAAASy87pKm1kZkguvsExZgb04g4+l1pwleJdMybpBQMNPzMlnnPrk8sXroD1ykELNNNBmOdAmOfsjPAF6ivOIbhBabPvs5va4QpOLJJW4wznFOq/EzR/JwRGkyiaptDHJO1hb0A3aVJI4l+MUcumzyfpNnMp2/SdzyU2ZoLnRWZ1bM00G76a4OShMnKe+Y6/WlmSs0ViRe6UMz/AFgOnqJtUPIZiL+WZSjG+FpXNKgXARQRXO/fwIPvHRgN5VoS9Mz97RJqJta+qnly6kwhDr8x3AcHqVG5k5uk8YWnzXMGKVVbopiSscJHCXvFntSfeamvDRemkNzrxTbK0scEHykIAJ3gPdr4uX9fb7xJUI9OChnfK3z+P+6iJVRWHlnUELsx5/zyfHiFY2Z+POx2Me/kQnvPQLBbiH+5WGvNHyaU+KreLz95HUS4YelUiyvV+ChNfTOx0WV3Rg3l0EvYAiwwUvrkph0yqWc1DcbtHI+qQkkKey3MtZiu510khHfycbrWRzImW/oVInrJLSWCitWAnQufCH2snZLLKeeQ7R7ZRe0IlReh5LnOxstLJEDCQvB3DF8hiqJ7nlu68oX0eqwXRJ1XV5JLpm0ZyYrH1ClurWo2TdJato50eq6XUx3u8vIWYuKhtK2kInnpeDb3frl/1t2TVW6K7SDDzvO+vWvvFSgQB3LMx8aHBTYO3ZEEH66YU0josfDcjIYj+IDcjtTxD02ZGknmG9zXDl5p7/NmA30AGdwafcM7vzvDX5uT4+g7bUYcesC7dVbhKYXjn8O8c/szj3yV2GQ//2XcDruDNdQj6u+SLhqv0uxxCGknVdCasU1sqX8ab1IpSc58Se+yU0E9TStjP6avOKfE6p7yr6UwGD+JqQtcOCLD9iDAADNW5tXFMuV0zZ85gUPLMGDHnwiPSVz3CAAQTFr9hAdizyC7bEX874nOYZM9zEF97mUuHzvH8jLSxqnQdli6Owq2zsuI2cHdjY662RxvNZMtPi8VYQYI5jOrMTrBHg+UXvg++3oQJTJt+/w1yTNVNHE+wraZqJmRqB20/WZHaIaIF6DDE09TlXX9ni7N2siwenrn11fU+KoOZPvVd92lZIezs037Wp3ncp5hzHPJKwftPQbnNyF2DeqtN23S4StQ5bkQQjRyWB80yOsJdn1ZKmNppo27k2+Lz1sqnqnV3TuGuNbS7b7FUYHKM6ifjafbKtFC6Bx1eAs4FrlQS2Vb2j4/iPBwUrm9qzKDI1bKR41PMPZY2XsbRnyFAOl423SpGAZR8SsmGQJ8ae/48XGO/MAwuVOBb8HnY0SVSyNOmEVjMmXfi4inhONqUWbFHMvmqhZtCB4O91fH8Bo4uHSxreAzBzW10eZSfbmjbMkwWxLmKB5m7as8NzYnqGjUWZfahpzN0VV/eJtlnWYCxjVSxNHC8/Sl0emfJ52BH2sBQI8JRsFN6FC4D/zXoVFVD+MyJNr+b1oPqV+Huw8qcun8/bjpFFHGL43SWLxPHTH5VtpVLLjJOSwM72AOK5KGqq/ikAeJBd+x7Hukl26sejoYUyIN9oGRCLxMlnlX2cAw8kHoNrrcFRR51uWmgjd+C4hXKtWFLoXvA1ypkHWsTxauTIDLPJWReFn5FHkltQCLfw1FMF+zf+37TRqloUbuJzqO/9xBpVmiNJCgvBCss7H3sfscO089i8slJ3FHOlUfYJQv0pCyoTiDX5gmq1QRRkFUsPi9fpU+tTZCFCYd+ysaAi9cCm2snepqsv/3ac+9XReU3q9L3QMHeMcyvdXzMCnnB+6pqdF+jU9tQCletTbGVR4uI7zNBA01tpN/48Wd3O0XGOf1jqnWLruRk5EC5/tUTG+pjwNB3Z7gSwqOnDM+zeJX5scClAhhnIP1jjcMVnOIONSGDCpQBTMmkuCN8AodPwLYyfZfbHniviJR7WoiFnZoLOXrl9kC2m0czyVzJLW2UUFW4H3ZUSwPLP9dG5ALum2toMbKlqFakc4ZSKSYLNWRBNygeSZpsTzY2vVtK+y28C9CCUgcqmdI4MsUs2VPFbgzekkL6QfXHZeIaim+PxXaN3zKK/oMGKnHg43q6FD0CXpULKFgkbujaiVViarQfLY778f740Geh0oXzPYW/LaM/drffh+tXUS4Z1fLiJ0K0cHHFWKUrTE/xZezjeXuUS0mVWHpKUL7keTcHea/ibF44jvrDRcwnm/Ycb9p7XPe7y/Vy2kf19dO2lV1x8Q18J7iGP/m8XsKf3f9zLwG+g1JQGbk7ct3w7hjlUTtK6v24rsRIJSPSoEbz21+FiHTNR5WnZtSRwGg6wMsYqZLx4/r7ePlG3VtxQ3COu8f1HBt9N+BWxZzAD95r7Gyvtqd6JYfMlRcf1/iPDhsIT6/i94H2W4Txx69N7kQx0VlUD5DachanrqPJyMd1pQit3JuawBQEGQzcTuF03p23NzirGwS0HEUN6wE94Wft9fOk+uQmRc3pk7dhe7BhD3BsuYhGMJt0UCqPrmhrKf49ZuZWmr4iTlOxLPdhXwTGj506riYF0+gBeUSOzjsEodDh8Z5idx/XdDSWFA+jV64nLaIGC2FfqlDJGhVte5o6DFHK5f7rWr5mdboMfPWk0ZFl/nhYX1pJ8aVcJpq5gqmq/JriGqRxa/j5j/NxFxXn7+fd/b3YOXtF4cpb6KKZcDunM7WjGEy4F/hQ25qTXteM5u2GD7g5eqdRod/5E5TdKBJcMQEq71P10YIb1fYZZoA/GwyOh8S+EVZy+ncZaebQ1OBon3+8tYMEEdQaymWob0f+vaOtf0eKJs9MS7k9F4PVtL5SKKMt8mQxdoqekbOGPxeVt1+lvyS9bK7S8LxAMZNJJKhOuY4uxeclvsjvtETUG2lZqlf65Yo29AhbDDTVOJXkGj2qVjtN1QexsrheWrDz32e1CVGdS3SChPE6uyQhaRM62DhsKRr48fPvo5ygEm3tOG/58/I7em7B4znt4mQlhRuvDo+05oMnkNAKHk1QPQUIPy/xVGMCoL3M0kS8MLcSfLyYTfy52/8ueakVJzdd1s/Lx/UQ062H++lSEFR3qq8aanUOmIrwifjbvB/3z0UE7v7YXR7frRl1/vCbXY0uL65uRk5V5v4LMys+/74IJO2v+kySWPuJJmmCsZQ5XwDf9SWtPG6a3hK2MA3ZfqWI7Kmzt+109hIKZCBGZ6xAYaTYZ6QUmatdNAGlObRpq1akc+E10E/yQrgeP+Mzr6P1slNsI5RmAvhWncvwEu5muNLHOlxgzLSRWRmhU38xsvRFbf21blbnHUVlr0bCkVd7F6q+S9VVgdKtf5q+V2EcP3kXMxXGXwXyTVAuwxtvhaHapmcU1Q71HBPWt8GZKD9TY+dLoOH3r+Pp7f1RluQkWqGjJFCrlcSl/WopVdvIrDiqUuekMQlCFxUGm8ZrRiV6bE7b8Uzpt1ZDbGmplgN+2iw2tmAao85Xz/2Dz7AsI1nyhj11UuUXx12mz7I5wKtMU9cDrJb8bjPihY/8yW4nvbnKBImbwD48J34QN9uMawT+scffDhgx4s8yWrDL2ETgCxNgx3c9kIYjRgCe1VHATcn4r2DrfMyPheBF5eB6eViZgUrohNGVor9RnMieYsCe903DqCzgcObHZ+Gdeqe2doptiuMiLLYWRaiEHH/F9y0dSpRVln4WLcs9o5rlF+KQbce9InFDmxM8LQoA+TN8nN5WgUDGW6HQUxP1ruqWNmQ0yjmd6GJ95T5Luh/5kOjqAocQc4ySsSXrfD+VTkan9P4oljZbeQkTF4FCrzgP6JafzByOv5b3VEYITkUIFFuWzcS2nm3jk1Fgw/BY7JRIhghywirG9fHbd8zkTeLakg8GNgdQ7Dl0SrielpbTz8Te3uI+5XsbKRQXBgRwSSeC5ErqgRYc8hUlwk+2KwRBZlZRPc0aJhNfp8f7tsCj+HU5Ic/LSDj1WV9e8CRkvmumhYC6XJ46sxHYAVTKOatgrlLWVi+oaYAtHSWv4Wikv3VCJtUXndoaQGwOZtzgVzbm1VOoX+ocoWR0ab1qaaHglpeKq7RmspjQNVz52xZ4Yu8gq5K5erzBVULNe0/Lb+tvHR/Fz3n1c9n0ANMOppsfqEbVZpTAk2t/jA27aKfkSmxrh15HE97eYEgpQTT2xIseOCi5r5HGgHXwjcI30OJqGvszjCtrBoOsUpqZovmSjSpdrAKOJHCRNTR9mozFQKS0pbq/aNL9z353K5gMJKTQjzRy+XO8/bxqqN1oFKcYEPMdOkU6dIp0SON3NMqKjF8xQlZepVdeJZ+ncazWthYTK503zcGJ/08TXckszUxB4auF4z+n+6IvWMtYzpLe004oTXA9p9XoNpErp57jm2CIgllznkI3UAaXl4Wyn0WuHjOlrx4+DX05p3AIf9Mu6NQdMc//z+n2eG5LxUaJhjeOvHV4rRSpSgWOcij+Od1PxW7iVauMS0A2w7kC/lz3u5/P864gtejlyeR5yi8Pjz1ABSpBcXmP3FWFjW35WjU5c6B5NlHRT1CaSSMPBK6nQ5X4X6lBUvDJOnzDnyRLn2Hj4e8gja5SzymyJ1oe/9rtFxwyEQKdFCWmo9i1ipky3psUM4CjeblkqiVqLtny6Tz72p0eIUJf2YMe16NmEDNKWy44Qew1f+1uGi/ZKQpI9Eqh8TOcH7iCyE5H2wK+Yqj0KzxyPeEva16WJjO+jj93+3OtdCfPVRoKheHv1+vvWHO4HM+2swrMNkmH3HJnbWuldLwmxfnr+TtZLR0/TqWjMI3Ki6VJwpeFpcCjxyu3lM/CcqDi/EqpwA59q53DvgkSHDfiz5L3YBBTWJuSgBb9Fban/BTL/fx4ecI/iDvaW8VdT08Bbaz8SAq7FzHGLSslqKZXPBeOwgowuDgLlQaO4WBZjN8S+HfqJYB+iMOjF1tbOzLHZMBZaHp8c56bWCxumj6dxCROAKcgU2vAv2fgbkYNiDSJDK4ShMxA/8GAptH0YJ9uTu+1Yql3aCV9BXA7Vw6HmbjYq6tVMd61vkC2UzuG5F4d7uf/j51NfmEaFcKM5nCUsZrq5TSpBBFFGCtDy6wozMgwpKfwaJipd4xPqiXDt+bmaobs9rPiWeq551CxU24ls+IU6ikEBbaqLojqXqftvqWN7XfXGpbfT6KS8m9SwDAKgs9ogG+4qOWcdhThvRYVdQpIknDQMkOIWcJku9QcTHkGcoySMlD1MeUL6WgkFzOYSSpvCVErUsmy+MHzMdFSZbBqA86646h7uQ4pLr4jnlaqz615BYe1PXgihnyFJkIQeDhk0BxAqoitvMNNOsp7HW9o8X0rD6wYTHv8OmhGLHgtoNTkIZQd7ggsox5ZwAEvix/4C63Vx+6yKybUIBMphmMJq7xYVg2lHuFt9/m5CxFjIZGthGmd4ydMHB/7XT9Pt5fUNl7uJnpTHYR8MmqT1SylfDFhx6EvZjW1DFvBkdt8p+rL4LvyaolzgsuF5vkeFs1EAtzt5qEiio5mPJe3q3EZCk3RGgY4kM4/ybNkQmYucyFPKX9t5+Sj2RmsFrPHFegiZ8RnM01aLndU0XWW5emx8SJfo8tmuVlVlyZg9rlW4mrqun8uf6rejDKF6HNCrDGBeQzQAwtypfBmcAX+kBlvdeYHTLyhKkWiYlKYwCo9IYkKLqjwqVArQlvM7PGBBqQZweLUJb3C8Nr/1a1tXr2UGrITWii4ZNHX11csuDdSEnJ2jzSb/s+9TF7L5ThSV/RvTKaE/6t0Kg4qWpvoIywm9udTnQjdqlo87UpajNRuQommTTTntoyvCqQpQl0zUbBVtPCn+hrUHdShKv/n//1/Pk+fsREk/LP/7//87//+X+D48qY/Bw8A"; \ 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..6af987eff --- /dev/null +++ b/7.x/docs/classes/AbsolutePathInteractionRoute.html @@ -0,0 +1,159 @@ +AbsolutePathInteractionRoute | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0b485133f --- /dev/null +++ b/7.x/docs/classes/AcceptPreferenceParser.html @@ -0,0 +1,181 @@ +AcceptPreferenceParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..14ad91ad1 --- /dev/null +++ b/7.x/docs/classes/AccessChecker.html @@ -0,0 +1,175 @@ +AccessChecker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class AccessCheckerAbstract

+
+

Performs an authorization check against the given acl resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..e98b7039a --- /dev/null +++ b/7.x/docs/classes/AccountInitializer.html @@ -0,0 +1,224 @@ +AccountInitializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..fafad17c1 --- /dev/null +++ b/7.x/docs/classes/AccountPromptFactory.html @@ -0,0 +1,252 @@ +AccountPromptFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..0528496ff --- /dev/null +++ b/7.x/docs/classes/AcpHeaderHandler.html @@ -0,0 +1,218 @@ +AcpHeaderHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class AcpHeaderHandler

+
+ +
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

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

Methods

+
+ +
    + +
  • +

    Checks if 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..e320c1fcd --- /dev/null +++ b/7.x/docs/classes/AcpReader.html @@ -0,0 +1,326 @@ +AcpReader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..0bba6a57c --- /dev/null +++ b/7.x/docs/classes/ActivityNotificationGenerator.html @@ -0,0 +1,200 @@ +ActivityNotificationGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ae757a995 --- /dev/null +++ b/7.x/docs/classes/AddRemoveNotificationGenerator.html @@ -0,0 +1,201 @@ +AddRemoveNotificationGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..85940a203 --- /dev/null +++ b/7.x/docs/classes/AgentAccessChecker.html @@ -0,0 +1,171 @@ +AgentAccessChecker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class AgentAccessChecker

+
+

Checks if the given WebID has been given access.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..c5eaca28b --- /dev/null +++ b/7.x/docs/classes/AgentClassAccessChecker.html @@ -0,0 +1,171 @@ +AgentClassAccessChecker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class AgentClassAccessChecker

+
+

Checks access based on the agent class.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..ac3db43e8 --- /dev/null +++ b/7.x/docs/classes/AgentGroupAccessChecker.html @@ -0,0 +1,219 @@ +AgentGroupAccessChecker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..62ed7385c --- /dev/null +++ b/7.x/docs/classes/AllStaticReader.html @@ -0,0 +1,191 @@ +AllStaticReader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..2af6fa333 --- /dev/null +++ b/7.x/docs/classes/AllowAcceptHeaderWriter.html @@ -0,0 +1,352 @@ +AllowAcceptHeaderWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..f6dcafc62 --- /dev/null +++ b/7.x/docs/classes/App.html @@ -0,0 +1,158 @@ +App | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..81727c8e2 --- /dev/null +++ b/7.x/docs/classes/AppRunner.html @@ -0,0 +1,369 @@ +AppRunner | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a77f88de9 --- /dev/null +++ b/7.x/docs/classes/ArrayUnionHandler.html @@ -0,0 +1,244 @@ +ArrayUnionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..0cfcdfa04 --- /dev/null +++ b/7.x/docs/classes/AssetPathExtractor.html @@ -0,0 +1,201 @@ +AssetPathExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..615457a39 --- /dev/null +++ b/7.x/docs/classes/AsyncHandler.html @@ -0,0 +1,242 @@ +AsyncHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..9c4e9e4cf --- /dev/null +++ b/7.x/docs/classes/AtomicFileDataAccessor.html @@ -0,0 +1,438 @@ +AtomicFileDataAccessor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5f9de670c --- /dev/null +++ b/7.x/docs/classes/AuthAuxiliaryReader.html @@ -0,0 +1,250 @@ +AuthAuxiliaryReader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..e5868435c --- /dev/null +++ b/7.x/docs/classes/AuthorizationParser.html @@ -0,0 +1,210 @@ +AuthorizationParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c7fb7bb66 --- /dev/null +++ b/7.x/docs/classes/AuthorizedRouteHandler.html @@ -0,0 +1,212 @@ +AuthorizedRouteHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6f3e9c89a --- /dev/null +++ b/7.x/docs/classes/Authorizer.html @@ -0,0 +1,174 @@ +Authorizer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..ee4074661 --- /dev/null +++ b/7.x/docs/classes/AuthorizingHttpHandler.html @@ -0,0 +1,250 @@ +AuthorizingHttpHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..e8b30d950 --- /dev/null +++ b/7.x/docs/classes/AuxiliaryLinkMetadataWriter.html @@ -0,0 +1,231 @@ +AuxiliaryLinkMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..9f4ceb701 --- /dev/null +++ b/7.x/docs/classes/AuxiliaryReader.html @@ -0,0 +1,242 @@ +AuxiliaryReader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..2717036c0 --- /dev/null +++ b/7.x/docs/classes/BadRequestHttpError.html @@ -0,0 +1,238 @@ +BadRequestHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..71288f3d9 --- /dev/null +++ b/7.x/docs/classes/Base64EncodingStorage.html @@ -0,0 +1,279 @@ +Base64EncodingStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..bbf649380 --- /dev/null +++ b/7.x/docs/classes/BaseAccountIdRoute.html @@ -0,0 +1,158 @@ +BaseAccountIdRoute | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f192c1558 --- /dev/null +++ b/7.x/docs/classes/BaseAccountStore.html @@ -0,0 +1,295 @@ +BaseAccountStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..8de2b4b59 --- /dev/null +++ b/7.x/docs/classes/BaseChannelType.html @@ -0,0 +1,347 @@ +BaseChannelType | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1a5f1df4d --- /dev/null +++ b/7.x/docs/classes/BaseClientCredentialsIdRoute.html @@ -0,0 +1,153 @@ +BaseClientCredentialsIdRoute | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..83a15390d --- /dev/null +++ b/7.x/docs/classes/BaseClientCredentialsStore.html @@ -0,0 +1,332 @@ +BaseClientCredentialsStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..ee26912b2 --- /dev/null +++ b/7.x/docs/classes/BaseComponentsJsFactory.html @@ -0,0 +1,171 @@ +BaseComponentsJsFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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

      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..0d7e682b9 --- /dev/null +++ b/7.x/docs/classes/BaseCookieStore.html @@ -0,0 +1,219 @@ +BaseCookieStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2eb160711 --- /dev/null +++ b/7.x/docs/classes/BaseEmailSender.html @@ -0,0 +1,204 @@ +BaseEmailSender | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class BaseEmailSender

+
+

Sends e-mails using nodemailer.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

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

Methods

+
+ +
    + +
  • +

    Checks if 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..17a704dab --- /dev/null +++ b/7.x/docs/classes/BaseFileIdentifierMapper.html @@ -0,0 +1,464 @@ +BaseFileIdentifierMapper | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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.

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

    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..5684acb35 --- /dev/null +++ b/7.x/docs/classes/BaseForgotPasswordStore.html @@ -0,0 +1,198 @@ +BaseForgotPasswordStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ec54adc9d --- /dev/null +++ b/7.x/docs/classes/BaseIdentifierStrategy.html @@ -0,0 +1,195 @@ +BaseIdentifierStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6bbd15087 --- /dev/null +++ b/7.x/docs/classes/BaseLogger.html @@ -0,0 +1,279 @@ +BaseLogger | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b921d84d9 --- /dev/null +++ b/7.x/docs/classes/BaseLoginAccountStorage.html @@ -0,0 +1,607 @@ +BaseLoginAccountStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..dbcdf944c --- /dev/null +++ b/7.x/docs/classes/BasePasswordIdRoute.html @@ -0,0 +1,152 @@ +BasePasswordIdRoute | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..91f24a030 --- /dev/null +++ b/7.x/docs/classes/BasePasswordStore.html @@ -0,0 +1,425 @@ +BasePasswordStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..6653c7214 --- /dev/null +++ b/7.x/docs/classes/BasePodCreator.html @@ -0,0 +1,291 @@ +BasePodCreator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..3ce5d6ddb --- /dev/null +++ b/7.x/docs/classes/BasePodIdRoute.html @@ -0,0 +1,152 @@ +BasePodIdRoute | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3fbda2083 --- /dev/null +++ b/7.x/docs/classes/BasePodStore.html @@ -0,0 +1,426 @@ +BasePodStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..19d9c5d14 --- /dev/null +++ b/7.x/docs/classes/BaseReadWriteLocker.html @@ -0,0 +1,383 @@ +BaseReadWriteLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f0fac2160 --- /dev/null +++ b/7.x/docs/classes/BaseResourceStore.html @@ -0,0 +1,284 @@ +BaseResourceStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..004fb2f79 --- /dev/null +++ b/7.x/docs/classes/BaseResourcesGenerator.html @@ -0,0 +1,330 @@ +BaseResourcesGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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<any>>
+
+ +
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..7d548ca45 --- /dev/null +++ b/7.x/docs/classes/BaseRouterHandler.html @@ -0,0 +1,252 @@ +BaseRouterHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..568e1e95b --- /dev/null +++ b/7.x/docs/classes/BaseServerFactory.html @@ -0,0 +1,160 @@ +BaseServerFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..891fe8a3b --- /dev/null +++ b/7.x/docs/classes/BaseStateHandler.html @@ -0,0 +1,217 @@ +BaseStateHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..c0a6c7219 --- /dev/null +++ b/7.x/docs/classes/BaseTypedRepresentationConverter.html @@ -0,0 +1,233 @@ +BaseTypedRepresentationConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f50d06687 --- /dev/null +++ b/7.x/docs/classes/BaseUrlExtractor.html @@ -0,0 +1,191 @@ +BaseUrlExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..5fad6d483 --- /dev/null +++ b/7.x/docs/classes/BaseUrlHandler.html @@ -0,0 +1,188 @@ +BaseUrlHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..772287315 --- /dev/null +++ b/7.x/docs/classes/BaseUrlRouterRule.html @@ -0,0 +1,236 @@ +BaseUrlRouterRule | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ 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..212552fef --- /dev/null +++ b/7.x/docs/classes/BaseUrlVerifier.html @@ -0,0 +1,208 @@ +BaseUrlVerifier | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..77f71c17a --- /dev/null +++ b/7.x/docs/classes/BaseWebIdLinkRoute.html @@ -0,0 +1,152 @@ +BaseWebIdLinkRoute | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a39053083 --- /dev/null +++ b/7.x/docs/classes/BaseWebIdStore.html @@ -0,0 +1,326 @@ +BaseWebIdStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..5e5075903 --- /dev/null +++ b/7.x/docs/classes/BasicConditions.html @@ -0,0 +1,193 @@ +BasicConditions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6091661d8 --- /dev/null +++ b/7.x/docs/classes/BasicConditionsParser.html @@ -0,0 +1,246 @@ +BasicConditionsParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..eabb43aff --- /dev/null +++ b/7.x/docs/classes/BasicETagHandler.html @@ -0,0 +1,183 @@ +BasicETagHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..08c3b17e8 --- /dev/null +++ b/7.x/docs/classes/BasicRepresentation.html @@ -0,0 +1,301 @@ +BasicRepresentation | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f104bdf51 --- /dev/null +++ b/7.x/docs/classes/BasicRequestParser.html @@ -0,0 +1,220 @@ +BasicRequestParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..94b053705 --- /dev/null +++ b/7.x/docs/classes/BasicResponseWriter.html @@ -0,0 +1,212 @@ +BasicResponseWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5ffaf6380 --- /dev/null +++ b/7.x/docs/classes/BearerWebIdExtractor.html @@ -0,0 +1,192 @@ +BearerWebIdExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class BearerWebIdExtractor

+
+

Responsible for extracting credentials from an incoming request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

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

Methods

+
+ +
    + +
  • +

    Checks if 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..89b62f938 --- /dev/null +++ b/7.x/docs/classes/BinarySliceResourceStore.html @@ -0,0 +1,325 @@ +BinarySliceResourceStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..22e8c66de --- /dev/null +++ b/7.x/docs/classes/BodyParser.html @@ -0,0 +1,175 @@ +BodyParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class BodyParserAbstract

+
+

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

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..a004b96aa --- /dev/null +++ b/7.x/docs/classes/BooleanHandler.html @@ -0,0 +1,214 @@ +BooleanHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..5c9e41299 --- /dev/null +++ b/7.x/docs/classes/CachedHandler.html @@ -0,0 +1,273 @@ +CachedHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

  • +
  • +

    TOut = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

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

Methods

+
+ +
    + +
  • +

    Checks if 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..305de2e49 --- /dev/null +++ b/7.x/docs/classes/CachedJwkGenerator.html @@ -0,0 +1,184 @@ +CachedJwkGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..705fa26a0 --- /dev/null +++ b/7.x/docs/classes/CachedResourceSet.html @@ -0,0 +1,148 @@ +CachedResourceSet | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f1dd7125d --- /dev/null +++ b/7.x/docs/classes/CancelOidcHandler.html @@ -0,0 +1,171 @@ +CancelOidcHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class CancelOidcHandler

+
+

Cancel an active OIDC interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ 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..9ec1350f9 --- /dev/null +++ b/7.x/docs/classes/ChainedConverter.html @@ -0,0 +1,419 @@ +ChainedConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3627d89af --- /dev/null +++ b/7.x/docs/classes/ChainedTemplateEngine.html @@ -0,0 +1,227 @@ +ChainedTemplateEngine | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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<any> = Dict<any>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

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

Methods

+
+ +
    + +
  • +

    Checks if 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..bfef6e30b --- /dev/null +++ b/7.x/docs/classes/CliExtractor.html @@ -0,0 +1,184 @@ +CliExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..47675407a --- /dev/null +++ b/7.x/docs/classes/CliResolver.html @@ -0,0 +1,119 @@ +CliResolver | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..99cd7bdf3 --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsAdapter.html @@ -0,0 +1,271 @@ +ClientCredentialsAdapter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6ba0e2133 --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsAdapterFactory.html @@ -0,0 +1,155 @@ +ClientCredentialsAdapterFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6ea024bcd --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsDetailsHandler.html @@ -0,0 +1,206 @@ +ClientCredentialsDetailsHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+
\ 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..14775c1cc --- /dev/null +++ b/7.x/docs/classes/ClientIdAdapter.html @@ -0,0 +1,295 @@ +ClientIdAdapter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..33806a56f --- /dev/null +++ b/7.x/docs/classes/ClientIdAdapterFactory.html @@ -0,0 +1,146 @@ +ClientIdAdapterFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..67497f9a6 --- /dev/null +++ b/7.x/docs/classes/ClientInfoHandler.html @@ -0,0 +1,190 @@ +ClientInfoHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+
\ 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..96bb9169e --- /dev/null +++ b/7.x/docs/classes/ClusterManager.html @@ -0,0 +1,213 @@ +ClusterManager | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7b5869060 --- /dev/null +++ b/7.x/docs/classes/CombinedShorthandResolver.html @@ -0,0 +1,190 @@ +CombinedShorthandResolver | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..2d5ae818d --- /dev/null +++ b/7.x/docs/classes/ComposedAuxiliaryStrategy.html @@ -0,0 +1,336 @@ +ComposedAuxiliaryStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..53d1a803e --- /dev/null +++ b/7.x/docs/classes/ComposedNotificationHandler.html @@ -0,0 +1,213 @@ +ComposedNotificationHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..dac79b05b --- /dev/null +++ b/7.x/docs/classes/ConditionalHandler.html @@ -0,0 +1,266 @@ +ConditionalHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..32a191e91 --- /dev/null +++ b/7.x/docs/classes/ConditionsParser.html @@ -0,0 +1,173 @@ +ConditionsParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class ConditionsParserAbstract

+
+

Creates a Conditions object based on the input HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..3d695b332 --- /dev/null +++ b/7.x/docs/classes/ConfigPodInitializer.html @@ -0,0 +1,215 @@ +ConfigPodInitializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..b6749db4c --- /dev/null +++ b/7.x/docs/classes/ConfigPodManager.html @@ -0,0 +1,196 @@ +ConfigPodManager | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..bb272c412 --- /dev/null +++ b/7.x/docs/classes/ConflictHttpError.html @@ -0,0 +1,228 @@ +ConflictHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..33ecf196f --- /dev/null +++ b/7.x/docs/classes/ConsentHandler.html @@ -0,0 +1,251 @@ +ConsentHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
    + +
  • +

    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..cf2891f9a --- /dev/null +++ b/7.x/docs/classes/ConstantConverter.html @@ -0,0 +1,233 @@ +ConstantConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..868aee008 --- /dev/null +++ b/7.x/docs/classes/ConstantMetadataWriter.html @@ -0,0 +1,193 @@ +ConstantMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..834da52e7 --- /dev/null +++ b/7.x/docs/classes/ContainerInitializer.html @@ -0,0 +1,218 @@ +ContainerInitializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..dd874b243 --- /dev/null +++ b/7.x/docs/classes/ContainerPathStorage.html @@ -0,0 +1,288 @@ +ContainerPathStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..647a83c4e --- /dev/null +++ b/7.x/docs/classes/ContainerToTemplateConverter.html @@ -0,0 +1,301 @@ +ContainerToTemplateConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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..6341abc6c --- /dev/null +++ b/7.x/docs/classes/ContentLengthParser.html @@ -0,0 +1,198 @@ +ContentLengthParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..28f300f93 --- /dev/null +++ b/7.x/docs/classes/ContentTypeMetadataWriter.html @@ -0,0 +1,176 @@ +ContentTypeMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class ContentTypeMetadataWriter

+
+

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

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..cdacb1102 --- /dev/null +++ b/7.x/docs/classes/ContentTypeParser.html @@ -0,0 +1,186 @@ +ContentTypeParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f5862d172 --- /dev/null +++ b/7.x/docs/classes/ContentTypeReplacer.html @@ -0,0 +1,243 @@ +ContentTypeReplacer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e3acff2f7 --- /dev/null +++ b/7.x/docs/classes/ContextDocumentLoader.html @@ -0,0 +1,140 @@ +ContextDocumentLoader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8894493f5 --- /dev/null +++ b/7.x/docs/classes/ControlHandler.html @@ -0,0 +1,277 @@ +ControlHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b9d2067c9 --- /dev/null +++ b/7.x/docs/classes/ConvertingErrorHandler.html @@ -0,0 +1,247 @@ +ConvertingErrorHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..7a71f74eb --- /dev/null +++ b/7.x/docs/classes/ConvertingNotificationSerializer.html @@ -0,0 +1,200 @@ +ConvertingNotificationSerializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..34aaa0d17 --- /dev/null +++ b/7.x/docs/classes/ConvertingOperationHttpHandler.html @@ -0,0 +1,200 @@ +ConvertingOperationHttpHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a31231236 --- /dev/null +++ b/7.x/docs/classes/ConvertingPatcher.html @@ -0,0 +1,242 @@ +ConvertingPatcher | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6767ae846 --- /dev/null +++ b/7.x/docs/classes/ConvertingRouterRule.html @@ -0,0 +1,251 @@ +ConvertingRouterRule | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
    + +
  • +

    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..b2e18ffd3 --- /dev/null +++ b/7.x/docs/classes/CookieInteractionHandler.html @@ -0,0 +1,212 @@ +CookieInteractionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4570d3109 --- /dev/null +++ b/7.x/docs/classes/CookieMetadataWriter.html @@ -0,0 +1,208 @@ +CookieMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..e955c5ffe --- /dev/null +++ b/7.x/docs/classes/CookieParser.html @@ -0,0 +1,208 @@ +CookieParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..dcc316058 --- /dev/null +++ b/7.x/docs/classes/CorsHandler.html @@ -0,0 +1,250 @@ +CorsHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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: (() => any);
            setHeader: ((key, value) => any);
            statusCode?: number;
        }
        +
          +
        • +
          end: (() => any)
          +
            +
          • +
              +
            • (): any
            • +
            • +

              Returns any

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

              Parameters

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

              Returns any

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

            Parameters

            +
              +
            • +
              Optional err: any
            +

            Returns any

      +

      Returns void

+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..7bbad5ba3 --- /dev/null +++ b/7.x/docs/classes/CreateAccountHandler.html @@ -0,0 +1,265 @@ +CreateAccountHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class CreateAccountHandler

+
+

Creates new accounts using an AccountStore;

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

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

Methods

+
+ +
    + +
  • +

    Checks if 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 if 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..9d777dabd --- /dev/null +++ b/7.x/docs/classes/CreateClientCredentialsHandler.html @@ -0,0 +1,235 @@ +CreateClientCredentialsHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class CreateClientCredentialsHandler

+
+

Handles the creation of client credential tokens.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

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

Methods

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ 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..199658f5b --- /dev/null +++ b/7.x/docs/classes/CreateModesExtractor.html @@ -0,0 +1,199 @@ +CreateModesExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..16bd6e3ec --- /dev/null +++ b/7.x/docs/classes/CreatePasswordHandler.html @@ -0,0 +1,226 @@ +CreatePasswordHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ 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..10b4c652c --- /dev/null +++ b/7.x/docs/classes/CreatePodHandler.html @@ -0,0 +1,268 @@ +CreatePodHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ 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..3a6a19eb3 --- /dev/null +++ b/7.x/docs/classes/CreatedResponseDescription.html @@ -0,0 +1,129 @@ +CreatedResponseDescription | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..9a1e9c096 --- /dev/null +++ b/7.x/docs/classes/CredentialsExtractor.html @@ -0,0 +1,177 @@ +CredentialsExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class CredentialsExtractorAbstract

+
+

Responsible for extracting credentials from an incoming request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..90ca2d65f --- /dev/null +++ b/7.x/docs/classes/DPoPWebIdExtractor.html @@ -0,0 +1,208 @@ +DPoPWebIdExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..f075fcb98 --- /dev/null +++ b/7.x/docs/classes/DataAccessorBasedStore.html @@ -0,0 +1,851 @@ +DataAccessorBasedStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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. +In case of 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..36d86d7b4 --- /dev/null +++ b/7.x/docs/classes/DeleteClientCredentialsHandler.html @@ -0,0 +1,199 @@ +DeleteClientCredentialsHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class DeleteClientCredentialsHandler

+
+

Handles the deletion of client credentials tokens.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clientCredentialsRoute: ClientCredentialsIdRoute
+
+ +
clientCredentialsStore: ClientCredentialsStore
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ 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..73bfd1afa --- /dev/null +++ b/7.x/docs/classes/DeleteNotificationGenerator.html @@ -0,0 +1,173 @@ +DeleteNotificationGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..d72d45e4f --- /dev/null +++ b/7.x/docs/classes/DeleteOperationHandler.html @@ -0,0 +1,191 @@ +DeleteOperationHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class DeleteOperationHandler

+
+

Handles DELETE Operations. +Calls the deleteResource function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..54cdb9f3c --- /dev/null +++ b/7.x/docs/classes/DeleteParentExtractor.html @@ -0,0 +1,213 @@ +DeleteParentExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..95b34ec2f --- /dev/null +++ b/7.x/docs/classes/DeletePasswordHandler.html @@ -0,0 +1,199 @@ +DeletePasswordHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class DeletePasswordHandler

+
+

Handles the deletion of a password login method.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
passwordRoute: PasswordIdRoute
+
+ +
passwordStore: PasswordStore
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ 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..7d7405b4a --- /dev/null +++ b/7.x/docs/classes/DynamicJsonToTemplateConverter.html @@ -0,0 +1,240 @@ +DynamicJsonToTemplateConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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..377aa05f9 --- /dev/null +++ b/7.x/docs/classes/EjsTemplateEngine.html @@ -0,0 +1,217 @@ +EjsTemplateEngine | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class EjsTemplateEngine<T>

+
+

Fills in EJS templates.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<any> = Dict<any>

+
+

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..b71de5c5b --- /dev/null +++ b/7.x/docs/classes/EmailSender.html @@ -0,0 +1,173 @@ +EmailSender | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class EmailSenderAbstract

+
+

A class that can send an e-mail.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..502310713 --- /dev/null +++ b/7.x/docs/classes/EqualReadWriteLocker.html @@ -0,0 +1,240 @@ +EqualReadWriteLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..20d5aa089 --- /dev/null +++ b/7.x/docs/classes/ErrorHandler.html @@ -0,0 +1,175 @@ +ErrorHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class ErrorHandlerAbstract

+
+

Converts an error into a ResponseDescription based on the request preferences.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..fe97b2284 --- /dev/null +++ b/7.x/docs/classes/ErrorToJsonConverter.html @@ -0,0 +1,230 @@ +ErrorToJsonConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c77bcca1e --- /dev/null +++ b/7.x/docs/classes/ErrorToQuadConverter.html @@ -0,0 +1,215 @@ +ErrorToQuadConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..401ca2911 --- /dev/null +++ b/7.x/docs/classes/ErrorToTemplateConverter.html @@ -0,0 +1,264 @@ +ErrorToTemplateConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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..8e1731e0f --- /dev/null +++ b/7.x/docs/classes/ExpiringAdapter.html @@ -0,0 +1,311 @@ +ExpiringAdapter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4dac4bcc2 --- /dev/null +++ b/7.x/docs/classes/ExpiringAdapterFactory.html @@ -0,0 +1,134 @@ +ExpiringAdapterFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7731b04ee --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedMapper.html @@ -0,0 +1,507 @@ +ExtensionBasedMapper | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..04acff316 --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedMapperFactory.html @@ -0,0 +1,118 @@ +ExtensionBasedMapperFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..467fe6640 --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedTemplateEngine.html @@ -0,0 +1,209 @@ +ExtensionBasedTemplateEngine | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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<any> = Dict<any>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
supportedExtensions: string[]
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..7873e899c --- /dev/null +++ b/7.x/docs/classes/FileDataAccessor.html @@ -0,0 +1,561 @@ +FileDataAccessor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..dd196cf21 --- /dev/null +++ b/7.x/docs/classes/FileSizeReporter.html @@ -0,0 +1,233 @@ +FileSizeReporter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..00beb0e07 --- /dev/null +++ b/7.x/docs/classes/FileSystemResourceLocker.html @@ -0,0 +1,356 @@ +FileSystemResourceLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..cfac38b1b --- /dev/null +++ b/7.x/docs/classes/FilterMetadataDataAccessor.html @@ -0,0 +1,374 @@ +FilterMetadataDataAccessor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..95dde6286 --- /dev/null +++ b/7.x/docs/classes/FilterPattern.html @@ -0,0 +1,137 @@ +FilterPattern | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ae26fc58b --- /dev/null +++ b/7.x/docs/classes/FinalizableHandler.html @@ -0,0 +1,182 @@ +FinalizableHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class FinalizableHandler

+
+

Allows using a Finalizable as a Finalizer Handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
finalizable: Finalizable
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..262886d2b --- /dev/null +++ b/7.x/docs/classes/Finalizer.html @@ -0,0 +1,173 @@ +Finalizer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class FinalizerAbstract

+
+

Finalizer is used to indicate an AsyncHandler that performs finalization logic.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..9710b522d --- /dev/null +++ b/7.x/docs/classes/FixedContentTypeMapper.html @@ -0,0 +1,504 @@ +FixedContentTypeMapper | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f3942de70 --- /dev/null +++ b/7.x/docs/classes/ForbiddenHttpError.html @@ -0,0 +1,228 @@ +ForbiddenHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..2f98646c3 --- /dev/null +++ b/7.x/docs/classes/ForgetWebIdHandler.html @@ -0,0 +1,191 @@ +ForgetWebIdHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+
\ 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..5fcefa628 --- /dev/null +++ b/7.x/docs/classes/ForgotPasswordHandler.html @@ -0,0 +1,264 @@ +ForgotPasswordHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ 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..fcad92f6b --- /dev/null +++ b/7.x/docs/classes/FormToJsonConverter.html @@ -0,0 +1,216 @@ +FormToJsonConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a814def4c --- /dev/null +++ b/7.x/docs/classes/FoundHttpError.html @@ -0,0 +1,239 @@ +FoundHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..86f149cbb --- /dev/null +++ b/7.x/docs/classes/GeneratedPodManager.html @@ -0,0 +1,157 @@ +GeneratedPodManager | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8e29b6fa4 --- /dev/null +++ b/7.x/docs/classes/GetOperationHandler.html @@ -0,0 +1,200 @@ +GetOperationHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class GetOperationHandler

+
+

Handles GET Operations. +Calls the getRepresentation function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
eTagHandler: ETagHandler
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..2da29ec34 --- /dev/null +++ b/7.x/docs/classes/GlobalQuotaStrategy.html @@ -0,0 +1,227 @@ +GlobalQuotaStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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..cc80f3f7b --- /dev/null +++ b/7.x/docs/classes/GreedyReadWriteLocker.html @@ -0,0 +1,354 @@ +GreedyReadWriteLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..feabc0347 --- /dev/null +++ b/7.x/docs/classes/HandlebarsTemplateEngine.html @@ -0,0 +1,217 @@ +HandlebarsTemplateEngine | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class HandlebarsTemplateEngine<T>

+
+

Fills in Handlebars templates.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<any> = Dict<any>

+
+

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..e4e00d581 --- /dev/null +++ b/7.x/docs/classes/HandlerServerConfigurator.html @@ -0,0 +1,245 @@ +HandlerServerConfigurator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..3f5fcd0bf --- /dev/null +++ b/7.x/docs/classes/HashEncodingStorage.html @@ -0,0 +1,282 @@ +HashEncodingStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0d4f6943f --- /dev/null +++ b/7.x/docs/classes/HashMap.html @@ -0,0 +1,346 @@ +HashMap | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

  • +
  • +

    TVal = any

+
+

Hierarchy

+
+
+

Implements

+
    +
  • Map<TKey, TVal>
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Accessors

+
+
+

Methods

+
+
+

Constructors

+
+ +
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      TKey = any

    • +
    • +

      TVal = any

    +
    +

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

    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..a9d2f8a58 --- /dev/null +++ b/7.x/docs/classes/HeadOperationHandler.html @@ -0,0 +1,200 @@ +HeadOperationHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class HeadOperationHandler

+
+

Handles HEAD Operations. +Calls the getRepresentation function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
eTagHandler: ETagHandler
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..c08c10b2c --- /dev/null +++ b/7.x/docs/classes/HeaderHandler.html @@ -0,0 +1,193 @@ +HeaderHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class HeaderHandler

+
+

Handler that sets custom headers on the response.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
headers: Record<string, string>
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..86c545eb5 --- /dev/null +++ b/7.x/docs/classes/HtmlViewEntry.html @@ -0,0 +1,121 @@ +HtmlViewEntry | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c7fc0e617 --- /dev/null +++ b/7.x/docs/classes/HtmlViewHandler.html @@ -0,0 +1,232 @@ +HtmlViewHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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<any>>
+
+ +
templates: HtmlViewEntry[]
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..1e1697892 --- /dev/null +++ b/7.x/docs/classes/HttpError.html @@ -0,0 +1,289 @@ +HttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..26003a1b7 --- /dev/null +++ b/7.x/docs/classes/HttpHandler.html @@ -0,0 +1,180 @@ +HttpHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class HttpHandlerAbstract

+
+

An HTTP request handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..e4e80a082 --- /dev/null +++ b/7.x/docs/classes/IdInteractionRoute.html @@ -0,0 +1,203 @@ +IdInteractionRoute | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..119f2c44c --- /dev/null +++ b/7.x/docs/classes/IdentifierMap.html @@ -0,0 +1,298 @@ +IdentifierMap | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..32f53c1cf --- /dev/null +++ b/7.x/docs/classes/IdentifierSetMultiMap.html @@ -0,0 +1,445 @@ +IdentifierSetMultiMap | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0d62855fb --- /dev/null +++ b/7.x/docs/classes/IdentityProviderFactory.html @@ -0,0 +1,409 @@ +IdentityProviderFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given token is an access token. +The AccessToken interface is not exported, so we have to access it like this.

    +
    +
    +

    Parameters

    +
      +
    • +
      token: any
    +

    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..df22c5677 --- /dev/null +++ b/7.x/docs/classes/IdentityProviderHttpHandler.html @@ -0,0 +1,213 @@ +IdentityProviderHttpHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..b0e0b2eb3 --- /dev/null +++ b/7.x/docs/classes/ImmutableMetadataPatcher.html @@ -0,0 +1,218 @@ +ImmutableMetadataPatcher | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..bae3be16c --- /dev/null +++ b/7.x/docs/classes/InMemoryDataAccessor.html @@ -0,0 +1,418 @@ +InMemoryDataAccessor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1a9361799 --- /dev/null +++ b/7.x/docs/classes/IndexRepresentationStore.html @@ -0,0 +1,355 @@ +IndexRepresentationStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b6a0c38f0 --- /dev/null +++ b/7.x/docs/classes/InitializableHandler.html @@ -0,0 +1,182 @@ +InitializableHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class InitializableHandler

+
+

Allows using an Initializable as an Initializer Handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
initializable: Initializable
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..bf8747519 --- /dev/null +++ b/7.x/docs/classes/Initializer.html @@ -0,0 +1,188 @@ +Initializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class InitializerAbstract

+
+

Initializer is used to indicate an AsyncHandler that performs initialization logic.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..173199bb7 --- /dev/null +++ b/7.x/docs/classes/InteractionHandler.html @@ -0,0 +1,175 @@ +InteractionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class InteractionHandlerAbstract

+
+

Handler used for IDP interactions.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..d44c7cb86 --- /dev/null +++ b/7.x/docs/classes/InteractionRouteHandler.html @@ -0,0 +1,213 @@ +InteractionRouteHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e2220567d --- /dev/null +++ b/7.x/docs/classes/IntermediateCreateExtractor.html @@ -0,0 +1,224 @@ +IntermediateCreateExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b8b4a092c --- /dev/null +++ b/7.x/docs/classes/InternalServerError.html @@ -0,0 +1,228 @@ +InternalServerError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..2acd75332 --- /dev/null +++ b/7.x/docs/classes/JsonConversionHandler.html @@ -0,0 +1,204 @@ +JsonConversionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e92b4312d --- /dev/null +++ b/7.x/docs/classes/JsonFileStorage.html @@ -0,0 +1,302 @@ +JsonFileStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e008855b1 --- /dev/null +++ b/7.x/docs/classes/JsonInteractionHandler.html @@ -0,0 +1,210 @@ +JsonInteractionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..3a5719940 --- /dev/null +++ b/7.x/docs/classes/JsonLdNotificationSerializer.html @@ -0,0 +1,171 @@ +JsonLdNotificationSerializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class JsonLdNotificationSerializer

+
+

Serializes a Notification into a JSON-LD string.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ 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..74d58a025 --- /dev/null +++ b/7.x/docs/classes/JsonResourceStorage.html @@ -0,0 +1,332 @@ +JsonResourceStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a60f6bb3f --- /dev/null +++ b/7.x/docs/classes/KeyExtractor.html @@ -0,0 +1,200 @@ +KeyExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..1790c6ee9 --- /dev/null +++ b/7.x/docs/classes/KeyValueChannelStorage.html @@ -0,0 +1,299 @@ +KeyValueChannelStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a5ca3dd91 --- /dev/null +++ b/7.x/docs/classes/LazyLoggerFactory.html @@ -0,0 +1,173 @@ +LazyLoggerFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3f8b0318f --- /dev/null +++ b/7.x/docs/classes/LinkMetadataGenerator.html @@ -0,0 +1,201 @@ +LinkMetadataGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..f505a8424 --- /dev/null +++ b/7.x/docs/classes/LinkRelMetadataWriter.html @@ -0,0 +1,203 @@ +LinkRelMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..4c92629e2 --- /dev/null +++ b/7.x/docs/classes/LinkRelObject.html @@ -0,0 +1,195 @@ +LinkRelObject | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3016878c7 --- /dev/null +++ b/7.x/docs/classes/LinkRelParser.html @@ -0,0 +1,212 @@ +LinkRelParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6fb28411e --- /dev/null +++ b/7.x/docs/classes/LinkWebIdHandler.html @@ -0,0 +1,253 @@ +LinkWebIdHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ 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..d89a0d197 --- /dev/null +++ b/7.x/docs/classes/ListeningActivityHandler.html @@ -0,0 +1,224 @@ +ListeningActivityHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: any
      +

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

      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..8beadd8f2 --- /dev/null +++ b/7.x/docs/classes/LocationInteractionHandler.html @@ -0,0 +1,210 @@ +LocationInteractionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8c0f022d1 --- /dev/null +++ b/7.x/docs/classes/LockingInteractionHandler.html @@ -0,0 +1,209 @@ +LockingInteractionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8dee256a8 --- /dev/null +++ b/7.x/docs/classes/LockingResourceStore.html @@ -0,0 +1,441 @@ +LockingResourceStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6e3c401de --- /dev/null +++ b/7.x/docs/classes/LoggerInitializer.html @@ -0,0 +1,182 @@ +LoggerInitializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class LoggerInitializer

+
+

Sets up the global logger factory.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
loggerFactory: LoggerFactory
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..16f32bfca --- /dev/null +++ b/7.x/docs/classes/LogoutHandler.html @@ -0,0 +1,191 @@ +LogoutHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+
\ 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..eeda07099 --- /dev/null +++ b/7.x/docs/classes/MappedMetadataWriter.html @@ -0,0 +1,196 @@ +MappedMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..7b03a0cc1 --- /dev/null +++ b/7.x/docs/classes/MarkdownToHtmlConverter.html @@ -0,0 +1,230 @@ +MarkdownToHtmlConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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..903ce5ef9 --- /dev/null +++ b/7.x/docs/classes/MaxKeyLengthStorage.html @@ -0,0 +1,319 @@ +MaxKeyLengthStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..49f441814 --- /dev/null +++ b/7.x/docs/classes/MemoryMapStorage.html @@ -0,0 +1,227 @@ +MemoryMapStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..d56e5f528 --- /dev/null +++ b/7.x/docs/classes/MemoryResourceLocker.html @@ -0,0 +1,199 @@ +MemoryResourceLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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. +In case 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..fc50ce194 --- /dev/null +++ b/7.x/docs/classes/MetadataGenerator.html @@ -0,0 +1,173 @@ +MetadataGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class MetadataGeneratorAbstract

+
+

Generic interface for classes that add metadata to a RepresentationMetadata.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..d1d7014df --- /dev/null +++ b/7.x/docs/classes/MetadataParser.html @@ -0,0 +1,195 @@ +MetadataParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b2f96f493 --- /dev/null +++ b/7.x/docs/classes/MetadataWriter.html @@ -0,0 +1,185 @@ +MetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class MetadataWriterAbstract

+
+

A serializer that converts metadata to headers for an HttpResponse.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..ee519b0d3 --- /dev/null +++ b/7.x/docs/classes/MethodFilterHandler.html @@ -0,0 +1,233 @@ +MethodFilterHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..32ea4a618 --- /dev/null +++ b/7.x/docs/classes/MethodModesExtractor.html @@ -0,0 +1,198 @@ +MethodModesExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..f2d48d45a --- /dev/null +++ b/7.x/docs/classes/MethodNotAllowedHttpError.html @@ -0,0 +1,238 @@ +MethodNotAllowedHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..30b6253cd --- /dev/null +++ b/7.x/docs/classes/ModesExtractor.html @@ -0,0 +1,178 @@ +ModesExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class ModesExtractorAbstract

+
+

Extracts all AccessModes that are necessary to execute the given Operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..0f6d290d7 --- /dev/null +++ b/7.x/docs/classes/ModifiedMetadataWriter.html @@ -0,0 +1,176 @@ +ModifiedMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class ModifiedMetadataWriter

+
+

A MetadataWriter that generates all the necessary headers related to the modification date of a resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..0e12a4af0 --- /dev/null +++ b/7.x/docs/classes/ModuleVersionVerifier.html @@ -0,0 +1,193 @@ +ModuleVersionVerifier | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..b0119ec34 --- /dev/null +++ b/7.x/docs/classes/MonitoringStore.html @@ -0,0 +1,1082 @@ +MonitoringStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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..3d0e3155d --- /dev/null +++ b/7.x/docs/classes/MovedPermanentlyHttpError.html @@ -0,0 +1,239 @@ +MovedPermanentlyHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..077eb6950 --- /dev/null +++ b/7.x/docs/classes/N3PatchBodyParser.html @@ -0,0 +1,265 @@ +N3PatchBodyParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..88ba528e0 --- /dev/null +++ b/7.x/docs/classes/N3PatchModesExtractor.html @@ -0,0 +1,201 @@ +N3PatchModesExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..de918021e --- /dev/null +++ b/7.x/docs/classes/N3Patcher.html @@ -0,0 +1,244 @@ +N3Patcher | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..176851421 --- /dev/null +++ b/7.x/docs/classes/NoCheckOwnershipValidator.html @@ -0,0 +1,193 @@ +NoCheckOwnershipValidator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..25b1b53bd --- /dev/null +++ b/7.x/docs/classes/NotFoundHttpError.html @@ -0,0 +1,228 @@ +NotFoundHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..d0ead4d1c --- /dev/null +++ b/7.x/docs/classes/NotImplementedHttpError.html @@ -0,0 +1,229 @@ +NotImplementedHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..24b82b343 --- /dev/null +++ b/7.x/docs/classes/NotificationDescriber.html @@ -0,0 +1,203 @@ +NotificationDescriber | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..08372745a --- /dev/null +++ b/7.x/docs/classes/NotificationEmitter.html @@ -0,0 +1,174 @@ +NotificationEmitter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class NotificationEmitterAbstract

+
+

Emits a serialized Notification to the channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..cdb439c85 --- /dev/null +++ b/7.x/docs/classes/NotificationGenerator.html @@ -0,0 +1,176 @@ +NotificationGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class NotificationGeneratorAbstract

+
+

Creates a Notification based on the provided input.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..a63c850a2 --- /dev/null +++ b/7.x/docs/classes/NotificationHandler.html @@ -0,0 +1,174 @@ +NotificationHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class NotificationHandlerAbstract

+
+

Makes sure an activity gets emitted to the relevant channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..becdf987a --- /dev/null +++ b/7.x/docs/classes/NotificationSerializer.html @@ -0,0 +1,176 @@ +NotificationSerializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..71659ca01 --- /dev/null +++ b/7.x/docs/classes/NotificationSubscriber.html @@ -0,0 +1,259 @@ +NotificationSubscriber | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..324eed338 --- /dev/null +++ b/7.x/docs/classes/NotificationUnsubscriber.html @@ -0,0 +1,198 @@ +NotificationUnsubscriber | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..eff2b565c --- /dev/null +++ b/7.x/docs/classes/OAuthHttpError.html @@ -0,0 +1,270 @@ +OAuthHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..bdf01233e --- /dev/null +++ b/7.x/docs/classes/OidcControlHandler.html @@ -0,0 +1,256 @@ +OidcControlHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c58fc3e5e --- /dev/null +++ b/7.x/docs/classes/OidcHttpHandler.html @@ -0,0 +1,197 @@ +OidcHttpHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class OidcHttpHandler

+
+

HTTP handler that redirects all requests to the OIDC library.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
providerFactory: ProviderFactory
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..fc59adc6a --- /dev/null +++ b/7.x/docs/classes/OkResponseDescription.html @@ -0,0 +1,140 @@ +OkResponseDescription | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e166dcd30 --- /dev/null +++ b/7.x/docs/classes/OperationHandler.html @@ -0,0 +1,178 @@ +OperationHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class OperationHandlerAbstract

+
+

Handler for a specific operation type.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..0a58b9acc --- /dev/null +++ b/7.x/docs/classes/OperationHttpHandler.html @@ -0,0 +1,180 @@ +OperationHttpHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class OperationHttpHandlerAbstract

+
+

An HTTP handler that makes use of an already parsed Operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..4361ee719 --- /dev/null +++ b/7.x/docs/classes/OperationRouterHandler.html @@ -0,0 +1,243 @@ +OperationRouterHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..862f5661f --- /dev/null +++ b/7.x/docs/classes/OriginalUrlExtractor.html @@ -0,0 +1,206 @@ +OriginalUrlExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class OriginalUrlExtractor

+
+

Reconstructs the original URL of an incoming HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
identifierStrategy: IdentifierStrategy
+
+ +
includeQueryString: boolean
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..256f924f6 --- /dev/null +++ b/7.x/docs/classes/OwnerMetadataWriter.html @@ -0,0 +1,211 @@ +OwnerMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..f42698ac9 --- /dev/null +++ b/7.x/docs/classes/OwnerPermissionReader.html @@ -0,0 +1,253 @@ +OwnerPermissionReader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..e9ef099e4 --- /dev/null +++ b/7.x/docs/classes/OwnershipValidator.html @@ -0,0 +1,185 @@ +OwnershipValidator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..a344cd108 --- /dev/null +++ b/7.x/docs/classes/ParallelHandler.html @@ -0,0 +1,204 @@ +ParallelHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..32c24fd65 --- /dev/null +++ b/7.x/docs/classes/ParentContainerReader.html @@ -0,0 +1,288 @@ +ParentContainerReader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..8d2a7a00e --- /dev/null +++ b/7.x/docs/classes/ParsingHttpHandler.html @@ -0,0 +1,260 @@ +ParsingHttpHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..e707470ab --- /dev/null +++ b/7.x/docs/classes/PartialReadWriteLocker.html @@ -0,0 +1,309 @@ +PartialReadWriteLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..11460861f --- /dev/null +++ b/7.x/docs/classes/PassthroughAdapter.html @@ -0,0 +1,248 @@ +PassthroughAdapter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..dbe6a0784 --- /dev/null +++ b/7.x/docs/classes/PassthroughAdapterFactory.html @@ -0,0 +1,140 @@ +PassthroughAdapterFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..86e2dbde4 --- /dev/null +++ b/7.x/docs/classes/PassthroughConverter.html @@ -0,0 +1,171 @@ +PassthroughConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4ab239fb8 --- /dev/null +++ b/7.x/docs/classes/PassthroughDataAccessor.html @@ -0,0 +1,338 @@ +PassthroughDataAccessor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3509f9d03 --- /dev/null +++ b/7.x/docs/classes/PassthroughKeyValueStorage.html @@ -0,0 +1,281 @@ +PassthroughKeyValueStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a3a4a2234 --- /dev/null +++ b/7.x/docs/classes/PassthroughStore.html @@ -0,0 +1,321 @@ +PassthroughStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..46545883b --- /dev/null +++ b/7.x/docs/classes/PasswordLoginHandler.html @@ -0,0 +1,278 @@ +PasswordLoginHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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 if 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..0e64052d4 --- /dev/null +++ b/7.x/docs/classes/PatchHandler.html @@ -0,0 +1,183 @@ +PatchHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class PatchHandler<T>Abstract

+
+

Executes the given Patch.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..e714d82f6 --- /dev/null +++ b/7.x/docs/classes/PatchOperationHandler.html @@ -0,0 +1,198 @@ +PatchOperationHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class PatchOperationHandler

+
+

Handles PATCH Operations. +Calls the modifyResource function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

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

Methods

+
+ +
    + +
  • +

    Checks if 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..152208672 --- /dev/null +++ b/7.x/docs/classes/PatchingStore.html @@ -0,0 +1,324 @@ +PatchingStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..441f05e00 --- /dev/null +++ b/7.x/docs/classes/PathBasedReader.html @@ -0,0 +1,246 @@ +PathBasedReader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..aac8a5fc2 --- /dev/null +++ b/7.x/docs/classes/PermissionBasedAuthorizer.html @@ -0,0 +1,288 @@ +PermissionBasedAuthorizer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..7bfed0159 --- /dev/null +++ b/7.x/docs/classes/PermissionReader.html @@ -0,0 +1,182 @@ +PermissionReader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..644422d35 --- /dev/null +++ b/7.x/docs/classes/PickWebIdHandler.html @@ -0,0 +1,232 @@ +PickWebIdHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ 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..b7d732dda --- /dev/null +++ b/7.x/docs/classes/PlainJsonLdFilter.html @@ -0,0 +1,216 @@ +PlainJsonLdFilter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..51b03ec64 --- /dev/null +++ b/7.x/docs/classes/PodCreator.html @@ -0,0 +1,173 @@ +PodCreator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class PodCreatorAbstract

+
+

Handles creating a pod and linking the created WebID.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..07e4c669c --- /dev/null +++ b/7.x/docs/classes/PodQuotaStrategy.html @@ -0,0 +1,262 @@ +PodQuotaStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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..350e45a2f --- /dev/null +++ b/7.x/docs/classes/PodStorageLocationStrategy.html @@ -0,0 +1,140 @@ +PodStorageLocationStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2b99cae22 --- /dev/null +++ b/7.x/docs/classes/PostOperationHandler.html @@ -0,0 +1,198 @@ +PostOperationHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class PostOperationHandler

+
+

Handles POST Operations. +Calls the addResource function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

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

Methods

+
+ +
    + +
  • +

    Checks if 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..02535cac6 --- /dev/null +++ b/7.x/docs/classes/PreconditionFailedHttpError.html @@ -0,0 +1,228 @@ +PreconditionFailedHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..eeff42aaa --- /dev/null +++ b/7.x/docs/classes/PreferenceParser.html @@ -0,0 +1,183 @@ +PreferenceParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class PreferenceParserAbstract

+
+

Creates RepresentationPreferences based on the incoming HTTP headers in a HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..0f1fe60b7 --- /dev/null +++ b/7.x/docs/classes/PreferenceSupport.html @@ -0,0 +1,146 @@ +PreferenceSupport | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..514b20b7d --- /dev/null +++ b/7.x/docs/classes/ProcessHandler.html @@ -0,0 +1,251 @@ +ProcessHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..26457d892 --- /dev/null +++ b/7.x/docs/classes/PromptFactory.html @@ -0,0 +1,173 @@ +PromptFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class PromptFactoryAbstract

+
+

Used to generate custom interactionPolicy.Prompts.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..6046a8830 --- /dev/null +++ b/7.x/docs/classes/PromptHandler.html @@ -0,0 +1,203 @@ +PromptHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+
\ 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..1451590d1 --- /dev/null +++ b/7.x/docs/classes/PublicCredentialsExtractor.html @@ -0,0 +1,164 @@ +PublicCredentialsExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..6f22641a6 --- /dev/null +++ b/7.x/docs/classes/PutOperationHandler.html @@ -0,0 +1,207 @@ +PutOperationHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class PutOperationHandler

+
+

Handles PUT Operations. +Calls the setRepresentation function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
logger: Logger = ...
+
+ +
metadataStrategy: AuxiliaryStrategy
+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..001943e93 --- /dev/null +++ b/7.x/docs/classes/QuadToRdfConverter.html @@ -0,0 +1,230 @@ +QuadToRdfConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0df846d94 --- /dev/null +++ b/7.x/docs/classes/QuotaStrategy.html @@ -0,0 +1,224 @@ +QuotaStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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..5d8baef02 --- /dev/null +++ b/7.x/docs/classes/QuotaValidator.html @@ -0,0 +1,190 @@ +QuotaValidator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..0438f99be --- /dev/null +++ b/7.x/docs/classes/RangeMetadataWriter.html @@ -0,0 +1,195 @@ +RangeMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..cb1eb242b --- /dev/null +++ b/7.x/docs/classes/RangeNotSatisfiedHttpError.html @@ -0,0 +1,237 @@ +RangeNotSatisfiedHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..f5f7f4f8b --- /dev/null +++ b/7.x/docs/classes/RangePreferenceParser.html @@ -0,0 +1,181 @@ +RangePreferenceParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..bc990f78f --- /dev/null +++ b/7.x/docs/classes/RawBodyParser.html @@ -0,0 +1,183 @@ +RawBodyParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class RawBodyParser

+
+

Converts incoming HttpRequest to a Representation without any further parsing.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

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

Methods

+
+ +
    + +
  • +

    Checks if 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..1e9b1087b --- /dev/null +++ b/7.x/docs/classes/RdfPatcher.html @@ -0,0 +1,198 @@ +RdfPatcher | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8cbaf605e --- /dev/null +++ b/7.x/docs/classes/RdfStorePatcher.html @@ -0,0 +1,171 @@ +RdfStorePatcher | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class RdfStorePatcherAbstract

+
+

Applies a Patch on an N3.js Store.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..b3d8b9fab --- /dev/null +++ b/7.x/docs/classes/RdfToQuadConverter.html @@ -0,0 +1,231 @@ +RdfToQuadConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ff8340b9a --- /dev/null +++ b/7.x/docs/classes/RdfValidator.html @@ -0,0 +1,191 @@ +RdfValidator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..87df27b70 --- /dev/null +++ b/7.x/docs/classes/ReadOnlyStore.html @@ -0,0 +1,313 @@ +ReadOnlyStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..03857be41 --- /dev/null +++ b/7.x/docs/classes/RecordObject.html @@ -0,0 +1,102 @@ +RecordObject | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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..fa810020f --- /dev/null +++ b/7.x/docs/classes/RedirectHttpError.html @@ -0,0 +1,279 @@ +RedirectHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..61d018272 --- /dev/null +++ b/7.x/docs/classes/RedirectingErrorHandler.html @@ -0,0 +1,172 @@ +RedirectingErrorHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..f79d5b999 --- /dev/null +++ b/7.x/docs/classes/RedirectingHttpHandler.html @@ -0,0 +1,286 @@ +RedirectingHttpHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..0af5b87e0 --- /dev/null +++ b/7.x/docs/classes/RedisLocker.html @@ -0,0 +1,488 @@ +RedisLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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. +In case 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..718cdb6cb --- /dev/null +++ b/7.x/docs/classes/RegexRouterRule.html @@ -0,0 +1,256 @@ +RegexRouterRule | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4196d0374 --- /dev/null +++ b/7.x/docs/classes/RegexRule.html @@ -0,0 +1,118 @@ +RegexRule | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..bb11f13a5 --- /dev/null +++ b/7.x/docs/classes/RelativePathInteractionRoute.html @@ -0,0 +1,188 @@ +RelativePathInteractionRoute | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f0c99c027 --- /dev/null +++ b/7.x/docs/classes/RepresentationConverter.html @@ -0,0 +1,177 @@ +RepresentationConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class RepresentationConverterAbstract

+
+

Converts a Representation from one media type to another, based on the given preferences.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..730c4c7fc --- /dev/null +++ b/7.x/docs/classes/RepresentationConvertingStore.html @@ -0,0 +1,379 @@ +RepresentationConvertingStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8abed072c --- /dev/null +++ b/7.x/docs/classes/RepresentationMetadata.html @@ -0,0 +1,766 @@ +RepresentationMetadata | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ddc904c5d --- /dev/null +++ b/7.x/docs/classes/RepresentationPatchHandler.html @@ -0,0 +1,200 @@ +RepresentationPatchHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..1534916fe --- /dev/null +++ b/7.x/docs/classes/RepresentationPatcher.html @@ -0,0 +1,187 @@ +RepresentationPatcher | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class RepresentationPatcher<T>Abstract

+
+

Handles the patching of a specific Representation.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..6ebbf9b75 --- /dev/null +++ b/7.x/docs/classes/RequestParser.html @@ -0,0 +1,173 @@ +RequestParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class RequestParserAbstract

+
+

Converts an incoming HttpRequest to an Operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..c97ed8828 --- /dev/null +++ b/7.x/docs/classes/ResetPasswordHandler.html @@ -0,0 +1,242 @@ +ResetPasswordHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ 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..5b509a765 --- /dev/null +++ b/7.x/docs/classes/ResetResponseDescription.html @@ -0,0 +1,124 @@ +ResetResponseDescription | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c91ca085e --- /dev/null +++ b/7.x/docs/classes/ResolveLoginHandler.html @@ -0,0 +1,258 @@ +ResolveLoginHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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

    Updates the account setting that determines if 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..0ca033515 --- /dev/null +++ b/7.x/docs/classes/ResponseDescription.html @@ -0,0 +1,142 @@ +ResponseDescription | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8e08d2a4f --- /dev/null +++ b/7.x/docs/classes/ResponseWriter.html @@ -0,0 +1,188 @@ +ResponseWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7dc27ce93 --- /dev/null +++ b/7.x/docs/classes/RootFilePathHandler.html @@ -0,0 +1,206 @@ +RootFilePathHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6d87ce96b --- /dev/null +++ b/7.x/docs/classes/RootStorageLocationStrategy.html @@ -0,0 +1,133 @@ +RootStorageLocationStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e11a66ca3 --- /dev/null +++ b/7.x/docs/classes/RouterHandler.html @@ -0,0 +1,251 @@ +RouterHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..f660dd971 --- /dev/null +++ b/7.x/docs/classes/RouterRule.html @@ -0,0 +1,191 @@ +RouterRule | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ea5f621a6 --- /dev/null +++ b/7.x/docs/classes/RoutingAuxiliaryIdentifierStrategy.html @@ -0,0 +1,227 @@ +RoutingAuxiliaryIdentifierStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..667afb432 --- /dev/null +++ b/7.x/docs/classes/RoutingAuxiliaryStrategy.html @@ -0,0 +1,334 @@ +RoutingAuxiliaryStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c8ebd9930 --- /dev/null +++ b/7.x/docs/classes/RoutingResourceStore.html @@ -0,0 +1,322 @@ +RoutingResourceStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4c842cd8d --- /dev/null +++ b/7.x/docs/classes/SafeErrorHandler.html @@ -0,0 +1,207 @@ +SafeErrorHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..9a698968f --- /dev/null +++ b/7.x/docs/classes/SeededAccountInitializer.html @@ -0,0 +1,212 @@ +SeededAccountInitializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..b6d4d4dc7 --- /dev/null +++ b/7.x/docs/classes/SequenceHandler.html @@ -0,0 +1,206 @@ +SequenceHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..fe6d02f1b --- /dev/null +++ b/7.x/docs/classes/ServerConfigurator.html @@ -0,0 +1,174 @@ +ServerConfigurator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class ServerConfiguratorAbstract

+
+

Configures a Server by attaching listeners for specific events.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..091a2b074 --- /dev/null +++ b/7.x/docs/classes/ServerInitializer.html @@ -0,0 +1,229 @@ +ServerInitializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..ab7e895bc --- /dev/null +++ b/7.x/docs/classes/ShorthandExtractor.html @@ -0,0 +1,175 @@ +ShorthandExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class ShorthandExtractorAbstract

+
+

A handler that computes a specific value from a given map of values.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..b34faafcc --- /dev/null +++ b/7.x/docs/classes/ShorthandResolver.html @@ -0,0 +1,175 @@ +ShorthandResolver | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..18a166946 --- /dev/null +++ b/7.x/docs/classes/SingleContainerJsonStorage.html @@ -0,0 +1,334 @@ +SingleContainerJsonStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..282162eb5 --- /dev/null +++ b/7.x/docs/classes/SingleRootIdentifierStrategy.html @@ -0,0 +1,213 @@ +SingleRootIdentifierStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..aebf9d5df --- /dev/null +++ b/7.x/docs/classes/SliceStream.html @@ -0,0 +1,4044 @@ +SliceStream | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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: any
    • +
    • +
      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..5ec283699 --- /dev/null +++ b/7.x/docs/classes/SlugParser.html @@ -0,0 +1,198 @@ +SlugParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5792026c4 --- /dev/null +++ b/7.x/docs/classes/SparqlDataAccessor.html @@ -0,0 +1,607 @@ +SparqlDataAccessor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e238bf57a --- /dev/null +++ b/7.x/docs/classes/SparqlUpdateBodyParser.html @@ -0,0 +1,184 @@ +SparqlUpdateBodyParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..006aa36ea --- /dev/null +++ b/7.x/docs/classes/SparqlUpdateModesExtractor.html @@ -0,0 +1,304 @@ +SparqlUpdateModesExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..8c778486d --- /dev/null +++ b/7.x/docs/classes/SparqlUpdatePatcher.html @@ -0,0 +1,311 @@ +SparqlUpdatePatcher | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..eb99a3235 --- /dev/null +++ b/7.x/docs/classes/StateHandler.html @@ -0,0 +1,185 @@ +StateHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..ddda7f533 --- /dev/null +++ b/7.x/docs/classes/StateNotificationGenerator.html @@ -0,0 +1,200 @@ +StateNotificationGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..027fdb599 --- /dev/null +++ b/7.x/docs/classes/StaticAssetEntry.html @@ -0,0 +1,119 @@ +StaticAssetEntry | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6271b086c --- /dev/null +++ b/7.x/docs/classes/StaticAssetHandler.html @@ -0,0 +1,283 @@ +StaticAssetHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..4ddddc8c5 --- /dev/null +++ b/7.x/docs/classes/StaticFolderGenerator.html @@ -0,0 +1,156 @@ +StaticFolderGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..669bbe9bc --- /dev/null +++ b/7.x/docs/classes/StaticHandler.html @@ -0,0 +1,196 @@ +StaticHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 extends any = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
value?: T
+
+

Methods

+
+ +
    + +
  • +

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

    +
    +
    +

    Parameters

    +
      +
    • +
      input: any
      +

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

      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..2b9091f7a --- /dev/null +++ b/7.x/docs/classes/StaticInteractionHandler.html @@ -0,0 +1,185 @@ +StaticInteractionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+
\ 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..aa445f36f --- /dev/null +++ b/7.x/docs/classes/StaticStorageDescriber.html @@ -0,0 +1,208 @@ +StaticStorageDescriber | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..c2cd33fd9 --- /dev/null +++ b/7.x/docs/classes/StaticTemplateEngine.html @@ -0,0 +1,218 @@ +StaticTemplateEngine | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class StaticTemplateEngine<T>

+
+

Template engine that renders output based on a static template file.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<any> = Dict<any>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
template: Template
+
+ +
templateEngine: AsyncHandler<TemplateEngineInput<T>, string>
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..600e8bcbc --- /dev/null +++ b/7.x/docs/classes/StaticThrowHandler.html @@ -0,0 +1,182 @@ +StaticThrowHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: any
      +

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

      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..336ff8c8b --- /dev/null +++ b/7.x/docs/classes/StorageDescriber.html @@ -0,0 +1,174 @@ +StorageDescriber | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class StorageDescriberAbstract

+
+

Generates Quads that need to be added to the given storage description resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..fd220bdd6 --- /dev/null +++ b/7.x/docs/classes/StorageDescriptionAdvertiser.html @@ -0,0 +1,208 @@ +StorageDescriptionAdvertiser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..4f91c8a9f --- /dev/null +++ b/7.x/docs/classes/StorageDescriptionHandler.html @@ -0,0 +1,228 @@ +StorageDescriptionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..061702dd8 --- /dev/null +++ b/7.x/docs/classes/SubdomainExtensionBasedMapper.html @@ -0,0 +1,551 @@ +SubdomainExtensionBasedMapper | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..44afa2a4c --- /dev/null +++ b/7.x/docs/classes/SubdomainIdentifierGenerator.html @@ -0,0 +1,166 @@ +SubdomainIdentifierGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class SubdomainIdentifierGenerator

+
+

Generates identifiers by using the name as a subdomain on the base URL. +Non-alphanumeric characters will be replaced with -.

+
+
+
+

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..5e9641834 --- /dev/null +++ b/7.x/docs/classes/SubdomainIdentifierStrategy.html @@ -0,0 +1,220 @@ +SubdomainIdentifierStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..26378c525 --- /dev/null +++ b/7.x/docs/classes/SubfolderResourcesGenerator.html @@ -0,0 +1,167 @@ +SubfolderResourcesGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b6371c49f --- /dev/null +++ b/7.x/docs/classes/SuffixAuxiliaryIdentifierStrategy.html @@ -0,0 +1,218 @@ +SuffixAuxiliaryIdentifierStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0a4812432 --- /dev/null +++ b/7.x/docs/classes/SuffixIdentifierGenerator.html @@ -0,0 +1,159 @@ +SuffixIdentifierGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..709b6b4a9 --- /dev/null +++ b/7.x/docs/classes/TargetExtractor.html @@ -0,0 +1,182 @@ +TargetExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class TargetExtractorAbstract

+
+

Extracts a ResourceIdentifier from an incoming HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..b947cdbfa --- /dev/null +++ b/7.x/docs/classes/TemplateEngine.html @@ -0,0 +1,186 @@ +TemplateEngine | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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<any> = Dict<any>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..d500cdfdf --- /dev/null +++ b/7.x/docs/classes/TemplatedPodGenerator.html @@ -0,0 +1,211 @@ +TemplatedPodGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..dc1544ba7 --- /dev/null +++ b/7.x/docs/classes/TokenOwnershipValidator.html @@ -0,0 +1,287 @@ +TokenOwnershipValidator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..4a83519e5 --- /dev/null +++ b/7.x/docs/classes/TypedNotificationHandler.html @@ -0,0 +1,199 @@ +TypedNotificationHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0826d49f4 --- /dev/null +++ b/7.x/docs/classes/TypedRepresentationConverter.html @@ -0,0 +1,192 @@ +TypedRepresentationConverter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1b6ba1336 --- /dev/null +++ b/7.x/docs/classes/UnauthorizedHttpError.html @@ -0,0 +1,228 @@ +UnauthorizedHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..7aec44815 --- /dev/null +++ b/7.x/docs/classes/UnionCredentialsExtractor.html @@ -0,0 +1,259 @@ +UnionCredentialsExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..48c890b93 --- /dev/null +++ b/7.x/docs/classes/UnionHandler.html @@ -0,0 +1,280 @@ +UnionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..27c9121ba --- /dev/null +++ b/7.x/docs/classes/UnionPermissionReader.html @@ -0,0 +1,271 @@ +UnionPermissionReader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..571fbc075 --- /dev/null +++ b/7.x/docs/classes/UnionPreferenceParser.html @@ -0,0 +1,243 @@ +UnionPreferenceParser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..a7dee4dae --- /dev/null +++ b/7.x/docs/classes/UnlinkWebIdHandler.html @@ -0,0 +1,199 @@ +UnlinkWebIdHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class UnlinkWebIdHandler

+
+

Allows users to remove WebIDs linked to their account.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
webIdRoute: WebIdLinkRoute
+
+ +
webIdStore: WebIdStore
+
+

Methods

+
+ +
+
+ +
+
+ +
+
+
\ 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..106ff6c3e --- /dev/null +++ b/7.x/docs/classes/UnsecureConstantCredentialsExtractor.html @@ -0,0 +1,201 @@ +UnsecureConstantCredentialsExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..fa2865991 --- /dev/null +++ b/7.x/docs/classes/UnsecureWebIdExtractor.html @@ -0,0 +1,183 @@ +UnsecureWebIdExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..081fac911 --- /dev/null +++ b/7.x/docs/classes/UnsecureWebSocketsProtocol.html @@ -0,0 +1,227 @@ +UnsecureWebSocketsProtocol | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..348e306c7 --- /dev/null +++ b/7.x/docs/classes/UnsupportedAsyncHandler.html @@ -0,0 +1,174 @@ +UnsupportedAsyncHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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: any
      +

      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..aa2a6299d --- /dev/null +++ b/7.x/docs/classes/UnsupportedMediaTypeHttpError.html @@ -0,0 +1,228 @@ +UnsupportedMediaTypeHttpError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..e90e8ad6d --- /dev/null +++ b/7.x/docs/classes/UpdateOwnerHandler.html @@ -0,0 +1,240 @@ +UpdateOwnerHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class UpdateOwnerHandler

+
+

Responsible for adding/updating/deleting owners in pods.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
podRoute: PodIdRoute
+
+ +
podStore: PodStore
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    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..04f8f20d7 --- /dev/null +++ b/7.x/docs/classes/UpdatePasswordHandler.html @@ -0,0 +1,221 @@ +UpdatePasswordHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+ +
+
+ +
+
+ +
+
+ +
+
+
\ 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..211b65fa4 --- /dev/null +++ b/7.x/docs/classes/V6MigrationInitializer.html @@ -0,0 +1,331 @@ +V6MigrationInitializer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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, any>[]
+
+ +
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 if 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..6f3e8d08d --- /dev/null +++ b/7.x/docs/classes/ValidatingDataAccessor.html @@ -0,0 +1,343 @@ +ValidatingDataAccessor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ae5317fa1 --- /dev/null +++ b/7.x/docs/classes/Validator.html @@ -0,0 +1,174 @@ +Validator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class ValidatorAbstract

+
+

Generic interface for classes that validate Representations in some way.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..977a5b156 --- /dev/null +++ b/7.x/docs/classes/VariableHandler.html @@ -0,0 +1,193 @@ +VariableHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c3052834f --- /dev/null +++ b/7.x/docs/classes/VariableSetter.html @@ -0,0 +1,222 @@ +VariableSetter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0a423b9d7 --- /dev/null +++ b/7.x/docs/classes/VersionHandler.html @@ -0,0 +1,191 @@ +VersionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..d9bcb0185 --- /dev/null +++ b/7.x/docs/classes/ViewInteractionHandler.html @@ -0,0 +1,194 @@ +ViewInteractionHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..fff5744c4 --- /dev/null +++ b/7.x/docs/classes/VoidLocker.html @@ -0,0 +1,217 @@ +VoidLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..fb50b1663 --- /dev/null +++ b/7.x/docs/classes/VoidLogger.html @@ -0,0 +1,245 @@ +VoidLogger | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6387462ee --- /dev/null +++ b/7.x/docs/classes/VoidLoggerFactory.html @@ -0,0 +1,133 @@ +VoidLoggerFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..161612373 --- /dev/null +++ b/7.x/docs/classes/WacAllowHttpHandler.html @@ -0,0 +1,243 @@ +WacAllowHttpHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..151e723d9 --- /dev/null +++ b/7.x/docs/classes/WacAllowMetadataWriter.html @@ -0,0 +1,213 @@ +WacAllowMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..39576e779 --- /dev/null +++ b/7.x/docs/classes/WaterfallHandler.html @@ -0,0 +1,220 @@ +WaterfallHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..a336934ba --- /dev/null +++ b/7.x/docs/classes/WebAclReader.html @@ -0,0 +1,389 @@ +WebAclReader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..efc72d9c1 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Emitter.html @@ -0,0 +1,199 @@ +WebSocket2023Emitter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..a1c659f90 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Handler.html @@ -0,0 +1,173 @@ +WebSocket2023Handler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class WebSocket2023HandlerAbstract

+
+

A handler that is called when a valid WebSocketChannel2023 connection has been made.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..6318333a8 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Listener.html @@ -0,0 +1,216 @@ +WebSocket2023Listener | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..33bfeed1a --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Storer.html @@ -0,0 +1,226 @@ +WebSocket2023Storer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..7d9a402fc --- /dev/null +++ b/7.x/docs/classes/WebSocketAdvertiser.html @@ -0,0 +1,193 @@ +WebSocketAdvertiser | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class WebSocketAdvertiser

+
+

Handler that advertises a WebSocket through the Updates-Via header.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
socketUrl: string
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..968670696 --- /dev/null +++ b/7.x/docs/classes/WebSocketChannel2023Type.html @@ -0,0 +1,336 @@ +WebSocketChannel2023Type | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..d72d57b52 --- /dev/null +++ b/7.x/docs/classes/WebSocketHandler.html @@ -0,0 +1,174 @@ +WebSocketHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class WebSocketHandlerAbstract

+
+

A handler to support requests trying to open a WebSocket connection.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..3fb5f13e1 --- /dev/null +++ b/7.x/docs/classes/WebSocketMap.html @@ -0,0 +1,456 @@ +WebSocketMap | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

    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..f13cd3d49 --- /dev/null +++ b/7.x/docs/classes/WebSocketServerConfigurator.html @@ -0,0 +1,198 @@ +WebSocketServerConfigurator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..8b805a31a --- /dev/null +++ b/7.x/docs/classes/WebhookChannel2023Type.html @@ -0,0 +1,366 @@ +WebhookChannel2023Type | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7e3caa9fe --- /dev/null +++ b/7.x/docs/classes/WebhookEmitter.html @@ -0,0 +1,229 @@ +WebhookEmitter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..70272d2e9 --- /dev/null +++ b/7.x/docs/classes/WebhookWebId.html @@ -0,0 +1,192 @@ +WebhookWebId | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..f6a1ed0a1 --- /dev/null +++ b/7.x/docs/classes/WinstonLogger.html @@ -0,0 +1,282 @@ +WinstonLogger | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

      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..44dbc039d --- /dev/null +++ b/7.x/docs/classes/WinstonLoggerFactory.html @@ -0,0 +1,167 @@ +WinstonLoggerFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b59b3d91c --- /dev/null +++ b/7.x/docs/classes/WorkerManager.html @@ -0,0 +1,182 @@ +WorkerManager | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Class WorkerManager

+
+

Spawns the necessary workers when starting in multithreaded mode.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
clusterManager: ClusterManager
+
+

Methods

+
+ +
    + +
  • +

    Checks if 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..a5b870186 --- /dev/null +++ b/7.x/docs/classes/WrappedExpiringReadWriteLocker.html @@ -0,0 +1,289 @@ +WrappedExpiringReadWriteLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..562392f2b --- /dev/null +++ b/7.x/docs/classes/WrappedExpiringStorage.html @@ -0,0 +1,390 @@ +WrappedExpiringStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..bbe320f80 --- /dev/null +++ b/7.x/docs/classes/WrappedIndexedStorage.html @@ -0,0 +1,1018 @@ +WrappedIndexedStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0fa03e507 --- /dev/null +++ b/7.x/docs/classes/WrappedSetMultiMap.html @@ -0,0 +1,485 @@ +WrappedSetMultiMap | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

    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..70100671a --- /dev/null +++ b/7.x/docs/classes/WrappingLogger.html @@ -0,0 +1,283 @@ +WrappingLogger | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0ba0dd573 --- /dev/null +++ b/7.x/docs/classes/WwwAuthMetadataWriter.html @@ -0,0 +1,195 @@ +WwwAuthMetadataWriter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..410cdfd9a --- /dev/null +++ b/7.x/docs/classes/YargsCliExtractor.html @@ -0,0 +1,227 @@ +YargsCliExtractor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..b79db49a3 --- /dev/null +++ b/7.x/docs/classes/YargsParameter.html @@ -0,0 +1,128 @@ +YargsParameter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

      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..a4c8aaea0 --- /dev/null +++ b/7.x/docs/enums/AccessMode.html @@ -0,0 +1,113 @@ +AccessMode | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..852de2dd8 --- /dev/null +++ b/7.x/docs/enums/AclMode.html @@ -0,0 +1,81 @@ +AclMode | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..bb94b80df --- /dev/null +++ b/7.x/docs/functions/absoluteFilePath.html @@ -0,0 +1,79 @@ +absoluteFilePath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ac659cb60 --- /dev/null +++ b/7.x/docs/functions/addGeneratedResources.html @@ -0,0 +1,87 @@ +addGeneratedResources | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..08384c818 --- /dev/null +++ b/7.x/docs/functions/addHeader.html @@ -0,0 +1,77 @@ +addHeader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..33a1f0a2f --- /dev/null +++ b/7.x/docs/functions/addResourceMetadata.html @@ -0,0 +1,81 @@ +addResourceMetadata | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a15019459 --- /dev/null +++ b/7.x/docs/functions/addTemplateMetadata.html @@ -0,0 +1,86 @@ +addTemplateMetadata | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..040cb5df4 --- /dev/null +++ b/7.x/docs/functions/allFulfilled.html @@ -0,0 +1,81 @@ +allFulfilled | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..70fd101e7 --- /dev/null +++ b/7.x/docs/functions/assertAccountId.html @@ -0,0 +1,73 @@ +assertAccountId | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..50b0b39cc --- /dev/null +++ b/7.x/docs/functions/assertOidcInteraction.html @@ -0,0 +1,78 @@ +assertOidcInteraction | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4b07f4653 --- /dev/null +++ b/7.x/docs/functions/assertReadConditions.html @@ -0,0 +1,94 @@ +assertReadConditions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ce705a93b --- /dev/null +++ b/7.x/docs/functions/asyncToArray.html @@ -0,0 +1,78 @@ +asyncToArray | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a69d7ecc9 --- /dev/null +++ b/7.x/docs/functions/cleanPreferences.html @@ -0,0 +1,79 @@ +cleanPreferences | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..27216eaf2 --- /dev/null +++ b/7.x/docs/functions/cloneRepresentation.html @@ -0,0 +1,78 @@ +cloneRepresentation | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..92288b7c3 --- /dev/null +++ b/7.x/docs/functions/concat.html @@ -0,0 +1,81 @@ +concat | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c0de71ff5 --- /dev/null +++ b/7.x/docs/functions/createAggregateError.html @@ -0,0 +1,78 @@ +createAggregateError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4832fbc3f --- /dev/null +++ b/7.x/docs/functions/createErrorMessage.html @@ -0,0 +1,73 @@ +createErrorMessage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..588805d6b --- /dev/null +++ b/7.x/docs/functions/createGenericEventEmitterClass.html @@ -0,0 +1,81 @@ +createGenericEventEmitterClass | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..9e55ed7e2 --- /dev/null +++ b/7.x/docs/functions/createSubdomainRegexp.html @@ -0,0 +1,85 @@ +createSubdomainRegexp | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..50288e125 --- /dev/null +++ b/7.x/docs/functions/createVocabulary.html @@ -0,0 +1,84 @@ +createVocabulary | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7c07d398e --- /dev/null +++ b/7.x/docs/functions/decodeUriPathComponents.html @@ -0,0 +1,80 @@ +decodeUriPathComponents | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..53f11a884 --- /dev/null +++ b/7.x/docs/functions/encodeUriPathComponents.html @@ -0,0 +1,79 @@ +encodeUriPathComponents | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..cb74c4fd7 --- /dev/null +++ b/7.x/docs/functions/endOfStream.html @@ -0,0 +1,70 @@ +endOfStream | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..03bc8a0d6 --- /dev/null +++ b/7.x/docs/functions/ensureLeadingSlash.html @@ -0,0 +1,79 @@ +ensureLeadingSlash | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..78256c51a --- /dev/null +++ b/7.x/docs/functions/ensureTrailingSlash.html @@ -0,0 +1,79 @@ +ensureTrailingSlash | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..10f4c7967 --- /dev/null +++ b/7.x/docs/functions/errorTermsToMetadata.html @@ -0,0 +1,83 @@ +errorTermsToMetadata | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b5f0ba301 --- /dev/null +++ b/7.x/docs/functions/extendVocabulary.html @@ -0,0 +1,90 @@ +extendVocabulary | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..24385f38d --- /dev/null +++ b/7.x/docs/functions/extractErrorTerms.html @@ -0,0 +1,79 @@ +extractErrorTerms | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..04b0adc54 --- /dev/null +++ b/7.x/docs/functions/extractScheme.html @@ -0,0 +1,82 @@ +extractScheme | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..df706927e --- /dev/null +++ b/7.x/docs/functions/fetchDataset.html @@ -0,0 +1,74 @@ +fetchDataset | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..68e11f817 --- /dev/null +++ b/7.x/docs/functions/filter.html @@ -0,0 +1,106 @@ +filter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

      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..8db4baf8a --- /dev/null +++ b/7.x/docs/functions/filterHandlers.html @@ -0,0 +1,89 @@ +filterHandlers | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c5d261d6c --- /dev/null +++ b/7.x/docs/functions/find.html @@ -0,0 +1,107 @@ +find | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

      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..e56c052fb --- /dev/null +++ b/7.x/docs/functions/findHandler.html @@ -0,0 +1,90 @@ +findHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b039e72c6 --- /dev/null +++ b/7.x/docs/functions/finishInteraction.html @@ -0,0 +1,86 @@ +finishInteraction | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c8db6cbf6 --- /dev/null +++ b/7.x/docs/functions/forgetWebId.html @@ -0,0 +1,83 @@ +forgetWebId | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..da3ca6ca6 --- /dev/null +++ b/7.x/docs/functions/generateHttpErrorClass.html @@ -0,0 +1,86 @@ +generateHttpErrorClass | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..86aa8a90f --- /dev/null +++ b/7.x/docs/functions/generateHttpErrorUri.html @@ -0,0 +1,73 @@ +generateHttpErrorUri | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..40033d0af --- /dev/null +++ b/7.x/docs/functions/generateRedirectHttpErrorClass.html @@ -0,0 +1,82 @@ +generateRedirectHttpErrorClass | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..723560abb --- /dev/null +++ b/7.x/docs/functions/generateWebSocketUrl.html @@ -0,0 +1,76 @@ +generateWebSocketUrl | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5a91f1428 --- /dev/null +++ b/7.x/docs/functions/getAccessControl.html @@ -0,0 +1,81 @@ +getAccessControl | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f21cc4c65 --- /dev/null +++ b/7.x/docs/functions/getAccessControlResource.html @@ -0,0 +1,81 @@ +getAccessControlResource | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3aa924696 --- /dev/null +++ b/7.x/docs/functions/getAccessControlledResources.html @@ -0,0 +1,76 @@ +getAccessControlledResources | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2c48c51a7 --- /dev/null +++ b/7.x/docs/functions/getBestPreference.html @@ -0,0 +1,84 @@ +getBestPreference | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b076fe84d --- /dev/null +++ b/7.x/docs/functions/getConversionTarget.html @@ -0,0 +1,88 @@ +getConversionTarget | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..52d72d251 --- /dev/null +++ b/7.x/docs/functions/getDefault.html @@ -0,0 +1,142 @@ +getDefault | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..9b25507fb --- /dev/null +++ b/7.x/docs/functions/getExtension.html @@ -0,0 +1,77 @@ +getExtension | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..9cd69b665 --- /dev/null +++ b/7.x/docs/functions/getLoggerFor.html @@ -0,0 +1,82 @@ +getLoggerFor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2661ba120 --- /dev/null +++ b/7.x/docs/functions/getMatcher.html @@ -0,0 +1,81 @@ +getMatcher | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b7a37b610 --- /dev/null +++ b/7.x/docs/functions/getModuleRoot.html @@ -0,0 +1,68 @@ +getModuleRoot | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6d9f74b11 --- /dev/null +++ b/7.x/docs/functions/getPolicy.html @@ -0,0 +1,81 @@ +getPolicy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a36c7d426 --- /dev/null +++ b/7.x/docs/functions/getRelativeUrl.html @@ -0,0 +1,87 @@ +getRelativeUrl | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f74b6398c --- /dev/null +++ b/7.x/docs/functions/getSingleItem.html @@ -0,0 +1,78 @@ +getSingleItem | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..788411ac1 --- /dev/null +++ b/7.x/docs/functions/getTemplateFilePath.html @@ -0,0 +1,74 @@ +getTemplateFilePath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..067da6e9f --- /dev/null +++ b/7.x/docs/functions/getTypeWeight.html @@ -0,0 +1,83 @@ +getTypeWeight | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1eb8f196f --- /dev/null +++ b/7.x/docs/functions/getWeightedPreferences.html @@ -0,0 +1,84 @@ +getWeightedPreferences | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..bfe5ba452 --- /dev/null +++ b/7.x/docs/functions/guardStream.html @@ -0,0 +1,87 @@ +guardStream | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f8af834de --- /dev/null +++ b/7.x/docs/functions/guardedStreamFrom.html @@ -0,0 +1,81 @@ +guardedStreamFrom | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function guardedStreamFrom

+
+
    + +
  • +

    Converts a string or array to a stream and applies an error guard so that it is Guarded.

    +
    +
    +

    Parameters

    +
      +
    • +
      contents: string | Iterable<any>
      +

      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..ffeab246e --- /dev/null +++ b/7.x/docs/functions/hasScheme.html @@ -0,0 +1,82 @@ +hasScheme | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..6ef9227eb --- /dev/null +++ b/7.x/docs/functions/identifierHashFn.html @@ -0,0 +1,73 @@ +identifierHashFn | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4e42889d1 --- /dev/null +++ b/7.x/docs/functions/importOidcProvider.html @@ -0,0 +1,74 @@ +importOidcProvider | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1e9b57d91 --- /dev/null +++ b/7.x/docs/functions/isContainerIdentifier.html @@ -0,0 +1,76 @@ +isContainerIdentifier | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function isContainerIdentifier

+
+
    + +
  • +

    Checks if 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..c26f4cc01 --- /dev/null +++ b/7.x/docs/functions/isContainerPath.html @@ -0,0 +1,76 @@ +isContainerPath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function isContainerPath

+
+
    + +
  • +

    Checks if 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..54dce2026 --- /dev/null +++ b/7.x/docs/functions/isError.html @@ -0,0 +1,73 @@ +isError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5bf5446ea --- /dev/null +++ b/7.x/docs/functions/isGuarded.html @@ -0,0 +1,78 @@ +isGuarded | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..d681091ae --- /dev/null +++ b/7.x/docs/functions/isHttpRequest.html @@ -0,0 +1,73 @@ +isHttpRequest | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..9b2358fb3 --- /dev/null +++ b/7.x/docs/functions/isHttpsServer.html @@ -0,0 +1,73 @@ +isHttpsServer | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..894ada973 --- /dev/null +++ b/7.x/docs/functions/isInternalContentType.html @@ -0,0 +1,78 @@ +isInternalContentType | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..33b43aca7 --- /dev/null +++ b/7.x/docs/functions/isPromise.html @@ -0,0 +1,81 @@ +isPromise | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..863bb884b --- /dev/null +++ b/7.x/docs/functions/isRepresentationMetadata.html @@ -0,0 +1,73 @@ +isRepresentationMetadata | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..36cdcffba --- /dev/null +++ b/7.x/docs/functions/isResourceIdentifier.html @@ -0,0 +1,73 @@ +isResourceIdentifier | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..57b045112 --- /dev/null +++ b/7.x/docs/functions/isSystemError.html @@ -0,0 +1,70 @@ +isSystemError | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..9cd962cfa --- /dev/null +++ b/7.x/docs/functions/isTerm.html @@ -0,0 +1,74 @@ +isTerm | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1c185a482 --- /dev/null +++ b/7.x/docs/functions/isUrl.html @@ -0,0 +1,77 @@ +isUrl | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function isUrl

+
+
    + +
  • +

    Checks if 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..b4011fa70 --- /dev/null +++ b/7.x/docs/functions/isValidFileName.html @@ -0,0 +1,77 @@ +isValidFileName | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..21c2e729e --- /dev/null +++ b/7.x/docs/functions/isValidVariable.html @@ -0,0 +1,74 @@ +isValidVariable | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c8bd8ae1e --- /dev/null +++ b/7.x/docs/functions/isWebSocket2023Channel.html @@ -0,0 +1,70 @@ +isWebSocket2023Channel | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..35c5f5f95 --- /dev/null +++ b/7.x/docs/functions/isWebhook2023Channel.html @@ -0,0 +1,70 @@ +isWebhook2023Channel | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..0de9ce177 --- /dev/null +++ b/7.x/docs/functions/joinFilePath.html @@ -0,0 +1,82 @@ +joinFilePath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a5d765f46 --- /dev/null +++ b/7.x/docs/functions/joinUrl.html @@ -0,0 +1,88 @@ +joinUrl | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..11a2f756e --- /dev/null +++ b/7.x/docs/functions/listSingleThreadedComponents.html @@ -0,0 +1,82 @@ +listSingleThreadedComponents | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8f4838c2b --- /dev/null +++ b/7.x/docs/functions/map.html @@ -0,0 +1,108 @@ +map | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

      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..734df7dae --- /dev/null +++ b/7.x/docs/functions/matchesAuthorizationScheme.html @@ -0,0 +1,82 @@ +matchesAuthorizationScheme | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..29e1b995e --- /dev/null +++ b/7.x/docs/functions/matchesMediaPreferences.html @@ -0,0 +1,81 @@ +matchesMediaPreferences | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2e3057d8a --- /dev/null +++ b/7.x/docs/functions/matchesMediaType.html @@ -0,0 +1,83 @@ +matchesMediaType | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function matchesMediaType

+
+
    + +
  • +

    Checks if 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..5adeb7ff7 --- /dev/null +++ b/7.x/docs/functions/modify.html @@ -0,0 +1,87 @@ +modify | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..aaf897d4e --- /dev/null +++ b/7.x/docs/functions/modulePath.html @@ -0,0 +1,74 @@ +modulePath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..65fc91749 --- /dev/null +++ b/7.x/docs/functions/msToDuration.html @@ -0,0 +1,78 @@ +msToDuration | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b8dff74a1 --- /dev/null +++ b/7.x/docs/functions/normalizeFilePath.html @@ -0,0 +1,77 @@ +normalizeFilePath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..63be09eb7 --- /dev/null +++ b/7.x/docs/functions/parseAccept.html @@ -0,0 +1,83 @@ +parseAccept | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a3c8fb638 --- /dev/null +++ b/7.x/docs/functions/parseAcceptCharset.html @@ -0,0 +1,83 @@ +parseAcceptCharset | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f3949e310 --- /dev/null +++ b/7.x/docs/functions/parseAcceptDateTime.html @@ -0,0 +1,83 @@ +parseAcceptDateTime | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6caaad1ab --- /dev/null +++ b/7.x/docs/functions/parseAcceptEncoding.html @@ -0,0 +1,83 @@ +parseAcceptEncoding | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3b908509b --- /dev/null +++ b/7.x/docs/functions/parseAcceptLanguage.html @@ -0,0 +1,83 @@ +parseAcceptLanguage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b4b69947d --- /dev/null +++ b/7.x/docs/functions/parseContentType.html @@ -0,0 +1,80 @@ +parseContentType | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b07ecbff3 --- /dev/null +++ b/7.x/docs/functions/parseForwarded.html @@ -0,0 +1,77 @@ +parseForwarded | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3c216711e --- /dev/null +++ b/7.x/docs/functions/parseLinkHeader.html @@ -0,0 +1,77 @@ +parseLinkHeader | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b4e315879 --- /dev/null +++ b/7.x/docs/functions/parseParameters.html @@ -0,0 +1,88 @@ +parseParameters | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..511774767 --- /dev/null +++ b/7.x/docs/functions/parsePath.html @@ -0,0 +1,88 @@ +parsePath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7296af7cf --- /dev/null +++ b/7.x/docs/functions/parseQuads.html @@ -0,0 +1,82 @@ +parseQuads | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..237d62194 --- /dev/null +++ b/7.x/docs/functions/parseSchema.html @@ -0,0 +1,78 @@ +parseSchema | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function parseSchema

+
+
    + +
  • +

    Generates a simplified representation of a yup schema.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends ObjectSchema<any, AnyObject, any, "">

    +
    +

    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..598eefbf5 --- /dev/null +++ b/7.x/docs/functions/parseWebSocketRequest.html @@ -0,0 +1,81 @@ +parseWebSocketRequest | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..095d33f63 --- /dev/null +++ b/7.x/docs/functions/pipeSafely.html @@ -0,0 +1,105 @@ +pipeSafely | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function pipeSafely

+
+
    + +
  • +

    Pipes one stream into another and emits errors of the first stream with the second. +In case of an error in the first stream 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..878a6c9e8 --- /dev/null +++ b/7.x/docs/functions/preferencesToString.html @@ -0,0 +1,76 @@ +preferencesToString | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..328a4c1ec --- /dev/null +++ b/7.x/docs/functions/promiseSome.html @@ -0,0 +1,82 @@ +promiseSome | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..65b4f8c41 --- /dev/null +++ b/7.x/docs/functions/readJsonStream.html @@ -0,0 +1,77 @@ +readJsonStream | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function readJsonStream

+
+
    + +
  • +

    Interprets the stream as JSON and converts it to a Dict.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable
      +

      Stream of JSON data.

      +
      +
    +

    Returns Promise<NodeJS.Dict<any>>

    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..e321687a0 --- /dev/null +++ b/7.x/docs/functions/readPackageJson.html @@ -0,0 +1,68 @@ +readPackageJson | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function readPackageJson

+
+
    + +
  • +

    Reads the project package.json and returns it.

    +
    +

    Returns Promise<Record<string, any>>

    +
+
+
\ 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..42f4a9937 --- /dev/null +++ b/7.x/docs/functions/readTemplate.html @@ -0,0 +1,73 @@ +readTemplate | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..af93e73b4 --- /dev/null +++ b/7.x/docs/functions/readableToQuads.html @@ -0,0 +1,77 @@ +readableToQuads | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f0a9b7ecc --- /dev/null +++ b/7.x/docs/functions/readableToString.html @@ -0,0 +1,77 @@ +readableToString | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6ba05c0fa --- /dev/null +++ b/7.x/docs/functions/reduce.html @@ -0,0 +1,152 @@ +reduce | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a4e5a969e --- /dev/null +++ b/7.x/docs/functions/resetInternalLoggerFactory.html @@ -0,0 +1,74 @@ +resetInternalLoggerFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ab30cb93a --- /dev/null +++ b/7.x/docs/functions/resolveAssetPath.html @@ -0,0 +1,75 @@ +resolveAssetPath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3cdaeac43 --- /dev/null +++ b/7.x/docs/functions/resolveModulePath.html @@ -0,0 +1,73 @@ +resolveModulePath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ae6297afa --- /dev/null +++ b/7.x/docs/functions/resolvePromiseOrValue.html @@ -0,0 +1,95 @@ +resolvePromiseOrValue | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4e1265ba2 --- /dev/null +++ b/7.x/docs/functions/responseToDataset.html @@ -0,0 +1,80 @@ +responseToDataset | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..24f961962 --- /dev/null +++ b/7.x/docs/functions/sanitizeUrlPart.html @@ -0,0 +1,77 @@ +sanitizeUrlPart | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c356ee1e6 --- /dev/null +++ b/7.x/docs/functions/serializeQuads.html @@ -0,0 +1,82 @@ +serializeQuads | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..77aff6b66 --- /dev/null +++ b/7.x/docs/functions/setGlobalLoggerFactory.html @@ -0,0 +1,77 @@ +setGlobalLoggerFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3474b610b --- /dev/null +++ b/7.x/docs/functions/setSafeInterval.html @@ -0,0 +1,100 @@ +setSafeInterval | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1daf933be --- /dev/null +++ b/7.x/docs/functions/sortedAsyncMerge.html @@ -0,0 +1,100 @@ +sortedAsyncMerge | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ef026b37d --- /dev/null +++ b/7.x/docs/functions/splitAndClean.html @@ -0,0 +1,77 @@ +splitAndClean | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..52f59106c --- /dev/null +++ b/7.x/docs/functions/splitCommaSeparated.html @@ -0,0 +1,77 @@ +splitCommaSeparated | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e1ea5b3e8 --- /dev/null +++ b/7.x/docs/functions/termToInt.html @@ -0,0 +1,81 @@ +termToInt | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6a415ec92 --- /dev/null +++ b/7.x/docs/functions/toCanonicalUriPath.html @@ -0,0 +1,80 @@ +toCanonicalUriPath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3844f698d --- /dev/null +++ b/7.x/docs/functions/toComponentsJsType.html @@ -0,0 +1,87 @@ +toComponentsJsType | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7dfc69814 --- /dev/null +++ b/7.x/docs/functions/toLiteral.html @@ -0,0 +1,81 @@ +toLiteral | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..04f76e5ce --- /dev/null +++ b/7.x/docs/functions/toNamedTerm.html @@ -0,0 +1,106 @@ +toNamedTerm | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e50188808 --- /dev/null +++ b/7.x/docs/functions/toObjectTerm.html @@ -0,0 +1,115 @@ +toObjectTerm | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2ae93ce4b --- /dev/null +++ b/7.x/docs/functions/toPredicateTerm.html @@ -0,0 +1,106 @@ +toPredicateTerm | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..bcb9fe8c7 --- /dev/null +++ b/7.x/docs/functions/transformQuotedStrings.html @@ -0,0 +1,85 @@ +transformQuotedStrings | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7b5719c9e --- /dev/null +++ b/7.x/docs/functions/transformSafely.html @@ -0,0 +1,87 @@ +transformSafely | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function transformSafely

+
+
    + +
  • +

    Transforms a stream, ensuring that all errors are forwarded.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = any

    +
    +

    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..6970c9ddc --- /dev/null +++ b/7.x/docs/functions/trimLeadingSlashes.html @@ -0,0 +1,77 @@ +trimLeadingSlashes | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..535e20a27 --- /dev/null +++ b/7.x/docs/functions/trimTrailingSlashes.html @@ -0,0 +1,77 @@ +trimTrailingSlashes | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..71ce436dc --- /dev/null +++ b/7.x/docs/functions/uniqueQuads.html @@ -0,0 +1,77 @@ +uniqueQuads | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3d3ed4dec --- /dev/null +++ b/7.x/docs/functions/updateModifiedDate.html @@ -0,0 +1,81 @@ +updateModifiedDate | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5228da6a6 --- /dev/null +++ b/7.x/docs/functions/validateWithError.html @@ -0,0 +1,82 @@ +validateWithError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Function validateWithError

+
+
    + +
  • +

    Same functionality as the yup validate function, but throws a BadRequestHttpError if there is an error.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends ObjectSchema<any, AnyObject, any, "">

    +
    +

    Parameters

    +
      +
    • +
      schema: T
    • +
    • +
      data: unknown
    • +
    • +
      Optional options: ValidateOptions<any>
    +

    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..debc78419 --- /dev/null +++ b/7.x/docs/functions/verifyAccountId.html @@ -0,0 +1,82 @@ +verifyAccountId | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..83baf2b52 --- /dev/null +++ b/7.x/docs/index.html @@ -0,0 +1,125 @@ +Community Solid Server - v7.0.3
+
+ +
+
+
+
+

Community Solid Server - v7.0.3

+

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.

+

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..05bc269c9 --- /dev/null +++ b/7.x/docs/interfaces/AccessCheckerArgs.html @@ -0,0 +1,108 @@ +AccessCheckerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a5e87788f --- /dev/null +++ b/7.x/docs/interfaces/AccountInitializerArgs.html @@ -0,0 +1,138 @@ +AccountInitializerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f6105f9da --- /dev/null +++ b/7.x/docs/interfaces/AccountStore.html @@ -0,0 +1,179 @@ +AccountStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Interface AccountStore

+
+

Used to store account data.

+
+
+
+

Hierarchy

+
    +
  • AccountStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Methods

+
+
+

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>

      +
+
+

Methods

+
+ +
+
+ +
    + +
  • +

    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..b6f487c70 --- /dev/null +++ b/7.x/docs/interfaces/AdapterFactory.html @@ -0,0 +1,110 @@ +AdapterFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..9ba4f19f8 --- /dev/null +++ b/7.x/docs/interfaces/AlgJwk.html @@ -0,0 +1,304 @@ +AlgJwk | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..adfc7cf63 --- /dev/null +++ b/7.x/docs/interfaces/AppRunnerInput.html @@ -0,0 +1,147 @@ +AppRunnerInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a47baacab --- /dev/null +++ b/7.x/docs/interfaces/AsyncTransformOptions.html @@ -0,0 +1,426 @@ +AsyncTransformOptions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Interface AsyncTransformOptions<T>

+
+

Type Parameters

+
    +
  • +

    T = any

+
+

Hierarchy

+
    +
  • DuplexOptions +
      +
    • AsyncTransformOptions
+
+
+
+ +
+
+

Properties

+
+ +
allowHalfOpen?: boolean
+
+ +
autoDestroy?: boolean
+
+ +
decodeStrings?: boolean
+
+ +
defaultEncoding?: BufferEncoding
+
+ +
emitClose?: boolean
+
+ +
encoding?: BufferEncoding
+
+ +
flush?: ((this) => any)
+
+

Type declaration

+
    +
  • +
      +
    • (this): any
    • +
    • +

      Performs any final actions after the source has ended

      +
      +
      +

      Parameters

      +
        +
      • +
        this: Transform
      +

      Returns any

      +
+
+ +
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) => any)
+
+

Type declaration

+
    +
  • +
      +
    • (this, data, encoding): any
    • +
    • +

      Transforms data from the source by calling the push method

      +
      +
      +

      Parameters

      +
        +
      • +
        this: Transform
      • +
      • +
        data: T
      • +
      • +
        encoding: string
      +

      Returns any

      +
+
+ +
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..50154d44a --- /dev/null +++ b/7.x/docs/interfaces/AtomicDataAccessor.html @@ -0,0 +1,347 @@ +AtomicDataAccessor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ed48d112a --- /dev/null +++ b/7.x/docs/interfaces/AtomicResourceStore.html @@ -0,0 +1,303 @@ +AtomicResourceStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

      Check if 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..59f186154 --- /dev/null +++ b/7.x/docs/interfaces/AuthorizerInput.html @@ -0,0 +1,108 @@ +AuthorizerInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8ff017abf --- /dev/null +++ b/7.x/docs/interfaces/AuthorizingHttpHandlerArgs.html @@ -0,0 +1,128 @@ +AuthorizingHttpHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..776edc6bd --- /dev/null +++ b/7.x/docs/interfaces/AuxiliaryIdentifierStrategy.html @@ -0,0 +1,204 @@ +AuxiliaryIdentifierStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..d0635a725 --- /dev/null +++ b/7.x/docs/interfaces/AuxiliaryStrategy.html @@ -0,0 +1,324 @@ +AuxiliaryStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ada5cf210 --- /dev/null +++ b/7.x/docs/interfaces/BasePodCreatorArgs.html @@ -0,0 +1,130 @@ +BasePodCreatorArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0d6eae4c5 --- /dev/null +++ b/7.x/docs/interfaces/BaseRouterHandlerArgs.html @@ -0,0 +1,130 @@ +BaseRouterHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4b6d06e94 --- /dev/null +++ b/7.x/docs/interfaces/BaseServerFactoryOptions.html @@ -0,0 +1,123 @@ +BaseServerFactoryOptions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..36d68ed4e --- /dev/null +++ b/7.x/docs/interfaces/BasicConditionsOptions.html @@ -0,0 +1,106 @@ +BasicConditionsOptions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5796519f3 --- /dev/null +++ b/7.x/docs/interfaces/BasicRequestParserArgs.html @@ -0,0 +1,117 @@ +BasicRequestParserArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..19bab0d6c --- /dev/null +++ b/7.x/docs/interfaces/BodyParserArgs.html @@ -0,0 +1,99 @@ +BodyParserArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..abf03614e --- /dev/null +++ b/7.x/docs/interfaces/CliOptions.html @@ -0,0 +1,106 @@ +CliOptions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..11cee1232 --- /dev/null +++ b/7.x/docs/interfaces/ClientCredentials.html @@ -0,0 +1,113 @@ +ClientCredentials | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..1f855bf40 --- /dev/null +++ b/7.x/docs/interfaces/ClientCredentialsStore.html @@ -0,0 +1,223 @@ +ClientCredentialsStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..afca24be4 --- /dev/null +++ b/7.x/docs/interfaces/ComponentsJsFactory.html @@ -0,0 +1,128 @@ +ComponentsJsFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

        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..d5943daf0 --- /dev/null +++ b/7.x/docs/interfaces/ComposedNotificationHandlerArgs.html @@ -0,0 +1,106 @@ +ComposedNotificationHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..22c9f4002 --- /dev/null +++ b/7.x/docs/interfaces/Conditions.html @@ -0,0 +1,159 @@ +Conditions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..12c55ee52 --- /dev/null +++ b/7.x/docs/interfaces/ConstantConverterOptions.html @@ -0,0 +1,132 @@ +ConstantConverterOptions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..cdb545a8d --- /dev/null +++ b/7.x/docs/interfaces/ContainerInitializerArgs.html @@ -0,0 +1,138 @@ +ContainerInitializerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..56d6322cd --- /dev/null +++ b/7.x/docs/interfaces/ConvertingStoreEntry.html @@ -0,0 +1,92 @@ +ConvertingStoreEntry | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..66b35760d --- /dev/null +++ b/7.x/docs/interfaces/CookieStore.html @@ -0,0 +1,192 @@ +CookieStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c76badbf2 --- /dev/null +++ b/7.x/docs/interfaces/DataAccessor.html @@ -0,0 +1,346 @@ +DataAccessor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ea8bd35f3 --- /dev/null +++ b/7.x/docs/interfaces/ETagHandler.html @@ -0,0 +1,183 @@ +ETagHandler | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..00c7eea34 --- /dev/null +++ b/7.x/docs/interfaces/EmailArgs.html @@ -0,0 +1,106 @@ +EmailArgs | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..aee4faddb --- /dev/null +++ b/7.x/docs/interfaces/EmailSenderArgs.html @@ -0,0 +1,106 @@ +EmailSenderArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6ac5a4e08 --- /dev/null +++ b/7.x/docs/interfaces/ErrorHandlerArgs.html @@ -0,0 +1,92 @@ +ErrorHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5511f55ed --- /dev/null +++ b/7.x/docs/interfaces/ExpiringReadWriteLocker.html @@ -0,0 +1,203 @@ +ExpiringReadWriteLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2a9c745d1 --- /dev/null +++ b/7.x/docs/interfaces/ExpiringStorage.html @@ -0,0 +1,260 @@ +ExpiringStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..8c3ad97d6 --- /dev/null +++ b/7.x/docs/interfaces/FileIdentifierMapper.html @@ -0,0 +1,158 @@ +FileIdentifierMapper | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..69ab7a986 --- /dev/null +++ b/7.x/docs/interfaces/FileIdentifierMapperFactory.html @@ -0,0 +1,114 @@ +FileIdentifierMapperFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..65c97f343 --- /dev/null +++ b/7.x/docs/interfaces/Finalizable.html @@ -0,0 +1,105 @@ +Finalizable | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3c372d448 --- /dev/null +++ b/7.x/docs/interfaces/ForgotPasswordHandlerArgs.html @@ -0,0 +1,133 @@ +ForgotPasswordHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5f5c0914b --- /dev/null +++ b/7.x/docs/interfaces/ForgotPasswordStore.html @@ -0,0 +1,169 @@ +ForgotPasswordStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ff5b62f0e --- /dev/null +++ b/7.x/docs/interfaces/Forwarded.html @@ -0,0 +1,122 @@ +Forwarded | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..49dd207f2 --- /dev/null +++ b/7.x/docs/interfaces/GenericEventEmitter.html @@ -0,0 +1,446 @@ +GenericEventEmitter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..68fc5bd75 --- /dev/null +++ b/7.x/docs/interfaces/HttpErrorClass.html @@ -0,0 +1,153 @@ +HttpErrorClass | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..4fc624951 --- /dev/null +++ b/7.x/docs/interfaces/HttpErrorOptions.html @@ -0,0 +1,103 @@ +HttpErrorOptions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c5a1173f3 --- /dev/null +++ b/7.x/docs/interfaces/HttpHandlerInput.html @@ -0,0 +1,94 @@ +HttpHandlerInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..eddb790be --- /dev/null +++ b/7.x/docs/interfaces/HttpServerFactory.html @@ -0,0 +1,101 @@ +HttpServerFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3e227e72b --- /dev/null +++ b/7.x/docs/interfaces/IdentifierGenerator.html @@ -0,0 +1,135 @@ +IdentifierGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..66ff198bc --- /dev/null +++ b/7.x/docs/interfaces/IdentifierStrategy.html @@ -0,0 +1,191 @@ +IdentifierStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e009f393b --- /dev/null +++ b/7.x/docs/interfaces/IdentityProviderFactoryArgs.html @@ -0,0 +1,188 @@ +IdentityProviderFactoryArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c65d13e10 --- /dev/null +++ b/7.x/docs/interfaces/IdentityProviderHttpHandlerArgs.html @@ -0,0 +1,108 @@ +IdentityProviderHttpHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..95a5a67d3 --- /dev/null +++ b/7.x/docs/interfaces/IndexedStorage.html @@ -0,0 +1,452 @@ +IndexedStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+
+
+
+ +
+
+

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>

    +
+
+ +
    + +
  • +

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

    +
+
+ +
    + +
  • +

    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/interfaces/Initializable.html b/7.x/docs/interfaces/Initializable.html new file mode 100644 index 000000000..0576a7646 --- /dev/null +++ b/7.x/docs/interfaces/Initializable.html @@ -0,0 +1,104 @@ +Initializable | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a33f7e8de --- /dev/null +++ b/7.x/docs/interfaces/InteractionHandlerInput.html @@ -0,0 +1,109 @@ +InteractionHandlerInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..9fe579255 --- /dev/null +++ b/7.x/docs/interfaces/InteractionRoute.html @@ -0,0 +1,150 @@ +InteractionRoute | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..142ce249f --- /dev/null +++ b/7.x/docs/interfaces/JsonInteractionHandlerInput.html @@ -0,0 +1,139 @@ +JsonInteractionHandlerInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..9c779b8b1 --- /dev/null +++ b/7.x/docs/interfaces/JsonRepresentation.html @@ -0,0 +1,103 @@ +JsonRepresentation | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8ce11d75c --- /dev/null +++ b/7.x/docs/interfaces/JsonView.html @@ -0,0 +1,117 @@ +JsonView | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c8c6fbd51 --- /dev/null +++ b/7.x/docs/interfaces/JwkGenerator.html @@ -0,0 +1,131 @@ +JwkGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b99c5a0ad --- /dev/null +++ b/7.x/docs/interfaces/KeyValueStorage.html @@ -0,0 +1,224 @@ +KeyValueStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if 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..568765074 --- /dev/null +++ b/7.x/docs/interfaces/LinkWebIdHandlerArgs.html @@ -0,0 +1,139 @@ +LinkWebIdHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6ba747a59 --- /dev/null +++ b/7.x/docs/interfaces/LogMetadata.html @@ -0,0 +1,98 @@ +LogMetadata | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..cbf9384ab --- /dev/null +++ b/7.x/docs/interfaces/Logger.html @@ -0,0 +1,284 @@ +Logger | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..beb89c3e4 --- /dev/null +++ b/7.x/docs/interfaces/LoggerFactory.html @@ -0,0 +1,114 @@ +LoggerFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..824d409db --- /dev/null +++ b/7.x/docs/interfaces/LoginStorage.html @@ -0,0 +1,479 @@ +LoginStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

+
+
+

Methods

+
+
+

Properties

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

      +
+
+

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>

    +
+
+ +
    + +
  • +

    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>

    +
+
+ +
    + +
  • +

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

    +
+
+ +
    + +
  • +

    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/interfaces/MetadataWriterInput.html b/7.x/docs/interfaces/MetadataWriterInput.html new file mode 100644 index 000000000..2297fae34 --- /dev/null +++ b/7.x/docs/interfaces/MetadataWriterInput.html @@ -0,0 +1,92 @@ +MetadataWriterInput | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..72e78e72b --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannel.html @@ -0,0 +1,209 @@ +NotificationChannel | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2f76af77e --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannelStorage.html @@ -0,0 +1,222 @@ +NotificationChannelStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..69ffdec5b --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannelType.html @@ -0,0 +1,218 @@ +NotificationChannelType | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6665be22c --- /dev/null +++ b/7.x/docs/interfaces/NotificationEmitterInput.html @@ -0,0 +1,92 @@ +NotificationEmitterInput | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..948deff54 --- /dev/null +++ b/7.x/docs/interfaces/NotificationHandlerInput.html @@ -0,0 +1,106 @@ +NotificationHandlerInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0cb7f3c40 --- /dev/null +++ b/7.x/docs/interfaces/NotificationSerializerInput.html @@ -0,0 +1,92 @@ +NotificationSerializerInput | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..184e4cba9 --- /dev/null +++ b/7.x/docs/interfaces/NotificationSubscriberArgs.html @@ -0,0 +1,151 @@ +NotificationSubscriberArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e25c56627 --- /dev/null +++ b/7.x/docs/interfaces/OAuthErrorFields.html @@ -0,0 +1,113 @@ +OAuthErrorFields | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..aba9d82df --- /dev/null +++ b/7.x/docs/interfaces/Operation.html @@ -0,0 +1,132 @@ +Operation | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..d4441509a --- /dev/null +++ b/7.x/docs/interfaces/OperationHandlerInput.html @@ -0,0 +1,85 @@ +OperationHandlerInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b8f6f7414 --- /dev/null +++ b/7.x/docs/interfaces/OperationHttpHandlerInput.html @@ -0,0 +1,103 @@ +OperationHttpHandlerInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..da21b6f7f --- /dev/null +++ b/7.x/docs/interfaces/OriginalUrlExtractorArgs.html @@ -0,0 +1,98 @@ +OriginalUrlExtractorArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8a45c5f72 --- /dev/null +++ b/7.x/docs/interfaces/ParsingHttpHandlerArgs.html @@ -0,0 +1,118 @@ +ParsingHttpHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..bc914abf6 --- /dev/null +++ b/7.x/docs/interfaces/PasswordLoginHandlerArgs.html @@ -0,0 +1,99 @@ +PasswordLoginHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..d4932ef78 --- /dev/null +++ b/7.x/docs/interfaces/PasswordStore.html @@ -0,0 +1,318 @@ +PasswordStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..cc871f8d5 --- /dev/null +++ b/7.x/docs/interfaces/Patch.html @@ -0,0 +1,133 @@ +Patch | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..17fbb22c4 --- /dev/null +++ b/7.x/docs/interfaces/PermissionReaderInput.html @@ -0,0 +1,99 @@ +PermissionReaderInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..11c8966d3 --- /dev/null +++ b/7.x/docs/interfaces/PodCreatorInput.html @@ -0,0 +1,122 @@ +PodCreatorInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e0b816f80 --- /dev/null +++ b/7.x/docs/interfaces/PodCreatorOutput.html @@ -0,0 +1,118 @@ +PodCreatorOutput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..70d6ac5b5 --- /dev/null +++ b/7.x/docs/interfaces/PodGenerator.html @@ -0,0 +1,116 @@ +PodGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..0c3f1752d --- /dev/null +++ b/7.x/docs/interfaces/PodManager.html @@ -0,0 +1,119 @@ +PodManager | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2519c1387 --- /dev/null +++ b/7.x/docs/interfaces/PodSettings.html @@ -0,0 +1,145 @@ +PodSettings | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..748d2aa34 --- /dev/null +++ b/7.x/docs/interfaces/PodStore.html @@ -0,0 +1,300 @@ +PodStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..91f4d3a26 --- /dev/null +++ b/7.x/docs/interfaces/ProviderFactory.html @@ -0,0 +1,106 @@ +ProviderFactory | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..90f781a40 --- /dev/null +++ b/7.x/docs/interfaces/RdfStorePatcherInput.html @@ -0,0 +1,110 @@ +RdfStorePatcherInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f98d25ab9 --- /dev/null +++ b/7.x/docs/interfaces/ReadWriteLocker.html @@ -0,0 +1,179 @@ +ReadWriteLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c8694932a --- /dev/null +++ b/7.x/docs/interfaces/RedirectHttpErrorClass.html @@ -0,0 +1,161 @@ +RedirectHttpErrorClass | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..95f84600c --- /dev/null +++ b/7.x/docs/interfaces/RedisSettings.html @@ -0,0 +1,106 @@ +RedisSettings | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c194cf375 --- /dev/null +++ b/7.x/docs/interfaces/Representation.html @@ -0,0 +1,131 @@ +Representation | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..533d29cf8 --- /dev/null +++ b/7.x/docs/interfaces/RepresentationConverterArgs.html @@ -0,0 +1,108 @@ +RepresentationConverterArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c278f0311 --- /dev/null +++ b/7.x/docs/interfaces/RepresentationPatcherInput.html @@ -0,0 +1,104 @@ +RepresentationPatcherInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..eda9b957b --- /dev/null +++ b/7.x/docs/interfaces/RepresentationPreferences.html @@ -0,0 +1,133 @@ +RepresentationPreferences | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4d7b173b2 --- /dev/null +++ b/7.x/docs/interfaces/Resource.html @@ -0,0 +1,92 @@ +Resource | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..413cacd17 --- /dev/null +++ b/7.x/docs/interfaces/ResourceIdentifier.html @@ -0,0 +1,92 @@ +ResourceIdentifier | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1bb880e86 --- /dev/null +++ b/7.x/docs/interfaces/ResourceLink.html @@ -0,0 +1,118 @@ +ResourceLink | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ed109c84c --- /dev/null +++ b/7.x/docs/interfaces/ResourceLocker.html @@ -0,0 +1,145 @@ +ResourceLocker | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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. +In case 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..6a3dae063 --- /dev/null +++ b/7.x/docs/interfaces/ResourceSet.html @@ -0,0 +1,115 @@ +ResourceSet | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Interface ResourceSet

+
+

A set containing resources.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
hasResource: ((identifier) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<boolean>
    • +
    • +

      Check if 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..fa80383e2 --- /dev/null +++ b/7.x/docs/interfaces/ResourceStore.html @@ -0,0 +1,311 @@ +ResourceStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

      Check if 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..24131cc74 --- /dev/null +++ b/7.x/docs/interfaces/ResourcesGenerator.html @@ -0,0 +1,120 @@ +ResourcesGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7d3d400d0 --- /dev/null +++ b/7.x/docs/interfaces/RouterHandlerArgs.html @@ -0,0 +1,136 @@ +RouterHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..83a71f7a4 --- /dev/null +++ b/7.x/docs/interfaces/SeededAccountInitializerArgs.html @@ -0,0 +1,118 @@ +SeededAccountInitializerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7519b8fb1 --- /dev/null +++ b/7.x/docs/interfaces/SetMultiMap.html @@ -0,0 +1,474 @@ +SetMultiMap | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

      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..bfc54fc4c --- /dev/null +++ b/7.x/docs/interfaces/SimpleLogger.html @@ -0,0 +1,123 @@ +SimpleLogger | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..9f4cf29c5 --- /dev/null +++ b/7.x/docs/interfaces/SingleThreaded.html @@ -0,0 +1,75 @@ +SingleThreaded | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..a7c1d356c --- /dev/null +++ b/7.x/docs/interfaces/Size.html @@ -0,0 +1,96 @@ +Size | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..25b6b9dd5 --- /dev/null +++ b/7.x/docs/interfaces/SizeReporter.html @@ -0,0 +1,196 @@ +SizeReporter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..63be698b9 --- /dev/null +++ b/7.x/docs/interfaces/SliceStreamOptions.html @@ -0,0 +1,432 @@ +SliceStreamOptions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2970d3699 --- /dev/null +++ b/7.x/docs/interfaces/SparqlUpdatePatch.html @@ -0,0 +1,141 @@ +SparqlUpdatePatch | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1410f3a9f --- /dev/null +++ b/7.x/docs/interfaces/StorageLocationStrategy.html @@ -0,0 +1,111 @@ +StorageLocationStrategy | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..758ee28c6 --- /dev/null +++ b/7.x/docs/interfaces/SubfolderResourcesGeneratorArgs.html @@ -0,0 +1,133 @@ +SubfolderResourcesGeneratorArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

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..8e7f3b955 --- /dev/null +++ b/7.x/docs/interfaces/SubscriptionService.html @@ -0,0 +1,111 @@ +SubscriptionService | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..44058dadf --- /dev/null +++ b/7.x/docs/interfaces/SystemError.html @@ -0,0 +1,192 @@ +SystemError | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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?: any
+

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..4e446603d --- /dev/null +++ b/7.x/docs/interfaces/TemplateEngineInput.html @@ -0,0 +1,101 @@ +TemplateEngineInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5b7d53717 --- /dev/null +++ b/7.x/docs/interfaces/TemplateOptions.html @@ -0,0 +1,106 @@ +TemplateOptions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5bb1ef0e0 --- /dev/null +++ b/7.x/docs/interfaces/TemplatePath.html @@ -0,0 +1,92 @@ +TemplatePath | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..26a989fc0 --- /dev/null +++ b/7.x/docs/interfaces/TemplateString.html @@ -0,0 +1,85 @@ +TemplateString | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..dc324e19f --- /dev/null +++ b/7.x/docs/interfaces/TemplatedResourcesGenerator.html @@ -0,0 +1,127 @@ +TemplatedResourcesGenerator | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..66debac3e --- /dev/null +++ b/7.x/docs/interfaces/V6MigrationInitializerArgs.html @@ -0,0 +1,158 @@ +V6MigrationInitializerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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

The storage that will contain the account data in the new format.

+
+
+
+ +
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..dd85d3bdd --- /dev/null +++ b/7.x/docs/interfaces/WacAllowHttpHandlerArgs.html @@ -0,0 +1,106 @@ +WacAllowHttpHandlerArgs | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ca58a59dd --- /dev/null +++ b/7.x/docs/interfaces/WebIdStore.html @@ -0,0 +1,221 @@ +WebIdStore | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..29132be53 --- /dev/null +++ b/7.x/docs/interfaces/WebSocket2023HandlerInput.html @@ -0,0 +1,92 @@ +WebSocket2023HandlerInput | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..2ded75ed5 --- /dev/null +++ b/7.x/docs/interfaces/WebSocketChannel2023.html @@ -0,0 +1,217 @@ +WebSocketChannel2023 | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8892c0eb7 --- /dev/null +++ b/7.x/docs/interfaces/WebSocketHandlerInput.html @@ -0,0 +1,92 @@ +WebSocketHandlerInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3be360300 --- /dev/null +++ b/7.x/docs/interfaces/WebhookChannel2023.html @@ -0,0 +1,217 @@ +WebhookChannel2023 | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..fd849ae08 --- /dev/null +++ b/7.x/docs/modules.html @@ -0,0 +1,884 @@ +Community Solid Server - v7.0.3
+
+ +
+
+
+
+

Community Solid Server - v7.0.3

+
+
+

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..89d04ff55 --- /dev/null +++ b/7.x/docs/types/AccessMap.html @@ -0,0 +1,64 @@ +AccessMap | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..1fe851316 --- /dev/null +++ b/7.x/docs/types/AccountIdKey.html @@ -0,0 +1,61 @@ +AccountIdKey | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..1d6025550 --- /dev/null +++ b/7.x/docs/types/AccountIdRoute.html @@ -0,0 +1,64 @@ +AccountIdRoute | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..960ff72bb --- /dev/null +++ b/7.x/docs/types/AccountInteractionResults.html @@ -0,0 +1,69 @@ +AccountInteractionResults | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..84f769e7a --- /dev/null +++ b/7.x/docs/types/AccountLoginStorage.html @@ -0,0 +1,70 @@ +AccountLoginStorage | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..cbba7aae0 --- /dev/null +++ b/7.x/docs/types/AccountSettings.html @@ -0,0 +1,66 @@ +AccountSettings | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e5f9c0ee1 --- /dev/null +++ b/7.x/docs/types/AclPermissionSet.html @@ -0,0 +1,61 @@ +AclPermissionSet | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..edd645629 --- /dev/null +++ b/7.x/docs/types/ActivityEmitter.html @@ -0,0 +1,65 @@ +ActivityEmitter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..83261460b --- /dev/null +++ b/7.x/docs/types/ArrayElement.html @@ -0,0 +1,66 @@ +ArrayElement | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Type alias ArrayElement<TArray>

+
ArrayElement<TArray>: TArray[number]
+
+

Type Parameters

+
    +
  • +

    TArray extends readonly any[]

+
+
\ 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..b228dc903 --- /dev/null +++ b/7.x/docs/types/AsyncHandlerInput.html @@ -0,0 +1,66 @@ +AsyncHandlerInput | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..c2a5a478d --- /dev/null +++ b/7.x/docs/types/AsyncHandlerOutput.html @@ -0,0 +1,66 @@ +AsyncHandlerOutput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2e849d558 --- /dev/null +++ b/7.x/docs/types/ChangeMap.html @@ -0,0 +1,66 @@ +ChangeMap | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6cb925178 --- /dev/null +++ b/7.x/docs/types/ClientCredentialsIdRoute.html @@ -0,0 +1,64 @@ +ClientCredentialsIdRoute | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..f401455e3 --- /dev/null +++ b/7.x/docs/types/CreateTypeObject.html @@ -0,0 +1,70 @@ +CreateTypeObject | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..93ee75bd3 --- /dev/null +++ b/7.x/docs/types/Credentials.html @@ -0,0 +1,84 @@ +Credentials | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..5c8f2e970 --- /dev/null +++ b/7.x/docs/types/CredentialsIdKey.html @@ -0,0 +1,61 @@ +CredentialsIdKey | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..db7bf623a --- /dev/null +++ b/7.x/docs/types/EmptyMapConstructor.html @@ -0,0 +1,72 @@ +EmptyMapConstructor | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Type alias EmptyMapConstructor

+
EmptyMapConstructor: (new () => Map<any, any>)
+
+

Type declaration

+
    +
  • +
      +
    • new (): Map<any, any>
    • +
    • +

      A simplified version of MapConstructor that only allows creating an empty Map.

      +
      +

      Returns Map<any, any>

      +
+
+
\ 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..b8867a436 --- /dev/null +++ b/7.x/docs/types/EmptyObject.html @@ -0,0 +1,61 @@ +EmptyObject | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..84cb0d4e5 --- /dev/null +++ b/7.x/docs/types/Expires.html @@ -0,0 +1,73 @@ +Expires | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b15a59db7 --- /dev/null +++ b/7.x/docs/types/ExtendedRoute.html @@ -0,0 +1,71 @@ +ExtendedRoute | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..43f6d96e8 --- /dev/null +++ b/7.x/docs/types/Guarded.html @@ -0,0 +1,71 @@ +Guarded | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b6c8c2b96 --- /dev/null +++ b/7.x/docs/types/HttpRequest.html @@ -0,0 +1,64 @@ +HttpRequest | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..fe29dc615 --- /dev/null +++ b/7.x/docs/types/HttpResponse.html @@ -0,0 +1,64 @@ +HttpResponse | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..ce59a4a0c --- /dev/null +++ b/7.x/docs/types/IndexRelation.html @@ -0,0 +1,86 @@ +IndexRelation | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..eaf724dfb --- /dev/null +++ b/7.x/docs/types/IndexTypeCollection.html @@ -0,0 +1,69 @@ +IndexTypeCollection | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..70871ed3e --- /dev/null +++ b/7.x/docs/types/IndexTypeDescription.html @@ -0,0 +1,69 @@ +IndexTypeDescription | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..37638160a --- /dev/null +++ b/7.x/docs/types/IndexedQuery.html @@ -0,0 +1,83 @@ +IndexedQuery | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2566f7767 --- /dev/null +++ b/7.x/docs/types/Interaction.html @@ -0,0 +1,61 @@ +Interaction | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..cddf92829 --- /dev/null +++ b/7.x/docs/types/Json.html @@ -0,0 +1,64 @@ +Json | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..aa53bfaab --- /dev/null +++ b/7.x/docs/types/LogLevel.html @@ -0,0 +1,64 @@ +LogLevel | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..be0ced3e6 --- /dev/null +++ b/7.x/docs/types/LoginOutputType.html @@ -0,0 +1,78 @@ +LoginOutputType | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..289b21b4f --- /dev/null +++ b/7.x/docs/types/MapEntry.html @@ -0,0 +1,66 @@ +MapEntry | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Type alias MapEntry<T>

+
MapEntry<T>: T extends Map<any, any>
    ? [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..c92e78f03 --- /dev/null +++ b/7.x/docs/types/MapKey.html @@ -0,0 +1,66 @@ +MapKey | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Type alias MapKey<T>

+
MapKey<T>: T extends Map<infer TKey, any>
    ? 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..0690f4d58 --- /dev/null +++ b/7.x/docs/types/MapValue.html @@ -0,0 +1,66 @@ +MapValue | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Type alias MapValue<T>

+
MapValue<T>: T extends Map<any, 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..795bc2657 --- /dev/null +++ b/7.x/docs/types/MetadataGraph.html @@ -0,0 +1,61 @@ +MetadataGraph | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..73308b600 --- /dev/null +++ b/7.x/docs/types/MetadataIdentifier.html @@ -0,0 +1,61 @@ +MetadataIdentifier | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..e2317a099 --- /dev/null +++ b/7.x/docs/types/MetadataRecord.html @@ -0,0 +1,61 @@ +MetadataRecord | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..e09b51633 --- /dev/null +++ b/7.x/docs/types/MetadataValue.html @@ -0,0 +1,61 @@ +MetadataValue | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..2ea50bf74 --- /dev/null +++ b/7.x/docs/types/ModifyOptions.html @@ -0,0 +1,82 @@ +ModifyOptions | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..58e35c362 --- /dev/null +++ b/7.x/docs/types/OptionalKey.html @@ -0,0 +1,69 @@ +OptionalKey | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7be7b30b0 --- /dev/null +++ b/7.x/docs/types/PartialVocabulary.html @@ -0,0 +1,80 @@ +PartialVocabulary | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..560f11be6 --- /dev/null +++ b/7.x/docs/types/PasswordIdKey.html @@ -0,0 +1,61 @@ +PasswordIdKey | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..ee7abdded --- /dev/null +++ b/7.x/docs/types/PasswordIdRoute.html @@ -0,0 +1,64 @@ +PasswordIdRoute | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..20d0b27c5 --- /dev/null +++ b/7.x/docs/types/PatchHandlerInput.html @@ -0,0 +1,75 @@ +PatchHandlerInput | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..85f2b29a5 --- /dev/null +++ b/7.x/docs/types/PermissionMap.html @@ -0,0 +1,64 @@ +PermissionMap | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..9ed94e831 --- /dev/null +++ b/7.x/docs/types/PermissionSet.html @@ -0,0 +1,64 @@ +PermissionSet | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..6277a88de --- /dev/null +++ b/7.x/docs/types/PodIdKey.html @@ -0,0 +1,61 @@ +PodIdKey | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..911bb3d88 --- /dev/null +++ b/7.x/docs/types/PodIdRoute.html @@ -0,0 +1,64 @@ +PodIdRoute | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..32a58e7f4 --- /dev/null +++ b/7.x/docs/types/PromiseOrValue.html @@ -0,0 +1,66 @@ +PromiseOrValue | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..a6ad016c4 --- /dev/null +++ b/7.x/docs/types/RouteParameter.html @@ -0,0 +1,69 @@ +RouteParameter | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..90390d6a7 --- /dev/null +++ b/7.x/docs/types/StringKey.html @@ -0,0 +1,69 @@ +StringKey | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..3fe6c64a4 --- /dev/null +++ b/7.x/docs/types/Template.html @@ -0,0 +1,61 @@ +Template | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..9a8598ea4 --- /dev/null +++ b/7.x/docs/types/TemplateFileName.html @@ -0,0 +1,61 @@ +TemplateFileName | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..e3682dc17 --- /dev/null +++ b/7.x/docs/types/TypeObject.html @@ -0,0 +1,75 @@ +TypeObject | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f38436e8e --- /dev/null +++ b/7.x/docs/types/ValidatorInput.html @@ -0,0 +1,68 @@ +ValidatorInput | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..244d485b2 --- /dev/null +++ b/7.x/docs/types/ValuePreference.html @@ -0,0 +1,72 @@ +ValuePreference | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..2a0cb9d6b --- /dev/null +++ b/7.x/docs/types/ValuePreferences.html @@ -0,0 +1,76 @@ +ValuePreferences | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..dabfe1222 --- /dev/null +++ b/7.x/docs/types/ValueType.html @@ -0,0 +1,69 @@ +ValueType | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f9ba7b73d --- /dev/null +++ b/7.x/docs/types/ValueTypeDescription.html @@ -0,0 +1,73 @@ +ValueTypeDescription | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b19d7eff8 --- /dev/null +++ b/7.x/docs/types/VirtualKey.html @@ -0,0 +1,69 @@ +VirtualKey | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..797301f8e --- /dev/null +++ b/7.x/docs/types/VirtualObject.html @@ -0,0 +1,71 @@ +VirtualObject | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..94e502e6b --- /dev/null +++ b/7.x/docs/types/Vocabulary.html @@ -0,0 +1,77 @@ +Vocabulary | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c57878988 --- /dev/null +++ b/7.x/docs/types/VocabularyLocal.html @@ -0,0 +1,69 @@ +VocabularyLocal | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Type alias VocabularyLocal<T>

+
VocabularyLocal<T>: T extends Vocabulary<any, 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..1f45adb1a --- /dev/null +++ b/7.x/docs/types/VocabularyTerm.html @@ -0,0 +1,69 @@ +VocabularyTerm | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Type alias VocabularyTerm<T>

+
VocabularyTerm<T>: T extends Vocabulary<any, 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..ef2eb6527 --- /dev/null +++ b/7.x/docs/types/VocabularyValue.html @@ -0,0 +1,69 @@ +VocabularyValue | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

Type alias VocabularyValue<T>

+
VocabularyValue<T>: T extends Vocabulary<any, 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..288b2f92d --- /dev/null +++ b/7.x/docs/types/WebIdLinkKey.html @@ -0,0 +1,61 @@ +WebIdLinkKey | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..5e87cf278 --- /dev/null +++ b/7.x/docs/types/WebIdLinkRoute.html @@ -0,0 +1,64 @@ +WebIdLinkRoute | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..b09e49e61 --- /dev/null +++ b/7.x/docs/types/YargsOptions.html @@ -0,0 +1,61 @@ +YargsOptions | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..9e9b8b133 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_ID_KEY.html @@ -0,0 +1,61 @@ +ACCOUNT_ID_KEY | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..358ec7654 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_PROMPT.html @@ -0,0 +1,66 @@ +ACCOUNT_PROMPT | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ed68e532c --- /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.3
+
+ +
+
+
+
+ +

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..748181708 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_STORAGE_DESCRIPTION.html @@ -0,0 +1,66 @@ +ACCOUNT_STORAGE_DESCRIPTION | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..04aea437f --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_TYPE.html @@ -0,0 +1,61 @@ +ACCOUNT_TYPE | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..4023fc119 --- /dev/null +++ b/7.x/docs/variables/ACL.html @@ -0,0 +1,61 @@ +ACL | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..ee81d7a45 --- /dev/null +++ b/7.x/docs/variables/ACP.html @@ -0,0 +1,61 @@ +ACP | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..fb141e980 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_JSON.html @@ -0,0 +1,61 @@ +APPLICATION_JSON | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..e302cdd89 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_LD_JSON.html @@ -0,0 +1,61 @@ +APPLICATION_LD_JSON | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..a421ce20e --- /dev/null +++ b/7.x/docs/variables/APPLICATION_OCTET_STREAM.html @@ -0,0 +1,61 @@ +APPLICATION_OCTET_STREAM | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c1d1da181 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_SPARQL_UPDATE.html @@ -0,0 +1,61 @@ +APPLICATION_SPARQL_UPDATE | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1b9bab6d5 --- /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.3
+
+ +
+
+
+
+ +

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..9f0ca09fc --- /dev/null +++ b/7.x/docs/variables/AS.html @@ -0,0 +1,61 @@ +AS | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..8fe6a592a --- /dev/null +++ b/7.x/docs/variables/AUTH.html @@ -0,0 +1,61 @@ +AUTH | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..d58a4378e --- /dev/null +++ b/7.x/docs/variables/BaseActivityEmitter.html @@ -0,0 +1,72 @@ +BaseActivityEmitter | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..7dcc91744 --- /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.3
+
+ +
+
+
+
+ +

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..e2d8ace3e --- /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.3
+
+ +
+ +
\ 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..78c6dd279 --- /dev/null +++ b/7.x/docs/variables/CONTENT_LENGTH.html @@ -0,0 +1,61 @@ +CONTENT_LENGTH | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..97c758523 --- /dev/null +++ b/7.x/docs/variables/CONTENT_LENGTH_TERM.html @@ -0,0 +1,61 @@ +CONTENT_LENGTH_TERM | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b16684495 --- /dev/null +++ b/7.x/docs/variables/CONTENT_TYPE.html @@ -0,0 +1,61 @@ +CONTENT_TYPE | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..d78822034 --- /dev/null +++ b/7.x/docs/variables/CONTENT_TYPE_TERM.html @@ -0,0 +1,61 @@ +CONTENT_TYPE_TERM | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f63e71502 --- /dev/null +++ b/7.x/docs/variables/DC.html @@ -0,0 +1,61 @@ +DC | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..7e2b2f2cb --- /dev/null +++ b/7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html @@ -0,0 +1,70 @@ +DEFAULT_CUSTOM_TYPES | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..69456f21f --- /dev/null +++ b/7.x/docs/variables/DEFAULT_NOTIFICATION_FEATURES.html @@ -0,0 +1,64 @@ +DEFAULT_NOTIFICATION_FEATURES | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..e437eecaf --- /dev/null +++ b/7.x/docs/variables/DEFAULT_SUBSCRIPTION_SHACL.html @@ -0,0 +1,77 @@ +DEFAULT_SUBSCRIPTION_SHACL | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..77bad90b7 --- /dev/null +++ b/7.x/docs/variables/FOAF.html @@ -0,0 +1,61 @@ +FOAF | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..1ec7699cf --- /dev/null +++ b/7.x/docs/variables/HH.html @@ -0,0 +1,61 @@ +HH | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..a692bf44b --- /dev/null +++ b/7.x/docs/variables/HTTP.html @@ -0,0 +1,61 @@ +HTTP | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..84c9e561b --- /dev/null +++ b/7.x/docs/variables/IANA.html @@ -0,0 +1,61 @@ +IANA | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..7dbed2439 --- /dev/null +++ b/7.x/docs/variables/INDEX_ID_KEY.html @@ -0,0 +1,64 @@ +INDEX_ID_KEY | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..6fd7111e8 --- /dev/null +++ b/7.x/docs/variables/INTERNAL_ALL.html @@ -0,0 +1,61 @@ +INTERNAL_ALL | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..604f392e0 --- /dev/null +++ b/7.x/docs/variables/INTERNAL_ERROR.html @@ -0,0 +1,61 @@ +INTERNAL_ERROR | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..abbc4beeb --- /dev/null +++ b/7.x/docs/variables/INTERNAL_QUADS.html @@ -0,0 +1,61 @@ +INTERNAL_QUADS | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..1220ade00 --- /dev/null +++ b/7.x/docs/variables/JSON_LD.html @@ -0,0 +1,61 @@ +JSON_LD | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..f1e33631d --- /dev/null +++ b/7.x/docs/variables/LDP.html @@ -0,0 +1,61 @@ +LDP | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..4acb6c208 --- /dev/null +++ b/7.x/docs/variables/LOG_LEVELS.html @@ -0,0 +1,61 @@ +LOG_LEVELS | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..3750b27a9 --- /dev/null +++ b/7.x/docs/variables/MA.html @@ -0,0 +1,61 @@ +MA | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..a84eda447 --- /dev/null +++ b/7.x/docs/variables/NOTIFY.html @@ -0,0 +1,61 @@ +NOTIFY | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..1f395924c --- /dev/null +++ b/7.x/docs/variables/OIDC.html @@ -0,0 +1,61 @@ +OIDC | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..37a761917 --- /dev/null +++ b/7.x/docs/variables/OWNER_STORAGE_DESCRIPTION.html @@ -0,0 +1,70 @@ +OWNER_STORAGE_DESCRIPTION | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c082698e1 --- /dev/null +++ b/7.x/docs/variables/OWNER_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +OWNER_STORAGE_TYPE | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..e2a2daa26 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_METHOD.html @@ -0,0 +1,64 @@ +PASSWORD_METHOD | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7879838dc --- /dev/null +++ b/7.x/docs/variables/PASSWORD_STORAGE_DESCRIPTION.html @@ -0,0 +1,72 @@ +PASSWORD_STORAGE_DESCRIPTION | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..7fe2b55d0 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +PASSWORD_STORAGE_TYPE | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..2a889dee8 --- /dev/null +++ b/7.x/docs/variables/PIM.html @@ -0,0 +1,61 @@ +PIM | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..e071b6756 --- /dev/null +++ b/7.x/docs/variables/POD_STORAGE_DESCRIPTION.html @@ -0,0 +1,68 @@ +POD_STORAGE_DESCRIPTION | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..72510fd8e --- /dev/null +++ b/7.x/docs/variables/POD_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +POD_STORAGE_TYPE | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..a657fc042 --- /dev/null +++ b/7.x/docs/variables/POSIX.html @@ -0,0 +1,61 @@ +POSIX | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..c35802b23 --- /dev/null +++ b/7.x/docs/variables/PREFERRED_PREFIX.html @@ -0,0 +1,61 @@ +PREFERRED_PREFIX | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..34602c05a --- /dev/null +++ b/7.x/docs/variables/PREFERRED_PREFIX_TERM.html @@ -0,0 +1,61 @@ +PREFERRED_PREFIX_TERM | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..b3526c69a --- /dev/null +++ b/7.x/docs/variables/RDF.html @@ -0,0 +1,61 @@ +RDF | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..1640f8e70 --- /dev/null +++ b/7.x/docs/variables/RDFS.html @@ -0,0 +1,61 @@ +RDFS | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..4c67cd4fc --- /dev/null +++ b/7.x/docs/variables/SOLID.html @@ -0,0 +1,61 @@ +SOLID | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..cf1335fc5 --- /dev/null +++ b/7.x/docs/variables/SOLID_AS.html @@ -0,0 +1,61 @@ +SOLID_AS | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..562e73b7c --- /dev/null +++ b/7.x/docs/variables/SOLID_ERROR.html @@ -0,0 +1,61 @@ +SOLID_ERROR | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..eaf1dff75 --- /dev/null +++ b/7.x/docs/variables/SOLID_ERROR_TERM.html @@ -0,0 +1,61 @@ +SOLID_ERROR_TERM | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..04b4f3622 --- /dev/null +++ b/7.x/docs/variables/SOLID_HTTP.html @@ -0,0 +1,61 @@ +SOLID_HTTP | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..c804e45bd --- /dev/null +++ b/7.x/docs/variables/SOLID_META.html @@ -0,0 +1,61 @@ +SOLID_META | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..d98d51b36 --- /dev/null +++ b/7.x/docs/variables/TEMPLATE-1.html @@ -0,0 +1,61 @@ +TEMPLATE | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..9d9474370 --- /dev/null +++ b/7.x/docs/variables/TEMPLATE_VARIABLE.html @@ -0,0 +1,61 @@ +TEMPLATE_VARIABLE | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..87fafc8f9 --- /dev/null +++ b/7.x/docs/variables/TEXT_HTML.html @@ -0,0 +1,61 @@ +TEXT_HTML | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..ca4d467f5 --- /dev/null +++ b/7.x/docs/variables/TEXT_MARKDOWN.html @@ -0,0 +1,61 @@ +TEXT_MARKDOWN | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..c47e73e7b --- /dev/null +++ b/7.x/docs/variables/TEXT_N3.html @@ -0,0 +1,61 @@ +TEXT_N3 | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..bcc377f33 --- /dev/null +++ b/7.x/docs/variables/TEXT_TURTLE.html @@ -0,0 +1,61 @@ +TEXT_TURTLE | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..8ac137f12 --- /dev/null +++ b/7.x/docs/variables/UNIT_BYTES.html @@ -0,0 +1,61 @@ +UNIT_BYTES | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..166e7f164 --- /dev/null +++ b/7.x/docs/variables/URL_SCHEMA.html @@ -0,0 +1,61 @@ +URL_SCHEMA | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..ebf9c4f49 --- /dev/null +++ b/7.x/docs/variables/VANN.html @@ -0,0 +1,61 @@ +VANN | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..071115ecd --- /dev/null +++ b/7.x/docs/variables/VCARD.html @@ -0,0 +1,61 @@ +VCARD | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..2c834ea50 --- /dev/null +++ b/7.x/docs/variables/WEBID_STORAGE_DESCRIPTION.html @@ -0,0 +1,68 @@ +WEBID_STORAGE_DESCRIPTION | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..9987949ae --- /dev/null +++ b/7.x/docs/variables/WEBID_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +WEBID_STORAGE_TYPE | Community Solid Server - v7.0.3
+
+ +
+ +
\ 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..511208234 --- /dev/null +++ b/7.x/docs/variables/XSD.html @@ -0,0 +1,61 @@ +XSD | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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..f3f491cf4 --- /dev/null +++ b/7.x/docs/variables/modulePathPlaceholder.html @@ -0,0 +1,65 @@ +modulePathPlaceholder | Community Solid Server - v7.0.3
+
+ +
+
+
+
+ +

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