From a104d26cb24d2392a58d5a9b9f2923beeb72efbe Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 17 Oct 2023 18:29:17 +0000 Subject: [PATCH] 2023-10-17T18:29:17+00:00 Signed-off-by: GitHub Actions --- .nojekyll | 1 + assets/highlight.css | 22 + assets/main.js | 59 + assets/navigation.js | 1 + assets/search.js | 1 + assets/style.css | 1383 +++++++++++++++++++++++ classes/AllowAllTenantGate.html | 116 ++ classes/Cid.html | 181 +++ classes/DataStoreLevel.html | 300 +++++ classes/DataStream.html | 166 +++ classes/DidIonResolver.html | 158 +++ classes/DidKeyResolver.html | 209 ++++ classes/DidResolver.html | 140 +++ classes/Dwn.html | 413 +++++++ classes/DwnConstant.html | 102 ++ classes/DwnError.html | 113 ++ classes/Encoder.html | 214 ++++ classes/Encryption.html | 180 +++ classes/EventLogLevel.html | 251 ++++ classes/EventsGet.html | 417 +++++++ classes/HdKey.html | 136 +++ classes/Jws.html | 225 ++++ classes/Message.html | 390 +++++++ classes/MessageStoreLevel.html | 351 ++++++ classes/MessagesGet.html | 417 +++++++ classes/PermissionsGrant.html | 475 ++++++++ classes/PermissionsRequest.html | 417 +++++++ classes/PermissionsRevoke.html | 432 +++++++ classes/PrivateKeySigner.html | 159 +++ classes/Protocols.html | 118 ++ classes/ProtocolsConfigure.html | 417 +++++++ classes/ProtocolsQuery.html | 434 +++++++ classes/Records.html | 301 +++++ classes/RecordsDelete.html | 435 +++++++ classes/RecordsQuery.html | 417 +++++++ classes/RecordsRead.html | 441 ++++++++ classes/RecordsWrite.html | 489 ++++++++ classes/Secp256k1.html | 352 ++++++ enums/DateSort.html | 101 ++ enums/DwnErrorCode.html | 602 ++++++++++ enums/DwnInterfaceName.html | 108 ++ enums/DwnMethodName.html | 143 +++ enums/EncryptionAlgorithm.html | 87 ++ enums/KeyDerivationScheme.html | 107 ++ enums/SortOrder.html | 87 ++ functions/authenticate.html | 76 ++ functions/executeUnlessAborted.html | 79 ++ index.html | 184 +++ interfaces/DataStore.html | 238 ++++ interfaces/DidMethodResolver.html | 124 ++ interfaces/EventLog.html | 189 ++++ interfaces/MessageStore.html | 222 ++++ interfaces/MessageStoreOptions.html | 84 ++ interfaces/Signer.html | 136 +++ interfaces/TenantGate.html | 102 ++ types/AssociateResult.html | 70 ++ types/CreateFromOptions.html | 79 ++ types/DerivedPrivateJwk.html | 71 ++ types/DidDocument.html | 85 ++ types/DidDocumentMetadata.html | 79 ++ types/DidResolutionMetadata.html | 67 ++ types/DidResolutionResult.html | 71 ++ types/DwnConfig.html | 76 ++ types/DwnServiceEndpoint.html | 65 ++ types/EncryptionInput.html | 87 ++ types/EncryptionProperty.html | 69 ++ types/Event.html | 67 ++ types/EventsGetMessage.html | 67 ++ types/EventsGetOptions.html | 69 ++ types/EventsGetReply.html | 65 ++ types/Filter.html | 65 ++ types/GenericMessage.html | 70 ++ types/GetEventsOptions.html | 65 ++ types/GetResult.html | 72 ++ types/KeyEncryptionInput.html | 87 ++ types/KeyMaterial.html | 75 ++ types/MessageSort.html | 69 ++ types/MessagesGetMessage.html | 67 ++ types/MessagesGetOptions.html | 69 ++ types/MessagesGetReply.html | 65 ++ types/Pagination.html | 67 ++ types/PermissionConditions.html | 70 ++ types/PermissionScope.html | 67 ++ types/PermissionsGrantDescriptor.html | 103 ++ types/PermissionsGrantMessage.html | 67 ++ types/PermissionsGrantOptions.html | 83 ++ types/PermissionsRequestDescriptor.html | 81 ++ types/PermissionsRequestMessage.html | 67 ++ types/PermissionsRequestOptions.html | 79 ++ types/PermissionsRevokeDescriptor.html | 71 ++ types/PermissionsRevokeMessage.html | 67 ++ types/PermissionsRevokeOptions.html | 69 ++ types/PrivateJwk.html | 70 ++ types/ProtocolDefinition.html | 77 ++ types/ProtocolRuleSet.html | 88 ++ types/ProtocolTypes.html | 65 ++ types/ProtocolsConfigureDescriptor.html | 71 ++ types/ProtocolsConfigureMessage.html | 67 ++ types/ProtocolsConfigureOptions.html | 71 ++ types/ProtocolsQueryFilter.html | 65 ++ types/ProtocolsQueryMessage.html | 65 ++ types/ProtocolsQueryOptions.html | 71 ++ types/ProtocolsQueryReply.html | 65 ++ types/PublicJwk.html | 82 ++ types/PutResult.html | 70 ++ types/RecordsDeleteMessage.html | 67 ++ types/RecordsDeleteOptions.html | 69 ++ types/RecordsQueryMessage.html | 65 ++ types/RecordsQueryOptions.html | 73 ++ types/RecordsQueryReply.html | 67 ++ types/RecordsQueryReplyEntry.html | 73 ++ types/RecordsReadOptions.html | 77 ++ types/RecordsReadReply.html | 65 ++ types/RecordsWriteDescriptor.html | 91 ++ types/RecordsWriteMessage.html | 75 ++ types/RecordsWriteOptions.html | 103 ++ types/ServiceEndpoint.html | 71 ++ types/UnionMessageReply.html | 79 ++ types/VerificationMethod.html | 71 ++ 119 files changed, 18157 insertions(+) create mode 100644 .nojekyll create mode 100644 assets/highlight.css 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/DidIonResolver.html create mode 100644 classes/DidKeyResolver.html create mode 100644 classes/DidResolver.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/EventLogLevel.html create mode 100644 classes/EventsGet.html create mode 100644 classes/HdKey.html create mode 100644 classes/Jws.html create mode 100644 classes/Message.html create mode 100644 classes/MessageStoreLevel.html create mode 100644 classes/MessagesGet.html create mode 100644 classes/PermissionsGrant.html create mode 100644 classes/PermissionsRequest.html create mode 100644 classes/PermissionsRevoke.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/RecordsWrite.html create mode 100644 classes/Secp256k1.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/SortOrder.html create mode 100644 functions/authenticate.html create mode 100644 functions/executeUnlessAborted.html create mode 100644 index.html create mode 100644 interfaces/DataStore.html create mode 100644 interfaces/DidMethodResolver.html create mode 100644 interfaces/EventLog.html create mode 100644 interfaces/MessageStore.html create mode 100644 interfaces/MessageStoreOptions.html create mode 100644 interfaces/Signer.html create mode 100644 interfaces/TenantGate.html create mode 100644 types/AssociateResult.html create mode 100644 types/CreateFromOptions.html create mode 100644 types/DerivedPrivateJwk.html create mode 100644 types/DidDocument.html create mode 100644 types/DidDocumentMetadata.html create mode 100644 types/DidResolutionMetadata.html create mode 100644 types/DidResolutionResult.html create mode 100644 types/DwnConfig.html create mode 100644 types/DwnServiceEndpoint.html create mode 100644 types/EncryptionInput.html create mode 100644 types/EncryptionProperty.html create mode 100644 types/Event.html create mode 100644 types/EventsGetMessage.html create mode 100644 types/EventsGetOptions.html create mode 100644 types/EventsGetReply.html create mode 100644 types/Filter.html create mode 100644 types/GenericMessage.html create mode 100644 types/GetEventsOptions.html create mode 100644 types/GetResult.html create mode 100644 types/KeyEncryptionInput.html create mode 100644 types/KeyMaterial.html create mode 100644 types/MessageSort.html create mode 100644 types/MessagesGetMessage.html create mode 100644 types/MessagesGetOptions.html create mode 100644 types/MessagesGetReply.html create mode 100644 types/Pagination.html create mode 100644 types/PermissionConditions.html create mode 100644 types/PermissionScope.html create mode 100644 types/PermissionsGrantDescriptor.html create mode 100644 types/PermissionsGrantMessage.html create mode 100644 types/PermissionsGrantOptions.html create mode 100644 types/PermissionsRequestDescriptor.html create mode 100644 types/PermissionsRequestMessage.html create mode 100644 types/PermissionsRequestOptions.html create mode 100644 types/PermissionsRevokeDescriptor.html create mode 100644 types/PermissionsRevokeMessage.html create mode 100644 types/PermissionsRevokeOptions.html create mode 100644 types/PrivateJwk.html create mode 100644 types/ProtocolDefinition.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/PutResult.html create mode 100644 types/RecordsDeleteMessage.html create mode 100644 types/RecordsDeleteOptions.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/RecordsReadOptions.html create mode 100644 types/RecordsReadReply.html create mode 100644 types/RecordsWriteDescriptor.html create mode 100644 types/RecordsWriteMessage.html create mode 100644 types/RecordsWriteOptions.html create mode 100644 types/ServiceEndpoint.html create mode 100644 types/UnionMessageReply.html create mode 100644 types/VerificationMethod.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/main.js b/assets/main.js new file mode 100644 index 000000000..d0aa8d5f9 --- /dev/null +++ b/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/assets/navigation.js b/assets/navigation.js new file mode 100644 index 000000000..591aa3b23 --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WYwXLbNhCG30XnTF17mrTNzWM5rtO4SaWkPXR6YMiVhDEFqAAoxdPpuxeESAogFsDiogP/fz+KiwWwwF//LjR804u3i2WlYS2kXrxaHCq9M0+Ad3t1NT7/bqf3rRGfGW8Wb3/679Ul8sTvpRTyTjQQRDtakvDINchNVcNv1R6jeHqS9AR6J5oI5iLGGfe8li8HzQS/bbdCMr3bz0mIJc77FV6WINmx6v3regfhP0MscV4/Gh9lA3JOmYR47G3bipP5+Qy84vrBjO0FUreVUqCuQo/Pu75xiXesCRHmYSrG1FS11kLCBzhCG4b7ep4kodrHKL2WJLDmUfAVKNEe3ZROFE/PkMw4JkmOniElMSTGiSOxJ56JuRNcaTPsaOwoZhh2xqMAq6SizcQSDfbVg5CJHSYlGj5oScIRuP4gtpGy9OQsRz0AksVJSsX/0hdKGGsfp+Len1QYZR6mYp5AqWqLLAODQIhNTeXAQuDhmXPEFOMTyD1Tyoy0epBoIc8dRNoK/ulApXmDh0w8imck84ElybPbBpjKWLMtx6bO3JGmCS1q0SJ1NEmkeLNUbNi2k9jnBR4S8fcOJDIpfD1FWkEtZIN82SAQYpfQArZlejKBE/kWVyVQVlAhe68jEhh/muYl/kFWTVHWUB9uXr95vg4Rk0TqBC7xbOz0nD7ARxiqv1meu7pwy3RRc1cKOS70KGkUUwB31UMhroEK+mj3L5XlDb4Udr5UOCRsjfCDsd7RAcTaRh9yq5SomTGZ8ehaZ1XVL4e+B/XlGen7n3+8fn3jNqGmy9PwTop9kKQzLzDkiLYdh2ZYO9+fnufEwJAlsmYp6m4PPPhaRyqgmHquGjNDErTRQqDaedH1uUlwQ1MRGR9rxJKl2l7UbB4BaxQIhDXII6vhnjcHwZBBCRw55qXJfOSHLgDOZDrNbHEHkPolDhwdWeYRqT77kBTZ915Bv+hAHJ3Mi0zYuU7mreDQhpny1BzrHWu1uzqeGeenudgHMKsnqyNZ8tU8S5//eCRHc53Aw2fgJOQIpofMFHnoIDCfzAoqWdUisFHKUcYN0LvBOlMciUhJ1HnoKGBGxjF0FDDRep/rOd6nast45R+dz6SLkmVMpxazAjcM/VLMQ+eua7PKxZFWptPOh78lqFqygxbBfI87S98RKaWIrZQeKaqIrYA+HGZJGQq85e/JZ8k3lr8hnynfWPSG/pxOTJVvLX4LJVGOr5hPSZPjy/KjLTS9dx4P+UvYMM7QdSpwUJmrroU1BLvGTKbSPvfBMZYVqaTL9UiirBLe8vfECitmLH9DrLRiRvIb7JUJ3rdhnjJuLi+uqYycy4drKiOjbQFiyVK7ry2rsck7CnlCpOuchBzBu12LDAbmKeJGhgLzELmp2kEsJdT0ny2pGjcErZnAUEy851rmsdZFZPd3m+kUOI4CZioBk07k2avT+MqNu0rY6cpyLSXUdFpdS46auV4pvFv5wu2lk/0edJgCQ474hzlXblhdDbdZO9HMkaEjx6w6vTMH8j7GGZhNx2ubsitX91lvfnAw8A3qTsMX3prvuf1qDq7QYDjMF2D//h/Kt2xg5CEAAA==" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 000000000..0e890a9f8 --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8W9W7PcuLGo+V+k8ygvL+LK8tPIrW5P29tunb54YsLhcJSqqKWyalVV10Vqbcf+74cECBaQzMSFpGZebPUqIDPJxPVDJvifF+fj58uLP/zjPy8+7g7bF39gjytdSfbqxWH93Lz4w4s3nw/fHA/vd08vXr24nfftX65fTs3l98PfHz5cn/ftj5v9+nJpWlEvXvzPKydNScnVIOtf/+rqRgW9HMp48l69OK3PzeEamHNXUj0yMejY7rY/Npfj/lNzzlH0EJZPKH3orSN0X5vD+nD90/qa9YwPQfF5mp+by2X91Px0PZ7zdIMK87Rv19d1vmq/9Dy9zae2/H8d403TqfUKF2tFOsVPzfnTbtN8e9iejru2/sgEUGCBboJJzOgv0FLiZR6O27Z2idIHVyVXdfrFxt/qwq90yvvMfJm7bb6uB1M4S11q/Cl6xoeSB01ovhT7zRkxrrmEPW273Jx3p+vueCiwJaw10Y7RWLHbvjlubs/NeJC4/zJ7dACiksOCZxTxCv+vzfFwbX5LGe3e3b/uxZMqE84bdR5KZ6Tj5Gtb7y/HvxyOnw+vR6MfoTasMVd/997Ox/1+vF4h1AcV5mpvlz2797vNumvzf22uH4657x6tONeafjDINOFeenYbuF0/tKX6x8ltBrDSbCva2udiR4xrzbXjY/Pl9dO5aTKGLGcEqDK7T6xP63e7/e765fvDp2ORV4iqy1n0ptk3T9MsCqpOsAiZWsze5daJbP912yP+giUWmGpQkRlTzsjY4qknpjlrChoJSKwj/BptB1t3m5dCsygZC9pILzBSlnk1v4I9098YImGGfdGOk2OkK7No5wmEFnWfweTImqKt9vMEAx7CugXGpDbr5/MRWeIkrHG1ZtkRWZLTzoclFlyilzp+ZCzl9nOzvjaRhQPu8KFWtgEJV99O2wl23GstZce2WW+uu08TbAlrLmVPu2a+tA31+1Jr/HpL2XJoJ8pfzBsvNCaouKQ1f5/4dmDdpWxqfr21LWDfVig2CVRdyqLN+nA8tPuNfbFBYc0Z9sCh9O+p/eO4wNyBlJCYGkcRS3P5Q1xjDEMgNYsRXkJ74UNPpREJKzKgRLEtp9u7/W7zl+bLnz9/LLMG1JxuD5P3xvgtPG3YtQul8/v1prXH/RZt2+xR1IO046k5JCW97EvhDzAYRKjY7I+XJq3DFZumZH1qTdymtQzlpql5aq6myCWtyS86Tdm23adfGyvkj1++2WU8HlZlqtea9TnHa7ZYgZJw5DZFQLcyf5s7Pt+FpIZkawLR+z+3K4zz8/oMu/5I/INfMqIo7wj1m9HoP1YYFC3SCJ3wJ9dWfzCnDpBAw5/nugaVl/LSyEbiBT7B1hTT9vBEI4dRveRrtMXben+1nsE86P2cGKUJ2T82p/0XSrL5sUjud7v9dTTL2j/OdbMnJeXc3opYCz208+QGf7Hhj/Nb50haum0G1iVOA0f8gdb4ENTJUZ5xxHA87/4bI8cRM2C1aZZAp/YFfzqeYZ/1fpnrTigq5UvfKDrQpPkGhRyEsoewRlJxOtCledutLS8fiizw68y1oZ98ft61/7iun0+ZZiDVJlgCG9Lb9dPugDXp+w9zmxGQlGpFnkWlEz2uKWe292rGnbffPe9glyPUuqLlGoneTs+P4wJFM5lXHZsj4c9Fst+2K7vdpWM73xwP2x22SMKKzG50lMxk88Psje5v0d6TUP8QVs03JaNHD7V+2hwj78X8OtGVlz+d14frG2pWpgsu51ZUcr5zR09AoSS3fZtkyINfvdSk5DSCwLpMs57jkQYzbIpObdnWZc50k+083Sv+2Px6a9WMgGymrYSkhe3tliDf/nbanUcBnplmhgIWtu6pK91svysdB4adpF//69j283GWaab617Hsj3C2LbPMVF+6tZGxl7mtLSMMc7J1l+isFrXLVV3Yok16YRM1K6g/37bUtI0vIYlSUxcI/WCYs0QYFV1wkYDLLlgmjJ9j+kIhakzZUmEsat5iIW5a/nKh3K7cBUPKwvIlQ6mtOdNc3MqyiW6ifbGpLsu8vMluonWx6S7LurwJr9S6rCkvbl/hpFdqYWLai9uWPfGVWpUz9cVNK5v8MuxLT0rJCTAsN30K/HT82OTNgGHJRSdARHTR/AceYs70R5tSOvsBSXMnv4hhJXNfoVX5U1/UvikzX5Gl3h7XLA1je+WoraigBaxNdsKMHu8VK+vw5+P1uDnuLzb19HaO9PhI0dldPiU72edjz1Ha6TONyen1MVFTun2uaal+P8eueMfPtzC350+3ddu83x122LIo18pAwhL2UR3wTcrUe4GlOhuQmNvFPEupEbcvWaT3wauVa0BOAB9yVJoyJHlaWmyJ0VtmhauykAWX6/m2ud5GdyQkrPCrTbdkdqO829EL/11VbpD3MOn++HPEY+a3pXrhXVhuB7SmpR/hx9u++akZHfeGvy71GL643AdxBhJN9n81h835C7qrpZU+/CuolWVAouv8ry4XA9kjxoy4V1nEgqf98d16/+NxX/D6H/4V1FrEjj7DsdSQsNpES8il6/++NecvaDgbVmSxpSqUmb1E9e2dNoNSuvPn0EBC/qseljjEloQqN21PYmxMaPLLzNCCBY4gJcoiN4eBqJXUbh6vo+jNUYHZsc+4xGQg9NhSKoxw/3Q8764fnosUP/jVck1I3dLRze3rfR+a+PdmM96xJowiJCxk38fmy7fU/JUwDFadbhFskj82m+N5e3ljsgXwnoUVKWr2vYBI50VKTNaAddzR7/Okf3u4npMqTKEpen5s1tvIQww/T5H9/7R9jgY6eKG5Q1BEamoYIqwuxDdpAzLADSFkArLJMCcBaybZQqwgMqxJriFm2fN2ff0w3aa+9oJ2nZvN7rQbpyJlGOVXXdCiy+ZD8wwvBMgwZ6i3pNdM7RExz/HYveaC9nRJwePA6Qxz7hUXtuan3X9PGIC8msvaQ6Qn5JmUzFSYOCpGgXHW+JiJiqe1cYIS5jTyJCmc7EcqzSPTk+mMj8kt/rvj+Xk9YbgM6s6zKbbciS45/RLxhQ56Odtd6vvbwRKe3/s/R0VW7J5k+3q/P35u/+fn8Y29fd3fj4tEpcvq/jo2rV0GdXpLvoTYl2Ed3D2I1UQS8e5iy2Sr9ypM0e2lySOv1Etiznyb8Yeh5aWfA7Xfbxr+9ObeWvu3fHM3x+fT7drE5LwMyuCGdr8RGtoyl7h8r0Sx9N62N+unt+/aYt+dj89//HL1YDz1NFiNJbT/dG2nxeci9UOVHP25XddTmO6roYr7871pW16Qd9kcbs+X37s/x0ewey/rVwqvL5vmsN0dnmLiXiKFcaMH42I6u4khX2lQeorWYSbNe1a0+Cy9mc+Ll8/X7A1BPtwYtUL/x/xByQwIaVkvXbno+sAaRnVg4/cMVUPB6bo+rfe7brX150uXkBZs22i9aKW7DdfL9ne7y+92hw9Nt1jZltr01Fxfm6TtDFP8sotagE0OqHo4R8zV3Y3Fbfk8/UHhBW0wDeu1nzn/+pLtk3jtpa38afd0WAdhASnL/BqLtpm/NZ+R6NZo64FVFrXnh/221B5YZTl7dpfuWXPaz73kktq7J8vT7kou3qf/SnGEZAdHas6yLnfBhhmEr9wmGIExlgwLnpdpnMjdIsPA8Hb9ZX9c5wzAZMWlbcu2ZdGGez3++acf/paheyg4Uzd9kIXf74SUWOj4ZyQy8+wnMHYWUKQsKKaJgaA4HnuPBaGk7BkqLWXFFm7x8uzwqi1lyYm6niVlS1BxKWuCu4y6QafYVbiEGfb54OrN6CtWHmcafszfclE3PIai4lc83m2i5mbqjkegJX7JY1LN6YbSN6DElpqo4qnJUWFLTVTRVjpudgSZBIr8shPV2TshM3QNBSc3AuLKyFEjiN0ZiasBQVu3K/qdieHvs6P7AkHJkL7BnKLzSlRJ8ojyXmvSqSStNHoQGdGKXCaJOmf4+1znhIIy7o2c4hxUSdI591qTnEMrjTqnSGtIsZN64wQ7ohk2i9duJEMbB/h1bhPBxKUaCjSwqLlEFCYbDaw7qemkDIg2oLQFrAYLFPQs5P5T/vrkesSPdYCsl/dysXnDmEVq+uHdv5vN+DRyrGooOFXXe/K4Cip7nzymytOW+WxB0QJ9ubAD6ss5pCIeEHwtpd0Af2q2b8/mexjju9hHv88dQ3CBye+kjMykIs6Ox+tfmi/jbyjE1D74tTINSCZHmpK7/hSi6C08IJWXtgqJFMy1KRomOMmioXzrg3KjQO3pdnmj8f+99U1xvdD8NX8MttYhjzaW9xIpiz+ItSyu0X0gIUOhVzRPX+6I5anKGaygmvsztX9/Q3Ume1SLlMg9aX8zhE1dMoW+DKvgT4PZjJ9D96G334Bv4iVsGFdbyI5gWMg0IjoeZFtgD2uzvXAvPkmvv/DadU1v9Fn5YeYNfs7v/E/N9a/tom+3OW6bTbCyjEh+idUiBrTQbNKKQ3PGTuxx5UPheTrBDJx44MTES+nMXjohWrOWT1kPC7ISYkoTiQh5+s729yyF97JzNG5vyGkgpq4vWKgLdMXvzXceya7o/bxIwCYiMrdx+JYWN46R0nTjyNAXaRwjhRmNI0Mj1ThG6lKNA9cFGkesZSzdLCa1iRkOKvbOVNeU+QXT4h+r7Lb261oj1/igGhbKn0VBD0oKzehHwN5MT6U1Z7iMVB2088+Hsds+x++lyYnRczJSoXmd/qzzqLHg+DEULfd0PrYv9kJFAw0KRuWKNX1YH7b7xs9XoLWhZedpxIM+cY2u7DyNXYZrpsK+6ER93ocgUvrCosX6Ll8Omw/n46FdHb893w7N9nubap7n1czaxVa5wFMiNWPQPyo3WVP/Gr9vR6an1upIu4rUyNEORqdvurmQeEb3W3z/HcSbrH9704N0k4XS3TH7x+bbQ7cDQltuoOJlqjr5fMNTTFgdQCOyVgeoSvBqvw0+o+3pMz8ss7TxheVabu0iPNi96qSabbRTQfnjl/KNr6SP0Pd+yuU9r718sj9/vvy1u+JxHPoPBb8kq8WfyBhN2jHEuvxy+Hg4fj6AIOaYLWTVqfYMi5O/Ha8/3U6n49lPc6VMoWrNsKKTdD3n+AQUnqfz790ImanSlZ2h8f5d++/Wu33em0bqTLXAfFFuvW9bsv1MbnP+/mDmiHHAOmVQlojJ9nUXwAbt3PzFfqQk/bKS1Re2K3cUSVZf2C57ce3k93Wvvpxd37ttVPvQz+vrBsLmHOMwGctZaAe0GeaNBCxnWzv4/Gn4TABYaOYbiEv5Glb+fMyc0zKFLNw/Wh3/b3N9vbnuPmUMeFkyplpojr/eBEes/XiaNCxadao98Isvf3IfWMjuGDkSlrLOfK6uPwv7fvv6sI0cZ6UtTUlb1Gp7jtVq+LB712UifLdr9lt4CpZpMylrKYt/ObgY7WZr/lBsJyZhAev6K9rtRAp1lhiZErSYrf6LsH8pNxOVMdnCIfTAht63wt/tm5+Pb5rtbdPureHNhKSV2XK+jqXh0eM0KxMnkhMsvLjd0Te3c8ZkkyFgum12MAtzYDf9nNszlAwD86QsauWb28l8F9UNzt2Ntz+ObhgrMjkl8uvY/6fh6uClzMclLmr994fN8XxuNtd7AMw0o3FBX8fWsoVAiaiF7bV75/CWg0I7QxFfw76f/XDOKdb9HI3xnGZbP1kHt2YX2RYK+Cq2gbviJ5k3yFjUwrem/r65XBbsM2mhiz5DN+NMd79Xe1GrOpnOd/NGeULSXGvv94h7k9/r633/MKkhlEpd7inuc+CCD5EldLln6MfJotZM1V7cKru+61viD++nGzgW9JVs/eH9hDVtnqzlLPa3cROMBNVn22XiDqbZhFWdas9wU7q5h/1vx792zKhtLn8Zrm/v+OXtkDavRNJMa8eQ8Bv3CUsbab/ub5Tvx5Fc2yfI/f/kSbqPYWYdyUyVuvhThHAvm2aWy/s6lrdDkOttM20OJX0da52ChV4zIu7r2t1N7wvbDkR+Hfsz95GZQmaP4GFm0y+Hn8pgWL6cmZa66f6waS7X4zlMIWmennMW8EWiZtoLsoBgvku/vhoGp1zby8Uu9Bxd3yC0lQ56ZSJn2m+/InK9nQ/N1mTvnDJW7/G6My3qs6OIJy8bHjJlzbTYxF3+qbmaL718v/3lYL4N2mwzD5BzpSxh5Rt78UDpxEDUXcqiLgJyskmg8hI29e0jnFfCa6FyrIuKWdDO7i18366gm0+74y19/pojYWHr3G0S/n1fheaFIha2D1xeUWha4kaUSVaVThpE3QUtKht50ZpLWPPD57b/vD5sbfDPpFGDFLGEfV0Hf30xKspiYzOFLGHj3/uY+iGY/v7FuKmTQ7bIqfb/1GxOTKqPVbsezQ56JSpNteGX8971rVba37rjv30WZYpUXNaWLhJgojV91Rn22H5e/GbwakvakftWqIpFtgTx/0O859/Wo6sf4M+5eQDffmr1I9P8WNjLoSj5BKGBqD6X8pSl0Ss8R6cXL5SlNiw/S7MDwnl6vdJztPZDaZbOe9lijUHb7NMf0IZ5/y23VQ5MPynspV+UfATPOlxfmClKK0tmjKY0/Qk7/YZqEvmASR14sN9ISyqUL6UnTOIk9STzN1N6gtRNUk0qazOt5ddbc8l4b/eCM3ThgY5jValgxpSmMAmUVJTM9kzpeRPeAksqepO4BJbS5KUH2pzGcUJf//f8/PB360ujRDtV/0zcEehLfImUxp/B2ZfWStypR6lN3KuX0tsZ3dru5CXUjkvP0QpS2WIqE4lsefqy3iwoOknf0dTOakCw6CR9F/N2st2IFZ+nN/2csGiuvtzE3UBZTt7uWFUwnJhlLZatP/ySP6Sc0A9QhYISX5+621N2rQVQkrjcIqkl46NTQOOML04lraE/NwWMKP/WVI5u7ENPY8UlX3hKe5n+xBT0dPn3pTLbWN7HpdCGN+/LUpn20Z+VQm0q/6ZUTtuIf1Bq3EqmfU0qx5L4p6TGlkz7jlTSEuojUsCA0i9IZejFPx810lv27ajcnpr8cBTebSd/NQqzK3sKhaaUfy8KU5/1sSigu/RLUUm9mZ+JAmbM/EZUplV5VizXNIlPQwGthd+FwrWGt2kPZfAvQsGfowusjLu0UXmpq7RHNhKu+9xOHefn9RneCB5T+uBXylM/+7NCUXtKvilUaFniQ1lRs7K/kpVhU4gI+vMibPfQ/5S/ql83FybVN9dzXzkl9CVSgdyaOENTuvuw3Xzd9wpTdTebXXMZjr1yH56qtYwVua+BqlVgRcGGNFCduScdK8QaMJVwjJTIpeuvXQvJFPnSr5B6nLu9+HlT4JZcA0a1plgxmqOG0t8f/C9/9cNW+OvsGQoRl5yggIHUzDBqIUmVD+tk+jmsHZ8DdvbuwH5++XsT9JO0OUT1JSz7OPqSQsyQj5EPABTrBRVGi6C4HUjtiXbBhv+XkXBg2bjA3OZPSEz1AMRS4nUnPjMS15//nRFETuLblO67EqMPsSRMCisubc1EW5azhBq0Epakx60sS7ylYvSyVP/HuRB4JCvBgQPDylDwWFWCBufr+u58HH+Xi9LXF56u82mIYM7QeS/8OzZL6+7SX4Wb2ShehhVmau/56fXa7YjQLQz1usM6sy0IiUi+FaN6s/xf6IpxjenaP3UXOn759tdbuzK5fvnh/ffPz7drF8X19nw8NefrDjkJG1uUJ2XWO7KOb8455oDiZXoVq0T25+A9pRjkK9cX/8i6pw7BaFO15X5ufqQ9ihLLrTl+PiBoe6zclZuta8KDU/WKbAlXCQUNez25VWcQ07E6BJqW6mrsOuWnL8/PzfW829zXLdgny8YmpOpPt+zSOjHDgL7YPD19aHqmunvp6VqHtPzszhz7/tRXXMf8/7mKKdcdbjKDHAn0EAApMXebSYlM7TMxY4kh6Ty6wiZL9cM5eWENJiGxnYN5PXmmnFIpPdMteTv+mmauNW9jV8hMtyi4QabMouj1MeUWbUb5x3nmbJIJxuW2XMKInjxDLvHUq3IrzqZG8Qvxqi3WWkzVYku8aktZ0n1Mu9CKvsqSFoy/QJ5jROwr5NPsQL5EnmNI9IORkyxpbOj/hLfi1VzKnsSJa8qo7EPXCf2oI4WXD8Xvya+3pNfeTrQH1l2yTYMrQ/NbdeKK0HJr0jEFKbNKwgom2HcHWlZ27hJyMA8TsJR1TfQMJWXauPZifRDc1l0+q2ECZlgHtwbfDHAY3xiMfp+7LcAFpjYFYzOjy5g+Sx0wsQwDHvD6mUaVLyfixkQXE6XaqekgbkJ6Mii1IzFhxs3Jni4n+IacoJJOypieSu1JTwdxq0omg2LbUlNBwrT8iaDUsvg0EDcrdxLIsEl5Fv3WbG7X5pdDd/Hw63fhJ8ze3w7mFs/L77Fi8RAi79j0z5/HTLb9W/4hafe9cyS3wcl4OfyOv5FOPy3Z+vhNQr5fqliLPdahj8cGReOCxbq2TZfA9Ha/3h1sthrF5AelkRrF2pvfruf15hp9m0GZYg339AwM9Q9KYLFZevLUZGrJjRS868gIEYQPMgri+Wtr5nm3hvjP+2WBsJ1AVEa8zmAUHReFhcJgah4+pqJfhlrJWKy36x2czCJa+9IT9E5/qU5vL/N3dJjj2IDB5mjcz58/wxD2XFMefAGlRiVBrbnIco5xvoT51sGe9pYy8P5DYtoD8ghnDH/PnoSpVK/+7/mTcUaypy8zlerpv3lnY3FiZ6AQT+ss04OlUkIlMYKZ0BBJ2Ay0EOmaJZoKkjND1ZmpmcW20MsgRH96KZT2ZTzpEnqVTrks0xpPsIRa6fTKAq1UMmWgDEulLNKBJ04CHeO0yfLekUySxLpKNEUybkPuwgyoTS/Oxqqykh8DPamoqISOzAClQGVhbFKWBTkapzYbIhwn0JCIxEGeYTyFovc/eL/NDf6FohKxv75VZaG/I0WJyN8MTfmLg0XugsiwKLlomHMfRJ7+yDQ/+U6IHK8nFxmz7oXIbndFi49l74bItjG5KJl/P0ReW8larCxwR0SeNVmLmAXuiciwJrG4mX5XRJbu6KJn+n0R+b04dzG03J0RuG2Fi6R590bgJpQsnqbfHZGhu2xRtdj9EdmW5VqyZHONL8Im3yNBaQ5piVcKPy0eF5hLPQmJKfiJWBpv4O3MnPkw4Ciyr5hrxuxjv4RVJed+xdYljm7zXlj21jFqF2yavxzacn3FH5vTHmZVjn6P7yLk6Jbkn9qB9d44d+4e3uGpze/5W5PjqTlkSXvZl4y+KmscNcPtj5c8y1+6otOV+aeuUVWxI9YcRU9NpqKnyAW+OYp+DW7Wjar6NXq7bo6ybXh1a1TbNn59a17TaNbn3KZhi5YpI/oRnD0IzTlzSBhK3c35+xKxL4cq6QdDZhKPXrwFkVqjORoWmMsxUHkJmDEysoxo4CoTWKNMZxdY4dWAN0HnWEKKmGef4yjmQ3SZBsE6y1gQoT9xMyYgoFzbaA6Em1QOgwoswZgMaUYJlMluyzQbIlpuOSAq61d5lCjWreahojJraV4Us7AcGhW0qTg5IlvXNHxUYFecIZF2TQNJuXZRNAk3pxQp5VuBcyXKijK4VDgWJAlTdGCYjJkiVuayJsqwcuCU+8rorGDclnRmcERzFu/C9ZZCr1wrMslX7GVMxl9lNhbZtHg7IWgYbkMhEovaAKKIQFEcjhGl5hKymNgUJqMMn8Z/MizJh0CUsHQY/7e/nXbnpuTt+6H899qL2tVcNufdKbhCqMCuoPaSdj11RZvtz8cJVvl1v4JNf4QIr8CmP9IUZpZN341uUiww6rtI6MU0q7zksH6TOwrnzbGPELOkpZdgz5xv2qVo35yd+7/dlQ7Q3gUA98pLWpUm/znmleD/fDtxypWBZvoiC5IuX2I+63KmTqZdgdp83pXQW8ZzAhuWIToJ+7KYTmDWLKqTtibBU6ApE2lKqrVksZ2wxcyiO1mtt5jvIE16McKTZXEW40GsnEV50m0sm/PA1jab9KRty2Y90LbZtCdhWwbvCUyaQXySliSZD7BkMvXJGydKuA82aCxBfsaWTmA/wLhZ9GdsUCmFCayZwWESlpSTmMCw5VhMlp2Fdn2FRp8mMoEd05kMZgdJZfrCSS4TlluQzCCCC9gMMH82naGtmcRngLgFSEjEwEIWUmRbBg2JWFbEQ6bYFSMiabvymMgUu6JUJG1YJhcpsizBGyJGZROHIntymEPEqDLqUGRZEXeImDiRPCRtpdhD8NFudJrpSixKHgaBJeDB2DmDO9yVlmCHmNZS6nC3YCnoELMukzncjZqJHBK2JHf5gSGTN/jRVpLJG7yWMhM3pNvsBNoAG/KCsCFtbyZrgDbORA2JtlVAGoJWtgBoSFhWwBkCyxbADDHLsijD3aBZkCFuRwZj8O2YgRgyRoYywjAaJpYBDMDOSXzBN20mXoi9tqzoEt+aovCSke5ysnHXPAtsxOyYwjXgC1kGa6StLLNq+faSwzTuVsxBGiMrIkSjK5sBNLxii/IMKLcIZ/i2L0AzCFsmwgxf2szbXbOsLLjidaKdhXs8ytDJW7y4pf4Oz97i9JfmC3ExHCwQbdLZcxAmNOvmkZG9hAPCi9bieuMXreVqHH/TL641/TG/iOb092pwpdFv1sSeNGgy9gMR47sKh1/yIYD59mTz+rD9/mAuajS3gAWf8kmpeZkngnpk9yxTGnFgRl7rHatDX+03x8P73RO6exoVmU1ccIkp5DI2tZC5EGpT0CVbbw51IWyYg12y7YtwF8KsCeClxBqUd9CmFMGO/NYSYS9Ui5kAXwpbbyZ9iTbpmfil0OIIf4laOQHAlLSxBIGhW9tEBFNiW4LB0LZNhDDZtpEUhjCpGMMUWEJwGNKSQhBTOk6kSUx80JiOYmKWFi8hRsZNgDExg7L2+IQxiTvs8vWSJIZQXIxiCt9AmsVE38h0GJPdyCkOQthVCkLidsB7gGFhAoVQ5WazkKjgJAwhzZ9IQ3KsKcAhpLhUbMf73WGHhXZk2RdUX9ayDAKSZWIRAploa5oqZZlagpUKLMX2h/87uCJlNC6YnxfbF96l5e4JrXkT94Oeuty9YFRfyT7Q073EHjBqV8b+zzNnxt4vZUV0rxWaMGmPFW8NGfs9v0XM2OtltMrCfd6oqS60x8uwNGN/N7Juxt4u1YYy93Vha5q5p0vZlLmfC22auZeL2pTcx3mmTN7DJSxI7N8CCybu3XL6e/6+bdz55+/ZoIXF+7XAqBl7teiripyaI3ZkHJlTWst2aZ7OyTu0qAWlu7PRS5i/M8uwr8CehdtFalfo6Z+6IxzrJ3aDpmBiJ+iXWWwXOBKavQMMTJ65+6OsmLDzC0TF9yvvd/srvZ0ibRqqLWdJwS6PNGvSDq/AxvzdHWnilJ1dwkJvV9d/RnbUofu/lxymmkPPqKCX90L4AzhryPm7n+7+0nx505gT4/YJ366vH+Jqo/UWtuSXy+7w9Gb4ZvTFbN/GM1qmfaS0r2G1az7dHxYwGxX3Ne3+5ni4Nr9dFzQdSvwa1tv9/RLtBEqaZK2NaLiHY6Q69Kj0JK0OeLw+bNo563huRb0+bN80l01bffS0l7+ur5tEn58ocZL1h65z7tvl73fh5IgaNi48tVV9as7XHI2waK6+3J0J3kYjxzZjVciU9Ca8HBkos7/OxYxjYQnKGNpWBhkRZQnGmKUtAzEimmcQxiyraMCIGFPOF3NtwNAebkAJ1ctrBTRcxFpCOVssaIt5aJFsoPPIYoGdNFgkbSvnirltJ44V8VY0jSrmWhSHirhF05hilkUUUkQMKSWKmfpxoIjqL+OJJT08iRPp7j6ZJlL2FU7ZoUnlLDHrNdEoEbEiTRIpnVkgEdFYyhGz9GdiRPIFTKaIBdblW7NseyAQIqK9kCDS2kOAGJTD+SFWZC4+JGWm6CFqL+Hasyk7wkwp3Q9evXwj5n1AKGlTNsecYFsaHibNK2GHmRaOd0E/NvSw0f220A5oEJW3/zFWTdr93BXl7X1imvJ3Pnet8/c9MYuSu567IZP3PAn9kf1GoHzCTiPq9eRux/P85L1Out0V7XRgY1xkn5O2MbnLgXZN3uMk2krWDidoNbP2NwlrsnY3gTWz9jYxaxI7m7sRE/c1cd3RXY2ve9KeJqMX5+5oRl167n4G2Fa4m/HNmbyXib2e5E7mbkH2PgboK9nF3LVN3MPEdJftYOCDz92/pC3LtWRJ/8d3LnfN0/YtI83orqUrFd2zeAUW2rFAiZn7Fd/SkmCCuNZUJAFSe4ldCmVN6R4l367sHQpl2oT9Sb51ycCGhHEFUQ3ltvWntz8e92Ut+gHUnGGPt5P7qdmcmFQfq9HAMfySv4tz+xfsZDYU9zIsij/L3TZq12gy2lsRPx///PljSuWo9FStw4FyntpR8VlP24r4+fjHL9dmHBaDPm9Qft4TF6hGKkzUjd7hANRFL29IavjUTnrv0w3WlZqo5alphzjbDt6ud+MVAlA3Lr6M3h/XnwtV2xqTtffXTmQMCaDsXI0ZXROUnaixDzPJfcxx8Xl66WAYXHE6HCZT8zcfdvttqfpxpXwbcndcQHFO0Af6yN4Xo8ESx/uac8blP5H7d3BBiYt3Sq/bIZSk79kpuF2H0BEfmaF4b1lyPF9/OPukoTncnlvZ7u/xF353nI2p2u4OT1FJL4NyhLmDTaim13mKXk/T4y3ZuohL8xHw/2o+NftR6w9/jr6n3A6FiMzqVcBSosFuTKZnrlJbdI6+d/vj5uPFfB4+R2dQvFBv0F+Op2a8ksE09gXn6Nrsj8h5CvpK+5JztJ1u49BqTJctN0dTO2NnabLl5mhqax43O+ywCNPnl56jdYvHFWIqh6Lz2kmzzuzvfclZT3dDcC36bLcIrKB7uTdIfvupLfxfxyd8jAx+XWSIHEvMGiFDM8sGSFxlbHzM0rZ9l6PJlJqh5dZu/79bd+9mvHBE1IXFy/SmB2FEYXQMztKED8GY06IjcKYurBujumK9OEvX+tS+mjFrR5QNJWdoawdyU26MHBCFfuEZOu3IaiX98Qt2aox1CKTSHBuwoRJTGxspyZ7oDZT9qVhkQTkqkQ8E981vu83x6bw+fdht1vtv7EFcpoaXZG38acdPQm1c2gV2X3jcrAhbQJ1yC3InEkJ/zmQSU58zodCqY5NKttbIupvQnLH0ztbe/qX5LVexKzyzoaGTDaEyOuFka8QnHcqx0YknWye2Jic0xpbl2fp+Ra/4ITS6wjN1EutyQmliaZ6tFdtXESpjW6uC1oMtI8jWE1tK5L9ZbKKj3mtsskM0/vNV3+3/8J+O8ncHem1B9sAfVm3N97tmv22l/MOa8qoLMHnuZP2z/+3vTTfcdiVskd8/vnj1j8dXij/wVf3Pf776h6thfjB/MMWq9r+qV2z18CjDYlVQjLX/xV7J+oHVq6AYC4rx9r84VowHxUT7XwIrJoJisv0viRWTQTHV/pfCiqmgmG7/S2MvRAfFauqF1EGx1in/qDFpq/D1dm97hRlXAT/Qjgg9UXVvvHp8JcXDismwZOiMqnvpVYUqD/1RCdLK0CNV9+bbxYF8fBCPQHnolKp7+RXaFqrQL5Umnzz0TGVcg7abKnROtaLfUegf1nmhkpgjWeggZhyEtjMG+orxkEZLhh5ixkNoM2Khh1jnh2qFlgxdxDo/MLTns9BFrPMDq9CSoYtY5wjG0JKhj1jnCMbRkqGPWOeIds2DlQx9xB+pBsJDF/GKbCA8dBE34xk6tnAwonGyHfPQRbzzA0MbCA9dxCWtPXQRV+Sjhx7ixkPo8MZDD3HjIbTN8dBDfEU/UOghQXpIhB4SnRsY2oxF6CHRuYGjzViEHhJm0kGbsQDTTucGjjZjEXpIdG7gaDMWoYdE5weONmMRukh0fuDoUCNCF4nOD1yhJUMXiRU51IjQRZJ0kQxdJCty7JShiyQj5xcZukhycuyUoYukcRHajiVYHEhq2pehh6TxUP1K1A+ai7Bk6CFpPLR6JfQDf+RhydBDsnODeES1hx6SnRsE/pJCD6nODwJdZKnQRarzg+DYE6nQRarzg0BbpwpdpDjVPlToIWUWb+jgpUIPqc4PAl+ZgRVc5weBel2FLlLkYkGFHlLGQ+gwp0IPKeMhdExSoYd05waJjkk69JDu3CBbr7MHUbGwZOghzagH0qGDdOcGiQ5eOvSQFqTI0EHaLLDRUU6HDtKdFyTajjRYZXdukOgop0MPaXKlrUMH6c4LUmEjkg4dVBsHaey116GDauOg+hVv26YOZdahg+rODRJdHNehh2qyC9Whg2pBdow69FBtBjm0xdWhh2qzC0JnwTr0UN25QaENqQZboc4PCm0fdeiiekU+euihVecGhTakVeihVecGhTakVeihVecGhU6Xq9BDK9JDq9BDq84NSmP7nFXooZXxUDu7qFZm2ORWoYdWimxyq9BDK+MhtMmtQg+tOjdodB5agf1q5weNjkgruGXtHKEZVtT+5pftXKE5XhZsXB/NUIdvHh/B1vWx84cWuFyweX3sPKIlXhbsXx87n2i0rdjf/LKdVzQ6K9nf/LL0JvYR7GIfa7Jt2d/8siuyddnfvLIGKODtqxrBhopsDRXkDYYqEM0BEgfDFYjmAJmDQQtEc4DYwcAFojlA8GDwAtEcIHowhEGjq4QK0gfDGDS6Tqggf6jI8bACAKIymIFoDgBBVAY0EM2BQUzE6OYAMERlYEP9iC0oKwAiKoMbanSiqQCKqAxwqNGppgIwomLkVrcCNKIyzIF6ZcBrhjpQrwx4zXAH6pUBtxn0UON8C2CJysCHGp30KgAmKk6uBysO8Z7xGt7QAZuoDIGoFV4WeM0wiBof9wCfqAyGqPEOBBBFxekxEjCKypCIGu9rgFJUnO5rAFNUhkas0OVUBUhFJWggC1BFZYDECgetAFZUBkms8C4hIJU1WBZdf1UAWFQGS6zwNgaQRWXAxApdWlUAWlSCdhqgFpVhE0R7BNyiMnRihc/DgFxUBlCs8PYI4EVlEMUKb48AX1QGUqzwRgYARiXJlWMFCEZlOEW7UMIhOeTpBqg/4m0HgIzK4Ip2qYRbDBxniEW7VsILA9cZaNEulvDCwHfS0nW8/QCoURl00S6X0MKAa1TKsifc1QBtVMoehOC+BnSjovFGBfhGpei1fwUIR6Xo1X+l4IGIorsHoByVxRyPK/QEA5COyvCMqkJ3ARWAHZVBGhVxKgR4R2WoRlWhTKoCyKMyYKPqUDny4gD1qCz26Fg9Vhg4z6IPFABUgH1UBnEQczjAH5WBHMSkCABIZQkIihYqDQ+0jPcqlJFVgIJUFoPgcLQCJKTS1nt4BwEwpKqt9/AOAnhIVVvvrV5xPn5xAIlUtd3J4S0OUJGqJg+FK8BFqlrE5ALv1fYsEl+JAjpSGQZS4UdYFQAklcEgFX6KVQFGUhkSUuEHWRXAJJXlJAwfOgEqqVaPEZcAWlIZJlLhpzUVACbVyvoPb0aAmVQWmuAnRhXgJtXKehCfVAE6qQwgqfBDngrQk2plD5RxdwOAUhlM0i6YXwn+8Mjg2wAeNKSkXTG/EtWDGB0Xw5Nl40EucMnwcNl4kEusMAMohRlc0i6a8cLgiNmyFK7xwuCU+dGeYdZ4YXDQbIhJ1Z2CYIXBWbNBJu3SGS8MjpsNM2kXz3hhcOJsgYpAPcgAUmGPNjKA44XBubPhJu36GS8MPFhF+iADVIXZGA4hsYbEAFZhNo5DtO5mD21jB4WBB20oh9B4YeBBC1ZEjRcGHrQRHfjxBwNohVXkHp0BssIMPcHnYQbICjP0BD8tYYCsMEtW8HGOweAOw09wds9geIeN75CP6FsbRXgYuILLBa4z/AQ/fmQwyMPwE/wAksEwD8NPKuKtwUgPC1ckCtsYDPYwCKXd1uCPB3xnGEq7rcElA+cZiIIfXDIAWJiN+sBPkhggLIyTm3UGAAuzgAVfpjKAWJiN/sCXqQwwFmY4SrsPwy0G7jMghbAYOM8GgVAWA+dZyEJZDJzHrfPwUCXAWZjlLJKIVgLeoyNCGAAtTET2DQygFiYi+wYGWAszPIV6PABbmLDeI0KsgPcMUanwgzkGcAszSKXCz+YY4C3M8hb8eI4B4sJEHZmdAHJhNlYEP85jgLkwOlyEAeTCbMAIfqbHAHNhNmZE4UMngC6sDxvBOxTALsxiF4WuaRnALsxiF4W3ZYBdmMUuCt2MM4BdmMUu+JEcA9iFyZj/AHZhFrtovBkB7MIsdtF4MwLYhVnsovGWAbAL67EL/jYAdmEWu2i8bQDwwgxcaTfeeGHgQUNXKvwkjwH0wgxeqfCjPAbYC7PsBT8UYoC9MBXzIGAvTNGneQygF2bRi16h0ztAL8yiF/wAhwH0wix6wU9wGEAvTPPI8wH2wgxfIZ4PsBemZez5gP8MYCGfD8aqmlBItP8B9sJ0zHuAvTDLXiiLgfsseyEsBuyFWfaCn5MxwF6YwSvESwbohdmIFMJkAF+YhS81EbsL3GfhC75nZgC+MMNXiGUtYC/Mshf8sIwB9sIse6nxEQOwF2bZS42PGIC9MMte8EMwBtgLs+wFPwVjgL0wy17wsy0G2Auz7AU/sWKAvTDLXlZ4xwbshVn2gh9EMcBemGUv+EkUA+yFWfZCdCrAXphlL/i5FQPshVn2QkmGQePGg/gpFwfshVv2gp9HccBeuGUv+IEUB+yFW/aCn0hxwF64ZS/4kRQH7IU/2kB/tG1wwF64wSvsEW0bHLAXbvAKw8+ZOGAv3OAVhp8zccBeuMErDD9n4oC9cINXGH7OxAF74QavMPyciQP2wg1eYfg5EwfshRu8wvBzJg7YCzd4hT3iHgTshRu8wircg4C98Mpma+AeBPSFG8LCKtyDAL9wg1hYhXsQ8BduEAurcA8C/sINY2F4eg0HAIYbxsIq3IMAwHBDWRh+EMIBguEGszD8IIQDBsMNZ2F4qg0HEIbbZBs824YDCMNtvg1+YMEBhOF9yg3uQQBhuM26wQ8sOIAw3Cbe4AcWHKbeGNDC8AMLDtNvDGphDPcgzMCxKThEysooCcd4kMhagXk4NhEHP4PgMBXH5uLgZxAcZuMY2MLwMwgOM3JsSg6ebsJhUo7NysEzTjjMy7GJOXjSCQckhhvcwvC8Ew5YDLf5OXjqCQcshhvcwvBkDQ5YDDe4hXHcg4DFcINbGMc9CFgMN7iFCdyDgMVwg1uYwD0IWAw3uIUJ3IOAxXCDW5jAPQhYDBc2+Q33IGAx3AAXJnAPAhrDDXBhAvcgoDHcABeGJ15wQGO4AS4MT6nggMZwA1wYfqzAAY3h0ubD4R4ENIYb4MIk7kFAY7gBLgzPmuCAxnADXBieD8EBjeEGuDA8JYIDGsMNcGE4y+aAxnADXBiOkTmgMVzZREbcg4DGcANcGE5wOaAx3AAXhvNQDmgMN8CF4TyUAxrDDXBhOA/lgMZwA1wYzkM5oDHcABeGI04OaAxXNr0R9yDAMdwQF4anI3CAY7ghLgznlhzgGG6IC8O5JQc4hhviwnBuyQGO4dompOIeBDyGG+TCNO5BwGO4QS4MR5Ec8BhueQyOIjkgMtxAF4ajSA6IDDfQheF0kQMiww10YThd5IDIcANdmMZzXwGR4Ya6MI0eM3CAZLihLgynixwgGW6oC8NjzjlAMjyGZDhAMryOHAhywGS4wS6sxtsGYDK8tvnFFcaHOWAy3GAXhpMvDpgMN9iF4YCKAybDDXZhOEfigMlwg10YzpE4YDLcMhn8xJMDJsMNdmE4dOKAyXCDXRgOnThgMtxgF4ZDJw6YDF9ZD+INCTAZbrALw6ETB0yGG+zCcOjEAZMRBrswHDoJwGTEo80Vx5OwAZMRBrswnCMJwGTEYwRqC8BkhMEuDOdIAjAZYeNh8LgjAZiMsPEweIcVgMkIGw+Dxx0JwGSEjYfB444EYDLCxsPgcUcCMBlh42HwuCMBmIyw8TB43JEATEbYeBg87kgAJiP6eBg07kgAJiP6eBg07kgAJiP6eBjcg4DJCBsPg8cdCcBkhL3nBI87EoDJiCpyMiEAkxE2JgaPOxKAyQh74wkedyQAkxE2KAaPOxKAyQh77wkedyQAkxGWyeDEVQAmIxiZ0SwAkREGuuDp6QIAGdFHxaAhPwIAGcHogCYBeIwwyAVPCBEAxwiLY3CaLACOERbH4DRZABwjLI7BabIAOEZwe98GfuEGwDGCxwZQgGOEIS4cR88C4BhhiAvH0bMAOEYY4sJx9CwAjhGGuPBHga1LBMAxgpO56QLAGGHDYvB0DwHvSbFhMXi6h4B3pRjewnH+LeB1Kf19KXh/gjem2CtTcP4tRpem0J0P3prSh8XgvQ9enGJvTsG5uoB3p9jLU3CuLuD1KTYshnAJvEHF0BaOQ3gBUIywYTHE/A5QjLCBMcT8DlCMMLSF43hfABQjpL3yBj3kFgDFCHulCn6FkQAoRhjawnG8LwCKEfZmFRzvC4BihL1cBcf7AqAYYWgLx/G+AChGSOtBvCEBFCNsYAwxVwIUI1Rs+gMoRqhIQK8AKEYo60G8PQMUI5S9twhvogDFCENbOH7KIACKETYwhpiyAYoRhrZw/EhCABQjDG3hDE0FFwDFCENbOH4kIQCKEYa2cCax0AoBUIwwtIXqKQDFCM0iPQWgGGFoC8cPOwRAMYK+kkUAECNsYAyezSUAiBGazikTgMMIHckpE4DDCG3dh98sBTiM0NZ9eAcEHEb0WUn4FAg4jDCohTM0glsADiNsVhLha8BhhM1K4vhrBhxG2NAYPERVAA4jLIfBQ1QF4DDCoBY8tU0ADCPqyAoUUBhhQAue2iYAhBGGs+CpbQIwGNHnJOEzPGAwYhUJqReAwQiDWTjH2wVgMGLFI4s5wGCEwSx4KJYACEas7MVv+BgHEIxYkekQAgAY0QfFoEBRAAAjDGOh2iYAMMIwFsLTgL/IR/qKEAnwizSEBW8VEtAXaSNicEdLQF/kI6cdLQF9kY+CdrQE9EU+Wueh+wEJ6Is0gIXjh6gS0BdpAAvHD1EloC/y0boPnRkkoC/SABZO3HgH6Is0gIXjh6gS0BdpAAvHD1EloC/SABaOH6JKQF+kASwcP0SVgL5IS1/wvaIE9EUawMLxE1cJ6Iuks5EkYC/S4BUuOH6rIfCfwSscP5yVgL1I+qYXCciLNHCF42xCAvIiDVzh+CVhEpAXyVisMPCeTUiizADes+QFXy5LwF6kTUnCGaUE8EVa+IIzSgngi7QpSTijlIC+SJuShDNKCfCLZJZ+ooxSAvwibU4SziglwC+yv40WZZQS4Bdps5JwRikBfpEWv+CMUgL8Im1WEs4oJcAv0mYl4YxSAvwi+7wkvGcD/CJtXhLRkAB+kRa/4FspCQCMtAAG36RJAGCkBTD4hkcCACMtgMHDIyQAMNJmJuFoQAIAI21mEo4GJAAw0gIYolsBBCMtgiG6FUAw0mYmEd0KIBhpM5OIbgUQjLQIhuhWAMFIm5lEdCt4j61FMES3gnfZWgRDdCt4na3NTSK6FbzR1uYmEd0KXmprc5OIbjW611ZGuhW829bmJhHdCl5va3OTiG4Fb7i1uUlEt4KX3NrcJKJbAQQjlZ0H8VUMQDBSkZmdEgAYqewsiC94AICRNjOJWLICACMVfamIBPxFWv6CBzNJwF+kvfgWnYkBfZGWvhDXGAPfWfiCX2QM2Iu0F8LgecQSsBdps5LwsAEJ2Iu0YTB4JIAE7EXarCT8VF0C9iINXsHziCVAL9LwFY7Hi0kAX6S2zsPXnwC+SANYOB4vJgF9kTpyI4UE9EXqyI0UEtAXaekLHokmAX2RBrBwPBJNAvoibV4SMfEA+iItfSEmHkBfpE1MIiYeQF+kpS/ExAPoi+yjYPCJB9AXaaNgiIkH4BdpM5OIiQfwF2kzk4iJBwAYaTOTiIkHEBhpCQwx8QACIy2BISYeQGCkzUwiJh5AYKQlMDiFlYDAyFVsFwEQjLSZScQsBRCMtAiGmKUAhJEWwhCzFIAw0kIYPAxTAggjV/QuEDAYFWEwCjAYZW/XRTmQAgxGRW7XVQDBKHu7LnqlqwIERtnbdVGOrwCAUfZ2XXQqUYC/KINY8EuOFcAvyhAW/PpXBeiLMoAFv/5VAfiibOgLvghQAL4oC1/wUFsF4IvqQ1/QLq0AfFF96As63CsAX5QNfcEHZQXgi7LwBR+UFYAvyoa+4IOyAvBF9d/3QQdlBfCLsqEv+KCsAH5RNvQFH5QVwC+qD31BB2UFAIzqQ1/QQVkBAKP60BfcgwDAqD70BR2UFQAwyn71Bx+UFQAwikXwmQIARlkAg4+zCgAYZQEMPs4qAGCUBTD4OKsAgFEWwODjrAIARjG7fMG/1AAAjKI/BaQAflGcvuFfAfqieGTsBPBF8cjYCdiL4pGxE6AXxSNjJyAvysAVYjwE4EUZtkKMh4C7qP4+GHw8BNxFces4/MMZgLsoEQmcUIC7KBEJnFCAu6ieu+C9CXAX1XMXfDwE3EX13AUfDwF3UT13wcdDwF1Uz13w8RBwF9VzF3w8BNxFWe5CjIeAuyjLXYjxEHAX1XMX3IOAu6ieu+DjIeAuqucuuAcBd1EyEnqmAHdRNvQFX6QqwF2UjA2egLsoGRs8AXdRMjZ4Au6iZGzwBNxF2dAXPO9Gwe8LKXrwhB8YUpHBE35iyJAV/HhVwY8MxaiLgh8asmEveJ6Qgt8aUhFqpkafG7If7UKPgxT84lB/Fy8aTabgV4diYS8KfnjIZiDhWSYKoBdlw17wRCgF0IvSkdtcFUAvyoa94FlTCqAXZS+EIQZywF6UDXshBnLAXpSOnB4pwF6UjpweKcBelI6cHinAXpSOnB4pwF6UjpweKcBeVB05PVKAvag6cnqkAHtRdeT0SAH2ourI6ZEC7EXVkdMjBdiLqiOnRwqwF1VHTo8UYC+qjo2ggL2onr3gAzlgL6pnL/hADtiLWkVOjxRgL8rgFY7nFyrAXtSK/OyDAuRFGbhCjM0AvCgb+oIGtCnAXZTlLsTYDLiLMmiFGPQBdlGGrHA8d1IB7KL6y3jx1gmwi+ov48XHFwBedH8ZL9o6NSAvur+MFx1fNEAvur+MFx1fNGAvur+MFx1fNIAvur+MFx1fNKAvuk8+QscXDfCL7i/jRccXDfiL7i/jRccXDQCM7i/jRT2oAYHR/WW86PiiAYHRNvkIH180IDC6ikyBGhAYbcNf8IWiBgRG98lH6PiiAYHRffIROr5oQGB0n3yEDnMaEBhdRWJ3NSAw2gbA4CnJGhAYXdFf5gP8RVf0J3M0wC/a3saLfxQR0Bcdu41XA/qiGb0C1QC+aJt3hCfragBftL2PF8/N1gC+aMNXOJ6brQF80YavcDw3WwP4og1f4XhutgbwRRu+wvHcbA3gi7bwBc/N1gC+aAtf8HswNcAv2iAWjidya8BftE0+whO5NQAw2kAWjidya0BgNI/gMw0QjLbJR/idkhowGG2jX/CJSgMIo230Cz5RaUBhtKUwxEQFKIy20S/ERAUojO4pDD5RAQqjewqDT1SAwuiewuATFaAwuqcw+EQFKIy2FIaYqACF0ZbCEBMVoDDaUhhiogIURlsKQ0xUgMLonsLgHgQURovIrXYaUBgtI8kPGlAYLSP30WtAYbSMpK9oQGG0jNxHrwGF0TJyH70GFEbbBCT8qlYNKIyWZASoBgxG2/QjPJNAAwajDWYhZjWAYLSMnCFpgGC0DX3Bb3/QAMJoFTlD0oDCaBU5Q9IAw2gVOUPSAMNoFTlD0gDDaBU5Q9IAw2gVOUPSAMNoFTlD0gDDaBU5Q9IAw2gVOUPS8BPQOnKGpOFXoHXkDEnDD0HryBmShh+D1pEzJA2/B61jkyD8JrQNgSFGGPhZaB0JP9OjL0NHws80/Di0joSfafiBaB0JP9MAw2gbAoNfqqIBhtE1GX6mAYTR9kPR+PIWMBhd03t4DRCMtgiGGGAAgtGGshBLYUBgtL2WF8/x0oDA6NqGn+FrUEBgtIEsHL9iWgMCow1k4fgdMBoQGG0gC8fvgNGAwGhLYPA7YDQgMNrmH+F3wGjAYHQf/YJiXg0gjDagheN3wGhAYbRNQMLvgNGAwmhDWjh+B4wGGEZbDIPfAaMBhtE2+gW/A0YDDKMthsHjVDTAMPVjZBdRAwxTG9LC8dtlaoBh6sdI/FINMExts5Dwq2hqgGFqm4WEnxfUAMPUFsPg5wU1wDC1zULCG1INMExts5DwG3FqgGFqm4WE34hTAwxT2ywk/JKbGmCY2gbC4Fd31ADD1DEMUwMMU1sMs9LoewYYprZZSKsaa3U1wDB1ZfsgNi7WgMLUNgkJjZ6tAYSpLYTBR/0aQJjahsHg0bM1gDC1hTD4V3hqgGFqGwaDR8/WgMPUhrXg0bM14DA1i3xZoAYcprZpSPiFIzUAMTWLHOTWAMTU/YeR8IYBQExtr4DBrzKpAYipDWsR+O0kNQAxNaNjsGvAYWpGx2DXAMPUke8i1YDC1Aa0CHSsrQGEqQ1nEWimZQ0YTG0wi0CTp2uAYGqbgES0CoBgakNZBH6lSw0QTM2t7/AhDiCYmlvf4UMcQDA1j1xLXwMEU/M60t4AgqltIAwxEAEEUwvrPnykBQimtglIeHsDBKa2F8Dg7Q0AmLr/MBI+EAEAU9vLePEw/hoAmNoCGGIgAgCmFrHBEwCY2jAWoo8A/lJb/kK0z56//PPVi93hU3O+NtvvD9vmtxd/+Mc/XvzrX9cvp+bFq/+8+NfO/rF6ZWS++MN/XlTt//zPqxe1/b+q/8923Db/3/Y9+//K/r/o/1v2/99uq+3/9+XbHZ39f9H/fy+37su1K1/z/6v+v6tH7RT3v1SsV9V9Gb7/hyvDXRnhzBTuJ+kEOou6b/fZf/DK/UP2/3BPwdxjdBdu2X/w3uDuFiD7D/coXfa7ffZq+EdvT5e0Y/+xWrn34l6Qcv9YuVdT9So6mtO/JFO9/VfvTvNfnXvXm+vueLj4rmsXd3ffCU5VbC5Mqs317FftbqAa6gr7NmJ1t83m/OV09UV0t3R5Ih5TIpoDIkJ7ItiKErF/Op531w/PQbtt57/708vBaSvntNq99b5ddEtTSv7++Ln9n2tzWB+uT+tr2EEq7zm7zwpTQi7Hj4fj58M68FEl75UZWfd0ag5bv5rwHk4OHYesf9m09XeHp8DFK091t8al6l7aMaJtWs/N9cMxMIJ5RjDy5V0ux80OvrN2WXevypwHbHOPCTk3l9v+GoryXj/j5GNcr83lujZ9ZPd0aM6BF7rbGO4NzXW/7jKGmDQohPlCFPlCbtcP7X/vNqN25DX27lvW6er//nx53l0uwLGV32u677EkBbUvJRTgvVERqX4MxowOVt3rVdyNl/2AJ4aRz/VB6VqudOOlck2hiwq0/6jddFFJNxb2krUmm4uxbfffoydr5+XBQq1yatvGEjY4v9kPT+fmou5el771uGY0zHyPw5A/DD7up5V7OiewQ+f9kB93QW/o7WBHl7Fb/HGY0026F9aETdobI7q7pXp3OavdsNqFCPRWPzrnxNr/8dy91/X1dm5O6y/743obNiTlNyTm3rCbgZV7se41StdapHuNyrlDuZlTufVEF3TQ2+qM1pqw9d360ihxO++vx3df2i4fjH61381W1ON6Io7v/t1swgmu9n2zolrku/1x8/FyPZ5D5/iOrV1/q8kh0DxB+yDOoNCQlW8I+T6sCORBVpVfP2HC5XoGY1Z327JXn+rYm/XheGhHrP0uaDDcay+Crntav9vtd9cv22bfPI3GBuZPSWkh7dr5OB46mbdsYtRb3ITWV/68UdVUQ9rsm3XQsYVnsBtbGXNjq3btwXWb2v1UC9Kw/fECmpi3zNBORd9/uk/X9QOcW4G4Mbpm7i+Cmn42x204/fnLke77ZFS159P63MBXyP2pxw283X3M1kBnjnSbAFn3D6HcCr3LUbD/cBsR/egmGreH6M7komY9N5fL+qm57p67xcbzKRzVhG+jW4e67ZN0Ww7pBlXpZpIuJ6ofzJgbzNx04R5Ru/Ws1tQI39l4u45end9kqzr2gG3l7frp9K6V8P58fB6NiBUTviiyD41FtQNCsw6X7/7MU9XUgLI5tuva0cZH+3Uf+9dZDZ5+dLMvJzvC8fB+B1bL2h9smWvnwo269NN2om7h0N190uDe2MkJvq3bvpnb5vqxaQet8+6TGW9O6+uHcPTz5gFNLsRpYbduBbldX9fvj+fn9fVy2XxoW3KoYuWroBtJVMXpfLweN8d9W+za/HZF1OjKVxN5pTlquj9gOh59HZEWENNh5K6xN6WZLz7Sbq14sFbzl95V7dDFykEI19uZ6+3MLaGZG4OZG/iZG8fYyo3cDjkIN7IJBxi6S6vtoONWR9JxnO7KlX48cqOPa/XKLcWVGgZPN2a5yUE7TtRFm/VDlVuJOV5SuxG7doVrNixnIh5qN+RXyKuYvyqL1v0t3EcGY5dVzinY0tcHqxDmAw9yA9fXPR/3gd0rX7+IdOKu5h5sSYL1svMfLaKjfu93+2sohfvDpuZk/XaoBjtX7q1EqpVrdm6O4u4f3Tcd7D+kM1K4Zucaq3JDq3KTrnKtRLnmqx3l04pcXRgjvU1/8KC+r4Uk37WV4W+y1hdkf8V9AHHvWe4RhxWZ67PSvQ/l5v4u5bF/VveIj0NncZsURTZmz85hWxU+r7+Lk+TobeSEhMcbjgTZGWw9FDJVfnesVnF3bbcNLsMHbKt4u+xWE+Gz+1BGxg3oKh9Po+VEdx2qR4fi7aWTcWrOhsu0cs7Nr7e2DQbifAoh6XHCiEMdWvnrcuaaiqiGfbFb97qRVrrRWLmhTYkBsLgV5KNbU7pOqRU5Aw+2gSFEeG9bVnFXYRwu4JoV5a1urRI6yKsm3AGCILeRXX24DK78MUwP5wDM/cMdEbhhSZCrtvtKKlTgL0q1djZSGx1vPRaI8dcXTMVqXwDMqYIpTg9P5tYLblRlbsgR5F7UiIc8wns+d3rCYh40AvbNpyYgEV1chbfQjj7geNcg/X2gw0OMPPtopTTIsCc9E9yIXLl1lSD3SJ205rfT7hxui/wFp5scu9traCGn27v97vIBGOVvQB6dUW5GdXRLRgVfjuewUTLlD62u1VfUmLR9Fx5CeE9WkxuPbdOdTX2CLzlA7qSDmo4TnPbr3cFCJwQXcn8ClnSLGR9RdZkt3mKd7NDN+91hB1cRtT9gDGd4K1rIvoGHID4QcIiCr4Yl0bAoHsAN/Yo74W1XOlwv776AoU14I4Y7Yqw52TPJfWal/GUmub68CxjvjrpPo3gi3DgTea5WVrPulgTG+V2/2PQHha2Cdm8WTh/Kf1RNt4RO6ubDbr89GVubVlA4BlV+XyN7lJHjZPz788fwUX2eKMgeFcgAdlR++2SSblqdDEqEv1QYjpFde61J0NYLNW8cytTBwZ9bjJPUF1/WcX/HUz+Sc3Vb+bw7jc6ofGrVTzeV20ZWbhOr3F9UpL1b+eGi3j+fJE8ytrvt9ri5mb8FqzPPtP6Fk7spT8Zzc13DlY0/Prv9Mwn4W1ntW2pnn+P+E9gg1l6DZpp8F7tt62pUgL83ZIpsibutPSY+HK+X2+l0PINBv1r54OsxKQd/GH8JRAZEtDI6K8ZHDf6sxclDf1v9EzxqYI/+QccjuRTYWdNvXbt9v97twb7KD6/gj9TOLpCCNg+fmfdNnQzWCKSND9J9eEtyKycDuMR3SL+GIM/UtjfAxWt/NBlW3m5lw+rh/MKxIbdircmznu3ncLCog7MdstV9PozBr2ccOVSaepfrGowDfvwNI7eNbe3mfIZntoEzIo9pqo7PUvxhg56/Ph92h2tzfr9uh+f1M8Bofgulnfm5jwsZ1/dPNmty+Pt8uDTnT+2k3k4Qp+MufIP+6owQ0Gx2zeXSbE7t3PaxCkOYPKcLTvXUUAC2SPTHC0HOI6EcNJjJhykkWmxrtt4Me1ftu5NcYd7XRQFX9A8Xh50dydbvQtCoKv4YrNrTpuwOpxt4nT5848M+2K16yTnhLvN0Pp6a8zVYk/gvtyIxTy/j8qX9czsxhEvJkOX6yIdEb82vt3bRte/CaMItSRA2QVWGvZ4FXYaq9QksN/xjRZKHmlr7YzCyeY1qQP2J6shu3XvvNbndtzuTcHzg/vgSfdrLUwN6kv966Qbj6vanssFL88xW1GQ3CECYIPOHWMGo8W0QcW43sUEL86OIyJ1K81uzuV2b22HfPcK70XKK++RdkmuZ7rih3YNvQSMNTvcrakAaHxRI/5RuYAbu/NnFG3Q5f4RE9PBY+UtUQQ3XBtGOwk8qf+PHyB731LTz5Xr/78+Xdv2ye79r/+dgVngoZWX+BMLJDYoVCrb22t+4kVEDrmo7+JzWu5Ck+tFFmlw8AAnn9edQiH8yTIYXGSG7DdJNpH+YSbVx0DsrvxJzcVh8CBZxUWS1O/2oSfrTSsYjLf2QWyGp/ttVR45rgohbF1PmYgKkM1i6eBBZuz3ksKt0gFy5Rap+HA453QEOuUdqrRpFr/hgxYkSLkREuqBI6Y6JpEPcym19lYtBV44sa7f11S6EXZMhqa1J7X+ev4Dxwd9jC3fUKzQ1UHRSRuN8cCDgOBa5+BlEICOuH10a6VFXg+rW+8/t2gWcgvkjtqTHiO7IHzjIX8wycjXQVYVDrA/FyX1eN0e1u7Fdt/LbjLC99ltHzIeH5nPbV5BuXPnHKsyd8wgXMihd2oN00ZvSRd0qxx7VEC/vohK0O83Vru1pcibt5tD9ljLOH/iHI+J7HII71RoOjWtniptqlDvnUq6vapcsol031uQk2xpnMRcgeNyPSdTkJmyoDpeQfkilJkMqzdpgHNTu+5xcZrd17SHaaGZXfrMjLd8f3633o0AEH18JUvUZ7HaZv43nNfm4Xb3gTN38xR6bAEYi/OmXbFq4QCQuvm34nkDynIAQeDhev7TzSXeSEa4S/ANmXpEDEy713Hw6foTP7e/2yGXZWOCwl2+f/Xl93XwIpfpxMeTJ6liq3d7jIv39CnnYOxbZvkrr9O37bkV7gC3p0WeEVbQFEnKvx/HEzyq/gVbkOGolvAv6sr9ZqdwEXbnxU7kTeEX31OF5A7Fe03HBLZULHFFunFYk0RueNhDqk3G3vqmGsBoXoKJIJP0Ubi89J5PxAB/Wh+3eRb/C7Vrlr0LZimrQVsa52RzP28uvt+Ycnjn4DISR8aCBkHMD8gr8NTUjT94DGaNlRFX760cyyPXDdnQQ478Fcqdt6oVncP0eJWzLPp2rqMEWrGL8hDh3UuLWmJRXbN3g0NdPGxPUS+xXYX3P/NSMIh19kFS5EEMRkdcPbgHB8Py5cmG+biVfudVB5dbPFbkm313oVaNPEYc0QvIIZXfpVmEgL8rfELmFiXBLdzmEXrrzUOkO85VD3mpIonUrf+0eU7tNgSYX5rtLt/gCNvlE3MkSQ7qqO2uSbtkvXQyqYm4kcesx5WLptduxaBdcpCPvaTzwV35CYeWWchXJ69t9fLjq8eOqyKMZuEzz27Mgg9zaWuunc9PAwz4/d4OMiw66NHIq7s8DjNzOtlJwxFs9BoehESuiXNbPtSW35GMhoQ/8xYsgkz9GOyzut0c5xEWqvj3WJORrJT13eaFt3w3lMV8eNdpi4MXnqZLMSN03v7XbtXYCPn3o8pE2Nv8jHCi9R6rJOXy/e94FjlB+UA1V63n9mwvxMtnJ3SLgXWPPDsCBq9/RSQSE7sv8ic6tSoSbMYQLJZFs2Kk5TuHCDKQblBVzaxk30iu3idNuFaXdeKLJzMzeShjf4oNsl4BEtZe7CBB46LNQEqO7FU5Isv19ChnOSSyOuI81JDn8eLURV/nolIxO80RgMa7+Ok+ScYWekBHR9hksuf9zAkAgmvRDz1N1YeChf6DUNzwSEPkyRqcZwh9Ia3Ix78vAXqXPx6VOSEFzxWSQ2WmfyeVIV9WwrnEzJBtiFF1qnhtBhVv7CEd0pNsSSDUEyQw3dLgZ3aUTKncsp1231y7hRJNnuuOLAvyl72oI1hlu8XD7KRcCV7lezFRfhg0PRh4qHJrfrrfTFoB4HqzeIlU/NecuXhvOSv4hIFW7HXID//sPS9Y5P3eL4wbLwvBz1MnjZnsGgqUl+1EHggzvOp6aMCci6P79y3ZJOHK4I8NRuXq4s4Ecso6fYXC4n9wkFNV8TL1Yejj3l4mCXNOf1k+7w/gGgOC80j0n9Za6OR2e7VZB6Jk7zRBkw2xlXED0vi/AJWeJAcsOENad1ks90FjXLx3TVy4qWbnIYu0i1bWiPGMsGqWB+oiDHL7vmQ145qUf9Ejujb30iHAi9fkceZGKV3tzDHO//OhSkjN49UcQk/txf5Jch0AReAyhHy5LZr5AUQN+Qombvxnl5NoUygw9XQcYYMiVcJOBu1xBuflGu2lGk6tRqBBZoviHGBV5UA0FobOrz7ZJKg8lmbYypO2tD1s/SzR8x/5yjoyER+XbrNBW8ofdu12H+3bNPlxnsiqI2Mto40b67TBcz7Edk3f/YIuzjHaPJiX5x2skHB8Lwdu+f/5dkVvxsbSwqfqxy26cVAXSsHbo55KR4GwsCm2JPholQyYDWR3tD2X4gShkZO9IBvHW/SConOHBCkNekx8vXJGJEWNJ9tQlNsQy/5ojTkYMjURjDvC3yorkJiNRfm8au4T5wQWcjOzBo/65vxmVQy4u/ZiDFGQpx33UrOkpZAj8RxLy/K2hotdKQET7ht7t233ittneNg0aCcj81Rynm0hU8ogDMX9tx8mUorHUIdp8czuDAzof0XGS0d1FXo/QqX74sCbPDdpxf9P2JAyl1H44L7246qekoCP6WYOOFFdi2Cm543J6rdILDfOYN/15WQ+Pwvflny2QFySgcre3097cTOYluXeXtZx2EJv6y01ORqPGldzPrwkd/kxOj8+Yjl27vj23Uq94MicLAu/Je/fioskVSJD0QcbKEMJtPJtZiIRC/WGX3FbGhI5uWgjiVcnjRFRkP1HA2APmJ5xzEsBERd72zQXEi/rpwZwksajUro+MrPQ3cJy8ZAKVZ3eUXThnuh34GZKcDGBH1XQmuxeC9g0fjHAy2Bjc2BIeWvhgmd5r9hKIHEo/IznZ0kcJiX6gQOUYBXM7GEGCRCcQOpb7nUQM90CRSHWQM25zfuxQRZ5qOgFgH+z3/3pgcqkB7IJeNcT9Lbkiz+PGQrwhfH2972no1uqPtvRKdqQHX8r6OV5VZB0Apd3nhDyj/XE87aZBTT8k2nm072jH96Fof8AlT8ISoo/viUna53WcPK0jpY+HtCDRMNUT7/KQ1Y4fGV+Ria9jUegK309uoJHOSJa/xA+f059gyOi2QeAoDoX7jEmRUX2hgDHl9TMYKhIth1KwV+1vs2Wy+Rox6Gv2Lzygd8WBnNH5j38dZUUGlIRCSD/5EaucJPdOWLc0CRm8PzPQ05uJ2xwxYr/R0at9NGTUPzOVbDghJfunE4Lu/vyDALrto7Gn/swoyHyIoS449vAD+wTdOl1t+BKCE81UZWS35ScdkJFe6B0ZfpBY5WJYKu3IujtzFmSq+iCVuM3Ib1ZkIt4ghLjPyF+OVmRqB4jPqPxTRebO06U7Iatd6E4d8Rcaaeyf8pM7mdE4yHxCxN2LlS4dqCaHVhiUx3x3c9Ld6Cq2CkLa3A14gkzYtzF98NY2v6sMwe1kfkAfFxgu2PypfghBJ3t9L6LPNT0cDedvG8k9tqaLFL0dwIjov3DSyYNseNsI91eVmtwEBfUxlOFHtVSpt2TFYDOO/8o0GQ05iAkvuIjiHj+Sg5PjTy95HEQ8nGt5k8N9IRlq8lsuOcgWaepo8ygQ3o+N4mTOO6knPPpAz5X8mCdOLtniGtqFKgawmD8lcnKNEpftBOPG+0tXct2Rp6DbIOBK/C4uqdV8XAlCZfyoG05eqdOLdTuDw8bEnoRRhc3TM9zj+ymmPNXHwFYfxiv2exz04kvmT02cjD8EirpXTWhB25GfVshTA884ftyHKRUZB+dXR0c/H1jIRFekltuVP0QxMjjRlzJabFd+2GpFnn2MZDRdnl8oyF8zkYFfREg998/TdE5tdDLwM6XIg39PCPI6/J0QSaMCEdfb+dBsTeLdCeyG/TAAnnJzfxcw0ZaRTu/f+8VTrkMi0v3wl9Rgbar39x2iA5t/nM5TL26Q1gWe4uL8cZKMowzEofyn8vcgVZagexZru3TqcGNr6TgLyF/v8lSDNXKxccA/cq/0sK1IjEpWnG0Xia+MMP9wmZPBUojgzj3ueznw6wT+gSknU0kJobt2HdR82h1v4eLXP8Hm5AkjIXN8hSPzTyw5GceJyENnDT8olZOZu4g0pN/6JJWTuVC+LGyw8093BJlUH0jpIuLWh63NmEC7nY8sOEmKfaEmwu5iRJOfjmE+7OJkAq0v1q5Qrk2Xr/PU/sHLFqBGIB8+cTKJBYlZYf65LCdJTX9hVXh44c/ALoaPOVDA3KWfjAxyReIGfF7DSV5zPh6RBHPff4xcw47bZOVnn1YOBghyDu3nqvBd+LrJkWYUbOdXq1xWYTVcSODynBR5cIXf2uSHp2nyqHyo275K9Jo2FVwDT00f/d1T4Vm9z0Pi9bA7q3xC5AK1qUGx64Ph2OCHKzueodw/tIvGrskYKNOrw0wYf90sSTTiDQehRUEINDWwIIEnfhhyTX51qssDwJIqhL/Qrukm1FZvhx6o2g9CJS9dsDcDUt9D8mUI8ga1QcY4Ctt/b+Q32Ow3IMCJnZ8uW9GP/uWw+XA+HtqF2KkdwZttn8FI5636Qx4ZTIR/49AfZ/s2TY6MyNuo/DUCI9Hg9fjvC8hs8/fHzAWfCxeRKlz4ixw+NuruGJFDvKDLKlAuc0G5VEbtmKkevmNGpu9gH72q/OUUIw8pRl9U9YdsF2FP+mN0suFvdEiMd2vHw/frLun2S9it/EwhMhbqdjCJ/6ZbjrZa3McKklxE2lwMcK7g9QnqgduO6BZy7cDuEiW6oLFwfPdXnWSODS4M4DU/O4WTC7JWlJ08Y1b5iZycDMnCRAGb/Bt2OTlou8WWR4TaZaI9dRh/uGa89OJ+DIcm4y+cmq53IksQ/+C/un9ixuUbDUcV7poYOYQ0DBcouEwH5VZg2uUkaXeJuyZXJs680f0r/jVlZDKCq90392HdGjyif4kiI899nKjRUon7m05JLs5cfSQz2g8nYeQnMOytZhvv3o5woecfIPVuosY7Iwq8z+BWfPIlmIrtYn3dfSXv+H73/Hy7dh2lv7VxB045fasEiVqsVPzrJsF5I3lPDJ7g5edKUU/0ucsvfl6fg1NKn2qrYV6iOupoNmZ+XCfHZ+N/vnpx2p2a/e7QlvrHP//nf/4P2z5NNQK5AgA="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 000000000..108428c3f --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1383 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/classes/AllowAllTenantGate.html b/classes/AllowAllTenantGate.html new file mode 100644 index 000000000..578dfe433 --- /dev/null +++ b/classes/AllowAllTenantGate.html @@ -0,0 +1,116 @@ +AllowAllTenantGate | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class AllowAllTenantGate

