From fe6a42af507e280c3edc41f232db9978972633c0 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Fri, 23 Aug 2024 16:52:00 +0000 Subject: [PATCH] 2024-08-23T16:52:00+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 | 1448 +++++++++++++++++++++ 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/HdKey.html | 14 + classes/Jws.html | 18 + classes/Message.html | 46 + classes/MessageStoreLevel.html | 26 + classes/MessagesQuery.html | 17 + classes/MessagesRead.html | 17 + classes/MessagesSubscribe.html | 19 + classes/PermissionGrant.html | 23 + classes/PermissionRequest.html | 16 + classes/PermissionsProtocol.html | 32 + classes/Poller.html | 12 + classes/PrivateKeySigner.html | 17 + classes/Protocols.html | 7 + classes/ProtocolsConfigure.html | 17 + classes/ProtocolsQuery.html | 19 + classes/Records.html | 66 + classes/RecordsDelete.html | 21 + classes/RecordsQuery.html | 21 + classes/RecordsRead.html | 22 + classes/RecordsSubscribe.html | 21 + classes/RecordsWrite.html | 87 ++ classes/ResumableTaskStoreLevel.html | 41 + classes/Secp256k1.html | 27 + classes/Secp256r1.html | 20 + classes/TestDataGenerator.html | 60 + classes/Time.html | 24 + enums/DateSort.html | 5 + enums/DwnErrorCode.html | 149 +++ enums/DwnInterfaceName.html | 4 + enums/DwnMethodName.html | 7 + 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 | 139 ++ 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/DataEncodedRecordsWriteMessage.html | 3 + 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/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/MessagesFilter.html | 2 + types/MessagesPermissionScope.html | 1 + types/MessagesQueryMessage.html | 1 + types/MessagesQueryOptions.html | 1 + types/MessagesQueryReply.html | 1 + types/MessagesReadMessage.html | 1 + types/MessagesReadOptions.html | 1 + types/MessagesReadReply.html | 1 + types/MessagesReadReplyEntry.html | 1 + types/MessagesSubscribeDescriptor.html | 1 + types/MessagesSubscribeMessage.html | 1 + types/MessagesSubscribeOptions.html | 1 + types/MessagesSubscribeReply.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 | 12 + 148 files changed, 3088 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/HdKey.html create mode 100644 classes/Jws.html create mode 100644 classes/Message.html create mode 100644 classes/MessageStoreLevel.html create mode 100644 classes/MessagesQuery.html create mode 100644 classes/MessagesRead.html create mode 100644 classes/MessagesSubscribe.html create mode 100644 classes/PermissionGrant.html create mode 100644 classes/PermissionRequest.html create mode 100644 classes/PermissionsProtocol.html create mode 100644 classes/Poller.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/DataEncodedRecordsWriteMessage.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/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/MessagesFilter.html create mode 100644 types/MessagesPermissionScope.html create mode 100644 types/MessagesQueryMessage.html create mode 100644 types/MessagesQueryOptions.html create mode 100644 types/MessagesQueryReply.html create mode 100644 types/MessagesReadMessage.html create mode 100644 types/MessagesReadOptions.html create mode 100644 types/MessagesReadReply.html create mode 100644 types/MessagesReadReplyEntry.html create mode 100644 types/MessagesSubscribeDescriptor.html create mode 100644 types/MessagesSubscribeMessage.html create mode 100644 types/MessagesSubscribeOptions.html create mode 100644 types/MessagesSubscribeReply.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..21a5d74d2 --- /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 Pe=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?Pe(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&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").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)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}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")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(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 Be(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 je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!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&&(qe=!0,F="touchstart",ye="touchmove",N="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(N,()=>{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(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,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.href.includes("#")&&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 $e=new U;Object.defineProperty(window,"app",{value:$e});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..5958bcf4b --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WaTXPbNhCG/4vOnrr21G7rm0dynNhxrUpOe8jkAJMrCWMIUADQiqaT/94hRUkgsFgAV73vPiCWWHxRX/8bWfhhRzejCbMwV9qOzkYbZlejmxHIZm3OD7//srJrMTobvXFZj27++Hl2itzKO62VHqsagmhHIwmfpAW9YBX8xdYYZaCTpCewK1VHMCcxzriTld5tLFfyViyV5na19kmIJc57hN0ENH9nrX9erSB8MsQS501Br7kxXMmxkjVvQ6bNq+BVF+2jaXe8lfadT7iGCoMOxDjjVgi1vRXiBSST9p5Zp+OVYMaAOQ89Q97FpUsc8zpEjHlNxUyYZXOrNHyGdxBh+FBPkzSwdYzSaiRhK5HQrUzEjJU0lkmLxh7EBKOrQxTQKVT0naxUDUhwLyRi+1JBw3uNJLyDtHdrbi3oWPZDT5L4WS0jA2IgU5yP9SPswvjuZyruYWvCqIetoWKewBi2RAqoFzJiqSIILBk883cDGun/QM7hzIAhZe2qOZR582oqzV/jOTpZKN5pxrzXaM15hjzWDL43YEhab8njmalWVlUKeZeIiWQqIbDi3v9ORnZLFjzCbs6XEmV4Dpq2f1akNo5SVvxYyQVfNhoZCKEnixgZ6EOdIs2gUrpGetYLGbETEIAtoAM5gxPpi6tmUPCSdcQMBlGwviOD9q/mRHo6laaYZs1eBbww80bNlBEjxZ5Dtbm8un67CGlHKSNex+M1Gf8Cxrb7k3uQoJnFtgGBheTxNZLp9tesfdgplB929c4ubIi4vLpGFm6UcBCTAH8T4TOwDQSG2Q9Ob28TwBwXhXQXYJTmGnJBz12zJsnrfTnYVKcRH4UNqwmlhjYK6q9GDghbhobB2GHFAcTOKUPIbWX5O+y94xVUb20HhLP6292mPfzgNo/865+/X1xduqcgDczCB63WwQvecwNDithW334zX7sTZrDp3ONpd05b3Su8B4unJXRkM6dNinl0JJntiRzqfgvzsH0LkL4hSewOawu+DEgHIUU4nZg+yU0TdNKT82lTrTag7S4OPDiSzO8NEx+4sG4B9rCTlKR0czk3FiTCccUUCX+UvKfoFkNeRapgqJaxZrARQbIRS4r6CLvEkAgdGcwnZkFzJhDYQUpRnphky3Z+cCZuH4d5ktx9droxEPAcLZMzvPIcYMJbzzjFWe0+MlmLcMTFnZltGHwkD9Vc1umIOK/UJhjaEVsuvTtERKoG8xRxI0se5inioiUZOnKZ7RkokQLHUkJNJMCxlFDJ7h8NxcQ7aXUa27ly2cdD4QT2paSiRYFYi1tJvETfV8xPvE7fV8wnX+zQlWI/S3he4NOQI6UoU7bk0vtWsYeclHzGuNEmHAC+nuSFX0mCN4J58rndVWG7CY1jj5Z8an9lSHMdUwn5Xe2/EaXgri+fj647hevNFLRREnu49udkdHRjn7+jP9wATmDBJUfHdODIZaZyhdty6bNGwByCvY8n59Je2uAYqxNzSaeb2fj0TnnL24lM8FFjeQuRKT5qzG6h25bgEzLmKeOm8lKygxsGpfJRsocbBqGLHWJJUrtP5NjUcBBSBKqjJf3rn7m9sED3Ur6e4s2YXMK4va7RyGw1VLNY+PBzpCSlu0LKOEJFjXkt9J9IIsMa8xRxI+8a82RyEwsA7spkUxWOWEqodCJKxr4bglZ2YCgmojWFuzLZxMEvdBQw6bQWnPqcCCqp2Wc+/1tdfN2OO0vboBNceibzw+hUl57I/DAq6WXnMffyPZl1z1XCprNdcvfvhtBZdi0l1Be2/IeJhnzYg6eQSz5qq6d47tKFjoLAkCJ+kVxJ6k45MKSIrLErkLb9f6CTw0Uju//6mXNXH7Kuf3Mw8AOqxsIXKcCY21elLdQYDvMF2G//A6ajbiunKgAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 000000000..a3715e1da --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8S9XZPbOJLv/V3svfTUFPHOufPYPbM9vf1y2t2z8UTHxoQs0WWNVVKNRNldu7Hf/QkCpAQk/yCTFH3OVbtLQGaSTLzlLwH8z4vj4cvpxZ9++58Xn7b7zYs/ifvSFlq8erFfPVYv/vTi7Zf9m8P+w/bhxasX5+PuxZ9e1M9P1emPl7/ffawfdy9evVjvVqdTdXrxpxcv/vdVJ81oLc1F1j/+0dQdFPTyUiaS9+rF0+pY7evEnKuS4l6oi47NdvNzdTrsPldHjqK7tPyI0rvWuozuutqv9vVfVzXrGe+S4rdprj5X+/pdfaxWjyzVafnbdD9Wp9PqoXpXH4685yYVbtO+WdUrvuq49AJv/D8Ow80ied2h8G1aj9Xp/Lh6v6t+WZ0+8R8bVptsidDXpvwNffztvq6OH1br6vTH7rfBnkHcK3eRdniq9qOSXralsN0XgzIq1rvDqRrX0RWbp2T19FTtN+NaLuXmqXmoal/kNK4pLjpP2b/O1fGZqy4tPE/hptpVdRWE/Pn5zZbxPlGVuW5SrY4cNwnFJihJh9VQZHuqq31voEp+u3V47QsbG2JT0waaPxlv6MsKP/M7gdP5/Wl93L7Pt9JI4su49MBztDZmVFaP25qlrS04W9FgBxcrGu/jhhUNd3OxJkZP11fVc4HwFZ7q7WHg+aJCg+6QDHUD7b4n8OVYi0/szCgceXU9nZwXiNUONlum4jtOK07qBnvzXdL3YVrmK5JOJP7p1g6pJ2usP0rsGp6DMlXdXYuPqxyZkW3323q72v3ncdub9WfVkzpzbKAfL/7SP1dPu2diS+/3kX45lf7XZijYrr+Hbzn98Vb3ANLGHIRYl1soVOEFHOhwm9d4l9ThKB9xltW5/ng4bv97lfSXo2bQavMsGf6oyGlAiWU/71XktG8cjM285FO9qs+naXrvLpXY6sdfcFv63eGY6U+bXxbqTi+imL2pNyq/pK7eHKtVXW14yu7SGqOKx5f01U/n97vt6eMkC+I6t9rQjhC/bB+rU716fGKaAarNsCSeZnUFRyZaoNitU62cyKHJFrJ26nQrq3d4wjWsmjvlGlY+NulCtcemXT+tHrZ7NCBcf7i1jyCSxrqIyKLctzsfT71xFGu5u5QdUzbSInfbeLE2qLIrOl0j/Tj/p4ln/Fydzrv6m319pAMk/XnSpKp1ltNftru6FwNIf1xokIilMceJzrrs7LdtOWyFd3EVjurRjrr+eMiMEkj9pfwCup+Oh/qwPuz42qMaizw7Z5DCb2HaOJW1J+fUP1erDV4ugBKzmk1TH01ae7/fJh01e1xoqUYKpHIbK7F62G3iyCrXgruk7hRjeK4826BlrWkw0XRT2lq32ZFzSD/UDLeouMgsp2+Hs3ybuhaYJf9dF7N9m1uLD5RcqnnlRHPbGHqImaPjiCkThkok6YZxc8ww5iA6xyrWiDZu38ThbbqlH/yASMMMXAOvtRewa7S5DXcbtNjiDW1KLC9r+4yIGscQZmwtK2pkHGH3czOjj3y7Rp1kqN9PC83p++Ml8b+v9ptdbsUDCi4VIstI5kbMwBPkHxsu6pZZzE1YxPUWbz0M/a/zagdtjX6Z9L1/3Fc/foASo18mSfx5tX+ooMTol+kS3zT05djvNdIfb/1YQNrYRyPW5caf44GmeuV13bWlOQrHctwOfK2+7Dyd+SjZm+HYU/h5uYhZJI8fN2ttnLr+GtLKWXn16g9/ys+r3XnKg991FeZqh9G1H32PSidS8U+3fsyerLEPmdiVo0yHY/3T8fBUHWsYFQT67kidceUjH7CR93Z7rNZg8jNoRFzpZitQYDarfTg0O0ErDEFn1Y4EoYf19vqiNoh3ComS52N+PTtU9OY+akz2aH819BwTl7RcYxhr2kFRMxa1bNNGVrU32TW4rJ1gIXNde4Otm+qDz0/p8yiulYmEJezLNcC3Y6ZeCyzV2IhEbhOLLJ3GEob1jvMEUH+EaWTA+5gho+x9siVe7zQruioLWXCqj+d1fe4l2Y9YEVebb8nNTnm1oxX+h2K6QdHDjLfHXwa+mP9tqVZ4FcZtgMG08Uf4+byr3lU9zpz+utRjxOK4D9IZmHHZf6v26+Pz00CfCJTe/SOpxTJgpOn822qNpvWDRlyrLGLB8bCb8OLv/tGWX0T3afvfk3S35Wfqvs3lgnZ+H5GacReeNTfx2U5yw8SQu1B5ujFjk7HV7zfY5CsvbtO/1auHSW2lLf//yGEa7d07EZPfh7c922qrf523x2rzy4wXcjHp7h9EzHQDR/u33e7w5de9n+vebC0UtoTN2aWrX/HCoCoqsthSlcpkL1Fje+fNoHO6+XPoRMKMKAHGcNlyk0LaqY0jmmYnCqQSEDECJSZpeLuqV9/s14dNtfm5Wh+Om5PfJYEfaLjwJL3fXCZAmaBev8DNO/OwxNHteX1Lc2x093A4buuPlBMMK76Lq3FN4G2SaSnr36t1P1I2YlRGwkL2faqev8nNm0cMo1XnW9SjVMGl3/q9rbgBoCLTSFgQMNBpgBKzNaAOo/f7bdJRuh4uNEdPPquxX+BmcogljtLDvqUzUieGlTOTJoCQmekSI+YwEiU4tgx89AHPnZdn2lYez4jLF1zIwebmww08wUR2wDOEQQ4GBM3gBkyzRqjBDTYNMgO2dUxiMNvODzAzg2fdpe7tNo01sMFue1IK3Jimgb7ihjyqIGE8jSpbbpnuYm4SVd780Rfr5/Rj/SMptFDfiKQy+0Vq9bw+ccAAfn9IhczvC4fM4fWD02zJLOkZ1owu6m+y56dV/XG+TW3tBe06Vuvt07Z/bgPDqLjqghad1h+rR7qHgmHOpd6CtoDYKsOSwQjrPO/xtb+d0baimgva0+xX6SehMcy5VlzYmnd9bMI0590QQJlrT2YXPM+k0Q3xM3tnzqxwuJ+eNiOc6OOZ9AGOk4+mEMz+jrnTBJhfcvxggdke/5fD8XE1o9tO6t5m09C0C3AN+vOSU62LvCmTrF9SnDTyOH8HSa+oyJwlwECoemp8euKLmxEhSoydHyLKqZ8WI0qkjM51DsfN4CiKzImqLWXJ+rCvq9+HB3RkSlxvKVvGQmdZY/ixswnWrOq6GVzmeE1Scyl7skkxY+Yw8mJY1pi0TVX7eruOjwn+cN6H5Jc/xj9P6oNer+vt5+oXf6bwm4/V+lM4l4I8cKbUrX3RkNix/ihneG7FfIorTLfjridgklmj7bBebel6lWPVpeKt1ojrYZCvm7SC17vdL/1zqVstf+wXGXQFXYi4+wvJgVGfMyL2ZVon86h9q2Ovjw67zLjCmBFcBxi0IzqiCbze6EQh5pvlPFheKveZ4LPELhOvB7v3+Ga74Zu+Pjw+netqSM7LpAw2tPkto+FpdTwNy49KTJbe2vZ29fDT+zfbzV+Oh8c/P9dRWmvuaVCNJbSTU3Y56kcOdk/1c5t0pHC8DacqYgeLYWxPR/wj3+X85x6X9bIrNziOB8Nyn8cv6RmqLgXn6+rmz1VD9x94alGdaRYYUaj8qSx5zegYlvq0+cP29Ift/mPVTI420/Wftg/x8dh59ZeCS2oPb5P92r/Cs6+axPufVs+7w6rf3eG3QKrcZlHsj/Xhb+9+/IFhxaXgjbrzmR54yygosdASe/IGUmTsTQG97MbGqdG8CTssh8Bu1h4e0Z1gRRN/AyeojtkRVVvKkqfcQY1jtiQVl7KGdI08S0A3eeM76bKR+3stRt9KWnUxf2lHvs1fj/3l4ajX0Mo3WBWvEN72LqmJpvKXH/kzntx1Aqmo4csErjblJju5A1qJluFjWUfVPJ3hAocoCaVmqnioOCpCqZkqwg0kDC2XgrO/SuaCkt5XGbqhBKvpp2L7Mj+daxhL6he4dbzNSBy9FKxv6TTIOKx3HDCC+qOY5VLnr9XI670UWOz1phLZr/dq6czXC/VOeL3X+gyWDG9DY1gycisaw5a46/85f2NX1Hj7pW4fDDIyh0cFYO7U4SGnd3ic4Cs+Vg/N5USwE8zpjurcqv7huHo/RXVb/vanjpaArCdeDfElrtrq9zpzo1lO8aXGrarzQ2pO9cjYOsW3M4Ns3reHRtsRxeTAvNV+9dBsaIrqkF4MFbl1bMjKHD0eD9mbYze9A0dHtN4NnTOM6o5lgvHf5TUPzNdZzobtY3U4924EGTXjUm0xS45VfXx+czj3r3saMyapeZM9UWT4bX/Q7oJM15/4w2J9wHF7IuvltdzQgD9051p9+PH9P6t1H0D1VV0KztX1IcsjqLIPoxyCp435bEnRufo256edJ998X3iJ60ywgAtAqGIOB4EKE5dPg1vV/vzoNY3fDVRcO/Q20/D1aV3tN9v9w5C4l6Bw1vbeNUE9nU1iGV9pUnqO1ksmHu9ZYfGb9DKfF5dna+6tFavj9nO1+em4/byqq799oYNY7/ebV4pQ4OhCsWdmbuQ5HOrvqude5tSg2ru4FtOA0WChL7k97N81eeeT3sIdqLy0VWCfAdemwU0Gsyy6lP+uotubGEaR2vPtimYM/76JTen6af9X/jwhWAcerS/vJSiLHyRYNqyx6SLWPIVR0fn6Llbj+cPAYw5PIxi6v6uefz1t9w///mnzYVwxKc3Tyh3FI22cAZyquT7Zd9Xz21z3EYYEUII7or+9pHefmEJfplXw0yCb8XjXwpk3IVWVa0O/2kJ2JB0h04jBHpBtgf9txf4K1+Kz9MbLoS/7/hT0y/BBlpxklU7GWI5Ko58TcezJHaZOealpQLFv7jBmyst9Oh7W1elE8/J7CnrlJmv6vNptG/CcyUe8aOqVm62pNfbbfV09HLd1fyzp6QQ1ONqJZ75pus7MM3a/Dfd15ES2ty0D8EmX1eaXw5+r9mSfURUvx6pnn+/yFDMWg9QI1moQqiSv9pvjEevzPyySnZsI41oe7MpuhdjAlpWo2Qw2Kiq//1LexEraVVf0E3dsfR1l2P/ty+n77ekElnNU8MtsteEn8kaP2nHdn/Vmu/l+e3pc1Ws64A2blJOwgHXbw/77w7H65eNq/+O+etclmf1wqN+dn54Ox3iHJMNUnrhb7L5sOwr/88Oh/vFLnCwzZGS+7iIW/XCofW5J00e9TvMLWVbB+nMte3PJw27KrCd90OG6t1v0/XlXbz+uTh9nWpWrP9eybzZC66L8du8H0jgEk7MF1Zit/XO1r7953NZ1dQzxxMYxnyoyWmRNGas+167ugijvk4mjdl1Qs5onhzjkrJwo7FabL4exJKr+struGI7GFLKYjf4Lhk/36377+LSrHqs9p0VMkTTX2r9W++q42v3ty+nv1XH7YVsd/1rVl6DFD4f6L4fzftxUtpjl7Gwb52UQmmEjEDHbvp7j+7988/tTc5TtuG1j1Re2iztzGq2+sF0/V58Pn+a/r2v15ez6tkshYM/teDKWs/B7f3zPDeb1BCxn23XS85fDkSyu+QZiKV/DSvbUjilk4fbxw6H+/6o67Bec20iIjLkW+vDq2wRatP3pqGGDVefa0/Xrz5fu/Nf9qZs9vjl+HrWKIWCubd/uN9Xv7SOGG9b8QRW/xPQuZ9Zw3eUseoduReMb9Y5zQdo0u2KR3+6/rx4Px2mWZQTcZFs79Pl/N8kx017ZQO0b/P5t1URoftqttvuQx9FuIuO2R5aIW+fDzWGrnccwbMpWW8KOW5YN+fo3WvbXqp7+fmilW9+O3xhzy+sZELDEl2t76PXhqZrx3VDtuVb91O5Unx5/Gap5qzXzYi9jtWdbVR0fmx7vsD9d+KJHV+1sPZys2nyOtmNkBxxukbz40/xc/etcnb7O87BkL/hEf61qr6TtVW55gLyoBe39ewvHAr39dV/9/lSt6+5WiTlmj0r8KtYfnqo33eFSPx0PH7fvm93W7fxgW1GKPfFJGNK/1lN1f2SvT2cI/Fq2k5b2y2o8YjJL5FewvwmFBGITqVriG4wJnv0sl5yld36r8697n3t+eFttzuvqde9ClKzpbDlfx9I0OXKelSOpkjMsvC5kz0dG6IAhYL5twWtSYrduIyhtFgDDQJ6Ur2Blc33XiR0ZnyBoUVu/3a8Px+aq8Lf9o0on2YoFfR1b3/SOZZxn6pvRYxpvtXQgu22qsaykt5n2vu12WDRHNfzcO2p8ksFZWQu/4RC6SQ8hn/hmUxFfwz5W6I4hYFHbvm+G4O3+of1Ah+Pmtm5qUN7Clv/e5IBxA1Y8GctauN3fbiGVsbCFfmZ5Yx8KpHwNK+llzXNsvMpY1MKffP1ddTot2NuPC130GZo5UHKwzyRjo9pf4c12fcibLnmx+ZS+d3nzcRVdOjzj/Y6LXvZ52j/e1ssCKYta2XzJrsXcNgPISFrU2uZI+AXmAEjMrXZer3m9TIVeN6m33+6n9mYcSV/B2ub7LWIsFbScrZeUnP/m91252otbFZZtbQv48cN8A/uCvpKtP36YsabmyfpKFocLUf9zW388nOs36T6YmYZjkV/J/l+fmiDZovZjkYvbf+nSf/wQ9M63G4la3t7Q/YTxfdJ6jCVqcXt/WT1MHNEGRSxnX7u0q07NdOlt9VR//Ob3dVVtZnUZg8IWtPmwq94efPjsm9+3p/p1/dft52o/aYLOlXaz1Z6J/7q/HPE84b2iqnPtaRlimCe9Tc7LfL3ffLvxj17tJ2Q6zpH4FayfsvGGLeYr2HlND9xv/NaUS6bZEuazpH+Fp2pmBW/x0a0zngJKu9Hqt5W/CuaHQxfQ+u5y83uTUcpZuU2RdLO1zXRlTg4OQ8CNtvnuKExB/uKPi76cltLk2nGDYxOFLWGzz3BZyORxWTda3E/cfXPYb7Y+WOD3VHRxg5bjc62fIff/ypM0OS6sbRJzpS7+FKGJdaN0B/YndeFThS7+DOEM7ONld9HCT8MVv/hzpdkutz9IVt7XsXxyvsxkcV/X7mbSvLDtROTN42t6RM6v+3fTkiP4cm60tIsC7NfVqT4c0wNIqodHTiB3kqgb7fWzziUXFlMELm/7jGXFqJTlrVxuUTFX+PLPNH9JwRV2o83ktCR6LtBkFDtb7ELP0fSwGW3sDOBZIpeY24ep+AVMhVnfhMzZabJutLjZhvBzVZ+P+yqk2z8xKO1w3QUsumG1ufx+mC7X/eYN9BMELWXrQr44Qd6tlodTzzItlRmwnibrRov9db2vr5cNX87DQkfTcE2fKvRrPcO804TmSv1aT9Ht+Ah7CNlbJGeLXeQ55neBA/WXsCyEyLpWlF4exrEM11/OsiYx+PV+0/zH7yGrz6vd7vmb39e784mzT32OxGWtf9OsjDbdSXSdvm/3tz3BuNTlnuKSBLPfJKvmBR5lguglnqf76HP6vn7dpSzyX3CuSaTyEjb9taq/2dfH5283v+431YftvtowD67gSlnIyh+qL9Wp9v83MSV5gqCFbP12v623q53/37lmZmQsYeG3j4/nOj414M3H1f5h4jA1IGQJG+ePUl9jfGplNm3w2/1Px+rz9nBmz8EHJSxoXXva6e1G5gQtaOvUYECm7pKeNmmFAmsuYc01Ne71hzpEoBiJXxwJS1jno2Kv95twdNKscSwrYgn7mkb/Oo3d/br/tD982c8Y1BjCFrZ5EVu/ho3dnt3LCipaVc3yAqbAr2L7bKTHF/d17f7hUH+7D+Pbu9wN8bc9yrCGr/J0zRU47RVBy3wXLPCr2N5m7jT5AzMXHGyRX8X+8GMzeZ+QWjhH4lzrwxDbajkcX29CksZq100+J2SnT5O1kMVNHIcTRcxWW8iO8L/sNclY7YWs+nVffV7tzqvrUSI3fNAxYbNtrtZPQptPRTiI9u+sdK9MpRttOM6xgVaaa8Mv28dmpH584qa8gQpzdf963EW73H5oDhHYsTqrgYrL2tKsiGda01a9wZ5L+5z2ZnC1SXYkNzVcTqn9YdW7EIn+7I1ItQ2e3cYR9zIqnH2K1MjhvHuW0rj0LVrbcZWl81p2ssbki4WDe/Hnuv7G/VaX7RCjwl7GRbOPEFkH9XngPq6rKzZbz88VmmBTNT8P3brN0OInVONqumKz9eRCC1TReABhTNMFQo8ri4tO1BddoRMCWP1Lb9q/D/pxcsfS+9WpMurX4+6XzE3CscSXoDR+hs6+ca2Zm3dzakdu3x3T2xj9y+HPnbwRtf3St2h9Vx/jg+SHVF6K3qKP9WZJ0Vn6Dr42y4Fo0Vn6Tv7tsD8jKn6b3vHnpEW5+riXWyXKOHdb9VXF3Unv/oyewl4Jfhfz1GwCYQp82RXGT9G3M6Mzcy1gRunIJYGDWo0oVHTJW+b+vYziR3ANX33a/GF7+sN2/7E6tltL5lhySrnSiCGnPktayI5VGuodsWPVj+ku+D5gHJHxZrLRwdm2xb5aH/727scfuPZcSi9hRXoBd6/sjz48d+3qwj3IuWKDPQLjOu5BuWO3cmdtjzq8+C4/0jz4FtyBpsIxZOTy6bYnuEQS5lgGZCxq4wefYTnJHTrTrlUXtejpcviqz1bvXbXOsg0JudnKdK7eBrrRMN7+xB9OV9VJaPOmPraVx4S+BBWyc4TO0DHd7e5evu5rhbm6q/W2Ol2ijdyHz9Vaxgrua8jVmmJFOpxtT988NRnDx9Xuu+q5uRHwWJ1O4CJZaspAxQnWTJinJtqZU9W+QtSccicdgxLcwM7rzl+ZIl/GFcYe52ov1P1N4iRcA3q15lhBZwLX0t/un8416VXJr7eO+0jc2HBPDcyMD6ueh4yqvFuNnntNaw+PUduQ5tamO/+9StrJuDmZ6ktY9ql6nmBIKL2QXlKBzilG7AC1Z9pFHf+7nnBiWb/Are6fkTjWAoClmde9IZtMJum/A7W5Bo1N3rpLL3vTthGT0opLWzPTluUsyXVaI5aM91ssS6KJa5z/0BvZ4x9vjQX1ZI2EgRLDpkWA+qpGgj98XX85Hh7Z+trC83U+XBLSGTqvhf8gbtK6PcVZ2wzNaYUbtYdXFyXSsV93WudWC0jeGNuKfr2bvv/ET9GvMV/7Z3892Df/Oq922/r5xw80V34LAuR9i3hSbnpH4cPHUYvBFxQXn6/3Q1WvP4ZdGNP60Jf5mjda0375OebgqtPs4UXJ+wagAPl0fZkYdF8dCD9P1zYaae7rHQwyT7fg8AWF/vtqu3I368om6Y7oZqfe8mzZnnwPu/nzc3peHmucylZdxqIky36SQbTmrb7Jco2RKPcc33jH1Z2pNsmSdEY9YRBYLTICZJhOXx3AOVN1VWFO/+758bGqj9v1dY4fr2byJozVn29Z40RMX7tZT7s3hKnuWnoRrRPaNa71f30d8P9yFXDbDLyLIPuboVnTTFBlvv5Ltv/kISZfcwFrprphtuJEW9LwWbINDsJjUOLWAFpO5FgEDRmbGUCOvdtAWKrvjqN3fyAJI4EqurGUZ8rT2J7S+ZYkR4lPs2bw3PD5FiUX+kyzaPA2n+kWndJNtzxbTsP7badbUa8euA2xs6GtspQFx3a71PQG1FVbzEd81f6Bc0w36dVeyq7Nqp7qJ22VJS14s536Rq61lrQjudaGb8jgfTazLOl2WE43Jqq5lD0jWUJjRrEThGa0qu5476ntKaq35Ff7aaY9tO6SPk3uluV79chdsjNGJZT9Njoq8RfizHeCzy1lvhfeOaXTrVpdUUEIPUwdOaGApayrBun0mGn92ou1/5FMvNF+gJ2Ex7KNLkzeXKAbXpb0fr91UYIFji1J+mYOTqfCS/ieRNMZBtzh+kyjpk9kho0ZnMbM0Q472nEbRrrZqZbkhsRhQ8YHxKl2gMn/sAmDU/+p2kemLMOWsCcsM7wkO0UYdRTGBGGqPXBAHjZkZDie/EaGBuORV8IbiqdaNDoQD1s1YRieatnwIDxsFncIntzb5EMfIx0OJ/DBsMZE7+f3an1uzpJqbnF+/d5f9HCx6cN57y86PP0RFRtO1I2Sk/72pR/6/duX4XGbBs6/2/aD5p2Ml5ff8Rtp9OclB497OyI/LjVZS0ieyCehXBT1C07Wtama3YM/7VbbfdgqmuO8F6UDNSZrr36vj6t1Pfg2kzKTNcTpOXm3ekmL3aSHp4aphZuPf9XBSMSnD9JLlf1+VVfH7YqGoqNfFkiOTUQxsmIvRuWzj1HCKVJz92ksx/RSazTj+afVlo7vA1rb0jP0zn+pnd5W5h/ymwn6BlxsHsyu/duXTzNNuYsFTDVqdOT09xLdYlws4XbraEv7KWfg9YeRYY/Iy3yMy9/ZgzBdenbdTPt3/mD8uT1e7W+nNs98NSjzJSyP33xn49hgPawwLjZXzxswgFElQ5H0EQ3rw2NTdFRLUm6eppBTGx/jP6ISVrhBd37aA/SOT33Gv13IyeT4+0tQeq7WH3ebCVpp6Vlat6fG+JHWcC00U0dj6qiOrtBMHcxcQKJ0Yhog24rhBI2MEbzkDF6/8H0uEDPUSYBKs2zo+utrVp+ffI424MF6XEu4k2PyAsYnyH1V6FCV5FAtosv/eOv2mZ4s5ikq3rBp22f6qphnp1Bd045Nuaqbe2LKsP6Rw1Ku6meekzKsfeSIlKv2maejjD8762CU9C3cdCbKkOeNHIdytWLmSSg93fgQlKbY8PknUYlbl7k5kdxTT2Jjh+Pw/fyOEd13SUW2GXPi3WOWME9e4VvBPHRl5M3wz1vhW8Y92CRn2vQzTYZtA8NaeiYlbab+16UGtqsw5sgWbJs3tEXKmGNbT9u0wS1SOHd0G7FgZHiLDJg5vo3oHxngIv0zRzjG87OGOPImbhrjBn1wZJCL7Jg5yvW142Eu3D0/OM7FRZYa6HoyuSNdYu+cwSWnmTu6JPVvOS8rawj3rKwJlqzPx1Pv1JFRQy61FrODOeBmLZo84k6wjTvkZo2bPuYOW0eb7K/75uqYUPXn6mlHT6ro/T48/Ore0ePv6kO0Ht92x2pfHt3/zh/TD0/VniXtZVty8GUF43JD+u5w4ln+sis6X1lM/AdVDeF9jqKHiqkoFJyv6F/JVG5Q1b8GjxjnKNukp3IPatsMn8zNc41qdeS6Rig6TVmmHdExNaOZM672BreIuDLEvrxUGX8wMLJGU/+f0h6uN30hv986/UfiRhYA1MLMSwSIBCobWPMyNT00P4K5L1R3LXy7zor5Pq+Fb9LZBGl9AXAEIdSbVrhNd3tnN8JQWHdS4Sbdx+pf5+pUg923UHNc/Ob3/c3vT9sj2AGbfd/XCje+7zbfj/u2r8Vv0ntaH56YXt0VvUnf+rAPN2cxX3FSfrJm2M/+HPxlQH9bYrm+NhbI7m07O+f0t4lCVo87oq1tZCDikVEaV7hRN68vSrRP641G9Y+3TaKd3zpHdI+1z0Qvt4WO6GS10UTxpFYKtMN2eupd99u34lKGP9k7H7dsgS9D4bEnulo63HqSTd2jutNKN9vgJyXTLIirLPAOPh/WPk1l6msg9W62xN81vx3pTogVSZ05FvTHi/FxiNhAat1sRQjFTzaDVlvIjrHlD7RieHfEjHfR+dr01xHVvNmaS4oGTtvL2tKrd7Ml/rS6iZ8mqXOzBU2WYDOuNRsl4kGk2Ww3oSsblnKzlR9XlyLvRoZsYhmoOccabkJO3o8ZyTkjnWw8jIc02u+q50wmKC0wOICzHw4J5T0ZtZeV6T6sdzjTnauxf3TxsNbxM4sHNI8fNYaVDh43NvSkicvQizOvOttf+Csyf8R29Xq/+Xbvd8r4NOzkFLYxNS95InKP3D3LHCdOzOB5b18dfLX9SzZ7Wi9Fbl7+Yolj69++qdNyDnJqRxIPhvXysg9yqqemIEyxJZOHkDNlYjLCFEsyGQk5SyamJUx9J4O5CUNvZ1aCAt9rM1kKOYsmpiqM2EH3wNDCOGkhW+7WzIVhwWPpC3nz55FyljV8XJ4XN7ZpvLc6nWIfZ6E60zKYA8KzaiQRZK5FY/kFPOP4SQZT7ETDL87vS39ebNhlZ/gR82YOt/wcP56+fXet/F987g5Lcb/OLRZczvNk6Y5LT9U6cXpxQ3Yj14axacX8/EauBWPTifkZjlPeAW8asUSOI88nx6YP87McB/Rnpg0DeY6wzGLThcmZjtjkG6cJt2fUYVGcBMjJNn2Y0iEuMR2YmxM6xxL2NGCBPEOuff07n3qNtv07f8Dfnjh3jXQbHqdcLjIQfH09eNHHJbr6mnXNRz5cgy/9TLRsRu74HNFxCaR8Vz2/vdzABmFUonaw3sKW/Hra7h/eXs5NO5Hb5Sbal5X2NazuGkbzhwXMhuK+pt3t+cMLmk4lfg3rA+lZwk+opJntuImZXgO+Yw26V3qW1g57vd6vq1N9OH5XPb/eb95Wp3W17z/t6ftVvR5p8zMlzu1jf/JFW3/xJ4J96B+mnet5RyrPsmls8ZXYwF11jejcnt7Vq2N9+s9t/ZGjFpafpfn9ebvb/LJ6GLn+IqjtF57brj9Xx/qX1cOJ87Co+C16J+i8TV/Xkt4mBxr+XH2omvrb1e7bfV09HLf1SF8xSc4sS08fD+fdpuu8X2cX/4lZ+UqzbAjT9G/36915U50uZ2JyZpAvR+suYNGv+6cbbIK153nxav9TdfxwOD6+9dsZXj+stvvufr8Rrx6peoPv/LnpGtKHDFeVcFobV8SC9gV3nW8cqc+1jAtC8exl0iIDLMPepntliLLw660x2L4w3u27rW3TIrBAGe/+3RFtzEuhEr0Tb4UatuASUR27gyk2AVWaaMOkizVj3VODsUwLhi8YjA2YGIpl6h++6rP/8r/G83NuwqRvYlYYluWZw1cRxnZMDMLmtcNLwUK5wVvBkiK3RmCzMpn3gqX2ZhOFh641yupm32uUSljicpi8TVNvh5li2/jFXHm7ptzMNcWmoUtQ8tbwbkGZ9m7O+xkvJVRazArOZSx5c6bdxjJmV38iBM9Qi35baBLEPUEttmrWBIh9fhpDE3vqQQ8SmzDxmHd8W0/vzEnHrMPbesrnTThmHd2WeeHLPzdnqrHAuW0MLxyeZsw+tS2nGU4x8me29QssNL2YemIbsHQKPB3WOkZOQe0lphQ3n4822a6hoXvm6XGTbWDeeHX7CW3TLRudbGWNmjDV4tvDmVrkLJo2sWAfYteWf3d+3+y9fZ8dui4FFppgpPJ4s4yrkbOmGkQlb74xqpM96SDqJ888oCWTph/EgplzEIYdwxMRYsa82QjDiuEpCfwcX+ldcCYn4K3cMkMZ9dvhaQqxZt5cBdsAJyyXooOzFlpqoakLFMucv/QMv2kCMWTJ5FlET9iMHDWOXby51kRrhiY2g9bwZjcTrRmfSAzaNGU2MdEyzpRi0LZp8wqGddHk4l21fhLafCp63czlF/50omPJKEElFfcyLYof6Gpbbvritw5+Vz3/cohviMmo7JWeq/WSV8NT2yt+09P+7cunXw5/fq4BOILPm5S/7YknqAYVZuqGm2WJusFdsqMawp1zow7blZqp5aHaV8fgB8n1Whl1/eLL6P159WWi6lBjtvZ2fy+jSyBlb9XIaJqkLF8jl7QTfRzWjtSBDvuY7bCPy3bYx+kd9vHGDvs4q8Me0Mrtvo5zu6+87qHu6zih+8prGO6+jpO6r7wWZvd1nNd95fW+b17/L4c/bx++BUelEK20MF/nxAZ9nN6g00eMDmIl53hEh6QyDvAYOEMDCxo5PGPqkRkZJeNnZUw4ISOjY7jVUPFRB3o41m+3x2qdbAWu9ufH0x+T34Zf/PUDhuzlzXb/MCrtZVI2Y3piH9T4mq/w9Xx90aDTLGh7baH5I3+oOe2qqn+P10XGy+53bKQ3ICP5cbvfPq5270YUkGLT9TQ3Hp6PTcH8vWRXdbj0dK0hBsrR2C85V9uPHz6cKtZT5spP19zNLzhaUVmWRm43Hz0go4cnSuKG02wS8odV/0f1ueofuJj+PNiYuKYDkayHIJZmRoC135/PVRqK3qLv/e6w/nRKzvof0pkUn6g3fx/AkMbB6wB4utILAQZf6eB9ADxt8Y0AQ7qGLgTgaYqvBBjSNHQjAE8TOaZ/SNnIKf3cLxaf0z/8xYaO6c+3gagL+eZzta//4/CAe5Dk10U6kL5EVv+RmplpzufddvOXVSOnv2ABetPiN+jdNmnTHI1dwWm6xrsOoGqw52Bpwh0H+n6D/QZTF3J5qGvI41m6Vk9P1b5P4YCyS8kbtPlbQnzJflwAqEyL36D3oar5WuPCN+gMvV+Q9OdndPs20I0qTWyL/Sv5BiZFvRL8RYbfQwiPzxgW/hJVxM/Yt396F5sxYsI1vrNnannVQ5M1ttaB+VruzY9P2djacTefUTzc1Q/pHO/uMyrZd0fN6PZzH5Z9hdTkuVxGI/eCp/FOmauRf8/TnFlkRumE654mz8czKrl3dM0YyLPew71laqjL/7k6nR9X73fVL6vTp4GOP1NukVntkGzmHkj8EDno/36aCb78IpozHf/YCxjq/sctGO8SB/UPdowTtePucfjxBzvJifqP1cMWXugyaEJUaxErHo6riR7Y1ljoHcAsusHnXw1lFU/SXv1eo/XDoP5LnUUsyAwlwz3A8IAyuRWgbn6kFQx19oxeiAYtvnnc1nV1fFcfq1X/lPV+keXCF32x/BhGanWOZmSTsXP64xq3as+HGIDi8TgDS+dAsAG97fGIA0tr9bjtT49yStvCs3SSoxir4+mwv14Q0h53F/56a0prLGb0gMXWkNwsY0t3cgDhd5vhi8p8+eEUxpQs5zWN3MzA1ZVkGAxqG0wuyOqb95E6fa28PxRMxRc7c5mrvXQlvgl3T6P5S9iY0WzaLgNmllFx7QWtwidjAovGzsLMOmLMvKtT3QTo/xpSWRAlpCX4gaouP4Z2NMOiX/arZYhkz/YxO8YvshgzCUlY2jp8zjfXsv8zGCeYbJXPxn6D9zONmJRWXcieNv8bn2E6YhCpu/B3ay93uZxONcvEMWEL2dwc9HeLmaD+st93VhsgdZe1KL8zkWfVu9Gp8VzLMmdS8cx6O7wgm2xTGy6b9wFp5YVtmv0JkYCFbYPnaTDN+nkorDDZou4YQnyT4YhJtPLXsOldtyXxJuNiKTdaeVztN4fHi8B39THOWhwxLld5GZvmmLKoBTgVfdCA4WT0ifrfvD8c331cCW0QCB60g1ZdxB6U4D1oxVCS90TdA1mHQxYwEhC5doRMyrfbzc/V6bA71/4WzdN5x34nQwIW6mvebjdNQv+8NQutPN0mdvZm5gVxUjkH1Cc3Dx12O3SNi/8zP2P/6bDb/VzVx2ecvByJe9krmlnaBsMG9DU+ewDQkSq7lmNqSrHmYbf7dV9vd+/O63V1Ov145OrN1WJawb4NMlLLugqy/7i9mGF6EXvjR/1YRb/MAvHEjFBGdBGYnIs1druQp6q/i2tOMGR0W3Uz4XxCF7oxLIrrLmfTKbmimGvNiXk9Md+O9WG/2cL7g0aNSareZFG+gfjwx2DzuJRYrnGkIvlN42rsDY4IlU90w6uM4Y9/DB8FBewHrYnrLWVLs0vjm9+ftscq74mZd5PUXMye0U4s96X4XRjXluHOAtvB7Sq4NjA6CmzIpG5iwJqhUfTzYe3XoyMDaVxsybG0J3fKcJrYftMIljNj8iCWCJrwId4N+qn/dQR84HvuRjTgUjd/4AGx3NvuqOHZbNR23+p0E+7iupOMGT0ksf54yF3jNmTQpeKN1lBn6AJ1w86QKXWrMwyJHXOGnOETnYFhAsMZclJmOAPHoBFnmGdNdwLTDHuiqjdalDn7bNg7caFbnXNAKvPgsxtdc9wAhmdmhMxwTIY5I345y5aMWzKsGfXKWfase/eXsQ1ac28vm/eGkhsfJ78lzr2Po3Y5MH15081Uw1E/K3Dsw3Dh4XCeifqKf523x2hpwRb+Mqo6No+DjwPt+el4+Lh9v61nWZRUvtGm/NTyzfjy41pkubk9kcmf10f2DiZzrQbn9Fj9XVqVb8qlGfzXq3YH1J/+pzkVqCn14k8vxJ28K1+8evFhW+02pxd/+i2Y+urF+vD4WHmEsjmsz/6f/9UW+3vVxEKbwqH0H+9fvPrt/pVRd0bo//qvV791lf0P/g+djOtffMXixavfilfC3knhkopFr2KRVBQvXv0mkEbRqyiSivLFq9/kK13e6cImFWWvokwqqhevflOooupVVElF/eLVbxpV1L2KOqloXrz6zaCKplfRJBXti1e/WVTR9irapKJ78eo3hyq6XkWXVCxzGstexTJ1gMYfyldK3QltUg/o+05BnMd7z/0rJe6Mlmll4D+pAxWNWxQFsrno+1CROlHRuEYhYOW+HxWpIxWNexTQB4u+LxWpMxWNixTQD4u+PxWpQxWNmxT6lbJ3wpZp5b5PFalTFY2rFAa1uaLvV0XqWIXLNvS+axWpbxVlruUVfe8qUvcSjccU9pU2d4UWaUfR9y+R+pfw/gXbg+j7lyAdlMg5tgBdVOpeQmYdW/TdS6TuJbx7lbBv7LuXSN1LNA4j7l/p4s5I8r767iVS9xImb3bfvUTqXsLmPET0vUuk3iUahxEFfOS+e4nUvUSZVdx3L5G6l2wcRgj0xLLvXjJ1L9k4jJDIatl3L5m6l/QDoIKV+/4lyRjYeIzQsDIYBlP/kir3vmTfvWTqXtK7l3ml5Z2RaQck++4lU/eSjcMICyv33Uum7iUbjxEOPnLfv2TqXzLbe8m+e8nUvWTjMQI2R9n3L5n6l2o8RsKZler7l0r9S2UnV6rvXip1L9U4jCxQv6n67qVS91J+jiXQh1J991JkmtV4jJSv1P3dvSZmg5lW6l+q8RgJW4Xq+5dK/UuZbN+n+v6lUv9SNtv3qb5/qdS/VNa/VN+/VOpfqvEYCeeXqu9fKvUvfZ9TrPvupVP30o3HSINcRPf9S6f+pb1/wRmj7vuXTv1Le/+CbVn3/Uun/qW9f8H2qPv+pclUXmffF5jMp+6lG4dR92jypfvupVP30o3DqAJW7ruXTt1LNx6jxCvl7rQs0sp9/9Kpf+ky2x5137906l+mcRkFhzjTdzCTOphpXEbBxmz6DmZSBzONyyg4xJm+g5nUwYzMfWbT9y+T+pfx60TYLEzfv0zqX0Zn5xOm72CGLBe9g8G5rgErxtTBjHcw2KZM38FM6mDGOxhsU6bvYCZ1MNO4jIZjnOk7mEkdzGY7MNv3L5v6ly2yDdL2/cum/mVFtkHavn/Z1L+szLYp23cwmzqYbVxGw6HZ9h3Mpg5mfTACBk5s38Fs6mDWZF92378sCUnY7OTNgqhE6l/WZaeNtu9fNvUv6/0L9kG271829S/XuIyGfZDrO5hLHcxlJ2Cu718u9S/XeIzWr1R5V5r0K7u+f7nUv1y2/3J993KpeznvXnCZ7/ru5VL3ct69LKzcdy+XupdrPEbDLsj1/cul/uUaj9GwC3J9/3Ik7JWdfzkQ+ErdyzUOY2D35fru5VL3KhuHMXDhWvbdq0zdq2w8xsC2XPb9q0z9qxS5Ry777lWm7lXK7BBX9v2rTP2rbDzGwOZY9v2rTP2rbDzGwOZY9v2rTP2rzHZfZd+9ytS9ysZhDJxOlH33KlP3KhuPMTCSW/b9qySR1TI7Uy5BcJVGV++zk/TwW1o9+ltb3/sYbNDhN1qfBFnvs24WfqLVSZj1XmaH6PAbrU8irfcqO0qH32h9Emy919mBOvxG65N4670P4Tv8+kHE9Z6EXO+928FeLfxG65Oo630+7HoP4q73JPB6X2YXDuE3Wp94n4/X23s0bhcovN+L7zfeZGH3WMAIP/E+H7W3sIcsUJCfRvmL7DhaoDA/jfP70L2FXV2BIv001F9kV5sFivXTYL+P31vYWRYo3E/j/UU2IluggD+N+PsovtXQ91HQn0b9fSTfYt6AAv8k8l/4YL7FXReI/Rck+F/4eL6F05EChP8LEv8vRL7rAwSgIAig8FF9i5s+gAAFoQCFD+w7OC8pAAcoCAgofGzfFbDtAhRQEBZQiOxoWwAYUBAaUPgIv8NNFwCBghCBwgf5HW57gAkUBAoUPtDvcOMBXKAgYKCQ2YVpAchAQdBA4aP9mZ4XwIGC0IHCB/wdnK8UgA8UBBAUPubvcOMDiKAgjKDwcX+HGx/ABAXhBIUP/Tvc+AApKAgqKHz03+HWA2BBQWhBIfN9H8AFBeEFhWcAJQwlFwAZFIQZFB4DlBhOA2pQEGxQeBJQ4tYDwEFByEHhaUCJWw+ABwWhB4UHAiVuPYAfFAQgFJ4JlNh9AUIoCEMoPBYosfsCilAQjFB4MlBi9wUgoSAkoVD5zg+ghIKwhELlgyUFoAkFwQmFysdLCkAUCoIUCk8JStz6AFQoCFUoPCkocesDYKEgZKHQ+bQggBYKwhYKjwsyqwZAFwqCFwpPDDKrBgAYCkIYCp1HWAVgDAWBDIUHBzj2UwDOUBDQUOjA4fHYD1hDQWBDoQPMwhNvwBsKAhwKzxCKe9wBAeZQEOhQ6CyULwB1KAh2KDxJKO5xBwbIQ0HQQ2HyHgjYQ0HgQ2EGPBDgh4Lwh8IMeCBAEAVhEEWAEHj6AChEQTBE4clCca9gDwJIREFQRGGCC0IsWQAaURAcUZjggjBoUgAiURAkUXjKkJm/AihRECpReNBQ3OMxAICJgpCJIqCJe5g+VAA6URA8UdiQ3lbCRwCEoiCIorB5iF8ASFEQSlEMYIoCcIqCgIrCs4fM8h+gioKwisLjB5xHUABaURBcUQReUdzjFwCckDCLwmOIosD9IMAWBeEWhc3HXwC4KAi5KDyMKArcjQJ4URB6UXggUWRyDQHAKAjBKPIIowAMoyAQo/BcIjORARijIByjCCCjSXcEXxCwjILAjMLziaLA/RDgGQUBGoXLZywVAGkUhGkULvggnooCrFEQrlF4VJEJowCyURC0UQS2UeB+DOCNgvCNwgUnxLNBgDgKwjiKMr8UBpCjIJSj8OCiKEr4BgDoKAjpKALqEHg6BGhHQXBHUYZsX9wNAOJREORReIpRCPFKmjtTkkxlQD0Kgj0KTzKy7wC4IUEfhccZuBsA8KMg9KMo7ZB+4IWEgBQeahQ42bEAEKQgFKTwYKPACY8FACEFISHCk40CJz0KgEIEQSHCo41CwJYsAAsRhIWIwEIEbIkC0BBBaIi4l3k3EgCHCIJDxH3wQ9iUBeAhgvAQ4flGIcpXSt4pQfOpQYIwASLCA45C3sO8aEBEBCEiwhOOQsJ5nQBIRBAkIjzjwCk2AjARQZiI8IyjkOKVtHdFQeqDhGHCRIRnHEUzq9J3hSFvAEARQaCICLsepMICUF468cOw80FqLAD4IcEiImARiVsCACOCgBFRZFOIBeAignARUeSpnABgRBAwIjzowOtrAcCIIGBEBDCCmawAaEQQNCI86sA5mwKgEUHQiCgGfBCgEUE3RYRdEdLBN4D2RdCNEWFnhCyxAOCDvc0RIre3ScDtEcQDPezIbK4A/kd3SIQtEnijAtojQTdJiLAJB65sBNonQTdKBDiicC+G9krQzRJhtwRe4Qu0YYLumPC8A28FEmjPBN00EXZN4NROgTZOEEAi8oBEAEAiCCARcmBxLAAhEYSQCE88CpxeKgAiEQSRCJmFwwIQEkEIiQjbKHIPAJyQIBIhgxPiXgQwEkEYiQiMBFcHLkgQifDMA7dBgEgEQSQi7KnI7HECDkgQiZDBAXEfAhiJIIxEeOZRKNyLA0giCCQRYX+FgtkdAlASQSiJUMEFS2wBcEGCSYTHHrleAHASQTiJ8Nwj0wsATiIIJxGeexQ4eVcAUCIIKBF5UCIAKBEElIgASvB2NQBKBAElImy80HjnGCAlgpAS4clHgRNqBUAlgqASEXZg4PRUAViJIKxEBFaS6QYALRGElghPPwqc4yoALhEElwiPPwqNV1aAlwjCS4QOXojnkwCYCAJMRNiWgfNOBSAmghATEYgJzj0VgJgIQkxEICaZpRkgJoIQExGISWZOCYiJIMREBGKCM2AFYCaCMBMRmAnOZBWAmQjCTERgJjibVQBqIgg1EZ6CFDijVQBsIgg2EWHfBk4uFYCbCMJNhMkvTAA2EQSbiIBNcH6qANhEEGwiAjYxuDEDbCIINhEBmxjclAA2EQSbCI9BCpzxKQA3EYSbiMBNDG5KgJsIwk1E4CYGj4qAmwjCTUTgJhY7MuAmgnAT4TlIgfMOBQAngoAT4UFIgRMPBSAngpATYQcChgKgE0HQifAopMC5hwKwE0HYiQjsBGcPCsBOBGEnIrATi0cFwE4EYScisBPMIAWgJ4LQExHoCc4gFICeCEJPRKAnOIVQAHoiCD0RgZ5kol2AnwjCT4TLHyIA8Ikg+ES4gXMEAD0RhJ6IQE9wDqQA9EQQeiJccEM8KAF8Igg+EQGf4DRGAfCJIPhEeBxSuMzZAMANCT8RgZ/gTEQB+Ikg/EQEfpJpy4CfCMJPROAnDrdlQFAEISgiEJSMBYCgCEJQRCAoOBtSAIIiCEERgaDgfEQBCIogBEUEgoITEgUgKIIQFBEICs5IFICgCEJQRNg9glMSBWAogjAUERgKzkkUgKEIwlBEYCglbguAoQjCUERgKCVuC4ChCMJQZGAoOK9QAoYiCUORgaHgxEIJGIokDEUGhoIzCyVgKJIwFBkYCk4tlIChSMJQZGAoOLdQAoYiCUORgaHg5EIJGIokDEUGhoLT8yRgKJIwFBkYCs7Pk4ChSMJQZGAoOMFMAogiCUSRHooInGAmAUWRhKJID0UETjCTgKJIQlGkhyICZ4hJQFEkoSjSQxFxjz0RUBRJKIr0UETcY08EFEUSiiI9FhH32BMBR5GEo8giHPaDPRGAFElAiizCiRnYEwFJkYSkyCLEb7AnApIiCUmRRTj5B3siQCmSoBTp0YjAKT4SsBRJWIr0aETgHB0JWIokLEV6NCIK7ImApUjCUqSHI6LInAWEDgMinujxiCiwJwKeIglPkZ6PCJzkIgFQkQSoyHDsFE5SkQCoSAJUpOcjAiepSABUJAEq0vMRgY/NkgCoSAJUZDiDCmeZSEBUJCEq0gMSgbNMJCAqkp5F1R5GhT0RHUdFz6MKB1JlTqRCR1LRM6nCoVSZU6nQsVS9c6m8J+ZOpkJHUxFP9JBE4CQNic6nogdUhROqcJKGRGdU0UOqwilVmZOm0DlV9KCqcFJV5sQodFYVPazKkxKBT42S6MAqemJVOLJKYk9Eh1YRtCI9KRESeyJAK5KgFanC0WjYEwFakQStSE9KBD4JSgK0IglakZ6UCIk9EaAVSdCK9KhE4CQJCdiKJGxFelQiJPZEwFYkYSsynGeFz0mSgK5IQldkoCv4rCQJ8IokeEWGfSgKeyLAK5LgFelpiVDYEwFekQSvSE9LhMKeCPCKJHhFeloiMOeWAK9IglekDgf1YU8EeEUSvCI9LRH4KCMJ8IokeEV6WiIU9kSAVyTBK9LTEqGwJwK8IglekZ6WCHy6kAR4RRK8Ij0tEfiEIQnwiiR4RXpaIjColACvSIJXpKclApNCCfCKJHhFeloiMCmUAK9IglekpyUCk0IJ8IokeEV6WiIw6JMAr0iCV6QJx0ZiTwR4RRK8Ij0vERj0SQBYJAEsMpyPhUGfBIBFEsAiPS8RGPRJAFgkASzS8xKBMZsEgEUSwCJN2JuHPREAFkkAi/S8RGDMJgFgkQSwSM9LBMZsEgAWSQCL9LxEYMwmAWCRBLBIz0sE5mQSABZJAIv0vETg81gkACySABbpeYnAnEwCwCIJYJE27AvAnggAiySARXpeIjAnkwCwSAJYZDhRCx8OIgFgkQSwyHCqFuZkEgAWSQCL9LxEYE4mAWCRBLBIz0sE5mQSABZJAIv0vERgzCUBYJEEsMh2gwr2RIBYJEEs0iMTgTGXBIxFEsYiPTIRmFJJwFgkYSwy7FDBlEoCxiIJY5EunKuLPREwFkkYi3RhuzL2RMBYJGEs0iMTgSmPBIxFEsYiPTIRmPJIwFgkYSzSIxOBKY8EjEUSxiI9MhEY0kjAWCRhLNIjE4EZiwSMRRLGIj0yEZixSMBYJGEs0iMTgRmLBIxFEsYiPTIRmLFIwFgkYSzSIxOBGYsEjEUSxiLLcMpz5rRl4ImEsUiPTARmLBIwFkkYiyzDcc/YEwFjkYSxKI9MBGYsCjAWRRiL8shEYMaiAGNRhLEoj0wEZiwKMBZFGIvyyERgxqIAY1GEsSiPTARmLAowFkUYi/LIRGDGogBjUYSxKI9MBGYsCjAWRRiL8shEYMaiAGNRhLEoj0wkZiwKMBZFGIvyyERixqIAY1GEsagiHD6OPREwFkUYi/LIRGLGogBjUYSxKI9MJGYsCjAWRRiL8shEYsaiAGNRhLEoj0wkZiwKMBZFGIsKe1UwY1GAsSjCWJRHJhIzFgUYiyKMRXlkIjFjUYCxKMJYVNitghmLAoxFEcaiPDKRmLEowFgUYSzKIxOJGYsCjEURxqI8MpGYsSjAWBRhLEqErfTYEwFjUYSxKI9MJGYsCjAWRRiL8shEYsaiAGNRhLEoj0wkZiwKMBZFGIvyyERixqIAY1GEsSiPTCRmLAowFkUYi/LIRGLGogBjUYSxKI9MJGYsCjAWRRiL8shEYsaiAGNRhLEoj0wkZiwKMBZFGIvyyERixqIAY1GEsSgZbmfAnggYiyKMRXlkIjFjUYCxKMJYlAznOmBPBIxFEcaiPDKRmLEowFgUYSzKIxOJGYsCjEURxqI8MpGZmzkAY1GEsSgZjtXHnggYi6I3g4SrQTBjUehyEHo7iEcmEjMWhW4IoVeEhDtCMrdtoFtC6DUh4Z6QzN0V6KaQ3lUh4aAluAdIwdtCiCeG+0IwY1HoxhB6ZYhHJhIzFoVuDaHXhnhkIiXcWa/QzSH06pCwhQXvQlLo+hB6f0i4QARDGoWuECGMRYUtLHgXkgKMRRHGosIWFnhxgQKIRRHEosJlIpgSKYBYFEEsKlwogimRAohFEcSiwolfmBIpgFgUQSxKh4trMjfXoKtriCN6YiIxJVIAsSiCWJQnJhJTIgUQiyKIRXliIjElUgCxKIJYVLhpBFMiBRCLIohFeWIiMSVSALEogliUGUiUVQCxKIJYlCcmEmMmBRCLIohFhR0s+IAFBRCLIohFhR0sOOVcAcSiCGJRA1eQKEBYFCEsKmxhgXvTFQAsigAWFXaw4PMRFAAsigAWFXaw4PMRFAAsigAWFXaw4PMRFAAsigAW5XmJxKxQAcCiCGBRNnvqkgJ4RRG8osL+FfwJAF1RhK6ogXO/FIArisAVNXBDiQJsRRG2osK5XxoPKICtKMJWlEcl+MwkBdCKImhFeVIiMWpVAK0oglaUDQc84O4coBVF0IrypERi1KoAWlEErSgXfBB35wCtKIJWlCclEqNWBdCKImhFOTHQmQK0oghaUZ6USMxqFUAriqAV5UmJxKxWAbSiCFpRnpRIzGoVQCuKoBXlSYk0uCkAtKIIWlEuew6xAmBFEbCiXP4cYgW4iiJcRbn8OcQKYBVFsIoqw/UTeGIFsIoiWEV5SiIxalYAqyiCVZSnJBKjZgWwiiJYRZXZYx4UgCqKQBUVNq7gHZ0KQBVFoIoqgw/ingBAFUWgigpHf2HUrQBUUQSqKM9IMk4EmIoiTEV5RCIxKleAqSjCVFR79heeFAGmoghT0WHfCp4UacBUNGEq+j64Ib5yEDAVTZiKvg9uCDe1asBUNGEq2iMS2RymiQT0HVETpqI9IpEY1mvAVDRhKjrchYJhvQZMRROmoj0ikRjWa8BUNGEq2iMSiWG9BkxFE6aiA1PBsF4DpqIJU9GBqWBYrwFT0YSp6MBUMKzXgKlowlR02LcCp+caIBVNkIpuD/+C02sNkIomSEW3h3/B6bUGSEUTpKIDUsHpBhogFU2Qig5IBacbaIBUNEEqOiAVh9sSQCqaIBUdkIqD46IGSEUTpKLDdehwhq4BUdGEqOhAVHC6ggZERROiogNRcbgtAqKiCVHR7QlgcJGkAVHRhKjoQFRwvoMGREUToqIDUXEajUsaEBVNiIoORAXnO2hAVDQhKjoQFZzvoAFR0YSo6EBUMqMCICqaEBUdiEpmVABERROiogNRcfAUKA2IiiZERQeigjMuNCAqmhAVHYgKzrjQgKhoQlR0ICo440IDoqIJUdEye1GPBjxFE56iwzlg+KhzDXiKJjxFy/xh7RrgFE1wipYDh7VrgFM0wSlamvxxgBrgFE1wipYDh7VrgFM0wSla5g9r14CmaEJTdDgMDJ8TrQFN0YSm6EBTcNaNBjRFE5qiPRzBl+9qAFM0gSk6nAWGT4vXAKZoAlN0OAsMnyenAUzRBKboAFPgUlUDlqIJS9EqfyqnBihFE5SiPRnBp8VrQFI0ISk6kBR4WrwGIEUTkKIDSMGnxWsAUjQBKVrlT+XUgKNoehd74Cj4UE2N7mOnF7KHG9lLeMyzRney00vZA0jB4QqN7mWnF7MHkIIjdxrdzU4vZ29vZ8ezAnQ/e++Cdp3tzOEV7cQJw0Fg+MB8ja5pp/e0h4vacT+AbmqnV7XrIS9Et7XT69o9FMk0I3RhO4Eo2jORTFcMGIomDEWbIt8NAISiCULRAaHgZgwIiiYERQeCglshACiaABTdAhTcCgFA0QSgaA9Ecq0QEBRNCIo2A0FDDRCKJghFtwgFj+cAoWiCULQnIhIncGqAUDRBKNoTEYkTODVAKJogFB0QCk7g1AChaIJQtA19IV5lAoiiCUTR4fIUnMCpAUXRhKJoT0UUTuDUAKNoglG0xyIKJ3BqwFE04SjaYxGFEzg14CiacBTtuYjCCZwagBRNQIq2A8ciagBSNAEp2nMRhTNANQApmoAUbbMXSWmAUTTBKNpTEdVM7kF3BDCKJhhFeyqiMlNjgFE0wSja5VcnAKJoAlG0C16IByQAUTSBKNoFL4T5JRpAFE0ginZ6SADwQgJRtDNDjwC8kEAUHfan4JgZoCiaUBTtghPirgBgFE0wivZYROEMWg04iiYcRXssonAGrQYcRROOoj0WUTiDVgOOoglH0R6LKJxBqwFH0YSj6HBpPM6g1YCkaEJStAcjCmfQakBSNCEp2oMRhTNoNSApmpAU7cGIwhm0GpAUTUiK9mRE4QxaDVCKJihFB5SSiVwClKIJStHhNvlM5BKgFE1QirkPngjbggEoxRCUYjwZUTiH1wCUYghKMfcDXNkAlGIISjHhUnmcBGwASjEEpZj2GhXIowxAKYagFBOOAMM8ygCUYghKMWF7CuzRDCAphpAU096igibJBoAUQ0CKCffKY4pgAEgxBKSY9hYVSBEMACmGgBTTXqMC488GgBRDQIopgh/CHtEAkmIISTFFdmA2gKMYwlGMxyLN8fX9Qc0AjGIIRjHhDhX8CQFFMYSimIFLVAyAKIZAFBMgCl7qGwBRDIEoxjMRhTPhDYAohkAUEyBKphkCimIIRTHtNSq4GQKKYghFMeHsL9wMAUQxBKKYFqLAbwgYiiEMxYgBmGcAQzGEoRgxAPMMYCiGMBQTblLJNEPAUAxhKMYjEYW3MxjAUAxhKCZ/z7wBBMUQgmLEQE8IAIohAMV4HoJz3QzgJ4bwExP4Ce4GAD4xBJ+YgE9wMwb0xBB6YgI9yTRjQE8MoSfG4xCFt5MYwE8M4SfG4xBITwygJ4bQE+NpCDwi2QB4Ygg8MS08gU0YsBND2IkJ7ARfBWQAOzGEnZjATvBVQAawE0PYiWm3osAdBAbAE0PgiWlvUsm4APBBAk9MuEkF3iJiADsxhJ2YwE7whiID4Ikh8MSo4INwYm4APDEEnhgVpoRwYm4APDEEnhg1NCUE9MQQemLCaV8wycoAemIIPTGehii8o8kAfGIIPjEehyi8o8kAfmIIPzEehyi8o8kAfmIIPzGeh6gm9IveAfBDAlCM5yFKwsirAQDFEIBiPA9RUmEBwBEJQDHh5nkJw0UGABRDAIoJV89LeN+sAQDFEIBiPA9REl65awBAMQSgGE9EFN7RZABCMQShmIBQMk0BIBRDEIrR+Ut9DEAohiAUo4Mj4qYAEIohCMXoIUcEDMUQhmLM/YAbAIhiCEQxphhwA0BRDKEoJlxAn3EDgFEMwSgm3ECPd4UZwFEM4SgmXEGPN2UZwFEM4SjGYxGFN2UZwFEM4SjGYxGFN2UZwFEM4SjGYxGFN2UZwFEM4SjGYxEDI58GYBRDMIrxVEThTV0GYBRDMIrxVEThTV0GYBRDMIrxVEThTV0GYBRDMIrxVEThTV0GYBRDMIoJGAVv6jIAoxiCUUzAKHhPlgEYxRCMYgJGwdt5DMAohmAUEzAKPvrPAIxiCEYxQxjFAIxiCEYxAaPgDS0GYBRDMIqxA5dYGABSDAEpZgikGABSDAEpxnMRnIVuAEcxhKMYJ/LpggaQFENIinEDu5UNICmGkBQTSAreFGQASTGEpJhwm0rmIwCSYghJMYGk4F1FBpAUQ0iKCdtRMmM7QCmGoBQTblPJhFwASjEEpZhw0hcOuQCSYghJMeEyFbzeByDFEJBiwl0qmZALACmGgBQT7lLJhFwASDEEpJiwISUTcgEgxRCQYgJIwVvDDAAphoAUU2ZzbAzAKIZgFBM2pOCQBaAohlAU46FIZlQFEMUQiGLKfPK1AQzFEIZiAkPJhEwAQzGEodjAUPDWOgsYiiUMxbZX0cNmaAFDsYSh2MBQcDO0gKFYwlBsYCgapitawFAsYSj2PjghHNYtYCiWMBR7n9+nbAFCsQSh2Pv8PmULEIolCMXeD+xTtoChWMJQ7P3APmULGIolDMXeD+xTtoChWMJQrEciCm9vtIChWMJQbJHdp2wBQbGEoNhwvBfsCCxAKJYgFOuRCL7H3QKEYglCsQMIxQKEYglCscXAPmULGIolDMUGhoLPL7GAoVjCUGxgKPgsYAsYiiUMxXokovAGTQsYiiUMxXokovAGTQsYiiUMxYrghHBWZAFEsQSiWA9FFN4gaQFFsYSiWA9FFN4gaQFFsYSiWBFQHu7PAUWxhKJYD0UU3l5oAUWxhKLYcCE93khiAUWxhKJYj0UUPkzYAo5iCUexIuS94r4EgBRLQIoVbmBEASTFEpJiPRlReIOjBSjFEpRiPRpReIOjBSzFEpZiZdgDgNsCYCmWsBQbWAre4GgBS7GEpVgPRxTe4GgBTbGEptiwFwVvcLSAp1jCU6znIwpvcLQAqFgCVKznIwpvD7QAqFgCVKwMnohdGQAVS4CK9XxE4dOILQAqlgAV6/mIwqcRWwBULAEqNgAVvNCzgKhYQlRsICp4f6AFRMUSomLDdpTMDBMQFUuIig3bUTIzTEBULCEqNmxHwTvTLCAqlhAVG+6mlxCsWYBULEEqVuWTbCwgKpYQFavyaNkCoGIJULFqIMnGAqBiCVCxaiDJxgKgYglQsXogycYCoGIJULEBqDjcIwKgYglQsTqbZGMBTrEEp9hwNT3eF2YBTrEEp9iwHwVPUQFNsYSm2LAdBafiW0BTLKEpVg8sUwBMsQSm2LAfBW+ztYCmWEJTbHsxPdwPYQFNsYSm2EBT8LnkFtAUS2iKDRfTZ/oiQFMsoSk2HOuV6YsATbGEpthwMX2mKwE0xRKaYsPNKbgrATDFEphizcBKBbAUS1iKDRfTZ7oSwFIsYSm2PdULdyWApVjCUmy7JwV3JYClWMJSrAmjMp6ZAJhiCUyxJrsTwAKUYglKsZ6MZBabgKRYQlKsze+LsgCkWAJS7MChXhZwFEs4irUDW/Ms4CiWcBQb7qTPdGWAo1jCUWy4kz7TkwCOYglHsYGj4P32FnAUSziKtQPhaws4iiUcxdqB8LUFHMUSjmIDR8n0JICjWMJRrMunHFqAUSzBKNblUw4twCiWYBTrBlIOLcAolmAU6wZSDi3AKJZgFOsGUg4twCiWYBQbNqTgWyYswCiWYBTrsimHFkAUSyCKdTbfEwCGYglDsR6JZHoigFAsQSjW5fcpW4BQLEEotkUouCMADMUShmJbhoI7AsBQLGEoNmxGwYdOWMBQLGEoNmxGKeE+CgsYiiUMxQaGgk9Gs4ChWMJQbNiMgg8csICiWEJRbNiMgq/5sACjWIJRbNiMUsJkJws4iiUcxbabUSBRtQCkWAJSrOciqoRE1QKQYglIcQGklDB+6gBIcQSkuLAZBW8zdQCkOAJSnOciCm8zdQCkOAJSXAApeJupAyDFEZDi2s0oMFbgAEhxBKQ4D0Y03qfqAElxhKS4e5NvTA6gFEdQiru3+cbkAEpxBKU4T0YyruwASnEEpbhwrhd2ZQdQiiMoxQWUgl3ZAZTiCEpxYTtKxpUBTHEEpjgPRzTeLewATXGEprhwsFfGkQBOcQSnuAGc4gBOcQSnuELnU0QcwCmO4BTn6QhOEXGApjhCU1x7rBf2AkBTHKEpzsMRk/mGwA0JTHGejWi8YdsBmOIITHGejWi8YdsBmOIITHGejWi839oBmOIITHEiuCFc7TsAUxyBKc6zEY1v3HEApjgCU5xnIxrfuOMATHEEpjgROkTcpwOY4ghMcZ6NaLxf2AGY4ghMcZ6NaLxf2AGY4ghMccINtGUAUxyBKc6zEY03HDsAUxyBKU4OhLAdgCmOwBTn2YguBArdOQBTHIEpzrMRjY9ycQCmOAJTnGcjcGeJAyjFEZTiPBnBO0scICmOkBQXdqbgnSUOkBRHSIprt6bAtaYDJMURkuLarSkwZOAASXGEpDgPRvDGEAdAiiMgxcnghbg3AiDFEZDihkCKAyDFEZDiVPBC3J0BkOIISHEqeCEeEwBIcQSkOJX3QoBRHMEoTg14IaAojlAUFygK/oQAojgCUZwKByrhxwc+SCCKayEKrg9ckEAUFyCKwPWBCxKG4gJDwTNLgFAcQSjOExGNzwxwAKE4glCcDh6IRyOAUBxBKE4P7Jd3AKI4AlGcZyK5nhhAFEcgitNqoCcGFMURiuI8FMk1IkBRHKEozlMR3IgARHEEojht840IMBRHGIoLDCXTEwOG4ghDceFqFLzHzwGG4ghDcWbgjh4HGIojDMUFhpIZjQBDcYShuMBQcEcCEIojCMWZ4IV4UgUYiiMMxZmhhTKAKI5AFOeZiMYnVzgAURyBKM4zkVxDAhDFEYjiPBPBbgwQiiMIxYWbUbAbA4LiCEFxgaAo3AwBQ3GEoTgbvNBCAQCiOAJRXLgYBV925QBFcYSiuEBRFEyUcgCjOIJRnKciuYYEMIojGMUFjILbAaAojlAUZ4MX4pk5oCiOUBRnzUA7ABTFEYriAkWBxzE5AFEcgSjOMxHsxQChOIJQXEAo2IsBQXGEoDhPRAqYV+IAQXGEoDhPRDQ+OMQBhOIIQnH5E70cACiOABTneYjG52Y4AFAcASiuPdELx1kAQHEEoLj2RC/cDwCA4ghAcXmA4gBAcQSgOA9EMgeCOUBQHCEorj3QC3cjAKE4glDcAEJxAKE4glCcJyIan3rhAEJxBKG4MjghXpcAhOIIQnGeiGi8594BhOIIQnFlcEM8sQUIxRGE4jwR0XjPvQMIxRGE4srQE+IZAUAojiAU54mIxlveHUAojiAU54mIxlveHUAojiAU54mIxpd4OoBQHEEozhMRjS/xdAChOIJQSk9ENL7EswQIpSQIpfREREvoiSVAKCVBKKUnIlpCTywBQikJQik9EdH4Es8SIJSSIJTSExGNt7yXAKGUBKGUAaHgHeclQCglQSilJyIa77YuAUIpCUIpPRHReLd1CRBKSRBK6YmIxrutS4BQSoJQSk9ENN5tXQKEUhKEUnoiovFu6xIglJIglNITEY13S5cAoZQEoZQBoeDd0iVAKCVBKGXYkIJ3S5cAoZQEoZTFwBqlBAylJAyl9EhE4+3WJWAoJWEoZRE8EbsygCglgSilZyIab7cuAUQpCUQpi5DegF0ZUJSSUJSyGNirXAKKUhKKUgaKgvdrl4CilISilCK7L6oEDKUkDKUUA6eIlIChlIShlGFDCj7AogQMpSQMpQwbUvD5EyVgKCVhKGU41gufP1EChlIShlIGhoJ3rJeAoZSEoZThYC/8DYAXEoJShu0ouVcIvJAQlDJsR8GH0ZSAoJSEoJRhOwo+jKYEBKUkBKUM21EybgQISkkIShm2o2S8ABCUkhCUMmxHyXgBYCglYSilZyIab5kvAUQpCUQpZXarcgkQSkkQShk2o2S8ACCUkiCUUobeEI9JAKGUBKGUMvSGeEwCDKUkDKWU2bTXEhCUkhCUUoVzG1C4ogQApSQApQw7UQpcH/gg4Sdl4Cd4r3QJ+ElJ+EkZNqLA5wf8pCT8pFRq4PmBAxJ+Uio98PzAAwk/KdtzvVC4qQT8pCT8pFTBAfGEAACUkgCUMgAU/P6A+xF+UoZDvTLvD/gf4SdlONMLvz+AT0qCT8qwAwW/P0BPSkJPykBPCpjYUwJ6UhJ6UoYtKPh2phLQk5LQkzLQE7xTvgT0pCT0pAz0BG/zLgE9KQk9KT0O0XiXcQn4SUn4Sel5iMa7jEsAUEoCUEqdd0KAT0qCT0pPQzTepFwCfNL97b9evdjuP1fHutp8u99Uv7/402+/vfjHP+rnp+rFq/958Y9t+GPxyut58af/eVG8+NP//O+rF4UL/xW2/W8Z/itV+9/2d9WWV+3/6/v2vzr818jwX9v+3ZrwX9fWc+3vrq1fiva/bbniXnT/aEsUhez+obt/tEYWoissuuryvvtHV0Z1P+nuUXX7bIXp/mI7XZ2ZRdnKEUX7AkQnWcjWHtFJFqYt09xr3r6dVntzu254P1J0L6p9iubmhvAP1/7UnLgc/tE9TnMSSXiNRSu52TDWvti2epOt3b5S0f3DdC+36P7R2tPMF9p/tNWb8aP9R/dJtP/H/77qPC78ufM1/1vjfKt1vT3sT7FfWRM5VlGyxXyu6mq/2tfrj9X607E6nXd14q6Fi+Q6ptzqJLRZ18dYUnO39kVSc3v2JEmban18fqpTgSoSaJlvrhNY7YFAGQu0PIG7h8NxW398jCWV99FLu7TfruE1lx4HH7s0zcIwle0OX1a7XfhkD6s67VpE3LkE9+eJPO831YftvtrUq4fEq1z0RgrBfMVPT9V+kzpRLKV9ZMV85NO62m+2+4dYYJO1eJHY5CWyJNV1dapXTctJjYtbjmNadZV12j7sq2Py1poLnS4iddf5NXc38WVTkfGX0NwnPtcfq329XVNHKWz8yMzPGgnbVKf1cftUH47r7eZxe3pc1euPiQYXaRAl88EjDf/8cnrcnk7kuxfOxGKZfchV7Pawfzwcq/rjan/YV82XW9XnY7U/1Kfz09OhGbtTdS5Wx3SNc/3xkPR8zQ6oq5iiHcyUaXsBfRl7unHXdINrcyBYO6a3hW03VFjTjU9h7GHatf3vXgMQ0aeS7fBlL0N49485WsL/7A/14cu+Sl+JK+M3y+xqY9n7Q/1wXO3ralMfwCuPe2BR8j28kZ+0FRUPW83BUpMkhX9sql1FO2sZvwEtmANrJxdJbHYKXp/56jCdn5hu+mInKvNfDz5D/Ja15HVK71enyqjzcVcf3j/XVdrLKRGNwJo3gkUCD+//Wa3TMV3FY7rmfb73u8P606k+HJOnbZLSroNON6l0XJnn7W7zr3N1fD489SZvOp5luTBg8CTWqwcvI32PzcE0V6flfpjma9SHy+tMX2M819K8/rwTuH3Y7ut0+I481RW8nqWVhj6xiW3j9SWttFN9JEOMVDqWxuvz16v9U3X8cDg+Ns2krlYPq+3+VB+r9eG4ST9M3JtInq3rbToqiXhSxuzb1rtqlfaQ0WMW3WpKdEtR1S6rmuP328Wj6+ZtbX/iuv6kyTrimXA4pR1WPEtuBzrRrfBak7rxR4jLYrCzsVvPmm5h5boVs+vMd9p2xnbmMzu/9WGT2upUPKDwXHZ9eHxaHSvy/Zqb1a69Zslr7K2ox+p0Wj1U9faxmX4+PqVyI99qrtLiyj3X1MRCqNjFuK+sE9W8vHV2UlXGw9Rk2Y/nXb39uDp9zMuPXq+c9ho2q4en9+vt5sPx8NgbnAoRTz7v+d+NCG76hdVjKjmeLd9znWu/2fZGkgagXJ1Ad824a6sNOmuDELzBdX3Yf9ima6/YfZuNNG1L66JLhtllesHndIiVMhoHFXOFuD40Xe15XYOBUMYzeN11b1Yxe6xO8qfqeVMdt5/9zPNpVSdrneY8wmufzlya5UWfm0XPZlWvmuFkVZ9O64/VYzolNTpWyHXEQYVPx0N9WB9268O+rn6vkVIbK2V7D0dp8wek0cQa2a1iSKPXsoLv1MXKJvoHWXwIEfee3cB13w1t3aAkbPeTayOColvvKXMJZ3bBy25JZrowrbn8pQtnNmd4tw7eDdv33UjYhXJd1whcF1V1l8JdgNN1UVXXxZDLLhZbMkOLrR+RYSWZdLhOpGZ/2ia8/mG7q9PFZHMIYjSpmiStCXghiTKWyGxhx6q3IotXoffdLMtdPnL7BvT9ffdtu1h+cfmkXZ/VfXbbRY1t5yOWGfsMBmbCYNJGw7JmrnNbibnIgopXTJo7afIyNzDuV8SLcaGZrhgENjErINHEn8gwO+8gcbs5VqfD7tw8dj9yruNlSclc5ATJzSwh+TZx56S5M4+LKLDglGXUZDRzCRsk+qhL8pVVPOWwU6w7fPhwqmo4m222REchXuZUwEs9Vv86Vydio4ltnPKZj9Xnw7rv2srFAqd83UvYMW0q8Qdhxu6v8kj3FYfHtZ3y7kA0u7kUPpLGW/sn0tADyzhEoe+nSM34SxxCEUx55+MpHbtl5CcXannpnplhumb2lg4nka+0o4DucK5mRiwaoXSZFj9z0XFfrXje2Ais9s1abRMCFacvx23dLTETChSrkbxXe53BpjOAeM1vL++iQ9pM/hlNjxPp8URAMP2+kXUiQd8i7nwKe4lNXP7RDdyK11C9DhpPjHukVi5zknsR91DVANnGsTrBnA5dRO6qz1US+tMxvXMTWoAX93SGFsZAZJLI3tI5DteJLhIkmCHUzaqu2sE86QSiJ1ZdnoPtJuLMxWMju/r9aXskoVkZfR3TdTElM0a76Qbg1GAVW2wUuxFVT+f3u+3pI3n8OAjfZYDYLneii8hpw/as6nQ4pg4QRylEl1MiuK3/feKfIupSHJOxbqqm33varbb7EFB+Wj3vDqv0pd7HdMMyW3o/T6G58OC6mGCunzyP39JZRzwPLLr1hOlim4bJ0TqUQ1xIx37ZrTFNO6iUHZIsmauhi5LefLE5zC9q/ZdhsBu+ulWR1d3Sp/M9ywyWhiB82k2IWGfncJ13q0656XJznLxEjrvVMdsDGuXV52pfn94/0xE7jqt2YWvFdYlcBKqIIyXCcL2gE9ePhhRxhEl0UxbFBO5ecrVq1lq+aTV9zLrNt9ke9p+q57RHjPN4DDMxKOjYPPlnqP755VNqfjy+GO53iyV+qp5TiXGHZZj9lJf4qXr2oaePnzYf0slK7JJs52pE5myM29UlC5A5FaaS++HvOEAgmCueVqr3AGqujVfezGUjXsTreIXi2D1syGGhC7t49DOqC8N0iYtlB6jKLo5WSuY885IzkyRfRC1XXjI62jFXXXIjud+wXm2TyVsRD44FMwKzSfssHfNG55iO2gZHPqcr09jleXLOT7uQcoSnfzrO0GHS2s2XNAHMxm3bMSdiX/Z9NBK96ylSTjUdIV3c1ByzP2+yNI4kEh1njYmSbZQX1Eeg8aDADFFsvuy3+7o6flitK183oT1xboZi9gBf9o9V/fGw6UuzsTRei6nW2+p0qtZPQptPRRoIiL6mYjbAVBzMWY1zFZi+lkqFiatxzgKTcFcboXVRbvefV7vtho6gcQajZEYcq8ctceN4kt9OdrjP7AMTaWhGxcsyJjS4TjtiUTbmEMWll+0yx5mRg6tsmAQs475JMfvNq8zt/umcfmUTP3+XaK67qbpmgterhqfj4ak61smoHGelFcyRrZV4en58rOojmeqlNDYOcjKDHdW/zqtdH9HEDYk5Z/Rz8sZJm+Ta3lCi4+xpxwxz9kU22Y5PFeiK44i7ZDJ+L363PdUVzZ+Mc5Z540OQdUgGrBjptrOZSbJAsCh6SicnSOt/kDjjrG2hU+Sd38P5XZwkw8S81e/V+lxX5/2uCY2+72WcyDLqTjRzcVD9XtMseZWYdsmuYrrK7/Vxta7J3E3FmXaamaj1oarXH/uYR0cDopkiygcyVrs4yJySgMgNdcEbH7zgffWl6rLskNw4ln/P8x3Q0UQft4PxRbeTSHSpc7bj6/ay8GLm1QeN2/16d95Up0tArn2qFCPE7ZUZh0/Fn/fDCuIkCGbvHxSQdNZIzGWDVpeLxNxGQiFoPB9j7kPCaVzxyCGY6NNj1F7maaHjlQMzK/ah6ctXu39+OX2ujtsP2+r4UNWXFfL+UH84nEnHULp46OB9lr6adqYHaVxRlrEK3ogSVAzwfx2nc5XMnAIoFRqt40BiyUSInfjNdvOpen6qjqfDPoF1OqZ1ZcGbtnVSGz/J9Uc6DtI7Zqy2E+y7436GSXMkViRz2htunn+1TclxGU+rOu7pCt4CgAg+rr6ksm0se5rIlkqefAZ9+lZ17ATzpB6rNPSv47VkeT/NBzqh7QzkPXGCOCuEOQ3sJCNvFfHwxIyPX+S1+XfthD3lwKnVSec7pQe6ajnBlE8dR8AcM0LVE913izil1jGDFZ3Y9jX0MYKO4V3JzC0mUoEHx9FLZj4/EZrxtThwx8y0JoL7riDivBzmzj4vdLsGqQWx+zJTklNhx+ppl7zOuEdkbrB4qAiejsNvlw3hFyLUbZJzTF75UNV4T2cchtD3fGG97W7NpewRYmRL6u1MiFcLzHBhI+Z8PFb7XB5X3BCZK66HZlN6fXxOzZMx4NBdPqRm5oY1Mv3CMI2Px+GO9rMy+XmzDSOsbMDSI07AYs/Y6k/kgeMRUzOz1h6qOqyLQGtTcQKuZk8X6sNukxMYr7HYvUHd7GXZ122SsJ9cf4AZwyqGRFawm3OYT5OgpoonuY49qtcQX6l4Uu7YA3l9Wh+e/DTxqTr6Hc5N7mhvm1i8gjLMWFQjvJ8KGCdcaea66SJpQ/0xzkNlIruH4+p92rvGi6ZL7jnXu5t5cLI0COkwPtEmMVbE6RuS27ti8WAruogjK5IZXciI3x/q56oOp3GkOuKt2QXTDbCOJo31E31D8U4pZuClL/7Cd9BBACJORZXcdURPR0A+WEEcV2WmWfcVXLeTf2jie3sS/BL38TyFuygc0II2rYv7GAYXzN7Zy0s75Xi2bhSz02zkkFlFPNUzzN1YXk5vi1Sc8GeYoOLj6hQtHdJTlJSOKT2T13zc9DImYkJleG3YS0lzcdrISvot42ko83gXKiIOLoUql3OPuiw8023HNcw04iA8CdYlJOWyrZ3X23gh7fOHbOom1w+RJRFPLiUzlN8X/3m1O1f0UC0Rj3KSOf+NZcdGb/eP1ePhSIyPu0rmHj9ftx06/L9X73cVfjVxJ8nc0NfOPdue5XNFd6HF22yLLq1NMWcAuYmtSHpzpqh2eEi5RExMXrQh9PDfotsoV3Ros7hsX+2mC2W3w7tkJs9tT/FhV0knEBOhotuAV3THfxXMQN32VD01aXTH1e5T9dxs+z020D6dP8XxYuWY7++UX2XEb7F7a5o5S96emmUCmSzG6w1mmGd7alYHRE48T2S/wFzIQcXg2zJxZ9PsHvbV5v3z0Bks8QvsUI5mhmCuGvIHpMSJPLrLc9bMUMz2dKpXx/r0ZVt/RHsU47fCTKL/5xeyDSxevjEHwH9+OeXSp9FAGBNhyWT+HbV4vsT9z/vLZv/18XM6TMbogukdNDEhjp8oZuAjmQaAHNo4BiCYa7hP1TPOWIkPNSgU28DBdJIYsDMDr32RqT/FibeKGY3+VD1TaB1HKVyXmu0uNKJLnGbmfXyqnh+biOZ2tUvVxNkozD20iJnE03Z9OdKPmTK225KsqRg9dAMgs8N4XO1XD00U/3R+bOYa9eqUZnXFCF8wU+QeV8l0Me4yC2Y473H1e7fLyh832Cx/3lft3rM0YyxOEGUCdBRVTo4A6SbI7dS5O2VNdX/R3eEz2l322HdBX3Hxvu7Mz26Ltu3m4vZy8Cozt601mAZf4/1g3eymO+KGueJsJfs4Z9oJx691iigf5AzTb9qvx7EJZpJ5h8bSvM24H2LuXewE9YfFmAkz4X4nDIQd2oBDsy0grERTaB4HBZjxxE4Z2REVL9mZ3Xsn6RpI7C2TdTzhLCe+2x6oUvHs3zBH2kRa8nI/rLY7EpCK542SGddPFKAQdbJRe7pIsHtexccjmYm+74X2qFWc+8XMIMvBaxW3djPRLRtho18pDlNxh4BIfq5DiVsT84CZWCz69rHDTmtVjUT46ePAEzOeGcvsf/nYl2bK87AsjY/FDjpZaDv59qgCfP94ws1cbQ4mRch4XqIm2nuROOK2RbzWkcxkpJ4SvIsnSY1kztWo5CgL9rzfPj7tqqY8fYZ40GVmPPU0gYYSh1OZS5WeWHTMSMyxFBPx9AT3mkx8Tjdzt0MntHeoZzRbaOdazDSEWCLIg46pt5724I1E2PUkM8RpXUUmGzqZe0377pHEj6v9ZkeyZuM88EmPD7MI0p1C7Wy9m5F34cJuZl50x94V3U+iWzKq7i+6i5vr7hQlU1wcoJvzl5fIZHf2UifZdsFKy9ydFQBWGiSLV5+ttMsNDN0TdMfqFd0io+zODSm7Jyi57rVN98DEYU/ucLvdbx9Xu9OuqkiSR8wQmML2zQEeu+1/VyC2FW+dsV1k0zKXLiEkBY8XjuOvzOydw745pqifFp40cJ6kpyqN6UQfoLvhQnT/7Ty3yzoSl6sqLqecykvCSvePLpTuurPFHTOs0TugW8ap4JrJIr2US8gOHKkgY6fTTKCdSu2nOMg4aKCZYOmpOTe5fwhavI+uO5OPiZOuEvunCsXhRWZULMmQoWkY8QMzV4tBHj0/KL4HgDlxeVodyTG+MSYW9xdS2Z2tUHZ7qLtOzXQ77szlmOHOcU0XgbH3XQfbEUnbHcRgmTdzeEN7B9vGe1iZCZydoMFjbUWMayWzp+okjx5qK+I1nWQG+710eBhavDrgfvZLlOFy8GzIi+pn/ceH9JXMGAwQn24pSZoQk3VfhfZ3M8VpooZ5jBORR4/50vG8tGSGL4hM0tLjebm6HMGjL2HBS25qN4npGpvtZjOWebJEnI7W95h4I4dhpgb0JPbfV/xNmVA9ltodzNcXHKdpy6keCMJo8R4DZlJxJA8FD1WMwA3zjBIgMzqUscsFb8xv0w6QZpFEx5kHT2U1t9+WrTtOIGBmEADdXSJlG0rCqmLwyDwGDajyCpJzILtf6tUDzEiLx0M531s6xeHM4vO++v2pWl82aaQakyz62b501Xh4qi5Tj6fj4eP2/bb2QfAmd2WbzqpFcobJ9NYGtRMfqldp8mWS5M/cqDimsvsj/qZx4IW59RJu14n3ejAzQJ4Ou97qOt5Yx5xHN2KOVX187i/f4uhzyUxWa8Q1a/VDipV1HAsrmZCgkXXe19vd6bxeV6cGjiDJRSyZOcOCB0SpODtPdwdRa3cBy1OFg8Wmijf82+7KN8dMRL4exARyuuN5hmGu8KjA894T4obAntcVPMBCxFBKyiX09Fi/iDdFSuaBAX0d1+SQ85HkUMe7qyR3sXRRUB96mwjiUClzx8PT8dC4NQi8FvE6WzATGq49cjpFjtsH8ywkODWJl5fd4Sj33c2d3VSzuJxeLi+5eN1p8czjNzvl6aVh6zZTuk0VSD9mPH1ghkAHtBzPu+qEtlyLODAqmeAUKrocYHU87JpNddunbUXgfDy5lsw0a6hru18fjsdqjcMGIt56KpmnmA7rwYf8ijiMIrlrq0FF8U0Rqap4XGZGsDOqQiKwn2ylKuLpHDObfkhFL3k5XglI5uYzqMBPW7b7h9bVDscN9O048iyZ+bMZfb83OT0o6y/uQyQzQI11bPdZHXFncEuX0042cauJ+axknjo1pMX3OemGUxEHZCTz2juoo+k2m6+fSo/bCHfxjqSHGGJzCs54w1T/f2lXsOW4jQP/Jec9hCIl2fsr+3Lw2OpubzxSR23Nzhzy7/soCuwiCapLu6e8Tl4AWSJBEKgqJMKG/0ewCU5lIcOwn9ewxK9vl7Sx0WBybA+eg6nr7V/quwjDAluQ0rz47yVrQz0fMKO2ZNdC9eSHndTjHKbXlpytkY0NSjMbLLWyNdvNXkX+OOmYHLNYaOYi+tNEcKBob7ZxWvfB7bhbRkLtBzqfDnbzXW0wa2gEptgKN72VDlDfxkKg9C5JfHP0XAYs1Nk37H1RuFxpXxc7LtLH6kixvH1lCYdVu44c7Fya1BEfqAdsSNURxbYkhxfP3rmP2tmARVJLgph2PPl1VHGExymJRCodbfEl5NdBQcPzF6ZFUa9psIlqSen2L1xukXR6SR3hAcsWW/cdTS+VOwructsdO/kqvpZ3X6XaeY944pH0yqrLeAhNL8F76gqPPRJPWXcVlmE4yIu8GBW/LAmKrLrKR3w02COwJOasat2frOWJihdyy/bZChfaQBbUL2VL24VhDWOEi7cjBSJKy9vlY/jwadpteH++DT+vw5Ch/Rvs6VkSHaY4mx7DbVrv8cPPux9t9nr/MRQi+Q1yUywpXlAXGHIYu3q2k5yYK0ElqI9q2C5vYlNbLKgVyjYHEqPaQsHN2ZPaAanVAtZ3wjOV7SMkJpfxc0J6+u1xs5OKmrH38Os9rewiscuQ0Jj3eRkzWDqWh9n7Q6Xjjkv7zKbuqkQKIkJambDcitjwiUS7RdtqXTxBb5KHlSbBYnHshTtqKdcWSqA/ZCoitpQqMZIzZQToib2zaFN5kOxrBC9mJKlvpfbaHvn83oc+aBGProZNBsVkbdQikrvYE3fJpLmQwdZExKaszzgKnHzkIqxbrPa5qLIQp5+Tb3e1q8hNYeSIw8q5RVGLxBjayHW7hV8/lqtgDuC1krz6zpfxpgittlgDPJN9r2Dr+m2aP94uTdtl+K0Wa35nUnUn2LynVZUW63pn8gALlj6xiM85n0SC6/NMCn9tVhVj2NAhY0cwpkuxYZnxTHJX5sv4Olw9JX/OTx1U06If7lWB++L1hbyn56Qng0W/RjDSTiaonMh8Ty3AGeQjmzjAkUylQi6cD0LGRC8es6LS0bMbr5RwttjkcYKv7MkazWYwVUwIE7z8OKfbml8PY0XqCY9QS8LOdjx6XKTqBu/XpA75jptPQabxlkKNde9YsiCpMjvefQ2hPiqt6RIxy0MfcZs+Mk7SFfrk7nuRq7ycjbVVS1ZrqzqpDiHZPdmnTax9xUHEbMiSEIjEgXJROien8//w0No9CSfw9GSTKhpNR3LtwhyQl29J/Mrmp+Q9axBfHXTQ4GXIkoCmQ349wLDQ9sMCtD1xqWTVa/h4idaYuvWxoWHJEnXVaUjn5khyI9xj3CORIlX3KcRP94eRjqS47PvbRdghEMbSWQDjzleCdJcY89gUJriU8ux4Xfl6qRbM8Po9SyEaFAKypAjX5ipRF6IPY4zAluz41B3WzmKMbpZkttS9HDyKsYJiSQGbuvMvTmIsuVpST3xzttsSRCAneRMUs2nvNdci2gU1YE3QkmXezK3fVRWfKhwbq3uWvKjWJNMN4n8bksuNxkIPJdxEYtlihZ0qOBMU2rIk3xidBTexxR+OswqWGketW7Kkhb60tAbvGiSUDU0qWY3BW0ZDitOgzZWaxL5+jGQklxh9FXVmlG0xJDytMFgUTlBewJDous1qoeCBwaYnS05g66vk+Yy5Iql2B+a1NYalexKGBxbVxBneZ092/8Bk+dVxdjaJekvsPZd5HAJV7z1DWOHUPEvqHUbGjG8bflQiqdJUxFuKI5EHe1MiHAbm/tgd8wtZDNRbNyQIMLfMyGI0WG23pFha7uhIlEYMuCN7f7k/DQyOkuWGRK7ldtW9hHT6Y6l8XYXDoAK6ITtYm9V98QiDwuSGRLxVx8BhxcYdi3arsTC7I0qdv87356/P9V7LjPGQcaQI01dehe0WiPWqkjCeQu5YYlR1+32ah+fbZZzGQZ3D1WCG4chRCInTr84r/IKk6g3aD9meB6tfxpv/x0q5fi6Xx+PX8PP6WD5y4X2MXI6tvKser/6SeBP5Q/G6zuPLvdrfExG44ys1eJWjo+ANNXgEOrY5UdiP0NLxltyw938aCgGxfRtwLV9N2WoWo4VjOzmZ7fXjqMbxuGV7JmhcPRkNmjUkqg/Nfk7IWcYVLDvcyoECFjGujpyNkHlB8WkNB21R+sWRaIjMR5hXs/5Vpy1Y7MK4Y3eO1fT9+/fliRLs1zffjsqcYKghiZXoRDvVk66vqNi2x473YDzsbL9e7+P7PPy4T0va/UEtZEeSLxUPmzTrjiMU3HckF1NxpFUKLA4KcKSei2K7zJ0tqvg7UnBAs1xq0CCh1B3rtsnW2rCkl5dnKE1laQyuIkfOCEAPmjwb5s0tycZPbPoy2mW8BVV9NX5ip9OR8t/oYs040nrdMv45Tv8ZlXiHEpKOlKGqONtxggGPlL9EJx4rmsYHzKOPtd7E4A8/FSM1iin0saLValSo8TELhMxQ/9AYOUlN1F2Hu90Ji1KxjtRa4dyN0/M+hi2+q2WFMpiOlMHcfQL/x5Y4qj8ZFYYcqTC06/BTyr2WWqHskCMBqbsuBQ1RQ2paFEhwpDjJPLz6VkiaYSEBrRFkxYlEYW+qJhnvHrFhHX0tXS1lWt/IY+5aGWpCv+DVZDlkCaVpSTaF1l1tEdt7JgmDYiiPbtiHMvQuAQH7QrITwULBQEMqgJR2FeFORDWRTJFVVeM6LRlsCAk1DV3+iiozxedFoWCSeZGzxrCna9gEaJqeBV7WIOywIRdbmZEZvD0Y4ay1pGjOVjtNDGKXvCHPvWBni1XTfLkFEMLlITcFneljUczIkelT5stXO7JyikXhIkeyOzKz4U/1GoVaQY7EsGXWl9EH9uXyKQlUfUOYK5GQ/nLYG3abuih+JsKt5yZOSyDf1XB9b9ruT5PWSGHj92Q3OVr6c/BvoOhdWZQNcqRs0GZ0Th6vxdrQiayBRUvVx8MkigyiH2/T8rh9W+6P2zJ+osjX01xRckXgQ0/qu+guIjZT84JsFJJZG7zkROl05WE06dn1e39NRUWxm9c2keMqupZnwaiKxMqJvLiv2Wmm3ALrrSN7vXDpSR8bx9qQ9xzltpbaTIbbkKt4Jwk3qNPSyBwX1wmLW2Y6d/Juu/j+z/L+ZR5ML4qvvUB8exLkVdYDDKoONeK8MTKGTzw4UXxuRRO1ladou/jswkIQykDXiNxjI//pHDWr5dfICJte/q/eRUp4nFwT5azlZZyirnVcjMJTIFFLOdEScV2GrFsoAtOwh05kGcEDCm53r1KR6wggD192H1nEqo23RPAz2QH2t+klayxiH5M04mkDz+nb5WPo3DKnpTRExTsSSBAtlvLZeOMli9ZBrSNLcRDSYci6tNq8xqKDaCC4VkZwkbUU7EYWXc5ERZJ70uIKhPUd4SyZGKOEW9SSb7Sc6oVcLVI/KFTsivgMv3V7TBKD9Nz0XV8HXxHMx2PgSzyRYERPYUlDABohA4kiI2hQUKEhgSCRT6MAlCzuWkdeXZ5TEjwSog9poNifBintDSlV9Jz+/ZFGR4OaHI2MPnCdnEvx8BESYicJeCfzyvrfI5NFRLujHgmJXH5OQcY//YH4ZCRJpqTv4nYkO3rL4357WUU60kEkWHA+kZSBZVwHmq99onIaEF7POjLgLPM9rRTgAChSgWKZHyB3JLMZfLEkWeso1+jII0o3nd0UkwFoZAa/zI940a2ZxXIiqf4oRUsAd/sW/kpqfRbDv8uqqUMuTU/WpsVpCkGeh5dh1e2/PGIJNb2gIFKQvM2LK7/xy5KMwx5iSzJJxGTG0HaINOwlOpxI6IEY3faK+gIM3vwakjaQKiunWwdLvCSHLZoDXmiZ8zgs33ckcE9MK2OrkbzQkJiuaE6lh2JP90SWaovGUyJFwIWeMG0sXTe4rM/xKkLu39Xe8Ndyedyfv6aXvPGfofkskolaEuyTjSdOu6q4gUixiRK2hkxix6Qpf/zjt/f7+/C4j8Nv//zXH3///V/LAmVQ/6EDAA=="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 000000000..9d619a641 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1448 @@ +: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-section { + margin-left: 10px; +} +.tsd-page-navigation-section > summary { + padding: 0.25rem; +} +.tsd-page-navigation-section > div { + margin-left: 20px; +} +.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; + vertical-align: text-top; +} +.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..1d6f88889 --- /dev/null +++ b/classes/AllowAllTenantGate.html @@ -0,0 +1,5 @@ +AllowAllTenantGate | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/classes/Cid.html b/classes/Cid.html new file mode 100644 index 000000000..5e28d764d --- /dev/null +++ b/classes/Cid.html @@ -0,0 +1,17 @@ +Cid | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/classes/DataStoreLevel.html b/classes/DataStoreLevel.html new file mode 100644 index 000000000..551394a1b --- /dev/null +++ b/classes/DataStoreLevel.html @@ -0,0 +1,27 @@ +DataStoreLevel | DWN-SDK Documentation - v0.4.6

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

Constructors
Properties
Methods
diff --git a/classes/DataStream.html b/classes/DataStream.html new file mode 100644 index 000000000..921df2bd2 --- /dev/null +++ b/classes/DataStream.html @@ -0,0 +1,13 @@ +DataStream | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/classes/Dwn.html b/classes/Dwn.html new file mode 100644 index 000000000..9b56acfeb --- /dev/null +++ b/classes/Dwn.html @@ -0,0 +1,16 @@ +Dwn | DWN-SDK Documentation - v0.4.6

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

Methods
diff --git a/classes/DwnConstant.html b/classes/DwnConstant.html new file mode 100644 index 000000000..6a7d04d5c --- /dev/null +++ b/classes/DwnConstant.html @@ -0,0 +1,6 @@ +DwnConstant | DWN-SDK Documentation - v0.4.6

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

Constructors
Properties
diff --git a/classes/DwnError.html b/classes/DwnError.html new file mode 100644 index 000000000..2d990ac63 --- /dev/null +++ b/classes/DwnError.html @@ -0,0 +1,4 @@ +DwnError | DWN-SDK Documentation - v0.4.6

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

Constructors
Properties
diff --git a/classes/Encoder.html b/classes/Encoder.html new file mode 100644 index 000000000..eb09ab570 --- /dev/null +++ b/classes/Encoder.html @@ -0,0 +1,11 @@ +Encoder | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/classes/Encryption.html b/classes/Encryption.html new file mode 100644 index 000000000..6df7d2fcb --- /dev/null +++ b/classes/Encryption.html @@ -0,0 +1,17 @@ +Encryption | DWN-SDK Documentation - v0.4.6

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

Constructors
Accessors
Methods
diff --git a/classes/EventEmitterStream.html b/classes/EventEmitterStream.html new file mode 100644 index 000000000..30b6084c8 --- /dev/null +++ b/classes/EventEmitterStream.html @@ -0,0 +1,7 @@ +EventEmitterStream | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/classes/EventLogLevel.html b/classes/EventLogLevel.html new file mode 100644 index 000000000..427b67d0b --- /dev/null +++ b/classes/EventLogLevel.html @@ -0,0 +1,28 @@ +EventLogLevel | DWN-SDK Documentation - v0.4.6

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

Constructors
Properties
Methods
diff --git a/classes/HdKey.html b/classes/HdKey.html new file mode 100644 index 000000000..734c408ae --- /dev/null +++ b/classes/HdKey.html @@ -0,0 +1,14 @@ +HdKey | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/classes/Jws.html b/classes/Jws.html new file mode 100644 index 000000000..b0b00ee88 --- /dev/null +++ b/classes/Jws.html @@ -0,0 +1,18 @@ +Jws | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/classes/Message.html b/classes/Message.html new file mode 100644 index 000000000..43cbe9ae7 --- /dev/null +++ b/classes/Message.html @@ -0,0 +1,46 @@ +Message | DWN-SDK Documentation - v0.4.6

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

    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

Constructors
Methods
diff --git a/classes/MessageStoreLevel.html b/classes/MessageStoreLevel.html new file mode 100644 index 000000000..be0cd8043 --- /dev/null +++ b/classes/MessageStoreLevel.html @@ -0,0 +1,26 @@ +MessageStoreLevel | DWN-SDK Documentation - v0.4.6

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

Constructors
Properties
Methods
diff --git a/classes/MessagesQuery.html b/classes/MessagesQuery.html new file mode 100644 index 000000000..c81501c4d --- /dev/null +++ b/classes/MessagesQuery.html @@ -0,0 +1,17 @@ +MessagesQuery | DWN-SDK Documentation - v0.4.6

Class MessagesQuery

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

Accessors
Methods
diff --git a/classes/MessagesRead.html b/classes/MessagesRead.html new file mode 100644 index 000000000..4d7de1494 --- /dev/null +++ b/classes/MessagesRead.html @@ -0,0 +1,17 @@ +MessagesRead | DWN-SDK Documentation - v0.4.6

Class MessagesRead

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

Accessors
Methods
diff --git a/classes/MessagesSubscribe.html b/classes/MessagesSubscribe.html new file mode 100644 index 000000000..8f52966dc --- /dev/null +++ b/classes/MessagesSubscribe.html @@ -0,0 +1,19 @@ +MessagesSubscribe | DWN-SDK Documentation - v0.4.6

Class MessagesSubscribe

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

Accessors
Methods
diff --git a/classes/PermissionGrant.html b/classes/PermissionGrant.html new file mode 100644 index 000000000..a51210540 --- /dev/null +++ b/classes/PermissionGrant.html @@ -0,0 +1,23 @@ +PermissionGrant | DWN-SDK Documentation - v0.4.6

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

Properties
Methods
diff --git a/classes/PermissionRequest.html b/classes/PermissionRequest.html new file mode 100644 index 000000000..319c0206d --- /dev/null +++ b/classes/PermissionRequest.html @@ -0,0 +1,16 @@ +PermissionRequest | DWN-SDK Documentation - v0.4.6

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

Properties
Methods
diff --git a/classes/PermissionsProtocol.html b/classes/PermissionsProtocol.html new file mode 100644 index 000000000..8c26374c7 --- /dev/null +++ b/classes/PermissionsProtocol.html @@ -0,0 +1,32 @@ +PermissionsProtocol | DWN-SDK Documentation - v0.4.6

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

StaticcreateRequest

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

    +

StaticgetScopeFromPermissionRecord

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

Constructors
Properties
Methods
diff --git a/classes/Poller.html b/classes/Poller.html new file mode 100644 index 000000000..7018ae11d --- /dev/null +++ b/classes/Poller.html @@ -0,0 +1,12 @@ +Poller | DWN-SDK Documentation - v0.4.6

Class Poller

Constructors

constructor +

Properties

pollRetrySleep +pollTimeout +

Methods

pollUntilSuccessOrTimeout +

Constructors

constructor

Properties

StaticpollRetrySleep

pollRetrySleep: number = 20

The interval in milliseconds to wait before retrying the delegate function.

+

StaticpollTimeout

pollTimeout: number = 2000

The maximum time in milliseconds to wait before timing out the delegate function.

+

Methods

StaticpollUntilSuccessOrTimeout

  • pollUntilSuccessOrTimeout<T>(delegate, retrySleep?, timeout?): Promise<T>

  • Polls the delegate function until it succeeds or the timeout is exceeded.

    +

    Type Parameters

    • T

    Parameters

    • delegate: (() => Promise<T>)

      a function that returns a promise and may throw.

      +
        • (): Promise<T>

        • Returns Promise<T>

    • retrySleep: number = Poller.pollRetrySleep

      the interval in milliseconds to wait before retrying the delegate function.

      +
    • timeout: number = Poller.pollTimeout

      the maximum time in milliseconds to wait before timing out the delegate function.

      +

    Returns Promise<T>

    Throws

    Operation timed out if the timeout is exceeded.

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/PrivateKeySigner.html b/classes/PrivateKeySigner.html new file mode 100644 index 000000000..1e3a1c221 --- /dev/null +++ b/classes/PrivateKeySigner.html @@ -0,0 +1,17 @@ +PrivateKeySigner | DWN-SDK Documentation - v0.4.6

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

Constructors
Properties
Methods
diff --git a/classes/Protocols.html b/classes/Protocols.html new file mode 100644 index 000000000..ade4698e2 --- /dev/null +++ b/classes/Protocols.html @@ -0,0 +1,7 @@ +Protocols | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/classes/ProtocolsConfigure.html b/classes/ProtocolsConfigure.html new file mode 100644 index 000000000..15229faa9 --- /dev/null +++ b/classes/ProtocolsConfigure.html @@ -0,0 +1,17 @@ +ProtocolsConfigure | DWN-SDK Documentation - v0.4.6

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

Accessors
Methods
diff --git a/classes/ProtocolsQuery.html b/classes/ProtocolsQuery.html new file mode 100644 index 000000000..3ab64b3be --- /dev/null +++ b/classes/ProtocolsQuery.html @@ -0,0 +1,19 @@ +ProtocolsQuery | DWN-SDK Documentation - v0.4.6

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

Accessors
Methods
diff --git a/classes/Records.html b/classes/Records.html new file mode 100644 index 000000000..2d8ced628 --- /dev/null +++ b/classes/Records.html @@ -0,0 +1,66 @@ +Records | DWN-SDK Documentation - v0.4.6

Class Records

Class containing useful utilities related to the Records interface.

+

Constructors

constructor +

Methods

buildTagIndexes +canPerformDeleteAgainstRecord +constructKeyDerivationPath +constructKeyDerivationPathUsingDataFormatsScheme +constructKeyDerivationPathUsingProtocolContextScheme +constructKeyDerivationPathUsingProtocolPathScheme +constructKeyDerivationPathUsingSchemasScheme +convertFilter +convertTagsFilter +decrypt +derivePrivateKey +filterIncludesPublishedRecords +filterIncludesUnpublishedRecords +getAuthor +getParentContextFromOfContextId +isRecordsWrite +isStartsWithFilter +normalizeFilter +shouldBuildUnpublishedAuthorFilter +shouldBuildUnpublishedRecipientFilter +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

StaticcanPerformDeleteAgainstRecord

  • canPerformDeleteAgainstRecord(deleteToBePerformed, newestExistingMessage): boolean

  • Checks if the given RecordsDelete message can be performed against a record with the given newest existing state.

    +

    Parameters

    Returns boolean

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.

    +

StaticshouldBuildUnpublishedAuthorFilter

  • shouldBuildUnpublishedAuthorFilter(filter, author): boolean

  • Checks whether or not the incoming records query filter should build an unpublished author MessageStore filter.

    +

    Parameters

    • filter: RecordsFilter

      The incoming RecordsFilter to evaluate against.

      +
    • author: string

      The author to check against the filter, typically the query/subscribe message author.

      +

    Returns boolean

    True if the filter contains the author, or if the author filter is undefined/empty.

    +

StaticshouldBuildUnpublishedRecipientFilter

  • shouldBuildUnpublishedRecipientFilter(filter, recipient): boolean

  • Checks whether or not the incoming records query filter should build an unpublished recipient MessageStore filter.

    +

    Parameters

    • filter: RecordsFilter

      The incoming RecordsFilter to evaluate against.

      +
    • recipient: string

      The recipient to check against the filter, typically the query/subscribe message author.

      +

    Returns boolean

    True if the filter contains the recipient, or if the recipient filter is undefined/empty.

    +

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

Constructors
Methods
diff --git a/classes/RecordsDelete.html b/classes/RecordsDelete.html new file mode 100644 index 000000000..ab8413901 --- /dev/null +++ b/classes/RecordsDelete.html @@ -0,0 +1,21 @@ +RecordsDelete | DWN-SDK Documentation - v0.4.6

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

Accessors
Methods
diff --git a/classes/RecordsQuery.html b/classes/RecordsQuery.html new file mode 100644 index 000000000..e37517db8 --- /dev/null +++ b/classes/RecordsQuery.html @@ -0,0 +1,21 @@ +RecordsQuery | DWN-SDK Documentation - v0.4.6

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

Accessors
Methods
diff --git a/classes/RecordsRead.html b/classes/RecordsRead.html new file mode 100644 index 000000000..4c445eb14 --- /dev/null +++ b/classes/RecordsRead.html @@ -0,0 +1,22 @@ +RecordsRead | DWN-SDK Documentation - v0.4.6

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

Accessors
Methods
diff --git a/classes/RecordsSubscribe.html b/classes/RecordsSubscribe.html new file mode 100644 index 000000000..bed651f7f --- /dev/null +++ b/classes/RecordsSubscribe.html @@ -0,0 +1,21 @@ +RecordsSubscribe | DWN-SDK Documentation - v0.4.6

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

Accessors
Methods
diff --git a/classes/RecordsWrite.html b/classes/RecordsWrite.html new file mode 100644 index 000000000..b741ca8d4 --- /dev/null +++ b/classes/RecordsWrite.html @@ -0,0 +1,87 @@ +RecordsWrite | DWN-SDK Documentation - v0.4.6

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

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

    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.

    +

StaticfetchNewestRecordsWrite

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

Properties
Accessors
Methods
diff --git a/classes/ResumableTaskStoreLevel.html b/classes/ResumableTaskStoreLevel.html new file mode 100644 index 000000000..406756996 --- /dev/null +++ b/classes/ResumableTaskStoreLevel.html @@ -0,0 +1,41 @@ +ResumableTaskStoreLevel | DWN-SDK Documentation - v0.4.6

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

Constructors
Properties
Methods
diff --git a/classes/Secp256k1.html b/classes/Secp256k1.html new file mode 100644 index 000000000..6ef907fc8 --- /dev/null +++ b/classes/Secp256k1.html @@ -0,0 +1,27 @@ +Secp256k1 | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/classes/Secp256r1.html b/classes/Secp256r1.html new file mode 100644 index 000000000..d06af5a9c --- /dev/null +++ b/classes/Secp256r1.html @@ -0,0 +1,20 @@ +Secp256r1 | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/classes/TestDataGenerator.html b/classes/TestDataGenerator.html new file mode 100644 index 000000000..098ad1ef9 --- /dev/null +++ b/classes/TestDataGenerator.html @@ -0,0 +1,60 @@ +TestDataGenerator | DWN-SDK Documentation - v0.4.6

Class TestDataGenerator

Utility class for generating data for testing.

+

Constructors

constructor +

Methods

createDidResolutionResult +generateAuthorization +generateAuthorizationSignature +generateDidKeyPersona +generateFromRecordsWrite +generateGrantCreate +generateMessagesQuery +generateMessagesRead +generateMessagesSubscribe +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

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>

StaticgenerateMessagesQuery

  • generateMessagesQuery(input): Promise<GenerateMessagesQueryOutput>

  • Parameters

    • input: GenerateMessagesQueryInput

    Returns Promise<GenerateMessagesQueryOutput>

StaticgenerateMessagesRead

  • generateMessagesRead(input): Promise<GenerateMessagesReadOutput>

  • Parameters

    • input: GenerateMessagesReadInput

    Returns Promise<GenerateMessagesReadOutput>

StaticgenerateMessagesSubscribe

  • generateMessagesSubscribe(input?): Promise<GenerateMessagesSubscribeOutput>

  • Generates a MessagesSubscribe message for testing.

    +

    Parameters

    • Optionalinput: GenerateMessagesSubscribeInput

    Returns Promise<GenerateMessagesSubscribeOutput>

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. +dataBytes & dataStream returned will be undefined as long as dataCid or dataSize is given. +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

Constructors
Methods
diff --git a/classes/Time.html b/classes/Time.html new file mode 100644 index 000000000..bffda0234 --- /dev/null +++ b/classes/Time.html @@ -0,0 +1,24 @@ +Time | DWN-SDK Documentation - v0.4.6

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

Constructors
Methods
diff --git a/enums/DateSort.html b/enums/DateSort.html new file mode 100644 index 000000000..f40ba6a6b --- /dev/null +++ b/enums/DateSort.html @@ -0,0 +1,5 @@ +DateSort | DWN-SDK Documentation - v0.4.6

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

Enumeration Members
diff --git a/enums/DwnErrorCode.html b/enums/DwnErrorCode.html new file mode 100644 index 000000000..b8de7863e --- /dev/null +++ b/enums/DwnErrorCode.html @@ -0,0 +1,149 @@ +DwnErrorCode | DWN-SDK Documentation - v0.4.6

Enumeration DwnErrorCode

DWN SDK error codes.

+

Enumeration Members

AuthenticateDescriptorCidMismatch +AuthenticateJwsMissing +AuthenticationMoreThanOneSignatureNotSupported +AuthorizationAuthorNotOwner +AuthorizationNotGrantedToAuthor +ComputeCidCodecNotSupported +ComputeCidMultihashNotSupported +Ed25519InvalidJwk +EventEmitterStreamNotOpenError +GeneralJwsVerifierGetPublicKeyNotFound +GeneralJwsVerifierInvalidSignature +GrantAuthorizationGrantExpired +GrantAuthorizationGrantMissing +GrantAuthorizationGrantNotYetActive +GrantAuthorizationGrantRevoked +GrantAuthorizationInterfaceMismatch +GrantAuthorizationMethodMismatch +GrantAuthorizationNotGrantedForTenant +GrantAuthorizationNotGrantedToAuthor +HdKeyDerivationPathInvalid +IndexInvalidCursorSortProperty +IndexInvalidCursorValueType +IndexInvalidSortPropertyInMemory +IndexMissingIndexableProperty +JwsDecodePlainObjectPayloadInvalid +JwsVerifySignatureUnsupportedCrv +MessageGetInvalidCid +MessagesGrantAuthorizationMismatchedProtocol +MessagesQueryAuthorizationFailed +MessagesReadAuthorizationFailed +MessagesReadInvalidCid +MessagesReadVerifyScopeFailed +MessagesSubscribeAuthorizationFailed +MessagesSubscribeEventStreamUnimplemented +ParseCidCodecNotSupported +ParseCidMultihashNotSupported +PermissionsProtocolCreateGrantRecordsScopeMissingProtocol +PermissionsProtocolCreateRequestRecordsScopeMissingProtocol +PermissionsProtocolGetScopeInvalidProtocol +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 +ProtocolAuthorizationRoleMissingRecipient +ProtocolAuthorizationTagsInvalidSchema +ProtocolsConfigureDuplicateActorInRuleSet +ProtocolsConfigureDuplicateRoleInRuleSet +ProtocolsConfigureInvalidActionDeleteWithoutCreate +ProtocolsConfigureInvalidActionMissingOf +ProtocolsConfigureInvalidActionOfNotAllowed +ProtocolsConfigureInvalidActionUpdateWithoutCreate +ProtocolsConfigureInvalidRecipientOfAction +ProtocolsConfigureInvalidRuleSetRecordType +ProtocolsConfigureInvalidSize +ProtocolsConfigureInvalidTagSchema +ProtocolsConfigureRecordNestingDepthExceeded +ProtocolsConfigureRoleDoesNotExistAtGivenPath +ProtocolsQueryUnauthorized +RecordsAuthorDelegatedGrantAndIdExistenceMismatch +RecordsAuthorDelegatedGrantCidMismatch +RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch +RecordsAuthorDelegatedGrantNotADelegatedGrant +RecordsDecryptNoMatchingKeyEncryptedFound +RecordsDeleteAuthorizationFailed +RecordsDerivePrivateKeyUnSupportedCurve +RecordsGrantAuthorizationConditionPublicationProhibited +RecordsGrantAuthorizationConditionPublicationRequired +RecordsGrantAuthorizationDeleteProtocolScopeMismatch +RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch +RecordsGrantAuthorizationScopeContextIdMismatch +RecordsGrantAuthorizationScopeProtocolMismatch +RecordsGrantAuthorizationScopeProtocolPathMismatch +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 +RecordsWriteGetNewestWriteRecordNotFound +RecordsWriteImmutablePropertyChanged +RecordsWriteMissingDataInPrevious +RecordsWriteMissingEncodedDataInPrevious +RecordsWriteMissingProtocol +RecordsWriteMissingSchema +RecordsWriteMissingSigner +RecordsWriteNotAllowedAfterDelete +RecordsWriteOwnerAndTenantMismatch +RecordsWriteSignAsOwnerDelegateUnknownAuthor +RecordsWriteSignAsOwnerUnknownAuthor +RecordsWriteValidateIntegrityAttestationMismatch +RecordsWriteValidateIntegrityContextIdMismatch +RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload +RecordsWriteValidateIntegrityDateCreatedMismatch +RecordsWriteValidateIntegrityEncryptionCidMismatch +RecordsWriteValidateIntegrityRecordIdUnauthorized +SchemaValidatorAdditionalPropertyNotAllowed +SchemaValidatorFailure +SchemaValidatorSchemaNotFound +SchemaValidatorUnevaluatedPropertyNotAllowed +Secp256k1KeyNotValid +Secp256r1KeyNotValid +TimestampInvalid +UrlProtocolNotNormalizable +UrlProtocolNotNormalized +UrlSchemaNotNormalized +

Enumeration Members

AuthenticateDescriptorCidMismatch

AuthenticateDescriptorCidMismatch: "AuthenticateDescriptorCidMismatch"

AuthenticateJwsMissing

AuthenticateJwsMissing: "AuthenticateJwsMissing"

AuthenticationMoreThanOneSignatureNotSupported

AuthenticationMoreThanOneSignatureNotSupported: "AuthenticationMoreThanOneSignatureNotSupported"

AuthorizationAuthorNotOwner

AuthorizationAuthorNotOwner: "AuthorizationAuthorNotOwner"

AuthorizationNotGrantedToAuthor

AuthorizationNotGrantedToAuthor: "AuthorizationNotGrantedToAuthor"

ComputeCidCodecNotSupported

ComputeCidCodecNotSupported: "ComputeCidCodecNotSupported"

ComputeCidMultihashNotSupported

ComputeCidMultihashNotSupported: "ComputeCidMultihashNotSupported"

Ed25519InvalidJwk

Ed25519InvalidJwk: "Ed25519InvalidJwk"

EventEmitterStreamNotOpenError

EventEmitterStreamNotOpenError: "EventEmitterStreamNotOpenError"

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"

MessagesGrantAuthorizationMismatchedProtocol

MessagesGrantAuthorizationMismatchedProtocol: "EventsGrantAuthorizationMismatchedProtocol"

MessagesQueryAuthorizationFailed

MessagesQueryAuthorizationFailed: "MessagesQueryAuthorizationFailed"

MessagesReadAuthorizationFailed

MessagesReadAuthorizationFailed: "MessagesReadAuthorizationFailed"

MessagesReadInvalidCid

MessagesReadInvalidCid: "MessagesReadInvalidCid"

MessagesReadVerifyScopeFailed

MessagesReadVerifyScopeFailed: "MessagesReadVerifyScopeFailed"

MessagesSubscribeAuthorizationFailed

MessagesSubscribeAuthorizationFailed: "MessagesSubscribeAuthorizationFailed"

MessagesSubscribeEventStreamUnimplemented

MessagesSubscribeEventStreamUnimplemented: "MessagesSubscribeEventStreamUnimplemented"

ParseCidCodecNotSupported

ParseCidCodecNotSupported: "ParseCidCodecNotSupported"

ParseCidMultihashNotSupported

ParseCidMultihashNotSupported: "ParseCidMultihashNotSupported"

PermissionsProtocolCreateGrantRecordsScopeMissingProtocol

PermissionsProtocolCreateGrantRecordsScopeMissingProtocol: "PermissionsProtocolCreateGrantRecordsScopeMissingProtocol"

PermissionsProtocolCreateRequestRecordsScopeMissingProtocol

PermissionsProtocolCreateRequestRecordsScopeMissingProtocol: "PermissionsProtocolCreateRequestRecordsScopeMissingProtocol"

PermissionsProtocolGetScopeInvalidProtocol

PermissionsProtocolGetScopeInvalidProtocol: "PermissionsProtocolGetScopeInvalidProtocol"

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"

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"

ProtocolsConfigureRecordNestingDepthExceeded

ProtocolsConfigureRecordNestingDepthExceeded: "ProtocolsConfigureRecordNestingDepthExceeded"

ProtocolsConfigureRoleDoesNotExistAtGivenPath

ProtocolsConfigureRoleDoesNotExistAtGivenPath: "ProtocolsConfigureRoleDoesNotExistAtGivenPath"

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"

RecordsGrantAuthorizationScopeProtocolMismatch

RecordsGrantAuthorizationScopeProtocolMismatch: "RecordsGrantAuthorizationScopeProtocolMismatch"

RecordsGrantAuthorizationScopeProtocolPathMismatch

RecordsGrantAuthorizationScopeProtocolPathMismatch: "RecordsGrantAuthorizationScopeProtocolPathMismatch"

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"

RecordsWriteGetNewestWriteRecordNotFound

RecordsWriteGetNewestWriteRecordNotFound: "RecordsWriteGetNewestWriteRecordNotFound"

RecordsWriteImmutablePropertyChanged

RecordsWriteImmutablePropertyChanged: "RecordsWriteImmutablePropertyChanged"

RecordsWriteMissingDataInPrevious

RecordsWriteMissingDataInPrevious: "RecordsWriteMissingDataInPrevious"

RecordsWriteMissingEncodedDataInPrevious

RecordsWriteMissingEncodedDataInPrevious: "RecordsWriteMissingEncodedDataInPrevious"

RecordsWriteMissingProtocol

RecordsWriteMissingProtocol: "RecordsWriteMissingProtocol"

RecordsWriteMissingSchema

RecordsWriteMissingSchema: "RecordsWriteMissingSchema"

RecordsWriteMissingSigner

RecordsWriteMissingSigner: "RecordsWriteMissingSigner"

RecordsWriteNotAllowedAfterDelete

RecordsWriteNotAllowedAfterDelete: "RecordsWriteNotAllowedAfterDelete"

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"

UrlSchemaNotNormalized

UrlSchemaNotNormalized: "UrlSchemaNotNormalized"

Settings

Member Visibility

On This Page

Enumeration Members
AuthenticateDescriptorCidMismatchAuthenticateJwsMissingAuthenticationMoreThanOneSignatureNotSupportedAuthorizationAuthorNotOwnerAuthorizationNotGrantedToAuthorComputeCidCodecNotSupportedComputeCidMultihashNotSupportedEd25519InvalidJwkEventEmitterStreamNotOpenErrorGeneralJwsVerifierGetPublicKeyNotFoundGeneralJwsVerifierInvalidSignatureGrantAuthorizationGrantExpiredGrantAuthorizationGrantMissingGrantAuthorizationGrantNotYetActiveGrantAuthorizationGrantRevokedGrantAuthorizationInterfaceMismatchGrantAuthorizationMethodMismatchGrantAuthorizationNotGrantedForTenantGrantAuthorizationNotGrantedToAuthorHdKeyDerivationPathInvalidIndexInvalidCursorSortPropertyIndexInvalidCursorValueTypeIndexInvalidSortPropertyInMemoryIndexMissingIndexablePropertyJwsDecodePlainObjectPayloadInvalidJwsVerifySignatureUnsupportedCrvMessageGetInvalidCidMessagesGrantAuthorizationMismatchedProtocolMessagesQueryAuthorizationFailedMessagesReadAuthorizationFailedMessagesReadInvalidCidMessagesReadVerifyScopeFailedMessagesSubscribeAuthorizationFailedMessagesSubscribeEventStreamUnimplementedParseCidCodecNotSupportedParseCidMultihashNotSupportedPermissionsProtocolCreateGrantRecordsScopeMissingProtocolPermissionsProtocolCreateRequestRecordsScopeMissingProtocolPermissionsProtocolGetScopeInvalidProtocolPermissionsProtocolValidateRevocationProtocolTagMismatchPermissionsProtocolValidateSchemaUnexpectedRecordPermissionsProtocolValidateScopeContextIdProhibitedPropertiesPermissionsProtocolValidateScopeMissingProtocolTagPermissionsProtocolValidateScopeProtocolMismatchPrivateKeySignerUnableToDeduceAlgorithmPrivateKeySignerUnableToDeduceKeyIdPrivateKeySignerUnsupportedCurveProtocolAuthorizationActionNotAllowedProtocolAuthorizationActionRulesNotFoundProtocolAuthorizationDuplicateRoleRecipientProtocolAuthorizationIncorrectContextIdProtocolAuthorizationIncorrectDataFormatProtocolAuthorizationIncorrectProtocolPathProtocolAuthorizationInvalidSchemaProtocolAuthorizationInvalidTypeProtocolAuthorizationMatchingRoleRecordNotFoundProtocolAuthorizationMaxSizeInvalidProtocolAuthorizationMinSizeInvalidProtocolAuthorizationMissingContextIdProtocolAuthorizationMissingRuleSetProtocolAuthorizationNotARoleProtocolAuthorizationParentNotFoundConstructingRecordChainProtocolAuthorizationParentlessIncorrectProtocolPathProtocolAuthorizationProtocolNotFoundProtocolAuthorizationRoleMissingRecipientProtocolAuthorizationTagsInvalidSchemaProtocolsConfigureDuplicateActorInRuleSetProtocolsConfigureDuplicateRoleInRuleSetProtocolsConfigureInvalidActionDeleteWithoutCreateProtocolsConfigureInvalidActionMissingOfProtocolsConfigureInvalidActionOfNotAllowedProtocolsConfigureInvalidActionUpdateWithoutCreateProtocolsConfigureInvalidRecipientOfActionProtocolsConfigureInvalidRuleSetRecordTypeProtocolsConfigureInvalidSizeProtocolsConfigureInvalidTagSchemaProtocolsConfigureRecordNestingDepthExceededProtocolsConfigureRoleDoesNotExistAtGivenPathProtocolsQueryUnauthorizedRecordsAuthorDelegatedGrantAndIdExistenceMismatchRecordsAuthorDelegatedGrantCidMismatchRecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatchRecordsAuthorDelegatedGrantNotADelegatedGrantRecordsDecryptNoMatchingKeyEncryptedFoundRecordsDeleteAuthorizationFailedRecordsDerivePrivateKeyUnSupportedCurveRecordsGrantAuthorizationConditionPublicationProhibitedRecordsGrantAuthorizationConditionPublicationRequiredRecordsGrantAuthorizationDeleteProtocolScopeMismatchRecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatchRecordsGrantAuthorizationScopeContextIdMismatchRecordsGrantAuthorizationScopeProtocolMismatchRecordsGrantAuthorizationScopeProtocolPathMismatchRecordsInvalidAncestorKeyDerivationSegmentRecordsOwnerDelegatedGrantAndIdExistenceMismatchRecordsOwnerDelegatedGrantCidMismatchRecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatchRecordsOwnerDelegatedGrantNotADelegatedGrantRecordsProtocolContextDerivationSchemeMissingContextIdRecordsProtocolPathDerivationSchemeMissingProtocolRecordsQueryCreateFilterPublishedSortInvalidRecordsQueryFilterMissingRequiredPropertiesRecordsQueryParseFilterPublishedSortInvalidRecordsReadAuthorizationFailedRecordsReadReturnedMultipleRecordsSchemasDerivationSchemeMissingSchemaRecordsSubscribeEventStreamUnimplementedRecordsSubscribeFilterMissingRequiredPropertiesRecordsWriteAttestationIntegrityDescriptorCidMismatchRecordsWriteAttestationIntegrityInvalidPayloadPropertyRecordsWriteAttestationIntegrityMoreThanOneSignatureRecordsWriteAuthorizationFailedRecordsWriteCreateDataAndDataCidMutuallyExclusiveRecordsWriteCreateDataCidAndDataSizeMutuallyInclusiveRecordsWriteCreateMissingSignerRecordsWriteCreateProtocolAndProtocolPathMutuallyInclusiveRecordsWriteDataCidMismatchRecordsWriteDataSizeMismatchRecordsWriteGetEntryIdUndefinedAuthorRecordsWriteGetInitialWriteNotFoundRecordsWriteGetNewestWriteRecordNotFoundRecordsWriteImmutablePropertyChangedRecordsWriteMissingDataInPreviousRecordsWriteMissingEncodedDataInPreviousRecordsWriteMissingProtocolRecordsWriteMissingSchemaRecordsWriteMissingSignerRecordsWriteNotAllowedAfterDeleteRecordsWriteOwnerAndTenantMismatchRecordsWriteSignAsOwnerDelegateUnknownAuthorRecordsWriteSignAsOwnerUnknownAuthorRecordsWriteValidateIntegrityAttestationMismatchRecordsWriteValidateIntegrityContextIdMismatchRecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayloadRecordsWriteValidateIntegrityDateCreatedMismatchRecordsWriteValidateIntegrityEncryptionCidMismatchRecordsWriteValidateIntegrityRecordIdUnauthorizedSchemaValidatorAdditionalPropertyNotAllowedSchemaValidatorFailureSchemaValidatorSchemaNotFoundSchemaValidatorUnevaluatedPropertyNotAllowedSecp256k1KeyNotValidSecp256r1KeyNotValidTimestampInvalidUrlProtocolNotNormalizableUrlProtocolNotNormalizedUrlSchemaNotNormalized
diff --git a/enums/DwnInterfaceName.html b/enums/DwnInterfaceName.html new file mode 100644 index 000000000..7ade0fb39 --- /dev/null +++ b/enums/DwnInterfaceName.html @@ -0,0 +1,4 @@ +DwnInterfaceName | DWN-SDK Documentation - v0.4.6

Enumeration DwnInterfaceName

Enumeration Members

Messages +Protocols +Records +

Enumeration Members

Messages

Messages: "Messages"

Protocols

Protocols: "Protocols"

Records

Records: "Records"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/DwnMethodName.html b/enums/DwnMethodName.html new file mode 100644 index 000000000..c140c0645 --- /dev/null +++ b/enums/DwnMethodName.html @@ -0,0 +1,7 @@ +DwnMethodName | DWN-SDK Documentation - v0.4.6

Enumeration DwnMethodName

Enumeration Members

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

Enumeration Members

Configure

Configure: "Configure"

Delete

Delete: "Delete"

Query

Query: "Query"

Read

Read: "Read"

Subscribe

Subscribe: "Subscribe"

Write

Write: "Write"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/EncryptionAlgorithm.html b/enums/EncryptionAlgorithm.html new file mode 100644 index 000000000..c311e395f --- /dev/null +++ b/enums/EncryptionAlgorithm.html @@ -0,0 +1,3 @@ +EncryptionAlgorithm | DWN-SDK Documentation - v0.4.6

Enumeration EncryptionAlgorithm

Enumeration Members

Aes256Ctr +EciesSecp256k1 +

Enumeration Members

Aes256Ctr

Aes256Ctr: "A256CTR"

EciesSecp256k1

EciesSecp256k1: "ECIES-ES256K"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/KeyDerivationScheme.html b/enums/KeyDerivationScheme.html new file mode 100644 index 000000000..18c092b2a --- /dev/null +++ b/enums/KeyDerivationScheme.html @@ -0,0 +1,7 @@ +KeyDerivationScheme | DWN-SDK Documentation - v0.4.6

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

Enumeration Members
diff --git a/enums/PermissionConditionPublication.html b/enums/PermissionConditionPublication.html new file mode 100644 index 000000000..db93d8f8d --- /dev/null +++ b/enums/PermissionConditionPublication.html @@ -0,0 +1,3 @@ +PermissionConditionPublication | DWN-SDK Documentation - v0.4.6

Enumeration PermissionConditionPublication

Enumeration Members

Prohibited +Required +

Enumeration Members

Prohibited

Prohibited: "Prohibited"

Required

Required: "Required"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/SortDirection.html b/enums/SortDirection.html new file mode 100644 index 000000000..4d31b8e1c --- /dev/null +++ b/enums/SortDirection.html @@ -0,0 +1,3 @@ +SortDirection | DWN-SDK Documentation - v0.4.6

Enumeration SortDirection

Enumeration Members

Ascending +Descending +

Enumeration Members

Ascending

Ascending: 1

Descending

Descending: -1

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/functions/authenticate.html b/functions/authenticate.html new file mode 100644 index 000000000..a121c1abd --- /dev/null +++ b/functions/authenticate.html @@ -0,0 +1,3 @@ +authenticate | DWN-SDK Documentation - v0.4.6

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
diff --git a/functions/executeUnlessAborted.html b/functions/executeUnlessAborted.html new file mode 100644 index 000000000..697ec511a --- /dev/null +++ b/functions/executeUnlessAborted.html @@ -0,0 +1,2 @@ +executeUnlessAborted | DWN-SDK Documentation - v0.4.6

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
diff --git a/hierarchy.html b/hierarchy.html new file mode 100644 index 000000000..d6dfdc3f8 --- /dev/null +++ b/hierarchy.html @@ -0,0 +1 @@ +DWN-SDK Documentation - v0.4.6

DWN-SDK Documentation - v0.4.6

Class Hierarchy

Settings

Member Visibility
diff --git a/index.html b/index.html new file mode 100644 index 000000000..ec923fcbb --- /dev/null +++ b/index.html @@ -0,0 +1,139 @@ +DWN-SDK Documentation - v0.4.6

DWN-SDK Documentation - v0.4.6

Index

Enumerations

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

Classes

AllowAllTenantGate +Cid +DataStoreLevel +DataStream +Dwn +DwnConstant +DwnError +Encoder +Encryption +EventEmitterStream +EventLogLevel +HdKey +Jws +Message +MessageStoreLevel +MessagesQuery +MessagesRead +MessagesSubscribe +PermissionGrant +PermissionRequest +PermissionsProtocol +Poller +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 +DataEncodedRecordsWriteMessage +DataStoreGetResult +DataStorePutResult +DerivedPrivateJwk +DwnConfig +EncryptionInput +EncryptionProperty +EqualFilter +EventListener +Filter +GenericMessage +GenericMessageReply +KeyEncryptionInput +KeyMaterial +ManagedResumableTask +MessageEvent +MessageSort +MessageSubscriptionHandler +MessagesFilter +MessagesPermissionScope +MessagesQueryMessage +MessagesQueryOptions +MessagesQueryReply +MessagesReadMessage +MessagesReadOptions +MessagesReadReply +MessagesReadReplyEntry +MessagesSubscribeDescriptor +MessagesSubscribeMessage +MessagesSubscribeOptions +MessagesSubscribeReply +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
diff --git a/interfaces/DataStore.html b/interfaces/DataStore.html new file mode 100644 index 000000000..927d02007 --- /dev/null +++ b/interfaces/DataStore.html @@ -0,0 +1,21 @@ +DataStore | DWN-SDK Documentation - v0.4.6

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

Methods
diff --git a/interfaces/EventLog.html b/interfaces/EventLog.html new file mode 100644 index 000000000..187bc2c2a --- /dev/null +++ b/interfaces/EventLog.html @@ -0,0 +1,25 @@ +EventLog | DWN-SDK Documentation - v0.4.6

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

Methods
diff --git a/interfaces/EventStream.html b/interfaces/EventStream.html new file mode 100644 index 000000000..c79b6f0b0 --- /dev/null +++ b/interfaces/EventStream.html @@ -0,0 +1,6 @@ +EventStream | DWN-SDK Documentation - v0.4.6

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

Methods
diff --git a/interfaces/EventSubscription.html b/interfaces/EventSubscription.html new file mode 100644 index 000000000..a403ec0b6 --- /dev/null +++ b/interfaces/EventSubscription.html @@ -0,0 +1,3 @@ +EventSubscription | DWN-SDK Documentation - v0.4.6

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

Properties
diff --git a/interfaces/MessageStore.html b/interfaces/MessageStore.html new file mode 100644 index 000000000..234f76af6 --- /dev/null +++ b/interfaces/MessageStore.html @@ -0,0 +1,18 @@ +MessageStore | DWN-SDK Documentation - v0.4.6

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

Methods
diff --git a/interfaces/MessageStoreOptions.html b/interfaces/MessageStoreOptions.html new file mode 100644 index 000000000..e956cf0fa --- /dev/null +++ b/interfaces/MessageStoreOptions.html @@ -0,0 +1,2 @@ +MessageStoreOptions | DWN-SDK Documentation - v0.4.6

Interface MessageStoreOptions

interface MessageStoreOptions {
    signal?: AbortSignal;
}

Properties

signal? +

Properties

Optionalsignal

signal?: AbortSignal

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/MessageSubscription.html b/interfaces/MessageSubscription.html new file mode 100644 index 000000000..fd781bff1 --- /dev/null +++ b/interfaces/MessageSubscription.html @@ -0,0 +1,3 @@ +MessageSubscription | DWN-SDK Documentation - v0.4.6

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

Properties
diff --git a/interfaces/ResumableTaskStore.html b/interfaces/ResumableTaskStore.html new file mode 100644 index 000000000..b40552369 --- /dev/null +++ b/interfaces/ResumableTaskStore.html @@ -0,0 +1,57 @@ +ResumableTaskStore | DWN-SDK Documentation - v0.4.6

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

Methods
diff --git a/interfaces/Signer.html b/interfaces/Signer.html new file mode 100644 index 000000000..7918fdf70 --- /dev/null +++ b/interfaces/Signer.html @@ -0,0 +1,16 @@ +Signer | DWN-SDK Documentation - v0.4.6

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

Properties
Methods
diff --git a/interfaces/TenantGate.html b/interfaces/TenantGate.html new file mode 100644 index 000000000..d2fe10f55 --- /dev/null +++ b/interfaces/TenantGate.html @@ -0,0 +1,4 @@ +TenantGate | DWN-SDK Documentation - v0.4.6

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

Methods
diff --git a/types/ActiveTenantCheckResult.html b/types/ActiveTenantCheckResult.html new file mode 100644 index 000000000..68c847432 --- /dev/null +++ b/types/ActiveTenantCheckResult.html @@ -0,0 +1,4 @@ +ActiveTenantCheckResult | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/CreateFromOptions.html b/types/CreateFromOptions.html new file mode 100644 index 000000000..40f071726 --- /dev/null +++ b/types/CreateFromOptions.html @@ -0,0 +1,4 @@ +CreateFromOptions | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/DataEncodedRecordsWriteMessage.html b/types/DataEncodedRecordsWriteMessage.html new file mode 100644 index 000000000..63ee960ee --- /dev/null +++ b/types/DataEncodedRecordsWriteMessage.html @@ -0,0 +1,3 @@ +DataEncodedRecordsWriteMessage | DWN-SDK Documentation - v0.4.6

Type Alias DataEncodedRecordsWriteMessage

DataEncodedRecordsWriteMessage: RecordsWriteMessage & {
    encodedData: string;
}

Represents a RecordsWrite message with encoded data attached.

+

Type declaration

  • encodedData: string

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

    +

Settings

Member Visibility
diff --git a/types/DataStoreGetResult.html b/types/DataStoreGetResult.html new file mode 100644 index 000000000..e26d53ec5 --- /dev/null +++ b/types/DataStoreGetResult.html @@ -0,0 +1,3 @@ +DataStoreGetResult | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/DataStorePutResult.html b/types/DataStorePutResult.html new file mode 100644 index 000000000..4a780d4d2 --- /dev/null +++ b/types/DataStorePutResult.html @@ -0,0 +1,3 @@ +DataStorePutResult | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/DerivedPrivateJwk.html b/types/DerivedPrivateJwk.html new file mode 100644 index 000000000..7b4bb86e1 --- /dev/null +++ b/types/DerivedPrivateJwk.html @@ -0,0 +1 @@ +DerivedPrivateJwk | DWN-SDK Documentation - v0.4.6

Type Alias DerivedPrivateJwk

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

Settings

Member Visibility
diff --git a/types/DwnConfig.html b/types/DwnConfig.html new file mode 100644 index 000000000..1882af7bb --- /dev/null +++ b/types/DwnConfig.html @@ -0,0 +1,2 @@ +DwnConfig | DWN-SDK Documentation - v0.4.6

Type Alias DwnConfig

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

DWN configuration.

+

Settings

Member Visibility
diff --git a/types/EncryptionInput.html b/types/EncryptionInput.html new file mode 100644 index 000000000..69f71c66f --- /dev/null +++ b/types/EncryptionInput.html @@ -0,0 +1,7 @@ +EncryptionInput | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/EncryptionProperty.html b/types/EncryptionProperty.html new file mode 100644 index 000000000..ab551c842 --- /dev/null +++ b/types/EncryptionProperty.html @@ -0,0 +1 @@ +EncryptionProperty | DWN-SDK Documentation - v0.4.6

Type Alias EncryptionProperty

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

Settings

Member Visibility
diff --git a/types/EqualFilter.html b/types/EqualFilter.html new file mode 100644 index 000000000..674dabc1e --- /dev/null +++ b/types/EqualFilter.html @@ -0,0 +1 @@ +EqualFilter | DWN-SDK Documentation - v0.4.6

Type Alias EqualFilter

EqualFilter: string | number | boolean

Settings

Member Visibility
diff --git a/types/EventListener.html b/types/EventListener.html new file mode 100644 index 000000000..fe40a7d42 --- /dev/null +++ b/types/EventListener.html @@ -0,0 +1 @@ +EventListener | DWN-SDK Documentation - v0.4.6

Type Alias EventListener

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

Settings

Member Visibility
diff --git a/types/Filter.html b/types/Filter.html new file mode 100644 index 000000000..8ef9e29cd --- /dev/null +++ b/types/Filter.html @@ -0,0 +1 @@ +Filter | DWN-SDK Documentation - v0.4.6

Type Alias Filter

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

Settings

Member Visibility
diff --git a/types/GenericMessage.html b/types/GenericMessage.html new file mode 100644 index 000000000..b724c9905 --- /dev/null +++ b/types/GenericMessage.html @@ -0,0 +1,2 @@ +GenericMessage | DWN-SDK Documentation - v0.4.6

Type Alias GenericMessage

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

Intersection type for all concrete message types.

+

Settings

Member Visibility
diff --git a/types/GenericMessageReply.html b/types/GenericMessageReply.html new file mode 100644 index 000000000..991773473 --- /dev/null +++ b/types/GenericMessageReply.html @@ -0,0 +1 @@ +GenericMessageReply | DWN-SDK Documentation - v0.4.6

Type Alias GenericMessageReply

GenericMessageReply: {
    status: Status;
}

Settings

Member Visibility
diff --git a/types/KeyEncryptionInput.html b/types/KeyEncryptionInput.html new file mode 100644 index 000000000..e37046fc9 --- /dev/null +++ b/types/KeyEncryptionInput.html @@ -0,0 +1,7 @@ +KeyEncryptionInput | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/KeyMaterial.html b/types/KeyMaterial.html new file mode 100644 index 000000000..2d9a3da2f --- /dev/null +++ b/types/KeyMaterial.html @@ -0,0 +1,2 @@ +KeyMaterial | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/ManagedResumableTask.html b/types/ManagedResumableTask.html new file mode 100644 index 000000000..1b9fe2c9c --- /dev/null +++ b/types/ManagedResumableTask.html @@ -0,0 +1,6 @@ +ManagedResumableTask | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/MessageEvent.html b/types/MessageEvent.html new file mode 100644 index 000000000..d20059ee6 --- /dev/null +++ b/types/MessageEvent.html @@ -0,0 +1,3 @@ +MessageEvent | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/MessageSort.html b/types/MessageSort.html new file mode 100644 index 000000000..2b4c85204 --- /dev/null +++ b/types/MessageSort.html @@ -0,0 +1 @@ +MessageSort | DWN-SDK Documentation - v0.4.6

Type Alias MessageSort

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

Settings

Member Visibility
diff --git a/types/MessageSubscriptionHandler.html b/types/MessageSubscriptionHandler.html new file mode 100644 index 000000000..10d437748 --- /dev/null +++ b/types/MessageSubscriptionHandler.html @@ -0,0 +1 @@ +MessageSubscriptionHandler | DWN-SDK Documentation - v0.4.6

Type Alias MessageSubscriptionHandler

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

Settings

Member Visibility
diff --git a/types/MessagesFilter.html b/types/MessagesFilter.html new file mode 100644 index 000000000..468bef4db --- /dev/null +++ b/types/MessagesFilter.html @@ -0,0 +1,2 @@ +MessagesFilter | DWN-SDK Documentation - v0.4.6

Type Alias MessagesFilter

MessagesFilter: {
    interface?: string;
    messageTimestamp?: RangeCriterion;
    method?: string;
    protocol?: string;
}

filters used when filtering for any type of Message across interfaces

+

Settings

Member Visibility
diff --git a/types/MessagesPermissionScope.html b/types/MessagesPermissionScope.html new file mode 100644 index 000000000..2baea4d0b --- /dev/null +++ b/types/MessagesPermissionScope.html @@ -0,0 +1 @@ +MessagesPermissionScope | DWN-SDK Documentation - v0.4.6

Type Alias MessagesPermissionScope

MessagesPermissionScope: {
    interface: Messages;
    method: Query | Read | Subscribe;
    protocol?: string;
}

Settings

Member Visibility
diff --git a/types/MessagesQueryMessage.html b/types/MessagesQueryMessage.html new file mode 100644 index 000000000..209c4200d --- /dev/null +++ b/types/MessagesQueryMessage.html @@ -0,0 +1 @@ +MessagesQueryMessage | DWN-SDK Documentation - v0.4.6

Type Alias MessagesQueryMessage

MessagesQueryMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: MessagesQueryDescriptor;
}

Settings

Member Visibility
diff --git a/types/MessagesQueryOptions.html b/types/MessagesQueryOptions.html new file mode 100644 index 000000000..39f933c28 --- /dev/null +++ b/types/MessagesQueryOptions.html @@ -0,0 +1 @@ +MessagesQueryOptions | DWN-SDK Documentation - v0.4.6

Type Alias MessagesQueryOptions

MessagesQueryOptions: {
    cursor?: PaginationCursor;
    filters?: MessagesFilter[];
    messageTimestamp?: string;
    permissionGrantId?: string;
    signer: Signer;
}

Settings

Member Visibility
diff --git a/types/MessagesQueryReply.html b/types/MessagesQueryReply.html new file mode 100644 index 000000000..5744f1343 --- /dev/null +++ b/types/MessagesQueryReply.html @@ -0,0 +1 @@ +MessagesQueryReply | DWN-SDK Documentation - v0.4.6

Type Alias MessagesQueryReply

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

Settings

Member Visibility
diff --git a/types/MessagesReadMessage.html b/types/MessagesReadMessage.html new file mode 100644 index 000000000..3f28283c7 --- /dev/null +++ b/types/MessagesReadMessage.html @@ -0,0 +1 @@ +MessagesReadMessage | DWN-SDK Documentation - v0.4.6

Type Alias MessagesReadMessage

MessagesReadMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: MessagesReadDescriptor;
}

Settings

Member Visibility
diff --git a/types/MessagesReadOptions.html b/types/MessagesReadOptions.html new file mode 100644 index 000000000..5b1e1fc31 --- /dev/null +++ b/types/MessagesReadOptions.html @@ -0,0 +1 @@ +MessagesReadOptions | DWN-SDK Documentation - v0.4.6

Type Alias MessagesReadOptions

MessagesReadOptions: {
    messageCid: string;
    messageTimestamp?: string;
    permissionGrantId?: string;
    signer: Signer;
}

Settings

Member Visibility
diff --git a/types/MessagesReadReply.html b/types/MessagesReadReply.html new file mode 100644 index 000000000..80e33d658 --- /dev/null +++ b/types/MessagesReadReply.html @@ -0,0 +1 @@ +MessagesReadReply | DWN-SDK Documentation - v0.4.6

Type Alias MessagesReadReply

MessagesReadReply: GenericMessageReply & {
    entry?: MessagesReadReplyEntry;
}

Settings

Member Visibility
diff --git a/types/MessagesReadReplyEntry.html b/types/MessagesReadReplyEntry.html new file mode 100644 index 000000000..700e3066c --- /dev/null +++ b/types/MessagesReadReplyEntry.html @@ -0,0 +1 @@ +MessagesReadReplyEntry | DWN-SDK Documentation - v0.4.6

Type Alias MessagesReadReplyEntry

MessagesReadReplyEntry: {
    data?: Readable;
    message: GenericMessage;
    messageCid: string;
}

Settings

Member Visibility
diff --git a/types/MessagesSubscribeDescriptor.html b/types/MessagesSubscribeDescriptor.html new file mode 100644 index 000000000..51cc3b7af --- /dev/null +++ b/types/MessagesSubscribeDescriptor.html @@ -0,0 +1 @@ +MessagesSubscribeDescriptor | DWN-SDK Documentation - v0.4.6

Type Alias MessagesSubscribeDescriptor

MessagesSubscribeDescriptor: {
    filters: MessagesFilter[];
    interface: Messages;
    messageTimestamp: string;
    method: Subscribe;
}

Settings

Member Visibility
diff --git a/types/MessagesSubscribeMessage.html b/types/MessagesSubscribeMessage.html new file mode 100644 index 000000000..bc2988192 --- /dev/null +++ b/types/MessagesSubscribeMessage.html @@ -0,0 +1 @@ +MessagesSubscribeMessage | DWN-SDK Documentation - v0.4.6

Type Alias MessagesSubscribeMessage

MessagesSubscribeMessage: {
    authorization: AuthorizationModel;
    descriptor: MessagesSubscribeDescriptor;
}

Settings

Member Visibility
diff --git a/types/MessagesSubscribeOptions.html b/types/MessagesSubscribeOptions.html new file mode 100644 index 000000000..e6e0164d1 --- /dev/null +++ b/types/MessagesSubscribeOptions.html @@ -0,0 +1 @@ +MessagesSubscribeOptions | DWN-SDK Documentation - v0.4.6

Type Alias MessagesSubscribeOptions

MessagesSubscribeOptions: {
    filters?: MessagesFilter[];
    messageTimestamp?: string;
    permissionGrantId?: string;
    signer: Signer;
}

Settings

Member Visibility
diff --git a/types/MessagesSubscribeReply.html b/types/MessagesSubscribeReply.html new file mode 100644 index 000000000..8eb97ad6a --- /dev/null +++ b/types/MessagesSubscribeReply.html @@ -0,0 +1 @@ +MessagesSubscribeReply | DWN-SDK Documentation - v0.4.6

Type Alias MessagesSubscribeReply

MessagesSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Settings

Member Visibility
diff --git a/types/OneOfFilter.html b/types/OneOfFilter.html new file mode 100644 index 000000000..e80204f92 --- /dev/null +++ b/types/OneOfFilter.html @@ -0,0 +1 @@ +OneOfFilter | DWN-SDK Documentation - v0.4.6

Type Alias OneOfFilter

OneOfFilter: EqualFilter[]

Settings

Member Visibility
diff --git a/types/Pagination.html b/types/Pagination.html new file mode 100644 index 000000000..38301370f --- /dev/null +++ b/types/Pagination.html @@ -0,0 +1,3 @@ +Pagination | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/PaginationCursor.html b/types/PaginationCursor.html new file mode 100644 index 000000000..2d3857163 --- /dev/null +++ b/types/PaginationCursor.html @@ -0,0 +1 @@ +PaginationCursor | DWN-SDK Documentation - v0.4.6

Type Alias PaginationCursor

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

Settings

Member Visibility
diff --git a/types/PermissionConditions.html b/types/PermissionConditions.html new file mode 100644 index 000000000..047bc32bc --- /dev/null +++ b/types/PermissionConditions.html @@ -0,0 +1,4 @@ +PermissionConditions | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/PermissionGrantData.html b/types/PermissionGrantData.html new file mode 100644 index 000000000..46eea8af4 --- /dev/null +++ b/types/PermissionGrantData.html @@ -0,0 +1,7 @@ +PermissionGrantData | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/PermissionRequestData.html b/types/PermissionRequestData.html new file mode 100644 index 000000000..af7bff621 --- /dev/null +++ b/types/PermissionRequestData.html @@ -0,0 +1,5 @@ +PermissionRequestData | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/PermissionRevocationData.html b/types/PermissionRevocationData.html new file mode 100644 index 000000000..8df7e2b99 --- /dev/null +++ b/types/PermissionRevocationData.html @@ -0,0 +1,3 @@ +PermissionRevocationData | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/PermissionScope.html b/types/PermissionScope.html new file mode 100644 index 000000000..3891f81c0 --- /dev/null +++ b/types/PermissionScope.html @@ -0,0 +1,2 @@ +PermissionScope | DWN-SDK Documentation - v0.4.6

Type Alias PermissionScope

PermissionScope: ProtocolPermissionScope | MessagesPermissionScope | RecordsPermissionScope

The data model for a permission scope.

+

Settings

Member Visibility
diff --git a/types/Persona.html b/types/Persona.html new file mode 100644 index 000000000..a93c5f82a --- /dev/null +++ b/types/Persona.html @@ -0,0 +1,2 @@ +Persona | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/PrivateJwk.html b/types/PrivateJwk.html new file mode 100644 index 000000000..254d4c236 --- /dev/null +++ b/types/PrivateJwk.html @@ -0,0 +1,4 @@ +PrivateJwk | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/ProtocolDefinition.html b/types/ProtocolDefinition.html new file mode 100644 index 000000000..03f0fb926 --- /dev/null +++ b/types/ProtocolDefinition.html @@ -0,0 +1,2 @@ +ProtocolDefinition | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/ProtocolPermissionScope.html b/types/ProtocolPermissionScope.html new file mode 100644 index 000000000..5ad5fc2f1 --- /dev/null +++ b/types/ProtocolPermissionScope.html @@ -0,0 +1 @@ +ProtocolPermissionScope | DWN-SDK Documentation - v0.4.6

Type Alias ProtocolPermissionScope

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

Settings

Member Visibility
diff --git a/types/ProtocolRuleSet.html b/types/ProtocolRuleSet.html new file mode 100644 index 000000000..9c72f6ffe --- /dev/null +++ b/types/ProtocolRuleSet.html @@ -0,0 +1,8 @@ +ProtocolRuleSet | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/ProtocolTypes.html b/types/ProtocolTypes.html new file mode 100644 index 000000000..adf02ceef --- /dev/null +++ b/types/ProtocolTypes.html @@ -0,0 +1 @@ +ProtocolTypes | DWN-SDK Documentation - v0.4.6

Type Alias ProtocolTypes

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

Settings

Member Visibility
diff --git a/types/ProtocolsConfigureDescriptor.html b/types/ProtocolsConfigureDescriptor.html new file mode 100644 index 000000000..86e092f75 --- /dev/null +++ b/types/ProtocolsConfigureDescriptor.html @@ -0,0 +1 @@ +ProtocolsConfigureDescriptor | DWN-SDK Documentation - v0.4.6

Type Alias ProtocolsConfigureDescriptor

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

Settings

Member Visibility
diff --git a/types/ProtocolsConfigureMessage.html b/types/ProtocolsConfigureMessage.html new file mode 100644 index 000000000..ad39f4236 --- /dev/null +++ b/types/ProtocolsConfigureMessage.html @@ -0,0 +1 @@ +ProtocolsConfigureMessage | DWN-SDK Documentation - v0.4.6

Type Alias ProtocolsConfigureMessage

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

Settings

Member Visibility
diff --git a/types/ProtocolsConfigureOptions.html b/types/ProtocolsConfigureOptions.html new file mode 100644 index 000000000..6155c0e5d --- /dev/null +++ b/types/ProtocolsConfigureOptions.html @@ -0,0 +1 @@ +ProtocolsConfigureOptions | DWN-SDK Documentation - v0.4.6

Type Alias ProtocolsConfigureOptions

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

Settings

Member Visibility
diff --git a/types/ProtocolsQueryFilter.html b/types/ProtocolsQueryFilter.html new file mode 100644 index 000000000..c189c07e8 --- /dev/null +++ b/types/ProtocolsQueryFilter.html @@ -0,0 +1 @@ +ProtocolsQueryFilter | DWN-SDK Documentation - v0.4.6

Type Alias ProtocolsQueryFilter

ProtocolsQueryFilter: {
    protocol: string;
}

Settings

Member Visibility
diff --git a/types/ProtocolsQueryMessage.html b/types/ProtocolsQueryMessage.html new file mode 100644 index 000000000..15d9c5c6b --- /dev/null +++ b/types/ProtocolsQueryMessage.html @@ -0,0 +1 @@ +ProtocolsQueryMessage | DWN-SDK Documentation - v0.4.6

Type Alias ProtocolsQueryMessage

ProtocolsQueryMessage: GenericMessage & {
    descriptor: ProtocolsQueryDescriptor;
}

Settings

Member Visibility
diff --git a/types/ProtocolsQueryOptions.html b/types/ProtocolsQueryOptions.html new file mode 100644 index 000000000..eaa2c557c --- /dev/null +++ b/types/ProtocolsQueryOptions.html @@ -0,0 +1 @@ +ProtocolsQueryOptions | DWN-SDK Documentation - v0.4.6

Type Alias ProtocolsQueryOptions

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

Settings

Member Visibility
diff --git a/types/ProtocolsQueryReply.html b/types/ProtocolsQueryReply.html new file mode 100644 index 000000000..0eaa0c6b1 --- /dev/null +++ b/types/ProtocolsQueryReply.html @@ -0,0 +1 @@ +ProtocolsQueryReply | DWN-SDK Documentation - v0.4.6

Type Alias ProtocolsQueryReply

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

Settings

Member Visibility
diff --git a/types/PublicJwk.html b/types/PublicJwk.html new file mode 100644 index 000000000..abc0c5cf3 --- /dev/null +++ b/types/PublicJwk.html @@ -0,0 +1,8 @@ +PublicJwk | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/QueryOptions.html b/types/QueryOptions.html new file mode 100644 index 000000000..de7e43356 --- /dev/null +++ b/types/QueryOptions.html @@ -0,0 +1 @@ +QueryOptions | DWN-SDK Documentation - v0.4.6

Type Alias QueryOptions

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

Settings

Member Visibility
diff --git a/types/QueryResultEntry.html b/types/QueryResultEntry.html new file mode 100644 index 000000000..eaf5156f8 --- /dev/null +++ b/types/QueryResultEntry.html @@ -0,0 +1,6 @@ +QueryResultEntry | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/RangeCriterion.html b/types/RangeCriterion.html new file mode 100644 index 000000000..e1cf6763e --- /dev/null +++ b/types/RangeCriterion.html @@ -0,0 +1,3 @@ +RangeCriterion | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/RangeFilter.html b/types/RangeFilter.html new file mode 100644 index 000000000..d7f7fcf60 --- /dev/null +++ b/types/RangeFilter.html @@ -0,0 +1,2 @@ +RangeFilter | DWN-SDK Documentation - v0.4.6

Type Alias RangeFilter

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

Ranger filter. 1 condition is required.

+

Settings

Member Visibility
diff --git a/types/RecordSubscriptionHandler.html b/types/RecordSubscriptionHandler.html new file mode 100644 index 000000000..2c6ed9b3e --- /dev/null +++ b/types/RecordSubscriptionHandler.html @@ -0,0 +1 @@ +RecordSubscriptionHandler | DWN-SDK Documentation - v0.4.6

Type Alias RecordSubscriptionHandler

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

Settings

Member Visibility
diff --git a/types/RecordsDeleteMessage.html b/types/RecordsDeleteMessage.html new file mode 100644 index 000000000..e6881f32f --- /dev/null +++ b/types/RecordsDeleteMessage.html @@ -0,0 +1 @@ +RecordsDeleteMessage | DWN-SDK Documentation - v0.4.6

Type Alias RecordsDeleteMessage

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

Settings

Member Visibility
diff --git a/types/RecordsDeleteOptions.html b/types/RecordsDeleteOptions.html new file mode 100644 index 000000000..4d13e8757 --- /dev/null +++ b/types/RecordsDeleteOptions.html @@ -0,0 +1,3 @@ +RecordsDeleteOptions | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/RecordsPermissionScope.html b/types/RecordsPermissionScope.html new file mode 100644 index 000000000..1af1df9dc --- /dev/null +++ b/types/RecordsPermissionScope.html @@ -0,0 +1,4 @@ +RecordsPermissionScope | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/RecordsQueryMessage.html b/types/RecordsQueryMessage.html new file mode 100644 index 000000000..495f5bdfd --- /dev/null +++ b/types/RecordsQueryMessage.html @@ -0,0 +1 @@ +RecordsQueryMessage | DWN-SDK Documentation - v0.4.6

Type Alias RecordsQueryMessage

RecordsQueryMessage: GenericMessage & {
    descriptor: RecordsQueryDescriptor;
}

Settings

Member Visibility
diff --git a/types/RecordsQueryOptions.html b/types/RecordsQueryOptions.html new file mode 100644 index 000000000..935280392 --- /dev/null +++ b/types/RecordsQueryOptions.html @@ -0,0 +1,2 @@ +RecordsQueryOptions | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/RecordsQueryReply.html b/types/RecordsQueryReply.html new file mode 100644 index 000000000..39124380e --- /dev/null +++ b/types/RecordsQueryReply.html @@ -0,0 +1 @@ +RecordsQueryReply | DWN-SDK Documentation - v0.4.6

Type Alias RecordsQueryReply

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

Settings

Member Visibility
diff --git a/types/RecordsQueryReplyEntry.html b/types/RecordsQueryReplyEntry.html new file mode 100644 index 000000000..5e05226af --- /dev/null +++ b/types/RecordsQueryReplyEntry.html @@ -0,0 +1,9 @@ +RecordsQueryReplyEntry | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/RecordsReadMessage.html b/types/RecordsReadMessage.html new file mode 100644 index 000000000..c3e850654 --- /dev/null +++ b/types/RecordsReadMessage.html @@ -0,0 +1 @@ +RecordsReadMessage | DWN-SDK Documentation - v0.4.6

Type Alias RecordsReadMessage

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

Settings

Member Visibility
diff --git a/types/RecordsReadOptions.html b/types/RecordsReadOptions.html new file mode 100644 index 000000000..934dc8613 --- /dev/null +++ b/types/RecordsReadOptions.html @@ -0,0 +1,4 @@ +RecordsReadOptions | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/RecordsReadReply.html b/types/RecordsReadReply.html new file mode 100644 index 000000000..4f876682a --- /dev/null +++ b/types/RecordsReadReply.html @@ -0,0 +1 @@ +RecordsReadReply | DWN-SDK Documentation - v0.4.6

Type Alias RecordsReadReply

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

Settings

Member Visibility
diff --git a/types/RecordsSubscribeDescriptor.html b/types/RecordsSubscribeDescriptor.html new file mode 100644 index 000000000..e5fd599d1 --- /dev/null +++ b/types/RecordsSubscribeDescriptor.html @@ -0,0 +1 @@ +RecordsSubscribeDescriptor | DWN-SDK Documentation - v0.4.6

Type Alias RecordsSubscribeDescriptor

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

Settings

Member Visibility
diff --git a/types/RecordsSubscribeMessage.html b/types/RecordsSubscribeMessage.html new file mode 100644 index 000000000..dc674b16e --- /dev/null +++ b/types/RecordsSubscribeMessage.html @@ -0,0 +1 @@ +RecordsSubscribeMessage | DWN-SDK Documentation - v0.4.6

Type Alias RecordsSubscribeMessage

RecordsSubscribeMessage: GenericMessage & {
    descriptor: RecordsSubscribeDescriptor;
}

Settings

Member Visibility
diff --git a/types/RecordsSubscribeOptions.html b/types/RecordsSubscribeOptions.html new file mode 100644 index 000000000..39c29559e --- /dev/null +++ b/types/RecordsSubscribeOptions.html @@ -0,0 +1,2 @@ +RecordsSubscribeOptions | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/RecordsSubscribeReply.html b/types/RecordsSubscribeReply.html new file mode 100644 index 000000000..95a1297ee --- /dev/null +++ b/types/RecordsSubscribeReply.html @@ -0,0 +1 @@ +RecordsSubscribeReply | DWN-SDK Documentation - v0.4.6

Type Alias RecordsSubscribeReply

RecordsSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Settings

Member Visibility
diff --git a/types/RecordsWriteDescriptor.html b/types/RecordsWriteDescriptor.html new file mode 100644 index 000000000..79f461df7 --- /dev/null +++ b/types/RecordsWriteDescriptor.html @@ -0,0 +1 @@ +RecordsWriteDescriptor | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/RecordsWriteMessage.html b/types/RecordsWriteMessage.html new file mode 100644 index 000000000..2c5ae6b30 --- /dev/null +++ b/types/RecordsWriteMessage.html @@ -0,0 +1 @@ +RecordsWriteMessage | DWN-SDK Documentation - v0.4.6

Type Alias RecordsWriteMessage

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

Settings

Member Visibility
diff --git a/types/RecordsWriteOptions.html b/types/RecordsWriteOptions.html new file mode 100644 index 000000000..776d1d498 --- /dev/null +++ b/types/RecordsWriteOptions.html @@ -0,0 +1,5 @@ +RecordsWriteOptions | DWN-SDK Documentation - v0.4.6

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
diff --git a/types/RecordsWriteTagValue.html b/types/RecordsWriteTagValue.html new file mode 100644 index 000000000..742b252ad --- /dev/null +++ b/types/RecordsWriteTagValue.html @@ -0,0 +1 @@ +RecordsWriteTagValue | DWN-SDK Documentation - v0.4.6

Type Alias RecordsWriteTagValue

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

Settings

Member Visibility
diff --git a/types/RecordsWriteTags.html b/types/RecordsWriteTags.html new file mode 100644 index 000000000..1bb656b86 --- /dev/null +++ b/types/RecordsWriteTags.html @@ -0,0 +1 @@ +RecordsWriteTags | DWN-SDK Documentation - v0.4.6

Type Alias RecordsWriteTags

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

Settings

Member Visibility
diff --git a/types/SubscriptionReply.html b/types/SubscriptionReply.html new file mode 100644 index 000000000..1c6a8610c --- /dev/null +++ b/types/SubscriptionReply.html @@ -0,0 +1 @@ +SubscriptionReply | DWN-SDK Documentation - v0.4.6

Type Alias SubscriptionReply

SubscriptionReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Settings

Member Visibility
diff --git a/types/UnionMessageReply.html b/types/UnionMessageReply.html new file mode 100644 index 000000000..fe4a57230 --- /dev/null +++ b/types/UnionMessageReply.html @@ -0,0 +1,12 @@ +UnionMessageReply | DWN-SDK Documentation - v0.4.6

Type Alias UnionMessageReply

UnionMessageReply: GenericMessageReply & {
    cursor?: PaginationCursor;
    entries?: QueryResultEntry[] | ProtocolsConfigureMessage[] | string[];
    entry?: MessagesReadReplyEntry;
    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[] | 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 MessagesQuery +Mutually exclusive with record.

    +
  • Optionalentry?: MessagesReadReplyEntry

    A single message entry if applicable (e.g. MessagesRead). +Mutually exclusive with record, entries and cursor.

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