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..9d6c0eca3 --- /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/PkLljbNwLdYzyID0UQVGOIRz0InfUcQy+HgIRV5o2CZoKyTH5WAp0mMHUiD7OQHVzAw1asTbSsGmlG1JJs60llawgdvttC3XX3tXPi+E4iBgB2MRewUBWgMYFvkzl53B1uOITuSXEq13Cy/ljL1lAm2VwKlIl7Olf3B4BEUY8DGmESEQyE/HBScHR45SZZb/hcr84QjYaChaVx6m+5uGaoINwITGRywmZX7eTavYrdegRgg3FT+XLwhIPEB+x5R1xB3sJtLTWo1Oj6zwe2JZFH8gmuAUfb1a5UwNFLGv/BjKDpKuza0hu6l5iwvRwkjT/P3Nf2+U2jqP7XzZfszUWSb3db7l5mc5O0skklZndM2dPjrusJN522TW2K93Z++evRMpVIgSAgCxv75fulAkSj/gCkA9BcraJDVaueD4Dgadd7dslQgQyMOJ8UvtB49J2ZRSXcMtSgYR39HjliPy7UD/j1lHlAm+u0kwOUUb7aGRO7wW9yC03H6R6wjjv+b20GIydTbPcPtKnj730y/32xq99/wRFWNtQRCFTj8Q2Um6Urig0ZGhWPGpcUKGm2z1BWOlIQyyjKDyY7e6pjevlvv0bLx5KSRU8hMmt1ku+lgjJKYqino1r6ESkRa8PrzuCcLvcDPoyUj4qJ1Vy9/jJ17t2+brefkVUIFI8kQ797+/H08HON7vlivLAUGo+H4yWLPfCI/icH/4d2/tiQZzyiO0agyeyvJs2VYOll59YE4NGf/Gj/cf65t8O7cAVMEy8+CzdQKBC1B8SXzaNtZGAm8TbiNEKJ0uiWkw/Cz4JFTGFkkBKzKYm1tKpt1DTblWX083BpyHudozR6ZcE6SDz5RAyk1V5O6tWlPLxPDBvL/f7XbsE7TLRRg0TmsWUkQWLDBiKXTfkaACJgabR3TzKKgDEuSQdNYFJSoPRkOagvzQgOdqLRjkL3aVp3wQ3QCOdSG9psNEOkBl76vsv9CMRNYyp0agyh6mONjaCf71fMjHBmNCcRnBcsMYIxtgnGUEEgMwIUrqVBgfRP6PBEYEUGBwE5ZwGR9SOMoODID3P4IiwJQ0O1s+nGhxFr+cMDtnzpxgcEtMg/u80O2PC/oCI5nzwenvKHMUMJQp/gmTEhz1ET1IIq+YkelAhwXKeBaUZPaWbgtCgz+dOqoUx45X+fjxiQKh+7NnSvAUlOKeHO4OrIL9jGkvBA5rET2gRksNUhpEdrPOhpMewtG25kTwfzvEAl+HDh/mc9UdHDiVHhTJqSIBNMRucxj9p6yc9K7xgJIYWrGB2eMkIDG37ymaJ80ZeaDEmZ4sqZnZOZOlZ43zMnaQjDt+73+1vU5QdIjOLK6fKlT1tjwDXGSdSfcIu8ZqlJonUPoc1UkDkDBGJcRYbpGjBhPkhcU60PApkzNPwZO/Wvwmv7euoqUn0d5WVSXSwgYF5u9z/utr9tr3e/dTqoo0MITeLoeHKFhkb6iOmrRhYOJMWDGl8EoPI4koYRWUNMYaRRTGHcVRC5Qwki3UWI6ls2YShZPFONJZKhLTB5Eep2mhOGhOo4RSMC5XxFHRA/N1b2npiQrOYTrJg0m5yX45+i85I0YASFkqjW/R+69k9VF8baPdM1YiqbyYwDTtmR05f7z6svtDdciwyS6ckihW5cgQ1a/ixOMkUDiynxI2z2CSDgwKUGBryOmH8NqV7DpetbTQdwlkctbztEj6aQjnRPctx0UaPHG9qk6ft4ajB43u5ytzxHWtg7FqR1Kb+WGQWY0cUKzJ2COrEVRpEIDIFYpRNYuZYVBIzR6FJmDl5bTBmjtI9h5mTA+TMHIVwFjMnb7uEmaNQTjRzcly0mSNHmtrMaXs4aub4Xq4yczyeQTABcffhs/1XNLCAEZcHGazHT1UqVDxZ449VRp/PfBUBah9lmQRsVMRs4O6QOakG2R0xM50Aa+gihff/XvLa30m3/bIjZ65rXyfc9jojLsqRznjX63xXvM59s6vuQlfVXdYXv8d6+h3WXI1c4Nbl2W5cnve25ak3Lc9de8QAnP3G5ZlvW77ITcsTblnuLmcu3MvtzW613n792Pb15dcxWlRqlmFIlyy+Q34Mn2iO4+7n5re/NOM7lxgQgzz0xP4MRO/266/r7XKjhhVnnAdb/CgD/ighA4p+i1C2BFJV3fAMtwBbEJcNIxWOb0v8onwCRxC/AI6Drj4Ol6qPFf4yOANlRT4Lfj6aNst+jThVBs5jlnnwoPfgdVGWlLHFhGY7mo4WrLvvboidsB2/tHWCBqLSEAZZZMYsgUfUDWg4WC+Yqp30O7R6tdvR4eG8DgdqitPR9BvC59CQznU5mmrDPA6NTONwNCgwf0Oj0LgbDQrM2zCtdKG6IHwNDUTpalJYhk+g/X633iMz6OE7UrEIa9LJyk6UN6rq4edAjMQg/KpQp+nltHrxS1wEBMH7WyBnh5v4/OEAS+nWDK8LfX4L4fT5hfjzO9zUflU8plLqlSPqQpUQUCQf5ANZe+zUaRUwZ0hh0M4bL1QVPQzBG30g9wk/PnP9aXn4lmIJEJlZ5q1UuaJpKwacaHHiZSZSvfJxJh6JbMZIYlFPGFVouPkiA2nKdFHRXsRskQR07mRRUWXYXJHEpXGiCgzYTJHEoPFkCgzYPJFun8vUAzFLJGEoXZoCCbUMJaFofQqPxT6a29c/v3j5759fv/j8l5f/8QDn+3K/7h7+OPxpmJyYp9Zllj+W+7fl5t4/9veiOdzs13fRHm/nkA5/wkSm6aAKVpUWjmbHpi2UN0hRldhBePfLf7X2BBT4mKAq7/m+WR4bslSYrCo7XK44/vaH31Wlvd6umt/51sdEpul4vttsmhtOxaOEXkOz+ut9s4fVMkziyxwsDftMzMowlpAvDFfNl3Z1St1agJT6JMqBT5gAXGpj0Pc6LyvVHWc5X7lO75kqiVUhpg+6Ur0yYgWOKYNzB72y7qI9qbZe9lx1r1fiynwUP0cpwaBgCjkCRazs1brZiCt1IH+OWnrhjhuC0SRHr5JZImM6U5w6qXS4EO2ORr5abxpqEQrSZ1mAYmWKFp8QLLGQIV8OQxUr3w0TYtjsbn5FFr8oggfZmfW/HgcsJnG8xqMUp+BJruBQEJwFFurCVmqoLs61CHVhKzJUF2cIhbqIlReqLmGQhBqpFRaqMmWP5D2lk+widTZjeoTqM1GWGftteBZZCwjJNe9YQu9V5ermfOsCnMbpRSjOcQCZ2ZwHVq7YgUDgOvaSVK9kLxVICF6ORCLg5SYiGT+qK2kV5DHd6XhETgVFknIsQp2Uc0F1phyMUCflZPDmn+c7GWeDqhU4HKFmzumgqiWOR96jTpIvtTDQvLP3+YN3KH9+1KXoGUjW2fH92vy43iVmnii6ccbZsT0ewbneYXsvJLZxxlmwDVittlRPuDK0FhCRH1wi+A+sPNZKQoz6LVZKZTriAObURxygujkDfaHPFUUYjHLSEQYEGYPq5nzDhT738Ni6lfhzD3Tr0rwMqj7hli700bIACph1cgAFiiHlFS/06eKACZibD5h4u/y9zfCm2X6lI30RmVmWHFS5wiu5xsB1Sw5SvXLJoUBCzCxIJMrphALJ7UBUjgfkmh1Va46/ddemrH+XY4ryzIEouSzhoEzsr8nlF6mTm1godGJLIbpbzqOTWAqRahM+R6GZWgqRqlNGX6H7t/3y7v3yB/oIHak/zjR7L287USv69/Xx2/Nvzc2vqt4HMl4ImxbSXNZp6Cqb293+x9vlHekngcA8ThIrVOYhIV5q5rc8LoVqe1EJ48loTxs7VDlr6YTaUHOOamNtuVAbalRRbaxFFWqjzCnekglbKtRJGlJUadKKMj0WvxGRWt6fcNCiswzORPGps/moQWK+TjerTIFTTi5FuJJDOwWKG+R6BNhwTyHgBr4eAWYCkg0zax0QZiEFImEg9DgoU5ECkjIaeiRk2HoKijp6fQo2Log9DXBKLLsQZRx+6M9lDJozRB72v7LGlaVBxsU8kRyXaZjnmlI4ewVXj5KsohP7ROi7A1N7Wt8dMp+X6Rv4wr+3C4O7ZkWd6zt1HFxsFh/IFC2aphJfoONyOBBKOkeHh/C9HB7O746m0To0x/WtsnJOOWbBkvT+HBLO8+s0Y16f08x5fJ1mzNuzXWG2bya8PKc84eF1+invzgFIeXYdgn27ePjeBKO5ojaZOThEARcZGZ+2wduMKaDEEBlmnB/Z+vByAqxhrvkxHXdwqiGya4Ncl8D0AiNNeEAv5ORJEg07h5LDuQr/+9cstaVGFBWVIp2BTYeXnKJJYCrnb2egTU3wpqEdnTNb74/32MGwxwTdubWQDT3EFaWdO8kfF5aa6sfQiAZcw7k3qedqTbdNnCnZCP5MwIdms6QOep3Szq20cWGpSouhkb3eSwt1XT2IC1SOK++cz+xVp7fBMQwn3EQl/DoaQmIYV23ef82mgEmYo3Pq5sr/7xKobr6tN3CY0bBO0v/zncVrPtWHsiIC6hm6Sgzi6lfAzMiAzNlNACC59UghGvMSxKFS4FQVB0uVrAR60FJOStBHveScBAZhGiUhQ/Od2w9hMIF8immqDNe6k5qAC+S7DC56ekpC0i4txK23Xr3ojj+vo6mErAFB1tnR7Xc7f3vz35aq7h5nmx9Vb55UbTjMNAei1Il3ASTBqXcVCuzwu8Q+Cg7Aq3AwfJz2YLpKL8NAas+oT6h3fZXPo53hILUHybV64/PkMuX8mXLlqOM40AnHy1Xa4Y0BAvWpWwPU+rXK59Gc4H6nnLFX6T/ukFtnBCBAvnnmYqYwmRt7zCnucj5M8ChWq0BpGfssl8HTXRNwvdNWE8x4OWwfmpvdXje0Rzkvg+55txILPVgLD2S9EL5wTHW9/RpqQotxnP0COMOpch/3oMEXZ7tg+36YMr/FMl9qhHQZR+SndJCAzBfA6BdGbVOdsayCuS+A0k8GgmRnbPUTiTjvBRAedpvvTXzfmGSON8x1mR7oBbF4Kb7vDbJdzKq8aJq7zj+pV2F49ovhPAPj/wi+tpkmwhvknIltA+8Sdfd6PJ6vfttlxh8QwgRnITvZwsUPFKHfoaM8eSBK1lOLqXua40Pzz/vmcPz04bUS2yjzZTB2U/tO/g67RotHCLJeBt/99tft7rft22a1Xnbj+uXvx2Z7wDwmD5Yr5zLIb5vjsjue8vH+C3Z8kIc7yixhBAUII0N2u7z7tN9c715R16glMI6zTx7LKK7oGYmJ4GAZs7U1ivhF//r0GYBBEZfB269kWuFuLLza725b3UrAVBkXq+FTP7ve6cEi2efpq49rwmY/uQ4HuS/W3qd+NQlknPl/qk9OGEVkIRfD/OyXdj1xf5xiQMe5L4YyrGe/T0QJcl8G5WlZewZUoojL4F0f3vZOegLSUeb55iCDxcDDJKfLtyIWApjQLIsAsmDRAgDFTkX/3B+Ou1v8GWAGRZRLMsHSY3rIoQcWZZ0BnX7CQiM8a7KiwZlwXDTCiU5LiU3isFiM5zgrDdZ2uK3v6LUTjXGUcRZskqU7jUmwbGffo9GAS6zhaZCK9ftsYNnFPA1VvJCfDah8VU+jnraiP+cTdIvntPVEF85z4+MX0WmQ8gX0bFUrW51q7GrKBczZK/hlKlvh9BJ15qoll6vJShUtVefsCez6ioUrXlvNCZddvbBwxYuW2eCKVlw0ZvVqazbgiaUXDVmx7DrL1yXWYK+W3dJnvDvIyF5sRTYsf/LC7PRBuvjDNBw+ClGIZHD57umK3jfr7eOdYoOLLofpbI2DA16n1biozCeRPP5pEVBC7ej1E1Yp+vqJVuXNo1uVaY0zTFf8OHCFVTyUV6kddhd2I3WgX72PCm6+JOYMEg1yZjvBG0nvgpUjSR3hRUsafQ5dafj0WwpVtnX1P1FpEZL0OUKq2uIPkndo6IwSsCX+KLYZ5KNzqeJT9p/7mnnaCEEzpVefium/B58ovFr/3qwG6xaCrsXFZpkeMEWLZgbEFyh8iRAJ6lI4OkqHrONBiF17DliU7RK4WigTYA1zzYRqwmqdQ3jeTvK5aNElhA6uirbV4RUR9RzaJFV/Vl1y5HyiDqfQ87rxQhDLHK5zqWUdwAS5zAGdi17WAWYJZg7uPBSz0lyKSWbWfM5PM0+zACTRLBn9aqp5GkaebJYAnYluVsPnWdsE8mm87STHRTK3Ao91PnerhsyytwnI8/C3asgsG5qAPA8VqoMsYnE53PPyuDrwCSaXgz0Xl5t2KoNF2sf7X1a723YgiUJrWOlZlmxpDaKVG/9ZzOzlIeMUZLAASZDLJKT75ityUEOA8JTxYsi6Kni/3COHq4T1d8o8J0LRXX4afCnOhC/r8TOJSjzcfGtuZ0F49VDUWUATdyPt20n7LGj7gmbGqpp2CGBPDXKWdlfNmlQGd8rSdBLafe9y8VmnyEDFBVy2ZtkphqxqJ4XmTsIrYk4EoNWxjuxsY2rVS0gr+VjUcFfzf04iGFHwGYqoxFngS2glAexz2aXJUwyGZBL6nTm4pmlzN45ykljIWZinSdDlBJTgOy7AQ51lVkk6SmFS1azUWYh5ckoBeyaOaiZXcN6sTLHpcpG+xPNuskaZRr9NrX6W0pJV/DzM1qQPELFFgq+YlzSa9CkJ7kjwEXNRSGLvMGCS2sH3vdkf19uvre521TmeUIwkZmGM8FJFLNEYsm6GRKhW3sIgRnGnqtcnj+ISLkWM4iYIynEMM8yKxMe63HbzhyN+EygBCMk3K65V82V5v8EDQQhIcZZz0cSxqsvtT8vtaiPGMsygHzfgXlKN4m+zav24/KLU3OeQeVu2NwzM4uvb2/vj8pdNM7DM6CimBGcxkmzhIltJfofOZPJAlJZTi4kyoDwonR3VYnq4GOW4b0v6Oo6h58Eh2S+Bcn2Sb+Va44mc/uVhYvlnwik0dokRkLR5WiSE6eNhJCzgNAyoIZTgUNlDSY8amMWfLWUHH1JmMXxxaSJL9whNZ9qAKqUtS2pttl/bJXpK64OUZHQldX5ttk1rV9L1OhScqlk4kGGLJkduUhcxVIGixNhMavFuJKXkJDRLHbartc2Pdp6yWuN3mwLdY/FZUDBGCK1hldXBtccvR3mJ0Ef2r7d39/ARplE6a3gEr+XgBaZekRrDpHaH4wdRBTqvkAdRWdWJ/V7kfJgEheCYmBZJPKgkIMYjTKt/4MWG4qPePUycxZeNCiTdGTdkIsxq64tgQA3wuQgImzxWj5jleXSjFovSrzJaBIZhx/qw+kLNjx6TZulUoDjRDGmATjdFgsqUc6S0XmqFBxXr1nSoXuGAGdVvcr6S1kYMDqgqMWOR6kEHAq5LNQxw/cPDzasv3d3ATS8V++7haVlEbrbDzlTZokPP2AeIPJkIAe/KNMoPnaBO+SnLNOWxqRuKYj1tmD6X0RuVOcmZQvBTzAOCRO1ShThowzEGoXSsKgSUSaFQaO0KhSS6OeFu3xzaHP5ZhKSJIaXnu1WB1SC7Y4H8JLXRSaBJmB41kH2UYwqiUQnnQBuaJyzDuO9iUvOYKrLkaQYL/Ry92WJQ6Y2XBhNlwmhAWkOmR4ObsxQinVFLoEp0WWqNSoteqvOK1q+JL0fWTpLFRwKMdjGixkUuThLAlIsVCa6JQyq18j4Ph8rcnMlBTK0l6VA/lyOQ9a7hQa426z83n/yDLJSXQmTmObRFlCs7qoUAVwYqU+qVI1qBhNiMIZGotmV4HMIhQ7dJkoBQ6CdMB6k8YTMUmteHobAcwSjfzC2yPrzwT56+3h6aPXIqisYF8s2O6/nu9m53WOsqa5hpZkSniEttC47yXQjXtHYkcl8I44Q2xbLOjA7f6iQRaTY91bYJddgJ+6Ty1AmvMXDRf97sfllu/nq/Y6J9EJlZXDRVrshFY8CZwzly5b20pOF5DDCm/boV27Qtc9N8OjTjN1FJQFhW2eRBUUf75m6HBtCSsAY5ZJ1SgWazvl2P7RsJ5SQ+B47RSYTvy/WmiyHy1a9qtVHW2fE1h+P6tpX4uP5vBTSQa3ZU4QY+L/rn+yXy/C898Mc5Z+lbw+3x3Yq3dlBgnm1yrFCRnRvhTTK5ui97gmaUWD8psuXNTXM4iCtlIH4mCqUBxuFMt75SZIdmub/59n59e3p0VAYMyTZnq5EOAUej9gZSHLgrwEHo/ICi5yScANlzJnoAKTLW/OOgJtl+KZ6k4SfM4FSrz/Whgcnn7f38xn6ipT9vWErHpFojPgBFo0+iSznU1ONsCoaEo5jVS5w/0DWjXK05OaS141nU/8Bb25/2mw+7+7Ynf7hHiL2RxCyDGC9V/Kx2DJlZmH6MwlwS2ocZJM5ejMRHzoyjsQkYD9LnYpDwtgSGBGsr1vql/UnVBsMMs34/zZtTfVG9w6RsC5SnYttDxVKxaAZhMY/HGn29v9we8Zv0MTl5KAwZb0YWm4g3Q2FTyu/vOl/9/Ftz8ysei8OggHmnwUGPzTNmFxOa+fD8FOOLYidqvYuiD2N5bPpoFHEuiQnQYOpPXeMmiQYFss2ASndoWmmeNbppC02r1xppDR7J4fXzTbW+dRKHy2cw2Kl+PKTZ9s2Xps1203wM5mm8FoQS8xBtaKkypm0EmYqZeRAcmw1Cf5xFxNNI0dB3X9B1obr7gkMSE1khWVwpA/kJLRIFl31tfked1EPKTKFjw9KEkWInaOSCHrs2F2gaX5Gr0nFArSfQkQiex3SMmoCeLYD0GZtjwhwBgtXsG6JKFXuGQt37Nm08kFDlJ9HztIuj3rA6T58fkuklo/4QpclQP5HG2253HJ9doFoj+Rlr/Lg7XfIlwxHJz4iDjSgkW0EZRkiOgKFBYWzJzGZEaEHYbzpnSJ09V5w+sNJjag69eHeaoSelOlF3aWHHgX6gWHMoMEuHQgsVPu4G8BLe4Qv3ZiYPg8gqMSFSdOuv29Y+vtptVs1+7MNwWDDPnHhOt9O+x1+/wOCALGeigfsLn7bIjgoO5FFa3WOgVnTzgNTKbh1Itd4sNzf3rZtqnn+73/6qAIBmPA8Lu4eCoxBtoyhaIGwRqZphmOXcXjigVCMQA5ax+11Omd4P+zFWypN7ru96EFTQyO3ufpso/EFGVLx9NN6ffn59/fn//sf1y48PCr4v9+tuA/Hwp8dEtiJgbY5cDIAs8jDgoqPYUHAFJu0E0Sek77aSCk9P6RYizVcnmPQncz1TZ6Qu8cm+8/Wf7MSfzHV0xkSyYBQWcvaKGOtOPj4zLAOBTh1pwWw2C01ksmevkKHW9OPSUf4IMBO/8rcQIk+FmzwkzxfBEhcpD2F5RErSUVwoDlA7EJb4PxKBZDmE6U/QDDJ99OIPrWn1AlDz1ehijP5y1YKMxjHwls+Ou9v1zYcmXAAWcy+DUYaIqXznh+TxfUrDEyy3rAKwb9MbGDmwtC/Cyhp/HzVSz6pGLPf/imocATtVY7ZQ1eP4A6nZ7Gp1yqkCGuf7X1F3A0gpp4+VMfwicge8O6U2qb5GWf9XVFmMKj0/wAoCX0ZU3e1utf7yY1LVjbL+r6i6GNWp6ipV1YEvI6ru2/Iwqd7ifP8rKm0AKb08Q0sZfBMdlYl78GGYmNx5a6IykS+WRmVSVQ6mSeOekNBPdYJJ+um5SwIFP22ZhIWeACSw8L5/EhbMiSZQUP5zkn7CLyUgMC5pEgrCxCdQMNZdiiIa/uvtcv/j42Z9k7IChOA8xoArfNI2Hvld1NkI/PIPHpjyBhABJq35YOEprIiytqguy8KhXavs2Sht9bHWn0U6ZSagRcfaQBbdlKWEFl3KQrIAJ87dtRhT9pPFOHGSrMUo8Lr8mJm88JYM6WGg+PLmW/PQrz42413NkcQ8IeJoqbL48BFknbUiVHNmahxtLMVw0wmKv74XPheB2BwSOCSTYbYGBh3sxfK4fNYfCPfP/eHTDFxslq7GFC3qb8QX6CYUHAjldEKHhzy7zyFSnuDXIRLcc8Bhm3zbgbLe7n9fb9adKZ0CEss9P8bkK18cxIlvfCURio0PB05igXRI0pNqDo98Sq1Dxc0G2f4lWBbrkKRnLBweOVmgQ5WY67H9W7Zg1uFJzI85PEIaQYfndO3a6/Et4BJMaPaZvBBxsxz5bpQEZ+odqbNxtuP8593+tlX3383q9Oac1lKgJVwIbbe5ez5ispRLoP6tW7NMQgpzXgzdi0nIXlwOVdjJ716iX663zV6ND89/CaT75nb3vTNzd+0ondbMZBGXwHt/1xuWUDNvO6+xblYvlsjtlxxovpxLIA+XdHz68Fq34hnkuqSl/7i5/zrJxvcZL1Jjm2a5VQMb5rpcO3Ym+NN+PaEtH3NeAl13WW/fp9Gnx9ml2ijvZWzjGRCRzJepxQ+7nT/bj10Px9dhnPNCNfh+v7tr9s+/rTertghtFY5yXwLloe3nmx/hBuRnp/X1aT6tm08mi7rcOP/Q3NzvD+vvj65CB50r5RKo25Xms5vj+vv6+GOSM8fzz880tHoe6uKkUAsUK2Ae1mZAiL7erprf48UyTolSgrOQomzhIlqU/A6K9uvkf+7+rcMyzCdpDC2u22a1Xn5YbhG7zAOLMs6ETElZ8QDlpJUWmT9D3RzeM9doJOoOK+ASrUsQNTy6c3estdXJsaQ80ik71lp0HEfJo5uyY61Fl2DkeIATd6zVw4VnMRNDZdqOtRZjmv9NjJnJO9aSIT3wn292N7929xexUUuY0Cx+kyxY5DNR7LqNRBqAchtRg4XouDQW1Wa6rlZufh07G65SgvzcONLbgzSmqZuDCXxil0Ijk2y7aVCkZzA0FvnsRYOIc2ZMiwm22zQo0saWGVoXqZeEG6XhCLe1NFgS7pLGItzyU/bgTpzZX2N78CjvLLY5QthZuC4QZ9glPtxrehRdwvxoA33x8ve79d5nmTgIEsXMj/u35fr4ateFnDTL2+vdy+34Hm0aLZp5Hi89mBi93W3XbfLpetgRPpA+y3QIK1M0E4JgdRMPVK1qzkHrF7tRFITEgwp1p50nikDuN4U4OJeJIpB4S6HuhFtC1Qs9khBB2lXjnXHuVkg4RRSE0B8KETS36+Pzbx3fNbZ9qPo4w4yjcn34y3b325akeVE040znIYLHg9+sD8dmi0wQqDEyyCBbKAuxSLuoYoku1iztmb3krNpD2ICuGUZ55q2PL1+E1eEFL1Abzzab08eNV81MjYB8syLb6ABtLoVjv/xNWzdxjlnRNNgbPaRZvVSbPI/u7BK1y/PRFV4z4Gk9512zVdrUcaZLYHrXmq5JuEDGeXvP91a82yQT9uRI/mwkw1vj26KO3/a7+6/EnbxQYJZlCFqo7Mp4iFe3EMEVC/aPhBjEixEciGQ1ItWeXo7gGOTrESkSbkGCY5CsSKTaE0sSHIBwTSLFkFgM4BiEqwEphvTCiBgcc/SH2OQcb76RrEeUOpOxgSUKLc0QJuVjOqFwdZhIMZCXrGgoHLoONkIi7l2CWpBrPXenXlQZvN0dYZqyJy/CIbHAIzTTb0ITYeJt8QjNlIgAEY6kVR5Bmbj3L0IjsY3jvjx7S8XPeyzbGejmB24lo9RZrOS4ROHDHkOYEzodolfi/UV6E50MUS30+yLtCZuMaBfaZJH2dJdGAMh9PYVB4hcwxWf6BVGVcH4BwTTFL4hwpP0Cgma6XyCbKrI2w6LBw4UIPEZ6JmuU0iC0Ttxn6QJ5BJCUET2T0CXPkAtwTjxKPgnv+iQ4rUrj7BdDubs/ngUT5L9gbXIxvKL61MfwSpGqjVwSrZyLmISRn5ck0cnmKRNwSXx3Ep3Gl0/oidOr7XxfP6FKed+fxDxtLjABZ3LKmoQ6cZ00CW1yipt2RdOipcVoB7egY5dmDS53ld6YpbnDdtJNTfgdTdI7ajmVqeujo7zojbRmUZdZ/jiHC+ECb5d3D1A6BYc/PfzOViXaOtGME/uw5CRTfy/9WeGsVKyXusUY5elb5+NS5r1v/qyo1gtUz5Tb5ONi5rpHfmLs8QXqRHFLfJx7lvvhpwcaX6AqtLe/x0XMde/79HjnC1SJ9lb3uIhZ7nNXHF/gPf/slaO6vR3kT97b3r2YOQoIHk2UEKF5eBSqYBl9gmGnonOod2Nx9b24aPnJo5BP80kwolmZAoVg7UtiUcw7FIjYlS6JReTKFCgE61oSi2LCoUCUWm6RcKTeTYEltZgisUjdiq4HKy3Vk0GWGUZ1/PRF2w3/ed8cjj8dj3cv93v0mYqRjHyNcGh71P3h+W41/l6q3CePef41Ezsv7EsITPfI3UIkmHv8OqFzMawPr1snscSihEkoUZ45ELGOXQEnNSvGihh8jN73kphkb6eIW+m83nuJfnOzvD8owJzEZ8fRdIm6ihlmmR3PLXUhDwnnlrmCZwIaYOO3Tbf/Q14TRKJCck7kchOVN7z4frf9slnfMC5gJDGLA8BLnWb+x9+gMP4EEI3pF+tnDD8BY4LZ59CIjH4SSsrkjws4y+ATeERvJEhb5pyeOn8/wQ09VQ8qMy/GQBt5AofexIuxkAaegKI27xwSnXEnEM1n2tnhPTQ1sTX/cr+98TdG/6lPYa34oKD+iHmX5W1zOAzvbXwscyzEO4mBA3q12/+yXq2aLe2BxiKzuCCi2Gk+CPkMhROioGi8kBwB44YoIBP8EItH5IjSYFKeCCnhLFdEIZL4Inn7nNVnL9BfcHdE1oXKH8lR0A6JQqL3SHI0pEuiwKh9EotF55QoTPN5Jb7iInN/v11xpn6YPJOZHxU51cRH0FXmfQxBZ9olmlmzPgYwyaQTOITmnAORNuVR7jPN+BiJzIRL2mGzu8FZeEztQHjOvjB5PMyMg3IdSP0r3YZEO+cyxgimuAsJCsZVjEFMcBMEBq2LGGOZ0z1QhsONID6IDZ8BeFxqYGLStcwo7/Mug0SJFxQHXT1ke3cXP/Iz2DCHMnJfF4+pVJHIwBq2zAiqeCglFePjaYry0QhK6kaHkVT1YLpCz1RkkxRwXw/poGW+Gf2ACf5vgus7x+PInI1KG+5Xki5FpYP2HiLHodJF+giJe0hp0nmCc5xAEglmJGMjjA3ttPVNdUW+VFWXDHAFs/+ETrgA0CtD7ElCp8auQNXSSDBeb2qaD3JPmuYnwKjM3agWgH24bva3h+vdaDQ9ziUwMemEpfn9uF/eHF8+FIGVD2V0zO6zr1/3zdcTe0tyu7GYmN193TXFdrn52Oy/N3vckyIysyz8qXKnrf6xL1FQACQYDQ+gwMDMNUgoExgBHpGIFhDASRkNrIizCAISk+xFGHErndd7L9Fv8IkVXR+qVbsCBz35IrHo1+8KPOQEjYSjXsnzaHSTOBLVfGv6ROUNb2Rujt92q593x2ebze63hqF/SclZHAJf+jS3QH+bwjkkgGlchBoP4ygSsCa4Cwk6kdMQQ0u5DrqgsxxIAp/oanBtS976DMjNhzyWx2wz4ZhjBF6uv+MOLtVeKjenxkQ7uwQuvcub0qtwF5PuVjr3J0Gmc4IJhPO5QlGlRk8UfG9W79u12nLbFrD5wThESnIeh8iWPtEhkt+mcYg8MJVD1OLhHCIPa4pDFKCTOUQptKRDJAs6zyHy+GRvZShbktyITYBR78mqkc0xJi+HjnCRiRbUuUgtJsZF8rgmuEgtNtpF8tD0LlKATOkieYQzukhJpQ5cZOtME6FCI4lZXCJe6jRXOP4GhQskgGhcn1g/4/IIGBNcHYdG5OKSUFKubVzAWS6NwCNxZeKWOaenzt9PcMdA1YPKIYgx0I6AwKF3AGIspOEnoKgNPodEZ+gJRPMZeLbSYsP++vZu09y22TgqkJCby8iTZU829ehX6Qw+DUpp9jVYeONPQ5rmAhLIpI5AAkvgDtBiznUKNDaha9C03vm9/FL9inQWTP1oXYYGD+s4aEyT3IcGF+dEaFhTXEkCldqh0OhmdSsp2IOYonfP7o/fvMCrdbNZoVFFUEbuUZrIUaWKfHISx8f5CCqn9POqOdzs13fUTXIMAJD1PDCHmx0e9IMDOImfqfQY7jiRKu3F9UoHsxQvRk9O4uRZIkCRIiXhWgCo3mFheiV+ilQcG7flth3/u/0PMB457eM85yBgHCSmfIJflOHA3SFa+yovKNNOOz8Mgd7nCXsD5UzQbqD1cCQGnWPDsMznz+iKGj7ltG/aIbhadzb71XK94dZJjOwsa6VU+dPWS9wXKtZMSXCaddMETIw9T0KbsH6SIRStoRTwUusorqiz1lJJjKL3xvStOs9ouGS/w51Jur5UnmUCLtrNJLHpfc4EfKQDSsJTeyMZOp1rSqKcz08JK3d4I2t3NXm7XPu4PK4PX9acz6JFZ3FZieKneSzm8xQOKwVN46/0iBh3lQI2wVuJ8ImclRxc8o5uuqSzXFUKoehaYHV7zjIGLtjfcDeVrCuVl9Kjop1UCpneR+nRkS4qBU7toUTYdA4qhXE+/yQzLuOj3x+a1bp1bY/XZ6WOgOMZxAegRtnHdQYlZqGT8FIljNIY8QRziGuXvS1Hq5dFdxHK0aiuSZo5s4vrnmJtpWgII0u0gM62SjEwJhXHMcGSSrHQBhSHorebDBKlucQRzWglOajRK0GsVYzeedCbQ/nZbKb0WcbQlLPbHCbVdF0Fhj/bzWGaMlNPQZO/AiLBlX5IBy3l3LPgHDjKM51Xa8Pm/PjjcGxu4ynA8FLOQTo/ARgMW6zMwQdLi4QvM+0bfOzD8p48yuINOcRHeS/CEox03XCXMwgUrZoD+j7dSFEvOFlR69q2O5Gmk+RkVevtF5mmXnCyorvl8ZtIUS84XdFuL2ulXnCyosOPw81ysxHpepRVqRusAj5tl/fHb7v9+r85WgyVmoURo0ueRobh36PgwRhAGp+qwsGslhg4E9xpCpWI8xJBSnlSvJCzmC4Gl2R5p2qxc3v0ZfoRvuDi6kW16FJhoRdeDB794kuFiVyAMZDUi7AUIt1CjEE232IsWYmRwzjc33U+rlm9baeZy+t2lHOOg5GeyYGkNEx1JNx3qhxKEqDOsUzAxTqYJLxJjkaGUuhwFBDTjocr7EwHlMQpc0QTWniuEXLZfkg5qHS9KR3VBGycw0rim+K4JmBkHFgS4gRHJkOodWhJpHM6NmElDxzcs/1++ePTdr3b/rTcrjbNeJyPJFhHJrUeeKkiizGGTLTOze72l/V23MNJ3Sdxuv6lOKJ+/C0kj6NuCSAD+Yk9QV5Fy15CXEmDDLKBJcbyTQXk24VQLDeb59pKAXku3Wjh0z8uvygrq88xR4XVZZY/DvRnhx/bm17s9fbu/pE66iYnLSqYnthapUt/d3/kiw8C4m3hYdZxZQ4S5zF6sECZvRti1I/jsU60q2o1UqN1pA4ZqNN04R2e0Dfq6wKd0aO8u92mWZJOMU6epXMgRcqeUo2Rkrv0X7/KvuPJg6jMDcr0kz4QQ8A7wNFbyyQC4RBBaz45SGRama5LfznbeTV6FTon9K/h86XLm2/NihotUeosg2VcouwdyggmtbjEHyhHVCIvktO9VKT7C348C9H9ZXwo60zdN52QqKZ7wXM0C4cmqj01MkU6iQGCKEyMD5G2r83xL80PUcM+isrsr0j/l/anF83huN7isVpoB4NZZsTDmEWyBVTTV7LHx28uh8D65Ya0XCORecwXXqz0LV2IWmnICOU6ayZH0X7M8LXSJIwH+YvgaMeWFkrIchE0f1tu7tVVc8o0L6J+kClbC+aaF1Nrg9aHb35ky+AMMpyNROqiqLGc9lNi7Zy55BuGm0lq9St1z6C3teE3vz6Iy6seZju7LxRRnxxNdB8DyAaprKeICtwcm/1PcIE0LHMoIOY2wm24r4aZRzWIyMzi4KhyFTdux8DpLQLmrm1EP3bLNt0nFEgIZ0sCUXlbHofQUNFtkrRUCv2EqSCVJ2yFQnM39IK4XHuUZ+aWYIx2ojZUM91EHx1eZ7DcLzebhpzsgvRZDAFWpuy8OACr5ZVQxUpiicYgHHL41yeHm1AvMdSYL59HI9qlGa2q7sy0e3Qzx+6mORzInhwlz9ORx0UK7z2IkFLcy+b+0I7ft8vtEqNpUeUwi6hHi9AQvgxDoXJjMu3N783N/bF5t32/X98u9+PlGoYDyXQWIukAxxomPb5FWqnhjahMjW7pV74MtSj9zEfx+eqaMzHkl+ssDNkLBwbmY/PP+2Z701AWBqTPYmKwMkU2BoLV+kpUsdJX0hgknZpBMOGrhYMXr291gIPqy9GOzXy9qmcz/WDYtY/L45rc9I5S5+nWoxJlnTqCSXTp7yh/hmj8ruDMKM2ijjxWnerGEm1MJ0ZqV9+F5V+Md2Dqq3Xdl2rxUee9/rbf/cb34KHIjN14VKyiL0eoubhMse7x1aapXk1gkHftMQhR/5boTXVypO4n9nR5LTDdnaqJCX2e6hnRSQQmRnP28MxpkZlnBUNOjIPU6t+3PnK9b54NzhzSCCJhySCTIFh/3e724f1mSS0A8TNQCAebNOhTq5EwK6LQTq0uNorzjABOdS0TIcjnRx+fGSg6S4wo1dvxA1RsrCUhN5Mxo8vWnlGhQgdHPvxtu8TENlJZMCCnbKynsImHPVdLAgugwkEaAwZE0i5MQEAMjiQK5ThJ9p/BkPn70h+B35A8PRSYZZCghYpGxwivLgQVV6wMQpViIGcfOAolB8KgEA5CohWSo0+qmRh23NfPpBMdaJxeNnSBa+9hFPfy0LxetVnWX9bN/uOxO2f1dUwo42LzRHXTRcuiu/EvIKq6NzOHxxwqQGj2OXB9bY7vfc7nu+1x2U5zdLjQ7HPgWh8+7HYTQY3zzoHoJpSHxMnzHemUaSqGwW1GzIAZ3M6iHC/x/hLdTdMaNL2U/WbpZVpyHP1p7H8tFICukM8hqo0ZRQK4ikF00Wob4zhVm9FUG/I51HqbGOQCrNIxftEKAyBOteU0tQU/hNqGhtZHAC9pfC5aOSftqYsQkPwPwAmmeb39umm6ahPMIDjhedjnlAIZD819E9Enfml9x6f9mC1LI3rMKeKnJ2AjlhRpaMrlhRCbdi6WxqnwdVMwpuY/aYBSCzkFnWDWmAaYcHssNz8BMzl/Ew3gsSGdAV9k1O5/We1uWy0Sm0bLzmPSEuXLLBrzQVqDlsKjtGd6ZPvma/O7Htcp24VQUUY2BUtrY0XI1CY2hVJjYfUIkwY2BU9sX/XYJOY1Be8c66pHTBtXgSlR2lbZOAFc04dmufp7V9ab3c2vBJ8AZGZjmbByU/cp4wf6kQ8h1wv326PyW5/EmebAFHWS39bHb51oJyUHBXLRNIoQxfLG7xzrgYwzSsy6Atm+2TS9tA7ZOOPMyLo2eN0t+bbLzfNTJ9E1IZZ9ZpStyXsoPcGzojDJ/LOPhNvdav3lh1cmhxdnmt1ibJTGYpO2E+ylSsru9yCm63bDbDL/osSlh0R3/hmqbcAWv/z9br1vFyKU6xtwOISonDdGTbtQgczCU1+jJ6zEWFLMFVVQ9D1MhY27tAYl3rP/oCp7+DHNGHO19vhN+Ezu5T/vl5vUVA4TmmUuRxYsWg+j2HW2mAYgMMYKLPJZG41INqiVOGgnwAMRjBUlkgkgknZf01sGg+LVetOEBxY+NOHQFzEwKMFZBgdbuGiAkN+hYz94IErqQ4tpeWxF744fm+OxNXHj5TAPbpxbMkPW19vNr+/u/AUG6sob5rwUtle7zWpCuw4yXgLZl3W7eOkuplcCG+abCVfMtP223Gx2vxFByzw2mHcmfKLL1BXIrqK//jVLzcvIoplSE2yBdiA/5Jps6jBmQIniMdc8KI67Lv1Lm+v98LUjGZhR5ksMhtON3dPM2zj3JTCut+vj2psEJbwo4zwtejJOE23abDhu7g/H3e277fPdbeuGb9cHtZnFS5jLEQxmW3/eN83qR2oNgkrNMs+iSxZNsnD4VDQYceUYg4G9Iw6ZYKnw7Fuxj/dfvqzHW3EMpCjXBVB51lwPK842D64pdCgD8UxCdBJa7BZAAUTyJsBzcXFULYNrClmr73Vq6yPe4mE5SFUFsvwBg5QkEM5BJmFZGEznct7qiqMJj0TN6XlvNbYpsM7jvpOtG92xd7vb/0gwIpjQLF6aLFh4zR6CXceC0ACUDIgOi66W2fGEXPAmR3K/7Yp+3i7wflne/IrdQkhBGuecAZtoSUljSi0nNdqppSStPbWM1Ghv3XUngLtTGgLINkdviW/f6xZWqTk9LjaLuWCKll7Jh30BM43GW4DDMcwlaYAkpimTVQ7gmbNVHV5uWsiBnDIv1LUuNzHk+9kMM0NdJbJTQw7rpLmhrhoJX8ahOnd2qK88enqYqj39/FCPbhKw82aIaZCDAAlBYMTFAiKm75mev5t/duDDRQIezti8vWCVKAIbpAENcRdcrQ+j3cII2EBA3v26/x3u2hLe75shL8WW/GSci/rSIWpqCn7o4v1uieoe6R6In6H0rs35226/EiodiJ+hdPWLUJ0XVCoazFO9DOHZB2mzzEhheaJp6BCgbrk6UqdcpQo07zuRtOKTmGSKK9X64TehXi84p2bUBeO6acc7RXsqEGKEYVrsgwAJZQpJJJwVPAsJHUIwwqCNGsC1x3ts7QLu2HjB55t1g6xbxmMeyTITmnax9uAvMcp/hGWcYU4kgSWQAxnKz4SjD0d4tdwg7MwIBZCejkEUrMGqvxr+kY7OGJZFFjNpxThCKZxPJ5uGX2qhaiWT1qReiikcG88EQSjQRfGCiLPg6UCBLiYEYqROEPUg0EgGOpCW9xxtN20N7TsRgd+LZM8wJdGiAt30iOam4h2P2KuDDskXKeiWUyLIZErTZijKeoJKTqbi0ZHAkB4jF/jwXqlkoRplPoHFFx1/3y/v7ppV6jDJqX/z4rMsTQQqZLfj8V+mW8BIQGlvzpuIb2q7aA8RTMPXdOL4U6cSjFH2mXHKZxoSpKLJx3Rs9HxECi49RZmGrunF34c4vOnNHJUhcY3yHjkwcH/brVeEMXtMmsVwgeJERmqATmeQoDKl8UH1ygcI1C4aDDKddMfHlKY7OV7Dgw7y0/Lw7e3ybqSu/32WrjEsS9QvTqCITvFNgPnJo5BkcAk0vhrb9JHCV9JXP8f6REtVRGFqKviQJcAj+l6bmlSmaC7IQfBlB4FJZR9SZR+ml71qp47Io1RR8Q8ykzT45VFiuPQik8pvhfbrJtGyj0KTdPyKvS8fKfgVPiuvKN2/n5Mo/0FmkoYvu/3L5c34wEek4lFIrKMwmRsEm2PL87ijcsvyxDf8o3UD7bxxt/9PXsfnk9znqab3H8fdx2M3/bhefk0pG4hq9A2eKF4/BLr8FBvgx0eKoQi/3B84vscgGsyVRKmzOMFxiSJXGMNUWG9EH7ThXKyBSC9m2RG90L6frRez+oheaPvP1kt4BEQ14hfO1o57C6xfjXzG2bopT4Jox/zJ2fpRL4MoH/maszUTHgjRjfihs7VT3glRj/moSfoFngsbbNB/nf3tjFdD9BO+bQoKhcfDgJB+bxIW1GV9bI5v7zfHNe+6BlIzuzBYstKVDeFPcmkj/dNcmwzHy9agjbdOeTCnPBdAxDvdEZhpzleAg3fCIxzTnLEAx3I1DjlgcATxC+BITg5GUCZPEsRo1F03znYBXKlJzNiyTJzMSHrOQWc/n5wyXABLeoI1QjN9oiXE86OVUyM6ZboApsQkcARn4mRQMrrWh+O6XYL+RYkI5LsAsuR0dYRp8rRVikbbi4aZLoApPaUeIZo+tSbwqKbYY1c6baotqBvRlHuE56ypN45q0hR8DOzMqTiObUBQhQNPCC0VEthZ96CYdo72ovmybFUhRT0mssWZRV1m+eNE/tl+v/zxctPcNoNgyG6n4PCnYZKqzJe3d8cf7375r+YGFjlIUZXY1uwwLjEUFn7UlvO36E32h5L8z9qy4nnTQ1n+Z32NtTmfI8uqQc3FEuLFGtgl4gt8krrwE4HKVJLv4PAqor6mhmn8GOA2vajCUh8SQ6OCvQarhoSiK7hkIJWd9uLIOKvb3Xfx9109iE/SPIyZw+iCQbyVlCeAr4JJymI39wj7KgwTw1Sd4sMy+i20YbYOHL3lG1sBTjO64r/gl570PXxuJfrcB5iCQcGp5wbEzF/aqkrH/A1zddioo0zImpjTTS2GL/i5A5XpV/2GuYdYqdY9CMc/ss69ZAt3ytKvy0VtfGBmi3AlzenGltAX/NRe3cOoXYi+9gSS+d54pZ6CMF6iX/ibvcKHr5aN40eg1GjG1uDs2KIW35cczwOdpwqQ2eoILVEFYLHPAUkEScz82UHbg+GWtXgPkftWcTfHOYRLf/GwmxvZ4H4ESp2rA3QFByIVpjLzN/fqHga2zHifQFKL/TEFwWEQhLTM/NWPGlOhd8Osg89ijyJwO3tjkTmPHEza00NQE+16g94mQ+uW38Ujx3Arr9Qnt+LYUVZ/clOT0s8FXKo04ntAjFp+wivXjW1UUmq5VaJcI7YlSWnkAkPlGrHNR0ojt2qSayS2GSmliQBVrV5dZ5IsoOQI8K1D0oKwgbOKFkY3Cck2ZldOcq3UdiClN7WQ0WnGN/443fySQq4d3eKjFLOBxYqezW3mkV1bspiQYyC27Sjtidm8Uq+qtdMza7l2aiuO0p2a3/KaBZtupLPggrPl38tsr1GaBfNb+fyH30gjIYgCuXkUg4nu82/dg62r6+b2brPsvMPX9s8RGFRqlukuXbJoxovDpxZv6/3hqP7CJ3E2yRxUheomCAeh8cjnKgjmnB1bm2fV7JvVz92fCmQg3xy44snHcvvTcrvaqEANM03rTWAyrwXwbXbtH5dfJiDoc8n235P9Zfhm3n8dEoZkJDGLEcFLlT2VN4JMDAXqwXhCt+6ZeA6FpNMRIBIdTvzt/fPo3XHnY7M9oO/dEBDwrEidSK7cFFcTbR+oroLahlmwMCOVbTbVKGWbcjhCT63Qve2a8vqc8DzjNqVg0tPl7Dee08OTaLWdfQJqaTdP12zSG05BRNmnJBzEVLH9fTI2fCAK8enGpLAfRuf/Oy2/LPcpP0oJzjIs2cKFVwYQ36F0rjwSnY8VYJJ0ZR5SwuNq60VilnhAs/pfbRXS9inRxdTeeFrjorZA0sAqOyBp9IEN+HhcHtc3ifGPCc0y9smCReMexU707WMvpYAwyCIZ8VPQaOv7ySjjDMiEg4hpq6Rz1yAgLCGtPmEF9brRgZrSrxqkSUxxwO017LwhfPT0syoq+ZSpex0yIlriMk/JfNmDONNTxkAXPpQ62E2PJeTRpscpJT8Z5cJ7B4DNf9v74euwiP4uXf9dXVWLSn0CcvBf5MEmVIs/6AnIoVKNVWXo86+3d/doKDEiJq/Y1ne0sw88Wogq+MkgE/9xQ+RSZyMBgLobBYCBU0+48ws48gmradQwnuuk5pnfneWoZlhvnu2sZnJTJI74/NLQZ0QWJTrIBKWkB6S657lGDvCx5GEyW6QdnI96//7N6+fPrl+/+/nzv3189/NDsd+X+/Xyl013TgqITCn6zQtJ6b3UFAXvnl+/vP788frDy2dvE1qGolNUfXz/7MNf33z+9P7Fs+uXCV2R7BRl//7573//++dX7z68/fzpw5uXPz9/9+Lli4RSNI9U+fXLf7/+/NP12zeIkoc0VWFvn334y4t3f8caP0pXFfqzpYr72aoKuv704foN1oyDVGmBr3++fvnh52dvPj97g1XfMFld5F8/PXvxkSvUC6iLffnhw7sPXLFeQFrsi5evnn16c/35+aeP1+/efr7+j/cvMcyY2PQDcoJyU2flUNzU+ZGbzQTVVyGbXH3iEN3yZj8NBc0hTEBx2xyXU2D0+c7BMXCLX5rjzbcXy+NyGPj46BaHyXJPe7hr8zbXO7rckYy08PDkyp+bbTvNuHn5vf3ql7frYzstft5lRDTxGaaek1WV/yQhkxhgidyJGsHXT4g4tspAxOTrp+Vq9WZ9OHZFaMp+EufD6wTDrw/Ml0BItQ5WxvALiMoZXO8uAQSuc/8frIrdVnDqCsu929LffqPFcKNqgHm//6YRHE/Ba+AmcZB70vgYZf1D6iVG8XBkSVdD4FOo/vLli67JvPwf01u+fBEczUQ7Swua7SvPNptTRaGUVKKlQPY/sM8MkQjO99H9Jvokou42k6ps80fX1AZWEH3iEytjk6qW/fK3iZ0pzvjHdKMBBsFZSbQDDT+DOhXdyqpw9Rn+kDrpdKdvOcCye9SJ0RO/467pwOOX3P+AUeRBpC9D4EZS+A6imu72zV2znTbbHef9Q6oKwBBcgoIVBT+Gr6937fzonDoD+f/IehtCEdyowtRd9FGUZerydduqOtsdZftjrNQDgvRtHaitevwClB1YH/58v9yvBi/IDq75P6VJqYavnfjHY7u8vkWKG6SqNs4hwLBfroR23C+3hy+7/e1f73fHZhV2nTH2AxeczheKSn5CpCVW0kQu4lvJufIBvwNvMt6rhyJngJ283utu046g22jbeZ5viAq+yJcM+ufhbrM+Ptuunm+aJfbkRpQu7fQtzkPzfrlv/zoOp62PxQIJVcHPbm6aO6zjDFInFPj8W/fvRLm90ITiX25vdqthOAta/klqgoI3y21r6b5iFgCRmqDgxfLYXK9vEwpOUlIFy9Xqp2a5GswrHot9SFOhfR4CO65xawhFVEW/2u1/o7xWLKAq9s16+ytZCUBCWvDt8njzrTk8uz9+2+3X/+0fmvzY/oK2Hy0sVfdteSBLf0gTx5aN63kwZ5HVcRwAjt4BFxf05Bf63oJHPNTZzx06LwYavjCxrUkV33YHdGEHdPRiE5V0gdo7gZaTnFxN1DXv0D7I33Az3Apbb47oWAkJ4h2q3fZmiRn8kCBHs8XsQfezfCNudX+DB7t0CdJiDj4U/9nhx/bmbbNHXQEUEZvpLsf1zt8mjFnqQbK0yG07UfEPlDNhRCMZaeH/tVtvmXKHyeIq+OWw29yzUU9QRFp0sz3c75vr/XK9aZ3/x1YaKx2Rki9D1rdRxgaftY6kdF/wpnVRyQ8YCmnwD/OR8GMh8QKyOT4cYMFWkINkMeLd8+V2t13fLDef9muiv4yFpMWvmnai2PSZnu9u73ZbYilCSMobVqqIkJQqWh+6WVl3GnxP1BaQmFDw423vfPGPcuJq+r1dfN0cyTlQlD7Hqn5c4JP4p8QaPhaO4VPHxeQfh2K5eihADSm5Gj9gflyKq88+A6rYpnxoNu1U+nt09jCyKgMBXVjNx/tfVrvbtq9+aL42v2PTKVROYQ/f7lb3m+bDbkc8U/CYLl6R+BzE2H5MVAQv7Tbfm7dcqSMZZeHPWqEjX/aDiCa8+f3y5td2Ef5vB9TdAAlpWOJjFb7vGKRvu81wQfkYt4bKaeZVeHfuU+RW+f1+d7s+YPbkIU3ZXH2ud/v4eYhRm8Vy4qV6yPVxh1Mgj6niCeVm8+p+065ZNiihMExWEddENQT+etq3H5q293Tz8L/eL1eY848FVOwHVeRjorS4++36n/dkeYNU8SSu2d9e715vUZr6lMbTEINTOq/86rQdeO1/x+/LR6mznNEZlyg6ZRvDpOYC9/HLMIzOR9Ez9N21K+F2moyc50U0DoXP0LkTf+Ju4hcOOseHdpq+X73DVQ4TZ+kaowJFPSPCSLG5H1obe7+/ad42x+VqOYicjnhdKCUe4netdOOfQ1k3qxdL9IjQWEjBRp/OFvH4oZR4+rZpV0UfmraHHto69UQrNnkbS8mJmtYUtxPL5apdzazW8ZM9Q8JmLCamZz9u1jdN2FGFjwINL9MeSckJ28NxucefnMELfXLKgHdcBDC1Yb/FX0Uh1Abxc5VG11NKPpa7oZJXO7wJ4lFwZB8GabPYG1ie7LqHAUCq5rwRSat7kHvUxN2WJNC8b7plVUc1/boeXxk8AgDF58fRjWUFjl78HBzR4dTPD5vPaRCRrKbtI42/rLfL/Q8vmFYZC8/21cHxCzHEwrNhuPnW3Pz6cito/IHkOdrBYrZbVV7vwGUN8Wp2KKJZJ4d81IQeSGgK7tbVZMBQLKDgTD62n7dpXh8bNAxpmC5eIK3v/AnuDbbp8piojkYiywQSqgispo+yetUuMbEKgDJyCnr17gvZWoNU8QTG739dnz6VmcOggvJpzNgmisp+kraP+BfoAwAlINLRyngpj19B7Zpv7g/odSQMqlOeP6xaPIAUu47nD9jpOKznu9vb5cemLWV5RCkhRErM4Cy37Sz/vzuq+f1wbj0oPJaQE3l/W27Wq9H1QkM6L5KQF4wTjf53Mel8uN69uN9TC61hshzXdbPHLFFIkG8QdpWxIsoapMoLDCtzssTHZHmRb/yV9FgzPKTJC3t/4mVIiJGEnJw8dt7qdTd8v6NYgYRur+Vvu5vlL/eb5R7zl1BEsV/YOi62aCii4oCRkgP/O7G8ziKslxuy2FH6RLRv2n9tSMg+dWLJGBkOUieWHPVmWHCyIw+vRHmOXajR/iov4D1awHtxAdhFFs/EF248+3T9E1ZA+7O0iBfPkQJePJdmf/Xu2SukgO5naRE/YZ/wk/gDfrq+xhqh+1laxOtnPz9Diuh+lhbR3TD0+Q12h06fIi3ozQvsa9pfpQW8xT7lrfhDfn53/frVfyBFhARpMe9eox2r+1laxPvX2J1L7a/iAt59fP3vWBHd79JCPrzA+nf7q6IAbJB3P0uL+PjuzWusa/nfVYV8Rg3OKUlXFHXJzyB1QoGfr19+wNodiuiKJozEY6KuuLcvr7FR9pgoLe5vz37GbrDqfhYX8fzZB6xz+N+lhfz7R6yI9ldpAc/f/Xz98ufrz29e/vxn1CfFAtOKpfoGIqVV0N0HxJTcJU8pMoX4QUZs0z68fNUOgpcvPnf/ws0bEJlaNIUdlcOU/OfTdom/an7/l//z//7le7P3wZ7/51/Mlb2qW8kv62azagX/EfS3Wdt1drea/88+7W9Nt1vRSQSRPy3+5ek/Fk+rxVVe1v/5n0//ccrhE/wPXixr/8qeGndV5GUklkVipv3LPLX5VVlUkZiJxGz7l31a5leuzCIxG4m59i/31FRXpbORmIvE8vav/KmprxZVHonlkVjR/lVgYkUkVrZ/lU+L8iqvikisjMSq9q/qqV1c2cJEYlUk1jbKP2qseuu4ehdUcRloB98Qi6dFdpUBwbgluutz/pFlmOosbozMkrrj5ujuo/lHZtAi4xbJuprP0BbO4kbpTnwTyuNmybrqzxyqPG6Z7iD0P7L8aeGuHGjpLG6crCZ7ddw83XUPeE80cfOYjOqLBgwUQ/VGE7eO6dogK7DvNnHzGEd9jYlbx/jWKbHWMXHrmIIaqCZuHVOSAz9uHFORNRm3janJmozbxi6omrRx21g/dCqsJm3cONZQNWmBHbMUSBu3jSVNmY3bxubk18RNY7sGyFDTYuO2sSX5NXHb2K4FzAKzfTZuHNs1gUGNi41bx3VtYMzTwrT2Ku5CLm4el5HWPm4dZ6hKd3HruK4NjMW+xwFH46had3HzuK4RDGqFXNw+rqBq3cXN40iH4+LmcRU1xlzcOo4cOi5unJw0a3ncNnlG1U8et03uJwA5Vj953Di5peonj9smd9Rn52AakJNfEzdNXpAThrhp8pL87Lhpct80BWYo87htctLl5HHbFGTbFHHbFKTLKeK2KUiXU8RNU/hxU2KNWMRtU/i2qZ6W7ehexJ23iBun8AOnxmqoANO0ghoPRdw6RdcGFp27FnHzFBVV6UXcOgU5coq4dUqydcq4dUpy5JRx65RdG1jUpJZx85TkyCnj1ikd9TVl3DglOXLKuG1Kcg5dgkm0bxt0qljGbVOSbVPGbVOSbVPGbVN1LWAtpruKG6fqmsCi1ryKW6cyVA1VceNUlqqhKm6cqmsCi1rKKm6dqmsDi84Aq7h5Kj9dQwduFbdP5dsHnQtVYJ1Dtk8Vt0/VtYKtn7riqoBFxg1U+8GDrWHquH1qckpQx81Tk1OCOm6emmyeOm6e2k/Y0OFYx81T51QF1XHr1AVZQXXcOnVJVlDcOLWfTZuneXlV1UASrENrsirhSnRB1WVIGoqSxi0kDUX9AEIHZUgbypIGLiQNRR1VUyFpKOqNnMN8VUgbytJNFdKGsiVVsyFpKFrRVQtWpouarlrQYJ4hcDnmMbMRe0DzOJA/yEiTl0ECISOXQRmkEDJypp1BDsEzBQ61exlkETJytp1BHiEjB1cGiYSMXKxmkEnISO+UAS4hM+SCNQNsQuZJA4ca9MxAvodctGaAUsg8cYBXAeAUMkMuXDPAKmSG5OEyQCtkhpxHZIBYyDx/4FBPlQFuIQvkAromzgC9kAV+AZ09ZoBhyDyRkONcGiAZMk8l5K1Jbie6ORiNgGbIPJuQ26euvjLGAVlI0vkxhvNfgGzIPKeQ5yj9BviGzNMKOT7KAOWQeWIhx7sjIB0ymnXIAO2QeXIB746Ad8gs6cYyQDxkjvZjgHnIPMGQ430MkA9ZYB/wPgb4h8yzDMUCbQcHuVVvGPE+BkiIzFMNBUHEgjbzbEOBO17ARGSecCjwPgbIiMxzDvgQBnRE5lmHAp3qZoCRyDzxgHcbwElknnpAiYEMsBKZ5x4KvJMDXiLz9EOBd3JATWSegcDnX1kOKXHaPAJ+IvM0RIH3R0BRZIGjwPsjYCkyz0WUuM0DPEXm6YgS74+Aqsg8I1Hi/RGwFVlBzukzwFdkNGGRAcYi87xEifdywFlknpko8V4OWIvMcxMl3nULuJPhiQu8kwHqIvMERYl3MkBeZJ6jKPHeAPiLrKB3NACDkXmignASgMTISpJjygCNkZX0tBHwGFlJLsYywGRknrAo8V4OyIzMcxYogZQBOiPzrEWFG+gS7j91zVLhAwJwGpmnLiqDYwBNVtJNBoiNrCJZpwwwG1lFtxigNrKKHmaA3Mg8h1HhwwzwG1lFbkdlgODIPI2BW3LAcGSex6jwVRzgODLPZFT4wgiwHFlFL80Az5F5NqPCxzlgOjJPaFT4OAdkR0azHRmgO7KabjJAeGSe16hw6wE4j6ymmwyQHllNNxmgPTJPblQ1tgWUAeIj8/xGjQ9IwH1knuGoM7R5AfuR1fTyDPAfxpMctcF6mAEEiPEsR42OBwMYELMgDaMBBIhZkIbRAALEeJajRp2ZAQyIWZBMlQEEiPEkB76fC/gP40kOfEQaQICYBc1XGcCAmAW9AQwYEONZjhr10gYwIMbTHDW+nw4oEON5jhodvQZwIMYTHTU6zgwgQUxGLqoNIEFMRu4HG8CBGE901KiPNIAEMRm5OjOABDEZue1oAAliQjzFYvE0d1c1/DDQZp7qyBaoPzUwqoIJqxjFVXgaZIFORg2MrQjBFQt8AMPwCpoKMTDAwtCtBiMsPN+RLfARDKMsDN1sMM7C0M0GIy083YGuvw1gQowlF9UGECEmhFss8FEJmBATIi4WRJgLjIgJrYaPS8CFGDrywgAqxNCxFwYwISZEXyzw4Q6oEGPJHX4DqBDj+Q58QmoAF2JsGG01FuhkABtiHLmuNoANMXQghgFkiKFDMQzgQoyjfRqgQoynO7IMXacawIUYRzs1QIUYT3fg8S0GUCHG0x0ZHj9nABdiPOGR4ZFxBrAhxjMeeESMAWyIoQM0DGBDTE6bSMCGmBCkgcbFGMCGmJxuNkCGmDw0G25MARticrrZABticnouAsgQkzNzEUCGGE944FNNA8gQk9NzEcCFGM93ZHigogFkiPGMR5bhNhLQIaagJ5CADjEF3WqADTFFaDXc8gI6xBR0qwE2xBR0qwEyxBRhrOH2HLAhpiDJYgPIEBPIEDzizwA6xISIDnxqCugQ4zkPPNzHAD7ElLSJBHyICYEdeEyfAYyIKUMwLm4kASViPO+R4QF7BpAixhMfmcGtGWBFjGc+MoMPekCLmBDrgYfPGcCLmJKk+g3gRUxF7qgZwIsYT35keISaAcyI8fRH1jZ0kV/VGbAngBsxFRlGbQA1YgI1Ykq8XNB2ngEhygUtV4WWq/ByQcsFdgQvF8bshnar8XJBuwV6BC8XtFtgR1CCxgB2xHgKJLML1LYDfsR4EgTHAPgR4zmQzGZ4uaDhPAtClAuaLYSFWJxHABSJqckoeAMYEuNZkMxavFzQcDV5SsEAhsR4GoTq64AjsQvyuIIFFIldZHRft4AjsQuy3SzgSGwIEsH7ugUsiV2Q7WYBSWIDSYL3dQtoErsg280CmsQuQruhts8CnsQuyKArC2gS67kQ3G9ZwJNYz4VkFuX8LSBKbAgVsQXW0SxgSmw4bYKHnllAldgsDDkiEh80XX/oBO2XFrAlNpw7ITob4EtsxlhLCwgTGwgTolsAysSGEyi4rbKANLGBNMENkAWsiQ2sCW5VLGBNrMloU2EBb2IDb2LxAwWAN7GGjNCygDWx4VSKQ+cpFvAm1pMjRGcGxIk1ZBS3BbSJNWSIlgW0iTXktrYFtIk1NTOa4CEVS66/LTymYsn1t4XnVCw5ubSjkyrkksDCsyo2NBl+vAOeV7HkksDCEyuBNOmat76yJeiP8NCKZ0aITwNtZskwLQvPrVgyrM4CxsQGxgQPWbSAM7GOjKuzgDOxnhjJukBEpNsA1sQ6y1g/wJtYx0wrLeBNbOBNCOsHmBMbDrMQ1g9QJzZQJw4fF4A6sYE6waP8LKBOrCO3Si1gTmyIIyFqGXAnNmfmlhawJzY3jL0G9IkNp1wIew0IFBsIFMJeAwLFBgKFqGVAodi8YLoRIFFsXjLdCLAoNq+YbgRoFBsOvxDdCBApNhApePCjBUSKLejxB2gUW4Txh88+AJFiC278ASrFFtz4A1SKLbjxB8gUW3DjD9ApNtApeBikBXSKLcgVggV0ig10Sr7AQYDW85RJlmdPC3tlLLDKgE+xJTfVBISKLenDmYBQsZ4zwR0DoFMsfVbGAjLFlvQRTUCl2ECl5CiVYgGVYgOVktunRX2V1xAvaLdApeTuab4YxZlaQKXYEGLSxfpg9QtarqJnKoBMsRU9UwFUiq3omQogUix9hMYCIsUGIgWPXrWASLEVPVMBRIr1XAnxYaDVKnqeAmgUG2gUPH7WAhrF0jSKBTSKrcNYwy0a4FFs4FHwAFYLeBTryZKswB0jYFJsYFLwEFYLmBQbQk3wGFYLuBQbuBQ8iNUCLsXWZGy5BVyKDVwKHvBqAZdia3pNDrgU6+kSlPu2gElx9GkbB5gUt6APSAMexS3I+CAHeBQXeBQ8OtcBHsUtyAAhB3gUtyADhBxgUdyCHG0OsChuQY42BzgUtyBXcg5wKM7zJBkeH+wAieIy0j46QKG4jIxQdoBAcYFAKUr0oDwgUBx93sYB+sQF+gSPJXaAPnGBPsGDiR2gT1xGtxogT1xGnqN2gDpxgTopUYvjAHXi6Ps7HCBOHH2DhwO0iaODTRwgTRx9i4cDlIkLlAkeUO0AaeIMHVfuAGfi+ts8DLYQcIA0cSHaBL36wwHWxNHBJg6wJs7QcV0O0CYu0CYUXtBsdLyJA7SJo2kTB2gTZ+lmA7SJC7EmpcWCLBwgTpylzSOgTZwlj1w7QJs4SxJdDpAmztIDDZAmzoaBhl9lAWgTZ+mBBu/7CLQJHjLv4JUfjh5q8NIPR+5+O3jtBx1q4kb3fvgWw4P2Hbz7gw41cfDyD0fufjt4/YejXRq8AMSRRJeDV4A4kuhygCpxgSrBDyM4QJW4nFxoO0CUuJy+pwXQJC4nF2oOkCQup69qARSJCxQJfnLCAYrE5fR9LYAgcYEgKdHLLBwgSFxOBpY7QI+4nNzxdoAccQW54+0ANeICNVKhBLwD5IgryMW1A9SIC7eEoF0cECMuECNVhlYYIEZcQZ6TcoAWcQU9BQGkiCtoywgoERduC6nQpYkDpIijD9w4QIm4QIlU6PreAUrEBUqkws0zoERcoEQq3OYCUsSFKBP8/IIDtIgLUSb4AQYHiBEXokwq9DoYB6gRV9LjDRAjriS3bxygRVxJjzZAiriStpCAEnGBEqnweTEgRVxFW0hAiriKvC7RAVLEVfSUH5AiLpAiNT7gASniKnoeAkgRV5ELawdIEeeZj6zGJ7uAFnH0DSMOkCKuIhfWDpAirqZnjoAScfTBGwcIEUcfvHGADnGBDqlxMwLoEEefvHGADHE1bR8BFeJq2j4CKsTVtH0ERIgLREiN2zFAhbiato+ACskXzG1k4DqyBTlvzAEVktNUSA6okDxQIfhhmhxQITlNheSACskX9AWlgArJaSokB1RIvqAvJwNUSB7CSfADMjkgQ/IFfUMZoEJyz3fgAdU54ELywIWgYc85IENy+uqRHFAhOU2F5IAKyT3bgYc954AJyeljNzngQfIQRoKfKMoBE5KHMBJ8OZkDLiTPmIGWAy4kD1wI7nxzwIbkIYwEZ1lywIfkIYwE3z3IASOShzAS/MxUDjiRnA4jyQEjkocwEqLiACWSB0qEqDhAieSBEiEqDnAieeBEqIoD7WcqruJA+9H3neaAFMktbSgBKZJb+uJGQIrk4QhOjdcDoEVyy9zeCFqOPoCTA1Ikt7ShBKRIbsnJSA5IkTzcRIIfjMsBLZJbcjKSA1IkD5eghtNuzsByQZs5us0AKZLTpEgOSJHc0c4NkCJ5uAwVP2+XA1okd7RzA6RIHm5EJWoB0CJ5iCPBWe4cECO5I6f9OSBGckdO+3NAjOQ0MZLD21Hz4N7QGVwOb0iliZEc3pEazt8QVQavSQ0RJESVwatSc3qsjS5LpccavC41p8cavDDVsx8GP1CZw0tTw62pC4eaaXhvah5GW44FFOSAHskLco8mB/RITt9HkgNyJC9IQisH5EhOH8DJATmShztU8aOPOSBHcvoATg7IkZw+gJMDciQvSqZDAnokL0gSMgfkSE5fp5oDciQvSUIrB9RIHk7f4Mc/c0CN5HS0SA6IkbwkCa0c0CJ56ZgKA7RITt+umgNSJC/pm4kBKZKXzN3EoMXKMM5QHjQHtEhOX0eSA1ok98wHXmGAFMmrjKkwQIvkgRZZoNFOOSBG8oqkjnNAjOQVGeOTA1okr+j5P6BFcs99GPy0ag6Ikbwi99RyQIvkgRbBo2VzQIzknv2gZryAGsk9/2Ey9OaMHJAjOU2O5IAcyelbWHNAjuT0Paw5oEZyz38Y/HBtDsiRPFxLgp9BzQE9kteh5fD1PiBIcs+CmAz3P4AiyQNFgody5YAiyUO0SIbGGOaAJCkWpGcrAElS0PEiBSBJigXZcgUgSQr6bpICUCTFIrQcfpE4IEkK+nKSApAkBU2SFIAkKeh4kQKQJAUdL1IAiqRYhBZDDWoBSJKCjhcpAEdS0PEiBaBICs+DEJ2mACRJ4ZkQYsAXgCYpMtJKFoAlKTLSsxWAJSky+vUdwJEUWRhp6HqtABxJkdFXuwOGpMjCwXvUUBeAISlMeLcCXS4VgCEpPAmCxuoVgB8pPAViOh5szGMUgB8pPAli8MO1BWBICk+CGPxwbQEYkoK+q7UA/EjhKRCDn5gtAD9ShHdgDDqZLQA/UoQrSoiHBgA/UpjQeviYAwxJYUPr4V0IcCSFJ0IM8ZAAYEkKS1KTBeBICvrETQE4ksIGahLvbYAlKegTNwVgSQpLrgEKwJIUlr4srQAkSREeisGv9y8ATVIEmgS/j78ANElBX9paAJqkoK8pKQBNUtA0SQFokqJ/MwYfRYAmKWiapAA0SRFoEvywWAFoksKRy4ACkCQFTZIUgCQp6BtbC0CSFOGOEvzNgQLQJAV9ZWsBSJKCvqSkACRJkdMDDVAkBX1HSQEIkiI8JoOfUy0ARVLQd5QUgCIpQvQIHhJSAJKkyOlJCaBIipxcbBeAIClyktgq4NMyngMx+AHcAj4vQx+tKeADMyF6BI/zKOAjM3T8SAFfmSnoKQl8ZqagpySjd2boKQl8aSYQJPjh2AI+NsO8NgOfm/EsiMEPxxaAIilK2jYCiqQoadsICJKipG0jIEiKQJDg50ILQJEUgSJpl6/IEqgAFEkRIkfw0ywFIEkKz4QYhz5LVwCapCjJBXcBaJKipMcaIEkK+i2aApAkBX03SQFIkiKQJA73PYAkKSqS2CoARVLQsSMFoEiKiiSQC0CRFDRFUgCKpAgUicOnkIAiKWiKpAAUSVGRd9wVgCApKrrFAD1S1PTLW4AcKWpye60A5EjhGRCDH3QtAD1S1OT2WgHokaImn0crADlSeP4DvzC1ANxIEbgRh0aKF4AbKWraoQFmpKjpQQZ4kaKmHRpgRUpPfRj8TGcJeJFyQTq0EvAiJc2LlIAXKRfBOKIuogTMSBmYEfz1iRIwI+WCfp0LMCPlgn6fCzAjpac/DP6oRQm4kZK+j6QE3EgZuJEcPfFcAm6kzEiXVgJupMxIl1YCbqTMSJdWAmakDMxIji5OSsCMlBk53S8BM1J6+sO0Ds1VV+00CQiDVgsRJLj3KwE7UgZ2JM+x/cASsCNluLsVPx9ZAn6kpE/TlIAdKQM7QnweYEfKPn4E/zzAj5SBHyE+D/AjZeBH8AOVJeBHSvp53BKwI6XhWg/wI6XhWg/wI6XhWg/wI2XgR/BznSXgR0pDtx5gR0rLtR5gR0rLtR5gR0rLtR7gR0obWg+3mIAhKemjNSXgR0pLnjwsAT9SWmYqWQKGpLTkUrsEBElpyXiEEtAjJX0jSQnIkTK8pVugB/BLQI+U9I0kJaBHSvpoTQnokdKRU8kSkCMl/aZuCciRMpAj+MnhEpAjJf2wbgnIkdJxow3QI6VjTtSXgCApA0FSoKubEhAkZYgjKdDdoBJQJGV41QYniEtAkpThLhICM6BJytwytQGIkjIQJcQHAqKkzHPuA0H7BaoEv0aiBFRJGY7aUB8IWjDEk1AfCFow51oQECZlwbUgIEzKItwOii7jSkCZlJ4VMfjx6xJQJmWgTPBzyiUgTcoQV4I/ZFQC2qQMz/Pix4RLQJyUIbIEPyZcAuqkLMjlXAmIk7Igl3MlIE7Kgom9K+FbvZ4dMeUCHVLwvd4QXYKf0y3hm72eITH4y0clfLY3HLzBr0Qp4dO9gT7BXzQq4fO9niEx+FnOEj7hG+gT/IBmOXrG11tQ/HxkCV/yDXEm+EHCEr7m63kSU1Z4bYAWDJEmOL1aAhqlDDQKfuCtBDRKGWJN8Gd9SkCklJ4tMZV5mtsrV0Nh0IKeLzEVeptTCciUMryAU/kpmYUFgwYMbEqV4yhAA3rKxOCnvUrAp5SBT8FPe5WAUSnDWRz8ZZkScCplCDmp0LvqS8CqlJ46MfgBphLwKmXgVfCjRiXgVUpPnhj8TE4JmJWSvuy1BMxKGcJO8IdgSkCtlPRlryUgVspwQQl+ZLAE1Erp+RODH18pAblShqAT/EhICeiVKtArdfG0WFwBv1oBdqVahMbDH6EG/Eq1CI2Hv0MNGJYqMCx4HHcFGJbKkyh2gfahCjAsladRLB4bXQGOpaLvfK0Ax1J5GsUu0KsOKsCxVJ5IsXjobAVYlsoTKRZ/NaQCLEvlqRSLv8RRAZ6l8mSKXRTYJKoCTEvl6RSLh2JWgGupPJ1i8TDECnAtVeBa8IlfBdiWqmdb0IlfBdiWKivoiV8F2JYqsC34xK8CbEuVMfHMFWBbqiy0IOrSKsC3VJ5SsRn6WEEF+JbKUyo2Qy8orADfUhnmhqcK8C2Vp1QsHopXAb6l8qSKxUPxKsC4VIbcaq0A31IZMqahAmxLZUqmLwO2pfKEis3QxyMqwLZUhjyqXwG2paKvMKkA11LZ0HL4QAVcS0VfYlIBpqWyod3QSUAFmJaKZloqwLRUNNNSAaal8mSKzUrMhQCipfJsis0q5I2HCjAtlQ2thjsFwLVUltwEqgDXUnk6xeLBYhXgWipPqFg8WKwCbEtFsy0VYFsq+iKTCrAtladULP5oQwX4loq+yKQCbEvlKRVr0FlsBfiWylMq1jhsaV8BvqXylIo17TS2bWULPw+0nKdULB5XVgG+pcpD2+FeCfAtVR7arkJNK+BbKk+pWIMbbcC3VJ5SsXhcWQX4lspTKha/VbYCfEvlKRWL3ypbAb6lCnwL+ihbBeiWyjMq1qJ8aAXolsozKtbiBhPQLZVnVKxFw6crQLdUxYLpGoBuqTyjYm2Bel1At1SBbsEjYStAt1SBbsFjbCtAt1Q93YLSWhWgW6oiNCDeQwHdUhUk4VkBsqUKcSqoQQZkS1VUTIcDdEtVhNbDBwmgWyrPqFC9E9AtVbjnBO+dgG2pPKFC9U7AtlSlZXonYFuq0jG9E7AtlSdUqN4J2JbKEypU7wRsSxXYFqJ3AralCmwL0TsB21IFtoXonYBtqarQgLhPBWxL5QkV6/CpKWBbKk+oWDyCqAJsS+UJFetwlwbYlsoTKha/rb0CbEvlGRWLB9pUgG6pPKNi8eCVCtAtlWdULB7lUQG6pfKMisVvuK4A3VJ5RsXiIQ4VoFsqz6hYPBihAnRL5RkViwcjVIBuqWrDzAcA3VLVlun8gG6paseVDFqwzhlHDAiXiiZcKkC4VHXJzAYA4VLRr+tUgG6p6pqxtoBuqekzPjVgW2r6jE8NuJaajmWpAdNS02d8asCz1IFnwUntGvAsdeBZcFtRA56lpnmWGvAsdeBZ8Gu2a8Cz1IFnwUM+asCz1IFnyVFLUQOepQ48S45aihrwLHXgWfDQjBrwLHVGvotUA5alDixLjgZu1YBlqbPQethKqwYkS+15lLaO83xEyNSAY6kzuu0Aw1Jnoe3QkVwDhqX2JIot8A4EGJY6MCz4rnINGJbakC9a1YBfqQO/QtQw4FdqT6FY/J7rGvArNX0fSg3YldqQYX814FZqw8xXasCu1J5CsQV6S04N+JXakHF/NWBXak+gEL0HkCu1qZkuAeiV2nMoVJcABEtN3xFbA3qlpumVGtArdaBX8A3fGtArNU2v1IBeqS3XcIBgqQPBUqAHTGrAsNSBYSmKp3lxBRoDECx1OOuD7kzVgF+pbRhx+MgADEsdjvrYp66+MsbFsoBgqQPBgm9P14BgqR0ZGV0DgqV25BmEGhAsdSBY8E3vGhAsteNaDlAsdaBYuu3p8SypBhRLHSgWfHu6BhRLHSiWEqW6a0Cx1IFiKVGquwYUS+1ZFGI4A4alDhEt+K5pDRiWOtyNgnc3QLDUgWApHUbv1oBgqQPBUubo5wGCpQ4BLfgWaw0IljoP7YfOcmvAsNTh7A/e6wHBUgeCpSw7FIsCCoPmCwQLftltDQiWOhAsJd6ZAcFSB4IF30+vAcFSew4F525rwK/UhSWtEGBX6oLci60Bt1IX9FZ6DaiVuqDnKYBaqYuSsW2AXKnpV3VqQK3U4Y4UvEMAZqUu6UkK4FXqMjQabicAsVIHYgW/8bYGxEodiBXCqABipS7pdgO0Sh1oFWI0A1qlDrQKMTQArVIHWoUwQIBWqUvG3wFWpQ6sCmEmAKtSV4zJBKRK7XkTolMATqUOnAphtwGnUgdOhbCCgFOpA6dCGDbAqdSBU6nwZRXgVOrAqeC3G9eAU6kDp4LfblwDTqUOnAoe71IDTqUOnAoe71IDTqWu6VU5YFTqwKhUFdqVAaNSB0alC43BhEH7BUYFD42pAaNS05fK1oBPqQOfUmfYZTM14FNqT5rYGiV4a8Co1DVJSdeAT6nrsDJHfQcgVOpAqOB+BvAp2YJ+ZKdPi4R949UoD9WnRuLkdl6fFgmTxEqfFgn74YfH8/SpkXhoQnSY9KmROOn6+rRI2A/BGn3xvk+NxH1D1uiddX1qJO7bskZJtz51KB4uVFkgLd+nRcKhNdGZTp8aiZNrhz4tEiZXD31aJBzoTXRJ0KdG4r418XV4nxqJkzcG9GmRcEm6uD4xkvYn9hboArtPjcR9ZMQiw5xGnzoUN7RX7BMjadov9omRNDM0DWxMwwxNAxszvM+D3wzZp0bi/gQfHtrVp0bi/n4jPLirT43EyQjrPi0SrmjX1KdG4jXtnPrUoXi4mRaPNOtTI/EQa40GZvepkbjhrJCFLRruqMXthIUtah1nsixs0UDNUCbLwhYN5Ay+v9inRuLcALWwSS252OjTIuGaG80WNqgjVxx9WiSccUPfweZ0JKndp0XClrETDramI5cdfVoknDNGxcGmdIzfdLAhw+0s+N2efWokTh6z7dMiYfIthD5tKBxCYtDwqz4xks647prDhgxRMfjKrU+NxP2NjYsSHZg5bMrA29RPXXFVjGowh22ZB0tb4V0wh42ZB0tbE+KwOT1B4zKUqetTI3HvOTNiPOSwQcPzPxm6sO5Th+KepnEZuu7rUyNxPzjxyw771EicmQgVsEUDkUP0rgK2aMEEW/Spkbhv0gy9mapPjcQLpr8UsEWL0KLEAC1gi9JXu/RpkTAzQAvYmn3QDFEpJWzNcMFL95AftkgpYWuW5N5vnxYJkzeq9mmRMHnKs0+LhENTohxlnxqJk4FPfVokTK4z+7RIuGI6bAkbsmRi1/rUoXi14Nqmgk0ZAmjwpXefGokzTVnBpqQvx+3TImGmKSvYlOHdIDzutk+NxJmmrGBTBsKHqu8KNmZVsfUNW5O+CaZPGwrTd8H0aZEweRtMnxYJ+8UJHmDcp0bi5NZwnxYJh9B7jBzpEyNp8i7IPi0SJu9e7dMiYfKO6j4tEvbNiAdR96mReE3PwyABlHmSh5rdZ5ACykJUDR5M3adG4qEp8eVdBkmgbEE3ZQZJoGxB7vP3aZGwX5WgBFqfGEkXdC/JIAWU0Tfp9mmRcCCAcA4tgwRQ1hNAKKHYpw7FM3pQZpAAyjJ6UGaQ/snCw0P4Hap9aiTOtCQkgDL6Xt0+LRIm7/zp0yJh8tafPi0S9jMe/DrXPjUSp2c8GeR+shBxgweD9alDcUPTshmkfjJDhm70aZEwGbzRp0XC3kniZwv61EicZNX7tEg452oEMj+ZoWm8DPI+mQktie5e9KmReLCv+OQrg8xPFk444Vfo9qlDcfpNoj4tEmbGJGR9snDjLn6Mok+NxJkxCVmfzDLRi31qJE57ygxyPpmlPWUGGZ+Mfri5T4uEfUvitwX3qZE4eTNQnzYUduSbDn1aJOzHJH4PcJ8aidNT1wwSPpmjp64Z5Hsy+q6ZPi0S9rYVv5C4T43E6alrBgmfzNGrkAzSPZljViEZ5HsyxxpXyPhkgfEhlhUZpHwy+mbePi0Spon1DNI9GX07b58WCXtiHb9+uU+NxENTEs4M0j1ZTnN3GSR7skD2WJxtziDZkwWyx+KrkAySPVnOXJPXpw7FC5qHzSDVkwWqB7/et0+NxIOBJSw9JHsyz+c4PIi7T43EfYviRz761EicPJrYp0XC5FHgPi0S9u2JHyfpUyPxiv1M2J70U0d92lC4ZJwlpHqyknGWkOjJPJnj8GMwfWokzjhLSPVkJbeDmUGyJwvxPHhAap8aiYf4VSQYrE+LhJkNkgyyPVl4FBon+DPI9mSez3H44aA+dSge2B78eFCfGomTT0X0aZFwaE00AKdPjcTDyCwJcdie4a5f/ERRnxqJhy0vYg0NGZ/MszoOP4LUp0bi9CZmBhmfjL73t0+LhGuu20LGJwuMD34aqk+NxENkMr5Pn0HWJ6OfSOrTImFmzyuDpE8WLgImxgQkfTJP7Lgcvaq9T43Ew0YJvpWRQeIn8+SOy9GLT/rUSNzb2hw92NmnRuJ+hOboPRt96kDcLOhA8z4xkqbXmQYyP4Z+XLpPi4T98MSPB/WpkbgfnvgBoT41Eg8Nisan9qmRuG9Q/G7RPjUSDw2Kj2YD+R/jGR6H3yrSp0bi9ArFQPbHMOyPgeyPyehprYHsj6HvDe7TImHfmgU+Igxkf0wI/0Hdm4Hsj/EMD+4kDGR/TLjPBh/3BtI/xhM8VNGwGTPGcRrI/piMZmQN5H6M53ccfi6qT43E/ags8HmNgfyPCZE/+ImcPjUSp6dBBvI/JtxrQ0TQGMgAmcAAERE0BjJAJsT+4PdB9qmRuB+XXbeqrorFCDtsUOYUVp8YSTMNCgkgEy4VJrohZICMpadBBjJAJjBAhK8ykAEynuWhyoatGV6nJhybgQyQsczIhAyQCQwQ4QUN5ICMZYYm5ICM5VymgRyQsUxTQg7IhLeqCf9qIAtkHNOWkAMygQMiTAokgYxjmhKSQMYTPQ6/8LRPjcTplaaBJJBx9ErTQBLIOHZQQhrIuOAs0YfX+9RIPGyW4MSOgTyQyWmS3UAWyOTM5AeyQCZn3CVkgUwI+sGPz/WpkThNshvIApnAAlH1DVkgE4J+qPqGPJChX2vq0yJh8nmLPi0SJq/+7tOGwiHcp8TXJQZyQCZwQFSdQA7IBA6Ims1ADsgEDqjMMObSQArIBAqImg1CCsiEgJ+SMJuQBDKe6HH4Tbl9aiROLzQNJIEMfSNxnxYJ12yVwwYNJBBV5ZAGMiHih6hyyAOZwANRVQ55IBNCfqgqh0yQCUwQZYIgE2RKetvEQB7IlKE5iakbZIJMSV7K36dFwuQLeH1aJOybE78nuU8diodLc/C9dwNpIFOxwxMSQaaiT1X2iZF0aE1i5Qh5IFMxthayQKYir/zr0yLhgv1K2JYh7ofqVpAFMuGoFxE1YCAPZAIPRDUQbM5wgw5R45AFMjWzzIQckAkHvojgCANZIFPTG2EGkkCmpjfCDOSATOCA8Pu6+9RInN4IM5ABMvSxrz4tEq64fgL5HxP4H8pyQv7HLridMAsJILug29JCAsiG0B/81HWfGonTbWkhAWQXdFtaSP/YQP/gJ7r71EicbksLyR+7oNvSQurHLri2tJD6sYuamYxZSP7YjG1LSP9Yhv6xkP6xGb2raSH9YzN6V9NC8sd6gsfhJ+j71Ejcr0zQO/H6xEjaG9kKvVqqT43EvcOscFdvIQVkM2aP2kIKyAYKCOc6LOSAbOCA8CPDfWokTr5o06dFwobus5D/sYH/ISocEkA2HP6iKhwSQDYc/qIqHBJA1tAX5faJkXTJVDikf6whnyXq0yJhPzLxM9p96lA8BADhp7T71EjcT4AqfGvLQgrI0s9u92mRMDM2IQFkAwGEnwHvUyPx0JqEwYcUkLV0xIGFBJD1JA/VDSEDZC13yNZCBsiGg18V4SAgB2QDB4QfNO9TI3GaA7KQA7Lhgh70YJ6FFJANcUA1Tv5ZSALZQALVxGiDJJANsUD4ww19aiTOuE1IA1kmFshCEshytyH3qZG4b03ibLiFJJDNF1wlQhrI5tympoVEkM3pTU0LiSCbM5uaFvJANmc2NS0kgmwggmo85MBCIsh6qodYP1jIA9kQD0ScPrWQCbKBCarx/TgLuSAbDn8RB0otZINsQW+CWcgF2YKOILGQCbKBCSIOzFvIBNmC3jqxkAiyBR3MbiENZD3RQ7k2yAJZz/Pgb9v2iZE0zelZSALZgub0LCSBbEFzehZSQDa86I0/UtKnRuIZZ/EhB2QDB4Sfs7SQArIlfVraQgLIeoonxx9M6VMjcU8AEcflLaSAbKCAKBsOKSDraZ6cOF1vIQlkPdFDfShszvDQN3EU30ISyIY7fhY5ds1ynxqJMzNayAHZipkCQQrI0k9+92mRMLPQhASQrbhhCRkg6zkeytpDAshW9A6YhfSPreiLmvrESJreALOQ/LEhBojyI5D9sTUz+YHsj/X8DuV0IPlja3oDzELyx9aO81CQ/rE1vZdpIfljQwAQ5c4g/WNrpiUh/WMD/UP5Pkj/WObkl4XkjwvBP8QJfAfJH0e/Dd6nRcL0GtNB6sd5eocYNw5yP27hGEPiIPvjFsHA4q3jIPvjPMOTL/AKd5D/ceHo1wKfEjjIALn+8BfO0TjIALkFHTnrIP/jmOAfB9kfxxz9cpD9cZ7hyTPcFzvI/zjP8ZBVCBkgFw5/ZbjDdJABchm9N+0gAeSycJkaHpDiIAHkwoXLVE+EBJALMUD4m099aiROh3I5SAC5cOkygQTyPy5c/oM/KNWnRuKG64aQA3KG9pgOUkDOhObEpwUOUkDO0Kf5HCSAnKFP8znI/7hwAzP+YlSfGonTp/kcJIBcuPsHfz2rTx2Kh4uYqW4ICSAX3rqiGh8SQM6G4UnYcUgBOeYUmIMUkLP0ssRBAsgxZ8AcpH+cp3hy4mi6gwSQC9cy43dXOEgAOUuvSxykfxz9zHifNhQOVzMT9zQ4SP44+qnxPi0SDg1Z454N0j+uv/eHMMuQ/nGe4MmJQ+QO0j8u3NNM9VlI/7hwUzPVZyEB5DzJkxPHyB2kgJwLwXmEfYMUkAtxQPgDN33qUDxnhyekgFxOz2kdJIBczlxh2adG4vSk1kEGyOWhRQlTCykglzOeExJALmeHJ2SAXM4NT0gAOSYUyEH6x+XMJAiSP84TPMRYhuSP8wRPTpz3dpD+ccy9Pw6SP84TPORYhvSPC/SPI2apkAByBTs4IQPkCnZwQgrIBQqIOPXtIAnkijA48W0CB2kgV9BrFAdpIFfSF1o6SAI5lgRykARy4eYf4tS3gyyQYw6EOcgCuZLxm5ADctyrWX1qJM68Q9GnRuI0oecgA+SYK577xEjaD038qaE+dSgeKCCLnxt0kAJy4aZnnCBxkANyFRM96yAJ5JjbfxwkgRxDAjlIArlwFgzfpHSQBHIVc0LBQRLIMSSQgySQqyqucSAL5BgWyEEWyNVsS0IWyDEskIMskAvnwIhmhyyQY1ggB1kg53keqo9AEsgxJJCDJJDzNE9OXDzgIAnkamY/00EWyNXhsAnOjDnIArmaCTVwkAbKF8z9hzlkgfIQAmTxCK0c8kC553qIvYccEkG553py4oh7DpmgfEFH5+WQB8oXdHReDlmgPMQA4c2TQxIoDyQQ0Tw5JIFyT/MQzZNDDigPFwBRzQMbM1twzQNpoNxTPVTzQB4ozzjaIIc8UJ7RtEEOWaA8xAGhBjmHHFDueR7cIOeQA8rD/c/ERQg55IDy/8/Y3S5JciPpob6X+U2jJT7cHa47ONcgk41R0727NHHIEdkj0x7ZufdTCffMLrzE66M/O7l0r+yqQAQC8QQcaHwStKAASTUFSBCApHnZONiWxRpAggIkxRpAgv4jxRpAgvojoT/jPhoU9B8J/yHeKug/0mOF2fvgUVCApPNZBoICJLHHORklCwqQ5PrP5MJEA5IerXkfPgoakAy6R0LGjuToZe+sLChAkqs/X5++BAFIBh/7CAKQDL40lyAASQAQWRhCkIAkCGjep14IEpBs5ZF5f/cpaECynUfmvQxMUIGkUCBBBZJQILIQgqACSaFAggoks2pMRCCZsafhdTK2oAHJLFY/FCQgmdxmBQFIJl+fS5B/ZPI1nQTxRwJ/yDISgvgjkzO7IP1IlIAR5hCkH4mlgJ6rTtxumIg/ErN/7rvYZvRI50+YgvgjgT9kiQpB/JGY/3OvkRHUHwn9IStUCOqPCK80EcQfET7TUhB/JPCHLDkhyD9S8I8g/0jwj9yH7IL8I5t45L6TakaP9L0DxuNeKSoIQLKJR0jRqiAAiVYrjggCkGzikfterRk90osxEPKPFHOABPFHirWABPFHrGhNxB+xaE3SSyD+SOAPWUJCEH9kA8/HuUzSsTVjEpDcp+4LApDEJCCyhIQgAIlp+e3Ymht5Pvq+H+Tx5ydqQQKSWBJIySWHBiRhQPetZDP6OT0MiCxuIGhAUkwDEiQgWdWdEwlINvO0j+HE9WkGEUhW8YCCCCSLvwkTNCBZ/K2mIAHJZh4hqz0IIpBEIdjjjkCCCCRRCNbIAA4ZSIKB2ImIDCSbeuiJiBAkAUGsS0QJktz/i3SJaEESFkTWwRDEIHH+8kQQg6RYCVqQgsS5zwpKkDgv0xR0IPG4NEmXiBCkZTGYogTpg6OeogNp7LCu9+5WEYK0WAdakYG0WAdakYE0twK79hGKDqQP3pCKDKTFMtCKCKQP3pCKBqQxD4gs36CIQNr4o6YiAWnUgen9IVnRgDTmApHFChQNSGPLdXK4EYG0QCBFBNLG+1hFBNJiHWhFAtLNPELWE1BEIC3WgVY0IA0DIs+8igaknU/qUjQg7bykT9GAtMezyb2rV1QgDQUiD9+KCqShQOThW1GBtHPQUzQgjZWg7/s8Z/RI54NZRQPSrTx93jeaUTQg7Xw4qyhAWqwDrShAWqwDreg/GjOA7D6oUgQgLWYAKQKQjmKTIUUB0sHJQNF/dHAyUNQfLZaBVrQfDfshC18o2o8Wy0Ar2o/OR3FAkH50cpdVpB8tVoFWlB+dvJRPEX40Jv+QpSMU5Udj3y+ywIOi/WjYD1lVQVF/NCb/kOJ6Rf/RYusvRf3RYusvRf3RYgEgRfvRYgEgRfnRYgEgRffRqPsi748U5UeLBYAU3UeluCCRfVSKCxLRR6W4IBF9NNCHLAagyD4qxQWJ6KPK12VXRB+NHdvJXAtF9NHYs93u25opoo8qf+WlSD4a5EPWJVAkH92oI6RSXpF8NMjnvst5Ro/0fU3e9znP6JHO0UcRfbQo/FJEH83dvsjFgOyjudvXfQs0RfZR4xsrKqKPBvqQInxF9FErrkskHzX+OloRfDR2+yJUoQg+ukmHbTqoCD4a4EOq2RXBR2Pxn3vtnKL36Krulsg9Gmv/kD0KFcFHo+6L7FGoKD4ak37IHoWK4qMhPmSPQkXz0dz2iwwdUX00FgAiexQquo+G+5A1BBTdR1dxz0T10e069PRC9dEoAWOXHKqPxjLQ5AxA9NFAn/sm9Rk90ouhLJKPegEFCD4aKwCR0xzFR2Pfd3ZbQfPRMB+ysoKi+mjM/yErKyi6j4b7kPUMFN3Hog6MrGdg6D72qK5RQ/mxRy86I0P5sVgGiFzShvZjsRI0uaQN9cce1TVqyD/2qK5RQwCyWAmadBiGBGSbecTvd2hDBLJiJWhDArJYDIicj4YIZK26ixoikAUC+X2wYIhAVuwFZmhAFgZ0v+4MEchawXmGCmSxHhA7ddGBrFX3UUMHstwNnpy6KEEWu8GzUxclyEKC2MmFFmQxH4id6ahBFqtCszMdNchCg8jaIIYaZMW+YIYWZL1qUsQgi0Wh2ZmLGGRRFEYWBzHkIIspQffZFYYaZL1a5dLQg2xUFfGGImSxLBDZ8cLQhCyWBSI7XhiakMWkIHLZIQpZzAry+2jEUIVs8Jcnhipkg68nbKhCFmVhpIGQhWxUC7AZspANLxsI2zPWBWINhDJkIUOsgdCGbBZLVhjikE3+IGqIQzY5uxvSkE1OtYYwZAFDfh/NGcKQzWjN+z5ehjBkuUnYvfFRhmzrj7hdR7mGNmRhQ34fcxnqkAl/UW2oQya8Ot5Qh0xGdVBQh0yKKV6GPGSbgOhBQSCyAogMgciKWUGGQGTC34cZ8pDFrCCyEI8hEFnMCiJryRgSkWnRlAhEpkVTIg+Zlk2JQGTK514a8pAphz5DHDLlr8MMacg2/ijZB8CQhqzYCN6QhqzYCN6QhizmA5G1cgxpyGJ3MLL4jSEN2eYfJevZGOKQbf7RB7kFIg5ZbAb/uC9AYshDtgno4xZFvh3bcxOQPkhnhUBkFi1Krh8EIou1ocn6D4ZAZNuAlCzoYChEtvjbakMgstWqcxGByIod4Q15yIqaMEMcsqImzJCGbOOPtvvLU0MaspgQxAbjSENWVIUZwpCtaEtyliMN2SoeOhGGbNMP/TMRhqxYGdrQhcz5Ek+GKmTOX40ZqpDFutDtvqKRoQtZMRHIkIWsmAhkiEJWTAQyJCErJgIZgpB5XJGk80EQWg9+RS7koFVsCrYQg9aDX48LKWg9eCsuhKAVK0K3e4e5EILWI67Ie4e5EIJWsSb0QgZawUD3kfpCBVoxEajd1WChAq0tPUoWfVjoQGtLj5JFHxY60IplgciyDAsdaMWuYGRZhoUOtGJhaLJewUIJWht7lJTnL6SgVSwMtFCCVswHIiXuCyVobetRUuK+UIJW41PcFzrQatGi5FREB1rFjKCFCrQ6n0Wy0IBWVIWRbc0XGtAqdgZbKEBrK4+SguGFBrQ6fzu2kIBWLAt9B6OFArS28ei4L1G9UIBWLwriFwrQ2sbTV/9Bxo/T/5SObZkbg8k9HQVoZVXYtXx5IQCtKAoze375Q/+Ujs0ZK0OP+817oQCtEQ16n+C1UIDWVh59rshyTccm3c6jpGZzoQKtmBtE9qNeyEBrQ4+Oe4niQgZaURk27uuZLWSgtaFHx33K9UIGWht6lMzDW8hAa0uPkvmDCx1oxSQhMm1voQSt2CyeTNtbaEErLIiUwS3UoFUsEb3QglaxRPRCCVobe/jvjS06vToBkIKWPKrTCylobe6h5wti0IqpQux8QQ5asWc8O1+Qg5bM6nxBD1oi1fmCHrQKD1roQSsmDJE6voUitEKEJrlFowmtWCX6fl9EEVpFndhCD1qxRjSp4lsoQqtYJmihCK0QoY8h0Y2YF4rQ0mhNMlZAE1rKp0gvNKGl/FlloQkt5ZO/ForQ0mhJMrBAE1rKnzkXmtCK6ULsAKIJrTAhUk+40ISWFc8rKELLuB8s9KBl3A8WatAKDSKVigs1aFnRz6IFrbAgUta40IKWFUNblKBlxTWJDrRWcU2iA61wICFPHuhAaxXXJDrQKhxooQOtxY12oQOtxd+dLFSgFQpEajYXKtAqdolfqEArFIgUSy5UoLX4NPeFCrS8eEBBA1pePKCgAa3tPCrkPowKtIq5QQsVaDl/B7bQgJYX/Soa0HJu7QsNaHlcjeRegwq0nFv7QgVaoUBCxiWoQP4Izbu7mKMD+aOSWUcJ8tgeXu6jHkcL8rAgUpTqqEEeGkSKUh01yEODSFGqowb5Fp9BBniOHuSbfJSUbDqCkAcIkcJERxDyACFS5OcIQh4gRArxHEHIG38X5shB3vi7MEcM8sAgUtPmiEEeq0TfVwVztCCPBYL0Pk5y1CAPDSJFbY4a5KFBpD7MUYN8i4+SeiVHD/LwIFLM4+hBvs1HSamLowh5iBApBHE0IQ8TIoUgjibk232UFII4qpCHCpFCEEcV8qgSI0UEji7kxVpBjizkvViQzVGFvEeT+nXWkSMLeSwXTWbjObKQD17Q4IhCPvhbFEcT8mKvMEcR8mKvMEcP8vAgUp3g6EFezAhy1CAPDSKvLxw1yEODyDDBUYM8NIgUSjhqkBe1Yo4W5LNoSZQgDwkiu+E5SpCHBK27eThKkIcErbvAOUqQTz6udXQgLxYKclQgn3w85KhAHgsFkWnvjg7kUSpGrmJkIJ/VKu6ODOQbenp8+ez4uyADeTDQcxu/j/Q//aXIQB4MxLoUZCCPWUGsS0EG8mAgMuHckYG8WCraEYFc+IQ9RwTyzTz8IGKDBgKRme+OCOSxbTw95tiiwUDsmCMEeVk75ghBrhwPHCHIlT90OjKQK8cDRwTyDT26yEgbGchjapDft0d3hCBXPvnAEYI8IIjMeHeEIC8gyBGCPCYHsT8TIcituG0iA7kVt01kILfitokM5MFA5JnMEYLciusSGciNg54jA3mxSrQjAnmxWbwjAnlMByLFAo4M5MV0IEcG8mAgsl+4IwN5MR3IkYG8YCBHBvJiOpAjA3kwEJmE7ghBvopxLDKQL6u6NIQgX9Xemo4Q5AUEOUKQFxDkCEFeQJAjBHlAEJl+7ghB7sUaiY4S5CFBZJK4owV5WBCZJO6oQR4aRDYic/QgDw9yct9GD/LCgxw9yJ3PvXTQoI8b9oMewwwe2Y0fw4we6Z0fw4we6YMfw4we6XQom7EjmQ5lM3Yk06Fsxo7kaMrrUCajRzptyowdybQpM/Y5OQjoPns6o0f6bstxXSIzo0f6s7XsPtk6o0f62OnXIUFGj/SiLRu2ZSjQfR5lRo90er/M2JFMX4Bl7Ehe+4+83gIzeqTTcU/GPidv4bHH9RaY0SO9uGNm9EiP1ryuYpnRIz1a89oxZ/RILyZFZ/RIl/3tV13K6JGuO/3ad2b0SLedvu6dUMc23chzHfhm7Egurs+OLToe1S8ysEUHXYctY0fyJtpnudyfKxAyeqTT3RUydiTP/Xtfhx4ZPdLp9goZO5J3Wz6LJa/HBNty0KeSjB3J++ps11XwM3qk040yMvY5eSOPPcswb989sS35XvEZO5L3tdmu+8Bk9Egv2nJiW27isfs08Ywe6fS5JGNHslbn98S23Mhj9338Mnqkr+oMn9iaW3noSTuxPeVRnYeC7bmVh55agi0qvTpbBFt0Kw89AQTbVKJNSfcp2KbcgDJ2JFMDytiRXPa0gi0qZYsKtqiULSrYolq2qGKLatmiii2qZYsqtqiWLarYouFA7Gau2KIq1c1csU239ZAOQ7FNNa5ScrNVbFONPpcMhhXbdGuPNTJkVWzTrT12nySf0SN9t+l9knxGj/TdpvdJ8hk90uk0hIwdybO6NAxbNFYRYpeGYYuaVpeGYZuaVZeGYZtaeR81bFPz6tIwbNP1qC6NhW26ok2vr0UzeqTTCUIZO5IH7+wWtuia1UW3sEW3/ti9RiKjRzq1oYwdyXRKbcaO5FWdiQtbc+sPPRMXtqY/qjPRsTW9VWeiY2t6r85Ex/b0UZ2Jji3qszoTHVvUo0XJ+MWxRb1oUccW3QBk9zKWjB7pu03vZSwZPdK9OnWRiNojet17n97QiNojrtB7n97QiNqDX6ENhag96PIHGTuS6dSvjB3JdApfxo7k3d+O+32ooRC1B53Cl7EjebflfcO5jB7pVG4z9jmZbyWfsSOZym3GjuR9Zd6rTDJ6pPN7Z0Mbanz16IwdyXQKX8aOZO58DWWobf2xcb/zNLShFjY05rU3aWhDbfuP3StjMvo5PXTovnlXRo90Ot0rY0dytOW9N2loQy3qxdZd4xraUNv6Y/fttTJ6pBftiTLUOpe+hi7UOpe+hirUerQm6dTQhVrn0tfQhdqICZnXStGMHum7f52k80EZalEu9iR7/RHPQnShtu3HJul8UIZaytD9OaWhDLXB9yrK4JG9O9l7yUpGj/SYgHDdmDmjR/p++LzPV8jokb4vz0kufuShNunLzowdyY0O3xriUAscYocccahtAGKHHHWohQ6xQ4461LYA0UOOPtS2ANFDjj7UYtGg+4mLOtS2/9i9Yi2jR3o0J+ltUYda6NC9ZCmjR3pcoaQDRR1qoUNzPf/QB76Da6hDLXToXnWT0SN9t+m9MiajR7rwo4461IRLQkMdaqFD92KXjB7pe02vda3nzeiR7sXvje259Yf83ihDLWRIrgsXZ/RIpysRZ+xI3m153wono0f65H8kqlBT7vANTaht97F7UUpGj/TYeuq64FFGj/T9zlPuj3kNVaiFCsl17b+Mfk6PUrH7UUETasYlvqEItRCh+2ZiGT3Si1EtilALEWJ/JIpQ2+Zj9wKSjB7pWhwTbM3wICFDMvSgZvwNdkMNaqFB93qQjH5OX8WViRbUwoL0OqUto0f6bk0lPQpqUNviQw4halALDWKdBGpQCw26F6Zk9EjndtBQg9qy6sRCD2rhQfcqlowe6UU/ixrUQoPuJS8ZPdKLpxS0oBYLSjcy+EALal60JkpQ87I1UYJaSNC9VCejR3rRmihBzbntNXSgFosH3WeaZ/RIj2dOlg6t2aNw7D4xPaNHelyd986zowP1cKDrFO8MHtm8OTtCUN/YY/eSpIwe6XwI1JGC+oMPgTpCUN/YY/fypYwe6as4xTtSUI+FpB+3mVwdKai3AIQ7T3TEoB6Tha5rH2XwyI41aq8rpmb0SN+joHuZVkaP9N2c9zKtjB7p/H1nRxHqjb/v7ChCPUSIjN46ilCPerF7pUZGj/RqFNRRhHovqhgyeqTvBl2kidCEepjQvdYto0c6Hwl1FKHe6fL9GTuSpfwzsT1jrhA7iGhCfbsPPyrYoqFC95K+jB7pXn47tujgY6GOKtRDhe7lghk90ndvK7d6igwe2VsRyEFEFerbfdqTBa5fji0a84XuL2k6qlCPVaQf9/dRHVWob/exe1lkRo90PrTtaEJ98MlfHUWohwiRA44k1GMNaXLA0YT67NUBRxPqMWGIHHA0ob7Vhx5wNKE+udd2FKEeM4buVagZPdLpwsMZO5JpLUPGjuTd197rWzP6OT086F7fmtEjPeqLrmuZZPRIj76WjBLQg3p40H27qYwe6fvueS/ozOiRvse29yrKjB7pfGzbUYS68LFtRw/qW3zsvpFVRo/0WBrzjuodRajHbCE2tkUT6mFC962VMnqk7xa9Vztm9Egv7p5oQl2LuyeaUI+ZQvddeDJ6pMcy79dVxDN6pO/2JK/nO6pQV7rkTMaO5H2FruvSXhn9nG78TWdHE+rG33R2NKEeJnSvXMzokb7bUu5vxzqqUN/uQ/YpzeiRHu1Jrn1Uoc4XEMrYkVz0tmhCnS8flLEjme4bl7HPyTE/6L6LUUaP9H1l3ksRM3qk79a8F7Fl9Ejffe19f5SMHum7r70XhGX0SJeqE0IV6qt49EQV6qFC99KqjB7p8XrsPkWkowr1WE6aneXoQn3LDz3L0YV6zBK67zaR0SOdzyjp6ELdaTVgxo5kXqXSUYW68xklHU2ob/exez1YRo/07e++rkDV0YW6x0xbvQ9A0IV6FJDpnes7utB4PIoR4kAXGuFCpF5qoAuNYn7QQBYaDz6DbyALjQ0/7CAOZKHxkOIgDoShsfGHHcSBNDQeVh5Ew3Te3w6EobHxx0hh2EAaGht/Fqn0GkhDo9GFwjN2JHd6UQx0obHlZ5EasoEuNBrdjSpjRzKvBxyoQqPR5TAzdiTzeSUDTWhs9VmkgmygCY2oILs/RQ4koRFLSt+fIgeK0Ig5QuQpcqAIjW0+9IRFERo92vJ+5xxoQoPvLJaxI5muKp2xI1mLQ4ggNAKE2CHE1uyrPITYmlE9Rg8hNmfsK3Y/sdCDRlSP3Xc9yeiRTldCyNiRTFdCyNiRPPcvch94DNSgERpESgcHctDY4LNILeBADhpRP3bfTyWjRzrnoIEcNAZdFDNjn5Nn0ZaoQWPy55OBGDQ296z7HjAZPdL5s+ZACxqTP2sOlKAxiy2oMnqkF30sStAoJGigBI1CggZK0NjWs+574mT0c7rwiV4DHWhUKwdl9EjfLXnfGTKjR/ruYRu5laADDb7bfMaO5H1VNtJ7owKNmBdEf3NszW09ixQlDpSgIcVViQ40JNqTdD/oQEOL6xIVaGznWaTwbqACDS36WDSgoUUfiwY0tvMsUqQ1UIGG8jdiAw1o8OWjM3Yk09VmMnYkF9cl+s/QaEfSc6P/DCuuS/SfsY2HvVMaKEBjGw9ZXiyjR3pcl6RDRgEaxme7D/SfYVzbB+rPsPKqRP8ZVoxj0X/GNp5FKvMGCtAwL38VbM1iVtBAARrbeBap+hsoQKOoEBvoP2MLT7Nx78HRf0bsND/vD5jIP2PFizDSgSP/jOAfUgk3EIDGKi5N5J+xgYechIg/Y3HOG0g/Y+PO6veX4APpZxRTggbCz9i4w78bG9N54fxA+hkF/Qykn+HFwyXSz+DrSGfsSN63SlJ0NhB+Bl83KGNH8n4cGdeFoTP6KX0++K1yIvpMvptYxo5kjgQTyWc+4m3m/SY8EX3mgw97JpLPfMQVeb+vTiSfuVFHntNeLk+LE8lnPqIt77e0ieQzi4WDJpLP3KizSBHeRPKZQT6koG0i+czNOmvcu++J6DP5+tEZO5J3e457LzgRfeaGnUWqsiayzyzYZyL7zIJ9JrLP3LSzxn0QOxF+ZuODn4nsM7fsLFIcNtF9ZueDn4nsM3u0Jbl+kH1mp0vtZexI5rg+kXxmp0vtZexI3lcmqVGbiD6TLxmdsSO5WMo0o0f6vi7VrsPBiegzO2eCieQzC/KZSD5zcCaYCD5zo84iZXgTyWcOzgQTyWeOWR1AJJ8Za0azA4jkMwd/IJkIPnPwUc9E7pmjuCaRe2YsF0QqAieCzywqwiaCz5zF3RLBZ87iikTumZM/Vk7knrlJZ5FKw4ngM4vFgiZyz5xFKyL3zFm0InLPLLhnIvfM4B5S8DiRe2bBPRO5Z8a0n+v+hRk8srcOXGfvTrSeKbwOfqL0TOFPlBOlZwp/aznReWY4zyT3anSeKbwOfqLyzC059OhhO27IaR+/yQ0bJzLPVD49ZCLzTKVLCmfsSC7Grog8c0POIlWlE5lnajF2ReSZfI+wjB3JxdWIyDP5HmEZO5I3DJDCzInMM4N5SGHmROaZm3IWmWg+EXpmFH+RwsyJ0DON08BE5pl8l7CMHcn8aXIi8kwrLklEnhnIc99JLqNH+h61kmLSicwzN+R011s58UTlmaE8cq/Pmqg8c0tOt8cVVyY6zwznEfIQgs4zt+Usuc85mSg9c1vOknud9UTpmRtzltypZyL1zKAeEZKOjRrU89z54pqOjRobx8t9ZdeJ2DM36Cy5z4OYyD1zRas6ScdWDfC57/CU0SOdg89E8JlePFgi98zgHr3umJnRIz1msV/vxwg+c6POUnJyIfnMzTpL79OlJqLPDPTR+2SsiegzvbpIUX2mF5tlZPRTujyiOe9nrqD7yLadpfczV1B+ZOvO0vuZK2g/Evaj63pgBO1Htu8svZ+5gvojoT92774E9UeiEszu5aWC+iOhP3Y/ZQT1R7bwLFLfIeg/8uALkAjqjzS6m03GjuR9gd7nKArSj7ROryJB+pGNO2Pc7+aC9CMbd8bzfnFNx+Ys6EeQfqSgH0H6kWLGjyD8SMz4IRUpgvQjxZrRgvAjG3cWqacQpB/pfGArCD/S+dtLQfiRzh8zBeFHNu4sUnwhSD/S+WOmIPxI5/V8gvAjPS7J+xxzQfiRzufgCbKPFOwjyD4SKwLdvxnZR2KmDykXEYQfCfghQ2ZB+JFYKZrMxxGkH4nZPqQYRZB+hG8XlrEjmT+kCMKPFPAjCD9SwI8g/EjADymgEYQfKeBHEH6kWApIEH5k4w7Z4yOjR/o2AzIfRxB/ZMb451qPLWg/wncKy9iRXHSuaD8yi84V7Ue27yxSrSSoPzKLzhXtR6S4S6L9iBRbSmX0SO9Vz4P8IwX/CPKPbOJZpHBKEIBEipZEABLh7y4F+Udims8iQxgEIJFoS3KjRAGSmOhDaqwEBUi0uCxRgGQrT/84hDJ+/BgSYzq2ZiwBROp8BRVItvP0jz90rh/Hn74cmzPqvT7+zvvvgs25qad/3B1uc0wFIUii4mv8MP3H3idmY4vGJmHLyB+KLRoWtNb1/aigBUlY0LqX8AlakMQyQB/X0MeBeSj+7mhBEhbkZPSIFiTbe5bfa9sENUhi0o+T0T16kGzzWT6uxQKCIiRbfZbfHwgFTUjChPy+DY+gCUmYkN+nKQqakMTUn4/7yv3bsVUDhZycBIhCElN/SO2CIArJZh8ntQuCKCSbfcijsqAJSZoQeTpFE5KtPsyzBE1I0oTuniVoQpImRM4wNCFJE7p7lqAJSZrQ3bMETUjShIgKoAlJmBDxLEETEg/pIw/iqEIS04CIZwm6kIQLEc8SdCHZ9uOkKEVQhsSLES66kHjxtIIqJKlC5ARAFZJKhQRVSEoVElQhLVVIUYW0VCFFFdJShRRVSEsVUlQhLVVIUYW0VCFFFdJShRRVSEOFiAwqqpCmCt3PAUUV0pgVRCBR0YV024+T4iRFGdIWfe99fKdIQ9r4QomKNKQbf5yUsyjSkLa4SO+DQUUa0saXSlSkId384+SJWBGHdAMQue4UdUi3/zipZ1HUId0C5KSeRdGHtEeD3m+mij6k24Cc1EIoCpF2/rpMUYh0KxA7LEhEuhGIdUeKRKQxO4h1R4hE2rXqjpCJNJiIdUfIRBobirHuCKFIuxfduiIVaSwSxHovxCJNLCK9F2KRBhax3guxSAOLWO+FWKSJReRPRSzSKA1jvRdykW4S8na/USuCkQ4+OUERjDRWj77eqBXBSDcJMXhRBCPdKMToQJGMdHLEVSQjnRxxFcFIi7lCilykW4ScVB8pepFuE2KlUIpipDPa8v7WQdGMdLuQt/tEcEU10lnN4FNUI90y5KSkSNGNtJgzpOhGWpaIKbqRbhmixwXdSLcN0eOCcqRRIsaOC8qRFnKkKEcq3AAV5UiFG6CiG+mWISdVWYpupMINUFGNVLkBKqqRVtvKZ/RI3/P4nveJ29FGNdJKjRTVSFON7o9/imqkpRopqpHG9CEhPTOykUaV2B2ZFNVINdqTDIlQjVTj6iRDIlQj3S7kpDpLUY10u5CTOidFNdJiBpGiGanxxSsUxUi3CdGTC8VIrSrGVRQj3Sbkndz3UYyUbzKfsSOZ1xYpapEWSwUpWpFuDXJSQKVoRbo1iPmMohVpZUWKVqRpRXfNUbQizflDZCiEVqRpReRyRivStKK75ihakaYVkeEzWpGmFZHhM1qRphWR4TNakaYVkRErWpGmFd3xR9GKNK2IDJ/RinRrkJOaO0UrUp9FH41UpF48hSIVaVAR69ARizSwiHw3NmhQEev90Yp0axD7bmhOezyKW4WhFNmDL9dv6EQW283f7yuGTGQPXv5niES2GcjJ9n2GSGSbgZgRGCKRxVpBpCcyRCLbDOT9fn0aIpFtBnJSIWeIRLYZyEnRmyESWZSOkcdbQySyVjQoEpEFEZFnYUMksla0KBKRReEYeVY1JCIriMiQiKwF+rHfG9uz8YvTUIgs5g+Rp2BDIbLGL05DH7LwIVKRaOhDVuwqZqhDFjpEZugb+pD16Gnv4zJDILLOJ1Qb8pB1/qBiiEPW+StuQxqyjT9O6igNach6tS+KIQ1Z0BCZumNIQ7bxx8lOgoY0ZKNoTYQhK9YLMmQhG3y6giEK2eBlgIYkZBt9nBSLGpKQxWpBZFBmSEIWqwWx440oZBt+nJSiGrKQjVjLa/4gjx+nYOMjC9mM1iR3IGQhm0VrIgtZwUKGLGSzaE1kIZtFayIK2YzWvMOKIQpZoBC7DSIK2WYf2gEhClmg0H2dMEMTsphJRFb+MjQhk1gF4foO3BCFrJxMZIhCFig0yOADUcgChUgprSEKWbFukCEJmfCV2QxJyKRsT0Qhk7I9kYVMqvZEFTIp2xNdyLRqT4QhK2HIEIZMy/ZEGDItrk90Idvy46QM2NCFTIs7J6qQaXHnRBMyjTsnud8jCpnyxRAMSciUL9RvCEJmFb8bgpAZ53dDDjIr+lnkIDPO74YcZDGBiBS3GHKQGZ+VYIhBZnzerSEFWUFBhhRkxufdGlKQbe5xUo1siEG2OLsbUpAFBd1tx1CCbGMPKU01lCBbvDDQ0IFsFeNYVCBbvDDQ0IBsK4+TSmdDA7KtPGT6ryEB2UYexouGBGQrmpL0l0hAtpHH5/0thyEB2UYeJyWnhgRkxXLRhgBkAUCT3KMQgCxWDWLHBQXItvLQ44IGZB5Neoc3QwOy7Tw+7/BmqEC2ncfnXdIMFci29JAzFxVoPXj99UIDWg++rsVCA1qbeZwUtC5EoPXg61osRKAVaweREcdCBFqxYDRZ3nUhAq0H72YXEtB68G52IQCtB+9mF/LPCv4h+8Uu5J/VeDe7EH9WsVT0QvxZrReX2kL8Wa0qb1jIPytmCJFLbSH/rCbFpbYQgFbMESKX2kIAWs2KS20hAa3GC48WAtBq/A3KQgBaAUBkj96FALQKAFoIQKvzYt2F/LOCf+T+YL+Qf1YvilUW+s+KCjKyit9CAVq9Wsl9oQGtWD5INvqrNkzHxuz8ddhCAVqdd7IL/WeF/8jdIxb6zyqWD1roP2sbj5P9ghcK0BrVuokLDWiNqjkRgdao3m0uRKAV84LYlY8ItIYVg4+FCLQCgeRuGAsRaA0++2AhAa0oJWNHEQloFasILSSgNcveFhFolcVkCxlozbK3RQhas+xtEYLWLHtbhKA1y94WIWjNordFB1qz6G1RgZbEBXp/MbOQgZYU7YkItITPrl1IQCsISO4TfRYS0IqKMvLd2JabeVzu01oWItAqtpRfSEBrI4+Lk+/GloyKMvLd2JLbePzZ61+/G9uy2FJ+IQCtTTz+8bR+/W4EoFVsKb+Qf9YmHn++M/tzyf1C/1laNCXqz9rC4zqupWcL/Wdp0ZToPyv8h2wVvdB/VuE/C/1nxZQgsj/zQgFaMSWItTwK0DJes7tQgNZWHte75S00oFUsKrTQgNZWHnoVowEtKy9MVKAVU4LYtYYOtMyqUxwlaG3tYWctUtAKCmInIlLQinlBeq+uXYhBK2rIdJF0bNIVTXrf4X4hB61NPv6cgX1Nx0bd6ONk492FJLQWB9qFJLSKDcQWgtBaVp1dKEJrFX0tetAKD2KnInrQ8qKvRQ1aoUHsvEUNWl70tahBKzSI9RSoQcuLzhYtaIUFsQsILWh50ZYoQSskiFxtCEHLi6ZEBlpeXpoIQf7gTekIQb6xx8l2y44U5MXOYY4Q5MXOYY4Q5DEbiPTijhDkD35ROjKQP7S4zhwhyGMuELl0HCnIYy4QuRocMcgf1SDIEYM8CsbIOevIQR4FY/fT0NGDPDyInFmOHuRRMUY6fUcP8vAgsr6Sowd5eBBZxcfRgzw8iNxSHD3Iw4PIOj6OHuRRNEYW0HEUIY+iMbJ7saMJeZgQWV/G0YQ8isbI7dBRhXzLD7sdOrqQhwuR9WUcXciLbcQcWcg3/DhZ2MWRhbxrdW0gC3mvBkSOLOSbfpysZOIIQ77xx8kbaEca8sH93RGGfLSqR0Ia8qQh0iMhDfkonlccZcjHrPovpCEf1ROLIw150BBZocSRhrwoGXOEId/083x3YD9+DCQwG9sz9pYnS2g7ypDP4jaKLuTbfthCGY4y5MXkIEcX8llJgqMLebgQO1fQhTxciLU+upDP8gpFF/JZXqHoQj6LRxZHGPJZjYscaciDhsjiN4405Jt/nCx+44hDHjOEyDbgjjzkwUOL3DCQh3wTkJMdsh2ByIXPRXDkIY85QqyfQyDyACJ2BiAQeZSOsTMAiciFr+nmCESuj+rKQCLyICJ2ZSARecwRIicjGpGHEbHrCJHIY5IQO3eRiTyYiGxK7shErnxvBkcm8thi/j5MRyTyqBwjW4c7MpFvCGI9NCqRhxKRjcYdlcitKux0dCIvZgo5KpFb2emiE7mVnS46kVvZ6aITeTgRu4bQidzKKxSdyCsncnQiL53I0Yk8nIhsBu/oRL54KYOjEvmK5f3t+osjEnkgkd9fOjkikQcSkX3mHZHINwQ52QvekYk8Zg6R7dcdocgDishW5o5Q5CsuUnK3QCryoCKyHpQjFfnmoPYgC0I5apHH8tMPsryPIxd5TB56kDVSHMXItwl95JMhJpKR5yrUZOETRzXyWG7oQVY+cWQj96LzRTby2HV+3F/LObqRxwQidmmjHHnKEek4QI7G4/HgI4GMHun05VnGjuTOO9SMHumDd6gZPdIn7cMyeGQX3W9Gj3TlXV5Gj/Sc5ne9uDN85K/IN3LYF+bHPOrH9WVrhj/nt7xerwWZGT7y43pt1/LQDB/5cb3eVwXJ8JFP54dl7Egu1kvI6JEu5bFs2LSbifixbNi2zepjiW3bVn0ssW1jaeqPY3a7S2X4c35sS/a47yKc4SOfzi7K2JGcDXtd2yLDR/4oD37Hts0ZRu26O2KGj/zY1Iocy45t27X+dbBtu5XnQse2zZ3p2bnQsW27l+dCx7Ydj/JcGNi2g46dMnYk9+q6Gti0MdmIngoDm3bQ1zIZO5Lri3Zgww76XiZjR7KVJ9nAVh30zUzGjuRsUtLVD2xSvnB1xo7k7IdJG01s0pmXK7lnTmzTmW3qlxn6GT3S6ZZXGTuS6U5JGTuSaVFLxo7kaM/7ciEZPvLprIaMHcm0qiVjn5NjEaLHfVfkDB/5xXBJsDGF7kCXsSM5WvK+SkeGj/zoeO9rLmT4yI8L9F6qn+EjP3re+5a6GT7ys03JZSTYplF39rjX02f4yI/L9F6EneHP+Zote30iyvCRH1fqvUY5w0c+3dAsY0dyNO695jjDR/4uDx3XdWYyeqRH297rfTN85Efb3ktyM3zkR9vei2wzfORH294rVjN85Efb3jdbzfDnfL6LfcaO5F2Jdt99OKNH+p6Ova4Vjhk90nc1Wrsuxp3RI73ogA2ble9in7EjueiADRvUskHJxWfYoFZ0wIatadwLM/g5e/PRxz39egNb2JhRkMZaZ2FjLsqFGTuSaYFoxo7k6H7vFaIZPvLzEiXd0cLmXHGJ3sv6MnzkWznQWNiia5UDjYWNurwaaCxsVac7tWTsSI6u916Dl+Ejn05gydiRHF3vfTPODB/5s/pDHduVb2mfsSOZLu6XsSOZLu6XsSM5mvO+ZWaGj/xoznsxYIY/5bdH3E3vG1Bm+MjPJr336A1lqcWcpMd9C8oMH/nZqvfLr6EttShRe9zr3zJ85Mflei/3yvCRH5frvUIow0d+XK73Qp4MH/nRvveilQwf+bR+ImOfkxOX7lUrGT7yo3HvxRwZPvKjce8T+jN85HNcaohLbfMRuX80tKXGNzvL2JHML9eGqtRSlYScwahKLVVJyBmMqtR4vVrGPicnKQk53ZGUWkFKDUmp8a3uM3Ykx4V63+cyw0f+rO5jDT2phSex+1hDUGoJSvfuvaEntQ1G5HxBTGqd1pNm7EiOHlhJj4GS1AYf8zZkpDbo6gsZO5J7ecjRkdrLkcghR0dqo7qjNpSkNopLFBmpDT7qbchILRlJSaeLjNRGXKJ6fd2Y4SM/m/QObA0lqYUkPfTOWg0xqc1q8NvQklpakpJuFy2pzaLbRUlqs+p2kZLalPJIoia1qeWRRFBqCUr0SGLLbjTiRxIbdtLy0ox9Tk5SYpcTklKTVl5OqEpNenU5oSs1oaUyGTuS6bJUGTuSs1HJHQ9FqQl9p5qxI5kW8mfsSF71Icf2TEuihxybNC2JHHKkpKYcCRs6UiscqaEjtXQkJYMGdKSmdJ5vxo5kKS5pNKSmxeAIAalp+XTaEJCalk+nDQGpafV02tCPmtFpvhk7kmn9d8aO5OxzycAL+ahZ0eciHjWji+Bk7EgubqOIR63Ao4Z41BKPjAzpEI9agUcN8ahZtOS9sCvDn/O3EJFjgnrUVvk2piEftVW+jWkoSG1Vb2MaGlJbHAMbAlLjixpl7EiO++e9JCjDRz6dsZ2xIzkuzntNSIaP/OLuiXDUvL57oh01r++eaEfNy7sn6lHz4u6JdNS8uHsiHLWckXQvlcnwkb+b9LlG559Xzcnokb5b9L6EakaP9GejfTxIXl84NOSjlnx0r8TJ8Kf8/uAPLx3tqBdTkjrCUX/wh9GOatQfdOm4jB3J8dhyLx/K8JFP52tn7EiuHkM7clF/8MfQjlbUH3RhhowdyZwVOkJRTyi6l0hl+MjnrNBRiXoqkV1XzM7wkR+drd1fvXSEor4t6L46XQaP7L1I1XWJ+gwe2bHq/HUj3Iwe6Xu29n2v2owe6btBr+u3Z/DI3lsU3stYMvo5PanoXt6V4SO/aFOkop6zj+7lWhk+8kf1uyMW9cQidsogFvXEInbKIBb1zUHslEEr6rHAETllEIt6X9Upg1zUtwfRUwa1qG8RYqcMclGPJa4f972wM3zk9+qXQTDqg2/Jk8Ejm0876ohFfUh1FJGLejHrqCMX9cG348ngkc3nHHWUoj7KaxShqPMytowdydmY9+FZRybqk79N62hEfdJy8IwdyfXliUrUZ315ohL1WV2eaER9VpcnClGf5eWJQtRneXmiEXWpLk8Uoi5FYWJGj/TsdO8jy45C1HPm0b1KLsNHfjTrvUwuw0d+NOu9Ti7DR36Mje6Fchk+8uN59F5YleEjP55f7vVPGT7yc81rchNDLeqpRfd6mQwf+XHBOrlgUYy6Rvvey1oyfOTHTfW660ZGj/Q9TrLrBiAZPdL3JJWP60T+tFp/Bo/scqCEbtS1umZRjfpmofHxRHV7FOyIRl2jExbyh2KzbhiilziyUbe4aK+bJGT0SOd79GTwyC7HSQhH3eKKvVc2ZfjILx5l0I769iE2v6qjHvVYCPu+nV9Gj/S8WElng37UzYszBvWor0d1OqIf9Zx9RE4B5KO+qjZFPOqrbFPEo54TkO71ZBk+8qMXvheUZfjIj174XlGW4SN/98LtXlGW4SOfq2BHQuqLz+ntSEh9GxEbFiAg9S1EbKplRz/q3ovzC/mo+6jOLwSknvuikfMLCalvI2LnFwJS30REzy8EpB7Tj8Z1AZKMHun73fe41zl0BKS+hUjH/X1gRz8a24h03F8HDhSkEbOP2r1aMcNHftGoAxVp8A3SMnYkz+IMGIhI40G308rYkazF6TIQkcaDbqeVsSO5MIeBijQedDetjH1O3kzETsSBiDT4zmgZO5J7tPx97DUQkUYx1WigII2NRPdeaCAgjW1EpBcaCEgjatjavf41w0d+9rb3MeBAQhqtepwZaEijFXfRgYQ0ejUyGihIYysRO7WQkMY2Inq2oCCNmG/U7oW+GT7yZ+TfxxcDCWkEIX08pJJ8bNieDXu/7Q5EpNH5m5iBhjTCkESuY6mBhjR61apISGNUY6OBhjRGNTYaSEhjFGOjgYI0RjU2GkhIY2Sj3scuAxVpDD7eHWhIYxTqMBCRxiieYAYi0hjlZYqMNEalDgMZacxCHQY60qiWQ8rokV7y/UBJGrPk+4GYNLYWrXHdoy6jR3pxI0VIGtuK+Hdjm8Zso9buY6OBljSifK2R4uqBmDQmn7w7kJLG1iJyU0JJGiFJ5NxFSBoBSa2RmylC0pDCeQcy0pByZISKNGLLNHauIyKNrUTsXEdCGtuI6LmOgjQkG5TcrVGQRghSa+RujYI0QpBaIzcxFKQRgtRICetAQRqaDUtuYihIQ4sRL/rR0PJCRT8aUbtGLyYUpBG1a+2+kX2Gj/y8WMm9ABFpKHf8gYQ0Yge1+wbFGf2cHnVrjdS9DjSkYcXQFwVpxBLa97VxMnqkF22KgDS2EH0Mhq6zCQb60dhGdN82LINHdrQoqcEdKEjDiucY9KOxgYj/5tigwUfsN8f2XNmepINEPxqLvzsdqEdj0X1hMnYkx7CXVAMP1KMRetRINfBAPRqhR41UAw/Uo7GyTUmPhHo0Uo9INfBAPRqhR41UAw8EpLHCeu8GPpCQRhASMfCBhjS8VbcyNKRRGdJAQxpbiQiwDySkURLSQEIaW4mYUg80pOHVXRUJaXjcVe/APpCQhld8P5CQhlfvUAcS0nzktXq/D0w0pJmGROrBJxrSjAq2Rkq8JyrSjAq2Rmq2J0LSjOlIjdRsT5SkGdORGqnZnohJM2YkNVKzPVGTZlSwNVKzPRGUZlSwNVJyPJGUZlSwNVJgO1GVZsxNaqTAdiIrzZib1EiB7URZmilLpEh1oizNkKVG6k4n4tKMRZIaqeCc6EszVklqpIJzojDNFCZSwTlRmGYKE6ngnChMs3HPn+hLs3HPn8hLM2YotWnXfmSiL82eLbuub6QmCtPs2bL3J9GJxDSTmEht6ERimklMz6mb198HWzaJSe43q4nENJOY5H63mkhMM4jpucP6PR9bNtZIak9muv7+2LhR2dbkflOZCE0zKtuakPZFaZoxW6nJXRomUtOM+rYmpH0Rm2bUtz3XqLrnY/umNun9iWeiNs3QpqakfRGc5oj2VdIzIDlNvvx2xo7kaNz7BkMZPvKjce+bBmX4c/58lCcnqtOcrTwZkJ3m7OXJgOw0ZzbudY+KDB/53PwnotOcUvZU6E5zatlTITzNhCfWUyE8zYQn1vMgPM3pZc+D9jTlUfYkyE9TWtmTIEDNBCjWkyBATRnllY4ENWWWVzoa1BQpr3REqClaXunIUDNmMjVSUTfRoaYU91xEqLmViTxHTCSomQRFKs0mEtQMgiLlCRMFam5iYpNGJgLU1JDFe73mRIKamu1KxoJoUDMN6r7bRoaPfC3PYzSoqVwsJgLU1PqiRYOayt+9ThSomQJFyqsmCtSMxZPISYMENY1uEpWxIzkuVlKjNNGgpvFaxokCNUOg2AmDBDWToEhJ00SCmlEC10jxzkSFmrbKjhIZapqXdzWEqLnquyxC1Fz1XRYtahYWNdGiZloUuwuiRc20KHYXRIuaaVHsLogWNdOi2AWFFjXTothdEC1qrnp8jBY1Vz0+Roya/ijvaqhRM0ri6F0NOWpGSRy9qyFITR/lXQ1JasaKSo0Ui000qen8bexEkZqeVy55TEWTmp5X7nVT3Awf+c/WM7lu25TRI73ojJGkZJuTkbVwBUVKNjmZ3meqCYKUPMrBkyBISYIU6RMEQUoSpO4bYGX4yJfqtBQEKXmUj7WCICUJUqTPFAQpSZAiTwKCICUPbhaCGiWtNAtBjZJWmoWgRkkrzUJQoyQ1ivSBgholqVGkDxTUKEmNIjc4QY2SVo6gBDVKUqNIHyioUdJW1acJgpQ0r/o0QZOSNKn7hmsZPvL5mx9BkJLO77aCGiWpUYtcVqhREhr1XJ7xzzuUZ/RIj4YlFXyCGCWJUaSUTBCjpFhgSVCipPPKVkGGks4rWwUNStKgSNGUoEHJKNoTAUpG0Z6oTzLq9kR9ks1L/eHXF5yC+CSJT6Q4SBCfZOsSaR+UJxl80RZBeZLBV8sSZCdJdiI1SoLsJMUi3YLmJLGu0r19EJwkwWmR2waCk2xRIhscZfRI52tCCHqTFCt0C2KTbE3qvZNfBNsyrYlUbQlak8yiORGaJKGJlHgJQpMIL4AUVCapJjkJGpOEMRG4ECQmiTlO7CiiMEkK07qPHwWFSfimbxk7kotrE21JigWVBGFJpGhMhCXJ2U2knk6QlkSLaxNdSbS4NlGVJOc1sb4TWUmUr+4hiEqifPUdQVES5au1CHKSJCeRAkNBTpKY0sROWQQl2WJET1n0JNFii82Mfk5PUSLVjoKiJFbcORGUhG/3lrEjma/fLKhJYnytFkFNkqiHa6RCU5CTxKq1WgQ1STYX0QZCTJLAJLK0i6AlSVoSKRcVtCRZxeWJkCSLr9UiqEiy+Fotgooki6/VIkhIkoREChwFCUlW0c2iH8kGItIFIR5J4hHrghCPZBVDWpQjWXRjzYx9Ti6W4BY0I0kzImWWgmYkxRLcgmAkzhcNENQiSS1i4yvUIikW4BbUIikW4BakIkkqIhWWglQkUQJ3f4cgKEXieVmSIRBikeb8JVKPqahFGvOXOqnHVOQiDS7qpGZOkYv0UQ2EFLVIH7y/VaQiDSrqpIpLkYr0wVeWVHQi3RAk7f7ApMhEGkzUH+PKbopMpDFvqT8mycd2DSnqD7nnoxRpy3a97jaY4SM/2/W+MZOiFGlIUSc7aClKkYYUdVJroyhF2njXq8hEuh2IbCWhiES6FYhtfahoRNrqlkUj0jCi3sgVhUak/VGeCWhE2lt5JiATae/lmYBSpH2UZwJKkfZZnglIRRpU1EmZiyIVaS+uWnQijUlL/GBi4/ZVH0xs3O71wcTGHY/y5EEw0tHKg49mpKOXBx/ZSIONOqnVUWQjHfxtqiIa6ciWvY9/FdFIY8ZSJ/Uuim6khRspupHGjKVONoNTpCMdfNCk6EY6+aBJ0Y005ip1UnajSEe6bYg9WSnKkc5s0vv4Q5GONJZb6qQyRlGPdBY9MeqRzmxS0s0jH2nwUSelLop8pJOPgxX5SKeXpwDykQpf71eRj1T4er+KeqShR53UrijykQqvN1fEI906xBblVLQjDTsisq+oRxqTkzopXlEEJJVsUdIJoCFpMTlJ0ZA0DYm8llU0JN1ORC8lVCSN2UmdlLsoQpIqf7xRVCTdUkQHlOhIGpOTOimlUaQkVf6Ao0hJWqzKrehIqtmipP9CSNKYmdRJkY6iJKnyNzCKjqThSJ1U9Cg6khaOpOhIWjiSoiNp4UiKjqSFIyk6koYjdVKDouhIasUICRVJX3OS7g+gioykwUidFLgoOpKmI5FX1IqOpOFI/bmyzu33QUrSmJPUyRIyipqksTh3J2vIKIKSrnr4i6akYUqdFNAompJuN1p+f9GjqEq65Wg82F+LrRuu1El5jqIr6crWJdc20pLGpKROynMUdUm9bl0EJnVeyqqoS+q9PBUQmNR5LasiMKnP8rxBYFLnKwkoApPGdCR6kqExqfOZoYrApJ5tSrpIJCZ1vo6Aoi/ZBqR5f7wy1CV78A2GDGnJHrz3NXQlK9boNlQle2Rb3jtUQ1iyhKX5MW5YP+rDMF8wn68XawhLFhOQ+mzkyw3zeaW5IStZstJzdHf9cmzOxt+YGpqSbTRyHdeiUUNSssan+Rp6kqUnzXH/xdGTrPHlfw0xyVq253wK0ceQCvOxPVvRnshJ1rI9712uoSdZUQFniEmWmER/c2zPxCR25iImWWISOxkRkywxiZ1fiEm2tYieMmhJlpbEzgK0JEtLItWHhpZkhSUZWpLFQt3X9xGGkGQJSfTAY8NuKSKzDwwZyZKR2GmAjGTJSKyZkJFsOxFtJlQkG/XFiopkY5ZnGUKSJSSRbT4NIclG0ayoSLaliB15ZCRLRvoYzt6GAYaMZKO+YFGSbGbLklsTYpJN/jxjKEk2+YwyQ0eyDUWMxQ0ZyWIG0t3cDRHJYp2l+zROQ0WymINEJqsZIpIlIrFjjohks75W0ZFs1jdVdCSTR3m6IyWZtPJyQk0yKa9WxCQLTOqkENnQkywmI3WySa0hKFmAUieb1BqKkqUokU1qDUXJNhn5c85t+7HhmYaeZOFJnexSa0hKFqTUyS61hqRkMS2pk11qDU3J0pTIhq+GpmRhSp1s+GrISqbZuqQDQVeydCWy06qhK1kUvXWyAakhLVnMUupk90xDXbLUJVK2bKhLlrpEKpENdcliz7dOKpENgckSmMh2mIbAZAFMnRRjGhqTxdZvnVRMGjKTRf1bJ0WKhtJkUf/WybZrhthkxSLehtJkIU2d1AUaYpMFNnVSvGeITWZ1z4zYZIFNnRTkGWKTrWLNZ0NqsqQmdl9BarJVD46RmmyVg2OUJlv14BilyZaUtyGkJlvZuOTKQmuyYjc4Q2iyLUlkKILKZKsaHKMxWRoTKRwzNCYLYyJjEUQmS2RiJwEik/koT2F0JktnYicNOpN53apITbYtiZ5kKE3mVp5kiE2W2EQK6wyxyTyvWNJdojetRzbuvbtcKE4r5zORipuF6LRyPhPZ12qhO60HfzO30J3Wo9hLbKE6rUepFAvVacV0JnamLYSn9YKn+5m2EJ7WxiV25iykp/Wip/uJuZCeVs5oImfaQn1aOaOJlBgt5KeVM5pIidFCgVopUOsOvgsFauWMpnVfbX4hQq1EqHV/G70QoVbUvnUyw3GhQ610qGUkH5s35zWt+5PtQopasWFcu9PvQolaKVGkpGGhRK1NTd7vb7EXQtRKiPL7a6yFELVyVpPfX0QslKiVEuX3dwsLJWqlRJF1NRdK1AqJ6mS69UKMWsWC3wsxam1tYv0OUtTqJVksxKg1SmNciFGrxqiFGLVKjFqIUavGqIUYtWqMWohRKzGKTBpfiFGrwKiFGLVGzgMnVwly1HpxFPtjsW1HMZJaiFFrlsy4EKNWzmxiZwJ61JrlAHkhSa1ZDZAXktSadcsiSq2ZLXsfuyxkqTWLlkWUWrO+2yJKrVnebdGk1sukyImAJrVqk1poUquqjlsoUkvKQfJCklpSDpIXktRKkiJz7BeS1Crq4xZ61BJeuLEQo9b2JkaTCzVqpUaR6fsLNWqlRpHp+ws1aoVGDTJ9f6FGLa2vWNSopfUVixq1UqPYaYYatbQaIaNFLa1HyGhRS6tnn4UUtbR89llIUWtb08ehvLjkQodaWt9l0aGW8TezCxFqBUINUpWxEKFWINQglRMLEWpZfb0iQi3jb2cXCtSy8ol2IUIt429nFwrUsrobRoFaxt+2L+SntX2Jnl+oT2sVTYr4tFb5UmAhPq3F37YvlKeVk5zYyYj0tFbRnuhOK9xpkE2KFrrTWsVtFdFpbVjqZLiE6rRyehP9O7FBc3oTO8+RnlbSEzu7kJ6Wl6/bF+LT8nIojPa0vB4Koz2tsKdBtodaaE/Ls2XJUBjtaW1der6KmR+/jmJroT2tsKfx0HtroT2tsKfxsOu6cwvtaRWrLi2EJ3/w+lZHdfLNSuwPdUQnf2T3u34Q/fGB9w5HdPJAp/Ex6rjnD8zf7frx68jjz8fFEZ58y5JN9tsIpu/rdZACJ0d38g1L/OAYpq/qLHB0Jw93YmeBozt5MeXJEZ288dftjuLkm5ToH4rg5G2UZwGCk7dZngUITh7gxM4C9CbfoETPAuQmD24apIzLkZt8e5IRnXLUJo+JT4MUKjlyk8fmcuzYozZ5b+VJhtzkvZcnGXKTdz7V1NGavPMiK0do8i1J/A/FVg1noicZOpN3K08ypCaPeU/sJENr8o1J9CRDavKgpkEqyhypyUfZD6M0+ejlWYDU5GOUZwFSkw8+bHJ0Ji92l3NEJh/ZB9811tGZfJR9MDKTj1WeNchMPrw8axCaPKCJnTXoTL4hiZ41yEwezDTIvliOzORRQTdIgZ6jM3k40yAVd47O5FPKo4nO5FPLo4nU5EFN9Ghi48b0p0EKAB2pyWd9g0VqcilGTuhMLuUVi9DkUo+cEJpc6pETQpNLOXJCZ3IpR04oTS551d51xxGbXMqrFrHJpR45ITa51A2L2ORajJxQmlyLkRMykwczDVIG6shMHsw0SD2lIzN5THoapIjREZo8oGmQIkZHaHKtHnQcocm1fNBxhCbX8kHH0Zq8WOvbEZrcissVocmtvFzRmdzqyxWdya2+XNGZ3MrLFaXJrbxcEZo8ZjsNUg7qaE1u5eWK1ORWX66oTW715Yrc5AU3OXKTF3vOOVqTr7xc76+yHbnJtyfRA4Pa5GuWZw2Ck7/AiZw1CE4e4MTOGiQn36pEzxo0Jw9zGqRc1tGcfKMSPzjYqv4ozxokJ/dWnjVITu7cER3ByZ3PhnHUJk9tYmNW1Cb38kkHscm9ftJBbXKvn3RQm9zLJx3EJvfySQe4aT6Cm8a9aDrDR37REWf0SK+edDJ85FdPOhk+8umTTsaOZPqkk7Ejubi1ZvRIt+IsyPCRv4qzIMNHvvOzIKOf0zcokbMgo0d6XKz36vYMH/mFOGX0SB/lWdCwVV/iRM6Chg3baA1sxo5kyv4ZO5KLW2tGj/Tq+TXDR371/Jrhz/m9eH7N6JFePL9m9EjP2+v1MSHDR/6+vX487l7WkczokR6teq/oz/CRH7fX+5aVGT7y9/u5+5rwGT3S44q973CZ4SO/Ggxn+Min5c0Z+5yc4HTfPjPDR37ZDQ9s2VGNhzN85Ffj4Qwf+cV4OKNHejEezuiRHnfY+1IHGT7yy4t2YMOOajyc4SO/Gg9n+HP+pOPhjB3JdDycsSO57IYntuqs4D/DR34F/xk+8gv4z+iRXsB/Ro/0vF6vupbhI3+VBwdb9aVN5CyY2KryKM8CwYYVusJExo5kusBPxo7k4ikno0d69ZST4SO/esrJ8JFfPOVk9EgvnnIyeqTHxXpfOCTDR340633hkAx/zte6WRWblXNTxo7kBOLrk0iGj/yyZRVbVuuWVWxZrVtWsWW1bFnFltWyZRVbNrHpvnxIho/84vk1o5/TrXp+zfCRXz2/ZvjIp8+vGTuS6fNrxo7kHDeRYZlhs8a8pnHfOjrDR37cXu9bR2f4yI+O+L51dIaP/GjY+9bRGT7y45K9bx2d4c/525SsXRccz+iRvmeYfpwHl33cM3qk79VhxnXlt4we6XGPva/KkeEjPxr3vpJEho/8AicyeqRredYvbNtl5Vm/sG0XnbaWsSO5GBEvbFUvXqxn9EhvZd/n2Kzey77PsV1DnFjf59isG5Vo3+fYqjnB6b7wRIaP/BInHFu1nOCU4SO/ftRxbFg+wSljn5Ibn+CUsSO5es5pyE2tnOCU4SO/fM5pyE2tmuCU0SO9es5pSE4tJzjN+x2woTm1B63NydiRvIfDj1v1aQaP7H1z7dc+sqE2tUYXMM3YkUzX5srYkbyfcMb9t0Znao0uzpWxIzl73vtttSEytZjWNO7LWWT4yI/WvC9nkeEjv2hNhKa2JYkdcWzMzUjsiGNbdrrEcMaO5Oh170twZPjI5881DXmpdbovQ8aO5FmcsEhLrdNFSzN2JGtxRLAVO10rOmNHcvSz9xVJMnzk8xtoQ1Jqg685kMEjO1vyPuhqKEotFwC/r0+U4SOf7mWUsSOZ7mWUsSM5r8v7iKuhJrXUpPtCKhk+8o03P1pSS0u6r7qS4SO/aFGEpDarFkVJaluLnu9Kpf348RthOjbo1qKPr713tWhJLS3pvlxMho/86G3vy8Vk+MiPVr0vF5PhI59uNpaxI7loUnSkxpf+ztiRHM8u91VrMvw5PxXpvmpNho/8uEzvq9Zk+MiPAdF91ZoMH/n8wbShJLWUpPvr+Awf+VKcv+hIjW8fl7Ejueh20ZBaGtJ9aZ4MH/l0oeiMfU5OQLqv45PhI58DUkNAaluI2F0O+ajx/eMydiQXfS7KUeP7x2XsSI4O975SUYaP/GIghGrUNHY1um6km9EjndclZ/BzdprRfc2kDB/5dLuxjB3JdLuxjB3J0d3eV2PK8JFP1/3O2JEcfe196aYMH/n8DWpDLWq5e9z9lEUralZ0tghFzejWGRn7nLyKcS0aUYtZSeO+3lSGj/xiXItE1IKI1nXj8Iwe6cWFiTzUVjGwRRxqqxjYogy1lKH7kloZPvLpcrMZO5L34yZ5k9zQhtrWH3JIUIaaFxclslDb7kMOCZpQCxMa91XAMnzk03qLjB3JUlw3CEItJyHd19DK8JGfrUlugShCzYvnTeSg5sXzJnJQ3+RDnvA7elAPD7orRkcO6g/emh0tqKcF3VeUyvCRz1uzowT1R3ax93tgRwrqDz746ehA/cEHPx0dqG/qYcdkYXIMZ++rYGX4c37jttcRgvrGnvvzfUcI6q0Y+XSEoN74yKcjBPXGO9iOCtQbH/l0JKCeBHRfFCzDRz4f+XQkoJ5zje5beWb4yI+2XPehUkcI6jHXaKz7fJqOFtTTgsh9raMF9e0994V8M3hkj/KvRQ/qnU8M7MhBPWcasUODItQ7XQkgY0ey1ccR27XzVyodRah3rw86Nurgc1E6mlBPE1r3m0pHE+qDj4I6glCPKUaxRdKffm8Uob7Vh/QVKEI9RYidKyhCPUWItRCKUB9Wni6IQj1RiDUSolDPCUbrfnPu6EJ9Fr0uslCPCUbkuKMK9ShpIxtfZfjI52bb0YR6mhBrJzShnibE2glNqGc9G2snZKGeM4xYO6EM9SxoW2TEgDjUJ8e+jjLUU4YWOfIoQz1laK37LRJlqKcMLXJvQhnqWdHm94fEjjjUE4fuu8Zn+MiPxn0ufHf9e7Fxs6bNrztcZvjI34MkZYcH2zaNyCfJx7bNeUYu93MHmagnE93XAMvwkV83L0pRVz4dpSMU9SxrY38sWlHX4uaKVtRzltF9Da0MH/lcFzpaUdeyVVGLes4xokcRW1W9PjDYqglG7CxAMOo5yei+TFeGj/ziDotm1K3oixGMek4y8usKNxk+8mM3x/sCYBk+8jXySXeAbNRjktG8b0CW4SN/Rf79WbyjHXXjUxY62lGPveLmY96bFfmoBx/NBzkNkI968NF8kM4ABamHIM0HuaSQkPpmIn2uWXrrKhGR+oYibeQ2iIzUVzYtOYlRkvrKpiV3HpSkXkhSR0nqsYQ3eevVUZJ6VLXN+5oyGT7yo2Xvq49k+Mjv5V0NSakHKc378iMZPvJneRdEVeo50YiNKtCVeroS6zDRlbqX/TGyUvf6Louy1L2+yyIujUc2771XGMhL48FfxgzUpfGgu9xk7EgexYEZiEsjcGnet6jO8JEvVQ810JfGQ6seaiAxjZhqNO9LW2T4yI/u+L60RYaPfD40HqhMo2Wr3ru/gdA0srqNXIQDrWm0Xl1UA7VpZHkbuagGgtPImUfkohpoTmO7Ej13UJ1GqhO5qAaq08gVlchFNRCeRsu2vff3A+FpvOCJ/f7YvJ0bxUB1GqlO7I9FdRqdj4sHotPo2Rvf71QD0WlEhdvs18XBM3zkx1V7X04iw0f+VuFp94ZCeRohT/O++kSGj/xo2PvqExk+8ouLFuVpbF0ivSXK0wh5mvcVEDJ85McA6r5pdYaP/GjYe618ho/8cnQ8UKDGkPJEQIEaQ6vR7kCBGiNblvSAKFBjZMuSSxYFaoRATVIJOlCgRgjUJKWdAxFqTF4MNdCgRi6rxPoPNKgxy6fZgQw1gqHovRMZakwp753IUGM7Ext9D1SoEZOTyOh7IEKNQKhJqmQHItQIhJqk7HWgQw0pn30GOtQo6twGItSQXh5KRKghdHm7jB3J0a6kpnagQA2+eHfGjmS6eHfGjuRqVDzQnsbGped0jPtBwRaV+v6K9DRe9ESuD6SnEfQ0SfntQHoaUeU2SaHmQH0ayuecDaSnofxFwEB6GklP7MggPQ2tR06oTyNmKn38773bRn4ayp9kB9rTUK+/HJvVsg8m9wS0p2HFhYrwNDYuPfe0uSwInNEjfdPT2mUb40/Z2KYbl54b1Ny/HFt125KMH6b/2PvEbGzTWLX7eQpcpgwMdKexYen5nv7jd3non74dWzSW7fZGvh3bNNTp48HiVqo20J1GrKT0HJjf0pGdxnal5fqDzh8nvp0eqE4jVu52I9+ObbpVaTk5kGhOY2XvS4YciE4jFlOapMpxoDoNvnp3xo5kq05fFKcRm8aR0xfJacTkJXb6IjmNmLxETl8EpxGbxrHTF71pbFCipy9y0/BRnb6oTWNzEj19EZvG1iR6+qI1jY1J9PRFahobk+jpi9Q0fFWnL0rTCGmapIh2oDTNoqptIjPNmMVETseJ0DQ3Jq2l1/HARGqaj6LznShN81F1vhOhaW5Jem6Ld5upN9GZ5oYkcrJPVKa5GWmt+/PtRGSaW5HYtTHRmOZ2pLWcfDu26GYkdilNRKbZovO9D9omGtNsvbjyJhLTbHGh3t98TxSm2aoLdSIwzVg/ye9D/InANJsW1/VEX5rNiut6Ii/NtorreqIuzebFdT0Rl2bMapqk2H2iL83wpUmK3Sf60owKt0mK3ScS00xiIsXuE4lpJjGR+vKJxDSTmEh9+URimrFu9ySVyBONaaYxkZrVicY0i9lNE4Fp9uyE72OCicY0i9lNE41pxhJKrCdDYprbkJ77e95G4xOFaaYwkWrRicI0Y4IT6bTRl+bgC55NxKU5tLp9oC3NjUfsu7E5txzxg4gNOvhb14moNGPdJHY3QFOahSlNNKU5e3UvQFKak7vDRE+aG4zojQM5ac6iLdGS5tTqLoOWNGfRlihJc67qHoOQNGfRlqhIUx7VDQkRaRaINBGRpvTq7oWGNAtDmmhIU2Z1q0NCmlK0JRLSFK1udIhIU4q2REKaMX1pkuLziYY0hVP+RECaAUiTVH1PBKSZgCTXPUozfORX2DDRj+Y2Itq/oSBNrXpaJKS5jYgOj1GQZizIzfpDBKQZ05fI8Bj5aOqqOkQEpBmrcbPhMfrRjI3fWJeIfDQ3EdFeDgFpxvJIrONCQJpWPZhOFKQZ+76xrgsFaZpUvRES0gxCYh0MEtI0q/oMJKSZhESGx0hIMwmJ9BpISDMJiZwESEgzZy6RZQAmGtIsCt8mCtLMaUukUn8iIc0kJFKpP5GQZhISKb6fSEhz8SKbiYQ0Fy+ymQhIc/Eim4l+NGNZpElK6ScC0vSCGtCPphfTvSfy0XRekzoRj2bOVRK/vtiaqEdz+xA53GhH03mdzUQ5mjFLaZLFAibS0XReZzMRjqav+s/E5nRelTqRjeTBKxkF2Ug2DN2PiSAaSSyFNMlKBIJqJA/+FkYQjSSmJ93PKkEzkq1C7I8UTNbqcAuakWwVuh9uQTGSovhN0Isk5iRNsjaDIBhJUfwmyEWyQcjGvPbLglwkG4Q+7qo/6ONHfC8lqEVSlL8JWpEU5W+CUiRF+ZugE0ns7Eb/RmzJmIc0ydoWglAkOQ9J53VYKShF0rzOx/ZMKtL78haCVCRJRWTlB0EqkqQi+v3YqklFZB0FQSqSpCKyeoEgFcm2INpcKEUSk5HIKYlOJJ13uYJIJJ1XGwsikXRebSwoRDL4KgCCQiQ5C4ksuiBIRJKzkMg6CoJGJGlEZJUBQSOSmIU0SQm+oBJJzkIi9emCUCQ5C4kUkQtKkeQsJFJELohFkrOQSIW1oBZJzkIiRdOCYCQ5C4lUKwuKkUQp3CTluYJoJDER6WPQTPKxfWMi0segmeRj++ZEpEXaF+VIciLSIu2LeCSTl60K0pHMeGV6vwujHUnOQiKlooJ4JDkLiZQ4CvqR5CwkUmonCEgS1XAfA3OSj02bE5EWOXUQkaRAJEFEkpyIRErtBBVJYiJSX3cvEYQkkaJdkZFkU1F7+sf9y7FlhYO9ICNJMNKTS+5fjs3Kd3bL2JHc4svvE2IEGUmKEjhBRJKYhNTv+8Rm+MjnJXCCiCSaDXpfLE9QkUSLBkVDks1EbE1xQUQSLdoTCUk02/P+1kPQkMSK9kRBkm1E3tv9F0dBkmKBbUE/klgvqft9Aq4gIIkVzYl8JFH71r2RL8fmtKI5UY8kCt+636cCC/KRWNGeiEcSS2t3Jz0L6pHwrdwydiRHn0sqhAXtSLLqjVQIC/KRJB85uT0iH0nykZPbI/KRLI73gnYkWfTm5IaHfCRZ9ObkhoeCJFH0Nkl9sCAiSSISqbIVRCTJwjdSeSroSJKFb07uYShJEoVvQupDBTFJcn1tUh8qiEkShW/yICcDepJE4ZuQ+lBBUpIgJXmQ9kVSkiAleZD2RVWS3NWNlHwKqpLEfCQhJZ+CsKQxH0lIUaaiLWlUvgkpylTkJQ1eElI4qchLGrwkpHBSUZh0IxKb/KpITBr1b0LqJhWVSV/KdO8IFZVJo/5NSCGhIjRp1L8Jqd9TtCbdmPRcvus28ViRmjSoSUg5nqI2aVTACSnHU+Qmbdm697NNEZy0ZeuSsw3NSaMCTkhhlSI7aay9Lfd9ejN85MfVSwqrFOlJg56EVEop0pMGPQmplFKkJw16ElLPpEhPmvu8kXomRXrSoCch9UyK9KRBT0LqhxTpSYOehNQPKdKTBj0JqR9SpCeNWUpC6ocU7UljlpKQohdFfdLO350r6pNuYTK91+so+pNuYzK9D2MVBUpjpzch9TeKCKWBUEKqWBQRSgOhhFRrKCKUBkIJqdZQRCjNrd7IBkyKCKUjm5acaohQOrJpyamGCKWBUELmjSsilI7cTpWcaohQOnLjTXKqIULpzC0aSfsiQmkglJAJg4oIpYFQQiYMKiKUzty4hLQvIpTO3OKCtC8ilL42fSPtiwilMzeRIu2LDqWxKJOQOYCKEqUhUUIm3ilKlBaLMikylG5ner5gvo4aUKE0FErILBxFhdJQKCETaxQVSmNNJiH7ByhClApfslJRoTQUSshUAEWF0tz3jbzdV4QoDYgS8nZfEaJUsmHJiYYWpWFRQl6rK1qUxqwmISvUK3KUbm9SudOIokZpVMUJeUetCFIas5rItBBFj9LY+03I615FklLlxY6KHqXbnMiq2YogpVEVJ+S9qaJIaVTFCXnvp4hSGiglZE17RZTSKIwTsty7oktpLMok5D2eIkypZcuSExNtSsOmhLyXU7QptWxacmIiT2nwlJDXUIo8pbE0k5DXUIpCpSFUQl5DKQqVxtJMQl5DKSKVBlIJeQ2liFQaqzMJeQ2l6FQaTiXkNZSiU2k4lZDXUIpOpYu/G1BEKg2kEvLOShGptEAqRaTSlS1LzhxEKg2kEvKCSxGpNJBKyAsuRaTSQCohL7gUkUoDqYS84FJEKg2kEvIWShGpNJGKvIVSRCpNpCJvoRSRShOpyFsoRaTSRCryFkoRqTSRirxYUkQqTaQiQquIVJpIRYRWEak0kYoIrSJSWSIVEVpDpLJEKoKuhkhliVQEXQ2RyhKpCLoaIpVl7dz1yc/QqCyNihCtoVFZGJUQojU0KtsI1eW+ypEhUVkSFRFdQ6KymA6lRHQNjcrCqJSIrqFRWRiVEtE1NCoLo1IiuoZGZWFUSkTX0KgsjEqJ6BoalYVRKRFdQ6OyMColomtoVBZGpUR0DY3KwqiUiK6hUVkYlRLRNTQqC6NSIrqGRmVhVEqI1tCoLIxKCbkaGpWFUSkhV0OjsjAqJYZqaFQWRqXEUA2NysKolBiqoVFZzJBSYqiGTGWxWpMSQzV0KotiOiWGaghVFlClxFANocoCqpQYqiFUWUCVEkM1hCoLqFJiqIZQZQFVSgzVEKosoEqJoRpClQVUKTFUS6j6bz/85edf/9fX3799/fL//Prl6//+y3/5r//1L3/967f//MfXv/zwf/7y15/jP64f9tf+5b/8n7+sj//z//3wl4/+Mf535P9q/O9zdc/8IK8P9vrg+eFj5JIf5uvD68c9v/+5+GF+6K8P8/Uhk5+LksSH1zc/KXl/sNc32+ub1+un1vu/vP4tf4W89deH13/p+Wu4zteHV+j1r7u9cmy+Ds7rG9tjvA/YfLw/9fen90/M9094/jHtuY9YftLXzz4394lPz/0cXp/s/en1s8+19fPTeP/EGO9P758d758d75+Y75+Yr594LvKVn97R8WrZ9m6A54ra70/vn3V5f3r/xPuvfFbMvT69fuJZ/pOf3v/GfP8b8/1vzPe/Md//xvNlYH6y13G297e4vs7GR1+vT68j9PFpvD/J+9P7J15HqD/m+yfm+ydeJ0Z/t1t/t1t/bn/2+vT65uemW/lpvfL668zpzw0P8tN6/bfxznsf3a6vk7br64zo6t8/2fvT67e31xHqzzFjfmrv/9a+/zd5f7L3p9e3LOnvT/P96d0NyOvorvcxWO9jsPT9E++jttb3T++f9ffPvvuM9e403ldyf1/K3V/9xkff8v70umbGu6U/Pr17k9eZPd7X6ujvaH9H+/fo65vHeB2/8VzD9PXJ3p/89el1dMdz/bX8pO+fffdjw9559o7a6/umfv/0+ub5OsfHfLXveM43jE/6ulKGvs6X8T43xvvcGPbuUp8D6/z06uKHvc6w8RxWvj69fmK9ur+PT/P96Xv03Uevd97q70/vn3j/9v7+d72/fmd/t4frO/o+Bv7+Zn+dJfPxulvMx+ssnu8eeD5efc582PsnXmfdfPfAey+W1yd9f3rlva/QvWb969P7J+z1LeN1E9lreOanVw+yl517fRqvT6/zYK86kJ/e/9p89U274v316fWvzfc3z1fftCu1X5/ePzHfP/H+Dd498K4Hfn16/YS87lF7Eunr0/f/9vpN5dVGeyLj69N8f3r/hL5/wt4/8W4PsfdP2Psn7P0T6/0Tr4HGflean16jkK1OH58+PubYZ/9/z7HQX7/9/tOvf/zbb7///fNIZ8Pte7Czufb+4z/99z9+++Wf377+28+/fP3HT9/+4/ySj2Hspy9p7Hd4fcnzC37+9dvX33/627eff/v1998+/tvnL3xOpXh/33NhTfZ9f/vb1398O0Zuot9/ss93HyvvnlXjvKff9o/fv/7b19+//vrx+aff//j6+/GHev/0d0YXQ7/oOaj84/NP94/B+/unNS4S8tN//PG3//j6t/9x/uv905/2vt3ElfOvvuan3//9/FXs029S/Rl//PH3n/5xNM2n06WNf/Gjv305mnV+Gle3slH/+OO340/39enAf4yn3yNred/M3gNobe9ufha/32///PXbX3/+8tf/8fU/P/9Lz31+3v+Sr+KX3F/wj99/+/t5Bj7fKX3/K/MKLr7hj6/fvv3867//8dffv/7969//+9ff//rLb//+86/H7ySff6dWnDjxjd9++/2nf//61y9f//jb7z//43mFHd+m7fO30Qs+vw2fjZ4b+Hz/8er0e/74z1+On/VP593HU8P7WeF1v2vt8X3k/x5Fv58p3veJZ5lOfpLX+PIpl//ql/lTY8/Pja3/6sf/1FE9dxv69AX/oq1//vXnbz//9MvP/+95XT9F9PtRsTgW/1ffgpf102I/fVN1icU3fe+Cv/7xz1++nV/2+Tx5vraov+zj0B4//tyu9fuhmf/iV9nnfJ645wEenw8wvbHEt8TV+G8ff9Jvv58N3T6106q6refX/Pl+pP7pUOQTCP/51yV9XsOfz5T2Ly6by5HQ8bn3XO+n1yX/F991HlNZn3+V14P+65ni4xp8Py2/Rh3tjRnPuTH5yV5jtY9z9v28+X5Oyw75+nv9ctyLPv0230dN73GbPfj18AveYcanK2kVP/ePr7///ec//vg48T/a6jxrP30B7w9++dNB/eivPt2h+DDq+aO///Tt67//5/nT9vmn+cXyy7ffvv/ux1Gcn07RfM69fsNxN9/vP76PaOzBL7B//MfXn758/f0/fvr1yy9n/7U+j2v6WPx8/BhbPb/jOK2PkR4/bP/znz/DAX8ugv39V3+fqvP9aLoXC89Pwk/G/c3PX+yX3/72P45/4bkd26d/Qfhlf44S5+fbyi63oz/3p/NIP98hhTfj77fTSPXzD/Nf99vP/+vnb8dP+vjUz3Yb/FeOn/3695+/fTtb0h+fx2haDFPiK3797dvP//bz33563n7+/euvH3eib+egb32+GPtzcTzyhV9++sfH73Lr9senX2m9HvHeT/BNjf6SX46By3MNoe9X1+tJt7/HHl2/f/L3E+zj+3Pr+4lzvKNKu5cvX76Pnz9OkK+//34eGLNPF03vs/6i7zfG49B8fmRbszgOr/b6+9dvH0f620/Hqf7xOPX9a4YZPee+fPnbb79+++nnX2PEgeffxxf58UX0zP/0RZ968eNE/Hza8Hv1ly951n398jH6+e2fv//tfFwz+dytNaGd8pcv//Gnbm3XtnzqA5yfvF9++fmPb8/f5Dwenwc+H33qd4AovunaRON4dHph2MtoBu9jvnz5x29//Py/b1/qn6+H7vxZ9suX//nPn+BSmp8vpeKvef4kPLX+/5W92ZLjupIs+i/3+T4QA6dvuXasTCkpM7VLKWlrqFzVZv3vByAJRwQIZ6770L20qwrBCUMMHu6tHLox7UMsdf1z/Bc7jHyMSBu5YXGeIvojeSsnLfKfvUUGERnY3uNvkQ9E2cYNyKIOGDF45A09/rbDnyFPumSNt++7OjXaViV/tqZWsPPQ08qL5eGbra/xPH7dzmGdkXvo1D1sLLPntWphUC4M9foOh+/dfnc+X79rVgbpTVjnqBMTzBzfToc/xzvmVm13NXJ3pcY+4v+S60o45ltjaI7IiV2du5HRxP68ezy4HXH/fFOPdj5CtHTjdqxcsczO+UOPcfLloXxp0w/6ic8fx7f7Tr8PWcs1dK87f/znWzl/wWMUA0f6Bc/n/e4yO8Vqq5K7fwqJUgWpTTGXNwaJdB4unc/vr/P76Xw+HvTK8Wr1evqZzucw4z+vejMdvcyU9rm2hCrY4Ol+EFfRnOWcj77v+6nwBq0Rc3lJyTFLx0P1/uS51aOY3qPWNxhUxhzu3vPJMV0ppp6j1eJayvvNVTj3w33D2v34EQwpk70yCVBARg5wvy0aj16B3uZauc1tfOzHM+xK+3WoJc9s01EP/ys6jPqYk2G163hS9KaCy7CXy4zFuDHseFFTW649Y+lOeLudlx34138eOhyeeHyE/8VTPsLI+VCzY5UdOr2Enev+eYxp2PAJvgpjyil0dH0JY4/b7v7f86/XLZxYRQDcqzDT0ekkrP3z6/v7+1esAv163c/Hyz6EGIfCaqusbny189/gih9Oz9IBN+pIdi1P/kUbYWcLe4dejzLHHNxLOldvt/vrUrjOnYqCN9LlafDpcns9tQWZ+Rx5Aur+8UePa9U4OnHv993f4/n4VZz+E1F9fvfe0kUeDbwu4b1X0jHBMxML3ZuGzgv90SK0VaaC+LCiJDTINIltO9RZm1yjTcec5xH343G8P+tlg1aswbGhs2mycD0d9iKxrbYVWUeJLRabhuIGSuZ3KzOoU/MSN/SMZ8Txn+d9Sk+o6SJTdmbgO/Lj72Vf/dAyQg2+BP9i2cBqsofpMiordLYLK9fXc2VGbtrBDN3bopnndZrC+qXKHKjfSLJPBlIx+3qrfJ5ehRQ8IRkCitM+RgLVmqMqJQ88gzhZiXVxaknW2O3A/fLJEpIRqxSzdSpHwvelZ4y4qmWISTVT5DQBOnD8ZHs+76e311O7TIP0cK3jufKXxgpYuZYRMYfpkvaKnq/vYGr3+ud0Pu3uf9fujTHyjlr6OMFK+N/xQNTF6VYMNwbVEMtzocFSsRUadXjyrFoYeb2f/meOHtcwA3Wwb14/WlGPMaqURt9tvYZp8FzUrGwvrayZmY3kSLJUFAVkJTKhFQDEtIBa2j7Bt8Ld/vTCKvtXLzdRHv0vBsJ6+Hw+b5XH7eVLt5b7PVVLZSW2l56etTydEKzVMvmj9IARPLR8KizL4nSIc/v9dKzWB4yViWO+LyZr59Pld0qWVEI8mSTo+P7Bl6zMcZqBuujJQO2RZFRkAL1OEVznMhYkZT57Hsz/2Z3Ou7fzkSSWpVdqaDbjbXe4H//7Cvt3nB+r5L1xjYymBpoZfts9ClCUnOlwqSJF7/LUBqBRC1hjh8RiR4E+8Uqdn4KBeF6sa8+m6aVDb6lPHS1toSWElXFgXpMwsq5dd9IVpA7ybGKjVCVXZ0er8dFMdHkux3MJgwlxhTRhN02cTzHhdj9Oi3N3flTejapmmsay87Rqb/2a5Clvmu0HvH7drpfwp4//PCo1tF46HdbQWGw2df19WjsuTvo/Iw3Fo4XjV1iCj+Ol2Ci8TDYHR5ftNdFE9MTyNvgVswuFnyAzX87T3NRk7Hr/uAYX/vH4vt4PqydTAZsxNCsTTf2wNbteOWbUmY+mztePj+L0MvL0amgWbBl9unCgiZMlvZHmrqOl4Lo8i5qZmiw9YNvj1rRJr7e2LOTUMXZzwW98JbkaDPVVZyMFtrWRu7774Q6uh5h3K+I8r445R4tl2kLpUUSiY2GFhmmLlcq7jHRv4gD5ycL6NY7qOWh2OI6PZ/3kMURQRRm2StCctxQeMduZTtLX/VQsYXkeeRQzAfx2PkGiXbt5WiHaqhYIe5UYNm7ryNqI27w88fvNDWf6ajWUzSiz/ZY7MSsj5UQa5V5q+83VEEz9qSIrepWhs7RyuDJSidd7Ga6HwGDrJcfcdi1YGeXcth3Nhc42Vh9Iho6uo3nZafTr7XANp5ROE5tenSnj1vWjKxFcxFuYMLGUF9/H/jp3JeqF0sgIzDWbs+91P+ux0j1JTUzoVxoAn3Voq3Op/cQ4wPk8GthatPiNFmA/j7gudS3aNmGubJ8bIW0u1KBdJLWeeZsbOFL7zqRasvms9YSazIeFYGDrMwYbtSDQqvOr2VpkwcL5ePnQx8Uol3pYpegORdfaQOt0i9F58d5f53KOWjVHt7yoYGWuTxeZcVUBGimgKpqYitwx/lsfI05B1H62slpvrYR8Gl7LChZOe5KCbeSCdw3NFhY2aunCplHLjOafClOVvI2sPHia/p/shKj6o5bTbdRW1Gw5CzFVKDcRFZvLEka/dVRHK9MZW2t3EV+63fJ8CiPlkWNG2bqy5dpO6c9bhOVW8g3Suez5Ajju7sf7NPOqu4TYGOnLDf6xPu+sjDsB5elTJ2if0pcDf7jJ5uN8KjBErSwaeY5IFOO3PA05lXu+Nq+HAh8vgZKWvtowrDJNWuXeLG+iTb3pLQ8ZYW41YVoFrKLv9Ho9H3f1Ipi04A2Pz1+n8+Frd9mVAZVXByhN4L2VRQzVCdewNbPf7T/LT6eQlMCJGpp4nWwc6g/v1MOzDzBb+M/376rzG4IdicNhJ/JsBHPyWGAHlKfeU9dqvzvvXxEktv98XX4/iqx27OVXEISEgusoGGi/u+xD9HE61EpnwemQESE9PYKR4z/HfXECGtepkhkFq1ahQTK3v/gEwJssTwV40LKClr9PAObUb5pwzH0CNoPOYflvqq6kHCDgRiEIXn4k18ygoaRLriHoBNAFkgxndw8QHLh46ebh1lnk99EPj7xAciUdQI/oOkdDOLrZUzOnT/38PvmkPoFqfG49zl3Gy49cg0ZTLUC1qfiEXt0ErvTotoVvmpBSbWpVg2vcptfbpt7lNr2NNvVio7GlTWdHm144+oPb9EHbFMS26epge+jSRcGC0Lnl6l168126VuQqXX4slwBevUuRQJeKNF1qUu+QRU/FsD4h2kGfgM6fPr3eITVnAr46pnseQc3RpAlkGotf6YubZsCvdAvhF8hBwMViELuYdNgY4/C3oPAwaFkyLRYAmgAsCDQsLFuQdNgWKyXNiajYkRZNg19YWs7hF2hMQHlg3IC8Pa62tDbEX2h19LguMhkGuEGDw9W0IDlpU+4jsrKmX7huO2As3iTmUORpSr/SCjKdy79ANgIylK7Nv/C3uFoPopce99KjUbPHE/WpYmEAQAy7TbI84F6GFu1uHf4d5svQ429hGVQaBgQaZsSXGfGuxlQ9Cc4u/rZHrAt7I0CBTVoEYeKA+CTRL1jMTmuwN5pEphB2yRQT2zT/LOaVxbyyINCwiM8t5lX4lcCQDvYcNlcHihHXY1MGxQjIaSy20bBT489SDiD8StfwAFeCasF6jz8DGYoH8Qm2Uet7YF9xjdYiV4BrtLgGZrFt07yyXdpJbJf/DDXlPq0e2+MNYTeymHW27/Fn6fvaPtM3gUgFzEkhaE/PO4A8Z8A7GFr8wlMOYIEaMUtGENuMuKsxzWeLWRcCT5C1pNXjQNzhGpCNNHB+GnRzYCd0BkeqcfizdNA5HO4O+1/4hX8HehID+hTsjuFXstziGvhuDnkfB4oM14LyBTQXrsVx3iZIr2szRUua2a7LpC4d/hZW+nR+eKw3D58mOLzp0DbIMhmQeYCuKHgN+FsQkKBm4dGA7uH3eMBCPIiLvEVvDugmJgXl9CvZa9P7m1Rfl18brvniOq4AD6NXCA9QAQ0gLRoo4HK/uz1f9+NUlE6Btm5TlqjrgZbk97vXo3CJJdDejWAxG9OzujHtgm6Ek4d9OGxLGIGvPGI+jiN8P7zFBt+7Seveg57KN2lfCk4ifuXvyAOz413DS1SnE+8BDVHG6XI8kESubLYLy5t+ntnI8fIR/qMDYq/aZDxtbl5MpJab2VRhyStLLLKNcdPHsQQ4uUbm3QaKoVzK5go+oToOPA7ANm/bOBB6ir9h9XgFbenTLAknAfb6lqURgsl7EbdamfoaaB546nhZSqlqGcli7khhTdNwZBSLEFNhO2lRZO65uRSdIZ2CUtIE6/7zdNYjjWxccjzzso95lzUK1Mki5djR1xZHZ6KdIh0rC11uIadiRh7n14dOFEj6Fcfxb9Po122pf6s76GTqx+DAD+cB3Q6DMQ1sGuSukYmfHKidQBzofcLqeE9pA6YLxFJqsSlIBJZ3tJI6A0b0h5Zl9c1hvwTQ5EduGUVl0lA6gQ3LK74ZxWnS0MLQChSj0TXqvhxdkKWRpbdc25K4yI3NnNiqVFO9Uc+4sW4Kk4fjM+Jlahkuhd5sKOb432GTZOG/oVnlla21JaMIgFCFbJBiaiiJThX1tCJJUZB6n+PH7Tm+iaVSpCJI9GfyU+QZ4K0b+BzhGfFkiFIb2kE1343ufpCpeYrZSAMr87VV8JOOJyu1ico0bRXYkveBLZYu79dq6lUaMRQMEY1Ui7xqYvfIcY605h8sVcp+nVW7PK3WhdExtx0Lqmq4guOMFP26P18vR16nmxR0xFFNEb7BzkN3ao2NYpyhRF7TyOM/t/AYh0dE42jI1qCo1VqKm9+fX49nxF+/X3XFXPY5NhTntQyvVFq6RsFqO+SLQP2LBKLnbYvJfkEI1Kmtq+fuajHOqEDINxTtGwcmZ/uxBo9J+JpDjt0Z2vsZ/vdb4bGr4CFFe8mtbXP82+TYlD/mZP3w+Lzen3FxVqe24vgbKEAoAkfPx+ex5uqrjhefSXlTw4dFTtH2hn7TH5CprSrR8ZkbzYTFs4kjDx9cep38c8+2JLVEFY4ko5GOe+/c3Aq2ZRS9Di/HXS/BTlGUVI3iDX/fSySyq2FjjFNblaF9KQSxoRxzNPODKWPDrdiCXPSq6ywVUFLiuKUUeMHo+0nTDsjOmQGM3CNthJxN1AhRu1G1oKK3vqG8XLOtiNuscwR2qvdg3Hr3s51aSVu+K2u5LzHZqHlXypPI2UzOXTCbSvtj+Zr6TgH/NnataOW1Rmeqo4t3x6Txx/15d/oq8l2SGJB7NMnClDkrLAiXk1OxwMLkExcW5MSjbRGThfuXJB5RfpUEPBj0DBnL/aJg8HzaszYVo9br1iqInk3V05OrwFBUSbTw3AUnvJ47cwqdxUPk0koV6uUUaox2xCRjW81PYk/tKNHsZOj+Kp1YuZjTPpMO9mU/RKp7OdTTeY+K8PzflFpIJYhUFkkFH+gEoFKZihomVa8MSrDAfbYo/aVtMJfYUE0DeiET/KcNIf0AJ72o6iQHIGV+0aoE+vNUMHGoYKQcjAOJEgoZyBZnvnXklJEgBqACzhIoz9P7BegiM4un/D/4wlE5AM83mt2R2Eleqwe/OmoBKVZp0/20yR1q07OjnNsmTw+FlTbdBvjGQT+H8koL9FUC33aprtWlz9Sll9Cl4xK+WJeuheoLCm5deuEo8napbgk0ToeLpvIRpBfAsw9KfSgr9GnKI/vbp2/Rp++OLC7CgyHVeAApHtL3QokY4ghg1gexPg4v1HVHlIkblPIbQJ2bBBoJLj3+FuXuBgXjZsAvgATk0su/wLYKBA6KVSaDcVC2MtDRMAaFbzQ8GotOagsYNxadsakYYizCK4uFDDUaA6kZ4wAwcLgDKDgYYHIMisgGRWSDxWXA5m88ng1FZAPOfYP1ZFAwNlgkkRgg/UolJAOETdSCxi9w1EJZpcXzovBoWqGdAjkfgDGwKgz49U2Hu+8yTAozosPb7QBT6JAe6gb8O8yI3PcO9RGDZWB6wC16JJT6jMrKIAskzcCOZMCOZFDQNihoG3A7mQGzBARbBtxyJnu/ULYwULEwA2bdgCeCIokZcb6g4Bf8VcAt8P5GfP0x+9o9/ixjzrCiwFBswRwefMasUQNYBs4YQIosiuYWK9QCUmRNxrOhcIS1agEusgb1KYOTDavR5jZ3g2tkyJzB1aBkZLFWLdRWghuLf4fGXgvAQtaSglCUdQCauIzCgz2HRnsHIJ4DaMNBSMABKOFQmQNYyaJcYXGqWhyrFiUMCwBe+AUQCFSGfPYH8LV8m30EuA3Qy4HeiwUAz+LUtC2+fgsQSIvEAjB3FjuDxdlp26wZBEAK2sVtl0GLgGp0GUCCGQF+R4uzygIVbrFWbZ9mtsWqtX3W+IEu0QD40IBrgOvbDrCHAnuYEBAVw91jbVnId1lEoa5BSb5J13DQinE46RxS1+EX/izdcwgPkMyCPawUBxieA/jOAXjhTPq+DqvHYfU4nGrOQtQBTmY4mABIwdUsmDItwCw27bvO4f4E3hSuZXYpM9IUiQQHxRkHQJ7zgOJAhcsBkOdaQFkx/xygTA7zz7XQPoK2i4O2i2vxnrss/waQTwcoRQeloA5Qig5wH8A9XQfeUAA+XQfVImhluR5P3uMaPUA+mOMO89mhzcthFodtI7OZQhnJ4xfeBjSwHFw1h/PDYWY7nB9uBCxoRAQAQTqXla/AQ+8B1/OA6/km7eMeyma+SQAU33T4sx5W0gnroVDhcVZ4Y/ALikc4Kzy8OQ8glgcQK/zCWMQQZoAVRBGIt8IWi1+IZxB7eQswDKIvb6F9ZIFwtlAewkrxDol2aHl5h+dw0EiCJ+hdLm1n8BPeUAZWezyRH/G3KUcRjgAAovBEbVY3wt3D0/ILKOx/NyLuWEgu0SuNTGG6jeJTMPL6KkqXMmhvAM8FXNoAdGJ62rYF7mpdtVR9i1g8qCKGb7CRG5sN6qJhN6hWv63U2DKc5R17ZWcjZ7iyU2awO1U+5JIgmd97F8lxKmwksvYWjoEfX/bzmlKQLMfUq+T/D3dWMGrJrKjHoeQhSenh3Hm7+dARErFuKZ1EXPMFetqKpE38itWwwo5TdmhJfLFTIjEmtVdpYCPpBQO121BEprxyOltZv5CwGEQv3vjDY8zja5UDBaj74S4K3I2kyAg71Q+DyxdpJWEi2GZdk6HAOMeMz7/gfwBW62mLs7jyag9UpOUNFU2SJjbSoJ1Mg24kZ5Ot69t/jvsCa9fI1/HD9I42al9T1qYoV5+wcT+GDWFfbgRe5Ye37+UfDcuVsCDboTWAa6osRg7X/Sv++fm6YrRrZB+fM1uFu2ipyHW3qvZMWTDi4PtVlW/lR6WaS8u4GnOckipqKYHvYkGrTikET7u12VU2cjW1k+vZIgODfioD3zec38i8I9IDf3+I6gAkRXQ6QJm5hYfKufNxo8XXUUDLZmvGxuGny8dUoqm8bSsLNe1GtT4ZksXmsIwqp/6guLc9B87CZlQlmqvXdXa9UVbJwhvc2LQXi+Hw33+WzE0SVuvarYN/sXJnZAoSrb5ZTF8MTbCw8Ff3glBPUXR0lC1pZsYSvLS1ZSOBr6al7JGzrRXzpGxJTXO12/h0k5GNjV1KRG74fdHM9O9UO7msiW4Uq+Pg2maujle+supsY/LbDil+Hzsk/AHDQ8bfIENqkeUEh6BpczMbcr79xhu51/CYg1X6Eugmcxv+S8nDrkq83nNY+ayoVyFekock+nI9VGG8owoJM1vY6/399I++JxkW+Y04JbJaFSwgYranpMmYchxjKh0g4s8p4QZ9gU3u7EQqGoLFBgLDBsGp8bl0gd5DaOC5XJWE4LjDseA8h49NTzdz/4b5rGnfrcQpcdZe2Ci/eycxCmbgsZw0UJmCTvpZI/f7pJnn6et4LTD+cnWOlPt6MfPxcT9+xEaUNcBAhjVu5Ej92VChLdArhA3HFkyD9+eTHqywmzwLkAZrhHAVbS09noa75cliFXfXK3gNP91mIwDH1TCVUrXAcJHXZGrlzSrBS6rJMw8/pE4y0hRgpRfb8x1mMjbNk6+wjIqgv5d7l7VZDJ2jB2d7EfgaHQEOwVXibm7gYKbJ4ESVcdof/4S/WqhFJykdvSsO+gSje/xkch6llphUPU3prxGNn1Bdd44DjibTFaZIJXSE9nvboP7TpIyW3Wi+maxPAnVVlLbC0m1Pn0TbWFtWSg3RcjdtMRT5uFde46AE0PwP8+92VXk0L7kKDWgqLNI8NoNdLA90kuma16faSfwPs+92v/45FWGiUuJayrTUwH9f1+fu47W7Fz0Gqn2zQ8WkyxEOzxdNhu/H/ev+OP05Iuuml4TtFBHMD0dp2G1Pj0rbkpdwc+94l+BiZd6YdLgk1hbX5VsMrCiMJZ3NwHtVptGP3fuxZK5UxFyu52ns2cJEnaj3QUUsjnKm5XG6sFRjXxwU7znvPZrNzOnYWluUUS1WQKug3mTAJ2JAH2J6SnS8XC+xLU4CS4V2reQE8h1PFUyWJsWI27UkrJVUdNb8sPrq+SvTyHyesz8cl6sZ0Srip257mf257ndvr3NBT2baUfFOUa2l2cjflXKNYuQbtvyFWnudWBOQbZ7/C7YO1L+3lmyyXT1S1PzKggIAIaPa74AKcMAgIHKz/Zb/nJvgCqV4L8VtQwBCT6LXI6oU/vM8Xlb08RHCJb60p3yes5HICvoVpQVPj1KiSW7W3vKUz2QnTtryPry6D/ZCSo1EK4ne+lRxRLKsTycheDiQPetTJNanuhmgSM5RDgSqpyK1vexAe+Hl+MhGuWaiNEo22/U05xLFt2IspPPW0smhKa3DW3GCySDe0QaFw75Y4DK/09NU8OH4pjuie9U3ApyHRb3bAtFo0aJoeVngcIwtT2ETi+5WDkL0zapTuqPMkYfj++51fv6aJ+qv9UxV1Nm+pTyWyZBMbf56D1vd614o/Snvt6POYDIYzh/ENL9C5Kel68dGtfnQjorF2qpNROnccS6FNPyqqSk6lUEZaNVyGV6Z/KqzrKO1ycXAqh5oZP+Fa+lRvoz/szu/dD+JV6cOzQCE8cGfXDWGyxgXVMQjAEWAzzlHeyoOx9jApusP0t9POcO0asYW6UQEZej5BWQWUEQDUJMBlCnmntOvrOGRWcGQlIQQsG0B4uo6lCPAsAJ7zgJ0ZQFbQpbPAfDhbA4kAWDKMHxAfx0Yp5wDlMkBxOXAyeJ65A8zuAP8OJ72ns9vv9I+OMo2cdvRps/FwL9K0ChBDOoszxZXef5BZR8AKg5PiV8A2/gfbvdfqFLLWgl3E2ZzufJSadmThwaXcpwN3Xb345QHWrteMsCkhJvJykY0L7+BpWwas6Ga4PbYyeBnQMYCBHB2SNl9O4JxG+gxi1SKHYEwHUFG2QBph/gk7DFpE+lzR06LXxAZAH2dG7CQBowYgIEcUMVHl4LD3buBFgPmd1KcsppxiY6MB9hbkRORy8E6ygkQBpdigfJAXnChZOD9WpBcKBc6Q+UT6NGAXtL0lK83dlvfv8JxQDSajDzTLNUDO5weUejp8HU8nHb3SHRUNopJV73hS/r0eJ4u+2cIF3RX/ai66oEj9JksDDSkXLM8QQOKW1P4DZpB2MIV9ApXQNMYh9v1xom0ZemTJuAPf8M/Oe2jru6PKCxJceU4Ke/xP49NeisZHHl69E9KQ2p+qjILIJgGEG/Tw3m2/Oai2ZV2ixIetbQLeBq87kz2TlFm0IIoE0/qlJxyA/cDJCWWMkQJk6uHcopDmRZEY5JcbeJWSXUAhAzAu+fKrNHWzEtWpC+VSM9A9a5qWmBKOQmUubaj51PU1vz7tbux3k6v9Hc9jfAmO5V0kle67p4urePlhy1MMRpQL2wWgf4poFOCtxu3NGvI6TBZggH43F9xmKmMFk2LhXGa7mBoFfcEihmAAdmOZkyCset7Rbi7Vbqe3cAO2zD+dj3pDXuUqbngeLDNtrKXGVl9cC26HFrqhB0vjxDyno+7ScnvvHt8Ft9RpUxp7Ww2sxrfWqUgResx8/BwZJzO5DaMug3+OZ73U9EsL4F+Y4uoD21qSAi2aGMaAaKEEo5D61WIlfBnYFu1OYqEi4c2SecMoiHQVziHaBNXcylaDLESQPRgFgcHhs9tyT5BTTzHGkzByaNk8VGTDL0lwTR+gQCVC64cL3/+7O6RmE+jPBTw1ww0a3K8fR6/wkmhpYgGhRqmj/Xf1+68KRs2KvQK9XuO9/vlqkeqDXVJctVH6q3cypxzCxYb8I1aNEtZNATYps+FVLSZpNnmDXdI4tUZsZ4JAbp8BpqAnqys2YwameYc0aiTkS9QdXJo0XQjWnZGtBTl/MqY++zRyIHGTI/GTN+Agxe8xh4tmh6FIo/WMm/4IUExkFJgJi22LoWAQ0oFDVmJGG2MjgJ05dVK78dKt6Glel+TiUoRflDMJ1tzuYqGMGob9Hb7EWLENJUlZrBfgcJRNB/8mJ0MXaMfr70MRevDST7EeOb9j8oQPWJnQ2G3YGS7qsJqaFF+MfRDTNKpmIRqd4Vw9/QV65Ur4ZJGlr0xI12H86dDw2CHs6bjE4roRinGV+hQgDUkrV+LlnwLZQyLVnaLBivXYGdoaOF/wsDEixYRuNSJdCBq8C3feGeNlevldg9vsShtKj1Sb6hA0oT0WaF7nMR6YUMz6Ie0EFXwjlYGZ/Y8feDKni2LYzac/oDmYPd0NLOd0ElV2kYZjnY0M1SYqNE2jopgj5aOkqWl5qhjEhlMeEdRAhlutXWQK/1PCmNNtuotYDIJwvXVp0rs4VgRQ5WesPGUOnc2QKvuyo+l5IeoBxd7S6v2ltwxTUO1ZGeqZtakjWWC1HlK/VQzVJk5Rm0rzlNkg7a3lZ1RUR3XyVwSTtMevZDc6tPXytOXL69sZToEi6PPqKOPHl2zlQnspraAXuX4wBzRgQ0B3dm25zHObJ2kMzvVSfOTDY1d62V90KLj2ILCyZqf3txjHx36AnWj5jwt+iULiWlSPVUv44mRJntrpI9Kuh1IcGvwqvkhvRSEdTJKOmJ8b6zVkodOFYXAyNDlXzT383587j+jM1bqpSnAoW9pX9BkoMhkyd3IjvSgnIZG/6lgoRNZGvpBTsfzoVhFSk6AC+VFnkQO6JAzdaREgD9Lu8vTPhzAWTmEfoiKyepOKDEnzvOXG+ytb6xX3gJv5KuRSbYqLw0WMIsKqwOPtgNRjPPUk4/XiG7q/Xi7rvxdKwVww2tjccVk5G/Mw6c6XfWgVzglGvoHY+V9tEYlqigf6zx0dz5fv2Mm9Pl51dPTymZjvlnNZha/upjfndJSbLcfIsVYfKbLwhvvW5ithakQ/n9JGK3yotRxmS1o8MugMpGUcHUZWgFLyb2SX/gSOwpjblrt+ar81+eiH61cCkOViKdTnPk9rWEtVop7UazQmREqgdK8hfiPo95YslyC86ya9Ej3UWcs2SkeT9Z8+qxhRiGqwYy6EycPWSRwMsUWAGAGTH4GqBIDeJ+zHZAhIFTsKF16vIvdq2Aw0CWWrQeIQ6/38NEnnHIUe/9aFSOk5243NvYLGJ9P5cEts5lbT/JW1r8bq+rC1CObBv+tNHN5xXaOLJkBEY0BUZixlBthNl/RffdKgAOMLYbjA2ZT62qo0lI3oJWzNBswGzrv3jSWx0slegPRJsPl7GdDL01o4o0yA1XBLmsJgjCwp/jlxfTjuEqR+kYBhFokCnIdGGSBnLE82kciKQvcFHU5JQZFQ+loK8Iowu6wzgYrNSiztbXUBYKlnLU33MsMA06FnyhLYWPKF425TILWLEdR6JPZaC4G5tdieRuvfDhay41GokB9QR8gp4lHy6jfnP+z41C8oVa9oa0vfv0uu11GFaRsPcGMutKDJaiU0jbMg0u9AdVT2dAS9jSYAGgUNIgigyYLhbOlMC/AOwIxaHivc7S2ikiMSuRSQHIcG9NNK04fmWHfHnw43Ysi/NgqpBkVDIrjK46SPLyDAwkWNkqQEu2ktImazwoi3NJu22l8ic9tFELMbO5af8IpGT2t4guoFt2t02imJT8eihyEkh4IkfmGidPj81iuQUXuT9Hf82BBrqDfoAqfaO3z/RQ83iqeSG4Enkoivp/+meT/BO3OOjqVr9PztXV+lQVzxYjQ0Y6H9+vuXX9Aefr6nrttZa+NauvvaEEujHs7hWPqwkjk1QTi53JYQbu9euZBbYNtFk5Le7qHlK3P+t+Qo/Wee4bX+8fxOeHa9ETp1UTZeOQ0vAZyVQeQ4d5SsHJ9bqFlVTf4wtv3bw2tsFqq433DBVfGVhublzuygfCpgbK7sVlWm/YOh4t8bVYCVdKZw92CndWZYWWI2/M81vX+vbsfiv2mlT6g7/i5HZz6A5vwTp1Z7EUvwG/d0CBrjWMmLgHFBUAuNktLA4pggFwzYH81YDQC46qF8K+FPWsgg2zAhgRCDWub/It9i/Q8Medx0+xeckHwJk0YiKkcncEZ5fifXmiMiXI+T01eiUMxjtaFk6UqO5VEwhuoHxuuvlVa0+neVhItmRb6Cxxhl+1F8psSdqyQLgPtckhGDkwoRmYrLW3fSmawFNZECE7xI41UJ2NlquySdcqlGmmOPxmqgR16pZxsUv7DQas7nFBAvNiMggGpLIhrkUVxI+hvQSwUQvx0RKEnyDcOOBcAsRDF+gYdJSAlCgHvT5+vpnDiGwUMoe5KslEJIeQO1lBYbzKQvOetSSD55HxDY6lsct360cvGe8vTsMnG8/r7qP1AJdjH+WNh4H66Fe7woBHvNHJPJoKPMAvuFUmaQfXwt7SqWu0O6lT2aoRCQJaUdygRgBPadvizMfNOb69GzXFSFKkU2djGHNFHgdyBkQGGGjgkwMdUtxnRPtdAA6LBJmmQtgQ3cuRjS79cDkDT3zowAXpYhmi7GQCNgXB9cLvwK13Dgb/fgfvDWcA/rc+JU/xChw/4+x34+x361R24lp1DAx9IrFwGjDr0k+CJvAeHcpay8RR4Er7MLkzO86uyAxiFxPLoYvK4E3A4u5aSJ8UrTAWQCr9kr3RE+UrUFs4T09C0M2j2Aem3U5h7aa26ySjIDfO4J0vnmWmmyEzLc5PWzubx4Esp6m/SwtYdnM96aUmOJRT4O7h9HFEWjUUR7rDPZMdJv2Dl9HBP5wmFxboHZlSxHdoSIJ8H5Aztcmg2peCM+lWLzyKPjiEj3NJloTIFXs+0+DbXz5/Y6RNTJrfdvgT9KVZIgMOgNBF+bbzG6MPW/JdRrhvLecuiifA9Wf7Zq/CK8hYEK/sQkx8/p9xaAX5TLRZbNzJJzNcfplcPs/E+Jhtzo0yRqlQtLn7DYZpt3I/n3dplMor929PifLaiHIuxVdSmmSYW4dUA6ZIR0CAoUdkRhzRCPZv9S66hnm+nsieGY1Lm/hqaMYpWEmFT4aaEg0BOY4/DycNz9ilcdO3mPJqvMOEC99eCesqoVktPhQYXO8can7YkoKGVYG3g/X79qhx9gzr6IAiC1hvf5yfemvb6Qus3qyYu3AiI4Tg4KOGI3ZoBUwYlJvGfu3vhbkXRMrXSN/bQqU5ZcN4Y1bEbPv9P4yMEhOz8blSmAP+32aehhZ5gfrV5tGpLB7oZquwWIlV2TDiZ8ABYhxBFGsGglTsbmq25vJBZ6BelxKI9xbNNw6v9HYME+lnoYdgu/4J32tOaULQ/BWPX+9/6nuvVnrsxsVL38Hrmqs0SjBM+SzSCvL7dmnHH9/dwo8H/uV3Pp31RoVfpyo14Ma4xDdQaFVPDSCtgcexz96HXi1Edk1mamCodRCtVbG+rRA462s0QDEyIserHcupjbezgNdjYINnRwhm9MfzjvitACtJjMoaiGMPYz1PMNu8/i4+gHJWNYP05jSg3Hs3jzikbw/h1Q8qoyNhoq+cyNnL0nf8WFnplYePNrW5cdXs4irCah5ZASlVxdttjv0/Pz+Cc7X8X1+/U9TduPWzWu/P0T/WRocAJW28v7vYVjmqZp/NcSH0xwAIFGYm5ngLrFyvFZxhVCbujWM1pdGzNKqpfvRrPJYfD+ArfqKrbbMUt09jY37CKQ41XLlHyDmglJBo7FrlOpUDfUBDbMnR9wA7qgM1MK/iFSsEI5PuIasTo4d52OfOE0GvrYEi3cykQOuOoDq+tZfl1PbzOxwgt0ZuyamLhhKbBwuV6/5rBfdWuOSuh9a7f+jBb/DxWgsG20nHP6+t5ez3XBGmNnKoOdOgOracOCWVnoOgGsLzLSXADZTqIPjvUhZxB3spuOehrJIwfFYEucFscTRDMhID69+7j+Dg+J+kFlf5UyQjO/jxZidCaquJWVLCV/miWg0a3Gii0vPUbT1xcpAzC1NfZqMcsdiruTKdO0o0pO1tYdanI92+3fOx5fAqRixBNhUUURTBZ0W6Ik0zYYwqETQOSfgvdW1TxDdxKA51Qg9DIANZv2i3PJN7JHG6W4b7qkaJ8/IuJ53XNe6cYePzWZjY5t7qBRVYht/JLt/vpz+55LM42J5k4hpTVHyjUbjJU44wW5/yQPPZxK9lwe72FZ1ndjiT3SJvJQGmVPyIrxHfd3VUzfWtho7lwFbAqmhJHiU0nGxFqdYj/WC8XBWIbKdNHMhEDmFUWQfVEQ/7WAZziIGYbYqStV7VcoQzCWjkB/VZR/LnIXH1V0iZRPUNuT1te1hZ9vnIZweHl+tSbFX5BVBT0Zz3yGz2UNiBU7QbElQPiSkT5boD054CYfaA47unuZx/ruOYT6RReZwDdud1aUcneev6Nav5t3VLpnBinGoy2UhAxZvnRQXHKQdk4wZZTVq1qmdIcU+lt3MpZT9yoKzjOICn/LCTdbZd/bU3eR7iv8zEs9JKNR4HTtsok6358tXd3yFXwButoJUz74lBV+SdIOo9boerSx1wPeQYJuLMu7aQWJZDgj+RfWx9ihUZ1kvPWDVuO1+M1ZdlZVKYS3ZCETgseHSNofIdyzlYtLcFea0kMozgjPZeDi3Zixb9Yka1stzLd1nEbzvlI/L2aLl5Nlx8NxFrQqyTsthKM7NAf7DpQt24ug7hxfx9PH59lelf1j9PGoGDhdZkpDIrMu8p3ua3K3uuiSdzCizHqxaT9uqNA+2Dlz+mosF1OdqyO6DGB/KUxcPogYWxsCiONHRBNZLS5gZsIojufMnmmTcwYERjL73N+2cdDrqAVfr1XrCAUKPhxvr7tzpPkxuMZESEfhXpcozYj7grEBF2Y2kWeolXivJz0/+N+PB7+blEyqO4Xb6liS9TTu62aLnqvYgzaTTLJjpTtcqow0HK80jx25maLJZXiRFCRPd8fo5UKv5tXRA4t1VCZY3j1DUQAv2zPyHcsSyLhMlKlY/nztLEnZyZF3Wl6p0ITZMowxzGxAcBFG5lFuAT1OjRapkWF1QU0DEhzk+p3lrdJjhi4qkGSZoVc5vKkSDBk4uh0JiD3A+7ptHizXHjWU8cry3rk6QeQ3iA2g4p4esGJiguBIoppPiU0sgp52nXahAdo04HWptto06dsE4ivTVdvk0PbpvfcJix0mz4osOttwh606ZuCKqBLz94lEESXPmWXPmWXzlWAuTroPCacR5fQvV2aPmiQg9Bpl+i60O3Zp02zT1isPmWS4IkPiRZsTKNAGRZmJqYmYnioGUeuFvzK2ougSIdqukmPbgwE/pCzMsZhBGjTDdBvyFkZZKqMhcqMzccIElAWjbAWWQlgQozDWCfkBJNl1+HgQfuhT2vHeIs/czl7gb8Fag3zy7R43jZl5gy4m8IKhn4tnrJF/zRo6QzmkOkSpMV0IKXv0iQ2XYYt4012eENdbn0E8hyzwfT42x7ssX1ukcSb7HFXA1qKB/R+DrACDm8zYL6ApM0MacEYZJvNgJmDcq5BttlA5tMA5xh+pXuBglr4hS0PoUiTUfWouhrsiMZgf08r01pAN9Akba2gmEv2QK4fvCY48dhZXVau8fhblKUx16zLGjoobjtcA9uoRR7NwvGxPu/jaUu2ADVY7KHWZ6Iw5O2xjVqP8nqLa7Q4KtqMn8Q1MIttpiDr0uZpMdcsWtDDYQLOnHRyWsw/2wMi06fvG35hLIBvPY60AdUJzD87WPwtEhIQbXBojHdNhuEgE96ABtQALG5QKoaQqTPpnHcGcDIDzneD89DAdUbvhbNZ3AGxAt6uw9t1Le65xTVaaAOCddy1OHRBgutaPEcHeyCCCwEb/hZW+rQ7emPyr5Q5Nzaf3oCwg+Mc78CjE8WbtOI9ZDI8uIm8wQkN98RbeAjogPEefgQEXX0LlwKHuc88b1yQfHbv3nb3TYLxTvmKNFEzG0NloJKiaVWKZvumVq1Gg+zss45iQmqSg7LAHWZi2lr7Nm9n2IiwxbVYhF1yBWyHLakHuzK4KuyQDjg7gGtwoFWu5UaP/30VpAv9qMQKaPWhRt+ixJawBSbHLE/jJk9jTMAuT09MXrQccgb4dBuT4N5M5v5aofh7hZCwlKxnNhYTfippmcem74QtKy3vtCjSoy7/TQ4jPL/lv4udtM1BTRkeEdwbeGlwWuCjQR4bp3DaPDKdflqkuasMByvOVcwWTLl8eGBKQdcG9CQZKJ92rLQ9YveGZk3aYZEl8AZ7CyBpGW+f3iYw9mm+oN80HdgerTzJA0eHQd6gkncE0jCwx7XpbbTpJEGXGfi/W0zgdH6iYQGk122as/AU2/RNgSlDIqpLJ1mX3iE8QxwJXfoEXXJlcUZ0aSNHGgiaHt2I6DaFtynJ36dcTJ++V59mK0i8IZwCymJADEwDPg6wK4dYIk1OiNiGiZuncA41EDggYMEhbnCIR2gwZj2CE6iK55AaB7axyDDZNv/KuSuUPdGy4sBb4hAQYC4b1yEQgfPv8GzgHQ1BRy6eItRIc9KABd9gfoWgA1kxjGg9ghOMxZQKQQdCkhErHckITCKD0NWA29Z0ubcRwUSHN9RlPhc8ZY/SL0QDQ9CB8ANPhPqR6XFXQ5P3HWQ78EQDwjfgRQ1y+GZAaAXcdviVrjviy2QyWYgJGWBITW5dGnGnKH9bSA1ZNDZZ0yDASF/VYnZak2WGfQ41IEIMASQoegWXADUEXAPzyoKlPvxCcILN1SGcAV+9dQiZsItabKMh6ACvMBx44Ketd/hbbOkQwAlBB/Z70PJiGw1BBzwQPEdr88HQ4BfCD4QzbQ4wsvcChD5yJLbPQqGZshMQJsy6EGrk8AP+zgDfJh2WFiJQdoAYadZzGxAaoBfUQYQxBB34M7RZYedycLjD500Hn3EIK1BhxhHssEs5NHyHUANFm9zWBlZ4pAEdMl8Ob9ch5eWQmAhBBwIRBDYtDt0Wz4G6n0NWyyGb5bD2Q9CR/h1YlzyynR6eh4fr4bFTezTCe7S/e4NMIAIvj8Ar/IIVnNDY0T1CMA9PJUxdtN3BI0QCMfxKf4vd1re0wLO4eBWSY1WG9YbKbcwWVoQWflBcYBs3UFAoCJ8ZCmdoNM3ZlBxFtyjIo//SWUxPuHMOW5dDgOGEIwcgAI5E50z27iC6gamIzs7g8iFTjKgyZ5g9Pg2nxQxvITjrh9OqP0hy4HAOmnn4HOqtgBZW0TL3tEcxGKkIvXWKQmdj7Ao9Nij0GDLTPnu/Ip9OoarB8mcS9qlzccuns55Vw6Kdd40d8U7JuVOkbhz6tbsVY2VXOdJk3lG8brSyFjcxRtXHHe1mC8NPlxDWPQsAifw6rM4dxt7uEQpa6yAL80OlArYeoNa2GmJW+QQ9Ghp7HBY9Vk+foyMAi3vAIHrgPAfU9bHOg98JWA5yZMjghl/4d9j6B9qNFZ6lxi6tpK15kTaMrnT4S2hoRzEHc0NjJS8yyKYNy+nrZgPFfFQwqI5/wnU3pZUNcLll31ECnWhjG1Ys2dFpOfZTQy06CUb2vMno86rTM2odmpzo6yiy8vP5VXBNKmFQ2jMQx0UIwWqfayUSwrSUEzcZqOXEvGJ/okDbSHNRvDarXhvd/QhfkBLx3LjzDYoVpe1DoV4wUaMNcVJx143c1QhGKm+vl4QQlre+i+Gny+2l03wSKWy5JGG0Uc0SKtIaSv00D3/cwhvQvf8K+Gk5BCCML+gHJBbM8uUWB05JwRqtvWpu4D1Hp91lV0w/p6Yfu23tGlrZYNcjwG9ywAZIW5vJBNIpYZHDcfywJRgySSvr0oVzWGXAmQEaXIdKlGtx6kCC2bUU/pfvoEqk4tVxgcKccYhfeedhNl11ahQKmX9LSTtfWFA4Uto3IAgPjs+v1zlqEBWW5Knk+ZEiLFWASrIdDzmW5HsjPgL3m0P8mLspUtSFGiFoXyy01F2D5mokkxzCcM+JqPLdR6fgr3bPlHQdQhFHXYvZWPDhF9h8ZbU66bYOlMCEWCrJ+ZS020A7VktrZCtuJem+6el2tGGuvMFW9fD01Mk9HQQH532luCOPOrPopVetlF2JrVWkvrSCdDrc5hHqXFcKKpSq6PRxud7nKltxMirpT0OdwtnA+/VcundGMeCFOIVuKl9fr2ckFEmI7tu6udAYFWzxrAKMLRoCRQ+MZGJyLe01PX1FjYjr6bCvNZG0sjBneAXzdNmfX4d4ZN//hu2lAJsrVlSfd4wNa1XaSCsnftgz6WuO//7X6fCrRO836qVY6gJO//54mB5HG1DCZ5bygy0GqrH0qO6BZitmE8VHVdz0G6dG/PflGjNWCZz0/FSN/77eJaakBHkwv1iQDSUVCmWl5NJTifTp39fepFKrcBuncPz3MWOzjwxTK/rg8EWU0hilToUdpuDZSAfV2Y3V8q7kS3vJfG8bh8pBgmzZBmChBtl6VL18Q3uYTpdZTfuiGfsHmfGySHDaLIAKLJndcDij8ZWUuZMtR8PGRzk9T1UVERloGBDFGa52pEzVdESUOh6XZ4YdfT9SdzeMTtk00Ex5x49LWNS6HTKjNKKsB20SYzJeEfhHv7Fe01X0Y8sGbzOk6qwZN1ba1/EruC9U2kaxGo5UkyAEfgRW7ySkxQ0bS430QssYFoIargFFJ8AdDry5Di0GzqCcIaIQZMYMbWw4XaZElorLFJWw8TSlUUkoavq9kR8ihO5ckbVtnEEYXnMiJT9RsMK/ZWllFda3raK43TjRuOvolDhZ+kxo/jOe8uqXVmvPqsStPfcQL5O+0+EU2XfvxwgOmyXuirBS5oMpOEwaW/cXy8jUtZRFZDJy2Z1/FWSAUfdCQtQoWS4MrBNTflB9GTQhBBNr+QYVYHtOb5BMzMmRSo5MMdKOPNy6zKIruRs/S1zojUp2q2zeVbJW8FcaRa7B19hj3idXmWon85UDJVmZxpcMK53KdQ6UPDYMfj0/Y4y3j43OeqeUGStKbhQt/MDnqEhCULYGaQQyOKgOA19KP+Kj4pGMMnS0PLkeBl9DxPI4PYsFpUKDlmdBcg2Ppa+UDHvHl2a2tOppbFWXcEdJek6bFUVFQMI36Ec8rlcJ83FQXCo8SbDUIxeBPY2sFO+U01kmC/NBpyayCuozVoA6YMHSLYr5XjLjp3JbZQKfH9aP49ftqQaq6myf3AGAYfvkXQ+0MhiMVjL7Sr1ma2y1NVPFctwVetSb6tT+T3PhpwdNpsuYw/IIYjLwmHdubUDJ79C2vlMsqU78s4UnKF25IeUc3YjM4gjEKxBZbgSuBmTYboR63Yjk4phjI6BL0PzhQU3im1Qq9Yi1PGItD9VN3+RWto3Zm445QmJpGpUaN5Rm5/T4fbl+X6JT8+f0LBpKlSz2wIOzR2zi1LNGbUsG6FXjaQn39AgRwdvxfn2f+kK1xyYOOD57qtwFplP807RpOw+vb9ajUpAZeT7kIRJuJZOHYnpB9tiDmNgDtNJSCtvT43JVb0fJqHDX6hGOsmd165UAcMqBE8bfT1/FLtk1KpeLhp5m4xiqCcIrJQzfUaqLMPpVf4ZePgOfYjpRVJswVgJk+g1vLG50cac9XVbsG0qfF58U8AmeCwQgoz4HFffCQFsXgplwR4yqSuVHgX0D+by3APFYik+ar1BLlKnXF1yJjU+xSul7xdOJbseOV2oeM6dHpGbaFcdW1yjJUyrAFGzcdvf/Kg9RZTMoAimNfN0Ou5WLKE+clqf5H49X+YHkO1iWU0txANHAbVJe1ruv2nw3Xt8kulxxN1TJsOFZnEcMPPVSHlTzPM84PFY8RGpqdpSC5/T4szufDpHhY5V3VqidYINPv8lG0qlTzoaiOjUbrtb38e3zev0ddjtXS3wqfZiNlNoDyh7MkmpZajdOwO/rvSBj6BrVnUWxFKfnuqY9jEqSHm116Lr3bgQo0gDD2gIESJkT/nM9XaoMLa1R0QzlmY0GVvNHVac7ytdVkry2arkDcmzQaW9aGgBEW7/O2l/u5C7te5oTyJplD5I3U2BR/t2joUlCvVoCkq6/pSs52vghi6eQoy0l/qlbWmfyFNSxpSQh0dz5cLnG03A/l3eCtXUKevCKoZjiT6M9zj/Wqp2zpctltrJQ5dfqRSr5zClQop2Sx6btFP6M5hf+8/27CkVRAklgN4OAwAAptpZOzRUvn/Q70NUzoKV/gAwcCD1cJulwtEgdrlNNe3YKPzdQL6zCYqNKKD3FZZSEyYMCfLUZ9p13vfTewl4HwDN1K4L9WOmueXGdPGDMAPZUrnEYjIXj6nVczobKhBuVmFRHy9XJUn3OypDRUR6ilSi3U4iOBsQRDeXEPe8uH6/i+qpeM1C453n3mFSk1MdTohmQkbBoUrSckO28+5+/C29zBUgn4Zi2oTSS50MJ42zVEUAf5vhHv8peido01HE8n75KCi15SdclDhYHzg7H46IYvuuUj9q96N2HYUunQlzFtSq+Sh3RAm00lGKx6pZmFPUtjQeinXAbJWxN+4SJ24bWjpKV5YYmliuNiJaQvI5m0xY7s9SMviHt6G6PDzHGo4gRVEGGbo5xPBOWVeTVhksrlDZWYC6nkg9UFuocI4VL7GAvKd7tqMq0aJfmkrnJloa9SfY5aK85NMz5lvbJzPZCIJmSYJX3NUo0iu16/s4fTx2TTjWEy7FQZe9URben6sLn664otiieB0MDwzgwVpwisv9ZspQqv5LT9EYbkRztePmjhlt1ftG0YNQEWG0I6ju5Eb2GI5QqG74wF4M/+alKd40WTSfiuoN2Be+vopVGorFdTw/oNQleKyVYDES7bIdOSgseCNBIeYj8eYvIChUwD20x72ihLt7JDBssNnTFUE6D0Q0VhUae8s5Sn24yEYlOtj+SIhukqazFmHS1S2SXyjfR6mc0VFc4bdSL4Wth/7sAYvaqzYqGiMG50C6FTAs0aMRu0HqMNl4LSVfb5NQqzWmEC/2aHIpCbk8G8Q3fBScfSB1zYtxy8TQnE01d5gFYfqDbHTgv9KajpVsIY2JRYBdImwA6bHOv5fIjBR0eWYjk77XJDriKWlBIJDugKwMfWZe6b6HJ2TsU6xI4JAGnAPlG1/+YUEBQgRpBDNGAgqEBLU4DSoImK46CtCEzLaLx2IDnyWSORQu6AHCFGYuXj83DODjjDgQNkAAxDlQD6OE00Ps0PmdCGuRicacdnqgDFQIIfAzepenBD9e34HHJjC54GwNoHnKAOYL+YgSH/4g3NIL3bcyUk2BYa4AqbDDPwLtlUWSzBtQFBohE9B1b6AlYC5oibNfWQhATm7R1mXcGLf8IGC1IW0KcjJ4Y0AWACNK2gGOCWct26HHAG7ddphAA7QHeqYU3ZQeQO4D7xI7ApWF2OnDkOAv+sKyk6YBuy8SbHmUND8VLnxnCRPM//gxoOTyvyz3foAVxiN5cD0m7HtJ5oIhy4P8LrzlTfaZ9w4I/DM8WtnkcqehddpkUFPa4YieNGDtZqjYjmpyg3R02xG2jDGI5KqeNplaDkZOGB8mBI6hHMgWT3TpRTpcsFqOAaVKd1vBK9WSikm1QdaiRtudNw1fgTCdrury9MAxeB9gK/NPw4Ov6URV9b5QQkqUxyvUjvLeK4+NV90lD0xJfZWOebE/vqdbe1+50ft53l8dUE9JXln1XhksbBxOXRFi31nNX3AMG3AmcyuBrd9kVjoWXbQnhOGJTOQw9xEzA3+CLngs4oJNJNN/QzpVVC5uUMvBoBvQdRUgECyvEk/EyQekXuqT64FTneF7X6odKmAtBq0cO1cMz8plq0WxcbKUhIfF93tNUThh6y+IPtZSHWHHdxty53UqNpUER/XO5nzA2vKDnlUPdjNLJQnOPA3+aA32ja2nOLV0naVJWLqMkfUBD7cFXgH7WcL5tfIzpMtUyl25cRT+jA4uR80Aa+Xwg0nx9uNiU1i2+fae+PV+h99+H6/fleY0d7fV2qKZT4q+0urLomEew6PV++p+5XlMjZpDLh5c4FnNrbU2F6GpAa4q2BgcWt/ArQ0n5K5iuM0GoOU2/zEEamqCWtiqwrEYZ+fGGKoimRgrphkdGv+vGJjhZY09me0UoQ12LycxakkuexZleHgTRNrPIJ8YtAy4vg7jOgHHdYNczLU1ZT/dyX9NfGJWxp5niaXglm2CV1PrGPvfP4XVfZbdGWXmziHdsT1NawVDYss/Hy0e5QyiRD7ex52cD9aKOVXbojcTpGhyHEs7TK2QwzVPOzTxhG6rfg9w8HD8sJyMp11MTlpDoGM+brr9ik/6CtNfpatVPARYyw2HTk6mM/I9PqJ9Nlg0pnVJhpey0VMUraqLYBhQhl2+5F1XbQ1qdNZtfA8L3PsW/fYpaQGnXp5UL8S1M8z7FxQNIXdtMTw+2wkwZNIKYa8S+PcILQqAffqVTfQRFV5b/HIecPQLWFgy8DRBuDQJBkHN7pAZ8g2a7BnXejT1+u1illXSWu6Ogdhi7725qE7Dy0O1pk8M2blWxQW1sRACtrqtNkoAiTZE2HTvtxnKeTc6yifqeenlPP73lGomElQUUMJJbEPdZk9tEUGHvQZDIO11w0df7itpLHd6eBn/JxMols7I00XMnirvhcv/qeqzJnz7BbGmFwbESdtvRgluw8nnVXaXy7aPGZlqaSZhNBF/4WeXKiplIMckWHVlqZ5IlrffLafaoTSuXa4ISEzYl1fM90prJbK0IT1X3PJQivKENgV+ny39fu3OJwW+UvmhDW3NWSq2DJCu3vH9/411KGBKylRakrzaTvqZNNvyi6+p6iHvTVowpeec62maSDD1OZZ9HI2dlcIxBIAMtuYb7k9FqGTvLmpm31NuYhq4r206mAj2qHR5kzX7DHZtsVgtWMgzxnNhitkAI/pS/b3KaFRslumB65CLAkewgx+IGvOMBIwYkhTIzLaolDuqwbsGh0VvPOnWlgy+9yYYyH8yy3WuEqTydfUf7FfPwSfL0c11TbRVIeqGkppYWmGf4zxoQpvJhvLXk63o5hTW6EGcW33RQMApa9f66/jkeoie6i5iE81+29XVq+6KrJtxILRAKJ4Gc+1zG7+ImWpq36+FvxfNo5V1Q9NBiY0VtI3fglraULKM3tkFZqbZsV5r+hRylcNcNWN5BKGvAF206iBD1JpfNslwSpIyaXKBCOYdSy8WLTwKSFZJSlYX24CjzjmZILsfvpX24EuF1cqc0Q75hetoFc4/j81ULFzuVpwZnfzBG7+0avv7+9ywX/3m6TdD+0itve4U4oKEapHAJPl0xitKEXPAt3sPLop6FTH81NI6VqGd1tsuj2XrawSzH1xqhlYvQUXx5xUwNgiphQbaju3vFWpkmG+X7sT1NGUtTM1HOWwnbktWenh7h0lAElxaeyagaunqaZ6uYWfnco+z5tj31l6Stapg5SJCm9bQKJg3VkG0SCWh7SqRWMVN5NqveE1+wP6P55QzwFG9Xt7S6sUG6lpZDLpW511ttRjk1NSm/Xt1SCZ8cpTNie1pEk9Ze9M5knYXTgk+2tKermoR8T5ONcejX7Tzpv/OoSe6QDQUoBls8u688PEAIIAfpGrpsrhNPRbyrWtFQcSU0NDs8GSGPJ6e437iPNepXcdf4jsa489BKl6sZVBGYTb15/ON8Ktx+BYz0HMN6fX8vXEvVPg9lo5YmMCLFXzHBVA6J9tTFgUvetgYalCxuptu0Qvgsu0a1h1DsdjRBOZFUDhkQqpbW8idjq07PXqnZc+qYiS+xLLqojnjkXSmM4vo7kRQTPjkrXe2e9jkUXr5VHIdD1sSj2bVrGbNb5aYPWeGCxnW58Sp6Dx8F3ZlkuhiowDv4znVKUTwN1EiyzihksSxHzGwTqUt5Z+gdo9/aWp/hZEiowOcHgM+6LDhJC4jljaxzf7LAtPHBYIdwdUtUsLW03bdmZ03arTgWeNccjE095LWE4ihTtZa3ys8Zlt15zd4p9zxLQ49KhqaTLawma/cYAHyh4BU+Ll3199PHKdzY636uRqUK1QuWU3Zw16yVvojpFUSc3tjryRhTZfZt4Ot3wpPRKrsiDjW0Fp1RaSVtn/IdABdsgJ+B4K4zyFkBwOyg8uMMEBiQG3SGz+/wRiLNk5rOTnGD0Rpj5F+RgAntcMiJSPOFU+z7a4nKfpFNXhH5GEddfW1shfxTpJmOJlYmKzzb6xXdr6OFqclMLp3OJX/l28tGCxp1/pAckF6d8ZmVPItgU0//trsHX+1Yc1jCY0mXy1B3I9g46uzxqCiPRkigOHrGzzaAnlq/KCUKQEubUxouMs3dtPfqJeuZ5x3xYnw4nyOVfGFmVGbYehJmIrtGiDtKBJFiFKTd6MJOUh0q7ChyK+rDCTu15tVgR9ET0nk42WGkTa1iDmhpN91kJL6Wz9VHNrJm7CkIbrLwfr1/r+m+WtW7yrlLJhNTC+j6JloFV+UsbJONuIDCPlECefyoMGKUDmSxEWabvgUVtPxwA4V3LT38sdkcuyaqVNovvqMx/ZzvPrzvz6dYt9f8LdKxNpzkfbJR4Yvt1XCaGpqGh+i7No2UWNzmM4C+pEL9NihqwJb2pUdDYWlSJ1MepLwzfW2ldHJ6RWlit1ZYBOHHTXQ6uqpgJKUYtjVNoqk/1/3u7XUuCLSCu6EUV2gqOFrRGPhGkaLxq2uBHyUGYgw9duO42+d9V8jaDIrJj6b34+jnZ/DOPz7D8X8rjv5WtTJw0u+1lUrDhXqBpqd+qzDGIK4K37lxzsIQJ6+W83X8N69pm5hB3plz/8JcpUCotAAGGipEI98FXkeh3aNoxOIU9ZBP7hMWwHN4X7L8a40n8YryxP5s4idPV2MXaGVjZW/l7MrEseHhSDJ0OhSRpFe91pZWILKBFS+aV0w5lpYgk4mpZ6bWetJLcAxn0azZKfdR36sP9uN7qTyUdNsh5WkAkzCOBu3J6GqSe9X6DUo7Y9FRaFOXnLGQwrboQbQD/gzi1BbBgIM4dQ9wcw8IKRrYbbNxPhVeipUVuM4CSIlmOADW2lRBdi3iUqArXUcJHOqlcYkVgPpxcHvyNdCiR5Mwk+Va0GNkgOhaQDYHipCQplZJIaMAiI4DXScrdXCEIsEaaF1qsrCdwhMTrKXAxZVDKYcNqXY/YH56zCeQzloABaxHd2uLXx1K9g0FSsW7eAsH+KESCsrUMy33RANf6/kzqAqmp9KOcXiZnJHew+a4CvpSdSlwPr3b7u+KNcNI1ROHBmjHmcNzxmF6hSk/U/oMSmeP3pGEjyvfRW5XfFZuJD+UayBalKE7bn3OGme4HjTWMN243lJ5+fUCVYwGFIsq4O/HQtNBZaXSzkqnx7uaF32vyig8TXPaUzYcrxi5eC/jTUdpfaPImmiD1e2kKTIV+Yvn1Zbb6XZ87N6P5yJkUBJXHe3JuJ13p8tMnzcDb3UtUd4Dd5CuP/taKgHHEUTS1Dqn2CsbdGO9HiaxjCJ7p6heXWrOM77JaKoGv7DVZooKipbL11vzF6pKItenyibmlLW2YZWNjVdXhYD0raIqzfUpWhoNlgpZdxWLgbIg3Axdx9e1l9saRb/PI7przcFVMs3hq6EjjNZEg51KX3Hf694vuq6uh/++rvW+AqMaCxxnIA1G1g+i2Hs999Svh7AHPstO2V76xJYrF8fh80JKjEi1JxmU0hfvsl6sqQcpdLHSnADQ38F1cRDNcqAf8YliwniLtQhNqJbnKiKWVBMxyyRHmJP8jdwLFWkVsKZarm1AC9FQ3GRU/NCeRyffpO8pM/ut0LK2EhHX8cxEGLbtdIqHaSls4xb7bC6HU7TyvjudKUBHAr58w8/ryG2+L5mtlSJUCNs37map71VwvSrnleKrNhXa21Sg28j51quHSiVjAPGhgeJDx1Mx2eLzWpGVbFTvueFrM9uZibn15iJZMxyHAM1Wwgf4VQHvdlbDgOipURj5teLq7hQOlbcRhfFRKyUR7xWxlXykAQwsnDt3sRahIMSikp1ApNPy5X8//QkT9T/fisVSgdgHvv/drzGDF+G+ajP2KkbifuUyfNUf0CvMoaGNnYuBevlQfh9Dm38WSYXrfU0CoMTsfUdlsxYTj2tZZ/MKyE/J8OP427OqbizXZEoGDGDWor3/s8Wqty7R5obyfM8GpkO6SIErIpStR4rkiVrqSMVbHY9h79fnVb9Io7x2CtypSeMqOv6BO+sbGtNy2x4z3RhOdKAiTA7BDCi+eiTQenQy8P7F2+vtfNoHr3dqSI1SbFUEi2KU2DS1WthSMJvKTZWAJ9nOxxu+w6jtw3iQhzGbe6uyoGqk72lxYRr3vNZEAHpFUA1avS7/onTL0Wp4+4d3UvlQ6riGbrMbTrOSp+JCZpOFKgLDKFJd19GS8YqjwMmsEgfETeO2mg/FPtlRGsnJyuX6fIT58YhdiMzHkrtuQ5tNJnPbrpLEJNIs771w04ZWNYgkz9y2oMbuaF73vvsm7Vid7ofl46sMvcaqvPCAxvyW9q+EGVs44tL55O0cYVw1762ohjnCNAx/FNe16rpst4oDYyhVv7j0alqaLyhsVNLhyuHiaqrB0PMaVz5b9Mqh5TP+8F5fsF6xxbPtNOYMdb5B1aA2RkVdlvkBCnyFgiZ0VNEi26i484qe1/PW98nI/r6igZMeBEV1xcHrtmAvoZve0fR5Bekma5GpQGUBEKYY3mgp5gHDezjuCrWeXlGJU589mrhezn9rtRXdpLll4bbb/959HEsBlkjEIu+CxiHRRqUy4FV8bik0LQ5PzHbagHoLLT1Ht+Egg/qsfGrvj6c/x8irrXds1fAEetIWlKVcECmYPN0iiEgtNFVc4Hi/mZ2j2q6iPH8aAMU0QTDyZCehanXke25pZX8ukCvBlOosok1cyVRY85Olmhcn12C38W5giSCTRulX24GfSIsl3f0lcwp2oAmiOLjAxklf1jvqPk8j42QtRivkEm2Bx+hyqltFw7Sxi4fx9+9ibKuuzZdaGFtLkoaFNqqrb9z9q+yAMioY3th63+/Hhy7hylB8TEWEkXbZ3Y8fx7J+KRGJHhwKXUKce0uV2iZrc7PD/XUuNmBFU9JROYjZxnq0rKp2G2fIrO5RUlcpZi8Ks0yjy7qPlYU3Lvs4D/+zAmpaiUvqkKfmIp/S0JZEfCtnqeESG8lehduzV6CFjS1mtlCMH1QHtOdRzTJ8qmyWr0eprhsH9j1H47Ng7lhA/oxXeGBAZLxLgaeHIrfn0paL5XiCrvYjp1RieAn3fozctJMcQFHfV2Jivts4GhYLj9+nW2FBpWc21vWsUqves1UJJQr/SWPXFM3y8B8TH8vI44xjpPHQ6QWxKfapAur9xv4aTezOatZZqZTT0woJxrI4T0599M8Fh4RPu2jwbXeoQEYUE0mzsT9FEwRYr+6o3/Cjoo1FQDv8xb3QTTHGKFJGimaeDdWT24Nyl1NHs2839phobOpf0YGUKru3KM3xzMlkKAZUeubIzk+a+8mDi7SWZHKj6bB5dOpBrTISqg5Uxztz71G0PXyf6Z+qfUouIu8pi04IrSOhT/yzsuFANT7wBMkx1nVm3O/a4VUE4RuO2Zqg26gGVNeh771LqRLH5Zm5pKFmrUtYxx6iCOhzsz24FyGF4HiKU1+RJRkUFSLN9RNbqxbFRqm9LCIj/9YegQaqPhFaH/w3wtFyC+ZpGWWonimSD9lSbG3VUi1f5JS5f/fOOLpTYSlbyspUmKsXbBUwk8srVRpLNEl3AsK2qdJrIfFg7cZ+P5k9HtbkeZolYLFEK02LoVr6VlYLElreQp/Fug3HcJIXL05o43pFlEgbWLbUyVXhhTtbk4H4ajJyTy9GiX7bcDRCFDf52pdIacGEFmVh3DYU5DBZq7Yo9Oo4pIguZaAKkld0Xxs7zCM2PP1AqiAPx41ANZpaAeRVjtECZmM3cpWP6zn4ZY/pCVe0d6orjYIGFiOrc61T72Wk5bNlPO1BUNpxZuszRTOUw08xmWwknycrm+Vx5fbTlujFkvZ0O4VcHTai32nw4zMc+fGd6Pfaqve69UJKIse+VQiDjSNnHlsnCHbSYxk2ciILLXepFao6Tp3fcNw4r7ci1eFQtWRiUqvQeTjZ+WEHYOfHjf11kZTTYGRJqjUublfW80JlHP0k4PXDwZMrbMsPENu7YSMwXe6G4Dxb9aHTJQxU4QwSxtYABE4B6VxOzym6eE4ok3Y+nY2RzSwQD+tsPpOBSt/I0f+wpcpIbiPzOFt5Xicq57IHfVCdxRTDlqxUqsWdmCZ9IiofEhfQ0OMboGMD6RLLe+/uhZPTd/JUNEJVC7I1lP812Hqdy9571V7OS37HP9ffx7e/H/dd2ZisGPiDBwDlN/RL9YDv9nwzK1ySQVq1jrKtxHF1PRWv9iAg/6Au4TzYa9uEAXUdd63FhWr9yKoDxlANmGjmXyF1FVUzz38FcyvOAOMUKTlPPi2D/+wKf15mGp3jUe8a7Cw9Ag+ZP48OvpZCcyZj6PvXmVfFxMGRE5z5R+6VA/fZpYEVL586WQfu3LKUvMKy8Fp/GB51h1//nM6n3f1vPqCrKBtF28xdlcJo3ZRMtlBo4mJq67iQtzTwnMtsqMb2qora0NC0lhdQi7ctOf2SlxxuhU6cMLzIVyqu9o4XD7Q4cKckbEceSL0u+/NJj1Twetp/N498/L3s9WhFeEO5GWLnEK9/SgVz2mg7Nx8djuewSjGfMBv0S+xU+o5O+dnkxxQ7rRzaTiEzM6W4pTnNx+4cQ6eLzkp6mfKKsB86+uuYJ3eJCmhktTA4RukAaWgf62MXtRv/JxZzIl+DjjS0aDudn2u1rL5Tpw0I1NtEEuc76gg99tfivFB4XM+b1h7H3X3/eTt91RgJrOqn7GhHxOO4v2vny6m0Nbg9DdfmehyDM3hYyKepOKZaixSbxmyV+383qqiMsgI9pmS0xnHIHh6o9tkWwq8d5TyarZWJbe/VZE5NXsbQYCLamZIKUQ1S5xTkZstVwKOBR5jB/41qcOH8eBXQkKZR5FSU7Cjbed0Oq+WlmmdHyuAUjWgs9aDI/Tyc7awxxAnnI2NPTENW4fYKBmRophREwzXyH5WZoMw7ddbjUfnBHXTAeaNIsPOn8E1Vk3VDj6V5ZPi+76eP15pcWlnhWcLZSlUHd1S3wb9HNECXtRJrpU03RYCnOEX7FJmMifphBPH+AEpG0Lg6C7EQhPLOQrHYZqXkHsJO2JGh7OEQ7TlooziXpLOcgwSWSzcV/ggk/D1+JbiuRytriGj4tHzS+qes8fGj5/icSJPVfi3Lg1DcHhFN2R4PRXOlwe7H+fq2mf6VK7rh3kPY02qlF0kN0FNEaBwdYuLTWhNWrntP8VAxn7DQPBZFUFk2p7nrKWFMq3RKiynsRFC8RjDbZx0r6HD3Cdrt+hG+LwqHA0YM0OYeMHZIR0kI+jB243B6Rt9tyuT/2Z0L30ZBcmlRoobnUsR5xm19vLpchMwFmyHpfxneFxIsrZW55Mun3sznbq9ROpK2yMIfs13+xf2raGx1gAwqj4k8T7CIXzR7VM8vdyq+or23GFzt1ekU5/VAKUdgJeXLtRH1pSAVOnJ/+vP6Hfzy/e94S8X3Eh+sTYnaLkFnhsRfM/TIi1JIz+N01gwLvTqGwSFroeJiG7TaNwlrYxvuwUyk+fPmp49qCfJq+IcNa+Z8BLPnDOVeLwSreIdp8m22FtNBP6QbnAzNPccyzAafsxqrnnyKFoDDQx7h4FerQJFKC5qjAUCzDENLsD8PeVnvk6Kl72iTWrxmHYWhGHc56jpCyCb36f612s07pTOKzTf8oq8g0vXXAPqd6remyQkxvqYa1rZqh6ZFmsf59VErY8ub4P7DxAJZnK6DLBzaNhEH2Jb7tJOZMsfbN8pFoBQT8+gSTqmEeTkxQ9i0dL7bdEpylqe0p5G/dmXfkFeD6VycBq+xRJ3CK/e06CrGV5q8FU9lzw+kyUjEuRfDVY8436Sm4SuV2k61RXC5m+m4CKFZQY+pu4w4scgjruPDLubKJq1dPfnVG+ioJMk6IaX6boH5XhYzCh1N6mo2UJE1Ho6IT/IMBgCQWHZOv1JRxywtwfFXOsZMh17czudSC36leNf0STfB9OjjHZJkr/WJTy78AtYLxSRr4MtDKd2ibmJHhC/Q6HUOwU1mqss6gQibegcndsgOK5xTqP8OwJ0NCIwG2ENVzYNB3xuPXymA8iiLhu2NT9J15lK26TufS2zMBM+LjOrYGml9bTbByUNl5DzycG+2MiVni8SK3ClHngqZDJyiblLxGIq9lMIa5PhaVDaqFMDID9LJziM8yP650kAeFWHvyM8ekWZi7auqJ5fuxcLQkvkuIFiNyo2MPGISllbPFaxYZYXubMIKFylsFX/W9sSbba24KJ30Rge+05Y2VvhAWQjgBO/Bzvfl+3r/XYJqZFrQ8E75x+24j5pYVXFoWUfoaAnwcTufniFY2Z+POx2Me/kQnssaTxbiH+5mGvNnyaXeK7eL7wjPolzQtapE1CT9YN7eM5nY6bK6ogfz6CRsARbpaMVuVQ4ZVLOah+J2i0bULiWF/EYoE81Wcq+DQjr4JMFuN5I50dK/EMlTdimyKFoLdiJ0LvyxdkIGq5xHvnNkG7UnVFKEnucyJysznQwBA8nb4TzVs6F6nlu684ZH85MF0SdV1eSS6ZuN5MRkawlbq1qNg3SWraOdHrOl1Md7vHyEmLiobStpCF7dnA193q/f9bdk1Vvaup/XY3/V2i9WIgjgnvUpGQw3DcyEFnSwbkguphtT2if8Sn87muSjjEgtj9C0GZFkHuF9jfClxhZ/1uEayOCOCLSz3sgIfw18ib4B/KhBD1iT7spDbTusFPw7hz/z+HeJ89kjr+KRVwm/kjfXIOhvki8afqXr8m6rSKqmM2GN2lL5Ml6lVpSa+5Due0joJ6RP8RlGl36k1rhwnxk8iF/p5RoHAmzfIwwAQ3VubeyT4LYZM2cwKHlGjBhz4RHpK7joFsGExTUsAHsW9NO2x9/2fXa900flwPrtZS4dOscTGtLGrNJ1mLo4CrfOyopbx92olbnaHm00k+0Pz1eQYHa9OrNTUBO+DzKdwMuN6QgO7/OHW95Ejqm6ieMJttlUzYRM7YAoLytSO0S0bYOYlUfQ83XWOGsny+LhmbcWn95HZTDTpvCwTcuqTe+2TQrzbZrHbUoR9l1eKXj/aSO0GblrUG+1aWMNvxJ1jusRRCOH5UGzjI5w16arhamdNuqNfFt83lr5VLXujmnNWcORMNFSgckxqp+MhwWVaaF0Dxq8BNT9uFJJZFvZP7+K87BTuL5hYwZFrpaVHJ9i7rG08TKOvoUA6XhZdasYBVDyCWjmOB3p4/V2uMZ+YRicqMDX4POwo0ukkOeFgGQxZ96Ji6eE42hTZsUeyeSrFm5e4Hq9zY7nD3B06WBZw2MIbm6ly6P8dMNLsMlkQZyreJB5uPZa0ZyorlFj00z3HU8AzerL6yT7KAswdiPbKw0c738Knd5R8jnYnjYw1IhwFOyUnivTwH8NOlXVEP5Sos2fpnWn+lV4YmpmTt1/HledIoq4xXE6y8XEMZNflW3lkous2XiuxQ72gCJ5qOoqiFs9WG19S9HhsD3r4WhIgTzYN/B1s4kSzyp7OLr2h+s/6m1BkUddbhpo47egeLXJy/WWA52+ZyHrWJsoXp0EkYUzlS7a2cJ75JHUBiTy3XNA9OPvY79qo1S0qA3VwgljQ6RZoTWSoLwQzLMt8Ln7HTtMb8Xkk5O4oafZM+ySBXpSFlTBoGc4UfJsgijIKhaf5aO2KXprE941HPopGzPAGwI21w70vc/XXvbcx1VR+Y2q9N1RsHcM82sdH6NCXgzUU6/RffVObUNpYlubYiuPFpHwCwQNtHCWrvHrz+5+ioxz+mKqdYuu5GTkQLn+1RPz1ncY+ukMV0J49JTheRavMj8WuFQgwkybajPWOPyC4wXkhDOoQBnAlEyC8odPYPEJ2Fam73LdA+8VkXJLj2bYqbmQvVduD2S7Dd38krmSW9oooapwP8wblgamf66NyAXcUs0HGFlTVCvSOQ54TRZqyIKmUzySFMuTbKx6t5T2W3gXWIS01p5MaRyZYpZs6amHwWtSSN+p/rhMXLOxau9fGr9lFP0HpbuLA5/X06XoEfCqXECbn+KGrp1YJaZGPY447tfn80ufhUoXzre0XDKN/trdfx+u30W5pFfLi8YXk4WLK8YqXWF+msSxz9f9WS4lVWJpKZv3lOddHeStirM57VPUHy5iPtm05zjx1fO6312ul9M+qq+f1q3siouv4zvBNfzJ7XoJf/b4z6ME+HZKQaWnwP65H7Z4DtX/R6OG53UmRioZkTo1mt/+LESkaz6qPDWijgRG0w5eRk91WJ7X38fLD+reihui4/7W9RwbfVfgVsWcQIP7MPq6/11tT/VKDtlSYq3nNf6jwwrC06r4nSc5w/jj9yp3opjoLKoHFg1NFqeuo8nI53WmCK3cm5rAtBckGLifwum8O69vcFQ3iK4vFDWsB/SERnzP6+2k+uQGRc3pUzbQtmDD7uDYcumLYDbpoFQeXdHWcpfsmmj6ijhNxbK0nScRGD936rgaFEyjTU0NHu66dwhCvUEjAVUPeF7T0VhSPPReuZ60iBoshH2pQiVrVLTtaeowRCmXx/u1fM3qdOn46kmjI8v88TC/tJLiS7lMlLwIpqrya4prkMat4fJf5+MuKs4/zrvHZ7FztorClYf40Uy4ndOZ2lEMJtwLfKptzUmva0Tz9oYPuDp6h16h3yn37aobRYIrBkDlAdq1SJ7YNsMM8GedwfGQMhG2w7/r0Yzj0NTgaJ9/vLWDBBHUGsplqG/7bVv/jhRNnpkboVc0WE3rK4UyT7eu+mJsFD2jpY7ya1J5ey/9Jelld5Sx63WBYiaTSFCdcg1diq9LfJE/aYmoN7JlqV7plyva0CNsMrCpxqkk12hYONvZVH0QK4sXKIKd/76qTYjqXKITJIzX2SUJSRsAOOCwpWjg19vfZzlBJdo6DOf3/zt6bsHjOe3iZCWFG68OjySS7DxUXKFv4VoKW3td4qnGBEBbmaUxLe3ID1aCjxeziW+7/e+Sl1pxctNl/bp8XQ8x3Xp4nC4FQXWj+qqhVhd+JYRsQwlfXpfHcf+aROAez93l+dOaUecP2/WT0enF1c3IqcrfPszM+PzHJJC0v+ozSWLtB4p2D8ZS5nwCfNeXtPK4KdhD2MI0ZPuVIrKnzt6609lLKJAxEEK0AoWRYh9eVp3togkozaFVW7UinXM9jcgSwvV4i888j9bLTrGN0PgL+Fady/AS7ma40sc8XGDMtJFRGaFTfzIy9UWt/bVmVOcdrVbORsKRV3sXqr7Lt4eE0q1/mrZVYRw/eSczFcZfBfJNUH7jaL+lMFTb9Iyi2qE5+IT13eBMlJ/JUbJygIY/v4+nj89nWZKTaIWGkkDNVhKX9tJSqraRUXFUJbBaOJzTG7M0gp6N14xK9NiYtuPRbS9XtrRUywFlcJltrME0Rp2vHEr6uoVlGcmSV+ypgyq/OO4y3crmAK8yTU0LsFryu02PF97zhXI/6c1VJkjcAPbhMX0yN9qMawT+scXfdhjR488yWrDJ2ETgCxPsxzceSEOA3JoBuEbKJVIy/ivYOh/zayJ4UTm4Vh5WZsNfu58rRX+jOJE9BYu8HquGUVnA4cyPr8I79U5t7fyEeUR+icOxFkWohBzFNEUL67KHvG3PtQxeUc3yG3HIuuNekbilVioHT4vSAv7pvk4fs0Ag461Q6CmuiVS3tCKjUc7pQBfrkvss6X7kQ4LaAm1b7FhPxqas8+NUOhmN0vujNK7ZyiJMXAQKreI8+PFmDsf36T2VEYJTEQKdyNlMbOtZNz4ZBTZ0HYUWJ0MEOWEV43pP+fySGSZvEteWfDCwOXiwhvjURe9aen6ny8Te3uI+5Xvjep4wIIBLOhEkV1ILtGCXf9Hm8WS7QhBkRhXVU884mfg+PT/XBR7Fr9vxpTgbCac+68sLnoTMd400AqjL5akzG4EdQKWcswrmKmVt9YI2DbClo+Q1HI30107IoPqiU1sDiM3BjBv8yo159RLqlzpHKBldtl61tFBwy0vFVZrUmUzoGq68tm0zG09OsYOrxxv8Sthi72kOdb7W8VlczqvLtTCNX62F6c0PVKNqM0rgyW1/jBW7aKPkSuzWDj2PJry9wVCrDPHbuOiBnZL74pS/dfCNwjdQQEEa+xbGlTWDTlYpzUid7WSjShergCOpAme5HkYyFgOR0pbq/qJJ9z/73b1gMpCQQt/TYPrP8f521VC73ihOMSDmG3SKNOgUaZDGb2iUFRm/YoSsvEqvvEqaD57Gam1rMbHSebM5OPH/aaIrmaUZadPYbOH4z+kx6QvWMpajpPe0A0oTXM9pNrpO5Mqpx+m1Ii09a85T6AZKY7tYKPtZ5OoxQ/rq4dPQl3MKh/AP7YJO3RFdzaf787UuFRslGu5on/8yvFaKVKWCjUPz9DgVu4lXrTIuAdkM5wr4c93v3l7nXUFq0Y6qZMd3AQyPPUAFKkFxeffcVYWNdflaNTn3NEeaTVT0E5RmUs8DgevpUCX+V2qQFHwyD1/xJ8nSZ9h4fh5dpZ5TZE+0GfZ7t59wyEQIdFCUmFyVsmKmjPcGxQzAlWSTqS1Rc8mWTx3o793pGSL0mT3oeT1qBjGjtOXcQKfa9+6u8ZKNooBErxQSLrZp8QsiOw1tC/iOodJ7eOR6wl/WvCzdv7+Pb7v9uVa6k+cq7UoMwz+v19+x5nA5nm1jFZhtkA655amYtZXS8RoU56/n72S2dPw6lY7C0CsvlhYRFwtTgUePV24pn4XlQMX5lVKBDfpWG4d9EyQ4rsefJe/BIKawNvEZWp/8bssLfdP9/Fo84V/EHW2t4q6n0BttrPxICrsXMcZbVkpQTat4LjhEAYOLs1Bp4BgOacb4NYF/o14C6IdaWnmbbK3tyByTAWehafHNOYB2srhq+nQSkzgAnNKgfRN94gbuZtSASJPI4FdiNDKoERvQNJoW7NOb03uuWOodWklfAdze0r41mImLvbpaFePd1hfIdmrHkNyrw/38/7Gzyi8MvUKY0RyOMlZTvRwGlSCi+GBlaJoVhRkZhrSUSw9m6h3jg2rJ8FtzczZDdvtR8Sy13HOo2Cm3klFxCrUUZApbVRdEda9TJH5pY/3dtYblz5OopPwbFDCMguAzGuAHLmo5pzlEdS4q6hSQJOGgZYYQs4TJdqk5mPIMbGjpWBmo+pjyhXDsQMxgJqm8KUStSCXL4gfPx0RLlcGqDTjrjqPuBbki72gNK5quyzgrOKxNuQFvu/wLTYQg8HDIoDmAVOEZeOjahuBg661Nvm/lgRWDaYurg2bEgmbEAizr0POFOolHtOdd4nDwPPycaa2+dpddMaE6mUgxHEtY5cWyaij1CO+7220XIsZCIlsJ07qNACWOj/2ut9N9kdrGy11Fb6qDkE9GbbKapZQvxnFFmsXUNGwGR67znaovg8KdF0ucE1wuNE97BiYzkQB3vXmoiKLZeDunUlhJoSm2hgEOpPNP8iwZkJnLXMhDovewY/LR7AhWi9HjF+giR8RnI01XTHdU0XWW5el+40Uuo8tmuVFVlwZg9rlW4mzqun9Nf6rejDKF6HNArDGAeWxE1DGCSHMEQ0jmDwFpUngzm89WpUhUTAogZA83NOCGYN6gVoS2mNHjA3VIMwIB0YBhs6dsWurWVq9eSg3ZAS0UXLLo+/s7Ftw3UhJydvc0m/7Po0xey+XY01XxNyZTwv9VOhU7Fa0N9BEmE/vzqU6EblUtnqLiJiO1m1CiaQMFiU7jqwJpilA3WGCnYrTwp/oa1B3Uj/n/8//+P7fTLTaChH/2//2f//3f/wtt+rajxAUPAA=="; \ 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..8dd8966e8 --- /dev/null +++ b/7.x/docs/classes/AbsolutePathInteractionRoute.html @@ -0,0 +1,159 @@ +AbsolutePathInteractionRoute | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..229e4c38c --- /dev/null +++ b/7.x/docs/classes/BaseFileIdentifierMapper.html @@ -0,0 +1,464 @@ +BaseFileIdentifierMapper | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..974a4d078 --- /dev/null +++ b/7.x/docs/classes/BinarySliceResourceStore.html @@ -0,0 +1,325 @@ +BinarySliceResourceStore | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..88a485486 --- /dev/null +++ b/7.x/docs/classes/ConfigPodInitializer.html @@ -0,0 +1,215 @@ +ConfigPodInitializer | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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..40895fac2 --- /dev/null +++ b/7.x/docs/classes/ConstantConverter.html @@ -0,0 +1,226 @@ +ConstantConverter | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..4261c6904 --- /dev/null +++ b/7.x/docs/classes/CreateClientCredentialsHandler.html @@ -0,0 +1,235 @@ +CreateClientCredentialsHandler | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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..26b9c7a36 --- /dev/null +++ b/7.x/docs/classes/DeleteClientCredentialsHandler.html @@ -0,0 +1,199 @@ +DeleteClientCredentialsHandler | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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..9966eea6f --- /dev/null +++ b/7.x/docs/classes/DeleteParentExtractor.html @@ -0,0 +1,213 @@ +DeleteParentExtractor | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..8c6a80fcd --- /dev/null +++ b/7.x/docs/classes/FileDataAccessor.html @@ -0,0 +1,561 @@ +FileDataAccessor | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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..73d173fa5 --- /dev/null +++ b/7.x/docs/classes/FixedContentTypeMapper.html @@ -0,0 +1,504 @@ +FixedContentTypeMapper | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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..361c0bb19 --- /dev/null +++ b/7.x/docs/classes/GlobalQuotaStrategy.html @@ -0,0 +1,227 @@ +GlobalQuotaStrategy | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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..15279e189 --- /dev/null +++ b/7.x/docs/classes/HtmlViewEntry.html @@ -0,0 +1,121 @@ +HtmlViewEntry | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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..89e3e0cc3 --- /dev/null +++ b/7.x/docs/classes/InteractionHandler.html @@ -0,0 +1,175 @@ +InteractionHandler | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..876832a43 --- /dev/null +++ b/7.x/docs/classes/MovedPermanentlyHttpError.html @@ -0,0 +1,239 @@ +MovedPermanentlyHttpError | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..3476e18a9 --- /dev/null +++ b/7.x/docs/classes/PodQuotaStrategy.html @@ -0,0 +1,262 @@ +PodQuotaStrategy | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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..7284a5d44 --- /dev/null +++ b/7.x/docs/classes/PreconditionFailedHttpError.html @@ -0,0 +1,228 @@ +PreconditionFailedHttpError | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..41f51c3da --- /dev/null +++ b/7.x/docs/classes/RegexRouterRule.html @@ -0,0 +1,256 @@ +RegexRouterRule | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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..4a0ca05be --- /dev/null +++ b/7.x/docs/classes/RepresentationConvertingStore.html @@ -0,0 +1,379 @@ +RepresentationConvertingStore | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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..e7071dc2e --- /dev/null +++ b/7.x/docs/classes/ResponseDescription.html @@ -0,0 +1,142 @@ +ResponseDescription | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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..38fcd9aed --- /dev/null +++ b/7.x/docs/classes/ServerInitializer.html @@ -0,0 +1,229 @@ +ServerInitializer | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..bf536861f --- /dev/null +++ b/7.x/docs/classes/ValidatingDataAccessor.html @@ -0,0 +1,343 @@ +ValidatingDataAccessor | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..498dad0c0 --- /dev/null +++ b/7.x/docs/enums/AclMode.html @@ -0,0 +1,81 @@ +AclMode | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..26e95d01a --- /dev/null +++ b/7.x/docs/functions/absoluteFilePath.html @@ -0,0 +1,79 @@ +absoluteFilePath | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..c55ce93b9 --- /dev/null +++ b/7.x/docs/functions/isSystemError.html @@ -0,0 +1,70 @@ +isSystemError | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..1728e5ba0 --- /dev/null +++ b/7.x/docs/functions/isTerm.html @@ -0,0 +1,74 @@ +isTerm | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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..210ec7856 --- /dev/null +++ b/7.x/docs/functions/isWebSocket2023Channel.html @@ -0,0 +1,70 @@ +isWebSocket2023Channel | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..642a3585b --- /dev/null +++ b/7.x/docs/functions/isWebhook2023Channel.html @@ -0,0 +1,70 @@ +isWebhook2023Channel | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..21e106450 --- /dev/null +++ b/7.x/docs/functions/joinFilePath.html @@ -0,0 +1,82 @@ +joinFilePath | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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..453397c94 --- /dev/null +++ b/7.x/docs/functions/modify.html @@ -0,0 +1,87 @@ +modify | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Community Solid Server - v7.0.1