+
+

A tenant gate that treats every DID as a tenant.

+
+
+
+

Hierarchy

+
    +
  • AllowAllTenantGate
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
isTenant +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

isTenant

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      _did: string
    +

    Returns Promise<boolean>

    true if the given DID is a tenant of the DWN; false otherwise

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class Cid

+
+

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

+
+
+
+

Hierarchy

+
    +
  • Cid
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
computeCid +computeDagPbCidFromBytes +computeDagPbCidFromStream +parseCid +
+
+

Constructors

+
+

constructor

+
    + +
  • +

    Returns Cid

+
+

Methods

+
+

Static computeCid

+
    + +
  • +

    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

    +
+
+

Static computeDagPbCidFromBytes

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      content: Uint8Array
    +

    Returns Promise<string>

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

    + +
+
+

Static computeDagPbCidFromStream

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      dataStream: Readable
    +

    Returns Promise<string>

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

    + +
+
+

Static parseCid

+
    + +
  • +

    Parses the given CID string into a {CID}.

    +
    +
    +

    Parameters

    +
      +
    • +
      str: string
    +

    Returns CID<unknown, number, number, Version>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

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 a sublevel and -> represents a key->value pair): + 'data' + + -> + 'references' + + + -> PLACEHOLDER_VALUE

+

