From 66fb71d46f7297375838283254f67299da5ff692 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 26 Jun 2024 00:10:53 +0000 Subject: [PATCH] 2024-06-26T00:10:53+00:00 Signed-off-by: GitHub Actions --- .nojekyll | 1 + assets/highlight.css | 22 + assets/icons.js | 18 + assets/icons.svg | 1 + assets/main.js | 60 + assets/navigation.js | 1 + assets/search.js | 1 + assets/style.css | 1438 +++++++++++++++++++++ classes/AllowAllTenantGate.html | 5 + classes/Cid.html | 17 + classes/DataStoreLevel.html | 27 + classes/DataStream.html | 13 + classes/Dwn.html | 16 + classes/DwnConstant.html | 6 + classes/DwnError.html | 4 + classes/Encoder.html | 11 + classes/Encryption.html | 17 + classes/EventEmitterStream.html | 7 + classes/EventLogLevel.html | 28 + classes/EventsQuery.html | 17 + classes/EventsSubscribe.html | 19 + classes/HdKey.html | 14 + classes/Jws.html | 18 + classes/Message.html | 46 + classes/MessageStoreLevel.html | 26 + classes/MessagesGet.html | 17 + classes/PermissionGrant.html | 23 + classes/PermissionRequest.html | 16 + classes/PermissionsProtocol.html | 28 + classes/PrivateKeySigner.html | 17 + classes/Protocols.html | 7 + classes/ProtocolsConfigure.html | 17 + classes/ProtocolsQuery.html | 19 + classes/Records.html | 54 + classes/RecordsDelete.html | 21 + classes/RecordsQuery.html | 21 + classes/RecordsRead.html | 22 + classes/RecordsSubscribe.html | 21 + classes/RecordsWrite.html | 86 ++ classes/ResumableTaskStoreLevel.html | 41 + classes/Secp256k1.html | 27 + classes/Secp256r1.html | 20 + classes/TestDataGenerator.html | 59 + classes/Time.html | 24 + enums/DateSort.html | 5 + enums/DwnErrorCode.html | 154 +++ enums/DwnInterfaceName.html | 5 + enums/DwnMethodName.html | 8 + enums/EncryptionAlgorithm.html | 3 + enums/KeyDerivationScheme.html | 7 + enums/PermissionConditionPublication.html | 3 + enums/SortDirection.html | 3 + functions/authenticate.html | 3 + functions/executeUnlessAborted.html | 2 + hierarchy.html | 1 + index.html | 137 ++ interfaces/DataStore.html | 21 + interfaces/EventLog.html | 25 + interfaces/EventStream.html | 6 + interfaces/EventSubscription.html | 3 + interfaces/MessageStore.html | 18 + interfaces/MessageStoreOptions.html | 2 + interfaces/MessageSubscription.html | 3 + interfaces/ResumableTaskStore.html | 57 + interfaces/Signer.html | 16 + interfaces/TenantGate.html | 4 + types/ActiveTenantCheckResult.html | 4 + types/CreateFromOptions.html | 4 + types/DataStoreGetResult.html | 3 + types/DataStorePutResult.html | 3 + types/DerivedPrivateJwk.html | 1 + types/DwnConfig.html | 2 + types/EncryptionInput.html | 7 + types/EncryptionProperty.html | 1 + types/EqualFilter.html | 1 + types/EventListener.html | 1 + types/EventsPermissionScope.html | 1 + types/EventsQueryMessage.html | 1 + types/EventsQueryOptions.html | 1 + types/EventsQueryReply.html | 1 + types/EventsSubscribeDescriptor.html | 1 + types/EventsSubscribeMessage.html | 1 + types/EventsSubscribeOptions.html | 1 + types/EventsSubscribeReply.html | 1 + types/Filter.html | 1 + types/GenericMessage.html | 2 + types/GenericMessageReply.html | 1 + types/KeyEncryptionInput.html | 7 + types/KeyMaterial.html | 2 + types/ManagedResumableTask.html | 6 + types/MessageEvent.html | 3 + types/MessageSort.html | 1 + types/MessageSubscriptionHandler.html | 1 + types/MessagesGetMessage.html | 1 + types/MessagesGetOptions.html | 1 + types/MessagesGetReply.html | 1 + types/MessagesGetReplyEntry.html | 1 + types/MessagesPermissionScope.html | 1 + types/OneOfFilter.html | 1 + types/Pagination.html | 3 + types/PaginationCursor.html | 1 + types/PermissionConditions.html | 4 + types/PermissionGrantData.html | 7 + types/PermissionRequestData.html | 5 + types/PermissionRevocationData.html | 3 + types/PermissionScope.html | 2 + types/Persona.html | 2 + types/PrivateJwk.html | 4 + types/ProtocolDefinition.html | 2 + types/ProtocolPermissionScope.html | 1 + types/ProtocolRuleSet.html | 8 + types/ProtocolTypes.html | 1 + types/ProtocolsConfigureDescriptor.html | 1 + types/ProtocolsConfigureMessage.html | 1 + types/ProtocolsConfigureOptions.html | 1 + types/ProtocolsQueryFilter.html | 1 + types/ProtocolsQueryMessage.html | 1 + types/ProtocolsQueryOptions.html | 1 + types/ProtocolsQueryReply.html | 1 + types/PublicJwk.html | 8 + types/QueryOptions.html | 1 + types/QueryResultEntry.html | 6 + types/RangeCriterion.html | 3 + types/RangeFilter.html | 2 + types/RecordSubscriptionHandler.html | 1 + types/RecordsDeleteMessage.html | 1 + types/RecordsDeleteOptions.html | 3 + types/RecordsPermissionScope.html | 4 + types/RecordsQueryMessage.html | 1 + types/RecordsQueryOptions.html | 2 + types/RecordsQueryReply.html | 1 + types/RecordsQueryReplyEntry.html | 9 + types/RecordsReadMessage.html | 1 + types/RecordsReadOptions.html | 4 + types/RecordsReadReply.html | 1 + types/RecordsSubscribeDescriptor.html | 1 + types/RecordsSubscribeMessage.html | 1 + types/RecordsSubscribeOptions.html | 2 + types/RecordsSubscribeReply.html | 1 + types/RecordsWriteDescriptor.html | 1 + types/RecordsWriteMessage.html | 1 + types/RecordsWriteOptions.html | 5 + types/RecordsWriteTagValue.html | 1 + types/RecordsWriteTags.html | 1 + types/SubscriptionReply.html | 1 + types/UnionMessageReply.html | 10 + 146 files changed, 3047 insertions(+) create mode 100644 .nojekyll create mode 100644 assets/highlight.css create mode 100644 assets/icons.js create mode 100644 assets/icons.svg create mode 100644 assets/main.js create mode 100644 assets/navigation.js create mode 100644 assets/search.js create mode 100644 assets/style.css create mode 100644 classes/AllowAllTenantGate.html create mode 100644 classes/Cid.html create mode 100644 classes/DataStoreLevel.html create mode 100644 classes/DataStream.html create mode 100644 classes/Dwn.html create mode 100644 classes/DwnConstant.html create mode 100644 classes/DwnError.html create mode 100644 classes/Encoder.html create mode 100644 classes/Encryption.html create mode 100644 classes/EventEmitterStream.html create mode 100644 classes/EventLogLevel.html create mode 100644 classes/EventsQuery.html create mode 100644 classes/EventsSubscribe.html create mode 100644 classes/HdKey.html create mode 100644 classes/Jws.html create mode 100644 classes/Message.html create mode 100644 classes/MessageStoreLevel.html create mode 100644 classes/MessagesGet.html create mode 100644 classes/PermissionGrant.html create mode 100644 classes/PermissionRequest.html create mode 100644 classes/PermissionsProtocol.html create mode 100644 classes/PrivateKeySigner.html create mode 100644 classes/Protocols.html create mode 100644 classes/ProtocolsConfigure.html create mode 100644 classes/ProtocolsQuery.html create mode 100644 classes/Records.html create mode 100644 classes/RecordsDelete.html create mode 100644 classes/RecordsQuery.html create mode 100644 classes/RecordsRead.html create mode 100644 classes/RecordsSubscribe.html create mode 100644 classes/RecordsWrite.html create mode 100644 classes/ResumableTaskStoreLevel.html create mode 100644 classes/Secp256k1.html create mode 100644 classes/Secp256r1.html create mode 100644 classes/TestDataGenerator.html create mode 100644 classes/Time.html create mode 100644 enums/DateSort.html create mode 100644 enums/DwnErrorCode.html create mode 100644 enums/DwnInterfaceName.html create mode 100644 enums/DwnMethodName.html create mode 100644 enums/EncryptionAlgorithm.html create mode 100644 enums/KeyDerivationScheme.html create mode 100644 enums/PermissionConditionPublication.html create mode 100644 enums/SortDirection.html create mode 100644 functions/authenticate.html create mode 100644 functions/executeUnlessAborted.html create mode 100644 hierarchy.html create mode 100644 index.html create mode 100644 interfaces/DataStore.html create mode 100644 interfaces/EventLog.html create mode 100644 interfaces/EventStream.html create mode 100644 interfaces/EventSubscription.html create mode 100644 interfaces/MessageStore.html create mode 100644 interfaces/MessageStoreOptions.html create mode 100644 interfaces/MessageSubscription.html create mode 100644 interfaces/ResumableTaskStore.html create mode 100644 interfaces/Signer.html create mode 100644 interfaces/TenantGate.html create mode 100644 types/ActiveTenantCheckResult.html create mode 100644 types/CreateFromOptions.html create mode 100644 types/DataStoreGetResult.html create mode 100644 types/DataStorePutResult.html create mode 100644 types/DerivedPrivateJwk.html create mode 100644 types/DwnConfig.html create mode 100644 types/EncryptionInput.html create mode 100644 types/EncryptionProperty.html create mode 100644 types/EqualFilter.html create mode 100644 types/EventListener.html create mode 100644 types/EventsPermissionScope.html create mode 100644 types/EventsQueryMessage.html create mode 100644 types/EventsQueryOptions.html create mode 100644 types/EventsQueryReply.html create mode 100644 types/EventsSubscribeDescriptor.html create mode 100644 types/EventsSubscribeMessage.html create mode 100644 types/EventsSubscribeOptions.html create mode 100644 types/EventsSubscribeReply.html create mode 100644 types/Filter.html create mode 100644 types/GenericMessage.html create mode 100644 types/GenericMessageReply.html create mode 100644 types/KeyEncryptionInput.html create mode 100644 types/KeyMaterial.html create mode 100644 types/ManagedResumableTask.html create mode 100644 types/MessageEvent.html create mode 100644 types/MessageSort.html create mode 100644 types/MessageSubscriptionHandler.html create mode 100644 types/MessagesGetMessage.html create mode 100644 types/MessagesGetOptions.html create mode 100644 types/MessagesGetReply.html create mode 100644 types/MessagesGetReplyEntry.html create mode 100644 types/MessagesPermissionScope.html create mode 100644 types/OneOfFilter.html create mode 100644 types/Pagination.html create mode 100644 types/PaginationCursor.html create mode 100644 types/PermissionConditions.html create mode 100644 types/PermissionGrantData.html create mode 100644 types/PermissionRequestData.html create mode 100644 types/PermissionRevocationData.html create mode 100644 types/PermissionScope.html create mode 100644 types/Persona.html create mode 100644 types/PrivateJwk.html create mode 100644 types/ProtocolDefinition.html create mode 100644 types/ProtocolPermissionScope.html create mode 100644 types/ProtocolRuleSet.html create mode 100644 types/ProtocolTypes.html create mode 100644 types/ProtocolsConfigureDescriptor.html create mode 100644 types/ProtocolsConfigureMessage.html create mode 100644 types/ProtocolsConfigureOptions.html create mode 100644 types/ProtocolsQueryFilter.html create mode 100644 types/ProtocolsQueryMessage.html create mode 100644 types/ProtocolsQueryOptions.html create mode 100644 types/ProtocolsQueryReply.html create mode 100644 types/PublicJwk.html create mode 100644 types/QueryOptions.html create mode 100644 types/QueryResultEntry.html create mode 100644 types/RangeCriterion.html create mode 100644 types/RangeFilter.html create mode 100644 types/RecordSubscriptionHandler.html create mode 100644 types/RecordsDeleteMessage.html create mode 100644 types/RecordsDeleteOptions.html create mode 100644 types/RecordsPermissionScope.html create mode 100644 types/RecordsQueryMessage.html create mode 100644 types/RecordsQueryOptions.html create mode 100644 types/RecordsQueryReply.html create mode 100644 types/RecordsQueryReplyEntry.html create mode 100644 types/RecordsReadMessage.html create mode 100644 types/RecordsReadOptions.html create mode 100644 types/RecordsReadReply.html create mode 100644 types/RecordsSubscribeDescriptor.html create mode 100644 types/RecordsSubscribeMessage.html create mode 100644 types/RecordsSubscribeOptions.html create mode 100644 types/RecordsSubscribeReply.html create mode 100644 types/RecordsWriteDescriptor.html create mode 100644 types/RecordsWriteMessage.html create mode 100644 types/RecordsWriteOptions.html create mode 100644 types/RecordsWriteTagValue.html create mode 100644 types/RecordsWriteTags.html create mode 100644 types/SubscriptionReply.html create mode 100644 types/UnionMessageReply.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 000000000..5674cf392 --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,22 @@ +:root { + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --code-background: var(--dark-code-background); +} + +pre, code { background: var(--code-background); } diff --git a/assets/icons.js b/assets/icons.js new file mode 100644 index 000000000..e88e8ca77 --- /dev/null +++ b/assets/icons.js @@ -0,0 +1,18 @@ +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `""`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/assets/icons.svg b/assets/icons.svg new file mode 100644 index 000000000..e371b8b5d --- /dev/null +++ b/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 000000000..7d7f77a07 --- /dev/null +++ b/assets/main.js @@ -0,0 +1,60 @@ +"use strict"; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; +"use strict";(()=>{var Ce=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(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),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}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=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(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=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){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",()=>{ce(e,t)}),ce(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");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),Ve(t,i,r,e)}function Ve(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?He(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}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=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function He(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),te(e)}}function he(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(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",H="mouseup",J={x:0,y:0},me=!1,ne=!1,je=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(je=!0,F="touchstart",ye="touchmove",H="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){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();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(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-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(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)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var qe=new U;Object.defineProperty(window,"app",{value:qe});fe();we();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/assets/navigation.js b/assets/navigation.js new file mode 100644 index 000000000..68344c63c --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WaTXMiNxCG/wtnVxy7YifxzQVedu11TMCbHLb2IGYaUDFIrKSBpVL731MzDKCRWi3pyvv2o1GPPloavv43MPDDDB4GI2ZgJpUZXA22zKwGDwMQ9UZfn37/ZWU21eBqsOaiHDz88fPqErkXT0pJNZQleNGWRhI+CQNqwQr4i20wSk8nSa9gVrIMYC5imPEkCnXYGi7FY7WUipvVxiUhljDvBQ4jUHzHGv+sWIH/ZIglzJuA2nCtuRRDKUrehEzqecWLNtpF0+5wK807H3EFBQbtiWHGY1XJ/WNVvYNgwoyZsTpeVExr0Ne+p8+7ubWJQ176iCEvqZgRM2xmpILPsIPKD+/rcZICtglRGo0k7AUSuheRmKEU2jBh0NiTGGG08xAFtAoV/SQKWQIS3AmR2G6qoOGdRhJ2IMzThhsDKpR93xMlfpbLwIDoyVGO/rsGdQhQjmKcMavnulB8jkwQx0CxPpYvgDxJ+zMV97zXftTzXlMxr6A1WyLP2wkJsdSk9CwJPD0GZIZYIsW4rJNjhc40x5DGmsL3GjRJ6yxpPD1R0shCIhlDTCSz3W7gBQ4zvhTY5HYdNO3YIjKOzlJS/FCKBV/WChlYvieJGJiefZ0iTaGQqkR61gkJsSOoANv8enICJ9AXW02gTIEhu6glJjCIBct1JND+VZxIT6vSFF1v2LyCd6bX1KoSMFLsGRTb27v79Y1PO0sJ8Socr8j4d9CmqS3GIEAxg23hnoXk8Q2S6ebXpBrqEspPFblVQfURt3f3yKaLEk5iFOAWAC4D2/wxzHFwOnWJB7NcFNLerFCabUgFvbXN6iiv86VgY51GfBTWn00o1bdRUHc3skDYNtQPxg4aFiB0xuhDHgvDd3D0DldQrJsOVNYebg7b5uCC2xzyr3/+fnN3a59gFDADH5TceC/4yPUMMeJ59o3B4I/qO5KZkzrGPDuizOaEC2VXVjzv1x7SNUSJ7eFnwZce6STECJcTyCexrb1OOnI6baLkFpQ5hIEnR5T5vWbVB14Ze1J0sIsUpbTrK9cGBMKxxSSSvhSbs0JuASW6pjRyW8R4hwsbazsymIHp5jsymFPYVv47dvQ03rlcGsFx8ZX4e8KMmS2Q2XVdmWwyy64rk01ku++JcfHplDaT2iKLF4Ec9tU8Fto9xBKjvsAhsqz5jgTmKzOgOKsQ2EmKUV6ZYEsoewWBi8M8Ue4xO+1Q8HiWlsjpX4P3MP5NeJhiVVEfmSgrf8SFnYltNJcagZHoOzKYgVnsOzKY6PB29VzekzAqCm1NqeTIzhawxehvAt4W+LJjSTHKhC25cG75j5CLks4Y1kr7m4yrR3n+9wVv3GCedG573daUm2Hs2ZJO7a7daK5lyiHv5PHrSgxu+9L56LjMHI8TUFoK7OGan6PRwRI+vXY/3b+NYMEFR8e050hlxnKF21Lp07qCGXg7hCOn0t6b4BCrFVNJl3vRcAlJefPbCWw9QWN+C4GNKGhMbqEtz/EFGfPkcWN5yTnB9INi+cg5x/SD0O0ZsUSp7cdlbGk4CTEC1dGc/nXP3FxNoGWCq8d4UyaWMGzuohWyWvXVJBY+/CwpSmnvxxMKzaAxrYXuA0VgWGOeLG7gXWOeRG5kA8BdiWxqhiOWHCqdiJyxb4egM9szZBPROYW7EtnNpyc6sZYjg0mn1XJkMKmknvVEXsLVT9iZ2wad4NzbHzeMTnXu/Y8bRiU97wbI/rIYzbrjymHT2bYtOVQ6y7Ylh/rOlv+wqiYf9uTJ5JKP2ugxnr11oaPAM8SIXwSXgrp58wwxIqvNCoRp/lln5XBRi/Zfcvra1vus+98sDPyAojbwRVSg9eNcKgMlhsN8Hvbb/yp7tYXhKQAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 000000000..b4413aad4 --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8S9XZPcxpHv/V3Ic0mPB/UO38mk7CN7LemIkjeeUGw4mtPgsM2e7nE3hhTXsd/9CVQBPVWJfxUSaPCcK1HTVZkJIOv1l5X17xen4+fziz/8+u8XH3eH7Ys/iNvaVlq8enHYPDQv/vDizefD6+Ph/e7+xasXT6f9iz+8aL88NuffX/5+86F92L949eJuvzmfm/OLP7x48T+vBmlGa2kusv7xj65uUdDLS5lI3qsXj5tTc2gTc56VVLdCXXRsd9ufmvNx/6k5cRTdpOUnlN701mV0t81hc2j/vGlZz3iTFL9Oc/OpObRv21OzeWCpTstfp/uhOZ83983b9njiPTepcJ327abd8FXHpVd44/9xLDeL5HWHwtdpPTXnp4fNu33z8+b8kf/YsNpsS4R+bsrf0sffHdrm9H5z15x/P/xW7BnErXIXacfH5jAp6WVfCtt9MSij4m5/PDfTOoZiy5RsHh+bw3Zay6XcMjX3TeuLnKc1xUWXKfvXU3P6wlWXFl6mcNvsm7YJQv745fWO8T5RlaVu0mxOHDcJxWYoSYfVYOv/6V7X30J3SBryuMBEc8rK/6l53H/JS/c/L5D99und+e60e9e8abr/PrZHOuBmy107ZSgLnppC5M3PdLoXL1hixk1ce6ZBkwNv++G4XWTUperaFnlP/Xn30JzbzcPjQttGQta18v1u3zan8yLjnutebdNEsyp1C7TQyg0qljqzNQ1WZ1795qn9cDzt/nvT7o6H2Ubc0OpzTJqaRzJ7MWRWUvc6myacIt+Xp0Vm9ee9Mb2Ex+7d/u/NYbsfraDyBa91wAnJU05YeIKJV/sfu3PbHEZPmvy2SutKhLEa1cW0wgycLPnofCX8zJ+Hnwcn4kh8GZcuPEdvY0Zl87BrWdr6gosVFdcYsaLpZUZZUXmlEWtiLDbGqkYuEDl9XmtUqOgO6cQnP/UeCXw5NelO7MwonHh1I52cF4jVFpstU/ENpxUndYO9kz2xr4h7SP/TSr3tsyxm/xrsKs/9mKpunotPq5wYuneHXbvb7P/ztBttvGXVkzpLbKAfL/7SaJwe/T5rkP5zNxTs7vCsMP3xWvcA0qYchFg3d46V18iZW5HaZWcpzUALZvBmnlOWlD8qchpQYt3P+yxy3jcOxmZe8rndtE90gTWh9+ZSia1++gUPE8PjKdOfdr+sNXkdRHFnq51R+V3t5vWp2bQNXd9nlN2kNSYVT++qNz8+vdvvzh9mWRDXudaGic2EnBns7YOiJfE0C6wu0FQBFLt2qpUTWZpsIWvnTreyessTrrJq7pSrrHxq0oVqT027ftzc7w5oQHj+4do+gkia6iIii3Lf7ul0Ho2jWMvNpeyUsokWud/Fi7WiyqHofI304/Sb1OenffvtoT3RAZL+vGTn4/znpsUTq3GBpfLR4E5/vko2ejmwzErDHRDKHPiIyeXuP+Y/TP03SdUZpvAGpKXmrGpLc7g7bpvtm027mW1PWndFm06nUY/EsKavdZUdtHH8yW/TE1vCH691/0jKlL/3VhS2IP/1tNlDW6NfZvUKPxyaH95DidEvsyT+tDncN1Bi9Mt8ia+7lfdpPOSmP177sYC0qY9GrMsxpNORRtrkdd30pTkKp0KMjnytvuwynfkZ0uvyvCP8vN5sKZLHnzP1Ns4dWEpaOWPKqH75U37a7J/mPPjNUGGpdjiz+sFPkelaPf7p2o85kjX1IRO7cjsMx1P74+n42JxaOCME+m5InWnlEx+wk/dmd2ruwMqhaERc6Wor0KQ8q708LZ+hFS4/smonFiBlvaO+6HRsj3fH/TnEqT2d8hEopaJX91FTsif7q9JzzAxF4RrDiEYpiloQkMI2bSIm5Sq7ijtJMyxkbi1dYeu2ee/ZxHgvgmtlImEN+3IN8M2Uqc8F1mpsRCK3iUWWZl77Y19ylt6bqBbXgInP/5jZdJ0yZHLfdbYlXu88K4YqK1lwbk9Pd+3TKMZ5woq42nJLrnbKZzt64b+r5hsUPcx0e/y58MX8b2u1wmdh3AYYTJt+hJ+e9s3bZrTHmP661mPE4rgPMhiYcdn/1RzuTl8eC30iUHrzj6QWy4CJpvO/NndoWl804rnKKhacjvsZL/7mH335VXSfd/89S3dffqHu61wuaOf3EakZN+FZcxOf3Sw3TAy5CZXnGzM1Gdv8doVNvvLqNv2vdnM/q6305f8fOUynfXgnYvb78LZnW23zr6fdqdn+vOCFXEy6+QcRM9/Ayf5tvz9+/uXg57pXWwuFrWFzdunqV7xwUxUVWW2pSmWyl6ixvctm0Dnd/Dl0ImHBLgEmfNlys7a0UxsnNC0+1JNKQEQRlJh3tOcyEclsro0LXB0djSVOhkiPLc1FfO3vj6dd+4Hu15cV38TVuCbwAhX7KLK/N3fgtEHZqIyElez72Hz5Njd/nTCMVl1u0YgWNXfH0/b8xh/xwy0LFZlHpIKAQuMFJRZrQA139Pt10lEwAC60RM9PzWZbfE1RgasJHpY4SfHGli4ICC0rZwaFAiFTW4CZ7ewJcxihshxbCh+94LmXn5c41PRZ0nzBlRxs6WnSwhPM3MPnGcLYwS8IWrB/zzRrYvf+CpuKe/ds65g794vtfA8jJHjWXepeb9NUAyt227OOlU5pKvQVV5xVDBKmjypmy63TXSw9qJg3f/LF+qMqU/0jKbRS34ikMvtFavWyPrFgAL8/pEKW94Ulc3j94DxbMktrhjWTi+ur7Plx035YblNfe0W7Ts3d7nE3PjvHMCquuqJF57sPzQON0GSYc6m3oi1gj5NhSXGnc5n3+NrfLWhbUc0V7elyQo2DwRjmPFdc2Zq3Y3zBNOdtCWQstSdzEoln0uShpIW9M2dWWO6n580IZ/p4BuNznHwS5S/+jrkTXcwvOX24a7HH/+l4etgs6LaTutfZVJp2Ab5Af15zqnWRN2eS9XOKdSYe5+8g+BQVWbIE8AKKC424xJovbsEOUWLs8i2inPp5e0SJlMm5zvG0LY6iyJyo2lqW3B0PbfNbeUBHpsT11rJlaussawx/72yGNZu27QaXJV6T1FzLnmxwypQ5jPgUljUmbVPNod3dxdlS3z8dQhDK7+OfZ/VB39y1u0/Nzz616usPzd3HcDaQPHCm1LV9UUnsVH+UMzy3Yj7HFebbcTMSMMusyXbYbnZ0vcqx6lLxWmvEc0Kebzq8/81+//M4PW+v5ffjIkVX0JWIu78QpBf1ORNiX6Z1Mo86tjr2+ijhUMYVpozgOkDRjuiYPHi90alu5pvlPFheKveZ4LPELhOvB4f3+Hq35Zt+d3x4fGqbkpyXSRlsaPdbRsPj5nQuy49KzJbe2/Zmc//ju9e77Z9Ox4c/fmmj8NLc06Aaa2gnmc446ifyW6f6uU06UjjdhlMVsYPFMHakI/6R73L+c0/LejmUK47jwbDc5/FLeoaqS8Hluob5c9PR/XueWlRnngVGVCp/8DuvGR31bs/b3+3Ov9sdPjTd5Gg7X/95dx+nKMyrvxRcU3t4m+zX/hWefdMFwP+4+bI/bsbdHX4LpMp1FsX+2B7/8vaH7xlWXApeqTsf6YGPboISKy2xZx/kRMZetaGXPWA4dzdvxknHEtjN2sMjujOs6PbfQBarKTuiamtZ8phLljNlS1JxLWtI18izBHSTV76TISp4fOZh8q2kVVfzl37k2/75NF4eTnoNrXyFVfEK4c3oro5oKn/5kT/jyaV0TUWVE7o+25Sb7OSSZBEt5dRYk2oen+AChygJpRaquG84KkKphSrCRQwMLZeCi79K5p6G0VcpXdSA1ZALkIYyPz61cC9pXODa8TYjcfJupLGl8yBjWe80YAT1JzHLpY7P8FN6vZcCq73eVCL79T5buvD1Qr0zXu9zfQZLhpdCMSyZuByKYUvc9f+Uv7goarzjUtcPBhmZ5VEBmDt3eMjpLY8TfMWn5r5LEA87wZzuqM616u9Pm3dzVPflr3/qaAnIeuJNiS9x1Ta/tZmLnXKKLzWuVZ0fUnOqJ8bWOb6dGWTzvl0abScUk/SGm8PmvtkmdUgvhopcOzZkZU7mNkT25tjNKKXhhNabUiZDVHcqEoz/Lp/jwHyd9WzYPTTHp1FW5kkzLtVWs+TUtKcvr49P45T7U8YkNa+yJ9oZfjMetIdNpuef+MNie8T79kTWy+dypQG/dO9Fe/zh3T+buzGAGqu6FFyq632WR1Bl7yc5BE8b89mSokv1bZ8e9558833hJa4zwwIuAKGKORwEKkxcPt3cag5PD17TdH726rlD7yMNvznfNYft7nBfEvcSFM7aPkrVPtLZBZbxlSall2i9ROLxnhUWv0ov83lxebbm0VqxOe0+NdsfT7tPm7b5y2c6iI1+v3qlCAVOLhRHZuZGnuOx/WvzZRQ5VVR7E9diGjC5WehL7o6Ht13c+ay3cAMqr20VOGfAtal4yGCRRZfyf23o8SaGUaT2cruiGcP/3samDP20/yt/nhCsA482lvcSlMUPEiwra+y6iDuewqjocn0Xq/H8ofCY5WkEQ/dfmy+/nHeH+//9cft+WjEpzdPKHcUjbZwBnKp5frK/Nl/e5LqPMCSAEtwR/c0lvPvMFPoyrYKfBtmMx7sezrwOoapcG8bVVrIj6QiZRhR7QLYF/rcN+ys8F1+kN14OfT6Mp6CfywklOcEqg4ypGJVOP2fHcSS3TJ3yUtMNxbG5ZcyUl/t4Ot415zONyx8pGJWbrenTZr/rwHMmHvGiaVRusabe2O8ObXN/2rXjsWSkE9TgaCee+brrOjPPOPxW7utIZrQ3PQPwQZfN9ufjH5tvw20NkypeTlXPPt/lKRYsBqkRrNUgVEle7bfJZRKRPv/DKtG5iTCu5cGu7FGILWxZiZptsVFR+eOX8jpW0q+6op+4Y+s3UYT9Xz6f/7Y7n8Fyjgp+ma1WfiJv9KQdz+ezXu+2f9udHzbtHR3wyiblJKxg3e54+Nvx1Pz8YXP44dC8HYLMvj+2b58eH4+n+IQkw1SeuGvsvhw7Cv/z/bH94XMcLFMyMl93FYu+P7Y+tqTro75J4wtZVsH6Sy17fYnD7srczfqg5brXW/S3p327+7A5f1hoVa7+Usve7LZ/8xkOZtmTq3WFFZ2k9sTpsUjh63T+vZs/MFUOZa/Q+FNzPu6fOo//02a3571pUGepBd9uhdZV/d3BT5viDbecflRjsfbu3t1vH3Zt25zC7nHXDT02ZG6QNWWq+lV2nX3/k3RKw3DT7dyQhB1FG7mirrPXh+klSpguNVn9OrsuyYCW2zYhYiX7ovvYfznsHh73zUNz4PR+fDlLLfV34272f/l8/ntz2r3fNac/N+1lu+z7Y/un49Nh2lC2mPXs7DuKy/RngY1AxGL7Rg3R/+Xb3x67ZMbTtk1VX9ku7px9svrKdv3UfDp+XP6+nquvZ9d3Q/AKe1XBk7GehWGCdIV5IwHr2fY83f7T8US2dfgGYilfw0r2ooIpZOX28f2x/f+aNpxUXdpIiIylFvqN/TcJLuv700nDilWX2jP0618u3fkvh/OwYnh9+jRpFUPAUtu+O2yb3/pHDHfs+RQpP8fcOGdWue56Fr1F9+LxjXrLuSJvnl2xyO8Of2sejqd5lmUEXGVbP/T5f3dhWfNeWaH2FX7/pun2Bn/cb3aHEEHUH1/ktkeWiKX29fvlf27awV8YFmUqLbXhx/48+/xdmlLNa61ZtkMzVXuxVc3pofPO4+F8oZAecPUzq5B/9e742PROzF6qXiN59af5qfnXU3P+Os/Dkr3iE/29R1KBmf5yaH57bO7aLma0M2DJc0xK/CrWHx+b10NKpx9Pxw+7d90Z575v3DWUHc98Eob0r/VUwx/Zc/MFAr+W7cRzf95MrxYXifwK9nfLwMBJIlVrfIMpwYuf5RIp9NYfMP7l4CO+j2+a7dNd883oGpKs6Ww5X8fSNCRxmZUTAYoLLHyexD+dGMsmhoDltgWvSTnZXb967Nk7w0CelK9gZXd51Zm9KzhD0Kq2fne4O566i7LfjBOEzrIVC/o6tr4eJUNcZurryeSI11paiCmbaywr1GyhvW+Gcw1dgoSfRgm+ZxmclbXyGw7L1jT198w3m4r4Gvaxti0YAla17W/dELw73Pcf6HjaXtdNFeWtbPlvXeQVd7HOk7GuhbvD9RZSGStb6GeWV/ahQMrXsJJeVbzExmcZq1r4o6+/b87nFXv7aaGrPkM3B0rS6cwyNqr9Fd7s0Ie8HkIGu0/pe5fXHzbRlbsL3u+06HWfp//jdb0skLKqlT724D937YfjU7vcJ4CUVa3sZA7t+rp5SkbSqtZ26eJXmKkgMdfa+XwV62XC9k0XlvvdYW6fy5H0Faztvt8qxlJB69l6CZr4b35rytVe3aqwuOxbwA/vlxs4FvSVbP3h/YKVP0/WV7I4XJbad4ev0zMyCw3HIr+S/b88dlt5q9qPRa5u/6VL/+F90LvcbiRqfXtD9xNmIbNWjSxRq9v78+Z+5ohWFLGefX4CclU/MZawnnX98rg5d1PON81j++Hb3+6aZrvI0KKwFW0+7ps3R78F+e1vu3P7Tfvn3afmMGuRw5W2ntW/HC4Jqpe8W1L9aru8Uy2zCVVdak/PW8Ps8k2SgfSbw/a7rf8kzWFGBN8SiV/B+jlHmdhivoKdz2Fvh60/7HOJoFrDfJb0r/BUXW/5BifDXfAUUNqVVr9p/OU63x+Hzcq/Nl++DRfudJGSnFX5HElXW9tN8pbE6jMEXGmb747CxO1PPgH3Jf9MF0PG3ficKWwNm3000EomT8u60uJxQOrr42G78xtB/qzAsCfUx2hwrV8g9//Kk3TxQKzw/6VSV3+K0MSGUXoI2pjVhc8VuvozhKzip8upmZWfhit+9edKI5muf5CsvK9j+ffHITDuSpMTQV/H1tlxW7PFfV27u4XHyrYTkV/Hfubqmynk6vlKmsTpl8PbeYFEfDlXWjrsRR3umnN7PKUpcpr7Bw5OmCXqSnv9LH7NhdocgevbvmCZNillfSvXW6QtFb7+My1fonGFXWkzyedFM1fNDltYLHal5+hGgYw2dvj8IpFrrJXC0uaCR8MsekaU+TxZV1r8U7PZ/tS0T6dDE456PDLodbnuChZdsXrPV7/SruuP2c8QtJatK/niDHnXWh7y8mVa6ryJG1PWlRb7C6W/eb4O+5KxDSVP4po+V+jXeoZl+a6WSv1aT9HPNvuzhuyjlIvFrvIcy7vAQv01LAtbjkMrSq+341iG669nWRdE/81h2/3Hn19snzb7/Zdvf7vbP50559mXSFzX+tfdymg75Eoc9H13uO4JpqWu9xSXUKzDNlnZr/AoM0Sv8TzDR1/S943rrmWR/4JLTSKV17Dpz0377aE9fflu+8th27zfHZotM8EFV8pKVn532LW7zd7/LzumlCdjDQu/e3h4auMT+68/bA73M7v+gpA1bFze83+NPr+X2fn1d4cfT82n3fGJPa8tSljRuj7H7fVG5gSt/CbJlS4z3+LU5S5LrJq77M/UXdP/Z61FYM01rPE7TN8ctiFd0aIxIStiDfu6xv5Nug/2y+Hj4fj5sGCAYAhb2eZVbP0aNg5nxS+rkWiFssgLmAK/iu2LcSNf3Ne1+/tj+90hjGuXZXm/LlzpUcoavsrTdRce9RdCrfNdsMCvYnsfVdTFNiycvLNFfhX7w4/dRHhG2OMSiUutD4NYr+V4+mYbAkg2+2HSOSOOeJ6slSzu9kQ4O3LZaivZEf6XvRaZqr2SVb8cmk+b/dPmOYXNFR90Sthim5u7R6HNxyokf+Wlvs5UutKG0xIbaKWlNvy8e+hG6odHbjgeqLBU9y+nfXS68vsuecWe1VkVKq5rS7cSXmhNX/UKey7tc96bwdXWtIP7VnIVZ9mS3BFyyVL7/WZ0FRf92ZuRaoNPGDJYc4S9vBTNPkFqYCnbIE9jVPganZdDDSylcelrtGaD6YBORrxcTmPiIf1VDNA9nn/j+sblXMqksJdx0ewjRNZBfX9GR2qppj+Xj8tO6fDBAdNahmKL9fzUoAUMVfNT6Q57hhY/YZ1WMxRbrOdNelN9VtGb8v30DE0XYD6tLC46U190IVXYGBxfIdX/vdhWkhvL3m3OjVG/nPY/Z+7ljiW+BKXxMwz2TWvN3GOdUztxl/WU3s7on49/HORNqB2XvkYruR6mpHLichiePtabJUUX6Tv62iwHokUX6Tv7t8P+jKj4dXqnn5MW5erjXhWXKOPcFDdWlXQnz1eqjFU9/8bvVh67Qz+Tol4OxTI2R1Zl9GQu0xwpmrhUM6PJiEpF1yFmbqocKXsAV1W25+3vduff7Q4fmlN/WGie9nPK37LKz2PadrXuTbodntW9Ge94r/LccH+1+Aay+6UL7In9rT3+5e0P30/bcCl3neb0uvmo1A9+Y/K5Ewr3fY8LFFss48L5jMSpG+eBpVHHE99QSdyao/UGuHhZ+cQ16u99lCPzZQ5GPFdayYo7f+HBPCMudVayoe+5LvtF86wBtVey6/GSPNlH0Ech7SzDUPUrLBsNnOPpf9oxXH5fZwBNxbEG0WcLlwykRCFrMIUa5wyoROmyQZVhRXFgJUYsGlwZNhQHWGLDokGW+R4YAy14I1cMtpN+WRxwiS2LBl1sARp4LyVLgy8ttM4ADKXyBuGR1fMH4pJ23mA8krDCMFS0auZQNNO+0oShaBZv0jDTGt7gWLRr7gDJsDDdrOpJOlrH9j/xh8ZNcxbavG5PfeUpoS9BhewieTB0Snef2oSv+7nCUt3N3a45X3Am9+FztdaxgvsacrXmWJEOV7vzt4/d8Z7TZv/X5kt3wfSpOZ8bMGwRUwoVZ1gzY6Mm0c7cqxkrRM0pd4UHKMGlJ98M/soU+TKuMPU4z/Ziqpc4CdeAUa0lVoxG/Evp7w6PTy3tUdNfrx7jgbjJwZ0YmBkbNiMPmVR5s5m80IXWLo9PuxA/359N+nuTtJNpczLV17DsY/NlhiGh9Ep6SYXRXKJsB6i90C7q+H8dCSeWjQtc6/4ZiVMtAFiaed1bciJ0lv4bUJtr0NTEbbjJejRlmzAprbi2NQttWc+SXKc1Ycl0v8WyJJq4xgGWo5E9/vHafZ2RrIlNncSweTs6Y1UT2zl8XX86HR/Y+vrCy3XeX06PMXQ+F/6duErr7hwfB2NoTitcqT28uihSn/260zrXWkAC09lWjOtd9f1nfopxjeXaP/k7nb/919Nmv2u//PCeHsLbAUI8togn5ap3FD58vFtRfEFx8eV63zft3Yf+Xc/rRF8Wqs6zh7fXPDYAbTTP15fZ0R2rA9u587VN7t2O9RY3budbcPyMNtHHaodyV+vKnruZ0M0+TcOzZXf2fdr2j1/S9LyskSFbdR2LkoNzswyiNa/1TZZrTOwkL/GNt1zdmWqzLEnnsDO63c0qfW6GlIzVAUwyV1cTZtFvvzw8NO1pd/c8q47XD3kTpuovt6xzIqavXa2nP+7JVPdcehWtM9o1rvV/feb9/3Lefd2cd9iz/e6wbX5jTexAleX6Lwf4Zg8x+ZorWDPXDbMVZ9qSblglJ9shmAUlrt2yyomc2rNCxmYGkNPoyjaW6pvT5AVtSMLE1hDNxsAz5XEqEcNyS5IbVeZZU7w+ZblFyT2A8ywqXv4336JzmqmCZ8u5nKRivhXt5p7bEAcb+iprWXDqT0DPb0BDtdV8xFcd52Nlusmo9lp2bTftXD/pq6xpwevd3DfyXGtNO5K7B/mGFC8dXGTJkDRhvjFRzbXsmYjFmTKKHYizoFUNt4nMbU9RvTW/2o8L7aF11/TpP3WneOdOIZKKq41KKL5sclTiL8SZ7wSn9Wa+F14a7/lWbZ4358PWw9yREwpYy7qmyIOnTBvXXq39T8S9TfYD7KA3lm10YfL6grnwsmT0+7WLEixwakkyNrM4nQov4W9kN51hwA2uzzRq/kSmbExxGrNEO+xop22Y6GbnWpIbEsuGTA+Ic+0Ak/+yCcWp/1ztE1OWsiXsCcsCL8lOESYdhTFBmGsPHJDLhkwMx7PfSGkwnnglvKF4rkWTA3HZqhnD8FzLyoNw2SzuEDy7t8lvfUx0OJyND4Y1Jno/vzV3T116yH1zPn/zzt+DdLHp/dPB30Z9/j0qVg6NjcKB/vJ5vPX7l8/lcZtunP91N940H2S8vPyO30inPy85eNybCflxqdlaQrhCPuzjomhccLaubdMdWP9xv9kdQnaCHOe9KC3UmK29+a09be7a4ttMyszWEAfE5N3qJS12lR6eGqYWbgT8sw5G6Dt9kFFw6t82bXPabehWdPTLCuGoiShGHOrFqHy8LwrxRGpuPk5FdV5qTcYY/7jZ0fG9oLUvvUDv8pc66O1l/i4fvj824GJzMZ71L58/LjTlJhYw16jJkdNf23eNcbGE662jLe3HnIHPP0wMe0Re5mNc/s4ehOnSc+hm+r/zB+NPfcbUv5z7yO5NUeZLWB6/+cHGqcG6rDAutlTPazCAUSWlnfQJDXfHh67opJak3DJNIYo1vuVmQiWscIXu/LQH6J2e+kx/u++bz8255fj7S1B6qdYf9tsZWmnpRVp35874idbwXGihjs7USR1DoYU6mLGAROnMMEC2FeUAjYwRvOAMXr/wt9xGTKmTAJUW2TD0189RfX7yOdmAi/W4lnAnx+QFTE+Qx6rA4HiOc1ISVd1v1x5XoaImTqvEVs07rDJSNHFWJaOJFwo+UjY35QhLeyYcdqR8ZqoRlu5MUPpI98wUI+znLsZrwzewKLUIw98ywbIjG2amFMlpTifDUSmMhsYFrl3UZiROrW2BpeU999e7LfNhyH57X5FrxpK97QlDJja3Z9swQSF4r4U9Chbtog74y6G75CVU/Kl53NMjn6PfywOGHiXKftseo2F2NySBvjy1/50/Ch0fmwNL2su+ZPFVBeNyA9H+eOZZ/nIoulxZvJFfVFXatecoum+Yiu4Leao5iv6VpBAtqvpXMVk1R9k2ze9c1LYt53jmuUazOXFdIxSdpyzTjugYkdHMGSlGnWS0kcoQ+/JSZfrBwHgRTVR/TGMvRgMx+f3aCSsSNzFppRZmXiLY+YDKCjsfTE333Y9g9gbVPRe+XmfDfJ/Pha/S2a29fAGQywfqTStcp7u/qRrtLmHdSYWrdJ+afz015xYcqoGa4+JXv+9vf3vcncDBluz7fq5w5fvuMT73bT8Xv0rv+e74yPTqoehV+u6Oh3DHFfMVJ+Vna4b97E/BXwr6+xLr9bWxQHZvO9i5pL9NFLJ63AltfSMD6/WM0rjClbp5fVGifV5vNKl/um0S7fzWOaF7qn0merktdEInq40mime1UqAdttPz6OrbsRWXMvzJ3tNpxxb4MhSeeqJnS8utJzmrNak7rXS1DX5SMs+CuMoK7+DT8c7Tp7mvgdS72hJ/w/puojshViR1llgwHi+mxyFiA6l1tRVhC3m2GbTaSnZMLX+gFeWgxwXvYvC1+a8jqnm1NRfygml81pZRvast8UloZn6apM7VFnzYXIq8nRgMiR2g5hJruAQr7yEMmjXRfcUDZIg7+WvzJRM6QQsUh0b2wyGhvCej9rJCw8p6y6FhXI3j7HplrdNp9Qqap3NzYKXF/BylJ01chl6g+Kyz/4W/1vFZIJtvDtvvDj601MctJWlLptS85InIPfLwLEucODGD571jdfDVji9bHGm9FLl6YYklTq0sx6bOY9A5tRMouqyXR6RzqueC6Tm2ZPh0zpSZmHqOJRlanbNkJrSe+06K7Lr0dhYhbL7XZkh2zqKZQHvCDho0SgtjvJ0tdy3lLguegt1585cRXpY1fNCbFzd1ymq07ptjH2cJuNAySOl5Vk3A+qUWTR0p5hnHP1g8x040/OIbG9OfVxt22fc2EvMWDrf82xt5+g7D1ep/8pewsBSP61xjwSUBFkt3XHqu1pnTiyvuruTaMDWtWH6DJdeCqenE8nss57wD3jRijdsseT45NX1YfqdlQX9m2lC42RKWWW26MPt+S2zyldOE6+9VxKLKQ977tDfk2vR+Toe4xnRg6W2gSyxhTwNWuHGSa9/4WoJRo+3/zh/wd2dOcu7hhMCcbNyFQLRvipmxL2Fo37DyYue3a/C9VImW7cQ1VBM6Lhspf22+vLlcEgIxT6K2WG9lS3457w73by6JRs7kApSZ9mWlfQ2rh4bR/WEFs6G4r2l3n7BvRdOpxK9hfWAoa/gJlbSwHXd7ps8bvlMNelR6kdYBKH1zuGvO7fH01+bLN4ftm+Z81xzGT3v+26a9m2jzCyUu7WN/9EV7f/EpNN6Ps0/met6Jyotsmlp8JTZwV10TOnfnt+3m1J7/c9d+4KiF5Rdpfve0229/3txP5IsOaseFl7brT82p/Xlzf+Y8LCp+jd4ZOq/TN7SkN0kGoJ+a901Xf7fZf3dom/vTrp3oK2bJWWTp+cPxab8dOu9vsov/xKx8pUU2hGn6d4e7/dO2OV+SSHFmkC8n665g0S+HxytsgrW5VnHxGR7zZk1NweT9TXp2gSgLv167czcWxrtWrLdt3r4dUMa7WGxCGzP3fqJ3ZvL9sgWXfbipVPexCajSTBtm3V8U6567hce0oHyPS2zAzA08pv7yjUrjl/81np9z4RB9E4s271ieWb7xJbZj5tZdXju8eyGUK16+kBS5dt8uK5N5/UJqbzZws5Q9PqubnT4+lbBGDu68TXOTcM+xbfr+g7xdcy5AmGNTKdd03hpesul57+bpsOClhEqrWcHJeZ03Z17S6ym7xhOhn5p8V9r9ttIk6CKKNwXyVi2aAD0r4k1/SprYU49npbMnHlT/rGnHs96Fk46y9vKU41n5sglHWXd5ukFf+PrPzZlqpG/gmolGyQvL04xnG5ZNMkaa4RSjK1WcYEQFVppeUInMyUVs6RzkVtY6xdtA7TWmFDlr5k4o+HaVhu6cNbyBm28D82KBnDmz7xWYYdnkZCtr1IypFt8eztQiZ9G8iUXZpvG04u3Tu+4s5Lvs0HUpsNIEI5XHm2U8G7loqkFU8uYbkzrZkw6ifvbMA1oya/pBLFg4B2HYUZ6IEDOWzUYYVpSnJPBzfKV3wZmcgLdyzQxl0m/L0xRizbK5CrYBTlguRYuzFlpqpakLFMucv4wMv2oCUbJk9ixiJGxBZBPHLt5ca6Y1pYlN0Rre7GamNdMTiaJNc2YTMy3jTCmKts2bVzCsiyYXb5u7R6HNx2rUzVx+4U8nBgKJwhpScS/ToviBnm3LTV/8gbO/Nl9+PsaJuDMqR6WXar1EY/DUjopf9bR/+fzx5+Mfv7QAHMHnTcpf98QzVIMKC3XDI5ZEXfFs5aSGcLXHpMMOpRZquW8OzSn4QXKLQUbduPg6en/afJ6pOtRYrL0/FcroEkjZazUymiYpy9fIJe1EH4e1I3Wgwz5lO+zTuh32aX6Hfbqywz4t6rALWrnd12lp95XXXeq+TjO6r7yGcvd1mtV95bUwu6/Tsu4rr/dd9/p/Pv5xd/8dSF1BtNLCfJ0zG/RpfoNOHzFKjEmyP0RJKxlpHwqZF7CgiZQLcxMtZJRMZ1iYkVcho6Pcaqj4qAM9nto3u1NzlxwgbQ5PD+ffJ7+VX/zzBwwxr9vd4X5S2sukbMb0xD6o8Ru+wm+W64sGnW5BO2oL3R/5Q8153zTj6xIuMl4Ov2MjvQEZyQ+7w+5hs387oYAUm6+nu1jm6dQVzF//8KwOl56vNeyBcjSOSy7V9sP79+eG9ZS58vM1D/MLjlZUlqWR281HD8jo4YmSuOF0R0t88uD/aD414wR46c/FxsQ1HYhkPQSxNDMC3PlT3Vyloeg1+t7tj3cfz0nu9ZLOpPhMvfn87CWNxfTsPF1pgvbiKy3mZ+dpizO0l3SVErTzNN2DK1uQplKGdp4mkja9pGwiazr3i8V508tfrJQ2Pd8Goi7k20/Nof2P4z3uQZJfV+lAxhJZ/UdqZqY5P+132z9tOjnjBQvQmxa/Qu+uC5vmaBwKztM13XUAVcWeg6UJdxzo+xX7DaYu5PJQV8njWbo2j4/NYUzhgLJLySu0+VsbfMnxvgBQmRa/Qu990/K1xoWv0Bl6vyDpj1/QJYdAN6o0sy2OL/QqTIpGJfiLDH/yDCZdKAt/iSriZxzbP7+LzRgx47a0xTO1vOrSZI2ttTBfy7356SkbWzvu5jOKy119Sed0d59Ryb7LZ0G3n/uw7Ct9Zs/lMhq5F+5Md8pcjfx7d5bMIjNKZ1y/M3s+nlHJvTNpwUCe9R7urT+lLv+n5vz0sHm3b37enD8WOv5MuVVmtSXZzDOQ+CFy0P/dPBN8+VU0Zzr+qRdQ6v6nLZjuEov6ix3jTO24eyw/frGTnKn/1Nzv4AUbRROiWqtYcX/azPTAvsZK7wBG0RWff1OKKp6lvfmtReuHov5LnVUsyAwl5R6gPKDMbgWom59oBaXOntEL0U2Lbx92bduc3ranZjPOzT0ust72xVgsfw8jtTpHM7LB2Dn9cY1rtee3GIDi6X0Gls7CZgN629M7DiytzcNuPD3KKe0LL9JJEvg1p/Px8HxhQ58kLfz12pDWWMxkWr7ekNwsY0dPcgDhN9vyxVG+fDmEMSXLeU0T+fy5upIIg6K2YnBBVt+yjzTo6+X9rmIqvtiZi1wdhSvxTbh5nIxfwsZMRtMOETCLjIprr2gVzqcILJrKoJh1xJh5N+e226D/cwhlQZSQluBvVA3xMbSjKYt+Oa6WIZIj26fsmL7+YMokJGFt63B2aK5l/6e4TzDbKh+N/RqfZ5owKa26kj19/DfOfDlhEKm78nfrrwS55DRaZOKUsJVs7tLDXWMmqL/u913UBkjddS3Kn0zkWfV2cmq81LJMTiqeWW/KC7LZNgWCsujzpVVXtWfxxxtXX8muflvx/Gew5zxhU1p1JXuGlHX4PrkJi2jlr2HT2+Eg4lXGxVKutPK0OWyPDxeBb9tTHKs4YVyu8jo2LTFlVQtwAHrRgHII+kz9r98dT28/bIQ2CP8W7aBVV7EHhXUXrSiFds/UXYg1LFnACDvk2hHiJ9/stj815+P+qfXX6p6f9ux3UhKwUl/zZrftwviXrVRo5fk2sWM2My+IE8BZfCWjraH0/uOu4nhJOi6zwrZRRihjEwmYPHVada76mwW3ZXsZU6dnx5eG8y1acHs4w6b0Mm+uNTNv9WbYAS745hqz5KZvbFG+gfhVbrF5XEqs1zhSkfym8WzsFY4Ilc90w2cZ5Y/fXyuO9mWL1sT11rKlC8b/9rfH3anJe2Lm3SQ1V7NnshPLfSl+F8a1pdxZYDu4XQXXBkZHgQ2Z1U0UrCmNosOF2xMDaVxszbF0JHfOcJrYftUIljNj9iCWCJrxId4W/dT/OrG/jS/BmtCAS139gQtiuVdhUcOzQYf98cT5JtzEdWcZM5kLr/1wzN3xVDLoUvFKa6gzDBszZWfIlLrWGUpip5whZ/hMZ2CYwHCGnJQFzsAxaMIZ2NZQZwg7h2VXgGWudYS80Ck3wCbPdIJJ9QwXwDIWOMC0MROff4klQ5al2bZEFa+yJpPbrOyLuNC1zliQykxsdqU7ThvA8MeMkAUOyTBnwiMX2ZJxSYY1kz65yJ670a1WbIPuuHdaLXtDyT2As98S5zbASbscmLe+HpYoIZXPBqR1KBcuNuQo60K3C7I7RWtKtvCXUdWpCTx8HGjPj6fjh927XbvIoqTylTbl1xSvp9edz0XWW9QRmfwFXWRvMVhrU1zMYfU3aVW+KZdm8F+v+hNOf/h3l/WnK/XiDy/EjbypX7x68X7X7LfnF3/4NZj66sXd8eGh8bBke7x78v/8r77Y35tuP7wrHEr//vbFq19vXxl1o434r/969etQ2f/g/zDIeP6Lr1i9ePVr9UrYG2F0UrEaVaySiuLFq18F0ihGFUVSUb549at8pesbpVVSUY4qyqSievHqV4UqqlFFlVTUL179qlFFPaqok4rmxatfDapoRhVNUtG+ePWrRRXtqKJNKroXr351qKIbVXRJxTqnsR5VrFMH6PyhfqXUTVWnNaux71TEebz33L5S4kbXaV3gPqn/VJ1XVBUyuRq7UJX6UNV5RiVg5bEbVakfVZ13VNAFq7ErVakvVZ2HVNANq7E7Vak/VZ2XVPqVsjeiMmnlsUtVqU9VnadUBjW5auxWVepXVectlYWVx65Vpb5VdR5TOVh57F5V6l/iNtfDiLF/idS/hPevGr0vMXYwQToo30Pdwsqgj0odTHQuI6pX6vZGu/Qzi7GDidTBROcyQrzS5ubWpe1CjB1MpA4mOpcREvasYwcTqYMJk33ZY/8SqX+JzmOEeqXljbbkfY39S6T+JTqPERpWHvuXSP1LdB4joGeLsX+J1L9k5zICerYcO5hMHUxmhz859i+Z+pf0/gVbhRz7lySDoMwqBsNg6l4yOxDKsXfJ1Luk964auaYce5dMvUt2DiNvoeaxe8nUvaTNjTNy7F0y9S7pcuOMHDuXTJ1Ldu4iK/iZxs4lU+dSnbtI8UpXN9qmc46xb6nUt1R2cFRj31KpbymRcw81di2VupbyEyzYgaixbykyx1JZxWCWlfqW6rxFKvTAY9dSqWsp71oaGj12LZW6luq8RcL+Q419S6W+pTp3kbD/UGPnUqlzqTr7usa+pVLf0rfZLlOPnUunzqWrbGetx96lU+/SncNI2HPpsXvp1L10tufSY+/SqXfpzmFkDRWP3UuTWXznMQoucjSYyKf+pbMDox67l07dS3cOoyrUZ+qxe+nUvXTnMErADzV2L526l66zsxA99i+d+pfpPEbBfsCM/cuk/mWqXMdnxu5lUvcyItfxmbF3mdS7TNa7zNi7TOpdxo+LcGA0Y+8yqXcZnVU8di5DlomdvyiNHMSAlWLqXcZ7F15ljr3LpN5lvHfBzsuMvcuk3mU6f1GwGzBj7zKpd1nvXbAp27F32dS7bOcwGjZlO3Yvm7qXzY6NduxeNnUv23mMhotOO/Yvm/qXVbnxzY7dy6buZf0eBNwvsWP/sql/2c5jNGzJduxflmxFdB6j1StV37iamA12I1L/si77rsfuZVP3sp3DaDik27F72dS9XOcwGg7pbuxeLnUv590Ltgo3di+XupfrPEbDVuHG/uVS/3LZ7suN3cul7uU6j9GwRbmxf7nUv1znMQa2KDf2L5f6l/P7XHCK7Mb+5VL/cjb7yGP3cmS3y2WbowMbXql/uc5jDGxSbuxfLvWvuvMYA5tUPfavOvWvOrtqrMfuVafuVXcOYxRUPHavOnWvuvMYA7cy67F/1al/1So70NRj/6pT/6p1doirx/5Vp/5Ve/+Cjbke+1ed+led9a967F916l+1y+4f1WP/qsmOap3dP6rBpirdVb3NTt3Cb2n16G99/c5tjEUvPPxG65Pd1VvvZ3jP7hbsr96SDdbbbE8WfqLVyRbrbec+pkajTviN1ie7rLedB9lbNG0Ov9H6ZKP1tnMiC7u08ButT/Zab/0OPuxcwm+0Ptluvc0OnOEnWp1suN767XzYPYXfaH3ifVV207VCu/qjbf3OmSzspCq4s0+cr8pO0Sq0t0839/1+vYWdTYW29+n+vt+yt3inHO3w0y1+v2tv8WY52uSnu/x+497itof2+elGf5Xt8iq000+3+v3uvYUTiQpt9tPdfr+B7+BcokL7/WTDv/Kb+K6CbRfs+Vdk078SeSYJdv0rsu1f+Z18h5su2PivyM5/5TfzHW57YO+/Ipv/ld/Pd7jxgO3/iuz/VyK7Eq0AAKgIAaj8rn6m5wUQoCIUoPIb+w5O2yvAASoCAiq/t+9w4wMooCIsoPLb+w43PkADKoIDKr/D73DjA0CgIkSgyiOBCjCBikCByu/zuxpsnFSAClQEC1R+q7+GW+wVIAMVQQOV3+6v8bgH6EBF8EDld/xr3HgAIKgIIaj8pn+NGw9gBBWBBFWgBLjxAE5QEVBQ+c3/GnsvYAUVgQWV3/+vsfcCXFARXlCp/MALiEFFkEGl8tu6FaAGFcEGlUcBeE+5AuSgIuig8jSgxo0PwIOK0IPKE4EaNz4AECpCECqV7/sAQ6gIRKg8F8Dz/QpghIpwhMqjATzlrwBJqAhKqDwdyEz6AUyoCE2oPCHAezUVAAoVIQqVhwQ1HvkBU6gIVKh0QFZ46AdcoSJgodJh6xf3P4AtVAQuVHm6UAG8UBG+UHlkUN3i/gsghoowhkrnHRBAhopQhkoXHBCAhoqQhkoXHBCwhorAhsrzg8zgD3BDRXhD5RFCdSthBwKQQ0WYQ+UxQnWL42MAdqgId6hMcEG4x1EB9lAR+FB5oJCZfQL+UBEAUQUCcYuHAAAhKkIhKhN8EAZjVQBEVIREVAFF3Dr8CMALCY6oAo+AwKoCQKIiRKLykCHTjQEmUREoUXnOkFm8AyxRES5RBTABmVkFyERF0ERlgxPCKIcK0ImK4InKE4eqwv0gIBQVQRRVnlFUAFJUhFJUHjxUFe5GAaioCKmoPH2oMgFygFZUBFdUNt8PAl5REWBReQaRmccAZFERZlF5DFF1MXroC6JoN+KCAVxk4vQAu6gIvKg8j8jMpAC+qAi/qDySqCo8EwUIoyIMo/JYIrMJAihGRTBG5UJ8Je7HAMmoCMqoAsvIxQwCJyQ8o3LZWJIKAI2KEI3KQ4qqcvgNACckVKPyoKKq8HQIgI2KkI0qoA2BuwFANyqCNypPLCpRvZL25laR5SAgHBVBHJWnFtl3ANyQYI7Kkwsc6go4R0VARxVIR0Y/gB0VoR2VBxiVwBMyADwqQjyqOkT64hUlgB4VoR6VBxmVwEtKAD4qQj4qDzMqgVsygB8VoR+VBxoVjm+sAACpCAGpAgLJuBGgIBXBIFXgIDhIsgIkpCIopPJ0o0uuquSNJL0hgCEVoSHC041KwPA/AXCIIDhEeLxRSTinEICHCMJDhOcbEN4LgEMEwSEi4BAJP4EAQEQQICJuQ9C5eKX0TXUriQAQFUyIiPCEo5ISCwCRwQSJCI84qu4VIAEgPJgwEeEZR4WD9ASAIoJAEZGHIgJAEUGgiLjNR0MJAEUEgSLCUw68uhaAighCRUQ47SAhQRUAiwiCRYTnHDhASQAuIggXEVXJCQEYEQSMiP7kg8WvADghISMinH6QDgsATkjQiKiyR2oEICOCkBFRZYOIBSAjgpARUWXjiAUAI4KAERHOQcgadkKAjAh6FCKchVC3YHdYoNMQ9DhEICOqeqXcjTKOCAAeODoSIbIHUAQ8FEE80LOOSuFzX+hgBD0ZIbJzQoGORtCzEaKwNBboeAQ9HxEOSOCoSIHOSNBDEiLL5gQ6JUGPSQhXegDgg/SohMcdVaYTQaclCB8RgY/A6gCPCIJHhOcduAUCPCIIHhEyGxsqAB4RBI+IcGxCwd0hAfiIIHxEeN5R4SgYAQCJIIBEyHD+CwZmCEBIBCEkQgYPzHwB4IEEkQiPPHKdAGAkgjASEU5T4E4AMBJBGImQwQXhukoASCIIJBF5SCIAJBEEkgiVjU0WgJEIwkhEOFuBo08FgCSCQBLhoUel4e6MAJREEEoiwiELHA0qACYRBJOIgEkynQAAJYKAEhFACQ4pFYCUCEJKhCcflYarKgFQiSCoRKjghHgyCViJIKxEhKMXOERUAFgiCCwRHn5UOExUAFoiCC0RgZbgZZkAtEQQWiICLclMKAEtEYSWiEBLcLCqALxEEF4iAi/BQacC8BJBeIkIvAQHngpATAQhJiIQExx8KgAyEQSZCB2OxeLGBJiJIMxE6PyqBCATQZCJCMgEh5IKgEwEQSYiIBODGzNAJoIgExGQicFNCSATQZCJCAc2cICmAMxEEGYiAjMxuCkBZiIIMxGBmRg8KAJmIggzEYGZGOzIgJkIwkyEZyCVxY4MoIkg0ER4CFLhkEMBqIkg1ESYwmahANhEEGwiPAapcNCiANxEEG4iAjfBYYcCcBNBuIkI3AQHDgrATQThJiJwE8wfBSAngpATEciJxW0BkBNByIkI5AQHDwpATgQhJyKQk8xWF2AngrAT4VlIpjrwQ4JOREAncIYNwIkg4EQEcIKDHwUAJ4KAE2GDF+IxCZATQciJCOQExy8KQE4EISfCk5AKBzAKgE4EQScioBOHmzJAJ4KgExHQSaYpA3QiCDoRAZ3gIEYB4Ikg8EQEeJKzAHghgSciwBOH+wIATwSBJyLAExwHKQA8EQSeiABPcCSiAPBEEHgiAjzBoYgCwBNB4InwNKTCsYgC4BNB8IkI+AQHIwqATwTBJyLgE4fbAsAnguATEfBJjdsCwCeC4BMR8AmOKBQAnwiCT0TAJzikUAB8Igg+EQGf4JhCAfCJIPhEBHyCgwoFwCeC4BPRHyPBngjwiSD4RAR8gsMKBeAngvATGfgJDsyTgJ9Iwk9k4Cc4Mk8CfiIJP5EeiFQ4tkwCgiIJQZEeiAgcWyYBQZGEoEgPRASOLZOAoEhCUKQHIgIHh0lAUCQhKNIDEXELPVECgiIJQZG3IbwLeqIEBEUSgiI9EhG30BMlYCiSMBQZGAqObpIAokgCUaSHIuIWeyKgKJJQFOmhiLjFnggoiiQURVYhrw/2RIBRJMEosgq5fbAnAowiCUaRnooIHJ4jAUaRBKNIT0VEhT0RYBRJMIr0XERU2BMBSJEEpMgqhHhhTwQoRRKUIqsQ6oo9EcAUSWCKrALNw54IYIokMEWKcMIOeyKgKZLQFOnhiMB5rSSgKZLQFBkyTOEAEwlwiiQ4RYYsUzjARAKcIglOkX2mKeyJAKhIAlRkyDaF4zMkACqSABXp+YjA8RkSABVJgIoMaadwfIYESEUSpCJD6ikcnyEBUpEEqciQfgrHZ0iAVCTNQBVSUGVyUKEkVDQLlackIpNLCmWioqmoQi4qgT0RZaMapaPyniixJ8KUVMQTPScRmTxLKC8VTUwVMlNJ7IkoNxVNTuU5icCJjyTKT0UTVHlOIiT2RJSkimap8qBE4AAJiTJV0VRVHpQInMlIomxVhKxIj0oEzmYkAVuRhK3IcAAF5waSgK5IQldkOIGCc/xIQFckoSvSwxKB8/xIQFckoSvSwxKhsCcCuiIJXZEelggMuSWgK5LQFalC9Cv2REBXJKErMpxDUdgTAV2RhK7IcBBFYU8EdEUSuiI9LBEKeyKgK5LQFRmyW+HUNBLQFUnoiuwzXGFPBHRFEroiPSwRGFNKQFckoSvSwxKBQaEEdEUSuiI9LBEYFEpAVyShK9LDEoFBoQR0RRK6Ij0sEZjzSUBXJKErMhxIwZxPAroiCV2ROiSGxJ4I+IokfEWGHFiY80nAVyThK9KEPGvYEwFfkYSvSI9LBKZsEvAVSfiKNOFUHvZEwFck4SvS4xKBKZsEfEUSviI9LhGYsknAVyThK9LjEoEpmwR8RRK+Ij0uERiTScBXJOErMhxKwZlTJOArkvAV6XGJwJhMAr4iCV+RJqQpxZ4I+IokfEV6XCIwJpOAr0jCV6THJQJn9ZCAr0jCV6THJQJjMgn4iiR8RXpcIjAmk4CvSMJXpMclAmMyCfiKJHxFelwiMOWSgK9IwldkOJuCKZcEhEUSwiI9MhGYcknAWCRhLNIjE4EhlQSMRRLGIsPhFAypJGAskjAW6ULSXOyJgLFIwlikRyYCUx4JGIskjEV6ZCIw5ZGAsUjCWKRHJgJTHgkYiySMRXpkIjDlkYCxSMJYpEcmAkMaCRiLJIxFemQiMGORgLFIwlikRyYCMxYJGIskjEV6ZCIwY5GAsUjCWKRHJgIzFgkYiySMRXpkIjBjkYCxSMJYpEcmAjMWCRiLJIxF1iGPM/ZEwFgkYSzSIxOBGYsEjEUSxiI9MhGYsUjAWCRhLLIOWZ2xJwLGIgljkR6ZCMxYJGAskjAW6ZGJwIxFAsYiCWORHpkIzFgkYCySMBYZ0nVhxiIBY5GEsaiQsQszFgUYiyKMRXlkIjBjUYCxKMJYlEcmAjMWBRiLIoxFeWQiMWNRgLEowliURyYSMxYFGIsijEV5ZCIxY1GAsSjCWNRtyDGO01cDxqIIY1EemUjMWBRgLIowFuWRicSMRQHGoghjUR6ZSMxYFGAsijAW5ZGJxIxFAcaiCGNRHplIzFgUYCyKMBblkYnEjEUBxqIIY1EemUjMWBRgLIowFuWRicSMRQHGoghjUR6ZSMxYFGAsijAW5ZGJxIxFAcaiCGNRHplIzFgUYCyKMBblkYnEjEUBxqIIY1FVyH2PPREwFkUYi/LIRGLGogBjUYSxKI9MJGYsCjAWRRiL8shEYsaiAGNRhLEoj0wkZiwKMBZFGIvyyERixqIAY1GEsSiPTCRmLAowFkUYi/LIRGLGogBjUYSxKI9MJGYsCjAWRRiL8shEYsaiAGNRhLEoj0wkZiwKMBZFGIuS4SYG7ImAsSjCWJQMpwawJwLGoghjUR6ZSMxYFGAsijAWJcPFDNgTAWNRhLEoj0wkZiwKMBZFGIvyyERixqIAY1GEsahwA0jucgngiYSxKI9MJGYsCjAWRRiL8shEZm6KAIxFEcaiwn0gmdsiAGNR9EqQcCdI5sYIdC0IvRcknF/BjEWhu0Ho5SAemUjMWBS6IITeEBKuCFEwzZxCl4SMbgkJqdBh5mYFbwohntjfFYI9EV0XQu8LCReGYMai0JUh9M6QcIIFnsVU6NYQem1IuDekO4MzPgim0M0h9OqQcIAFnyRT6PoQgliUJyYSQx4FEIsiiEXpwnFSBRCLIohFBcQC8+woQFgUISxKBz/EbREQFkUIiwoXimDKpABhUYSwKB38ELdFQFgUISxKBz/EbREQFkUIi/LARGLKpABhUYSwKA9MJKZMChAWRQiL8sBEYsqkAGFRhLAoD0wkpkwKEBZFCIsKt41gyqQAYVGEsKhwggWHOytAWBQhLMoDE4kxlQKERRHCosIJFpghQwHAoghgUaZwbEABwKIIYFHGZG9fAnhFEbyiwvEVnFtAAbyiCF5R4fgKTnChAF5RBK+ocHwFJ7hQAK8ogldUOL6CE1wogFcUwSvKBjfMXCQF3JDgFZVP+6UAXFEErihbyO+gAFxRBK6oAFfgxYMKsBVF2Iqy+Sz/CqAVRdCKCmgFZuhQgKwoQlaUDX0hzE+hAFlRhKwoG/pC3J0DsqIIWVE2n+hGAbCiCFhRrpDoRgGwoghYUZ6T4GYMsIoiWEWFoysZFwJYRRGsosLRlUwzBlhFEayiwtGVTDMGWEURrKLC0ZVMMwZYRRGsojwlkRi3K4BVFMEqKn+liQJQRRGoosLBldw3AE5IoIpy+UQ3CjAVRZiKCkwFdwMAqSiCVFRdFZohQCqKIBXlCQnOXacAUVGEqCgPSCSOd1CAqChCVJQHJBLHOyhAVBQhKsoDEonjHRQgKooQFeUBicTxDgoQFUWIivKAROJ4BwWIiiJERdWF86QKEBVFiIrygETigAkFiIoiREV7QCJxwIQGREUToqI9IJE4YEIDoqIJUdEh65eB+es0ICqaEBWdvwZFA56iCU/RHo/AbPAa0BRNaIr2cARng9cApmgCU3SAKTjcQwOYoglM0QGm4HAPDWCKJjBFB5iCwz00gCmawBTt2UjmA4xdUBOUoqvC4XoNUIomKEUHlILDTTRAKZqgFB1QCg430QClaIJStCcj2IcASNEEpOgAUnC0igYgRROQokPOLzgl0oCjaMJRdLj0HE+JNOAomnAUHTgKDpfRgKNowlF04CgW5tnQgKNowlF04CgWpnTWgKNowlF04Cg4XEYDjqIJR9GBo+BwGQ04iiYcRQeOgsNlNOAomnAUHTgKDpfRgKNowlF04Cg4XEYDjqIJR9GBozjckgBH0YSjaJFdImtAUTShKDqk/sJTYw0oiiYURYfkX3hqrAFF0YSi6EBRcLyPBhRFE4qiA0XB8T4aUBRNKIoOFMXhpgQoiiYURQeK4nBTAhRFE4qiZWGRrAFF0YSi6EBRcMCQBhRFE4qiA0XBAUMaUBRNKIqWhUycGlAUTSiKDhQFRxxpQFE0oSg6UJS6QoMKgCiaQBQdIAoOONIAomgCUXSAKDjgSAOIoglE0QGiZPp0AFE0gSg6QJRMnw4giiYQRQeIUuOpBYAomkAUHSAKDnnSAKJoAlF0gCg45EkDiKIJRNEBouCQJw0giiYQRavsSlkDhqIJQ9EhCRi+LUIDhqIJQ9EeieD7LjRAKJpewR5ygOF8Mxrdwk6vYQ8IBWdU1egmdnoVe39jCsxoqNFt7PQ6do9E8H0XGt3ITq9kDynAcKp9jW5lH13LHrwQ96fwZnbihQGh1DV+BcAL6f3sIQUYvnFDoyva6R3tupCVU6Nr2uk97Z6IZK6IRze1E4KiwxkVfNE7ACiaABTteQi+cUMDfqIJP9Eeh2RuqQf4RBN8ovtLUyAJ1ACfaIJPdMAnmVEd8BNN+Ik2hczEGvATTfiJDpem3OLFNiAomhAUbWxhrwEQFE0IijYuv+2mAUHRhKDocG8Kjt7UgKBoQlC0zSbm1ICfaMJPdH9tCrx1RAN+ogk/0R6I5HoCQFA0ISjalvwQEBRNCIr2RCTTkABB0YSgaE9EMr0xICiaEBRdICgaEBRNCIr2QCTTkAFA0QSgaFvYu9YAoGgCUHQAKJl2CAiKJgRFeyCSa4eAoGhCUHQgKJl2CBiKJgxF9wwFt0PAUDRhKNojEYWDoDVgKJowFO2RiMJB0BowFE0YivZIROEgaA0YiiYMRbvQG+K5KWAomjAU7aGIwkHQGlAUTSiK9lBE4SBoDSiKJhRFu9Ab4nkJwCiaYBRdB0/E6zzAUTThKNpjEYWDoDXgKJpwFF0Xwho0ACmagBTtuYjCUdQagBRNQIqus/naNcAommAUHa6Nr3B/BDCKJhhFeyqiKniDjQYYRROMovPXx2sAUTSBKNozEVXBKC8NIIomEEXXYWYIWZgGEEUTiGI8E8kIMACiGAJRzG2VfwQDIIohEMXkr04xAKEYglDMbfBB2BMYAFEMgSjGUxGFg9ANwCiGYBRzG7wQ9gQGcBRDOIq5DV4IewIDOIohHMXchmEZ9gQGcBRDOIrxWEThIHQDOIohHMV4MKJwELoBJMUQkmI8GFE4CN0AkmIISTEejCgchG4ASTGEpJhwfQoOQjeApBhCUkw4lII3Lw1gKYawFBNYCt68NIClGMJSjGcjCofBGwBTDIEpxrMRhcPgDYAphsAUUxXukjIAphgCU0wVPBE3JgBTDIEppsqH2BjAUgxhKUYUQmwMYCmGsBQjsiE2BpAUQ0iKEYUQGwNIiiEkxYhCiI0BJMUQkmJEIcTGAJJiCEkxohBiYwBJMYSkGBHcEHeIgKUYwlJM/hoVA0iKISTFeDCi8FEKA0iKISTFhGtUch8ReCEhKUbmd2wMACmGgBTjuYjCZzkMACmGgBTjuQjcNjQAoxiCUUy4aB62IQBRDIEoJtyjgrJMG4BQDEEoJtyigm9SMgChGIJQTH+LCoreN4CgGEJQTCAoOHrfAIJiCEEx4RIVHDtvAEIxBKGYcIsKvIXFAIJiCEExHogofJbHAIJiCEExKnggHtABQTGEoBgPRBQ+y2MAQTGEoJhwkQoeCQBAMQSgmABQ0EUwBuATQ/CJ8TRE4aNEBuATQ/CJ8TRE4aNEBuATQ/CJ8TxE4aNEBgAUQwCKUaEfdPAVACck/MR4HqIk3HAzAKAYAlCM5yEKnyQyAKAYAlCM5yFKwR0zAwCKIQDFeB6i8JaXAQDFEIBiPBBRCjIgAwiKIQTFeCCicLY2AwiKIQTF6HyEjQEAxRCAYgJAge0A4BND8InxNEThc0QG4BND8InRBS8E9MQQemICPcn5APBCgk+MuS34AOAnhvATY6qCDwCAYghAMQGg4JNMBhAUQwiKMcELcVcACIohBMWY4IV4Xg4IiiEExXggovBJJgMIiiEExQSCgk8yGUBQDCEoxgMRAw/EGQBQDAEoxvMQhU9CGQBQDAEoJgAUfBLKAIBiCEAxnogofBLKAIRiCEIxnogofBLKAIRiCEIxnogofJDJAIRiCEIxnogofAjGAIRiCEIxHokonG/PAIZiCEMxtnB3hQEQxRCIYmxwRNwUAEUxhKIYW1okA4xiCEYx1uX3PQ3AKIZgFOOpCAz6NACiGAJRjLvNxvcYwFAMYSimP4WCh3XAUAxhKMYFN8SdCWAohjAUU7pCxQCGYghDMYGh4DMEBjAUQxiKcYVRGSAUQxCKcYW4VwMQiiEIxTib3acAAMUQgGJKx1AMACiGABQT7k/J7FMAgGIIQDHh/pTMPgUAKIYAFBPuT8nsUwCAYghAMZ6HKHwOxACAYghAMXU2/t8AfGIIPjEhsxfeJQD8xBB+YjwOyYyIAJ8Ygk9MuDsl4wMAnxiCT0xdOJFnAEAxBKCYAFDwQRoDAIohAMUUrp43gJ8Ywk9s6ep5C/iJJfzEBn5iIIKygJ9Ywk/sbXBCOKZbQFAsISg2pPVCHYEF/MQSfmJvC7E1FvATS/iJ7a+ehx2BBfzEEn5i+6vnYUdgAT+xhJ/Y/up52BFYwE8s4Sc28BN8lskCfmIJP7H5cygW0BNL6Imt8tuFFsATS+CJ9SwE311vATuxhJ3YqrBpbQE7sYSd2MBOcEdgATuxhJ3YqpAyxAJ2Ygk7sYGd4NNkFrATS9iJDewEnyazgJ1Ywk6sRyEKp9+1gJ1Ywk5sYCf4PJYF7MQSdmI9C1H4PJYF8MQSeGI9C1H4PJYF8MQSeGI9DVH4PJQF+MQSfGI9DVH4PJQF+MQSfGIDPsF3hVqATyzBJ9bTEIVPRFmATyzBJ9bTEIUPJFmATyzBJzbgk8yQAvCJJfjEeh6icAJgCwCKJQDFBoCCEwBbAFAsAShWBE/EbQEAFEsAipXBE3FbAATFEoJiA0HBJ5osICiWEBTrkYjCJ5osYCiWMBTroYjCJ5osoCiWUBTrsYhyuC0AjmIJR7GysFS2gKNYwlGs5yIKnyiyAKRYAlJsuI0eTs8s4CiWcBQbOEpmegY4iiUcxfZHUeAZAgtAiiUgxYbb6CWM+bQApFgCUqzK8mQLMIolGMWq0tAMMIolGMWqAk+2gKNYwlGsKvBkC0iKJSTFqgJPtoCkWEJSbCAp+FyaBSTFEpJi8wdRLOAolnAUGw6i4EMQFoAUS0CKVfmUDRZwFEs4ig0HUXDMqQUcxRKOYvuDKNiLAEexhKPYwFFwJm8LOIolHMWGy+hx5K8FHMUSjmIDR8GpwC3gKJZwFFvgKBZwFEs4itWFHRsLSIolJMWGgyiZrgSQFEtIig25vGBXAkCKJSDF6kJUgwUgxRKQYsNd9JmuBIAUS0CKDXfRZ7oSAFIsASk2ZPLKdCUApFgCUmwAKfh4pwUgxRKQYk025NUCjGIJRrGeimRWaoCiWEJRrMmfALAAolgCUWwpkZcFFMUSimJLx1AsoCiWUBTbJ/LKCABeSCiK7RN54Z4EUBRLKIoNFAWf0LWAolhCUWxI5IV7EgBRLIEoNpxDyfQkAKJYAlFsuIY+05MAiGIJRLFWZ3sSgFAsQSjWFjYOLUAoliAUawuH5S1AKJYgFGsLh+UtQCiWIBTbn0TBPQmAKJZAFBtOouBT1hZQFEsoig0X0cOeBDAUSxiKDVek4J4AIBRLEIr1RCTTEwGCYglBsa60bwgIiiUExfaZvHBHABCKJQjFBoSS6QgAQrEEodhwCgXfrGEBRLEEothwCqWGR9osgCiWQBQbTqHUeKkPIIolEMWGUyj4Zg0LIIolEMWGUyj4mLkFEMUSiGIDRKlh2LQFEMUSiGJDOi9IIy2gKJZQFOupiKph2LUFGMUSjGLDMZQabxkBjmIJR7HhGAq+mcMCjmIJR7Eei2h8M4cFHMUSjmI9FtH4bKcFHMUSjmJ7joJbMwAploAU57mIxqfaHAApjoAUF0AKbksOgBRHQIoLIAW3JQdAiiMgxYWjKNiTHUApjqAUF+5HgZ7sAElxhKS4cBIFe7IDJMURkuLCSRTsyQ6QFEdIirsNjgi3nBwgKY6QFHdbSCvnAElxhKS428IixQGW4ghLceEkCg6ucACmOAJTnIcjMLjCAZbiCEtxIaMXdgKAUhxBKc6TEQNDtx0gKY6QFOfBiMaHOx0gKY6QFOfBiMaHOx0gKY6QFOfBiMaHOx0gKY6QFFcFL4RLfQdIiiMkxVWhO4SrPAdIiiMkxXkwovHhTgdIiiMkxXkwovHhTgdIiiMkxXkwovHZTAdIiiMkxXkwovENNw6QFEdIihOFGBsHSIojJMV5MKLxFTkOkBRHSIoThf1rB0iKIyTFeTCi8eFGB0iKIyTFeTCiK9waAUlxhKQ4D0bgQs8BjuIIR3HhIAo6SOEARXGEojh5mz9I4QBFcYSiOFllD1I4AFEcgSjOM5HMOQgHIIojEMWFfF7wHIQDDMURhuJk8EHcFwGG4ghDcSWG4gBDcYShOBl8EHdmgKE4wlCcDD6IB3UAURyBKE7mfRAgFEcQipN5HwQAxRGA4gJAwV8Q8BNH+IlTIW0IfHoAUBwBKK4HKLg+8EDCT1x/DAXXBx5I8IkL+AQCKAfoiSP0xHkYovHpYgfoiSP0xHkYovHpYgfoiSP0xKlCvKsD/MQRfuI8Dsl1w4CfOMJPnOchuW4YABRHAIrTt4U2BACKIwDFeR6C2xDAJ47gE9fn8UJtCMATR+CJC/AEd8OAnTjCTlx/EQr+AICdOMJOXGAnmX4cwBNH4IkL8CQzEgF44gg8cQGe4G4EsBNH2InzMETjI/IO0BNH6InThRWyA/TEEXriPAzR+Iy9A/TEEXriTFVoRoCeOEJPnIch2IkBO3GEnbg+jRdyYkBOHCEnLpAThRsxYCeOsBMXkngpvD4H8MQReOJMOBYKA2YdoCeO0BMX6InC3QigJ47QE2cK50IdoCeO0BNn8udCHYAnjsATZ4MT4jk5gCeOwBMXsnhlmgGAJ47AE2fzt0I5AE8cgSfOZo8mO4BOHEEnzmaPJjsAThwBJy6AE3jywQFy4gg5cTYMxnh1DsiJI+TE2WwogwPcxBFu4mzoBvHiHnATR7iJs3VhewVwE0e4iQvcJDMhA9zEEW7i8tzEAW7iCDdx4exJphcF4MQRcOJC/i6ccscBcuIIOXElcuIAOXGEnDgPQjTOE+IAOXGEnDgXvBCvSQA5cYScOA9CNE7z4QA5cYScOBf8EM9qATlxhJw4D0I0zvHgADlxhJw4D0I0TrHgADlxhJw4D0I0PmLvADlxhJw4D0I0PmLvADlxhJw4T0I0PmLvADpxBJ04T0I0PuPuADpxBJ04T0I0PuPuADpxBJ04T0I0PuPuADpxBJ24gE7wdZkOoBNH0IkL6ARfl+kAOnEEnThPQrTCngjQiSPopA7oREFPrAE6qQk6qW9D+D/0xBqgk5qgk9qTEI2vy6wBOqkJOqlvA0yGnlgDdFITdFJ7FKLxKfMasJOasJP6NgTWQE+sATupCTupPQrR+Ih1DdhJTdhJHdgJPmJdA3ZSE3ZSexSi8RHrGrCTmrCT+rawRKkBO6kJO6k9CtH4jHYN2ElN2EldZcfmGrCTmrCTOuTwwkf9awBPagJPag9DcK6BGsCTmsCTulL5VAE1gCc1gSd1OIaCUwXUAJ7UBJ7UAZ7gU+o1gCc1gSd1lZ0g1gCd1ASd1FU+W0MNyElNyEldFXKG1ICc1ISc1KKQM6QG5KQm5KQWhZwhNSAnNSEntSjkDKkBOakJOalFIWdIDchJTchJHcgJzjRQA3JSE3JSB3ICnQBwk5pwkzqcQMFOALBJTbBJHbAJTnRQA2xSE2xSew6icaKDGoCTmoCTWmQP5NUAnNQEnNQBnNRomV0DblITblJ7DiJucX3ggoSb1CF9F87TUANuUhNuUsvsyeQaYJOaYJM6JPDKPD/wP0JNag9Bcs8PHJBAkzpAE5xmogbQpCbQpJb5XhAgk5ogkzqcO8k8P3A/wkxqD0Fyzw/8j0CT2kMQfHNFDaBJTaBJ7SGIxlk2akBNakJN6kBN4PsD0KQm0KQO0AS/PwBNagJNag9BMu8PQJOaQJPaM5Dc+wP+R5hJ7RFIhalNDZhJTZhJHZgJvjqkBsykJsykDswEZympATOpCTOpAzPBOTZqwExqwkzqwExwiowaMJOaMJPaQxCN0yvUgJrUhJrUOu+EgJrUhJrUnoJonFygBthk+Nt/vXqxO3xqTm2z/e6wbX578Ydff33xj3+0Xx6bF6/+/eIfu/DH6pXX8+IP/35RvfjDv//n1Qtx2//XhP/K/u9Shv8q0f9X9f+tw391/7vu65n+/40O/7V9PevCf13/u7Phv3Wvp+7/v7qVwz/6GlV1O/xDDP8YCotq+EevrhrsrtRQSw0/DaZWevjLYFxlh784NbyOXrsQw19Er1QMkoXuy6hBjhqeSg9P0V3bGP6hhp9sX71LKd7/o//JDCq6bBvhrQ3V7VC9O5XRv9BqeJP9T274S7c26f8xvOXh/XSzhfCP4cN240f4x/CJO2f8w7//539eDR4X/jz4mv+tc77NXbs7Hs6xX1kTOVal2GI+NW1z2Bzauw/N3cdTc37at4m7VjaSG1xoWm5zFtrctadYUndn60VSdyvrLEnb5u705bFNBUZtSdXMRx4ENgcg8DYWyHzW/f3xtGs/PMSSXB29NCkGhxy8rhpaqu1dwgW3YSjbHz9v9vvwye43bdq1iNv4W1m+yKfDtnm/OzTbdnOfeJWTkUTBfCOPj81hmzpRLKV/ZMV85PNdc9juDvexwC7O8CKxiyRkSWrb5txuupaTGqfjt8b0y2dZ5939oTklb627aeTZ1U3fP+tZsolIGbtUd/kfS9JT+6E5tLs76ihV3Fk4Zp8TCds257vT7rE9nu5224fd+WHT3n1INLhIg3D1bA3//Hx+2J3P5LtXTsdi3Vyxu+Ph4Xhq2g+bw/HQdF9u0z6dmsOxPT89Ph67sTtVF3V+omZ+vqf2wzHp+boTS89ihl5AmWEMGwZmfRmExNBBuGEQuh0GdTWMT6YfzKxlNnRv1+6/Rw1AqMi6Yai8jOXDP6yZryX8z+HYHj8fmvSVOBe/WWZXEMs+HNv70+bQNtv2CF553FxEzffwTn7SVrocSxdJXRalWZLCP7bNvqGddXdH43ODVszRa5CLJHYn+yI3qwaHGfxED/MYO1OZ/3r4GeIhXfE6pXebc2PU02nfHt99aZu0l1NRg1OaZ2ck8Pjun81dOqYrF0tkmrg/3n08t8dT8rQ6Hijc0FKc4nVu7552++2/nprTl+PjaPKm45G7i6RjS2w3915G+h67JCzPTit4/aT/Gu3x8jrT11jHr5FpYC9wd787tOnwHU0rusMgM6SBT6zjeaCe9bDn9kSGGKnjSaDm2Xa3S8cNEXX4FbP3uds3m7QPi+cl/RxCiH76JGQ/enQ53Pvl3bC+G1q8G1p8F8/DM+F4TruUeEI5LEuHYasaBqveompYtw0TXjEsj7pU/cEQcTF2+Ice5oPmsjzlNfu74za1NZ6rCsdz0bvjw+Pm1JDv193KcxHV3bszQ9RDcz5v7pt299BNEB8eE7ki6i8Nc9rayX1qqYmViGfmzLXKs6ju5d1lpz11PJDMlv3wtG93HzbnD3n5VSyf+7m9/O3m/vHd3W77/nR8GA0flYibTD3r/caCz+2p2TykkuMZc831iMN2N+rrO8Lz7ATDzkiX/LvfOLjsF3Bf/OH9Ll0dVSoeqMzQLQz7QIY33QqCn9JBUMbWK+ZIdXc8nNvT010Lhqouy1I0hxhmt5LZYw2SPzZfts1p98nPDR837Yd0Dhe1Z1vxRoi86KduWbLdtJv3x9PDpj2f7z40D+mk0d7GCq99Fq/w8XRsj3fH/d3x0Da/tUipiAd99kfmKO3+gDRWsUbe+mhCo9eyge9UxsqYg+qgjCwPRLwj4YbtzmE3UAzLHzGs0cSwRhOub55qGPdU3ZfRdf8XM+z9mWFz01xGQndx8GFBVw8j4bDv6YbVnxu2Dt1Q2A17kV2YeD9aDv3GLdvLOvcho0ncY1TDhnHNb97dvvf73b5NV3ldJr7nTybZ/tFJ63aikEQXOwHzkU/NaKcsXh7eDrvK9vJth3+4Ycd4mICZYbfeuP4vdqhuh5mRHXbkuwwsfAMz+1MyfmTNbWRBYm7Jr+L1hmFOwIPMLdyQq3S8ntdzHnvbbSYhifEnYi4Fe4m77ak5H/dP3WOPt7R1vCSsZz18NzlIv028iK/migIrwe6m7WjrcI6D++2QRJaOZxp2jucc378/Ny2cxOp4N9dxhxkv9dT866k5ExujQcvMet5T8+l4N3ZtreKHnmPeZT8wbSpV3FSYc4eLPNJ9xQsqzdz2ioURX4n3hJnbk4k09MAy7rT1rO+b8Zd4b4Pbfz2dzumQrXTsJ/0ANXTTljfV7+Zs6dwzftSh19aWN7fopNFV2W1MywZeqJm7CM9TylRmDJMuCHNYLmvmGBPNVxPp8axKMPuITtaZ7JNWty5+9P7LCHH5xzBLYm7QeB10Cy5ePvdyK94c5SLuvmkB5YxXNULMFLlvPjX71OXj/S3BG7su4h6foIUxQ2AuDYPI0VpWxRv+w46MYG7fbjdt0w+zac8WtaQhRuBCvjSvX+9kN7897k5kN1PFsxXdt4Ca2ZVsh6GRGCyjpmoUu4U2j0/v9rvzByIt+jpDbEJlhgCEYamgmaimU3M+nlIHkDFRGzbjBDNgYPsu3W6OzHWG+R6bbtPocb/ZHcIe7OPmy/64SV9D3P9pJp8DaL/Lhx+tn5lvrUPYOzofMHGPPECR7pav8A/mJtFAP9KnjZ3eDGtGMyzN6gF118xB9KJkNJPr0tVFH18PfjX8Y4gjsMN2kh3GCcvcCO10kzVS/HRiCPcRQ8yKujyvvMQXDVu5Q5SPM1wP6JQ3n5pDe373hY6p8dL0sg5m9qnZLaHKxCSZuSP2LG68PVHFnFCYy7qR27hOu0/NplsF+abV9TF3fYjK7nj42HxJe8R4cWSYAD/o2D76Z2j++fljan48vnAnLInEj82XVGLcYZk5Nn5svvi9oA8ft+/TyUrskmaOkTkb43Z1ie/iDq9E8ng/Ot4GFIbbEr1U7wEjc+M1seF2XTiCJt4jZsaLDWEfdMkV905m2GY2wzhYD+FO9UCIau4M6xJmksQrJDEgfTu7hBxe4gqZU46m3eySyVsVw5+K232mfZaObXSW2Qvutg9N++G4zXOTuI1yR66dlzfinFUdT3mZRCMI+7TZky463sMXNbNdxrs07ze7PX3Y+DPX7FfoZX5Kl93xa+PJeXrch0AnPIPWcVyQZnbxn9OwszhgUzCZ5/bzYYx7oj6GbYnfF6eTDBf3Vo45JHaxIScafBO/cMd+NC9ojHVj32IGNW4/H3aHtjm939w1vm686I8n/kqxX1nfNqm0eOavmGuo5m7XnM/N3aPQ5mOVhqDGE+hb3jdIxcFI2RjaMdt6KhWGy8aPzuyOmq3Quqp3B9+J0ElIHE8kal4P3jzsUrMiL5YD+2RuEDWHzv22dJ8o3qOcJSkNgFbR0ynmHvnzHDAWFW87V8PwWg1B6IoZcfIsGwYxy3iKrLhf4yJzd3h8Iv4Sg4zbYU08LMU0s8d51vB4Oj42pzaZIsVxhRWTOPUSz18eHpr2RObd6X5hvH0reX1R86+nzX5MsnT0cplzlVFHG+/vM+Mz/SKrazJdgPFoYNNxVIlj7gaORXYRn48NGBjqqHeTzCMAXvx+d24bspkuok8tmR7vZR2T4TOOlOunp7Nkgd2/qJ07yRv+wuI3HafiyEVmtHwQ4/cPEvg3xGh3i7VA9NPvEr9K7qjjVT02Jx+n3S2Jj+lJp+4g5jNnkzP88+zjJNOovLgvMsy+81lW8jLQZLOOX8AMZwri+6CvdK0W79rPFQjIoIxfp2KCrUjkqXncp6vJ5GTPDHHnp3fduuxdOhGKCbBiLnmIvImvJOJjFfJ2jhNcVOAlZRWPGjOa/7Pc8L++93s67B4e901XmtpfxfbP6RgueoCnxX22YM5OUqHQ2+KAX+YqmIgdeZxIpnczRI4GqmhN0G/azOpng4WjaZWMvw/Tvt+au6e2eTrsuw/zbrRmV7cJGWD67G8tPUEVxyyIy7SWuQXW/NaeNnct2aRQMbHTzDM675v27gOINIjJHJNIelF+x36zPzV3x9P2/Pm0IycM4qBezfRuMNmKz3AMdGo4RyuGU652oCr2coSW+cGCxt3hbv+0bc4XQtQ/VfKm4rWxlUvEPx3KCuJJIbNVBAWJnBgRDQdxlb0cQebN3Wi8TNypMPcFcKBvPB0QijfY+Iib0emBKnZdwTzMcd/NRTf7f34+f2pOu/e75nTftJct28OxfX98OpC+X8R9P8+Rx2r6dTMM3BDxqQrJjFoPKgqhYjqGr465CoRSodE6pkw1c0kwiN/uth+bL4/N6Xw8pAv2+LhKzQzaGaRmpqA63jdyzE2UVCacOOl4nu+Ym6eD3M6nc31nlyMwEsyb1A6CfRc/DpzU8e6KY44Zg8zuW212aVRPvPKwQzyPm+m8veDT5nMqO44+nfnB+nnW+b5JYwdl3IMxd6UHmchRRexUzGnWRV6/lOv3Ky7DAfCEmPczw86oljM8D6DjVbhjbs+ORI8bWxyg65iBBIPY/jWMkbaOYygcc8eSSAX9QkzSmKdliNBMxxBDJOYxGSIYuEIcvckcxr3Q3R1YeyR76TO+0kXYaI0gk2hnpkQSKhVzjCFeW6nLYbRh9jwkLHHMvdj7ps2czY/n+Mxwr07Y6Niyirf/LTO07b5pR+fXYiDLnmy0d0+nU3PIhP3GYYiOuUi+75KLtKcvqXkyRl96gMKaucXVyRxtllXxgcvLOUj2Z+1XIWD5EW/4Ms+c3DftR7rSis84Ofb3ODSfm3MLmp2KZ+eGefLjvmmP+21OYBwqzgxa6ea8m85h+jMlfoL9Hh4wUTGxsMx13GVOTTCRjvdRLHsQbmFMhY43lSx7+tWi4O44opC5vXORNFqcxycLuBOD0+Zd2hPGa5vLIVxm4Mh4FzmEUfoATbK4ifxbMk9UZMSDrB8ifheSO5vH4g/H9kvThsRHiY74VINkxsNkdHQHEz7SN2TiR2A22JH4C9RGOVdEHHwpuW14jAo858YKYkzATFk0VvCcueN9t112IHtJIh5oZMXscwtaUH4QER9KkBVzoPDy0n4znlEa5nk5L4cM/PFczzDDCLyc0VnXeOlrmE39w+YcTfNTjKPiYBfDDFT5sB2FrsUhM0yA46WkMZz9Bkj6LeOtFeapejIjiSMZhgN+Q8TrJdHBkIDPMPNfBOEJGYwXS/JylpPXVL2Q/vnD+ZguRhxBcBGnjpBMtjMW/2mzf2po/kIRx+NKJtmKZcdG7w4PzcPxRIyPu0rmRNPX7YcO/+/Nu32DX03cSTKPEPTTw75n+dTQ48RxWEA1pOHQzHl3du6ZEE+mqH54SNlm1PCGw8LDEQXVr4Wq4fBTLYfjFcN0oZaX48C8Vrs7x3kF09DKmLMNJ6mrIclVxdyZ2J2bxy78+rTZf2y+dPkbTl2kUtqi43BsxZzW7c7ZjxEn1NHVJbMkb3TanbuZfNrhx1m3DHMs3Z27CTyREw8czNFyd85tD6g4aNty+9Kzn8Ju330ppLuKE8LpYeVtmCPvs4Z8Lqo4V5uWl6P4vPFqdz63m1N7/rxrP6BT5/FbETxn+udnclgzJllM+PHPz+fcsRs4ECYRMTyfGuDCl8v2/NPhEn18d/qUKogJA3N7gsZQxTHsmrnRm0wDwNmLOPOFYB4i/th8wcF1cXaaignQEmHjyLf43IJmLmDGItNNp/hsgWauuT42X+hOUbx1Ney/m0vK4AGNOmaI2sfmy0O3+7jb7FM18Qtg7pEiXBA7oK6HjTxmYs39joSKqoRaD6McS9bD5rC573bcz08P3Vyj3ZzTUNZ4Gi6YwQQPm2S66JLsW2wRw+lcn9m1W/68a/q41jTkJT5LwzxChHaA43H2kqSynzoPQZ5qOAmqhhhVPaQlMkMZM0xOzJDK2Q6pnO0wBbfDmRLLDMPtDSb7o3HCODvsFvJa5bPAtHePuZhhJtzrZfndzDTyL3qlvLbSi/JbmWEGT4eGeFHN3MgcGFhqWxwXxJz/ZGCaitmRYS5TIlloHzOWyGwxzwJRPo4YRBnmuaVI5IhvxP0CM8CWivNb6ukeZjxpmyWTnDKO0QkzWeYgqRgJGk1Sa2as7iB3lIYzsrDvMBZIBFG7SWzKvGfvJCLnifcVDPOoySAzE6OWZI9bLPHD5rDdk3DqJDZ7jmDIi+K0KUNCq+FkdHV7Oa53OSs/pN4a0u4rexkyLsfoh0O1w09mWKyaIaG/vcRyDdFddhh6LHuM6/Y/0x3JmCf204ThUQasWA1ZD+phcVMPWbvqIdllzTy2/LBLT3vEBxK53eTusHvY7M/7piEYL96CYgo7dHlD9rv/bsDSKD5aZC9Jh5kdZVjRoETA8ZEbxUwfcTx0eYvGwX8x9Oc5dnd6IVkSRB+gd7Bh904Myd7E8N3Fs3teErldjsgP/xhOz7shN4RjRk2OUmnL+ICcZobVeimXFR/I5CDjTOua2R+kUseETManczRzafXYZTgep3mKt0+G6SZz++NZ4jjNUHynBJO6JQyU7CvH4U2aOaAGeTSxUHycgLl9/rg5kXS+IolzH3pacwnvHHraIc+CGXa6zJCY0wy5HcywfWcGOXZoEnYoY5mZlLyhowS3cd4H5qpsEFRMbyvi/lwyz/oPkieT24p44JPMYBAvHWZHizOMMLNpPE/ELgloA/kex3bGZzZqZvwOEJ/mMo+bUK1509FnoePYcpk0daZHpfJGBzrj91ozN7KITNLSY0qmhhhzNdyxpIdEombIMWqHMBU7+7MiR0n6Q2a2xJHE8Wu6jV8TbxCIpQ4J+saCo+G95jaS0gJDxvJ4m2GRPHQoTiW7Q8z8JUBmlJxxiPbrzO9hFdIs4ugeyQyWyWruvy1bd7zFy5zGAd1+EyJJ0jj80m7uYXBBcpxTzu02RopDHuGnQ/PbY3N3iY1NNcYkc7nTPGs8PjaXacDj6fhh927X+hOXHYbcNeR8RcxomTtGU9rJh203aRxNssRjzummVA5/xN80RrnMqSmMko5DbJknnXGeIxWjcT1MXcywIHXMAz/PwsHiRcVpDOyQFdoxDyw+5xMCIWbxgG3mvYiLwKeD37DuNoSf7hp49F/Eu16Sub1S1jNCDyJJ1MA8CTXW8cyqnk4kpCs5zsddbVwUtEfqOnGWG8sMnX48He+a8xkdEI6RsmAemH3uVdIpVzxOM8NJUO9vkoVuvyyoxCVI4BKqe9nQGKIFmBtmg9L0mqi7PmCrJxbpR4zHQua9ZwUtp6d9c4YHtOJdd8k8rQ4VXZIHnY77Lg5/97hrSIhbHDYvmfuCUNfucHc8nZo7vPwUcQyJlGwXK+jBOWpFPEeXzMQYZUXxzQOpqnhMYYK1jKoQj+QnCqmKeCrCDEsvqRjFUMUQRXKXNEiBH3J3h/ve1Y6nLfTteFtfMpFSRt9vHVpEwQfxQT7J3OjEOnaHrI64M7imy+knSrjVxFvskhl6VdLi+5wUfYl4vSaZ2Wehjq7b7L5+Kj1uI8wzrVB62IvqzrZPN8w4Q7fkbibklQ6OHF0ecx9c/O7DZkduMIz705njX6q6/yNuRXG3wN3YQFr8GbIu1Oj41I6/Xdw3ME9AQS2d5MED4SgUr+4l8wwU1NTd1ZHvTeO9Fsndmkgvu0nnTcl9lfM+QyZHcLwtysz+kmsGVRznVQ3ESwz3VOtL+uqZjb64+xG9kZq7lOzlUv+r4rmJqC4p7IeNLDfcKj48iB3SXFvmwaaL5nG3GH/aihkUeQlcT6NS4lv8LpvXzBRj5SOvKp5tG2Yk31gkzkQTx18yjywD0cMMdNNFKu8OaACKd+Akl0zkNXVulFEUj6bMyPmxor57CZP4cLK370DHh9RFvBcrmZB8QmXfkR7fp4riIY95scGEouP7zEIoxpiSSUQndD09dts4hfcYD3jMHNlZlZcx6Pg+aE9VxaMed7M1qyq44f/f2dWsuW3DwHfJuYelSMlyX6VfD46teN14pa0spdlD3r2ffkAP+KMd5biHBWRRBEFgZrBkC1HyXSmByH3HXuQqHINRYCy2pI521vp0sMYHKjZYbPW78SdRksCer2ELopHhFBAGH7kipShiy3PelNkeKEZqSdpT7GG9QzWPKdu8NO/Da/Pz3DSX0BnGNFLXO+GsuzeXbi5HND9v0+iv6+1HE0nVF0hlsKTkU+xtbJ/To7V5DGJsMyqr3OBwISqSnKvNxRAOhDgYtl2kbKa+dmyp78yasip9Dt/mgYR6a6sRZBCZDYatoiuT+bXHQ4UETPruwse7rnvjKCFDclzf+7ENEJxYPGfvP5n+Nn6LR/aGk6KcO2S9lUKfqgTvVJPYMm872TVQirDkaZuitFtciJIFxYilUKsBCQJsSi62EjV0hIsJsq9m71yp0TvIgzAvwimTfnspNM6SZK56H+k5h5g8FGzaLCYzkw7xcCzYDHkMBsQolp+0tfzcUAFK1qT5WIAVC1bOz3h4cli5tzvbTch3YOQQmQKyLpqLxHhGk82aNfxOs7cijDWWmMhDsj+1l4R4XYmv8kh2BRdb569d/3g9FWUVMhqw+HYktScWmzddFSqxdngkOayLpSfyL5o2UWLl9kgqDK9WE8bU0nKfyWIsLW2Da3skKWn9qb0254k/2YenDiJs6Ye7JsC1eI8lSxd9o3GcBn9bIfHASQOvJpPXZAHRoOyH8ehssvS7pNrhHGIMBIKiKktBd+8yHRSEDMYvDxcnd8piUNNblzFd08ymy5y+N21GlwOlDyzJ+djwOKEQk27wtk7WRTfcPNUz2osG9qa94wWexH1ueJ9uefl5aAUe+pZETntZuJlU2XbSO3sSLSdFkrDoj9RNS+YQWQE6hxeZA9lkVtY+k8jGdM2SJDnlIHFROipxrd+wmbonYa3hQDbZvFE9d2sTBIJv3JL6hKufWFQmBahNQzIKFLyyJLpjl9+pHBIJMSFR3ZKc3azXZfGUMExy6yOQxZIMi6zTJZ3rvSIi4R7jHn1MZtxrEF/aH0Y69oDf9Nd2Q+LIKpD/a0lg2rajTbAeEoIt2dbg3E0VrbRLjFZk+2jbZaJcioLYluR0rE6kWt6eZ46fliForm9BQlRgULMko3h1pYQt6NQCiyWWlOPNO8xlFliAsuRdKu9lZ2KBnCFLlkXyzj/JK2rc22SdenW22aDFCwYJKBKzuhMeymBsAllQl8iSqguB22nrZnwm4eNHNUJhVxCJag4G8cqGLCWjsaWltdyrfBFmojynsEVYNLMktBadLW484GI5nDPYb8yoLKlDjL5SSRrenPZllrkKikH4YEFKjKDNmdbEvn7M08g52egrqpojWteQkMTIYFQGwiKtIRGVq9Xwau4wrB7IAhrY+uwqgC/AkgpYYD71jWHHhIRegsXkNQD138lmLJiMVx1DBol0VPaGsW+bheb3HiCzcItZEpzhaTdTWvLIRNJE0oK/w5FjEbbExB2ebId91YFPhichx9WQwM/QMjU+Cfee3XcceEe7ojQmV+Tki9BfahchyJ4EK4ZmU1sJT/vDvmtYfmSTQXlkQ4IeV6vbehMGVZwN2ejLzgnC46PcV9WbjS3C7l5k99rfho/n555LjHEpHVuI/sTrejiunPyUhqXFNXFsA+ETt29d3wyvp7Zrm/R0Gdzmjq3go9Pt48ri5+DYDgbYX5K9iZ9waucJrjNbexhP9/tH8/N8Hx+B5LNFpKZjy/5Jj+fpjngR4S3xOg9sir1iI21fUgVe5eSINRZelJbtrtwS7Hucb3tRt/jtn4aSpST2AV3LqiW2mkUBBEeCC0Lb8+IkjeNpS/KclfH0VEFcCrMvwZvNPscnjO2MXG4usZS1RUUXR3boAy8oe5qCvlvU5HYkogB93N7exgE1ec+vU8tLO0FNbkcqg6KTFMlODYYQXbpyX/6zGF823PQZ3dr3vvlx60bdYUJXjpROzXiIBx5aBKA4UnY5YR0mXOd+BkZFUhoh4ShVHbBIvnWk+FDCdpwvWxSNdqRWYspyHE9RutL9RmaRGq6J2X25r/mx2JwKW6f2skgsJ0Ma6lw7UucaXcxJgK6gje33tvuvTYQgFJ51pPBsxtmGE4xBpIQhOpnAtDo2YGr7GyFhOF1/TBLp2ihmtfs6k7NRIdf7xAySteRCo5qNI9VsNh1udj8syts4EorJuWu74dYuG3BTmQrVMRypjrH5BNMfay6X/skYEUlJjE2HT13fXLaDggeORGJvuhS0RQ4JalGOwpFo2L65Ts0JnfQgEqnwCmgkTH0VKwlUD9BkRWLqV0uB3DHC5CrPYqfPi9lkPHEDRRl2/NCwe1siCeJI0jbFUBjdsLVm6GgJasaR8CbCmhYDBakhEtuN5TcxrtQklaZvhv7j3I0BLKlUo2vZ9fA6NeHyIk2yYvFSAasOW+SGzQ27bojwuAZhjQVJA4rzJYNXNeMxsmQVZq1mKoOIdyjIc2+xs8aqrj9dFpDD6S63hDTXw6KsjCMB8YGvqQARVDgstpsc+WkHZpc/k1co1DdypL5RYH1sp8A+np6iQtk3hLkSqd8ST/5B0GZVik63AP2OgtQ9kuHl0Zzfi7L6bnTZEsW4SYCOt7RMW466SRa1ZRypLbMa7dXjlXiHr8lCvLeUfTxMokhlmsdrN959Mcaf4rrIr4TNyVW5XRV81eKClCJYWtVC9z3KkS76MDVZD5iTOi2xhporFdkXh7uCfmwkKpDNqcQlR9tEIgWp07KVuxr8wYWQFZwwqF0tBQoRjK1k9Hp1lPf/InrGHsQq4ftAwsziS67BD7IQ2f1CJAqdqDM7Uct3QgN3tRAt/NyjyldZ/I/wEv9CTJD/qmSGw+HFQ3KFYO4809yr/3tNZxFRPHhxZ/kYRT+6JhFMIYET0WSGLH8kVJYVcpsMal0/XG6TxEYoT6DU02XTkUEtMyKsUpIBnKnhNAS1IhzlQr7uGc0/dF9Pj6ZyY6/rQ8gVdyRx21uMNaTxEkXSlxepkSAzQFCtIUv2yS6sklWT3S8Ha02iprGvFo9PxtSIe9Lo5oAVDBmfbCovYCH7nEQXR5NRMJ8uSJLPUuiK4jO8zfUxSXTasKqdruOydaWpxPyyJmGJE7NEhwA0QgaSyUgXMLtQPqUgEQ2e5pJA2lg17JCEcw+dCh6wguzrifenwd1ekFXQofvnoaOjQe2xQk5Hd5C536JTXcrc76rwytVysLzIeeIn2MjnfiBB1EO3aNnrH4hPxu7GiFWL25HsUo732+XbLP6h54RgUbgmQWJjOw+FTU9rd5g4VOStZuxv+pqB1DoSAzT2d9BqkgEFU41Bf+t4BJAgsLTp4IKlZ/SQb7K/+/th/okxgJNpbMpw+LxY3iNxa1JEBPjz1OWeSaxDNJk1rmI6BGUcyFqxONUg3b751syq+Ke7L2nqmw+CX8jvUFxNESUukThsKVUkykJMBoxsh5eTgyS/NYmiEKPrJky+AIOshIJE/2itZF30wpIrmZh4c8ADjZMph2WWijwYxXRipigm7AUZrb25JB0UG7k1WduIGkEoPUAC85c5jPq7QYjo0d9xuDN3sdf8O57ut+Gj+xY24QO8m8XEryQ7ScHsSPXwmAGVZGUnRnZh8d8xcLm///jyfntv7re2+fLnX3//+vU/oQTdB22bAwA="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 000000000..d0c980d41 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1438 @@ +: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-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --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-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --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-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --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-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --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-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --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-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +*:focus-visible, +.tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +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; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +footer > p { + margin: 0 1em; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} +a.tsd-anchor-link { + color: var(--color-text); +} + +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: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + 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-visible + svg { + outline: 2px solid var(--color-focus-outline); +} +.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); +} + +.settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; +} + +.tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; +} + +.tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-navigation .tsd-nav-link { + display: none; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + 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-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: 2rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} +.tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; +} +.tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; +} +.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%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/classes/AllowAllTenantGate.html b/classes/AllowAllTenantGate.html new file mode 100644 index 000000000..ed95618ba --- /dev/null +++ b/classes/AllowAllTenantGate.html @@ -0,0 +1,5 @@ +AllowAllTenantGate | DWN-SDK Documentation - v0.3.10

Class AllowAllTenantGate

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

+

Implements

Constructors

constructor +

Methods

isActiveTenant +

Constructors

constructor

Methods

isActiveTenant

Settings

Member Visibility

On This Page

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

Class Cid

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

+

Constructors

constructor +

Methods

computeCid +computeDagPbCidFromBytes +computeDagPbCidFromStream +parseCid +

Constructors

constructor

Methods

StaticcomputeCid

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

  • Computes a V1 CID for the provided payload

    +

    Parameters

    • payload: any
    • codecCode: number = cbor.code

      the codec to use. Defaults to cbor

      +
    • multihashCode: number = sha256.code

      the multihasher to use. Defaults to sha256

      +

    Returns Promise<string>

    payload CID

    +

    Throws

    codec is not supported

    +

    Throws

    encoding fails

    +

    Throws

    if hasher is not supported

    +

StaticcomputeDagPbCidFromBytes

  • computeDagPbCidFromBytes(content): Promise<string>

  • Parameters

    • content: Uint8Array

    Returns Promise<string>

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

    +

StaticcomputeDagPbCidFromStream

  • computeDagPbCidFromStream(dataStream): Promise<string>

  • Parameters

    • dataStream: Readable

    Returns Promise<string>

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

    +

StaticparseCid

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

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

    +

    Parameters

    • str: string

    Returns CID<unknown, number, number, Version>

Settings

Member Visibility

On This Page

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

Class DataStoreLevel

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

+

It has the following structure (+ represents an additional sublevel/partition): +'data' + + + ->

+

Implements

Constructors

constructor +

Properties

blockstore +config +

Methods

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

Constructors

constructor

Properties

blockstore

blockstore: BlockstoreLevel

config

config: DataStoreLevelConfig

Methods

clear

close

delete

  • delete(tenant, recordId, dataCid): Promise<void>

  • Deletes the specified data. No-op if the data does not exist.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<void>

get

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

  • Fetches the specified data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<undefined | DataStoreGetResult>

    the data size and data stream if found, otherwise undefined.

    +

open

put

Settings

Member Visibility

On This Page

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

Class DataStream

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

+

Constructors

constructor +

Methods

duplicateDataStream +fromBytes +fromObject +toBytes +toObject +

Constructors

constructor

Methods

StaticduplicateDataStream

  • duplicateDataStream(dataStream, count): Readable[]

  • Duplicates the given data stream into the number of streams specified so that multiple handlers can consume the same data stream.

    +

    Parameters

    • dataStream: Readable
    • count: number

    Returns Readable[]

StaticfromBytes

  • fromBytes(bytes): Readable

  • Creates a readable stream from the bytes given.

    +

    Parameters

    • bytes: Uint8Array

    Returns Readable

StaticfromObject

  • fromObject(object): Readable

  • Creates a readable stream from the object given.

    +

    Parameters

    • object: Record<string, any>

    Returns Readable

StatictoBytes

  • toBytes(readableStream): Promise<Uint8Array>

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

    +

    Parameters

    • readableStream: Readable

    Returns Promise<Uint8Array>

StatictoObject

  • toObject(readableStream): Promise<object>

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

    +

    Parameters

    • readableStream: Readable

    Returns Promise<object>

Settings

Member Visibility

On This Page

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

Class Dwn

Methods

close +open +processMessage +validateMessageIntegrity +validateTenant +create +

Methods

close

open

  • open(): Promise<void>

  • Initializes the DWN instance and opens the connection to it.

    +

    Returns Promise<void>

processMessage

validateMessageIntegrity

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

  • Validates structure of DWN message

    +

    Parameters

    • rawMessage: any

    Returns Promise<undefined | GenericMessageReply>

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

    +

validateTenant

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

  • Checks tenant gate to see if tenant is allowed.

    +

    Parameters

    • tenant: string

      The tenant DID to route the given message to.

      +

    Returns Promise<undefined | GenericMessageReply>

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

    +

Staticcreate

Settings

Member Visibility

On This Page

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

Class DwnConstant

Constructors

constructor +

Properties

maxDataSizeAllowedToBeEncoded +

Constructors

constructor

Properties

Static ReadonlymaxDataSizeAllowedToBeEncoded

maxDataSizeAllowedToBeEncoded: 30000 = 30_000

The maximum size of raw data that will be returned as encodedData.

+

We chose 30k, as after encoding it would give plenty of headroom up to the 65k limit in most SQL variants. +We currently encode using base64url which is a 33% increase in size.

+

Settings

Member Visibility

On This Page

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

Class DwnError

A class that represents a DWN error.

+

Hierarchy

  • Error
    • DwnError

Constructors

constructor +

Properties

code +

Constructors

constructor

Properties

code

code: string

Settings

Member Visibility

On This Page

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

Class Encoder

Utility class for encoding/converting data into various formats.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

Staticbase64UrlToBytes

  • base64UrlToBytes(base64urlString): Uint8Array

  • Parameters

    • base64urlString: string

    Returns Uint8Array

Staticbase64UrlToObject

  • base64UrlToObject(base64urlString): any

  • Parameters

    • base64urlString: string

    Returns any

StaticbytesToBase64Url

StaticbytesToObject

StaticbytesToString

StaticobjectToBytes

  • objectToBytes(obj): Uint8Array

  • Parameters

    • obj: Record<string, any>

    Returns Uint8Array

StaticstringToBase64Url

StaticstringToBytes

Settings

Member Visibility

On This Page

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

Class Encryption

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

+

Constructors

constructor +

Accessors

isEphemeralKeyCompressed +

Methods

aes256CtrDecrypt +aes256CtrEncrypt +eciesSecp256k1Decrypt +eciesSecp256k1Encrypt +

Constructors

constructor

Accessors

StaticisEphemeralKeyCompressed

Methods

Staticaes256CtrDecrypt

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

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

    +

    Parameters

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

    Returns Promise<Readable>

Staticaes256CtrEncrypt

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

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

    +

    Parameters

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

    Returns Promise<Readable>

StaticeciesSecp256k1Decrypt

  • eciesSecp256k1Decrypt(input): Promise<Uint8Array>

  • Decrypt the given plaintext using ECIES (Elliptic Curve Integrated Encryption Scheme) +with SECP256K1 for the asymmetric calculations, HKDF as the key-derivation function, +and AES-GCM for the symmetric encryption and MAC algorithms.

    +

    Parameters

    • input: EciesEncryptionInput

    Returns Promise<Uint8Array>

StaticeciesSecp256k1Encrypt

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

  • Encrypts the given plaintext using ECIES (Elliptic Curve Integrated Encryption Scheme) +with SECP256K1 for the asymmetric calculations, HKDF as the key-derivation function, +and AES-GCM for the symmetric encryption and MAC algorithms.

    +

    Parameters

    • publicKeyBytes: Uint8Array
    • plaintext: Uint8Array

    Returns Promise<EciesEncryptionOutput>

Settings

Member Visibility

On This Page

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

Class EventEmitterStream

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

+

Implements

Constructors

constructor +

Methods

close +emit +open +subscribe +

Constructors

constructor

Methods

close

emit

open

subscribe

Settings

Member Visibility

On This Page

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

Class EventLogLevel

Implements

Constructors

constructor +

Properties

index +ulidFactory +

Methods

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

Constructors

constructor

Properties

index

index: IndexLevel

ulidFactory

ulidFactory: ULIDFactory

Methods

append

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

  • adds an event to a tenant's event log

    +

    Parameters

    • tenant: string

      the tenant's DID

      +
    • messageCid: string

      the CID of the message

      +
    • indexes: KeyValues

      (key-value pairs) to be included as part of indexing this event.

      +

    Returns Promise<void>

clear

close

deleteEventsByCid

  • deleteEventsByCid(tenant, messageCids): Promise<void>

  • deletes any events that have any of the messageCids provided

    +

    Parameters

    • tenant: string
    • messageCids: string[]

    Returns Promise<void>

    the number of events deleted

    +

getEvents

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

  • Retrieves all of a tenant's events that occurred after the cursor provided. +If no cursor is provided, all events for a given tenant will be returned.

    +

    The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

    Returns Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>

open

queryEvents

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

  • retrieves a filtered set of events that occurred after a the cursor provided, accepts multiple filters.

    +

    If no cursor is provided, all events for a given tenant and filter combo will be returned. +The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

    Returns Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>

Settings

Member Visibility

On This Page

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

Class EventsQuery

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class EventsSubscribe

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class HdKey

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

+

Constructors

constructor +

Methods

deriveKeyUsingHkdf +derivePrivateKey +derivePrivateKeyBytes +derivePublicKey +

Constructors

constructor

Methods

StaticderiveKeyUsingHkdf

  • deriveKeyUsingHkdf(params): Promise<Uint8Array>

  • Derives a key using HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as defined in RFC 5869. +TODO: Consolidate HKDF implementation and usage with web5-js - https://github.com/TBD54566975/dwn-sdk-js/issues/742

    +

    Parameters

    • params: {
          hashAlgorithm: "SHA-256" | "SHA-384" | "SHA-512";
          info: Uint8Array;
          initialKeyMaterial: Uint8Array;
          keyLengthInBytes: number;
      }
      • hashAlgorithm: "SHA-256" | "SHA-384" | "SHA-512"
      • info: Uint8Array
      • initialKeyMaterial: Uint8Array
      • keyLengthInBytes: number

    Returns Promise<Uint8Array>

StaticderivePrivateKey

StaticderivePrivateKeyBytes

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

  • Derives a hardened hierarchical deterministic private key.

    +

    Parameters

    • privateKey: Uint8Array
    • relativePath: string[]

    Returns Promise<Uint8Array>

StaticderivePublicKey

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

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

    +

    Parameters

    Returns Promise<PublicJwk>

Settings

Member Visibility

On This Page

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

Class Jws

Utility class for JWS related operations.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticcreateSigner

StaticcreateSigners

StaticdecodePlainObjectPayload

  • decodePlainObjectPayload(jws): any

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

    +

    Parameters

    • jws: GeneralJws

    Returns any

StaticextractDid

  • extractDid(kid): string

  • Extracts the DID from the given kid string.

    +

    Parameters

    • kid: string

    Returns string

StaticgetKid

  • getKid(signatureEntry): string

  • Gets the kid from a general JWS signature entry.

    +

    Parameters

    • signatureEntry: SignatureEntry

    Returns string

StaticgetSignerDid

  • getSignerDid(signatureEntry): string

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

    +

    Parameters

    • signatureEntry: SignatureEntry

    Returns string

StaticverifySignature

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

  • Verifies the signature against the given payload.

    +

    Parameters

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

    Returns Promise<boolean>

    true if signature is valid; false otherwise

    +

Settings

Member Visibility

On This Page

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

Class Message

A class containing utility methods for working with DWN messages.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticcompareCid

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

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

    +

    Parameters

    Returns Promise<number>

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

    +

StaticcompareMessageTimestamp

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

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

    +

    Parameters

    Returns Promise<number>

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

    +

StaticcreateAuthorization

  • createAuthorization(input): Promise<AuthorizationModel>

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

    +

    Parameters

    • input: {
          delegatedGrant?: DataEncodedRecordsWriteMessage;
          descriptor: Descriptor;
          permissionGrantId?: string;
          protocolRole?: string;
          signer: Signer;
      }
      • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage
      • descriptor: Descriptor
      • OptionalpermissionGrantId?: string
      • OptionalprotocolRole?: string
      • signer: Signer

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    +

StaticcreateSignature

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

  • Creates a generic signature from the given DWN message descriptor by including descriptorCid as the required property in the signature payload. +NOTE: there is an opportunity to consolidate RecordsWrite.createSignerSignature() wth this method

    +

    Parameters

    • descriptor: Descriptor
    • signer: Signer
    • OptionaladditionalPayloadProperties: {
          delegatedGrantId?: string;
          permissionGrantId?: string;
          protocolRole?: string;
      }
      • OptionaldelegatedGrantId?: string
      • OptionalpermissionGrantId?: string
      • OptionalprotocolRole?: string

    Returns Promise<GeneralJws>

StaticgetCid

StaticgetNewestMessage

StaticgetOldestMessage

StaticgetSigner

  • getSigner(message): undefined | string

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

    +

    Parameters

    Returns undefined | string

StaticisNewer

StaticisOlder

StaticisSignedByAuthorDelegate

StaticisSignedByOwnerDelegate

StaticvalidateJsonSchema

  • validateJsonSchema(rawMessage): void

  • Validates the given message against the corresponding JSON schema.

    +

    Parameters

    • rawMessage: any

    Returns void

    Throws

    if fails validation.

    +

StaticvalidateSignatureStructure

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

  • Validates the structural integrity of the message signature given:

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

    Parameters

    • messageSignature: GeneralJws
    • messageDescriptor: Descriptor
    • payloadJsonSchemaKey: string = 'GenericSignaturePayload'

      The key to look up the JSON schema referenced in compile-validators.js and perform payload schema validation on.

      +

    Returns Promise<GenericSignaturePayload>

    the parsed JSON payload object if validation succeeds.

    +

Settings

Member Visibility

On This Page

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

Class MessageStoreLevel

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

+

Implements

Constructors

constructor +

Properties

blockstore +config +index +

Methods

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

Constructors

constructor

Properties

blockstore

blockstore: BlockstoreLevel

config

config: MessageStoreLevelConfig

index

index: IndexLevel

Methods

clear

close

delete

get

open

put

query

StaticbuildQueryOptions

Settings

Member Visibility

On This Page

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

Class MessagesGet

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

authormessagesignaturePayloadsignertoJSONcreateparse
\ No newline at end of file diff --git a/classes/PermissionGrant.html b/classes/PermissionGrant.html new file mode 100644 index 000000000..55a5da3d5 --- /dev/null +++ b/classes/PermissionGrant.html @@ -0,0 +1,23 @@ +PermissionGrant | DWN-SDK Documentation - v0.3.10

Class PermissionGrant

A class representing a Permission Grant for a more convenient abstraction.

+

Properties

conditions? +dateExpires +dateGranted +delegated? +description? +grantee +grantor +id +requestId? +scope +

Methods

parse +

Properties

Optional Readonlyconditions

conditions?: PermissionConditions

Optional conditions that must be met when the grant is used.

+

ReadonlydateExpires

dateExpires: string

Timestamp at which this grant will no longer be active.

+

ReadonlydateGranted

dateGranted: string

The date at which the grant was given.

+

Optional Readonlydelegated

delegated?: boolean

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

+

Optional Readonlydescription

description?: string

Optional string that communicates what the grant would be used for

+

Readonlygrantee

grantee: string

The grantee of the permission.

+

Readonlygrantor

grantor: string

The grantor of the permission.

+

Readonlyid

id: string

The ID of the permission grant, which is the record ID DWN message.

+

Optional ReadonlyrequestId

requestId?: string

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

+

Readonlyscope

scope: PermissionScope

The scope of the allowed access.

+

Methods

Staticparse

Settings

Member Visibility

On This Page

conditionsdateExpiresdateGranteddelegateddescriptiongranteegrantoridrequestIdscopeparse
\ No newline at end of file diff --git a/classes/PermissionRequest.html b/classes/PermissionRequest.html new file mode 100644 index 000000000..6ddd2aa2b --- /dev/null +++ b/classes/PermissionRequest.html @@ -0,0 +1,16 @@ +PermissionRequest | DWN-SDK Documentation - v0.3.10

Class PermissionRequest

A class representing a Permission Request for a more convenient abstraction.

+

Properties

conditions? +delegated? +description? +id +requester +scope +

Methods

parse +

Properties

Optional Readonlyconditions

conditions?: PermissionConditions

Optional conditions that must be met when the requested grant is used.

+

Optional Readonlydelegated

delegated?: boolean

Whether the requested grant is delegated or not. +If true, the requestor will be able to act as the grantor of the permission within the scope of the requested grant.

+

Optional Readonlydescription

description?: string

Optional string that communicates what the requested grant would be used for.

+

Readonlyid

id: string

The ID of the permission request, which is the record ID DWN message.

+

Readonlyrequester

requester: string

The requester for of the permission.

+

Readonlyscope

scope: PermissionScope

The scope of the allowed access.

+

Methods

Staticparse

Settings

Member Visibility

On This Page

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

Class PermissionsProtocol

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

+

Constructors

constructor +

Properties

definition +grantPath +requestPath +revocationPath +uri +

Methods

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

Constructors

constructor

Properties

Static Readonlydefinition

definition: ProtocolDefinition = ...

The definition of the Permissions protocol.

+

Static ReadonlygrantPath

grantPath: "grant" = 'grant'

The protocol path of the grant record.

+

Static ReadonlyrequestPath

requestPath: "request" = 'request'

The protocol path of the request record.

+

Static ReadonlyrevocationPath

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

The protocol path of the revocation record.

+

Static Readonlyuri

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

The URI of the DWN Permissions protocol.

+

Methods

StaticcreateGrant

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

  • Convenience method to create a permission grant.

    +

    Parameters

    • options: PermissionGrantCreateOptions

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

StaticcreateRequest

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

  • Convenience method to create a permission request.

    +

    Parameters

    • options: PermissionRequestCreateOptions

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

StaticcreateRevocation

StaticfetchGrant

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

  • Fetches PermissionGrant with the specified recordID.

    +

    Parameters

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

    Returns Promise<PermissionGrant>

    the PermissionGrant matching the recordId specified.

    +

    Throws

    if PermissionGrant does not exist

    +

StatichasProtocolScope

StaticparseRequest

StaticvalidateSchema

  • validateSchema(recordsWriteMessage, dataBytes): void

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

    +

    Parameters

    Returns void

Settings

Member Visibility

On This Page

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

Class PrivateKeySigner

A signer that signs using a private key.

+

Implements

Constructors

constructor +

Properties

algorithm +keyId +

Methods

sign +

Constructors

constructor

Properties

algorithm

algorithm: string

The name of the signature algorithm used by this signer. +This value will be used as the "alg" parameter in JWS produced. +This parameter is not used by the DWN but is unfortunately a required header property for a JWS as per: +https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.1 +Valid signature algorithm values can be found at https://www.iana.org/assignments/jose/jose.xhtml

+

keyId

keyId: string

The ID of the key used by this signer. +This needs to be a fully-qualified ID (ie. prefixed with DID) so that author can be parsed out for processing such as recordId computation. +Example: did:example:alice#key1 +This value will be used as the "kid" parameter in JWS produced. +While this property is not a required property per JWS specification, it is required for DWN authentication.

+

Methods

sign

  • sign(content): Promise<Uint8Array>

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

    +

    Parameters

    • content: Uint8Array

    Returns Promise<Uint8Array>

Settings

Member Visibility

On This Page

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

Class Protocols

Class containing Protocol related utility methods.

+

Constructors

constructor +

Methods

deriveAndInjectPublicEncryptionKeys +

Constructors

constructor

Methods

StaticderiveAndInjectPublicEncryptionKeys

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

  • Derives public encryptions keys and inject it in the $encryption property for each protocol path segment of the given Protocol definition, +then returns the final encryption-enabled protocol definition. +NOTE: The original definition passed in is unmodified.

    +

    Parameters

    Returns Promise<ProtocolDefinition>

Settings

Member Visibility

On This Page

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

Class ProtocolsConfigure

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class ProtocolsQuery

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorize +toJSON +create +normalizeFilter +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

authorize

toJSON

Staticcreate

StaticnormalizeFilter

Staticparse

Settings

Member Visibility

On This Page

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

Class Records

Class containing useful utilities related to the Records interface.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticbuildTagIndexes

  • buildTagIndexes(tags): KeyValues

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

    +

    Parameters

    Returns KeyValues

StaticconstructKeyDerivationPath

StaticconstructKeyDerivationPathUsingDataFormatsScheme

  • constructKeyDerivationPathUsingDataFormatsScheme(schema, dataFormat): string[]

  • Constructs the full key derivation path using dataFormats scheme.

    +

    Parameters

    • schema: undefined | string
    • dataFormat: string

    Returns string[]

StaticconstructKeyDerivationPathUsingProtocolContextScheme

  • constructKeyDerivationPathUsingProtocolContextScheme(contextId): string[]

  • Constructs the full key derivation path using protocolContext scheme.

    +

    Parameters

    • contextId: undefined | string

    Returns string[]

StaticconstructKeyDerivationPathUsingProtocolPathScheme

  • constructKeyDerivationPathUsingProtocolPathScheme(descriptor): string[]

  • Constructs the full key derivation path using protocolPath scheme.

    +

    Parameters

    Returns string[]

StaticconstructKeyDerivationPathUsingSchemasScheme

  • constructKeyDerivationPathUsingSchemasScheme(schema): string[]

  • Constructs the full key derivation path using schemas scheme.

    +

    Parameters

    • schema: undefined | string

    Returns string[]

StaticconvertFilter

  • convertFilter(filter, dateSort?): Filter

  • Converts an incoming RecordsFilter into a Filter usable by MessageStore.

    +

    Parameters

    • filter: RecordsFilter

      A RecordsFilter

      +
    • OptionaldateSort: DateSort

    Returns Filter

    a generic Filter able to be used with MessageStore.

    +

StaticconvertTagsFilter

  • convertTagsFilter(tags): Filter

  • This will create individual keys for each of the tag filters that look like tag.tag_filter_property

    +

    Parameters

    • tags: {
          [property: string]: RecordsWriteTagsFilter;
      }
      • [property: string]: RecordsWriteTagsFilter

    Returns Filter

Staticdecrypt

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

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

    +

    Parameters

    Returns Promise<Readable>

StaticderivePrivateKey

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

  • Derives a descendant private key given an ancestor private key and the full absolute derivation path. +NOTE: right now only ECIES-ES256K algorithm is supported for asymmetric encryption, +so we will only derive SECP256K1 key without additional conditional checks

    +

    Parameters

    Returns Promise<Uint8Array>

StaticfilterIncludesPublishedRecords

  • filterIncludesPublishedRecords(filter): boolean

  • Checks if the filter supports returning published records.

    +

    Parameters

    • filter: RecordsFilter

    Returns boolean

StaticfilterIncludesUnpublishedRecords

  • filterIncludesUnpublishedRecords(filter): boolean

  • Checks if the filter supports returning unpublished records.

    +

    Parameters

    • filter: RecordsFilter

    Returns boolean

StaticgetAuthor

StaticgetParentContextFromOfContextId

  • getParentContextFromOfContextId(contextId): undefined | string

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

    +

    Parameters

    • contextId: undefined | string

    Returns undefined | string

StaticisRecordsWrite

StaticisStartsWithFilter

  • isStartsWithFilter(filter): filter is StartsWithFilter

  • Parameters

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

    Returns filter is StartsWithFilter

StaticnormalizeFilter

  • normalizeFilter(filter): RecordsFilter

  • Normalizes the protocol and schema URLs within a provided RecordsFilter and returns a copy of RecordsFilter with the modified values.

    +

    Parameters

    • filter: RecordsFilter

      incoming RecordsFilter to normalize.

      +

    Returns RecordsFilter

    a copy of the incoming RecordsFilter with the normalized properties.

    +

StaticshouldProtocolAuthorize

  • shouldProtocolAuthorize(signaturePayload): boolean

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

    +

    Parameters

    • signaturePayload: GenericSignaturePayload

    Returns boolean

StaticvalidateAncestorKeyAndDescentKeyDerivationPathsMatch

  • validateAncestorKeyAndDescentKeyDerivationPathsMatch(ancestorKeyDerivationPath, descendantKeyDerivationPath): void

  • Validates that ancestor derivation path matches the descendant derivation path completely.

    +

    Parameters

    • ancestorKeyDerivationPath: string[]
    • descendantKeyDerivationPath: string[]

    Returns void

    Throws

    with DwnErrorCode.RecordsInvalidAncestorKeyDerivationSegment if fails validation.

    +

StaticvalidateDelegatedGrantReferentialIntegrity

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

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

    +

    Parameters

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

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

      +
    • OptionalownerSignaturePayload: GenericSignaturePayload

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

      +

    Returns Promise<void>

Settings

Member Visibility

On This Page

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

Class RecordsDelete

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +constructIndexes +toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

authorizeDelegate

constructIndexes

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class RecordsQuery

A class representing a RecordsQuery DWN message.

+

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

authorizeDelegate

  • authorizeDelegate(messageStore): Promise<void>

  • Authorizes the delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class RecordsRead

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

authorizeDelegate

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class RecordsSubscribe

A class representing a RecordsSubscribe DWN message.

+

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

authorizeDelegate

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class RecordsWrite

A class representing a RecordsWrite DWN message. +NOTE: Unable to extend AbstractMessage directly because the incompatible _message type, which is not just a generic <M> type.

+

Implements

Properties

attesters +

Accessors

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

Methods

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

Properties

Readonlyattesters

attesters: string[]

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

isSignedByAuthorDelegate

isSignedByOwnerDelegate

message

owner

  • get owner(): undefined | string

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

    +

    Returns undefined | string

ownerSignaturePayload

  • get ownerSignaturePayload(): undefined | GenericSignaturePayload

  • Decoded owner signature payload.

    +

    Returns undefined | GenericSignaturePayload

ownerSignatureSigner

  • get ownerSignatureSigner(): undefined | string

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

    +

    Returns undefined | string

signaturePayload

  • get signaturePayload(): undefined | RecordsWriteSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | RecordsWriteSignaturePayload

signer

  • get signer(): undefined | string

  • Gets the signer of this message. +This is not to be confused with the logical author of the message.

    +

    Returns undefined | string

Methods

authorizeAuthorDelegate

  • authorizeAuthorDelegate(messageStore): Promise<void>

  • Authorizes the author-delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

authorizeOwnerDelegate

  • authorizeOwnerDelegate(messageStore): Promise<void>

  • Authorizes the owner-delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

constructIndexes

encryptSymmetricEncryptionKey

  • encryptSymmetricEncryptionKey(encryptionInput): Promise<void>

  • Encrypts the symmetric encryption key using the public keys given and attach the resulting encryption property to the RecordsWrite.

    +

    Parameters

    Returns Promise<void>

getEntryId

isInitialWrite

sign

  • sign(options): Promise<void>

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

    +

    Parameters

    • options: {
          delegatedGrant?: DataEncodedRecordsWriteMessage;
          permissionGrantId?: string;
          protocolRole?: string;
          signer: Signer;
      }
      • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage
      • OptionalpermissionGrantId?: string
      • OptionalprotocolRole?: string
      • signer: Signer

    Returns Promise<void>

signAsOwner

  • signAsOwner(signer): Promise<void>

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

    +

    Parameters

    Returns Promise<void>

signAsOwnerDelegate

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

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

    +

    Parameters

    • signer: Signer
    • delegatedGrant: DataEncodedRecordsWriteMessage

    Returns Promise<void>

toJSON

Staticcreate

StaticcreateAttestation

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

  • Creates the attestation property of a RecordsWrite message if given signature inputs; returns undefined otherwise.

    +

    Parameters

    • descriptorCid: string
    • Optionalsigners: Signer[]

    Returns Promise<undefined | GeneralJws>

StaticcreateFrom

  • createFrom(options): Promise<RecordsWrite>

  • Convenience method that creates a message by:

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

    Parameters

    Returns Promise<RecordsWrite>

StaticcreateSignerSignature

  • createSignerSignature(input): Promise<GeneralJws>

  • Creates the signature property in the authorization of a RecordsWrite message.

    +

    Parameters

    • input: {
          attestation: undefined | GeneralJws;
          contextId: undefined | string;
          delegatedGrantId?: string;
          descriptorCid: string;
          encryption: undefined | EncryptionProperty;
          permissionGrantId?: string;
          protocolRole?: string;
          recordId: string;
          signer: Signer;
      }
      • attestation: undefined | GeneralJws
      • contextId: undefined | string
      • OptionaldelegatedGrantId?: string
      • descriptorCid: string
      • encryption: undefined | EncryptionProperty
      • OptionalpermissionGrantId?: string
      • OptionalprotocolRole?: string
      • recordId: string
      • signer: Signer

    Returns Promise<GeneralJws>

StaticfetchInitialRecordsWrite

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

  • Fetches the initial RecordsWrite of a record.

    +

    Parameters

    Returns Promise<undefined | RecordsWrite>

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

    +

StaticgetAttesters

  • getAttesters(message): string[]

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

    +

    Parameters

    • message: InternalRecordsWriteMessage

    Returns string[]

StaticgetEntryId

StaticgetInitialWrite

StaticisInitialWrite

Staticparse

StaticverifyEqualityOfImmutableProperties

Settings

Member Visibility

On This Page

attestersauthorisSignedByAuthorDelegateisSignedByOwnerDelegatemessageownerownerSignaturePayloadownerSignatureSignersignaturePayloadsignerauthorizeAuthorDelegateauthorizeOwnerDelegateconstructIndexesencryptSymmetricEncryptionKeygetEntryIdisInitialWritesignsignAsOwnersignAsOwnerDelegatetoJSONcreatecreateAttestationcreateFromcreateSignerSignaturefetchInitialRecordsWritegetAttestersgetEntryIdgetInitialWriteisInitialWriteparseverifyEqualityOfImmutableProperties
\ No newline at end of file diff --git a/classes/ResumableTaskStoreLevel.html b/classes/ResumableTaskStoreLevel.html new file mode 100644 index 000000000..0e71d4c41 --- /dev/null +++ b/classes/ResumableTaskStoreLevel.html @@ -0,0 +1,41 @@ +ResumableTaskStoreLevel | DWN-SDK Documentation - v0.3.10

Class ResumableTaskStoreLevel

A simple single-instance implementation of ResumableTaskStore that works in both browsers and node.js. +Leverages LevelDB under the hood.

+

Implements

Constructors

constructor +

Properties

config +db +

Methods

clear +close +delete +extend +grab +open +read +register +

Constructors

constructor

Properties

config

config: ResumableTaskStoreLevelConfig

db

db: LevelWrapper<string>

Methods

clear

close

delete

  • delete(taskId): Promise<void>

  • Deletes the task associated with the task ID provided. +No-op if the task is not found, as this implies that the task has already been completed. +Called when the task has been successfully completed.

    +

    Parameters

    • taskId: string

    Returns Promise<void>

extend

  • extend(taskId, timeoutInSeconds): Promise<void>

  • Extends the timeout of the task associated with the task ID provided. +No-op if the task is not found, as this implies that the task has already been completed. +This allows the client that is executing the task to continue working on it before the task is considered timed out.

    +

    Parameters

    • taskId: string

      ID of the task to extend the timeout for.

      +
    • timeoutInSeconds: number

      Timeout in seconds from the current time.

      +

    Returns Promise<void>

grab

  • grab(count): Promise<ManagedResumableTask[]>

  • Grabs a number of unhandled tasks from the store. +Unhandled tasks are tasks that are not currently in-flight/under processing (ie. tasks that have timed-out). +NOTE: The implementation must make sure that once a task is grabbed by a client, +tis timeout must be updated so that it is considered in-flight/under processing +and cannot be grabbed by another client until it is timed-out.

    +

    Parameters

    • count: number

      Desired number of tasks to grab.

      +

    Returns Promise<ManagedResumableTask[]>

    A list of tasks exclusive for the caller to handle; or empty array if there is no tasks, or if all tasks are already grabbed by others.

    +

open

read

register

  • register(task, timeoutInSeconds): Promise<ManagedResumableTask>

  • Registers a new resumable task that is currently in-flight/under processing to the store. +If the task is timed out, a client will be able to grab it through the grab() method and resume the task.

    +

    Parameters

    • task: any

      Task specific data. This is deliberately of type any because this store should not have to be ware of its type.

      +
    • timeoutInSeconds: number

      Timeout in seconds from the current time.

      +

    Returns Promise<ManagedResumableTask>

    A ManagedResumableTask object that can be used to extend or delete the task.

    +

    Throws

    with code set to ResumableTaskAlreadyExists if the same task is already registered.

    +

Settings

Member Visibility

On This Page

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

Class Secp256k1

Class containing SECP256K1 related utility methods.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticgenerateKeyPair

StaticgenerateKeyPairRaw

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

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

    +

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

StaticgetPublicJwk

StaticgetPublicKey

  • getPublicKey(privateKey): Promise<Uint8Array>

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

    +

    Parameters

    • privateKey: Uint8Array

    Returns Promise<Uint8Array>

StaticprivateJwkToBytes

  • privateJwkToBytes(privateJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

StaticprivateKeyToJwk

StaticpublicJwkToBytes

  • publicJwkToBytes(publicJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

StaticpublicKeyToJwk

Staticsign

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

  • Signs the provided content using the provided JWK.

    +

    Parameters

    Returns Promise<Uint8Array>

StaticvalidateKey

Staticverify

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

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

    +

    Parameters

    • content: Uint8Array
    • signature: Uint8Array
    • publicJwk: PublicJwk

    Returns Promise<boolean>

    a boolean indicating whether the signature is valid.

    +

Settings

Member Visibility

On This Page

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

Class Secp256r1

Class containing SECP256R1 related utility methods.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticbytesToBigInt

StaticgenerateKeyPair

StaticprivateJwkToBytes

  • privateJwkToBytes(privateJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

StaticpublicKeyToJwk

Staticsign

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

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

    +

    Parameters

    Returns Promise<Uint8Array>

StaticvalidateKey

Staticverify

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

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

    +

    Parameters

    • content: Uint8Array
    • signature: Uint8Array

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

      +
    • publicJwk: PublicJwk

    Returns Promise<boolean>

    a boolean indicating whether the signature is valid.

    +

Settings

Member Visibility

On This Page

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

Class TestDataGenerator

Utility class for generating data for testing.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticcreateDidResolutionResult

StaticgenerateAuthorization

  • generateAuthorization(): AuthorizationModel

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

    +

    Returns AuthorizationModel

StaticgenerateAuthorizationSignature

  • generateAuthorizationSignature(): GeneralJws

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

    +

    Returns GeneralJws

StaticgenerateDidKeyPersona

StaticgenerateEventsQuery

  • generateEventsQuery(input): Promise<GenerateEventsQueryOutput>

  • Parameters

    • input: GenerateEventsQueryInput

    Returns Promise<GenerateEventsQueryOutput>

StaticgenerateEventsSubscribe

  • generateEventsSubscribe(input?): Promise<GenerateEventsSubscribeOutput>

  • Generates a EventsSubscribe message for testing.

    +

    Parameters

    • Optionalinput: GenerateEventsSubscribeInput

    Returns Promise<GenerateEventsSubscribeOutput>

StaticgenerateFromRecordsWrite

  • generateFromRecordsWrite(input): Promise<GenerateFromRecordsWriteOut>

  • Generates a valid RecordsWrite that modifies the given an existing write. +Any mutable property is not specified will be automatically mutated. +e.g. if published is not specified, it will be toggled from the state of the given existing write.

    +

    Parameters

    • input: GenerateFromRecordsWriteInput

    Returns Promise<GenerateFromRecordsWriteOut>

StaticgenerateGrantCreate

  • generateGrantCreate(input?): Promise<GenerateGrantCreateOutput>

  • Parameters

    • Optionalinput: GenerateGrantCreateInput

    Returns Promise<GenerateGrantCreateOutput>

StaticgenerateMessagesGet

  • generateMessagesGet(input): Promise<GenerateMessagesGetOutput>

  • Parameters

    • input: GenerateMessagesGetInput

    Returns Promise<GenerateMessagesGetOutput>

StaticgeneratePersona

StaticgenerateProtocolEncryptedRecordsWrite

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

  • Generates a encrypted RecordsWrite message for testing.

    +

    Parameters

    • input: {
          author: Persona;
          encryptSymmetricKeyWithProtocolContextDerivedKey: boolean;
          encryptSymmetricKeyWithProtocolPathDerivedKey: boolean;
          plaintextBytes: Uint8Array;
          protocolContextDerivedPublicJwk?: PublicJwk;
          protocolContextDerivingRootKeyId?: string;
          protocolDefinition: ProtocolDefinition;
          protocolParentContextId?: string;
          protocolPath: string;
          recipient?: string;
      }
      • author: Persona
      • encryptSymmetricKeyWithProtocolContextDerivedKey: boolean

        Set to true to attach the symmetric key encrypted by the protocol context derived public key

        +
      • encryptSymmetricKeyWithProtocolPathDerivedKey: boolean

        Set to true to attach the symmetric key encrypted by the protocol path derived public key

        +
      • plaintextBytes: Uint8Array
      • OptionalprotocolContextDerivedPublicJwk?: PublicJwk
      • OptionalprotocolContextDerivingRootKeyId?: string
      • protocolDefinition: ProtocolDefinition

        Protocol definition used to generate the RecordsWrite. +Must be the RECIPIENT's protocol definition if encryptSymmetricKeyWithProtocolPathDerivedKey is true, +because the recipient's public keys will be needed to encrypt the symmetric key.

        +
      • OptionalprotocolParentContextId?: string
      • protocolPath: string
      • Optionalrecipient?: string

    Returns Promise<{
        dataStream: Readable;
        encryptedDataBytes: Uint8Array;
        encryptionInput: EncryptionInput;
        message: RecordsWriteMessage;
        recordsWrite: RecordsWrite;
    }>

StaticgenerateProtocolsConfigure

  • generateProtocolsConfigure(input?): Promise<GenerateProtocolsConfigureOutput>

  • Generates a ProtocolsConfigure message for testing. +Optional parameters are generated if not given. +Implementation currently uses ProtocolsConfigure.create().

    +

    Parameters

    • Optionalinput: GenerateProtocolsConfigureInput

    Returns Promise<GenerateProtocolsConfigureOutput>

StaticgenerateProtocolsQuery

  • generateProtocolsQuery(input?): Promise<GenerateProtocolsQueryOutput>

  • Generates a ProtocolsQuery message for testing.

    +

    Parameters

    • Optionalinput: GenerateProtocolsQueryInput

    Returns Promise<GenerateProtocolsQueryOutput>

StaticgenerateRecordsDelete

  • generateRecordsDelete(input?): Promise<GenerateRecordsDeleteOutput>

  • Generates a RecordsDelete for testing.

    +

    Parameters

    • Optionalinput: GenerateRecordsDeleteInput

    Returns Promise<GenerateRecordsDeleteOutput>

StaticgenerateRecordsQuery

  • generateRecordsQuery(input?): Promise<GenerateRecordsQueryOutput>

  • Generates a RecordsQuery message for testing.

    +

    Parameters

    • Optionalinput: GenerateRecordsQueryInput

    Returns Promise<GenerateRecordsQueryOutput>

StaticgenerateRecordsSubscribe

  • generateRecordsSubscribe(input?): Promise<GenerateRecordsSubscribeOutput>

  • Generates a RecordsSubscribe message for testing.

    +

    Parameters

    • Optionalinput: GenerateRecordsSubscribeInput

    Returns Promise<GenerateRecordsSubscribeOutput>

StaticgenerateRecordsWrite

  • generateRecordsWrite(input?): Promise<GenerateRecordsWriteOutput>

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

    +

    Parameters

    • Optionalinput: GenerateRecordsWriteInput

    Returns Promise<GenerateRecordsWriteOutput>

StaticrandomBytes

StaticrandomCborSha256Cid

StaticrandomInt

  • randomInt(min, max): number

  • Generates a random within a range (inclusive).

    +

    Parameters

    • min: number

      lowest potential value.

      +
    • max: number

      greatest potential value.

      +

    Returns number

StaticrandomSignatureString

StaticrandomString

StaticrandomTimestamp

  • randomTimestamp(options?): string

  • Generates a random timestamp. Optionally allows you to set specific non-randomized values for the timestamp.

    +

    Parameters

    • Optionaloptions: {
          day?: number;
          hour?: number;
          microsecond?: number;
          millisecond?: number;
          minute?: number;
          month?: number;
          second?: number;
          year?: number;
      }
      • Optionalday?: number
      • Optionalhour?: number
      • Optionalmicrosecond?: number
      • Optionalmillisecond?: number
      • Optionalminute?: number
      • Optionalmonth?: number
      • Optionalsecond?: number
      • Optionalyear?: number

    Returns string

    random UTC ISO-8601 timestamp

    +

Settings

Member Visibility

On This Page

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

Class Time

Time related utilities.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticcreateOffsetTimestamp

  • createOffsetTimestamp(offset, timestamp?): string

  • Creates a UTC ISO-8601 timestamp offset from now or given timestamp accepted by DWN.

    +

    Parameters

    • offset: {
          seconds: number;
      }

      Negative number means offset into the past.

      +
      • seconds: number
    • Optionaltimestamp: string

    Returns string

StaticcreateTimestamp

  • createTimestamp(options): string

  • Creates a UTC ISO-8601 timestamp in microsecond precision accepted by DWN.

    +

    Parameters

    • options: {
          day?: number;
          hour?: number;
          microsecond?: number;
          millisecond?: number;
          minute?: number;
          month?: number;
          second?: number;
          year?: number;
      }

      Options for creating the timestamp.

      +
      • Optionalday?: number
      • Optionalhour?: number
      • Optionalmicrosecond?: number
      • Optionalmillisecond?: number
      • Optionalminute?: number
      • Optionalmonth?: number
      • Optionalsecond?: number
      • Optionalyear?: number

    Returns string

    string

    +

StaticgetCurrentTimestamp

  • getCurrentTimestamp(): string

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

    +

    Returns string

StaticminimalSleep

Staticsleep

  • sleep(durationInMillisecond): Promise<void>

  • sleeps for the desired duration

    +

    Parameters

    • durationInMillisecond: number

      the desired amount of sleep time

      +

    Returns Promise<void>

    when the provided duration has passed

    +

StaticvalidateTimestamp

  • validateTimestamp(timestamp): void

  • Validates that the provided timestamp is a valid number

    +

    Parameters

    • timestamp: string

      the timestamp to validate

      +

    Returns void

    Throws

    DwnError if timestamp is not a valid number

    +

Settings

Member Visibility

On This Page

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

Enumeration DateSort

Enumeration Members

CreatedAscending +CreatedDescending +PublishedAscending +PublishedDescending +

Enumeration Members

CreatedAscending

CreatedAscending: "createdAscending"

CreatedDescending

CreatedDescending: "createdDescending"

PublishedAscending

PublishedAscending: "publishedAscending"

PublishedDescending

PublishedDescending: "publishedDescending"

Settings

Member Visibility

On This Page

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

Enumeration DwnErrorCode

DWN SDK error codes.

+

Enumeration Members

AuthenticateDescriptorCidMismatch +AuthenticateJwsMissing +AuthenticationMoreThanOneSignatureNotSupported +AuthorizationAuthorNotOwner +AuthorizationNotGrantedToAuthor +ComputeCidCodecNotSupported +ComputeCidMultihashNotSupported +DidMethodNotSupported +DidNotString +DidNotValid +DidResolutionFailed +Ed25519InvalidJwk +EventEmitterStreamNotOpenError +EventsGrantAuthorizationMismatchedProtocol +EventsQueryAuthorizationFailed +EventsSubscribeAuthorizationFailed +EventsSubscribeEventStreamUnimplemented +GeneralJwsVerifierGetPublicKeyNotFound +GeneralJwsVerifierInvalidSignature +GrantAuthorizationGrantExpired +GrantAuthorizationGrantMissing +GrantAuthorizationGrantNotYetActive +GrantAuthorizationGrantRevoked +GrantAuthorizationInterfaceMismatch +GrantAuthorizationMethodMismatch +GrantAuthorizationNotGrantedForTenant +GrantAuthorizationNotGrantedToAuthor +HdKeyDerivationPathInvalid +IndexInvalidCursorSortProperty +IndexInvalidCursorValueType +IndexInvalidSortPropertyInMemory +IndexMissingIndexableProperty +JwsDecodePlainObjectPayloadInvalid +JwsVerifySignatureUnsupportedCrv +MessageGetInvalidCid +ParseCidCodecNotSupported +ParseCidMultihashNotSupported +PermissionsProtocolCreateGrantRecordsScopeMissingProtocol +PermissionsProtocolCreateRequestRecordsScopeMissingProtocol +PermissionsProtocolValidateRevocationProtocolTagMismatch +PermissionsProtocolValidateSchemaUnexpectedRecord +PermissionsProtocolValidateScopeContextIdProhibitedProperties +PermissionsProtocolValidateScopeMissingProtocolTag +PermissionsProtocolValidateScopeProtocolMismatch +PrivateKeySignerUnableToDeduceAlgorithm +PrivateKeySignerUnableToDeduceKeyId +PrivateKeySignerUnsupportedCurve +ProtocolAuthorizationActionNotAllowed +ProtocolAuthorizationActionRulesNotFound +ProtocolAuthorizationDuplicateRoleRecipient +ProtocolAuthorizationIncorrectContextId +ProtocolAuthorizationIncorrectDataFormat +ProtocolAuthorizationIncorrectProtocolPath +ProtocolAuthorizationInvalidSchema +ProtocolAuthorizationInvalidType +ProtocolAuthorizationMatchingRoleRecordNotFound +ProtocolAuthorizationMaxSizeInvalid +ProtocolAuthorizationMinSizeInvalid +ProtocolAuthorizationMissingContextId +ProtocolAuthorizationMissingRuleSet +ProtocolAuthorizationNotARole +ProtocolAuthorizationParentNotFoundConstructingRecordChain +ProtocolAuthorizationParentlessIncorrectProtocolPath +ProtocolAuthorizationProtocolNotFound +ProtocolAuthorizationQueryWithoutRole +ProtocolAuthorizationRoleMissingRecipient +ProtocolAuthorizationTagsInvalidSchema +ProtocolsConfigureDuplicateActorInRuleSet +ProtocolsConfigureDuplicateRoleInRuleSet +ProtocolsConfigureInvalidActionDeleteWithoutCreate +ProtocolsConfigureInvalidActionMissingOf +ProtocolsConfigureInvalidActionOfNotAllowed +ProtocolsConfigureInvalidActionUpdateWithoutCreate +ProtocolsConfigureInvalidRecipientOfAction +ProtocolsConfigureInvalidRuleSetRecordType +ProtocolsConfigureInvalidSize +ProtocolsConfigureInvalidTagSchema +ProtocolsConfigureQueryNotAllowed +ProtocolsConfigureRecordNestingDepthExceeded +ProtocolsConfigureRoleDoesNotExistAtGivenPath +ProtocolsConfigureUnauthorized +ProtocolsQueryUnauthorized +RecordsAuthorDelegatedGrantAndIdExistenceMismatch +RecordsAuthorDelegatedGrantCidMismatch +RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch +RecordsAuthorDelegatedGrantNotADelegatedGrant +RecordsDecryptNoMatchingKeyEncryptedFound +RecordsDeleteAuthorizationFailed +RecordsDerivePrivateKeyUnSupportedCurve +RecordsGrantAuthorizationConditionPublicationProhibited +RecordsGrantAuthorizationConditionPublicationRequired +RecordsGrantAuthorizationDeleteProtocolScopeMismatch +RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch +RecordsGrantAuthorizationScopeContextIdMismatch +RecordsGrantAuthorizationScopeNotRecords +RecordsGrantAuthorizationScopeProtocolMismatch +RecordsGrantAuthorizationScopeProtocolPathMismatch +RecordsGrantAuthorizationScopeSchema +RecordsInvalidAncestorKeyDerivationSegment +RecordsOwnerDelegatedGrantAndIdExistenceMismatch +RecordsOwnerDelegatedGrantCidMismatch +RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch +RecordsOwnerDelegatedGrantNotADelegatedGrant +RecordsProtocolContextDerivationSchemeMissingContextId +RecordsProtocolPathDerivationSchemeMissingProtocol +RecordsQueryCreateFilterPublishedSortInvalid +RecordsQueryFilterMissingRequiredProperties +RecordsQueryParseFilterPublishedSortInvalid +RecordsReadAuthorizationFailed +RecordsReadReturnedMultiple +RecordsSchemasDerivationSchemeMissingSchema +RecordsSubscribeEventStreamUnimplemented +RecordsSubscribeFilterMissingRequiredProperties +RecordsWriteAttestationIntegrityDescriptorCidMismatch +RecordsWriteAttestationIntegrityInvalidPayloadProperty +RecordsWriteAttestationIntegrityMoreThanOneSignature +RecordsWriteAuthorizationFailed +RecordsWriteCreateDataAndDataCidMutuallyExclusive +RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive +RecordsWriteCreateMissingSigner +RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive +RecordsWriteDataCidMismatch +RecordsWriteDataSizeMismatch +RecordsWriteGetEntryIdUndefinedAuthor +RecordsWriteGetInitialWriteNotFound +RecordsWriteImmutablePropertyChanged +RecordsWriteMissingDataInPrevious +RecordsWriteMissingDataStream +RecordsWriteMissingEncodedDataInPrevious +RecordsWriteMissingProtocol +RecordsWriteMissingSchema +RecordsWriteMissingSigner +RecordsWriteOwnerAndTenantMismatch +RecordsWriteSignAsOwnerDelegateUnknownAuthor +RecordsWriteSignAsOwnerUnknownAuthor +RecordsWriteValidateIntegrityAttestationMismatch +RecordsWriteValidateIntegrityContextIdMismatch +RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload +RecordsWriteValidateIntegrityDateCreatedMismatch +RecordsWriteValidateIntegrityEncryptionCidMismatch +RecordsWriteValidateIntegrityRecordIdUnauthorized +SchemaValidatorAdditionalPropertyNotAllowed +SchemaValidatorFailure +SchemaValidatorSchemaNotFound +SchemaValidatorUnevaluatedPropertyNotAllowed +Secp256k1KeyNotValid +Secp256r1KeyNotValid +TimestampInvalid +UrlProtocolNotNormalizable +UrlProtocolNotNormalized +UrlSchemaNotNormalizable +UrlSchemaNotNormalized +

Enumeration Members

AuthenticateDescriptorCidMismatch

AuthenticateDescriptorCidMismatch: "AuthenticateDescriptorCidMismatch"

AuthenticateJwsMissing

AuthenticateJwsMissing: "AuthenticateJwsMissing"

AuthenticationMoreThanOneSignatureNotSupported

AuthenticationMoreThanOneSignatureNotSupported: "AuthenticationMoreThanOneSignatureNotSupported"

AuthorizationAuthorNotOwner

AuthorizationAuthorNotOwner: "AuthorizationAuthorNotOwner"

AuthorizationNotGrantedToAuthor

AuthorizationNotGrantedToAuthor: "AuthorizationNotGrantedToAuthor"

ComputeCidCodecNotSupported

ComputeCidCodecNotSupported: "ComputeCidCodecNotSupported"

ComputeCidMultihashNotSupported

ComputeCidMultihashNotSupported: "ComputeCidMultihashNotSupported"

DidMethodNotSupported

DidMethodNotSupported: "DidMethodNotSupported"

DidNotString

DidNotString: "DidNotString"

DidNotValid

DidNotValid: "DidNotValid"

DidResolutionFailed

DidResolutionFailed: "DidResolutionFailed"

Ed25519InvalidJwk

Ed25519InvalidJwk: "Ed25519InvalidJwk"

EventEmitterStreamNotOpenError

EventEmitterStreamNotOpenError: "EventEmitterStreamNotOpenError"

EventsGrantAuthorizationMismatchedProtocol

EventsGrantAuthorizationMismatchedProtocol: "EventsGrantAuthorizationMismatchedProtocol"

EventsQueryAuthorizationFailed

EventsQueryAuthorizationFailed: "EventsQueryAuthorizationFailed"

EventsSubscribeAuthorizationFailed

EventsSubscribeAuthorizationFailed: "EventsSubscribeAuthorizationFailed"

EventsSubscribeEventStreamUnimplemented

EventsSubscribeEventStreamUnimplemented: "EventsSubscribeEventStreamUnimplemented"

GeneralJwsVerifierGetPublicKeyNotFound

GeneralJwsVerifierGetPublicKeyNotFound: "GeneralJwsVerifierGetPublicKeyNotFound"

GeneralJwsVerifierInvalidSignature

GeneralJwsVerifierInvalidSignature: "GeneralJwsVerifierInvalidSignature"

GrantAuthorizationGrantExpired

GrantAuthorizationGrantExpired: "GrantAuthorizationGrantExpired"

GrantAuthorizationGrantMissing

GrantAuthorizationGrantMissing: "GrantAuthorizationGrantMissing"

GrantAuthorizationGrantNotYetActive

GrantAuthorizationGrantNotYetActive: "GrantAuthorizationGrantNotYetActive"

GrantAuthorizationGrantRevoked

GrantAuthorizationGrantRevoked: "GrantAuthorizationGrantRevoked"

GrantAuthorizationInterfaceMismatch

GrantAuthorizationInterfaceMismatch: "GrantAuthorizationInterfaceMismatch"

GrantAuthorizationMethodMismatch

GrantAuthorizationMethodMismatch: "GrantAuthorizationMethodMismatch"

GrantAuthorizationNotGrantedForTenant

GrantAuthorizationNotGrantedForTenant: "GrantAuthorizationNotGrantedForTenant"

GrantAuthorizationNotGrantedToAuthor

GrantAuthorizationNotGrantedToAuthor: "GrantAuthorizationNotGrantedToAuthor"

HdKeyDerivationPathInvalid

HdKeyDerivationPathInvalid: "HdKeyDerivationPathInvalid"

IndexInvalidCursorSortProperty

IndexInvalidCursorSortProperty: "IndexInvalidCursorSortProperty"

IndexInvalidCursorValueType

IndexInvalidCursorValueType: "IndexInvalidCursorValueType"

IndexInvalidSortPropertyInMemory

IndexInvalidSortPropertyInMemory: "IndexInvalidSortPropertyInMemory"

IndexMissingIndexableProperty

IndexMissingIndexableProperty: "IndexMissingIndexableProperty"

JwsDecodePlainObjectPayloadInvalid

JwsDecodePlainObjectPayloadInvalid: "JwsDecodePlainObjectPayloadInvalid"

JwsVerifySignatureUnsupportedCrv

JwsVerifySignatureUnsupportedCrv: "JwsVerifySignatureUnsupportedCrv"

MessageGetInvalidCid

MessageGetInvalidCid: "MessageGetInvalidCid"

ParseCidCodecNotSupported

ParseCidCodecNotSupported: "ParseCidCodecNotSupported"

ParseCidMultihashNotSupported

ParseCidMultihashNotSupported: "ParseCidMultihashNotSupported"

PermissionsProtocolCreateGrantRecordsScopeMissingProtocol

PermissionsProtocolCreateGrantRecordsScopeMissingProtocol: "PermissionsProtocolCreateGrantRecordsScopeMissingProtocol"

PermissionsProtocolCreateRequestRecordsScopeMissingProtocol

PermissionsProtocolCreateRequestRecordsScopeMissingProtocol: "PermissionsProtocolCreateRequestRecordsScopeMissingProtocol"

PermissionsProtocolValidateRevocationProtocolTagMismatch

PermissionsProtocolValidateRevocationProtocolTagMismatch: "PermissionsProtocolValidateRevocationProtocolTagMismatch"

PermissionsProtocolValidateSchemaUnexpectedRecord

PermissionsProtocolValidateSchemaUnexpectedRecord: "PermissionsProtocolValidateSchemaUnexpectedRecord"

PermissionsProtocolValidateScopeContextIdProhibitedProperties

PermissionsProtocolValidateScopeContextIdProhibitedProperties: "PermissionsProtocolValidateScopeContextIdProhibitedProperties"

PermissionsProtocolValidateScopeMissingProtocolTag

PermissionsProtocolValidateScopeMissingProtocolTag: "PermissionsProtocolValidateScopeMissingProtocolTag"

PermissionsProtocolValidateScopeProtocolMismatch

PermissionsProtocolValidateScopeProtocolMismatch: "PermissionsProtocolValidateScopeProtocolMismatch"

PrivateKeySignerUnableToDeduceAlgorithm

PrivateKeySignerUnableToDeduceAlgorithm: "PrivateKeySignerUnableToDeduceAlgorithm"

PrivateKeySignerUnableToDeduceKeyId

PrivateKeySignerUnableToDeduceKeyId: "PrivateKeySignerUnableToDeduceKeyId"

PrivateKeySignerUnsupportedCurve

PrivateKeySignerUnsupportedCurve: "PrivateKeySignerUnsupportedCurve"

ProtocolAuthorizationActionNotAllowed

ProtocolAuthorizationActionNotAllowed: "ProtocolAuthorizationActionNotAllowed"

ProtocolAuthorizationActionRulesNotFound

ProtocolAuthorizationActionRulesNotFound: "ProtocolAuthorizationActionRulesNotFound"

ProtocolAuthorizationDuplicateRoleRecipient

ProtocolAuthorizationDuplicateRoleRecipient: "ProtocolAuthorizationDuplicateRoleRecipient"

ProtocolAuthorizationIncorrectContextId

ProtocolAuthorizationIncorrectContextId: "ProtocolAuthorizationIncorrectContextId"

ProtocolAuthorizationIncorrectDataFormat

ProtocolAuthorizationIncorrectDataFormat: "ProtocolAuthorizationIncorrectDataFormat"

ProtocolAuthorizationIncorrectProtocolPath

ProtocolAuthorizationIncorrectProtocolPath: "ProtocolAuthorizationIncorrectProtocolPath"

ProtocolAuthorizationInvalidSchema

ProtocolAuthorizationInvalidSchema: "ProtocolAuthorizationInvalidSchema"

ProtocolAuthorizationInvalidType

ProtocolAuthorizationInvalidType: "ProtocolAuthorizationInvalidType"

ProtocolAuthorizationMatchingRoleRecordNotFound

ProtocolAuthorizationMatchingRoleRecordNotFound: "ProtocolAuthorizationMatchingRoleRecordNotFound"

ProtocolAuthorizationMaxSizeInvalid

ProtocolAuthorizationMaxSizeInvalid: "ProtocolAuthorizationMaxSizeInvalid"

ProtocolAuthorizationMinSizeInvalid

ProtocolAuthorizationMinSizeInvalid: "ProtocolAuthorizationMinSizeInvalid"

ProtocolAuthorizationMissingContextId

ProtocolAuthorizationMissingContextId: "ProtocolAuthorizationMissingContextId"

ProtocolAuthorizationMissingRuleSet

ProtocolAuthorizationMissingRuleSet: "ProtocolAuthorizationMissingRuleSet"

ProtocolAuthorizationNotARole

ProtocolAuthorizationNotARole: "ProtocolAuthorizationNotARole"

ProtocolAuthorizationParentNotFoundConstructingRecordChain

ProtocolAuthorizationParentNotFoundConstructingRecordChain: "ProtocolAuthorizationParentNotFoundConstructingRecordChain"

ProtocolAuthorizationParentlessIncorrectProtocolPath

ProtocolAuthorizationParentlessIncorrectProtocolPath: "ProtocolAuthorizationParentlessIncorrectProtocolPath"

ProtocolAuthorizationProtocolNotFound

ProtocolAuthorizationProtocolNotFound: "ProtocolAuthorizationProtocolNotFound"

ProtocolAuthorizationQueryWithoutRole

ProtocolAuthorizationQueryWithoutRole: "ProtocolAuthorizationQueryWithoutRole"

ProtocolAuthorizationRoleMissingRecipient

ProtocolAuthorizationRoleMissingRecipient: "ProtocolAuthorizationRoleMissingRecipient"

ProtocolAuthorizationTagsInvalidSchema

ProtocolAuthorizationTagsInvalidSchema: "ProtocolAuthorizationTagsInvalidSchema"

ProtocolsConfigureDuplicateActorInRuleSet

ProtocolsConfigureDuplicateActorInRuleSet: "ProtocolsConfigureDuplicateActorInRuleSet"

ProtocolsConfigureDuplicateRoleInRuleSet

ProtocolsConfigureDuplicateRoleInRuleSet: "ProtocolsConfigureDuplicateRoleInRuleSet"

ProtocolsConfigureInvalidActionDeleteWithoutCreate

ProtocolsConfigureInvalidActionDeleteWithoutCreate: "ProtocolsConfigureInvalidActionDeleteWithoutCreate"

ProtocolsConfigureInvalidActionMissingOf

ProtocolsConfigureInvalidActionMissingOf: "ProtocolsConfigureInvalidActionMissingOf"

ProtocolsConfigureInvalidActionOfNotAllowed

ProtocolsConfigureInvalidActionOfNotAllowed: "ProtocolsConfigureInvalidActionOfNotAllowed"

ProtocolsConfigureInvalidActionUpdateWithoutCreate

ProtocolsConfigureInvalidActionUpdateWithoutCreate: "ProtocolsConfigureInvalidActionUpdateWithoutCreate"

ProtocolsConfigureInvalidRecipientOfAction

ProtocolsConfigureInvalidRecipientOfAction: "ProtocolsConfigureInvalidRecipientOfAction"

ProtocolsConfigureInvalidRuleSetRecordType

ProtocolsConfigureInvalidRuleSetRecordType: "ProtocolsConfigureInvalidRuleSetRecordType"

ProtocolsConfigureInvalidSize

ProtocolsConfigureInvalidSize: "ProtocolsConfigureInvalidSize"

ProtocolsConfigureInvalidTagSchema

ProtocolsConfigureInvalidTagSchema: "ProtocolsConfigureInvalidTagSchema"

ProtocolsConfigureQueryNotAllowed

ProtocolsConfigureQueryNotAllowed: "ProtocolsConfigureQueryNotAllowed"

ProtocolsConfigureRecordNestingDepthExceeded

ProtocolsConfigureRecordNestingDepthExceeded: "ProtocolsConfigureRecordNestingDepthExceeded"

ProtocolsConfigureRoleDoesNotExistAtGivenPath

ProtocolsConfigureRoleDoesNotExistAtGivenPath: "ProtocolsConfigureRoleDoesNotExistAtGivenPath"

ProtocolsConfigureUnauthorized

ProtocolsConfigureUnauthorized: "ProtocolsConfigureUnauthorized"

ProtocolsQueryUnauthorized

ProtocolsQueryUnauthorized: "ProtocolsQueryUnauthorized"

RecordsAuthorDelegatedGrantAndIdExistenceMismatch

RecordsAuthorDelegatedGrantAndIdExistenceMismatch: "RecordsAuthorDelegatedGrantAndIdExistenceMismatch"

RecordsAuthorDelegatedGrantCidMismatch

RecordsAuthorDelegatedGrantCidMismatch: "RecordsAuthorDelegatedGrantCidMismatch"

RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch

RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch: "RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch"

RecordsAuthorDelegatedGrantNotADelegatedGrant

RecordsAuthorDelegatedGrantNotADelegatedGrant: "RecordsAuthorDelegatedGrantNotADelegatedGrant"

RecordsDecryptNoMatchingKeyEncryptedFound

RecordsDecryptNoMatchingKeyEncryptedFound: "RecordsDecryptNoMatchingKeyEncryptedFound"

RecordsDeleteAuthorizationFailed

RecordsDeleteAuthorizationFailed: "RecordsDeleteAuthorizationFailed"

RecordsDerivePrivateKeyUnSupportedCurve

RecordsDerivePrivateKeyUnSupportedCurve: "RecordsDerivePrivateKeyUnSupportedCurve"

RecordsGrantAuthorizationConditionPublicationProhibited

RecordsGrantAuthorizationConditionPublicationProhibited: "RecordsGrantAuthorizationConditionPublicationProhibited"

RecordsGrantAuthorizationConditionPublicationRequired

RecordsGrantAuthorizationConditionPublicationRequired: "RecordsGrantAuthorizationConditionPublicationRequired"

RecordsGrantAuthorizationDeleteProtocolScopeMismatch

RecordsGrantAuthorizationDeleteProtocolScopeMismatch: "RecordsGrantAuthorizationDeleteProtocolScopeMismatch"

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch: "RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch"

RecordsGrantAuthorizationScopeContextIdMismatch

RecordsGrantAuthorizationScopeContextIdMismatch: "RecordsGrantAuthorizationScopeContextIdMismatch"

RecordsGrantAuthorizationScopeNotRecords

RecordsGrantAuthorizationScopeNotRecords: "RecordsGrantAuthorizationScopeNotRecords"

RecordsGrantAuthorizationScopeProtocolMismatch

RecordsGrantAuthorizationScopeProtocolMismatch: "RecordsGrantAuthorizationScopeProtocolMismatch"

RecordsGrantAuthorizationScopeProtocolPathMismatch

RecordsGrantAuthorizationScopeProtocolPathMismatch: "RecordsGrantAuthorizationScopeProtocolPathMismatch"

RecordsGrantAuthorizationScopeSchema

RecordsGrantAuthorizationScopeSchema: "RecordsGrantAuthorizationScopeSchema"

RecordsInvalidAncestorKeyDerivationSegment

RecordsInvalidAncestorKeyDerivationSegment: "RecordsInvalidAncestorKeyDerivationSegment"

RecordsOwnerDelegatedGrantAndIdExistenceMismatch

RecordsOwnerDelegatedGrantAndIdExistenceMismatch: "RecordsOwnerDelegatedGrantAndIdExistenceMismatch"

RecordsOwnerDelegatedGrantCidMismatch

RecordsOwnerDelegatedGrantCidMismatch: "RecordsOwnerDelegatedGrantCidMismatch"

RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch

RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch: "RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch"

RecordsOwnerDelegatedGrantNotADelegatedGrant

RecordsOwnerDelegatedGrantNotADelegatedGrant: "RecordsOwnerDelegatedGrantNotADelegatedGrant"

RecordsProtocolContextDerivationSchemeMissingContextId

RecordsProtocolContextDerivationSchemeMissingContextId: "RecordsProtocolContextDerivationSchemeMissingContextId"

RecordsProtocolPathDerivationSchemeMissingProtocol

RecordsProtocolPathDerivationSchemeMissingProtocol: "RecordsProtocolPathDerivationSchemeMissingProtocol"

RecordsQueryCreateFilterPublishedSortInvalid

RecordsQueryCreateFilterPublishedSortInvalid: "RecordsQueryCreateFilterPublishedSortInvalid"

RecordsQueryFilterMissingRequiredProperties

RecordsQueryFilterMissingRequiredProperties: "RecordsQueryFilterMissingRequiredProperties"

RecordsQueryParseFilterPublishedSortInvalid

RecordsQueryParseFilterPublishedSortInvalid: "RecordsQueryParseFilterPublishedSortInvalid"

RecordsReadAuthorizationFailed

RecordsReadAuthorizationFailed: "RecordsReadAuthorizationFailed"

RecordsReadReturnedMultiple

RecordsReadReturnedMultiple: "RecordsReadReturnedMultiple"

RecordsSchemasDerivationSchemeMissingSchema

RecordsSchemasDerivationSchemeMissingSchema: "RecordsSchemasDerivationSchemeMissingSchema"

RecordsSubscribeEventStreamUnimplemented

RecordsSubscribeEventStreamUnimplemented: "RecordsSubscribeEventStreamUnimplemented"

RecordsSubscribeFilterMissingRequiredProperties

RecordsSubscribeFilterMissingRequiredProperties: "RecordsSubscribeFilterMissingRequiredProperties"

RecordsWriteAttestationIntegrityDescriptorCidMismatch

RecordsWriteAttestationIntegrityDescriptorCidMismatch: "RecordsWriteAttestationIntegrityDescriptorCidMismatch"

RecordsWriteAttestationIntegrityInvalidPayloadProperty

RecordsWriteAttestationIntegrityInvalidPayloadProperty: "RecordsWriteAttestationIntegrityInvalidPayloadProperty"

RecordsWriteAttestationIntegrityMoreThanOneSignature

RecordsWriteAttestationIntegrityMoreThanOneSignature: "RecordsWriteAttestationIntegrityMoreThanOneSignature"

RecordsWriteAuthorizationFailed

RecordsWriteAuthorizationFailed: "RecordsWriteAuthorizationFailed"

RecordsWriteCreateDataAndDataCidMutuallyExclusive

RecordsWriteCreateDataAndDataCidMutuallyExclusive: "RecordsWriteCreateDataAndDataCidMutuallyExclusive"

RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive

RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive: "RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive"

RecordsWriteCreateMissingSigner

RecordsWriteCreateMissingSigner: "RecordsWriteCreateMissingSigner"

RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive

RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive: "RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive"

RecordsWriteDataCidMismatch

RecordsWriteDataCidMismatch: "RecordsWriteDataCidMismatch"

RecordsWriteDataSizeMismatch

RecordsWriteDataSizeMismatch: "RecordsWriteDataSizeMismatch"

RecordsWriteGetEntryIdUndefinedAuthor

RecordsWriteGetEntryIdUndefinedAuthor: "RecordsWriteGetEntryIdUndefinedAuthor"

RecordsWriteGetInitialWriteNotFound

RecordsWriteGetInitialWriteNotFound: "RecordsWriteGetInitialWriteNotFound"

RecordsWriteImmutablePropertyChanged

RecordsWriteImmutablePropertyChanged: "RecordsWriteImmutablePropertyChanged"

RecordsWriteMissingDataInPrevious

RecordsWriteMissingDataInPrevious: "RecordsWriteMissingDataInPrevious"

RecordsWriteMissingDataStream

RecordsWriteMissingDataStream: "RecordsWriteMissingDataStream"

RecordsWriteMissingEncodedDataInPrevious

RecordsWriteMissingEncodedDataInPrevious: "RecordsWriteMissingEncodedDataInPrevious"

RecordsWriteMissingProtocol

RecordsWriteMissingProtocol: "RecordsWriteMissingProtocol"

RecordsWriteMissingSchema

RecordsWriteMissingSchema: "RecordsWriteMissingSchema"

RecordsWriteMissingSigner

RecordsWriteMissingSigner: "RecordsWriteMissingSigner"

RecordsWriteOwnerAndTenantMismatch

RecordsWriteOwnerAndTenantMismatch: "RecordsWriteOwnerAndTenantMismatch"

RecordsWriteSignAsOwnerDelegateUnknownAuthor

RecordsWriteSignAsOwnerDelegateUnknownAuthor: "RecordsWriteSignAsOwnerDelegateUnknownAuthor"

RecordsWriteSignAsOwnerUnknownAuthor

RecordsWriteSignAsOwnerUnknownAuthor: "RecordsWriteSignAsOwnerUnknownAuthor"

RecordsWriteValidateIntegrityAttestationMismatch

RecordsWriteValidateIntegrityAttestationMismatch: "RecordsWriteValidateIntegrityAttestationMismatch"

RecordsWriteValidateIntegrityContextIdMismatch

RecordsWriteValidateIntegrityContextIdMismatch: "RecordsWriteValidateIntegrityContextIdMismatch"

RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload

RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload: "RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload"

RecordsWriteValidateIntegrityDateCreatedMismatch

RecordsWriteValidateIntegrityDateCreatedMismatch: "RecordsWriteValidateIntegrityDateCreatedMismatch"

RecordsWriteValidateIntegrityEncryptionCidMismatch

RecordsWriteValidateIntegrityEncryptionCidMismatch: "RecordsWriteValidateIntegrityEncryptionCidMismatch"

RecordsWriteValidateIntegrityRecordIdUnauthorized

RecordsWriteValidateIntegrityRecordIdUnauthorized: "RecordsWriteValidateIntegrityRecordIdUnauthorized"

SchemaValidatorAdditionalPropertyNotAllowed

SchemaValidatorAdditionalPropertyNotAllowed: "SchemaValidatorAdditionalPropertyNotAllowed"

SchemaValidatorFailure

SchemaValidatorFailure: "SchemaValidatorFailure"

SchemaValidatorSchemaNotFound

SchemaValidatorSchemaNotFound: "SchemaValidatorSchemaNotFound"

SchemaValidatorUnevaluatedPropertyNotAllowed

SchemaValidatorUnevaluatedPropertyNotAllowed: "SchemaValidatorUnevaluatedPropertyNotAllowed"

Secp256k1KeyNotValid

Secp256k1KeyNotValid: "Secp256k1KeyNotValid"

Secp256r1KeyNotValid

Secp256r1KeyNotValid: "Secp256r1KeyNotValid"

TimestampInvalid

TimestampInvalid: "TimestampInvalid"

UrlProtocolNotNormalizable

UrlProtocolNotNormalizable: "UrlProtocolNotNormalizable"

UrlProtocolNotNormalized

UrlProtocolNotNormalized: "UrlProtocolNotNormalized"

UrlSchemaNotNormalizable

UrlSchemaNotNormalizable: "UrlSchemaNotNormalizable"

UrlSchemaNotNormalized

UrlSchemaNotNormalized: "UrlSchemaNotNormalized"

Settings

Member Visibility

On This Page

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

Enumeration DwnInterfaceName

Enumeration Members

Events +Messages +Protocols +Records +

Enumeration Members

Events

Events: "Events"

Messages

Messages: "Messages"

Protocols

Protocols: "Protocols"

Records

Records: "Records"

Settings

Member Visibility

On This Page

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

Enumeration DwnMethodName

Enumeration Members

Configure +Delete +Get +Query +Read +Subscribe +Write +

Enumeration Members

Configure

Configure: "Configure"

Delete

Delete: "Delete"

Get

Get: "Get"

Query

Query: "Query"

Read

Read: "Read"

Subscribe

Subscribe: "Subscribe"

Write

Write: "Write"

Settings

Member Visibility

On This Page

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

Enumeration EncryptionAlgorithm

Enumeration Members

Aes256Ctr +EciesSecp256k1 +

Enumeration Members

Aes256Ctr

Aes256Ctr: "A256CTR"

EciesSecp256k1

EciesSecp256k1: "ECIES-ES256K"

Settings

Member Visibility

On This Page

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

Enumeration KeyDerivationScheme

Enumeration Members

DataFormats +ProtocolContext +ProtocolPath +Schemas +

Enumeration Members

DataFormats

DataFormats: "dataFormats"

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

+

ProtocolContext

ProtocolContext: "protocolContext"

ProtocolPath

ProtocolPath: "protocolPath"

Schemas

Schemas: "schemas"

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

+

Settings

Member Visibility

On This Page

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

Enumeration PermissionConditionPublication

Enumeration Members

Prohibited +Required +

Enumeration Members

Prohibited

Prohibited: "Prohibited"

Required

Required: "Required"

Settings

Member Visibility

On This Page

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

Enumeration SortDirection

Enumeration Members

Ascending +Descending +

Enumeration Members

Ascending

Ascending: 1

Descending

Descending: -1

Settings

Member Visibility

On This Page

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

Function authenticate

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

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

    +

    Parameters

    • authorizationModel: undefined | AuthorizationModel
    • didResolver: DidResolver

    Returns Promise<void>

    Throws

    if fails authentication

    +

Settings

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

Function executeUnlessAborted

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

  • Wraps the given Promise such that it will reject if the AbortSignal is triggered.

    +

    Type Parameters

    • T

    Parameters

    • promise: Promise<T>
    • signal: undefined | AbortSignal

    Returns Promise<T>

Settings

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

DWN-SDK Documentation - v0.3.10

Class Hierarchy

Settings

Member Visibility
\ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 000000000..4d76d9d84 --- /dev/null +++ b/index.html @@ -0,0 +1,137 @@ +DWN-SDK Documentation - v0.3.10

DWN-SDK Documentation - v0.3.10

Index

Enumerations

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

Classes

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

Interfaces

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

Type Aliases

ActiveTenantCheckResult +CreateFromOptions +DataStoreGetResult +DataStorePutResult +DerivedPrivateJwk +DwnConfig +EncryptionInput +EncryptionProperty +EqualFilter +EventListener +EventsPermissionScope +EventsQueryMessage +EventsQueryOptions +EventsQueryReply +EventsSubscribeDescriptor +EventsSubscribeMessage +EventsSubscribeOptions +EventsSubscribeReply +Filter +GenericMessage +GenericMessageReply +KeyEncryptionInput +KeyMaterial +ManagedResumableTask +MessageEvent +MessageSort +MessageSubscriptionHandler +MessagesGetMessage +MessagesGetOptions +MessagesGetReply +MessagesGetReplyEntry +MessagesPermissionScope +OneOfFilter +Pagination +PaginationCursor +PermissionConditions +PermissionGrantData +PermissionRequestData +PermissionRevocationData +PermissionScope +Persona +PrivateJwk +ProtocolDefinition +ProtocolPermissionScope +ProtocolRuleSet +ProtocolTypes +ProtocolsConfigureDescriptor +ProtocolsConfigureMessage +ProtocolsConfigureOptions +ProtocolsQueryFilter +ProtocolsQueryMessage +ProtocolsQueryOptions +ProtocolsQueryReply +PublicJwk +QueryOptions +QueryResultEntry +RangeCriterion +RangeFilter +RecordSubscriptionHandler +RecordsDeleteMessage +RecordsDeleteOptions +RecordsPermissionScope +RecordsQueryMessage +RecordsQueryOptions +RecordsQueryReply +RecordsQueryReplyEntry +RecordsReadMessage +RecordsReadOptions +RecordsReadReply +RecordsSubscribeDescriptor +RecordsSubscribeMessage +RecordsSubscribeOptions +RecordsSubscribeReply +RecordsWriteDescriptor +RecordsWriteMessage +RecordsWriteOptions +RecordsWriteTagValue +RecordsWriteTags +SubscriptionReply +UnionMessageReply +

Functions

authenticate +executeUnlessAborted +

Settings

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

Interface DataStore

The interface that defines how to store and fetch data associated with a message.

+
interface DataStore {
    clear(): Promise<void>;
    close(): Promise<void>;
    delete(tenant: string, recordId: string, dataCid: string): Promise<void>;
    get(tenant: string, recordId: string, dataCid: string): Promise<undefined | DataStoreGetResult>;
    open(): Promise<void>;
    put(tenant: string, recordId: string, dataCid: string, dataStream: Readable): Promise<DataStorePutResult>;
}

Implemented by

Methods

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

Methods

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

delete

  • delete(tenant, recordId, dataCid): Promise<void>

  • Deletes the specified data. No-op if the data does not exist.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<void>

get

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

  • Fetches the specified data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<undefined | DataStoreGetResult>

    the data size and data stream if found, otherwise undefined.

    +

open

put

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

  • Stores the given data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +
    • dataStream: Readable

    Returns Promise<DataStorePutResult>

Settings

Member Visibility

On This Page

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

Interface EventLog

interface EventLog {
    append(tenant: string, messageCid: string, indexes: KeyValues): Promise<void>;
    clear(): Promise<void>;
    close(): Promise<void>;
    deleteEventsByCid(tenant: string, messageCids: string[]): Promise<void>;
    getEvents(tenant: string, cursor?: PaginationCursor): Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>;
    open(): Promise<void>;
    queryEvents(tenant: string, filters: Filter[], cursor?: PaginationCursor): Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>;
}

Implemented by

Methods

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

Methods

append

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

  • adds an event to a tenant's event log

    +

    Parameters

    • tenant: string

      the tenant's DID

      +
    • messageCid: string

      the CID of the message

      +
    • indexes: KeyValues

      (key-value pairs) to be included as part of indexing this event.

      +

    Returns Promise<void>

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

  • close(): Promise<void>

  • closes the connection to the underlying store

    +

    Returns Promise<void>

deleteEventsByCid

  • deleteEventsByCid(tenant, messageCids): Promise<void>

  • deletes any events that have any of the messageCids provided

    +

    Parameters

    • tenant: string
    • messageCids: string[]

    Returns Promise<void>

    the number of events deleted

    +

getEvents

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

  • Retrieves all of a tenant's events that occurred after the cursor provided. +If no cursor is provided, all events for a given tenant will be returned.

    +

    The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

    Returns Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>

open

  • open(): Promise<void>

  • opens a connection to the underlying store

    +

    Returns Promise<void>

queryEvents

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

  • retrieves a filtered set of events that occurred after a the cursor provided, accepts multiple filters.

    +

    If no cursor is provided, all events for a given tenant and filter combo will be returned. +The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

    Returns Promise<{
        cursor?: PaginationCursor;
        events: string[];
    }>

Settings

Member Visibility

On This Page

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

Interface EventStream

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

+
interface EventStream {
    close(): Promise<void>;
    emit(tenant: string, event: MessageEvent, indexes: KeyValues): void;
    open(): Promise<void>;
    subscribe(tenant: string, id: string, listener: EventListener): Promise<EventSubscription>;
}

Implemented by

Methods

close +emit +open +subscribe +

Methods

close

emit

open

subscribe

Settings

Member Visibility

On This Page

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

Interface EventSubscription

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

Properties

close +id +

Properties

close

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

id

id: string

Settings

Member Visibility

On This Page

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

Interface MessageStore

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

Implemented by

Methods

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

Methods

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

delete

get

open

put

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

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

    +

    Parameters

    Returns Promise<void>

query

Settings

Member Visibility

On This Page

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

Interface MessageStoreOptions

interface MessageStoreOptions {
    signal?: AbortSignal;
}

Properties

signal? +

Properties

Optionalsignal

signal?: AbortSignal

Settings

Member Visibility

On This Page

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

Interface MessageSubscription

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

Properties

close +id +

Properties

close

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

id

id: string

Settings

Member Visibility

On This Page

closeid
\ No newline at end of file diff --git a/interfaces/ResumableTaskStore.html b/interfaces/ResumableTaskStore.html new file mode 100644 index 000000000..2c41bbfbf --- /dev/null +++ b/interfaces/ResumableTaskStore.html @@ -0,0 +1,57 @@ +ResumableTaskStore | DWN-SDK Documentation - v0.3.10

Interface ResumableTaskStore

Interface for interacting with the resumable task store.

+

Implementer's Note: +The store implementation used in a horizontally scalable deployment, such as in a Kubernetes cluster, +must account for concurrent access by multiple ResumableTaskStore instances. +It would be undesirable to have many kubernetes pods all trying to handle the same resumable task. +A minimal viable implementation can use a per tenant exclusive lock on the store when grab() and method is called. +This would prevent issues that occur from concurrent modification to the same task to the store, +but negatively impacts the throughput performance of the DWN. +Requirements for a more performant implementation that allows distributed processing of resumable tasks across multiple clients:

+
    +
  1. The implementation probably requires both: +a. a persistent store for storing the data of each resumable task; and +b. an message streaming queue/service for distributing the each task exclusively to one of multiple handling clients.
    2. +
  2. The grab() and/or open() implementation will need to copy the timed-out tasks from persistent store into the message queue/service +for distributed processing by multiple clients when there is no resumable tasks to grab in the message queue. +During the move, the persistent store should be locked to prevent multiple copies of the same tasks from being copied.
    3. +
  3. Both Google's pub-sub and Amazon's SQS require an Ack ID / Receipt Handle to acknowledge the message, +The value of Ack ID / Receipt Handle is not known until the message is received, +therefore the implementer will likely need to have an in-memory mapping of task ID -> Ack ID / Receipt Handle +so that delete() can be called with task ID.
    4. +
+
interface ResumableTaskStore {
    clear(): Promise<void>;
    close(): Promise<void>;
    delete(taskId: string): Promise<void>;
    extend(taskId: string, timeoutInSeconds: number): Promise<void>;
    grab(count: number): Promise<ManagedResumableTask[]>;
    open(): Promise<void>;
    read(taskId: string): Promise<undefined | ManagedResumableTask>;
    register(task: any, timeoutInSeconds: number): Promise<ManagedResumableTask>;
}

Implemented by

Methods

clear +close +delete +extend +grab +open +read +register +

Methods

clear

close

delete

  • delete(taskId): Promise<void>

  • Deletes the task associated with the task ID provided. +No-op if the task is not found, as this implies that the task has already been completed. +Called when the task has been successfully completed.

    +

    Parameters

    • taskId: string

    Returns Promise<void>

extend

  • extend(taskId, timeoutInSeconds): Promise<void>

  • Extends the timeout of the task associated with the task ID provided. +No-op if the task is not found, as this implies that the task has already been completed. +This allows the client that is executing the task to continue working on it before the task is considered timed out.

    +

    Parameters

    • taskId: string

      ID of the task to extend the timeout for.

      +
    • timeoutInSeconds: number

      Timeout in seconds from the current time.

      +

    Returns Promise<void>

grab

  • grab(count): Promise<ManagedResumableTask[]>

  • Grabs a number of unhandled tasks from the store. +Unhandled tasks are tasks that are not currently in-flight/under processing (ie. tasks that have timed-out). +NOTE: The implementation must make sure that once a task is grabbed by a client, +tis timeout must be updated so that it is considered in-flight/under processing +and cannot be grabbed by another client until it is timed-out.

    +

    Parameters

    • count: number

      Desired number of tasks to grab.

      +

    Returns Promise<ManagedResumableTask[]>

    A list of tasks exclusive for the caller to handle; or empty array if there is no tasks, or if all tasks are already grabbed by others.

    +

open

read

  • read(taskId): Promise<undefined | ManagedResumableTask>

  • Reads the task associated with the task ID provided regardless of whether it is in-flight/under processing or not. +This is mainly introduced for testing purposes: ie. to check the status of a task for easy test verification.

    +

    Parameters

    • taskId: string

      ID of the task to read.

      +

    Returns Promise<undefined | ManagedResumableTask>

register

  • register(task, timeoutInSeconds): Promise<ManagedResumableTask>

  • Registers a new resumable task that is currently in-flight/under processing to the store. +If the task is timed out, a client will be able to grab it through the grab() method and resume the task.

    +

    Parameters

    • task: any

      Task specific data. This is deliberately of type any because this store should not have to be ware of its type.

      +
    • timeoutInSeconds: number

      Timeout in seconds from the current time.

      +

    Returns Promise<ManagedResumableTask>

    A ManagedResumableTask object that can be used to extend or delete the task.

    +

    Throws

    with code set to ResumableTaskAlreadyExists if the same task is already registered.

    +

Settings

Member Visibility

On This Page

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

Interface Signer

A signer that is capable of generating a digital signature over any given bytes.

+
interface Signer {
    algorithm: string;
    keyId: string;
    sign(content: Uint8Array): Promise<Uint8Array>;
}

Implemented by

Properties

algorithm +keyId +

Methods

sign +

Properties

algorithm

algorithm: string

The name of the signature algorithm used by this signer. +This value will be used as the "alg" parameter in JWS produced. +This parameter is not used by the DWN but is unfortunately a required header property for a JWS as per: +https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.1 +Valid signature algorithm values can be found at https://www.iana.org/assignments/jose/jose.xhtml

+

keyId

keyId: string

The ID of the key used by this signer. +This needs to be a fully-qualified ID (ie. prefixed with DID) so that author can be parsed out for processing such as recordId computation. +Example: did:example:alice#key1 +This value will be used as the "kid" parameter in JWS produced. +While this property is not a required property per JWS specification, it is required for DWN authentication.

+

Methods

sign

  • sign(content): Promise<Uint8Array>

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

    +

    Parameters

    • content: Uint8Array

    Returns Promise<Uint8Array>

Settings

Member Visibility

On This Page

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

Interface TenantGate

An interface that gates tenant access to the DWN.

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

Implemented by

Methods

isActiveTenant +

Methods

isActiveTenant

Settings

Member Visibility

On This Page

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

Type Alias ActiveTenantCheckResult

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

The result of the isActiveTenant() call.

+

Type declaration

  • Optionaldetail?: string

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

    +
  • isActiveTenant: boolean

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

    +

Settings

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

Type Alias CreateFromOptions

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

Type declaration

  • OptionalattestationSigners?: Signer[]
  • Optionaldata?: Uint8Array
  • OptionaldataFormat?: string

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

    +
  • OptionaldatePublished?: string
  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • OptionalencryptionInput?: EncryptionInput
  • OptionalmessageTimestamp?: string
  • OptionalprotocolRole?: string
  • Optionalpublished?: boolean
  • recordsWriteMessage: RecordsWriteMessage
  • Optionalsigner?: Signer

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

    +
  • Optionaltags?: RecordsWriteTags

Settings

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

Type Alias DataStoreGetResult

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

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

+

Type declaration

  • dataSize: number

    The number of bytes of the data stored.

    +
  • dataStream: Readable

Settings

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

Type Alias DataStorePutResult

DataStorePutResult: {
    dataSize: number;
}

Result of a data store put() method call.

+

Type declaration

  • dataSize: number

    The number of bytes of the data stored.

    +

Settings

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

Type Alias DerivedPrivateJwk

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

Settings

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

Type Alias DwnConfig

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

DWN configuration.

+

Settings

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

Type Alias EncryptionInput

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

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

+

Type declaration

  • Optionalalgorithm?: EncryptionAlgorithm

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

    +
  • initializationVector: Uint8Array

    Initialization vector used for encrypting the data.

    +
  • key: Uint8Array

    Symmetric key used to encrypt the data.

    +
  • keyEncryptionInputs: KeyEncryptionInput[]

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

    +

Settings

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

Type Alias EncryptionProperty

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

Settings

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

Type Alias EqualFilter

EqualFilter: string | number | boolean

Settings

Member Visibility
\ No newline at end of file diff --git a/types/EventListener.html b/types/EventListener.html new file mode 100644 index 000000000..957f14efd --- /dev/null +++ b/types/EventListener.html @@ -0,0 +1 @@ +EventListener | DWN-SDK Documentation - v0.3.10

Type Alias EventListener

EventListener: ((tenant: string, event: MessageEvent, indexes: KeyValues) => void)

Settings

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

Type Alias EventsPermissionScope

EventsPermissionScope: {
    interface: Events;
    method: Query | Subscribe;
    protocol?: string;
}

Settings

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

Type Alias EventsQueryMessage

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

Settings

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

Type Alias EventsQueryOptions

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

Settings

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

Type Alias EventsQueryReply

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

Settings

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

Type Alias EventsSubscribeDescriptor

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

Settings

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

Type Alias EventsSubscribeMessage

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

Settings

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

Type Alias EventsSubscribeOptions

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

Settings

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

Type Alias EventsSubscribeReply

EventsSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Settings

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

Type Alias Filter

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

Settings

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

Type Alias GenericMessage

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

Intersection type for all concrete message types.

+

Settings

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

Type Alias GenericMessageReply

GenericMessageReply: {
    status: Status;
}

Settings

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

Type Alias KeyEncryptionInput

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

Input that specifies how a symmetric key is encrypted.

+

Type declaration

  • Optionalalgorithm?: EncryptionAlgorithm

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

    +
  • derivationScheme: KeyDerivationScheme

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

    +
  • publicKey: PublicJwk

    Public key to be used to encrypt the symmetric key.

    +
  • publicKeyId: string

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

    +

Settings

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

Type Alias KeyMaterial

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

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

+

Settings

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

Type Alias ManagedResumableTask

ManagedResumableTask: {
    id: string;
    retryCount: number;
    task: any;
    timeout: number;
}

An managed resumable task model.

+

Type declaration

  • id: string

    Globally unique ID. Used to extend or delete the task.

    +
  • retryCount: number

    Number of retries

    +
  • task: any

    Task specific data. This is deliberately of type any because this store should not have to be ware of its type.

    +
  • timeout: number

    Task timeout in Epoch Time.

    +

Settings

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

Type Alias MessageEvent

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

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

+

Type declaration

Settings

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

Type Alias MessageSort

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

Settings

Member Visibility
\ No newline at end of file diff --git a/types/MessageSubscriptionHandler.html b/types/MessageSubscriptionHandler.html new file mode 100644 index 000000000..7318fa3e9 --- /dev/null +++ b/types/MessageSubscriptionHandler.html @@ -0,0 +1 @@ +MessageSubscriptionHandler | DWN-SDK Documentation - v0.3.10

Type Alias MessageSubscriptionHandler

MessageSubscriptionHandler: ((event: MessageEvent) => void)

Settings

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

Type Alias MessagesGetMessage

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

Settings

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

Type Alias MessagesGetOptions

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

Settings

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

Type Alias MessagesGetReply

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

Settings

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

Type Alias MessagesGetReplyEntry

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

Settings

Member Visibility
\ No newline at end of file diff --git a/types/MessagesPermissionScope.html b/types/MessagesPermissionScope.html new file mode 100644 index 000000000..929e47cd4 --- /dev/null +++ b/types/MessagesPermissionScope.html @@ -0,0 +1 @@ +MessagesPermissionScope | DWN-SDK Documentation - v0.3.10

Type Alias MessagesPermissionScope

MessagesPermissionScope: {
    interface: Messages;
    method: Get;
}

Settings

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

Type Alias OneOfFilter

OneOfFilter: EqualFilter[]

Settings

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

Type Alias Pagination

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

Pagination Options for querying messages.

+

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

+

Settings

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

Type Alias PaginationCursor

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

Settings

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

Type Alias PermissionConditions

PermissionConditions: {
    publication?: PermissionConditionPublication;
}

Type declaration

  • Optionalpublication?: PermissionConditionPublication

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

    +

Settings

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

Type Alias PermissionGrantData

PermissionGrantData: {
    conditions?: PermissionConditions;
    dateExpires: string;
    delegated?: boolean;
    description?: string;
    requestId?: string;
    scope: PermissionScope;
}

Type for the data payload of a permission grant message.

+

Type declaration

  • Optionalconditions?: PermissionConditions
  • dateExpires: string

    Timestamp at which this grant will no longer be active.

    +
  • Optionaldelegated?: boolean

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

    +
  • Optionaldescription?: string

    Optional string that communicates what the grant would be used for

    +
  • OptionalrequestId?: string

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

    +
  • scope: PermissionScope

    The scope of the allowed access.

    +

Settings

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

Type Alias PermissionRequestData

PermissionRequestData: {
    conditions?: PermissionConditions;
    delegated: boolean;
    description?: string;
    scope: PermissionScope;
}

Type for the data payload of a permission request message.

+

Type declaration

  • Optionalconditions?: PermissionConditions
  • delegated: boolean

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

    +
  • Optionaldescription?: string

    Optional string that communicates what the grant would be used for.

    +
  • scope: PermissionScope

    The scope of the allowed access.

    +

Settings

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

Type Alias PermissionRevocationData

PermissionRevocationData: {
    description?: string;
}

Type for the data payload of a permission revocation message.

+

Type declaration

  • Optionaldescription?: string

    Optional string that communicates the details of the revocation.

    +

Settings

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

Type Alias PermissionScope

PermissionScope:
    | ProtocolPermissionScope
    | MessagesPermissionScope
    | EventsPermissionScope
    | RecordsPermissionScope

The data model for a permission scope.

+

Settings

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

Type Alias Persona

Persona: {
    did: string;
    keyId: string;
    keyPair: {
        privateJwk: PrivateJwk;
        publicJwk: PublicJwk;
    };
    signer: Signer;
}

A logical grouping of user data used to generate test messages.

+

Settings

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

Type Alias PrivateJwk

PrivateJwk: PublicJwk & {
    d: string;
}

Type declaration

  • d: string

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

    +

Settings

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

Type Alias ProtocolDefinition

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

Type declaration

  • protocol: string
  • published: boolean

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

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

Settings

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

Type Alias ProtocolPermissionScope

ProtocolPermissionScope: {
    interface: Protocols;
    method: Configure | Query;
}

Settings

Member Visibility
\ No newline at end of file diff --git a/types/ProtocolRuleSet.html b/types/ProtocolRuleSet.html new file mode 100644 index 000000000..07080fd43 --- /dev/null +++ b/types/ProtocolRuleSet.html @@ -0,0 +1,8 @@ +ProtocolRuleSet | DWN-SDK Documentation - v0.3.10

Type Alias ProtocolRuleSet

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

Type declaration

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

    Encryption setting for objects that are in this protocol path.

    +
  • Optional$role?: boolean

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

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

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

    +
    • Optionalmax?: number
    • Optionalmin?: number
  • Optional$tags?: {
        $allowUndefinedTags?: boolean;
        $requiredTags?: string[];
        [key: string]: any;
    }

    If $tags is set, the record must conform to the tag rules.

    +
    • [key: string]: any
    • Optional$allowUndefinedTags?: boolean

      allow properties other than those explicitly listed. defaults to false

      +
    • Optional$requiredTags?: string[]

      array of required tags

      +

Settings

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

Type Alias ProtocolTypes

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

Settings

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

Type Alias ProtocolsConfigureDescriptor

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

Settings

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

Type Alias ProtocolsConfigureMessage

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

Settings

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

Type Alias ProtocolsConfigureOptions

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

Settings

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

Type Alias ProtocolsQueryFilter

ProtocolsQueryFilter: {
    protocol: string;
}

Settings

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

Type Alias ProtocolsQueryMessage

ProtocolsQueryMessage: GenericMessage & {
    descriptor: ProtocolsQueryDescriptor;
}

Settings

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

Type Alias ProtocolsQueryOptions

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

Settings

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

Type Alias ProtocolsQueryReply

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

Settings

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

Type Alias PublicJwk

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

Type declaration

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

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

    +
  • x: string

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

    +
  • Optionaly?: string

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

    +

Settings

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

Type Alias QueryOptions

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

Settings

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

Type Alias QueryResultEntry

QueryResultEntry: GenericMessage & {
    encodedData?: string;
}

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

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

Settings

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

Type Alias RangeCriterion

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

Type declaration

  • Optionalfrom?: string

    Inclusive starting date-time.

    +
  • Optionalto?: string

    Inclusive end date-time.

    +

Settings

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

Type Alias RangeFilter

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

Ranger filter. 1 condition is required.

+

Settings

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

Type Alias RecordSubscriptionHandler

RecordSubscriptionHandler: ((event: RecordEvent) => void)

Settings

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

Type Alias RecordsDeleteMessage

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

Settings

Member Visibility
\ No newline at end of file diff --git a/types/RecordsDeleteOptions.html b/types/RecordsDeleteOptions.html new file mode 100644 index 000000000..5f5e9b295 --- /dev/null +++ b/types/RecordsDeleteOptions.html @@ -0,0 +1,3 @@ +RecordsDeleteOptions | DWN-SDK Documentation - v0.3.10

Type Alias RecordsDeleteOptions

RecordsDeleteOptions: {
    delegatedGrant?: DataEncodedRecordsWriteMessage;
    messageTimestamp?: string;
    protocolRole?: string;
    prune?: boolean;
    recordId: string;
    signer: Signer;
}

Type declaration

  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • OptionalmessageTimestamp?: string
  • OptionalprotocolRole?: string
  • Optionalprune?: boolean

    Denotes if all the descendent records should be purged. Defaults to false.

    +
  • recordId: string
  • signer: Signer

Settings

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

Type Alias RecordsPermissionScope

RecordsPermissionScope: {
    contextId?: string;
    interface: Records;
    method:
        | Read
        | Write
        | Query
        | Subscribe
        | Delete;
    protocol: string;
    protocolPath?: string;
}

The data model for a permission scope that is specific to the Records interface.

+

Type declaration

  • OptionalcontextId?: string

    May only be present when protocol is defined and protocolPath is undefined

    +
  • interface: Records
  • method:
        | Read
        | Write
        | Query
        | Subscribe
        | Delete
  • protocol: string
  • OptionalprotocolPath?: string

    May only be present when protocol is defined and contextId is undefined

    +

Settings

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

Type Alias RecordsQueryMessage

RecordsQueryMessage: GenericMessage & {
    descriptor: RecordsQueryDescriptor;
}

Settings

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

Type Alias RecordsQueryOptions

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

Type declaration

  • OptionaldateSort?: DateSort
  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • filter: RecordsFilter
  • OptionalmessageTimestamp?: string
  • Optionalpagination?: Pagination
  • OptionalprotocolRole?: string
  • Optionalsigner?: Signer

Settings

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

Type Alias RecordsQueryReply

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

Settings

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

Type Alias RecordsQueryReplyEntry

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

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

+
    +
  1. May include an initial RecordsWrite message
    2. +
  2. May include encoded data
    3. +
+

Type declaration

  • OptionalencodedData?: string

    The encoded data of the record if the data associated with the record is equal or smaller than DwnConstant.maxDataSizeAllowedToBeEncoded.

    +
  • OptionalinitialWrite?: RecordsWriteMessage

    The initial write of the record if the returned RecordsWrite message itself is not the initial write.

    +

Settings

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

Type Alias RecordsReadMessage

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

Settings

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

Type Alias RecordsReadOptions

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

Type declaration

  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • filter: RecordsFilter
  • OptionalmessageTimestamp?: string
  • OptionalpermissionGrantId?: string
  • OptionalprotocolRole?: string

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

    +
  • Optionalsigner?: Signer

Settings

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

Type Alias RecordsReadReply

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

Settings

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

Type Alias RecordsSubscribeDescriptor

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

Settings

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

Type Alias RecordsSubscribeMessage

RecordsSubscribeMessage: GenericMessage & {
    descriptor: RecordsSubscribeDescriptor;
}

Settings

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

Type Alias RecordsSubscribeOptions

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

Type declaration

  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • filter: RecordsFilter
  • OptionalmessageTimestamp?: string
  • OptionalprotocolRole?: string
  • Optionalsigner?: Signer

Settings

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

Type Alias RecordsSubscribeReply

RecordsSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Settings

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

Type Alias RecordsWriteDescriptor

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

Settings

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

Type Alias RecordsWriteMessage

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

Settings

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

Type Alias RecordsWriteOptions

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

Type declaration

  • OptionalattestationSigners?: Signer[]
  • Optionaldata?: Uint8Array
  • OptionaldataCid?: string
  • dataFormat: string
  • OptionaldataSize?: number
  • OptionaldateCreated?: string
  • OptionaldatePublished?: string
  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • OptionalencryptionInput?: EncryptionInput
  • OptionalmessageTimestamp?: string
  • OptionalparentContextId?: string

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

    +
  • OptionalpermissionGrantId?: string
  • Optionalprotocol?: string
  • OptionalprotocolPath?: string
  • OptionalprotocolRole?: string
  • Optionalpublished?: boolean
  • Optionalrecipient?: string
  • OptionalrecordId?: string
  • Optionalschema?: string
  • Optionalsigner?: Signer

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

    +
  • Optionaltags?: RecordsWriteTags

Settings

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

Type Alias RecordsWriteTagValue

RecordsWriteTagValue:
    | string
    | number
    | boolean
    | string[]
    | number[]

Settings

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

Type Alias RecordsWriteTags

RecordsWriteTags: {
    [property: string]: RecordsWriteTagValue;
}

Settings

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

Type Alias SubscriptionReply

SubscriptionReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Settings

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

Type Alias UnionMessageReply

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

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

+

Type declaration

  • Optionalcursor?: PaginationCursor

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

    +
  • Optionalentries?:
        | QueryResultEntry[]
        | ProtocolsConfigureMessage[]
        | MessagesGetReplyEntry[]
        | string[]

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

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

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

    +
  • Optionalsubscription?: MessageSubscription

    A subscription object if a subscription was requested.

    +

Settings

Member Visibility
\ No newline at end of file