+

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

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

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

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

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

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..0323aca42 --- /dev/null +++ b/7.x/docs/interfaces/AppRunnerInput.html @@ -0,0 +1,141 @@ +AppRunnerInput | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

+
+
+
+ +
loaderProperties: IComponentsManagerBuilderOptions<App>
+

Properties that will be used when building the Components.js manager. +Sets typeChecking to false by default as the server components will result in errors otherwise.

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

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

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

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..3caef175d --- /dev/null +++ b/7.x/docs/interfaces/AuthorizerInput.html @@ -0,0 +1,108 @@ +AuthorizerInput | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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..a5e626581 --- /dev/null +++ b/7.x/docs/interfaces/ComposedNotificationHandlerArgs.html @@ -0,0 +1,106 @@ +ComposedNotificationHandlerArgs | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..901d01af6 --- /dev/null +++ b/7.x/docs/interfaces/Conditions.html @@ -0,0 +1,159 @@ +Conditions | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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..9dfd664da --- /dev/null +++ b/7.x/docs/interfaces/ConvertingStoreEntry.html @@ -0,0 +1,92 @@ +ConvertingStoreEntry | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..c02dea311 --- /dev/null +++ b/7.x/docs/interfaces/CookieStore.html @@ -0,0 +1,192 @@ +CookieStore | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..85a8e052b --- /dev/null +++ b/7.x/docs/interfaces/Initializable.html @@ -0,0 +1,104 @@ +Initializable | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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..1c4ab0a9e --- /dev/null +++ b/7.x/docs/interfaces/MetadataWriterInput.html @@ -0,0 +1,92 @@ +MetadataWriterInput | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..741e70503 --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannel.html @@ -0,0 +1,209 @@ +NotificationChannel | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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..eccace50a --- /dev/null +++ b/7.x/docs/interfaces/NotificationEmitterInput.html @@ -0,0 +1,92 @@ +NotificationEmitterInput | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..95de36f98 --- /dev/null +++ b/7.x/docs/interfaces/NotificationHandlerInput.html @@ -0,0 +1,106 @@ +NotificationHandlerInput | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..6c5500957 --- /dev/null +++ b/7.x/docs/interfaces/Resource.html @@ -0,0 +1,92 @@ +Resource | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..91389e3dd --- /dev/null +++ b/7.x/docs/interfaces/ResourceIdentifier.html @@ -0,0 +1,92 @@ +ResourceIdentifier | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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..36a33fa09 --- /dev/null +++ b/7.x/docs/interfaces/WebSocket2023HandlerInput.html @@ -0,0 +1,92 @@ +WebSocket2023HandlerInput | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..e24a1dcf0 --- /dev/null +++ b/7.x/docs/interfaces/WebSocketChannel2023.html @@ -0,0 +1,217 @@ +WebSocketChannel2023 | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