This allows for the to be shared for everything that uses the same while also making +sure that the can only be deleted if there are no for any still using it.

+
+
+
+

Hierarchy

+
    +
  • DataStoreLevel
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
blockstore +config +
+
+

Methods

+
associate +clear +close +delete +dump +get +open +put +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

blockstore

+
blockstore: BlockstoreLevel
+
+

config

+
config: DataStoreLevelConfig
+
+

Methods

+
+

associate

+
    + +
  • +

    Associates dataCid of existing data with the given messageCid. +The returned dataCid and returned dataSize will be verified against the given dataCid (and inferred dataSize).

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      +

      The tenant in which the data must exist under for the association to occur.

      +
      +
      • +
    • +
      messageCid: string
      +

      CID of the message that references the data.

      +
      +
      • +
    • +
      dataCid: string
      +

      The CID of the data stored.

      +
      +
    +

    Returns Promise<undefined | AssociateResult>

    if association succeeds. undefined if data to be associated is not found.

    + +
+
+

clear

+
+
+

close

+
+
+

delete

+
    + +
  • +

    Deletes the specified data.

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      messageCid: string
      +

      CID of the message that references the data.

      +
      +
      • +
    • +
      dataCid: string
    +

    Returns Promise<void>

    +
+
+

dump

+
+
+

get

+
    + +
  • +

    Fetches the specified data. +The returned dataCid and returned dataSize will be verified against the given dataCid (and inferred dataSize).

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      messageCid: string
      +

      CID of the message that references the data.

      +
      +
      • +
    • +
      dataCid: string
    +

    Returns Promise<undefined | GetResult>

    +
+
+

open

+
+
+

put

+
    + +
  • +

    Puts the given data in store. +It is expected that the CID of the dataStream matches the given dataCid. +The returned dataCid and returned dataSize will be verified against the given dataCid (and inferred dataSize).

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      messageCid: string
      +

      CID of the message that references the data.

      +
      +
      • +
    • +
      dataCid: string
      • +
    • +
      dataStream: Readable
    +

    Returns Promise<PutResult>

    The CID and size in number of bytes of the data stored.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class DataStream

+
+

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

+
+
+
+

Hierarchy

+
    +
  • DataStream
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
fromBytes +fromObject +toBytes +toObject +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

Static fromBytes

+
    + +
  • +

    Creates a readable stream from the bytes given.

    +
    +
    +

    Parameters

    +
      +
    • +
      bytes: Uint8Array
    +

    Returns Readable

    +
+
+

Static fromObject

+
    + +
  • +

    Creates a readable stream from the object given.

    +
    +
    +

    Parameters

    +
      +
    • +
      object: Record<string, any>
    +

    Returns Readable

    +