Community Solid Server - v7.0.1

+
+
+

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..ebcc3ab38 --- /dev/null +++ b/7.x/docs/types/AccessMap.html @@ -0,0 +1,64 @@ +AccessMap | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..1a8e2ca62 --- /dev/null +++ b/7.x/docs/types/AccountIdKey.html @@ -0,0 +1,61 @@ +AccountIdKey | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..74326ac37 --- /dev/null +++ b/7.x/docs/types/AccountIdRoute.html @@ -0,0 +1,64 @@ +AccountIdRoute | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..fbfe7f69e --- /dev/null +++ b/7.x/docs/types/AccountInteractionResults.html @@ -0,0 +1,69 @@ +AccountInteractionResults | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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

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

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

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..68681b6ce --- /dev/null +++ b/7.x/docs/types/ClientCredentialsIdRoute.html @@ -0,0 +1,64 @@ +ClientCredentialsIdRoute | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..bb1da77d4 --- /dev/null +++ b/7.x/docs/types/CreateTypeObject.html @@ -0,0 +1,70 @@ +CreateTypeObject | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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..0ce4e4839 --- /dev/null +++ b/7.x/docs/types/CredentialsIdKey.html @@ -0,0 +1,61 @@ +CredentialsIdKey | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..330cded9a --- /dev/null +++ b/7.x/docs/types/EmptyMapConstructor.html @@ -0,0 +1,72 @@ +EmptyMapConstructor | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..ff3b8ea84 --- /dev/null +++ b/7.x/docs/types/EmptyObject.html @@ -0,0 +1,61 @@ +EmptyObject | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..094ca07cd --- /dev/null +++ b/7.x/docs/types/Expires.html @@ -0,0 +1,73 @@ +Expires | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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..5084849d4 --- /dev/null +++ b/7.x/docs/types/HttpRequest.html @@ -0,0 +1,64 @@ +HttpRequest | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..0d63baa39 --- /dev/null +++ b/7.x/docs/types/HttpResponse.html @@ -0,0 +1,64 @@ +HttpResponse | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..318ac1c01 --- /dev/null +++ b/7.x/docs/types/IndexRelation.html @@ -0,0 +1,86 @@ +IndexRelation | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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

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

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..0481ce589 --- /dev/null +++ b/7.x/docs/types/Interaction.html @@ -0,0 +1,61 @@ +Interaction | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..3f5267b58 --- /dev/null +++ b/7.x/docs/types/Json.html @@ -0,0 +1,64 @@ +Json | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..6301dbe7f --- /dev/null +++ b/7.x/docs/types/LogLevel.html @@ -0,0 +1,64 @@ +LogLevel | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..08ed3f578 --- /dev/null +++ b/7.x/docs/types/LoginOutputType.html @@ -0,0 +1,78 @@ +LoginOutputType | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..1359d9367 --- /dev/null +++ b/7.x/docs/types/MapEntry.html @@ -0,0 +1,66 @@ +MapEntry | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..5d5b68475 --- /dev/null +++ b/7.x/docs/types/MapKey.html @@ -0,0 +1,66 @@ +MapKey | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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..8c858ed4c --- /dev/null +++ b/7.x/docs/types/MetadataGraph.html @@ -0,0 +1,61 @@ +MetadataGraph | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..9de3959e4 --- /dev/null +++ b/7.x/docs/types/MetadataIdentifier.html @@ -0,0 +1,61 @@ +MetadataIdentifier | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..956f3c707 --- /dev/null +++ b/7.x/docs/types/MetadataRecord.html @@ -0,0 +1,61 @@ +MetadataRecord | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..f8c0d687a --- /dev/null +++ b/7.x/docs/types/MetadataValue.html @@ -0,0 +1,61 @@ +MetadataValue | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..dff19f4e5 --- /dev/null +++ b/7.x/docs/types/ModifyOptions.html @@ -0,0 +1,82 @@ +ModifyOptions | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..3318af3b9 --- /dev/null +++ b/7.x/docs/types/OptionalKey.html @@ -0,0 +1,69 @@ +OptionalKey | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..8e32663ee --- /dev/null +++ b/7.x/docs/types/PartialVocabulary.html @@ -0,0 +1,80 @@ +PartialVocabulary | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..79e99a4f2 --- /dev/null +++ b/7.x/docs/types/PasswordIdKey.html @@ -0,0 +1,61 @@ +PasswordIdKey | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..225e961fb --- /dev/null +++ b/7.x/docs/types/PasswordIdRoute.html @@ -0,0 +1,64 @@ +PasswordIdRoute | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..9667fdf5a --- /dev/null +++ b/7.x/docs/types/PatchHandlerInput.html @@ -0,0 +1,75 @@ +PatchHandlerInput | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..8a62c5cd7 --- /dev/null +++ b/7.x/docs/types/PermissionMap.html @@ -0,0 +1,64 @@ +PermissionMap | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..ef2bb7590 --- /dev/null +++ b/7.x/docs/types/PermissionSet.html @@ -0,0 +1,64 @@ +PermissionSet | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..03f65b610 --- /dev/null +++ b/7.x/docs/types/PodIdKey.html @@ -0,0 +1,61 @@ +PodIdKey | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..f39930760 --- /dev/null +++ b/7.x/docs/types/PodIdRoute.html @@ -0,0 +1,64 @@ +PodIdRoute | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..423535737 --- /dev/null +++ b/7.x/docs/types/PromiseOrValue.html @@ -0,0 +1,66 @@ +PromiseOrValue | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..bd23354be --- /dev/null +++ b/7.x/docs/types/RouteParameter.html @@ -0,0 +1,69 @@ +RouteParameter | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..4c5fa0769 --- /dev/null +++ b/7.x/docs/types/StringKey.html @@ -0,0 +1,69 @@ +StringKey | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..34a91ca29 --- /dev/null +++ b/7.x/docs/types/Template.html @@ -0,0 +1,61 @@ +Template | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..47622c9da --- /dev/null +++ b/7.x/docs/types/TemplateFileName.html @@ -0,0 +1,61 @@ +TemplateFileName | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..a40e855d8 --- /dev/null +++ b/7.x/docs/types/TypeObject.html @@ -0,0 +1,75 @@ +TypeObject | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..abea605ac --- /dev/null +++ b/7.x/docs/types/ValidatorInput.html @@ -0,0 +1,68 @@ +ValidatorInput | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..8b03746b4 --- /dev/null +++ b/7.x/docs/types/ValuePreference.html @@ -0,0 +1,72 @@ +ValuePreference | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..663b74d54 --- /dev/null +++ b/7.x/docs/types/ValuePreferences.html @@ -0,0 +1,76 @@ +ValuePreferences | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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..d0f405ce6 --- /dev/null +++ b/7.x/docs/types/ValueTypeDescription.html @@ -0,0 +1,73 @@ +ValueTypeDescription | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..4cffeef22 --- /dev/null +++ b/7.x/docs/types/VirtualKey.html @@ -0,0 +1,69 @@ +VirtualKey | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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..44337daa9 --- /dev/null +++ b/7.x/docs/types/Vocabulary.html @@ -0,0 +1,77 @@ +Vocabulary | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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

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..22741c489 --- /dev/null +++ b/7.x/docs/types/VocabularyTerm.html @@ -0,0 +1,69 @@ +VocabularyTerm | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..93106ca33 --- /dev/null +++ b/7.x/docs/types/VocabularyValue.html @@ -0,0 +1,69 @@ +VocabularyValue | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..0baa738b3 --- /dev/null +++ b/7.x/docs/types/WebIdLinkKey.html @@ -0,0 +1,61 @@ +WebIdLinkKey | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..1d62a9379 --- /dev/null +++ b/7.x/docs/types/WebIdLinkRoute.html @@ -0,0 +1,64 @@ +WebIdLinkRoute | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..d6f121f0d --- /dev/null +++ b/7.x/docs/types/YargsOptions.html @@ -0,0 +1,61 @@ +YargsOptions | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..3e757ee56 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_ID_KEY.html @@ -0,0 +1,61 @@ +ACCOUNT_ID_KEY | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..0c645e6b5 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_PROMPT.html @@ -0,0 +1,66 @@ +ACCOUNT_PROMPT | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..bece401da --- /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.1
+
+ +
+
+
+
+ +

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..9f0e36184 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_STORAGE_DESCRIPTION.html @@ -0,0 +1,66 @@ +ACCOUNT_STORAGE_DESCRIPTION | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..cb1ec8622 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_TYPE.html @@ -0,0 +1,61 @@ +ACCOUNT_TYPE | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..cd52388f9 --- /dev/null +++ b/7.x/docs/variables/ACL.html @@ -0,0 +1,61 @@ +ACL | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..dfbcd9a68 --- /dev/null +++ b/7.x/docs/variables/ACP.html @@ -0,0 +1,61 @@ +ACP | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..2d0f886b7 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_JSON.html @@ -0,0 +1,61 @@ +APPLICATION_JSON | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..bacafbec8 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_LD_JSON.html @@ -0,0 +1,61 @@ +APPLICATION_LD_JSON | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..cbee9137f --- /dev/null +++ b/7.x/docs/variables/APPLICATION_OCTET_STREAM.html @@ -0,0 +1,61 @@ +APPLICATION_OCTET_STREAM | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..c6b47695b --- /dev/null +++ b/7.x/docs/variables/APPLICATION_SPARQL_UPDATE.html @@ -0,0 +1,61 @@ +APPLICATION_SPARQL_UPDATE | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..8ffb11597 --- /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.1
+
+ +
+
+
+
+ +

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..536b15bb4 --- /dev/null +++ b/7.x/docs/variables/AS.html @@ -0,0 +1,61 @@ +AS | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..c305545f0 --- /dev/null +++ b/7.x/docs/variables/AUTH.html @@ -0,0 +1,61 @@ +AUTH | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..43d116e46 --- /dev/null +++ b/7.x/docs/variables/BaseActivityEmitter.html @@ -0,0 +1,72 @@ +BaseActivityEmitter | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..47b22b35f --- /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.1
+
+ +
+
+
+
+ +

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..f8c1aa427 --- /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.1
+
+ +
+ +
\ 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..27ec91bf9 --- /dev/null +++ b/7.x/docs/variables/CONTENT_LENGTH.html @@ -0,0 +1,61 @@ +CONTENT_LENGTH | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..e7a9b5f5a --- /dev/null +++ b/7.x/docs/variables/CONTENT_LENGTH_TERM.html @@ -0,0 +1,61 @@ +CONTENT_LENGTH_TERM | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..bdee9ce68 --- /dev/null +++ b/7.x/docs/variables/CONTENT_TYPE.html @@ -0,0 +1,61 @@ +CONTENT_TYPE | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..7f1e19d93 --- /dev/null +++ b/7.x/docs/variables/CONTENT_TYPE_TERM.html @@ -0,0 +1,61 @@ +CONTENT_TYPE_TERM | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..6f000f19a --- /dev/null +++ b/7.x/docs/variables/DC.html @@ -0,0 +1,61 @@ +DC | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..659272dea --- /dev/null +++ b/7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html @@ -0,0 +1,70 @@ +DEFAULT_CUSTOM_TYPES | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..4f6bc8697 --- /dev/null +++ b/7.x/docs/variables/DEFAULT_NOTIFICATION_FEATURES.html @@ -0,0 +1,64 @@ +DEFAULT_NOTIFICATION_FEATURES | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..93bda0b69 --- /dev/null +++ b/7.x/docs/variables/DEFAULT_SUBSCRIPTION_SHACL.html @@ -0,0 +1,77 @@ +DEFAULT_SUBSCRIPTION_SHACL | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..f1628c96f --- /dev/null +++ b/7.x/docs/variables/FOAF.html @@ -0,0 +1,61 @@ +FOAF | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..230055c4c --- /dev/null +++ b/7.x/docs/variables/HH.html @@ -0,0 +1,61 @@ +HH | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..2798d7b63 --- /dev/null +++ b/7.x/docs/variables/HTTP.html @@ -0,0 +1,61 @@ +HTTP | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..3ba4e4186 --- /dev/null +++ b/7.x/docs/variables/IANA.html @@ -0,0 +1,61 @@ +IANA | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..04b0e5c21 --- /dev/null +++ b/7.x/docs/variables/INDEX_ID_KEY.html @@ -0,0 +1,64 @@ +INDEX_ID_KEY | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..6132a0162 --- /dev/null +++ b/7.x/docs/variables/INTERNAL_ALL.html @@ -0,0 +1,61 @@ +INTERNAL_ALL | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..d308ec176 --- /dev/null +++ b/7.x/docs/variables/INTERNAL_ERROR.html @@ -0,0 +1,61 @@ +INTERNAL_ERROR | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..0322592e2 --- /dev/null +++ b/7.x/docs/variables/INTERNAL_QUADS.html @@ -0,0 +1,61 @@ +INTERNAL_QUADS | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..e46f34698 --- /dev/null +++ b/7.x/docs/variables/JSON_LD.html @@ -0,0 +1,61 @@ +JSON_LD | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..7a8efc31b --- /dev/null +++ b/7.x/docs/variables/LDP.html @@ -0,0 +1,61 @@ +LDP | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..b77ad6506 --- /dev/null +++ b/7.x/docs/variables/LOG_LEVELS.html @@ -0,0 +1,61 @@ +LOG_LEVELS | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..89522b0e0 --- /dev/null +++ b/7.x/docs/variables/MA.html @@ -0,0 +1,61 @@ +MA | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..a02af6248 --- /dev/null +++ b/7.x/docs/variables/NOTIFY.html @@ -0,0 +1,61 @@ +NOTIFY | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..dfeb26cf7 --- /dev/null +++ b/7.x/docs/variables/OIDC.html @@ -0,0 +1,61 @@ +OIDC | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..cd2703f04 --- /dev/null +++ b/7.x/docs/variables/OWNER_STORAGE_DESCRIPTION.html @@ -0,0 +1,70 @@ +OWNER_STORAGE_DESCRIPTION | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..f563b2bfe --- /dev/null +++ b/7.x/docs/variables/OWNER_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +OWNER_STORAGE_TYPE | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..86884b324 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_METHOD.html @@ -0,0 +1,64 @@ +PASSWORD_METHOD | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..fb5be1724 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_STORAGE_DESCRIPTION.html @@ -0,0 +1,72 @@ +PASSWORD_STORAGE_DESCRIPTION | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..81e5190ae --- /dev/null +++ b/7.x/docs/variables/PASSWORD_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +PASSWORD_STORAGE_TYPE | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..d0309ba7f --- /dev/null +++ b/7.x/docs/variables/PIM.html @@ -0,0 +1,61 @@ +PIM | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..217302ff7 --- /dev/null +++ b/7.x/docs/variables/POD_STORAGE_DESCRIPTION.html @@ -0,0 +1,68 @@ +POD_STORAGE_DESCRIPTION | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..4839f1286 --- /dev/null +++ b/7.x/docs/variables/POD_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +POD_STORAGE_TYPE | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..26ae86549 --- /dev/null +++ b/7.x/docs/variables/POSIX.html @@ -0,0 +1,61 @@ +POSIX | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..80c05c5bd --- /dev/null +++ b/7.x/docs/variables/PREFERRED_PREFIX.html @@ -0,0 +1,61 @@ +PREFERRED_PREFIX | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..ef27a8ea5 --- /dev/null +++ b/7.x/docs/variables/PREFERRED_PREFIX_TERM.html @@ -0,0 +1,61 @@ +PREFERRED_PREFIX_TERM | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..d4d2bd1e7 --- /dev/null +++ b/7.x/docs/variables/RDF.html @@ -0,0 +1,61 @@ +RDF | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..538a27ced --- /dev/null +++ b/7.x/docs/variables/RDFS.html @@ -0,0 +1,61 @@ +RDFS | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..9c60ab730 --- /dev/null +++ b/7.x/docs/variables/SOLID.html @@ -0,0 +1,61 @@ +SOLID | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..accb75b1b --- /dev/null +++ b/7.x/docs/variables/SOLID_AS.html @@ -0,0 +1,61 @@ +SOLID_AS | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..b79cae4ab --- /dev/null +++ b/7.x/docs/variables/SOLID_ERROR.html @@ -0,0 +1,61 @@ +SOLID_ERROR | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..8978d0b60 --- /dev/null +++ b/7.x/docs/variables/SOLID_ERROR_TERM.html @@ -0,0 +1,61 @@ +SOLID_ERROR_TERM | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..c25588239 --- /dev/null +++ b/7.x/docs/variables/SOLID_HTTP.html @@ -0,0 +1,61 @@ +SOLID_HTTP | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..71cb0a1f8 --- /dev/null +++ b/7.x/docs/variables/SOLID_META.html @@ -0,0 +1,61 @@ +SOLID_META | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..716dae29f --- /dev/null +++ b/7.x/docs/variables/TEMPLATE-1.html @@ -0,0 +1,61 @@ +TEMPLATE | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..f0052b48c --- /dev/null +++ b/7.x/docs/variables/TEMPLATE_VARIABLE.html @@ -0,0 +1,61 @@ +TEMPLATE_VARIABLE | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..080745729 --- /dev/null +++ b/7.x/docs/variables/TEXT_HTML.html @@ -0,0 +1,61 @@ +TEXT_HTML | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..7a7a0bd5e --- /dev/null +++ b/7.x/docs/variables/TEXT_MARKDOWN.html @@ -0,0 +1,61 @@ +TEXT_MARKDOWN | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..dbd9a9db6 --- /dev/null +++ b/7.x/docs/variables/TEXT_N3.html @@ -0,0 +1,61 @@ +TEXT_N3 | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..77a451e5d --- /dev/null +++ b/7.x/docs/variables/TEXT_TURTLE.html @@ -0,0 +1,61 @@ +TEXT_TURTLE | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..1b5488fc9 --- /dev/null +++ b/7.x/docs/variables/UNIT_BYTES.html @@ -0,0 +1,61 @@ +UNIT_BYTES | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..806d20ed1 --- /dev/null +++ b/7.x/docs/variables/URL_SCHEMA.html @@ -0,0 +1,61 @@ +URL_SCHEMA | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..e7e20be37 --- /dev/null +++ b/7.x/docs/variables/VANN.html @@ -0,0 +1,61 @@ +VANN | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..edabea09f --- /dev/null +++ b/7.x/docs/variables/VCARD.html @@ -0,0 +1,61 @@ +VCARD | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..309df20d1 --- /dev/null +++ b/7.x/docs/variables/WEBID_STORAGE_DESCRIPTION.html @@ -0,0 +1,68 @@ +WEBID_STORAGE_DESCRIPTION | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..9bbac5b78 --- /dev/null +++ b/7.x/docs/variables/WEBID_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +WEBID_STORAGE_TYPE | Community Solid Server - v7.0.1
+
+ +
+ +
\ 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..0a34588c2 --- /dev/null +++ b/7.x/docs/variables/XSD.html @@ -0,0 +1,61 @@ +XSD | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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..c9240d68a --- /dev/null +++ b/7.x/docs/variables/modulePathPlaceholder.html @@ -0,0 +1,65 @@ +modulePathPlaceholder | Community Solid Server - v7.0.1
+
+ +
+
+
+
+ +

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