+
+

Static toBytes

+
    + +
  • +

    Reads the entire readable stream given into array of bytes.

    +
    +
    +

    Parameters

    +
      +
    • +
      readableStream: Readable
    +

    Returns Promise<Uint8Array>

    +
+
+

Static toObject

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
      +
    • +
      readableStream: Readable
    +

    Returns Promise<object>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/DidIonResolver.html b/classes/DidIonResolver.html new file mode 100644 index 000000000..b2332fa3a --- /dev/null +++ b/classes/DidIonResolver.html @@ -0,0 +1,158 @@ +DidIonResolver | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class DidIonResolver

+
+

Resolver for ION DIDs.

+
+
+
+

Hierarchy

+
    +
  • DidIonResolver
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
dump +method +resolve +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      resolutionEndpoint: string = 'https://discover.did.msidentity.com/1.0/identifiers/'
      +

      optional custom URL to send DID resolution request to

      +
      +
    +

    Returns DidIonResolver

    +
+
+

Methods

+
+

dump

+
+
+

method

+
+
+

resolve

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class DidKeyResolver

+
+

did:key Resolver.

+
    +
  • NOTE: Key support is limited to Ed25519 and SECP256k1.
    • +
  • NOTE: verificationMethod support is limited to JsonWebKey2020
    • +
+

Helpful Resources:

+ +
+
+
+

Hierarchy

+
    +
  • DidKeyResolver
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
dump +method +resolve +generate +getKeyId +getMulticodecSize +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

dump

+
+
+

method

+
+
+

resolve

+
+
+

Static generate

+
    + +
  • +

    Generates a new ed25519 public/private key pair. Creates a DID using the private key.

    +
    +

    Returns Promise<{
        did: string;
    } & KeyMaterial>

    DID and its key material.

    + +
+
+

Static getKeyId

+
    + +
  • +

    Gets the fully qualified key ID of a did:key DID. ie. '#'

    +
    +
    +

    Parameters

    +
      +
    • +
      did: string
    +

    Returns string

    +
+
+

Static getMulticodecSize

+
    + +
  • +

    Gets the number of bytes of the multicodec header in the did:key DID.

    +
    +
    +

    Parameters

    +
      +
    • +
      did: Uint8Array
      +

      A did:key DID

      +
      +
    +

    Returns number

    size of the multicodec head in number of bytes

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/DidResolver.html b/classes/DidResolver.html new file mode 100644 index 000000000..aaefa86af --- /dev/null +++ b/classes/DidResolver.html @@ -0,0 +1,140 @@ +DidResolver | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class DidResolver

+
+

A DID resolver that by default supports did:key and did:ion DIDs.

+
+
+
+

Hierarchy

+
    +
  • DidResolver
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
dump +resolve +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

dump

+
+
+

resolve

+
    + +
  • +

    attempt to resolve the DID provided

    +
    +
    +

    Parameters

    +
      +
    • +
      did: string
      +

      the DID to resolve

      +
      +
    +

    Returns Promise<DidResolutionResult>

    +
    +

    Throws

    if DID is invalid

    + +

    Throws

    if DID method is not supported

    + +

    Throws

    if resolving DID fails

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class Dwn

+
+

Hierarchy

+
    +
  • Dwn
+
+
+
+ +
+
+

Methods

+
close +handleMessagesGet +handleRecordsQuery +handleRecordsRead +handleRecordsWrite +processMessage +synchronizePrunedInitialRecordsWrite +validateMessageIntegrity +validateTenant +create +
+
+

Methods

+
+

close

+
    + +
  • +

    Returns Promise<void>

+
+

handleMessagesGet

+
+
+

handleRecordsQuery

+
+
+

handleRecordsRead

+
    + +
  • +

    Handles a RecordsRead message.

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      message: RecordsReadMessage
    +

    Returns Promise<RecordsReadReply>

    +
+
+

handleRecordsWrite

+
    + +
  • +

    Handles a RecordsWrite message.

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      message: RecordsWriteMessage
      • +
    • +
      Optional dataStream: Readable
      • +
    • +
      Optional options: RecordsWriteHandlerOptions
    +

    Returns Promise<GenericMessageReply>

    +
+
+

processMessage

+
+
+

synchronizePrunedInitialRecordsWrite

+
    + +
  • +

    Privileged method for writing a pruned initial RecordsWrite to a DWN without needing to supply associated data.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<GenericMessageReply>

    +
+
+

validateMessageIntegrity

+
    + +
  • +

    Validates structure of DWN message

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<undefined | GenericMessageReply>

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

    + +
+
+

validateTenant

+
    + +
  • +

    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.

    + +
+
+

Static create

+
    + +
  • +

    Creates an instance of the DWN.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Dwn>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class DwnConstant

+
+

Hierarchy

+
    +
  • DwnConstant
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
maxDataSizeAllowedToBeEncoded +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Static Readonly maxDataSizeAllowedToBeEncoded

+
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

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

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

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/Encoder.html b/classes/Encoder.html new file mode 100644 index 000000000..9e15bba5b --- /dev/null +++ b/classes/Encoder.html @@ -0,0 +1,214 @@ +Encoder | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class Encoder

+
+

Utility class for encoding/converting data into various formats.

+
+
+
+

Hierarchy

+
    +
  • Encoder
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

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

Constructors

+
+

constructor

+
+
+

Methods

+
+

Static base64UrlToBytes

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      base64urlString: string
    +

    Returns Uint8Array

+
+

Static base64UrlToObject

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      base64urlString: string
    +

    Returns any

+
+

Static bytesToBase64Url

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      bytes: Uint8Array
    +

    Returns string

+
+

Static bytesToObject

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      content: Uint8Array
    +

    Returns object

+
+

Static bytesToString

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      content: Uint8Array
    +

    Returns string

+
+

Static objectToBytes

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      obj: Record<string, any>
    +

    Returns Uint8Array

+
+

Static stringToBase64Url

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      content: string
    +

    Returns string

+
+

Static stringToBytes

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      content: string
    +

    Returns Uint8Array

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class Encryption

+
+

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

+
+
+
+

Hierarchy

+
    +
  • Encryption
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
aes256CtrDecrypt +aes256CtrEncrypt +eciesSecp256k1Decrypt +eciesSecp256k1Encrypt +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

Static aes256CtrDecrypt

+
    + +
  • +

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

    +
    +
    +

    Parameters

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

    Returns Promise<Readable>

    +
+
+

Static aes256CtrEncrypt

+
    + +
  • +

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

    +
    +
    +

    Parameters

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

    Returns Promise<Readable>

    +
+
+

Static eciesSecp256k1Decrypt

+
    + +
  • +

    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>

    +
+
+

Static eciesSecp256k1Encrypt

+
    + +
  • +

    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

    +
      +
    • +
      uncompressedPublicKey: Uint8Array
      • +
    • +
      plaintext: Uint8Array
    +

    Returns Promise<EciesEncryptionOutput>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class EventLogLevel

+
+

Hierarchy

+
    +
  • EventLogLevel
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
config +db +ulidFactory +
+
+

Methods

+
append +clear +close +deleteEventsByCid +dump +getEvents +open +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

config

+
config: EventLogLevelConfig
+
+

db

+
db: LevelWrapper<string>
+
+

ulidFactory

+
ulidFactory: ULIDFactory
+
+

Methods

+
+

append

+
    + +
  • +

    adds an event to a tenant's event log

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      +

      the tenant's DID

      +
      +
      • +
    • +
      messageCid: string
      +

      the CID of the message

      +
      +
    +

    Returns Promise<string>

    watermark

    + +
+
+

clear

+
+
+

close

+
+
+

deleteEventsByCid

+
    + +
  • +

    deletes any events that have any of the cids provided

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      cids: string[]
    +

    Returns Promise<number>

    the number of events deleted

    + +
+
+

dump

+
+
+

getEvents

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Event[]>

    +
+
+

open

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/EventsGet.html b/classes/EventsGet.html new file mode 100644 index 000000000..3a49c8762 --- /dev/null +++ b/classes/EventsGet.html @@ -0,0 +1,417 @@ +EventsGet | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class EventsGet

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
toJSON +compareCid +compareMessageTimestamp +create +createAuthorizationAsAuthor +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +parse +validateJsonSchema +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: undefined | string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: EventsGetMessage
+
+

Methods

+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static create

+
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
+
+

Static isOlder

+
+
+

Static parse

+
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class HdKey

+
+

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

+
+
+
+

Hierarchy

+
    +
  • HdKey
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
derivePrivateKey +derivePublicKey +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

Static derivePrivateKey

+
+
+

Static derivePublicKey

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<PublicJwk>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/Jws.html b/classes/Jws.html new file mode 100644 index 000000000..5b4b45216 --- /dev/null +++ b/classes/Jws.html @@ -0,0 +1,225 @@ +Jws | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class Jws

+
+

Utility class for JWS related operations.

+
+
+
+

Hierarchy

+
    +
  • Jws
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

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

Constructors

+
+

constructor

+
    + +
  • +

    Returns Jws

+
+

Methods

+
+

Static createSigner

+
+
+

Static createSigners

+
+
+

Static decodePlainObjectPayload

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
      +
    • +
      jws: GeneralJws
    +

    Returns any

    +
+
+

Static extractDid

+
    + +
  • +

    Extracts the DID from the given kid string.

    +
    +
    +

    Parameters

    +
      +
    • +
      kid: string
    +

    Returns string

    +
+
+

Static getKid

+
    + +
  • +

    Gets the kid from a general JWS signature entry.

    +
    +
    +

    Parameters

    +
      +
    • +
      signatureEntry: SignatureEntry
    +

    Returns string

    +
+
+

Static getSignerDid

+
    + +
  • +

    Gets the signer DID from a general JWS signature entry.

    +
    +
    +

    Parameters

    +
      +
    • +
      signatureEntry: SignatureEntry
    +

    Returns string

    +
+
+

Static verifySignature

+
    + +
  • +

    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

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class Message<M>Abstract

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
toJSON +compareCid +compareMessageTimestamp +createAuthorizationAsAuthor +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +validateJsonSchema +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: undefined | string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: M
+
+

Methods

+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
    + +
  • +

    Gets the CID of the given message.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<string>

    +
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
    + +
  • +

    Checks if first message is newer than second message.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<boolean>

    true if a is newer than b; false otherwise

    + +
+
+

Static isOlder

+
    + +
  • +

    Checks if first message is older than second message.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<boolean>

    true if a is older than b; false otherwise

    + +
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/MessageStoreLevel.html b/classes/MessageStoreLevel.html new file mode 100644 index 000000000..8885f4440 --- /dev/null +++ b/classes/MessageStoreLevel.html @@ -0,0 +1,351 @@ +MessageStoreLevel | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class MessageStoreLevel

+
+

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

+
+
+
+

Hierarchy

+
    +
  • MessageStoreLevel
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
blockstore +config +index +
+
+

Methods

+
clear +close +delete +dump +get +open +put +query +lexicographicalCompare +sortMessages +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

blockstore

+
blockstore: BlockstoreLevel
+
+

config

+
config: MessageStoreLevelConfig
+
+

index

+
index: IndexLevel
+
+

Methods

+
+

clear

+
+
+

close

+
+
+

delete

+
+
+

dump

+
+
+

get

+
+
+

open

+
+
+

put

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      message: GenericMessage
      • +
    • +
      indexes: {
          [key: string]: string | boolean;
      }
      +

      indexes (key-value pairs) to be included as part of this put operation

      +
      +
      +
        +
      • +
        [key: string]: string | boolean
      • +
    • +
      Optional options: MessageStoreOptions
    +

    Returns Promise<void>

    +
+
+

query

+
    + +
  • +

    Queries the underlying store for messages that matches the provided filters. +Supplying multiple filters establishes an OR condition between the filters.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<{
        messages: GenericMessage[];
        paginationMessageCid?: string;
    }>

    +
+
+

Static lexicographicalCompare

+
    + +
  • +

    Compares the chosen property of two messages in lexicographical order. +When the value is the same between the two objects, messageCid comparison is used to tiebreak. +tiebreaker always compares messageA to messageB

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<number>

    if SortOrder is Ascending: + 1 if the chosen property of messageA is larger than of messageB; + -1 if the chosen property messageA is smaller/older than of messageB; + 0 otherwise + if SortOrder is Descending: + 1 if the chosen property of messageB is larger than of messageA; + -1 if the chosen property messageB is smaller/older than of messageA; + 0 otherwise

    + +
+
+

Static sortMessages

+
    + +
  • +

    This is a temporary naive sort, it will eventually be done within the underlying data store.

    +

    If sorting is based on date published, records that are not published are filtered out.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<GenericMessage[]>

    Sorted Messages

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/MessagesGet.html b/classes/MessagesGet.html new file mode 100644 index 000000000..47de712d8 --- /dev/null +++ b/classes/MessagesGet.html @@ -0,0 +1,417 @@ +MessagesGet | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class MessagesGet

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
toJSON +compareCid +compareMessageTimestamp +create +createAuthorizationAsAuthor +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +parse +validateJsonSchema +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: undefined | string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: MessagesGetMessage
+
+

Methods

+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static create

+
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
+
+

Static isOlder

+
+
+

Static parse

+
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/PermissionsGrant.html b/classes/PermissionsGrant.html new file mode 100644 index 000000000..3dd5e1aa7 --- /dev/null +++ b/classes/PermissionsGrant.html @@ -0,0 +1,475 @@ +PermissionsGrant | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class PermissionsGrant

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
authorize +toJSON +compareCid +compareMessageTimestamp +create +createAuthorizationAsAuthor +createFromPermissionsRequest +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +parse +validateJsonSchema +validateScope +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: undefined | string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: PermissionsGrantMessage
+
+

Methods

+
+

authorize

+
+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static create

+
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createFromPermissionsRequest

+
    + +
  • +

    generates a PermissionsGrant using the provided PermissionsRequest

    +
    +
    +

    Parameters

    +
      +
    • +
      permissionsRequest: PermissionsRequest
      +
      • +
    • +
      authorizationSigner: Signer
      +

      the private key and additional signature material of the grantor

      +
      +
      • +
    • +
      overrides: CreateFromPermissionsRequestOverrides
      +

      overrides that will be used instead of the properties in permissionsRequest

      +
      +
    +

    Returns Promise<PermissionsGrant>

    +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
+
+

Static isOlder

+
+
+

Static parse

+
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+

Static validateScope

+
    + +
  • +

    Validates scope structure for properties beyond interface and method. +Currently only grants for RecordsRead and RecordsWrite have such properties and need validation beyond JSON Schema.

    +
    +
    +

    Parameters

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/PermissionsRequest.html b/classes/PermissionsRequest.html new file mode 100644 index 000000000..592bc9aab --- /dev/null +++ b/classes/PermissionsRequest.html @@ -0,0 +1,417 @@ +PermissionsRequest | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class PermissionsRequest

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
toJSON +compareCid +compareMessageTimestamp +create +createAuthorizationAsAuthor +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +parse +validateJsonSchema +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: undefined | string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: PermissionsRequestMessage
+
+

Methods

+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static create

+
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
+
+

Static isOlder

+
+
+

Static parse

+
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/PermissionsRevoke.html b/classes/PermissionsRevoke.html new file mode 100644 index 000000000..ead415297 --- /dev/null +++ b/classes/PermissionsRevoke.html @@ -0,0 +1,432 @@ +PermissionsRevoke | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class PermissionsRevoke

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
authorize +toJSON +compareCid +compareMessageTimestamp +create +createAuthorizationAsAuthor +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +parse +validateJsonSchema +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: undefined | string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: PermissionsRevokeMessage
+
+

Methods

+
+

authorize

+
+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static create

+
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
+
+

Static isOlder

+
+
+

Static parse

+
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class PrivateKeySigner

+
+

A signer that signs using a private key.

+
+
+
+

Hierarchy

+
    +
  • PrivateKeySigner
+
+

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

+
    + +
  • +

    Signs the given content and returns the signature as bytes.

    +
    +
    +

    Parameters

    +
      +
    • +
      content: Uint8Array
    +

    Returns Promise<Uint8Array>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class Protocols

+
+

Class containing Protocol related utility methods.

+
+
+
+

Hierarchy

+
    +
  • Protocols
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
deriveAndInjectPublicEncryptionKeys +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

Static deriveAndInjectPublicEncryptionKeys

+
    + +
  • +

    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

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class ProtocolsConfigure

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
toJSON +compareCid +compareMessageTimestamp +create +createAuthorizationAsAuthor +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +parse +validateJsonSchema +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: ProtocolsConfigureMessage
+
+

Methods

+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static create

+
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
+
+

Static isOlder

+
+
+

Static parse

+
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class ProtocolsQuery

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
authorize +toJSON +compareCid +compareMessageTimestamp +create +createAuthorizationAsAuthor +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +parse +validateJsonSchema +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: undefined | string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: ProtocolsQueryMessage
+
+

Methods

+
+

authorize

+
+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static create

+
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
+
+

Static isOlder

+
+
+

Static parse

+
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class Records

+
+

Class containing useful utilities related to the Records interface.

+
+
+
+

Hierarchy

+
    +
  • Records
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
constructKeyDerivationPath +constructKeyDerivationPathUsingDataFormatsScheme +constructKeyDerivationPathUsingProtocolContextScheme +constructKeyDerivationPathUsingProtocolPathScheme +constructKeyDerivationPathUsingSchemasScheme +convertFilter +decrypt +derivePrivateKey +normalizeFilter +validateAncestorKeyAndDescentKeyDerivationPathsMatch +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

Static constructKeyDerivationPath

+
    + +
  • +

    Constructs full key derivation path using the specified scheme.

    +
    +
    +

    Parameters

    +
    +

    Returns string[]

    +
+
+

Static constructKeyDerivationPathUsingDataFormatsScheme

+
    + +
  • +

    Constructs the full key derivation path using dataFormats scheme.

    +
    +
    +

    Parameters

    +
      +
    • +
      schema: undefined | string
      • +
    • +
      dataFormat: string
    +

    Returns string[]

    +
+
+

Static constructKeyDerivationPathUsingProtocolContextScheme

+
    + +
  • +

    Constructs the full key derivation path using protocolContext scheme.

    +
    +
    +

    Parameters

    +
      +
    • +
      contextId: undefined | string
    +

    Returns string[]

    +
+
+

Static constructKeyDerivationPathUsingProtocolPathScheme

+
    + +
  • +

    Constructs the full key derivation path using protocolPath scheme.

    +
    +
    +

    Parameters

    +
    +

    Returns string[]

    +
+
+

Static constructKeyDerivationPathUsingSchemasScheme

+
    + +
  • +

    Constructs the full key derivation path using schemas scheme.

    +
    +
    +

    Parameters

    +
      +
    • +
      schema: undefined | string
    +

    Returns string[]

    +
+
+

Static convertFilter

+
    + +
  • +

    Converts an incoming RecordsFilter into a Filter usable by MessageStore.

    +
    +
    +

    Parameters

    +
      +
    • +
      filter: RecordsFilter
      +

      A RecordsFilter

      +
      +
    +

    Returns Filter

    a generic Filter able to be used with MessageStore.

    + +
+
+

Static decrypt

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Readable>

    +
+
+

Static derivePrivateKey

+
    + +
  • +

    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>

    +
+
+

Static normalizeFilter

+
    + +
  • +

    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.

    + +
+
+

Static validateAncestorKeyAndDescentKeyDerivationPathsMatch

+
    + +
  • +

    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.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class RecordsDelete

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
authorize +toJSON +compareCid +compareMessageTimestamp +create +createAuthorizationAsAuthor +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +parse +validateJsonSchema +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: undefined | string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: RecordsDeleteMessage
+
+

Methods

+
+

authorize

+
+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static create

+
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
+
+

Static isOlder

+
+
+

Static parse

+
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class RecordsQuery

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
toJSON +compareCid +compareMessageTimestamp +create +createAuthorizationAsAuthor +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +parse +validateJsonSchema +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: undefined | string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: RecordsQueryMessage
+
+

Methods

+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static create

+
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
+
+

Static isOlder

+
+
+

Static parse

+
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/RecordsRead.html b/classes/RecordsRead.html new file mode 100644 index 000000000..82cef0ebe --- /dev/null +++ b/classes/RecordsRead.html @@ -0,0 +1,441 @@ +RecordsRead | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class RecordsRead

+
+

Hierarchy

+
    +
  • Message<RecordsReadMessage> +
      +
    • RecordsRead
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
author +authorSignaturePayload +message +
+
+

Methods

+
authorize +toJSON +compareCid +compareMessageTimestamp +create +createAuthorizationAsAuthor +createSignature +getAuthor +getCid +getNewestMessage +getOldestMessage +isNewer +isOlder +parse +validateJsonSchema +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly author

+
author: undefined | string
+
+

Readonly authorSignaturePayload

+
authorSignaturePayload: undefined | GenericSignaturePayload
+
+

Readonly message

+
message: RecordsReadMessage
+
+

Methods

+
+

authorize

+
+
+

toJSON

+
+
+

Static compareCid

+
    + +
  • +

    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)

    + +
+
+

Static compareMessageTimestamp

+
    + +
  • +

    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)

    + +
+
+

Static create

+
+
+

Static createAuthorizationAsAuthor

+
    + +
  • +

    Creates the authorization as the author to be used in a DWN message.

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      +

      Signer as the author

      +
      +
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    + +
+
+

Static createSignature

+
    + +
  • +

    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.createAuthorSignature() wth this method

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptor: Descriptor
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalPayloadProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static getAuthor

+
    + +
  • +

    Gets the DID of the author of the given message, returned undefined if message is not signed.

    +
    +
    +

    Parameters

    +
    +

    Returns undefined | string

    +
+
+

Static getCid

+
+
+

Static getNewestMessage

+
+
+

Static getOldestMessage

+
+
+

Static isNewer

+
+
+

Static isOlder

+
+
+

Static parse

+
+
+

Static validateJsonSchema

+
    + +
  • +

    Validates the given message against the corresponding JSON schema.

    +
    +
    +

    Parameters

    +
      +
    • +
      rawMessage: any
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Class RecordsWrite

+
+

Hierarchy

+
    +
  • RecordsWrite
+
+
+
+ +
+
+

Properties

+
attesters +
+
+

Accessors

+
author +authorSignaturePayload +message +owner +ownerSignaturePayload +
+
+

Methods

+
authorize +encryptSymmetricEncryptionKey +getEntryId +isInitialWrite +sign +signAsOwner +toJSON +create +createAttestation +createAuthorSignature +createFrom +getAttesters +getEntryId +getInitialWrite +isInitialWrite +parse +verifyEqualityOfImmutableProperties +
+
+

Properties

+
+

Readonly attesters

+
attesters: string[]
+
+

Accessors

+
+

author

+
+
+

authorSignaturePayload

+
    +
  • get authorSignaturePayload(): undefined | RecordsWriteSignaturePayload
    • +
  • +

    Decoded author signature payload.

    +
    +

    Returns undefined | RecordsWriteSignaturePayload

    +
+
+

message

+
+
+

owner

+
+
+

ownerSignaturePayload

+
    +
  • get ownerSignaturePayload(): undefined | GenericSignaturePayload
    • +
  • +

    Decoded owner signature payload.

    +
    +

    Returns undefined | GenericSignaturePayload

    +
+
+

Methods

+
+

authorize

+
+
+

encryptSymmetricEncryptionKey

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+

getEntryId

+
    + +
  • +

    Computes the deterministic Entry ID of this message.

    +
    +

    Returns Promise<string>

    +
+
+

isInitialWrite

+
    + +
  • +

    Checks if the given message is the initial entry of a record.

    +
    +

    Returns Promise<boolean>

    +
+
+

sign

+
    + +
  • +

    Signs the RecordsWrite as the author.

    +
    +
    +

    Parameters

    +
      +
    • +
      signer: Signer
      • +
    • +
      Optional options: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<void>

    +
+
+

signAsOwner

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
      +
    • +
      signer: Signer
      • +
    • +
      Optional permissionsGrantId: string
    +

    Returns Promise<void>

    +
+
+

toJSON

+
+
+

Static create

+
+
+

Static createAttestation

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
      +
    • +
      descriptorCid: string
      • +
    • +
      Optional signers: Signer[]
    +

    Returns Promise<undefined | GeneralJws>

    +
+
+

Static createAuthorSignature

+
    + +
  • +

    Creates the authorization property of a RecordsWrite message.

    +
    +
    +

    Parameters

    +
      +
    • +
      recordId: string
      • +
    • +
      contextId: undefined | string
      • +
    • +
      descriptorCid: string
      • +
    • +
      attestation: undefined | GeneralJws
      • +
    • +
      encryption: undefined | EncryptionProperty
      • +
    • +
      signer: Signer
      • +
    • +
      Optional additionalProperties: {
          permissionsGrantId?: string;
          protocolRole?: string;
      }
      +
        +
      • +
        Optional permissionsGrantId?: string
        • +
      • +
        Optional protocolRole?: string
    +

    Returns Promise<GeneralJws>

    +
+
+

Static createFrom

+
    + +
  • +

    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>

    +
+
+

Static getAttesters

+
    + +
  • +

    Gets the DID of the author of the given message.

    +
    +
    +

    Parameters

    +
      +
    • +
      message: InternalRecordsWriteMessage
    +

    Returns string[]

    +
+
+

Static getEntryId

+
+
+

Static getInitialWrite

+
+
+

Static isInitialWrite

+
    + +
  • +

    Checks if the given message is the initial entry of a record.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<boolean>

    +
+
+

Static parse

+
+
+

Static verifyEqualityOfImmutableProperties

+
    + +
  • +

    Verifies that immutable properties of the two given messages are identical.

    +
    +
    +

    Parameters

    +
    +

    Returns boolean

    +
    +

    Throws

    if immutable properties between two RecordsWrite message

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/classes/Secp256k1.html b/classes/Secp256k1.html new file mode 100644 index 000000000..9ea2ff754 --- /dev/null +++ b/classes/Secp256k1.html @@ -0,0 +1,352 @@ +Secp256k1 | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Class Secp256k1

+
+

Class containing SECP256K1 related utility methods.

+
+
+
+

Hierarchy

+
    +
  • Secp256k1
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

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

Constructors

+
+

constructor

+
+
+

Methods

+
+

Static deriveChildPrivateKey

+
    + +
  • +

    Derives a child private key using the given derivation path segment.

    +
    +
    +

    Parameters

    +
      +
    • +
      privateKey: Uint8Array
      • +
    • +
      derivationPathSegment: Uint8Array
    +

    Returns Promise<Uint8Array>

    +
+
+

Static derivePrivateKey

+
    + +
  • +

    Derives a hardened hierarchical deterministic private key.

    +
    +
    +

    Parameters

    +
      +
    • +
      privateKey: Uint8Array
      • +
    • +
      relativePath: string[]
    +

    Returns Promise<Uint8Array>

    +
+
+

Static derivePublicKey

+
    + +
  • +

    Derives a hardened hierarchical deterministic public key.

    +
    +
    +

    Parameters

    +
      +
    • +
      privateKey: Uint8Array
      • +
    • +
      relativePath: string[]
    +

    Returns Promise<Uint8Array>

    uncompressed public key

    + +
+
+

Static generateKeyPair

+
+
+

Static generateKeyPairRaw

+
    + +
  • +

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

    +
    +

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

    +
+
+

Static getPublicJwk

+
+
+

Static getPublicKey

+
    + +
  • +

    Gets the uncompressed public key of the given private key.

    +
    +
    +

    Parameters

    +
      +
    • +
      privateKey: Uint8Array
    +

    Returns Promise<Uint8Array>

    +
+
+

Static privateJwkToBytes

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
    +

    Returns Uint8Array

    +
+
+

Static privateKeyToJwk

+
    + +
  • +

    Converts a private key in bytes into a JWK.

    +
    +
    +

    Parameters

    +
      +
    • +
      privateKeyBytes: Uint8Array
    +

    Returns Promise<PrivateJwk>

    +
+
+

Static publicJwkToBytes

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
    +

    Returns Uint8Array

    +
+
+

Static publicKeyToJwk

+
    + +
  • +

    Converts a public key in bytes into a JWK.

    +
    +
    +

    Parameters

    +
      +
    • +
      publicKeyBytes: Uint8Array
    +

    Returns Promise<PublicJwk>

    +
+
+

Static sign

+
    + +
  • +

    Signs the provided content using the provided JWK.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Uint8Array>

    +
+
+

Static validateKey

+
    + +
  • +

    Validates the given JWK is a SECP256K1 key.

    +
    +
    +

    Parameters

    +
    +

    Returns void

    +
    +

    Throws

    if fails validation.

    +
+
+

Static verify

+
    + +
  • +

    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

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

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

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Enumeration DwnErrorCode

+
+

DWN SDK error codes.

+
+
+
+
+
+ +
+
+

Enumeration Members

+
AuthenticateJwsMissing +AuthorizationUnknownAuthor +DidMethodNotSupported +DidNotString +DidNotValid +DidResolutionFailed +GeneralJwsVerifierInvalidSignature +GrantAuthorizationGrantExpired +GrantAuthorizationGrantMissing +GrantAuthorizationGrantNotYetActive +GrantAuthorizationGrantRevoked +GrantAuthorizationInterfaceMismatch +GrantAuthorizationMethodMismatch +GrantAuthorizationNotGrantedForTenant +GrantAuthorizationNotGrantedToAuthor +HdKeyDerivationPathInvalid +PermissionsGrantGrantedByMismatch +PermissionsGrantScopeContextIdAndProtocolPath +PermissionsGrantScopeSchemaProhibitedFields +PermissionsGrantUnauthorizedGrant +PermissionsRevokeMissingPermissionsGrant +PermissionsRevokeUnauthorizedRevoke +PrivateKeySignerUnableToDeduceAlgorithm +PrivateKeySignerUnableToDeduceKeyId +PrivateKeySignerUnsupportedCurve +ProtocolAuthorizationActionNotAllowed +ProtocolAuthorizationDuplicateContextRoleRecipient +ProtocolAuthorizationDuplicateGlobalRoleRecipient +ProtocolAuthorizationIncorrectDataFormat +ProtocolAuthorizationIncorrectProtocolPath +ProtocolAuthorizationInvalidSchema +ProtocolAuthorizationInvalidType +ProtocolAuthorizationMissingRole +ProtocolAuthorizationMissingRuleSet +ProtocolAuthorizationNotARole +ProtocolAuthorizationParentlessIncorrectProtocolPath +ProtocolAuthorizationRoleMissingRecipient +ProtocolsConfigureContextRoleAtProhibitedProtocolPath +ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath +ProtocolsConfigureInvalidActionMissingOf +ProtocolsConfigureInvalidActionOfNotAllowed +ProtocolsConfigureInvalidRole +ProtocolsConfigureUnauthorized +ProtocolsQueryUnauthorized +RecordsDecryptNoMatchingKeyEncryptedFound +RecordsDerivePrivateKeyUnSupportedCurve +RecordsGrantAuthorizationConditionPublicationProhibited +RecordsGrantAuthorizationConditionPublicationRequired +RecordsGrantAuthorizationScopeContextIdMismatch +RecordsGrantAuthorizationScopeNotProtocol +RecordsGrantAuthorizationScopeProtocolMismatch +RecordsGrantAuthorizationScopeProtocolPathMismatch +RecordsGrantAuthorizationScopeSchema +RecordsInvalidAncestorKeyDerivationSegment +RecordsProtocolContextDerivationSchemeMissingContextId +RecordsProtocolPathDerivationSchemeMissingProtocol +RecordsReadReturnedMultiple +RecordsSchemasDerivationSchemeMissingSchema +RecordsWriteDataCidMismatch +RecordsWriteDataSizeMismatch +RecordsWriteGetEntryIdUndefinedAuthor +RecordsWriteMissingAuthorizationSigner +RecordsWriteMissingDataAssociation +RecordsWriteMissingDataInPrevious +RecordsWriteMissingDataStream +RecordsWriteMissingProtocol +RecordsWriteMissingSchema +RecordsWriteOwnerAndTenantMismatch +RecordsWriteSignAsOwnerUnknownAuthor +RecordsWriteValidateIntegrityEncryptionCidMismatch +Secp256k1KeyNotValid +UrlProtocolNotNormalizable +UrlProtocolNotNormalized +UrlSchemaNotNormalizable +UrlSchemaNotNormalized +
+
+

Enumeration Members

+
+

AuthenticateJwsMissing

+
AuthenticateJwsMissing: "AuthenticateJwsMissing"
+
+

AuthorizationUnknownAuthor

+
AuthorizationUnknownAuthor: "AuthorizationUnknownAuthor"
+
+

DidMethodNotSupported

+
DidMethodNotSupported: "DidMethodNotSupported"
+
+

DidNotString

+
DidNotString: "DidNotString"
+
+

DidNotValid

+
DidNotValid: "DidNotValid"
+
+

DidResolutionFailed

+
DidResolutionFailed: "DidResolutionFailed"
+
+

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

PermissionsGrantGrantedByMismatch

+
PermissionsGrantGrantedByMismatch: "PermissionsGrantGrantedByMismatch"
+
+

PermissionsGrantScopeContextIdAndProtocolPath

+
PermissionsGrantScopeContextIdAndProtocolPath: "PermissionsGrantScopeContextIdAndProtocolPath"
+
+

PermissionsGrantScopeSchemaProhibitedFields

+
PermissionsGrantScopeSchemaProhibitedFields: "PermissionsGrantScopeSchemaProhibitedFields"
+
+

PermissionsGrantUnauthorizedGrant

+
PermissionsGrantUnauthorizedGrant: "PermissionsGrantUnauthorizedGrant"
+
+

PermissionsRevokeMissingPermissionsGrant

+
PermissionsRevokeMissingPermissionsGrant: "PermissionsRevokeMissingPermissionsGrant"
+
+

PermissionsRevokeUnauthorizedRevoke

+
PermissionsRevokeUnauthorizedRevoke: "PermissionsRevokeUnauthorizedRevoke"
+
+

PrivateKeySignerUnableToDeduceAlgorithm

+
PrivateKeySignerUnableToDeduceAlgorithm: "PrivateKeySignerUnableToDeduceAlgorithm"
+
+

PrivateKeySignerUnableToDeduceKeyId

+
PrivateKeySignerUnableToDeduceKeyId: "PrivateKeySignerUnableToDeduceKeyId"
+
+

PrivateKeySignerUnsupportedCurve

+
PrivateKeySignerUnsupportedCurve: "PrivateKeySignerUnsupportedCurve"
+
+

ProtocolAuthorizationActionNotAllowed

+
ProtocolAuthorizationActionNotAllowed: "ProtocolAuthorizationActionNotAllowed"
+
+

ProtocolAuthorizationDuplicateContextRoleRecipient

+
ProtocolAuthorizationDuplicateContextRoleRecipient: "ProtocolAuthorizationDuplicateContextRoleRecipient"
+
+

ProtocolAuthorizationDuplicateGlobalRoleRecipient

+
ProtocolAuthorizationDuplicateGlobalRoleRecipient: "ProtocolAuthorizationDuplicateGlobalRoleRecipient"
+
+

ProtocolAuthorizationIncorrectDataFormat

+
ProtocolAuthorizationIncorrectDataFormat: "ProtocolAuthorizationIncorrectDataFormat"
+
+

ProtocolAuthorizationIncorrectProtocolPath

+
ProtocolAuthorizationIncorrectProtocolPath: "ProtocolAuthorizationIncorrectProtocolPath"
+
+

ProtocolAuthorizationInvalidSchema

+
ProtocolAuthorizationInvalidSchema: "ProtocolAuthorizationInvalidSchema"
+
+

ProtocolAuthorizationInvalidType

+
ProtocolAuthorizationInvalidType: "ProtocolAuthorizationInvalidType"
+
+

ProtocolAuthorizationMissingRole

+
ProtocolAuthorizationMissingRole: "ProtocolAuthorizationMissingRole"
+
+

ProtocolAuthorizationMissingRuleSet

+
ProtocolAuthorizationMissingRuleSet: "ProtocolAuthorizationMissingRuleSet"
+
+

ProtocolAuthorizationNotARole

+
ProtocolAuthorizationNotARole: "ProtocolAuthorizationNotARole"
+
+

ProtocolAuthorizationParentlessIncorrectProtocolPath

+
ProtocolAuthorizationParentlessIncorrectProtocolPath: "ProtocolAuthorizationParentlessIncorrectProtocolPath"
+
+

ProtocolAuthorizationRoleMissingRecipient

+
ProtocolAuthorizationRoleMissingRecipient: "ProtocolAuthorizationRoleMissingRecipient"
+
+

ProtocolsConfigureContextRoleAtProhibitedProtocolPath

+
ProtocolsConfigureContextRoleAtProhibitedProtocolPath: "ProtocolsConfigureContextRoleAtProhibitedProtocolPath"
+
+

ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath

+
ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath: "ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath"
+
+

ProtocolsConfigureInvalidActionMissingOf

+
ProtocolsConfigureInvalidActionMissingOf: "ProtocolsConfigureInvalidActionMissingOf"
+
+

ProtocolsConfigureInvalidActionOfNotAllowed

+
ProtocolsConfigureInvalidActionOfNotAllowed: "ProtocolsConfigureInvalidActionOfNotAllowed"
+
+

ProtocolsConfigureInvalidRole

+
ProtocolsConfigureInvalidRole: "ProtocolsConfigureInvalidRole"
+
+

ProtocolsConfigureUnauthorized

+
ProtocolsConfigureUnauthorized: "ProtocolsConfigureUnauthorized"
+
+

ProtocolsQueryUnauthorized

+
ProtocolsQueryUnauthorized: "ProtocolsQueryUnauthorized"
+
+

RecordsDecryptNoMatchingKeyEncryptedFound

+
RecordsDecryptNoMatchingKeyEncryptedFound: "RecordsDecryptNoMatchingKeyEncryptedFound"
+
+

RecordsDerivePrivateKeyUnSupportedCurve

+
RecordsDerivePrivateKeyUnSupportedCurve: "RecordsDerivePrivateKeyUnSupportedCurve"
+
+

RecordsGrantAuthorizationConditionPublicationProhibited

+
RecordsGrantAuthorizationConditionPublicationProhibited: "RecordsGrantAuthorizationConditionPublicationProhibited"
+
+

RecordsGrantAuthorizationConditionPublicationRequired

+
RecordsGrantAuthorizationConditionPublicationRequired: "RecordsGrantAuthorizationConditionPublicationRequired"
+
+

RecordsGrantAuthorizationScopeContextIdMismatch

+
RecordsGrantAuthorizationScopeContextIdMismatch: "RecordsGrantAuthorizationScopeContextIdMismatch"
+
+

RecordsGrantAuthorizationScopeNotProtocol

+
RecordsGrantAuthorizationScopeNotProtocol: "RecordsGrantAuthorizationScopeNotProtocol"
+
+

RecordsGrantAuthorizationScopeProtocolMismatch

+
RecordsGrantAuthorizationScopeProtocolMismatch: "RecordsGrantAuthorizationScopeProtocolMismatch"
+
+

RecordsGrantAuthorizationScopeProtocolPathMismatch

+
RecordsGrantAuthorizationScopeProtocolPathMismatch: "RecordsGrantAuthorizationScopeProtocolPathMismatch"
+
+

RecordsGrantAuthorizationScopeSchema

+
RecordsGrantAuthorizationScopeSchema: "RecordsGrantAuthorizationScopeSchema"
+
+

RecordsInvalidAncestorKeyDerivationSegment

+
RecordsInvalidAncestorKeyDerivationSegment: "RecordsInvalidAncestorKeyDerivationSegment"
+
+

RecordsProtocolContextDerivationSchemeMissingContextId

+
RecordsProtocolContextDerivationSchemeMissingContextId: "RecordsProtocolContextDerivationSchemeMissingContextId"
+
+

RecordsProtocolPathDerivationSchemeMissingProtocol

+
RecordsProtocolPathDerivationSchemeMissingProtocol: "RecordsProtocolPathDerivationSchemeMissingProtocol"
+
+

RecordsReadReturnedMultiple

+
RecordsReadReturnedMultiple: "RecordsReadReturnedMultiple"
+
+

RecordsSchemasDerivationSchemeMissingSchema

+
RecordsSchemasDerivationSchemeMissingSchema: "RecordsSchemasDerivationSchemeMissingSchema"
+
+

RecordsWriteDataCidMismatch

+
RecordsWriteDataCidMismatch: "RecordsWriteDataCidMismatch"
+
+

RecordsWriteDataSizeMismatch

+
RecordsWriteDataSizeMismatch: "RecordsWriteDataSizeMismatch"
+
+

RecordsWriteGetEntryIdUndefinedAuthor

+
RecordsWriteGetEntryIdUndefinedAuthor: "RecordsWriteGetEntryIdUndefinedAuthor"
+
+

RecordsWriteMissingAuthorizationSigner

+
RecordsWriteMissingAuthorizationSigner: "RecordsWriteMissingAuthorizationSigner"
+
+

RecordsWriteMissingDataAssociation

+
RecordsWriteMissingDataAssociation: "RecordsWriteMissingDataAssociation"
+
+

RecordsWriteMissingDataInPrevious

+
RecordsWriteMissingDataInPrevious: "RecordsWriteMissingDataInPrevious"
+
+

RecordsWriteMissingDataStream

+
RecordsWriteMissingDataStream: "RecordsWriteMissingDataStream"
+
+

RecordsWriteMissingProtocol

+
RecordsWriteMissingProtocol: "RecordsWriteMissingProtocol"
+
+

RecordsWriteMissingSchema

+
RecordsWriteMissingSchema: "RecordsWriteMissingSchema"
+
+

RecordsWriteOwnerAndTenantMismatch

+
RecordsWriteOwnerAndTenantMismatch: "RecordsWriteOwnerAndTenantMismatch"
+
+

RecordsWriteSignAsOwnerUnknownAuthor

+
RecordsWriteSignAsOwnerUnknownAuthor: "RecordsWriteSignAsOwnerUnknownAuthor"
+
+

RecordsWriteValidateIntegrityEncryptionCidMismatch

+
RecordsWriteValidateIntegrityEncryptionCidMismatch: "RecordsWriteValidateIntegrityEncryptionCidMismatch"
+
+

Secp256k1KeyNotValid

+
Secp256k1KeyNotValid: "Secp256k1KeyNotValid"
+
+

UrlProtocolNotNormalizable

+
UrlProtocolNotNormalizable: "UrlProtocolNotNormalizable"
+
+

UrlProtocolNotNormalized

+
UrlProtocolNotNormalized: "UrlProtocolNotNormalized"
+
+

UrlSchemaNotNormalizable

+
UrlSchemaNotNormalizable: "UrlSchemaNotNormalizable"
+
+

UrlSchemaNotNormalized

+
UrlSchemaNotNormalized: "UrlSchemaNotNormalized"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Enumeration DwnInterfaceName

+
+
+
+ +
+
+

Enumeration Members

+
Events +Messages +Permissions +Protocols +Records +
+
+

Enumeration Members

+
+

Events

+
Events: "Events"
+
+

Messages

+
Messages: "Messages"
+
+

Permissions

+
Permissions: "Permissions"
+
+

Protocols

+
Protocols: "Protocols"
+
+

Records

+
Records: "Records"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Enumeration DwnMethodName

+
+
+
+ +
+
+

Enumeration Members

+
Configure +Create +Delete +Get +Grant +Query +Read +Request +Revoke +Write +
+
+

Enumeration Members

+
+

Configure

+
Configure: "Configure"
+
+

Create

+
Create: "Create"
+
+

Delete

+
Delete: "Delete"
+
+

Get

+
Get: "Get"
+
+

Grant

+
Grant: "Grant"
+
+

Query

+
Query: "Query"
+
+

Read

+
Read: "Read"
+
+

Request

+
Request: "Request"
+
+

Revoke

+
Revoke: "Revoke"
+
+

Write

+
Write: "Write"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Enumeration EncryptionAlgorithm

+
+
+
+ +
+
+

Enumeration Members

+
Aes256Ctr +EciesSecp256k1 +
+
+

Enumeration Members

+
+

Aes256Ctr

+
Aes256Ctr: "A256CTR"
+
+

EciesSecp256k1

+
EciesSecp256k1: "ECIES-ES256K"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

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

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/enums/SortOrder.html b/enums/SortOrder.html new file mode 100644 index 000000000..9d5b60127 --- /dev/null +++ b/enums/SortOrder.html @@ -0,0 +1,87 @@ +SortOrder | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Enumeration SortOrder

+
+
+
+ +
+
+

Enumeration Members

+
Ascending +Descending +
+
+

Enumeration Members

+
+

Ascending

+
Ascending: 1
+
+

Descending

+
Descending: -1
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/authenticate.html b/functions/authenticate.html new file mode 100644 index 000000000..4e059a2ad --- /dev/null +++ b/functions/authenticate.html @@ -0,0 +1,76 @@ +authenticate | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Function authenticate

+
+
    + +
  • +

    Validates the signature(s) of the given JWS.

    +
    +
    +

    Parameters

    +
      +
    • +
      authorizationModel: undefined | AuthorizationModel
      • +
    • +
      didResolver: DidResolver
    +

    Returns Promise<void>

    +
    +

    Throws

    if fails authentication

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/executeUnlessAborted.html b/functions/executeUnlessAborted.html new file mode 100644 index 000000000..8dc27cca5 --- /dev/null +++ b/functions/executeUnlessAborted.html @@ -0,0 +1,79 @@ +executeUnlessAborted | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Function executeUnlessAborted

+
+
    + +
  • +

    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

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 000000000..73be6d1b4 --- /dev/null +++ b/index.html @@ -0,0 +1,184 @@ +DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+

DWN-SDK Documentation - v0.2.4

+
+
+

Index

+
+

Enumerations

+
DateSort +DwnErrorCode +DwnInterfaceName +DwnMethodName +EncryptionAlgorithm +KeyDerivationScheme +SortOrder +
+
+

Classes

+
AllowAllTenantGate +Cid +DataStoreLevel +DataStream +DidIonResolver +DidKeyResolver +DidResolver +Dwn +DwnConstant +DwnError +Encoder +Encryption +EventLogLevel +EventsGet +HdKey +Jws +Message +MessageStoreLevel +MessagesGet +PermissionsGrant +PermissionsRequest +PermissionsRevoke +PrivateKeySigner +Protocols +ProtocolsConfigure +ProtocolsQuery +Records +RecordsDelete +RecordsQuery +RecordsRead +RecordsWrite +Secp256k1 +
+
+

Interfaces

+
DataStore +DidMethodResolver +EventLog +MessageStore +MessageStoreOptions +Signer +TenantGate +
+
+

Type Aliases

+
AssociateResult +CreateFromOptions +DerivedPrivateJwk +DidDocument +DidDocumentMetadata +DidResolutionMetadata +DidResolutionResult +DwnConfig +DwnServiceEndpoint +EncryptionInput +EncryptionProperty +Event +EventsGetMessage +EventsGetOptions +EventsGetReply +Filter +GenericMessage +GetEventsOptions +GetResult +KeyEncryptionInput +KeyMaterial +MessageSort +MessagesGetMessage +MessagesGetOptions +MessagesGetReply +Pagination +PermissionConditions +PermissionScope +PermissionsGrantDescriptor +PermissionsGrantMessage +PermissionsGrantOptions +PermissionsRequestDescriptor +PermissionsRequestMessage +PermissionsRequestOptions +PermissionsRevokeDescriptor +PermissionsRevokeMessage +PermissionsRevokeOptions +PrivateJwk +ProtocolDefinition +ProtocolRuleSet +ProtocolTypes +ProtocolsConfigureDescriptor +ProtocolsConfigureMessage +ProtocolsConfigureOptions +ProtocolsQueryFilter +ProtocolsQueryMessage +ProtocolsQueryOptions +ProtocolsQueryReply +PublicJwk +PutResult +RecordsDeleteMessage +RecordsDeleteOptions +RecordsQueryMessage +RecordsQueryOptions +RecordsQueryReply +RecordsQueryReplyEntry +RecordsReadOptions +RecordsReadReply +RecordsWriteDescriptor +RecordsWriteMessage +RecordsWriteOptions +ServiceEndpoint +UnionMessageReply +VerificationMethod +
+
+

Functions

+
authenticate +executeUnlessAborted +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Interface DataStore

+
+

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

+
+
+
+

Hierarchy

+
    +
  • DataStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Methods

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

Methods

+
+

associate

+
    + +
  • +

    Associates dataCid of existing data with the given messageCid. +The returned dataCid and returned dataSize will be verified against the given dataCid (and inferred dataSize).

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      +

      The tenant in which the data must exist under for the association to occur.

      +
      +
      • +
    • +
      messageCid: string
      +

      CID of the message that references the data.

      +
      +
      • +
    • +
      dataCid: string
      +

      The CID of the data stored.

      +
      +
    +

    Returns Promise<undefined | AssociateResult>

    if association succeeds. undefined if data to be associated is not found.

    + +
+
+

clear

+
    + +
  • +

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

    +
    +

    Returns Promise<void>

    +
+
+

close

+
    + +
  • +

    Closes the connection to the underlying store.

    +
    +

    Returns Promise<void>

    +
+
+

delete

+
    + +
  • +

    Deletes the specified data.

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      messageCid: string
      +

      CID of the message that references the data.

      +
      +
      • +
    • +
      dataCid: string
    +

    Returns Promise<void>

    +
+
+

get

+
    + +
  • +

    Fetches the specified data. +The returned dataCid and returned dataSize will be verified against the given dataCid (and inferred dataSize).

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      messageCid: string
      +

      CID of the message that references the data.

      +
      +
      • +
    • +
      dataCid: string
    +

    Returns Promise<undefined | GetResult>

    +
+
+

open

+
    + +
  • +

    Opens a connection to the underlying store.

    +
    +

    Returns Promise<void>

    +
+
+

put

+
    + +
  • +

    Puts the given data in store. +It is expected that the CID of the dataStream matches the given dataCid. +The returned dataCid and returned dataSize will be verified against the given dataCid (and inferred dataSize).

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      messageCid: string
      +

      CID of the message that references the data.

      +
      +
      • +
    • +
      dataCid: string
      • +
    • +
      dataStream: Readable
    +

    Returns Promise<PutResult>

    The CID and size in number of bytes of the data stored.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/DidMethodResolver.html b/interfaces/DidMethodResolver.html new file mode 100644 index 000000000..703761bf1 --- /dev/null +++ b/interfaces/DidMethodResolver.html @@ -0,0 +1,124 @@ +DidMethodResolver | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Interface DidMethodResolver

+
+

A generalized interface that can be implemented for individual +DID methods

+
+
+
+

Hierarchy

+
    +
  • DidMethodResolver
+
+

Implemented by

+
+
+
+
+ +
+
+

Methods

+
method +resolve +
+
+

Methods

+
+

method

+
+
+

resolve

+
    + +
  • +

    attempts to resolve the DID provided into its respective DID Document. +More info on resolving DIDs can be found +here

    +
    +
    +

    Parameters

    +
      +
    • +
      did: string
      +

      the DID to resolve

      +
      +
    +

    Returns Promise<DidResolutionResult>

    +
    +

    Throws

    if unable to resolve the DID

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/EventLog.html b/interfaces/EventLog.html new file mode 100644 index 000000000..926a48031 --- /dev/null +++ b/interfaces/EventLog.html @@ -0,0 +1,189 @@ +EventLog | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Interface EventLog

+
+

Hierarchy

+
    +
  • EventLog
+
+

Implemented by

+
+
+
+
+ +
+
+

Methods

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

Methods

+
+

append

+
    + +
  • +

    adds an event to a tenant's event log

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      +

      the tenant's DID

      +
      +
      • +
    • +
      messageCid: string
      +

      the CID of the message

      +
      +
    +

    Returns Promise<string>

    watermark

    + +
+
+

clear

+
    + +
  • +

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

    +
    +

    Returns Promise<void>

    +
+
+

close

+
    + +
  • +

    closes the connection to the underlying store

    +
    +

    Returns Promise<void>

    +
+
+

deleteEventsByCid

+
    + +
  • +

    deletes any events that have any of the cids provided

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      cids: string[]
    +

    Returns Promise<number>

    the number of events deleted

    + +
+
+

getEvents

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Event[]>

    +
+
+

open

+
    + +
  • +

    opens a connection to the underlying store

    +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Interface MessageStore

+
+

Hierarchy

+
    +
  • MessageStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Methods

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

Methods

+
+

clear

+
    + +
  • +

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

    +
    +

    Returns Promise<void>

    +
+
+

close

+
    + +
  • +

    closes the connection to the underlying store

    +
    +

    Returns Promise<void>

    +
+
+

delete

+
    + +
  • +

    Deletes the message associated with the id provided.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+

get

+
+
+

open

+
    + +
  • +

    opens a connection to the underlying store

    +
    +

    Returns Promise<void>

    +
+
+

put

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
      +
    • +
      tenant: string
      • +
    • +
      message: GenericMessage
      • +
    • +
      indexes: {
          [key: string]: string | boolean;
      }
      +

      indexes (key-value pairs) to be included as part of this put operation

      +
      +
      +
        +
      • +
        [key: string]: string | boolean
      • +
    • +
      Optional options: MessageStoreOptions
    +

    Returns Promise<void>

    +
+
+

query

+
    + +
  • +

    Queries the underlying store for messages that matches the provided filters. +Supplying multiple filters establishes an OR condition between the filters.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<{
        messages: GenericMessage[];
        paginationMessageCid?: string;
    }>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Interface MessageStoreOptions

+
+

Hierarchy

+
    +
  • MessageStoreOptions
+
+
+
+ +
+
+

Properties

+
signal? +
+
+

Properties

+
+

Optional signal

+
signal?: AbortSignal
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Interface Signer

+
+

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

+
+
+
+

Hierarchy

+
    +
  • Signer
+
+

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

+
    + +
  • +

    Signs the given content and returns the signature as bytes.

    +
    +
    +

    Parameters

    +
      +
    • +
      content: Uint8Array
    +

    Returns Promise<Uint8Array>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

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

Interface TenantGate

+
+

An interface that determines if a DID is a tenant of the DWN.

+
+
+
+

Hierarchy

+
    +
  • TenantGate
+
+

Implemented by

+
+
+
+
+ +
+
+

Methods

+
isTenant +
+
+

Methods

+
+

isTenant

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      did: string
    +

    Returns Promise<boolean>

    true if the given DID is a tenant of the DWN; false otherwise

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/AssociateResult.html b/types/AssociateResult.html new file mode 100644 index 000000000..c16026449 --- /dev/null +++ b/types/AssociateResult.html @@ -0,0 +1,70 @@ +AssociateResult | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias AssociateResult

+
AssociateResult: {
    dataCid: string;
    dataSize: number;
}
+

Result of a data store associate() method call.

+
+
+

Type declaration

+
    +
  • +
    dataCid: string
    • +
  • +
    dataSize: number
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/CreateFromOptions.html b/types/CreateFromOptions.html new file mode 100644 index 000000000..10714f4da --- /dev/null +++ b/types/CreateFromOptions.html @@ -0,0 +1,79 @@ +CreateFromOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias CreateFromOptions

+
CreateFromOptions: {
    attestationSigners?: Signer[];
    authorizationSigner?: Signer;
    data?: Uint8Array;
    datePublished?: string;
    encryptionInput?: EncryptionInput;
    messageTimestamp?: string;
    published?: boolean;
    recordsWriteMessage: RecordsWriteMessage;
}
+
+

Type declaration

+
    +
  • +
    Optional attestationSigners?: Signer[]
    • +
  • +
    Optional authorizationSigner?: Signer
    • +
  • +
    Optional data?: Uint8Array
    • +
  • +
    Optional datePublished?: string
    • +
  • +
    Optional encryptionInput?: EncryptionInput
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    Optional published?: boolean
    • +
  • +
    recordsWriteMessage: RecordsWriteMessage
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/DerivedPrivateJwk.html b/types/DerivedPrivateJwk.html new file mode 100644 index 000000000..49ad0fd66 --- /dev/null +++ b/types/DerivedPrivateJwk.html @@ -0,0 +1,71 @@ +DerivedPrivateJwk | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias DerivedPrivateJwk

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

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/DidDocument.html b/types/DidDocument.html new file mode 100644 index 000000000..a0d09d6e6 --- /dev/null +++ b/types/DidDocument.html @@ -0,0 +1,85 @@ +DidDocument | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias DidDocument

+
DidDocument: {
    @context?: "https://www.w3.org/ns/did/v1" | string | string[];
    alsoKnownAs?: string[];
    assertionMethod?: VerificationMethod[] | string[];
    authentication?: VerificationMethod[] | string[];
    capabilityDelegation?: VerificationMethod[] | string[];
    capabilityInvocation?: VerificationMethod[] | string[];
    controller?: string | string[];
    id: string;
    keyAgreement?: VerificationMethod[] | string[];
    service?: ServiceEndpoint[];
    verificationMethod?: VerificationMethod[];
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/DidDocumentMetadata.html b/types/DidDocumentMetadata.html new file mode 100644 index 000000000..5874bfe2d --- /dev/null +++ b/types/DidDocumentMetadata.html @@ -0,0 +1,79 @@ +DidDocumentMetadata | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias DidDocumentMetadata

+
DidDocumentMetadata: {
    canonicalId?: string;
    created?: string;
    deactivated?: boolean;
    equivalentId?: string;
    nextUpdate?: string;
    nextVersionId?: string;
    updated?: string;
    versionId?: string;
}
+
+

Type declaration

+
    +
  • +
    Optional canonicalId?: string
    • +
  • +
    Optional created?: string
    • +
  • +
    Optional deactivated?: boolean
    • +
  • +
    Optional equivalentId?: string
    • +
  • +
    Optional nextUpdate?: string
    • +
  • +
    Optional nextVersionId?: string
    • +
  • +
    Optional updated?: string
    • +
  • +
    Optional versionId?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/DidResolutionMetadata.html b/types/DidResolutionMetadata.html new file mode 100644 index 000000000..037cc1da5 --- /dev/null +++ b/types/DidResolutionMetadata.html @@ -0,0 +1,67 @@ +DidResolutionMetadata | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias DidResolutionMetadata

+
DidResolutionMetadata: {
    contentType?: string;
    error?: "invalidDid" | "notFound" | "representationNotSupported" | "unsupportedDidMethod" | string;
}
+
+

Type declaration

+
    +
  • +
    Optional contentType?: string
    • +
  • +
    Optional error?: "invalidDid" | "notFound" | "representationNotSupported" | "unsupportedDidMethod" | string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/DidResolutionResult.html b/types/DidResolutionResult.html new file mode 100644 index 000000000..0f140476b --- /dev/null +++ b/types/DidResolutionResult.html @@ -0,0 +1,71 @@ +DidResolutionResult | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias DidResolutionResult

+
DidResolutionResult: {
    @context?: "https://w3id.org/did-resolution/v1" | string | string[];
    didDocument?: DidDocument;
    didDocumentMetadata: DidDocumentMetadata;
    didResolutionMetadata: DidResolutionMetadata;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/DwnConfig.html b/types/DwnConfig.html new file mode 100644 index 000000000..81effabdb --- /dev/null +++ b/types/DwnConfig.html @@ -0,0 +1,76 @@ +DwnConfig | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias DwnConfig

+
DwnConfig: {
    dataStore: DataStore;
    didResolver?: DidResolver;
    eventLog: EventLog;
    messageStore: MessageStore;
    tenantGate?: TenantGate;
}
+

DWN configuration.

+
+
+

Type declaration

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/DwnServiceEndpoint.html b/types/DwnServiceEndpoint.html new file mode 100644 index 000000000..7e8d187aa --- /dev/null +++ b/types/DwnServiceEndpoint.html @@ -0,0 +1,65 @@ +DwnServiceEndpoint | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias DwnServiceEndpoint

+
DwnServiceEndpoint: {
    nodes: string[];
}
+
+

Type declaration

+
    +
  • +
    nodes: string[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

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

+
    +
  • +
    Optional algorithm?: 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

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias EncryptionProperty

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

Type declaration

+
    +
  • +
    algorithm: EncryptionAlgorithm
    • +
  • +
    initializationVector: string
    • +
  • +
    keyEncryption: EncryptedKey[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/Event.html b/types/Event.html new file mode 100644 index 000000000..ef39be1be --- /dev/null +++ b/types/Event.html @@ -0,0 +1,67 @@ +Event | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias Event

+
Event: {
    messageCid: string;
    watermark: string;
}
+
+

Type declaration

+
    +
  • +
    messageCid: string
    • +
  • +
    watermark: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/EventsGetMessage.html b/types/EventsGetMessage.html new file mode 100644 index 000000000..81387136b --- /dev/null +++ b/types/EventsGetMessage.html @@ -0,0 +1,67 @@ +EventsGetMessage | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias EventsGetMessage

+
EventsGetMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: EventsGetDescriptor;
}
+
+

Type declaration

+
    +
  • +
    authorization: AuthorizationModel
    • +
  • +
    descriptor: EventsGetDescriptor
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/EventsGetOptions.html b/types/EventsGetOptions.html new file mode 100644 index 000000000..c3b702ca7 --- /dev/null +++ b/types/EventsGetOptions.html @@ -0,0 +1,69 @@ +EventsGetOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias EventsGetOptions

+
EventsGetOptions: {
    authorizationSigner: Signer;
    messageTimestamp?: string;
    watermark?: string;
}
+
+

Type declaration

+
    +
  • +
    authorizationSigner: Signer
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    Optional watermark?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/EventsGetReply.html b/types/EventsGetReply.html new file mode 100644 index 000000000..a6fa7f316 --- /dev/null +++ b/types/EventsGetReply.html @@ -0,0 +1,65 @@ +EventsGetReply | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias EventsGetReply

+
EventsGetReply: GenericMessageReply & {
    events?: Event[];
}
+
+

Type declaration

+
    +
  • +
    Optional events?: Event[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias Filter

+
Filter: {
    [property: string]: EqualFilter | OneOfFilter | RangeFilter;
}
+
+

Type declaration

+
    +
  • +
    [property: string]: EqualFilter | OneOfFilter | RangeFilter
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/GenericMessage.html b/types/GenericMessage.html new file mode 100644 index 000000000..3e201155b --- /dev/null +++ b/types/GenericMessage.html @@ -0,0 +1,70 @@ +GenericMessage | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias GenericMessage

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

Intersection type for all concrete message types.

+
+
+

Type declaration

+
    +
  • +
    Optional authorization?: AuthorizationModel
    • +
  • +
    descriptor: Descriptor
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/GetEventsOptions.html b/types/GetEventsOptions.html new file mode 100644 index 000000000..6a0692d91 --- /dev/null +++ b/types/GetEventsOptions.html @@ -0,0 +1,65 @@ +GetEventsOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias GetEventsOptions

+
GetEventsOptions: {
    gt: string;
}
+
+

Type declaration

+
    +
  • +
    gt: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/GetResult.html b/types/GetResult.html new file mode 100644 index 000000000..af87acd3e --- /dev/null +++ b/types/GetResult.html @@ -0,0 +1,72 @@ +GetResult | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias GetResult

+
GetResult: {
    dataCid: string;
    dataSize: number;
    dataStream: Readable;
}
+

Result of a data store get() method call.

+
+
+

Type declaration

+
    +
  • +
    dataCid: string
    • +
  • +
    dataSize: number
    • +
  • +
    dataStream: Readable
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/KeyEncryptionInput.html b/types/KeyEncryptionInput.html new file mode 100644 index 000000000..71c4f1427 --- /dev/null +++ b/types/KeyEncryptionInput.html @@ -0,0 +1,87 @@ +KeyEncryptionInput | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias KeyEncryptionInput

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

Input that specifies how a symmetric key is encrypted.

+
+
+

Type declaration

+
    +
  • +
    Optional algorithm?: 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

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/KeyMaterial.html b/types/KeyMaterial.html new file mode 100644 index 000000000..dac667d87 --- /dev/null +++ b/types/KeyMaterial.html @@ -0,0 +1,75 @@ +KeyMaterial | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias KeyMaterial

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

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

+
+
+

Type declaration

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias MessageSort

+
MessageSort: {
    dateCreated?: SortOrder;
    datePublished?: SortOrder;
    messageTimestamp?: SortOrder;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias MessagesGetMessage

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

Type declaration

+
    +
  • +
    authorization: AuthorizationModel
    • +
  • +
    descriptor: MessagesGetDescriptor
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/MessagesGetOptions.html b/types/MessagesGetOptions.html new file mode 100644 index 000000000..7b5056b30 --- /dev/null +++ b/types/MessagesGetOptions.html @@ -0,0 +1,69 @@ +MessagesGetOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias MessagesGetOptions

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

Type declaration

+
    +
  • +
    authorizationSigner: Signer
    • +
  • +
    messageCids: string[]
    • +
  • +
    Optional messageTimestamp?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias MessagesGetReply

+
MessagesGetReply: GenericMessageReply & {
    messages?: MessagesGetReplyEntry[];
}
+
+

Type declaration

+
    +
  • +
    Optional messages?: MessagesGetReplyEntry[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias Pagination

+
Pagination: {
    limit?: number;
    messageCid?: string;
}
+
+

Type declaration

+
    +
  • +
    Optional limit?: number
    • +
  • +
    Optional messageCid?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionConditions.html b/types/PermissionConditions.html new file mode 100644 index 000000000..0ff9daaf3 --- /dev/null +++ b/types/PermissionConditions.html @@ -0,0 +1,70 @@ +PermissionConditions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionConditions

+
PermissionConditions: {
    publication?: PermissionsConditionPublication;
}
+
+

Type declaration

+
    +
  • +
    Optional publication?: PermissionsConditionPublication
    +

    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

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionScope.html b/types/PermissionScope.html new file mode 100644 index 000000000..b7146259c --- /dev/null +++ b/types/PermissionScope.html @@ -0,0 +1,67 @@ +PermissionScope | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionScope

+
PermissionScope: {
    interface: DwnInterfaceName;
    method: DwnMethodName;
} | RecordsPermissionScope
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionsGrantDescriptor.html b/types/PermissionsGrantDescriptor.html new file mode 100644 index 000000000..0241fed54 --- /dev/null +++ b/types/PermissionsGrantDescriptor.html @@ -0,0 +1,103 @@ +PermissionsGrantDescriptor | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionsGrantDescriptor

+
PermissionsGrantDescriptor: {
    conditions?: PermissionConditions;
    dateExpires: string;
    description?: string;
    grantedBy: string;
    grantedFor: string;
    grantedTo: string;
    interface: Permissions;
    messageTimestamp: string;
    method: Grant;
    permissionsRequestId?: string;
    scope: PermissionScope;
}
+
+

Type declaration

+
    +
  • +
    Optional conditions?: PermissionConditions
    • +
  • +
    dateExpires: string
    +

    optional timestamp at which this grant will no longer be active.

    +
    +
    • +
  • +
    Optional description?: string
    +

    Optional string that communicates what the grant would be used for

    +
    +
    • +
  • +
    grantedBy: string
    +

    The granter, who will be either the DWN owner or an entity who the DWN owner has delegated permission to.

    +
    +
    • +
  • +
    grantedFor: string
    +

    The DID of the DWN which the grantee will be given access

    +
    +
    • +
  • +
    grantedTo: string
    +

    The recipient of the grant. Usually this is the author of the PermissionsRequest message

    +
    +
    • +
  • +
    interface: Permissions
    • +
  • +
    messageTimestamp: string
    • +
  • +
    method: Grant
    • +
  • +
    Optional permissionsRequestId?: string
    +

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

    +
    +
    • +
  • +
    scope: PermissionScope
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionsGrantMessage.html b/types/PermissionsGrantMessage.html new file mode 100644 index 000000000..ee1ced77a --- /dev/null +++ b/types/PermissionsGrantMessage.html @@ -0,0 +1,67 @@ +PermissionsGrantMessage | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionsGrantMessage

+
PermissionsGrantMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: PermissionsGrantDescriptor;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionsGrantOptions.html b/types/PermissionsGrantOptions.html new file mode 100644 index 000000000..cc6d194ce --- /dev/null +++ b/types/PermissionsGrantOptions.html @@ -0,0 +1,83 @@ +PermissionsGrantOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionsGrantOptions

+
PermissionsGrantOptions: {
    authorizationSigner: Signer;
    conditions?: PermissionConditions;
    dateExpires: string;
    description?: string;
    grantedBy: string;
    grantedFor: string;
    grantedTo: string;
    messageTimestamp?: string;
    permissionsRequestId?: string;
    scope: PermissionScope;
}
+
+

Type declaration

+
    +
  • +
    authorizationSigner: Signer
    • +
  • +
    Optional conditions?: PermissionConditions
    • +
  • +
    dateExpires: string
    • +
  • +
    Optional description?: string
    • +
  • +
    grantedBy: string
    • +
  • +
    grantedFor: string
    • +
  • +
    grantedTo: string
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    Optional permissionsRequestId?: string
    • +
  • +
    scope: PermissionScope
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionsRequestDescriptor.html b/types/PermissionsRequestDescriptor.html new file mode 100644 index 000000000..f8a75ff2e --- /dev/null +++ b/types/PermissionsRequestDescriptor.html @@ -0,0 +1,81 @@ +PermissionsRequestDescriptor | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionsRequestDescriptor

+
PermissionsRequestDescriptor: {
    conditions?: PermissionConditions;
    description?: string;
    grantedBy: string;
    grantedFor: string;
    grantedTo: string;
    interface: Permissions;
    messageTimestamp: string;
    method: Request;
    scope: PermissionScope;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionsRequestMessage.html b/types/PermissionsRequestMessage.html new file mode 100644 index 000000000..7f5dc478e --- /dev/null +++ b/types/PermissionsRequestMessage.html @@ -0,0 +1,67 @@ +PermissionsRequestMessage | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionsRequestMessage

+
PermissionsRequestMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: PermissionsRequestDescriptor;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionsRequestOptions.html b/types/PermissionsRequestOptions.html new file mode 100644 index 000000000..64acfb362 --- /dev/null +++ b/types/PermissionsRequestOptions.html @@ -0,0 +1,79 @@ +PermissionsRequestOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionsRequestOptions

+
PermissionsRequestOptions: {
    authorizationSigner: Signer;
    conditions?: PermissionConditions;
    description?: string;
    grantedBy: string;
    grantedFor: string;
    grantedTo: string;
    messageTimestamp?: string;
    scope: PermissionScope;
}
+
+

Type declaration

+
    +
  • +
    authorizationSigner: Signer
    • +
  • +
    Optional conditions?: PermissionConditions
    • +
  • +
    Optional description?: string
    • +
  • +
    grantedBy: string
    • +
  • +
    grantedFor: string
    • +
  • +
    grantedTo: string
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    scope: PermissionScope
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionsRevokeDescriptor.html b/types/PermissionsRevokeDescriptor.html new file mode 100644 index 000000000..4ef25c6bc --- /dev/null +++ b/types/PermissionsRevokeDescriptor.html @@ -0,0 +1,71 @@ +PermissionsRevokeDescriptor | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionsRevokeDescriptor

+
PermissionsRevokeDescriptor: {
    interface: Permissions;
    messageTimestamp: string;
    method: Revoke;
    permissionsGrantId: string;
}
+
+

Type declaration

+
    +
  • +
    interface: Permissions
    • +
  • +
    messageTimestamp: string
    • +
  • +
    method: Revoke
    • +
  • +
    permissionsGrantId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionsRevokeMessage.html b/types/PermissionsRevokeMessage.html new file mode 100644 index 000000000..c776e7c8b --- /dev/null +++ b/types/PermissionsRevokeMessage.html @@ -0,0 +1,67 @@ +PermissionsRevokeMessage | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionsRevokeMessage

+
PermissionsRevokeMessage: GenericMessage & {
    authorization: AuthorizationModel;
    descriptor: PermissionsRevokeDescriptor;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PermissionsRevokeOptions.html b/types/PermissionsRevokeOptions.html new file mode 100644 index 000000000..8b6c4fdb2 --- /dev/null +++ b/types/PermissionsRevokeOptions.html @@ -0,0 +1,69 @@ +PermissionsRevokeOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PermissionsRevokeOptions

+
PermissionsRevokeOptions: {
    authorizationSigner: Signer;
    messageTimestamp?: string;
    permissionsGrantId: string;
}
+
+

Type declaration

+
    +
  • +
    authorizationSigner: Signer
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    permissionsGrantId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

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

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/ProtocolDefinition.html b/types/ProtocolDefinition.html new file mode 100644 index 000000000..ed34297ab --- /dev/null +++ b/types/ProtocolDefinition.html @@ -0,0 +1,77 @@ +ProtocolDefinition | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

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

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

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/ProtocolRuleSet.html b/types/ProtocolRuleSet.html new file mode 100644 index 000000000..985817ab7 --- /dev/null +++ b/types/ProtocolRuleSet.html @@ -0,0 +1,88 @@ +ProtocolRuleSet | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias ProtocolRuleSet

+
ProtocolRuleSet: {
    $actions?: ProtocolActionRule[];
    $contextRole?: boolean;
    $encryption?: ProtocolPathEncryption;
    $globalRole?: boolean;
    [key: string]: any;
}
+
+

Type declaration

+
    +
  • +
    [key: string]: any
    • +
  • +
    Optional $actions?: ProtocolActionRule[]
    • +
  • +
    Optional $contextRole?: boolean
    +

    If true, this marks a record as a role that may used within a single context. Only +second-level records may set $contextRole: true. +The recipient of a $contextRole record may invoke their role in RecordsReads or RecordsWrites +by setting protocolRole property to the protocol path of the $contextRole record.

    +
    +
    • +
  • +
    Optional $encryption?: ProtocolPathEncryption
    +

    Encryption setting for objects that are in this protocol path.

    +
    +
    • +
  • +
    Optional $globalRole?: boolean
    +

    If true, this marks a record as a role that may be used across contexts. Only root records +may set $globalRole: true. +The recipient of a $globalRole record may invoke their role in RecordsRead or RecordsWrites +by setting protocolRole property to the protocol path of the $globalRole record.

    +
    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias ProtocolTypes

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

Type declaration

+
    +
  • +
    [key: string]: ProtocolType
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias ProtocolsConfigureDescriptor

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

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias ProtocolsConfigureMessage

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

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/ProtocolsConfigureOptions.html b/types/ProtocolsConfigureOptions.html new file mode 100644 index 000000000..24209bfcc --- /dev/null +++ b/types/ProtocolsConfigureOptions.html @@ -0,0 +1,71 @@ +ProtocolsConfigureOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias ProtocolsConfigureOptions

+
ProtocolsConfigureOptions: {
    authorizationSigner: Signer;
    definition: ProtocolDefinition;
    messageTimestamp?: string;
    permissionsGrantId?: string;
}
+
+

Type declaration

+
    +
  • +
    authorizationSigner: Signer
    • +
  • +
    definition: ProtocolDefinition
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    Optional permissionsGrantId?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias ProtocolsQueryFilter

+
ProtocolsQueryFilter: {
    protocol: string;
}
+
+

Type declaration

+
    +
  • +
    protocol: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias ProtocolsQueryMessage

+
ProtocolsQueryMessage: GenericMessage & {
    descriptor: ProtocolsQueryDescriptor;
}
+
+

Type declaration

+
    +
  • +
    descriptor: ProtocolsQueryDescriptor
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias ProtocolsQueryOptions

+
ProtocolsQueryOptions: {
    authorizationSigner?: Signer;
    filter?: ProtocolsQueryFilter;
    messageTimestamp?: string;
    permissionsGrantId?: string;
}
+
+

Type declaration

+
    +
  • +
    Optional authorizationSigner?: Signer
    • +
  • +
    Optional filter?: ProtocolsQueryFilter
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    Optional permissionsGrantId?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/ProtocolsQueryReply.html b/types/ProtocolsQueryReply.html new file mode 100644 index 000000000..6cab862ab --- /dev/null +++ b/types/ProtocolsQueryReply.html @@ -0,0 +1,65 @@ +ProtocolsQueryReply | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias ProtocolsQueryReply

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

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PublicJwk.html b/types/PublicJwk.html new file mode 100644 index 000000000..06e0dd969 --- /dev/null +++ b/types/PublicJwk.html @@ -0,0 +1,82 @@ +PublicJwk | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PublicJwk

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

Type declaration

+
    +
  • +
    crv: "Ed25519" | "secp256k1"
    +

    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

    +
    +
    • +
  • +
    Optional y?: 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

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/PutResult.html b/types/PutResult.html new file mode 100644 index 000000000..ecfe30c4d --- /dev/null +++ b/types/PutResult.html @@ -0,0 +1,70 @@ +PutResult | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias PutResult

+
PutResult: {
    dataCid: string;
    dataSize: number;
}
+

Result of a data store put() method call.

+
+
+

Type declaration

+
    +
  • +
    dataCid: string
    • +
  • +
    dataSize: number
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias RecordsDeleteMessage

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

Type declaration

+
    +
  • +
    authorization: AuthorizationModel
    • +
  • +
    descriptor: RecordsDeleteDescriptor
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/RecordsDeleteOptions.html b/types/RecordsDeleteOptions.html new file mode 100644 index 000000000..697ecc175 --- /dev/null +++ b/types/RecordsDeleteOptions.html @@ -0,0 +1,69 @@ +RecordsDeleteOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias RecordsDeleteOptions

+
RecordsDeleteOptions: {
    authorizationSigner: Signer;
    messageTimestamp?: string;
    recordId: string;
}
+
+

Type declaration

+
    +
  • +
    authorizationSigner: Signer
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    recordId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/RecordsQueryMessage.html b/types/RecordsQueryMessage.html new file mode 100644 index 000000000..2d5c7179c --- /dev/null +++ b/types/RecordsQueryMessage.html @@ -0,0 +1,65 @@ +RecordsQueryMessage | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias RecordsQueryMessage

+
RecordsQueryMessage: GenericMessage & {
    descriptor: RecordsQueryDescriptor;
}
+
+

Type declaration

+
    +
  • +
    descriptor: RecordsQueryDescriptor
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/RecordsQueryOptions.html b/types/RecordsQueryOptions.html new file mode 100644 index 000000000..a06439338 --- /dev/null +++ b/types/RecordsQueryOptions.html @@ -0,0 +1,73 @@ +RecordsQueryOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias RecordsQueryOptions

+
RecordsQueryOptions: {
    authorizationSigner?: Signer;
    dateSort?: DateSort;
    filter: RecordsFilter;
    messageTimestamp?: string;
    pagination?: Pagination;
}
+
+

Type declaration

+
    +
  • +
    Optional authorizationSigner?: Signer
    • +
  • +
    Optional dateSort?: DateSort
    • +
  • +
    filter: RecordsFilter
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    Optional pagination?: Pagination
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias RecordsQueryReply

+
RecordsQueryReply: GenericMessageReply & {
    entries?: RecordsQueryReplyEntry[];
    paginationMessageCid?: string;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/RecordsQueryReplyEntry.html b/types/RecordsQueryReplyEntry.html new file mode 100644 index 000000000..9070ef6e6 --- /dev/null +++ b/types/RecordsQueryReplyEntry.html @@ -0,0 +1,73 @@ +RecordsQueryReplyEntry | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias RecordsQueryReplyEntry

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

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. does not contain authorization
    2. +
  2. may include encoded data
    3. +
+
+
+

Type declaration

+
    +
  • +
    Optional encodedData?: string
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/RecordsReadOptions.html b/types/RecordsReadOptions.html new file mode 100644 index 000000000..02718d08b --- /dev/null +++ b/types/RecordsReadOptions.html @@ -0,0 +1,77 @@ +RecordsReadOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias RecordsReadOptions

+
RecordsReadOptions: {
    authorizationSigner?: Signer;
    filter: RecordsFilter;
    messageTimestamp?: string;
    permissionsGrantId?: string;
    protocolRole?: string;
}
+
+

Type declaration

+
    +
  • +
    Optional authorizationSigner?: Signer
    • +
  • +
    filter: RecordsFilter
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    Optional permissionsGrantId?: string
    • +
  • +
    Optional protocolRole?: string
    +

    Used when authorizing protocol records. +The protocol path to a $globalRole record whose recipient is the author of this RecordsRead

    +
    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias RecordsReadReply

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

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

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

Type declaration

+
    +
  • +
    dataCid: string
    • +
  • +
    dataFormat: string
    • +
  • +
    dataSize: number
    • +
  • +
    dateCreated: string
    • +
  • +
    Optional datePublished?: string
    • +
  • +
    interface: Records
    • +
  • +
    messageTimestamp: string
    • +
  • +
    method: Write
    • +
  • +
    Optional parentId?: string
    • +
  • +
    Optional protocol?: string
    • +
  • +
    Optional protocolPath?: string
    • +
  • +
    Optional published?: boolean
    • +
  • +
    Optional recipient?: string
    • +
  • +
    Optional schema?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

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

Type alias RecordsWriteMessage

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

Type declaration

+
    +
  • +
    Optional attestation?: GeneralJws
    • +
  • +
    authorization: AuthorizationModel
    • +
  • +
    Optional contextId?: string
    • +
  • +
    descriptor: RecordsWriteDescriptor
    • +
  • +
    Optional encryption?: EncryptionProperty
    • +
  • +
    recordId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/RecordsWriteOptions.html b/types/RecordsWriteOptions.html new file mode 100644 index 000000000..23503bd76 --- /dev/null +++ b/types/RecordsWriteOptions.html @@ -0,0 +1,103 @@ +RecordsWriteOptions | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias RecordsWriteOptions

+
RecordsWriteOptions: {
    attestationSigners?: Signer[];
    authorizationSigner?: Signer;
    contextId?: string;
    data?: Uint8Array;
    dataCid?: string;
    dataFormat: string;
    dataSize?: number;
    dateCreated?: string;
    datePublished?: string;
    encryptionInput?: EncryptionInput;
    messageTimestamp?: string;
    parentId?: string;
    permissionsGrantId?: string;
    protocol?: string;
    protocolPath?: string;
    protocolRole?: string;
    published?: boolean;
    recipient?: string;
    recordId?: string;
    schema?: string;
}
+
+

Type declaration

+
    +
  • +
    Optional attestationSigners?: Signer[]
    • +
  • +
    Optional authorizationSigner?: Signer
    • +
  • +
    Optional contextId?: string
    • +
  • +
    Optional data?: Uint8Array
    • +
  • +
    Optional dataCid?: string
    • +
  • +
    dataFormat: string
    • +
  • +
    Optional dataSize?: number
    • +
  • +
    Optional dateCreated?: string
    • +
  • +
    Optional datePublished?: string
    • +
  • +
    Optional encryptionInput?: EncryptionInput
    • +
  • +
    Optional messageTimestamp?: string
    • +
  • +
    Optional parentId?: string
    • +
  • +
    Optional permissionsGrantId?: string
    • +
  • +
    Optional protocol?: string
    • +
  • +
    Optional protocolPath?: string
    • +
  • +
    Optional protocolRole?: string
    • +
  • +
    Optional published?: boolean
    • +
  • +
    Optional recipient?: string
    • +
  • +
    Optional recordId?: string
    • +
  • +
    Optional schema?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/ServiceEndpoint.html b/types/ServiceEndpoint.html new file mode 100644 index 000000000..f5cee60ec --- /dev/null +++ b/types/ServiceEndpoint.html @@ -0,0 +1,71 @@ +ServiceEndpoint | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias ServiceEndpoint

+
ServiceEndpoint: {
    description?: string;
    id: string;
    serviceEndpoint: string | DwnServiceEndpoint;
    type: string;
}
+
+

Type declaration

+
    +
  • +
    Optional description?: string
    • +
  • +
    id: string
    • +
  • +
    serviceEndpoint: string | DwnServiceEndpoint
    • +
  • +
    type: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/UnionMessageReply.html b/types/UnionMessageReply.html new file mode 100644 index 000000000..45bfcc56e --- /dev/null +++ b/types/UnionMessageReply.html @@ -0,0 +1,79 @@ +UnionMessageReply | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias UnionMessageReply

+
UnionMessageReply: GenericMessageReply & {
    data?: Readable;
    entries?: QueryResultEntry[];
}
+

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

+
+
+

Type declaration

+
    +
  • +
    Optional data?: Readable
    +

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

    +
    +
    • +
  • +
    Optional entries?: QueryResultEntry[]
    +

    Resulting message entries or events returned from the invocation of the corresponding message. +e.g. the resulting messages from a RecordsQuery +Mutually exclusive with data.

    +
    +
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/VerificationMethod.html b/types/VerificationMethod.html new file mode 100644 index 000000000..76fa98631 --- /dev/null +++ b/types/VerificationMethod.html @@ -0,0 +1,71 @@ +VerificationMethod | DWN-SDK Documentation - v0.2.4
+
+ +
+
+
+
+ +

Type alias VerificationMethod

+
VerificationMethod: {
    controller: string;
    id: string;
    publicKeyJwk?: PublicJwk;
    type: string;
}
+
+

Type declaration

+
    +
  • +
    controller: string
    • +
  • +
    id: string
    • +
  • +
    Optional publicKeyJwk?: PublicJwk
    • +
  • +
    type: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file