From 3046b783c621f03650b0f12a48559eabcc39f838 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 21 Feb 2024 19:04:33 +0000 Subject: [PATCH] 2024-02-21T19:04:33+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 | 1414 +++++++++++++++++++++++ classes/AllowAllTenantGate.html | 5 + classes/Cid.html | 17 + classes/DataStoreLevel.html | 27 + classes/DataStream.html | 13 + classes/Dwn.html | 14 + classes/DwnConstant.html | 6 + classes/DwnError.html | 4 + classes/Encoder.html | 11 + classes/Encryption.html | 17 + classes/EventEmitterStream.html | 7 + classes/EventLogLevel.html | 28 + classes/EventsGet.html | 9 + classes/EventsQuery.html | 9 + classes/EventsSubscribe.html | 11 + classes/HdKey.html | 9 + classes/Jws.html | 18 + classes/Message.html | 44 + classes/MessageStoreLevel.html | 26 + classes/MessagesGet.html | 9 + classes/PermissionsGrant.html | 23 + classes/PermissionsRequest.html | 9 + classes/PermissionsRevoke.html | 10 + classes/PrivateKeySigner.html | 17 + classes/Protocols.html | 7 + classes/ProtocolsConfigure.html | 9 + classes/ProtocolsQuery.html | 11 + classes/Records.html | 43 + classes/RecordsDelete.html | 13 + classes/RecordsQuery.html | 13 + classes/RecordsRead.html | 14 + classes/RecordsSubscribe.html | 13 + classes/RecordsWrite.html | 65 ++ classes/Secp256k1.html | 34 + classes/TestDataGenerator.html | 65 ++ classes/Time.html | 24 + enums/DateSort.html | 5 + enums/DwnErrorCode.html | 135 +++ enums/DwnInterfaceName.html | 6 + enums/DwnMethodName.html | 12 + enums/EncryptionAlgorithm.html | 3 + enums/KeyDerivationScheme.html | 7 + enums/SortDirection.html | 3 + functions/authenticate.html | 3 + functions/executeUnlessAborted.html | 2 + hierarchy.html | 1 + index.html | 133 +++ interfaces/DataStore.html | 21 + interfaces/EventLog.html | 25 + interfaces/EventStream.html | 6 + interfaces/MessageStore.html | 18 + interfaces/MessageStoreOptions.html | 2 + interfaces/MessageSubscription.html | 3 + interfaces/Signer.html | 16 + interfaces/TenantGate.html | 4 + types/ActiveTenantCheckResult.html | 4 + types/CreateFromOptions.html | 3 + types/DataStoreGetResult.html | 3 + types/DataStorePutResult.html | 3 + types/DerivedPrivateJwk.html | 1 + types/DwnConfig.html | 2 + types/EncryptionInput.html | 7 + types/EncryptionProperty.html | 1 + types/EqualFilter.html | 1 + types/EventSubscriptionHandler.html | 1 + types/EventsGetMessage.html | 1 + types/EventsGetOptions.html | 1 + types/EventsGetReply.html | 1 + types/EventsQueryMessage.html | 1 + types/EventsQueryOptions.html | 1 + types/EventsQueryReply.html | 1 + types/EventsSubscribeDescriptor.html | 1 + types/EventsSubscribeMessage.html | 1 + types/EventsSubscribeOptions.html | 1 + types/EventsSubscribeReply.html | 1 + types/Filter.html | 1 + types/GenericMessage.html | 2 + types/GenericMessageReply.html | 1 + types/KeyEncryptionInput.html | 7 + types/KeyMaterial.html | 2 + types/MessageEvent.html | 3 + types/MessageSort.html | 1 + types/MessagesGetMessage.html | 1 + types/MessagesGetOptions.html | 1 + types/MessagesGetReply.html | 1 + types/MessagesGetReplyEntry.html | 1 + types/OneOfFilter.html | 1 + types/Pagination.html | 3 + types/PaginationCursor.html | 1 + types/PermissionConditions.html | 4 + types/PermissionScope.html | 1 + types/PermissionsGrantDescriptor.html | 8 + types/PermissionsGrantMessage.html | 1 + types/PermissionsGrantOptions.html | 1 + types/PermissionsRequestDescriptor.html | 1 + types/PermissionsRequestMessage.html | 1 + types/PermissionsRequestOptions.html | 1 + types/PermissionsRevokeDescriptor.html | 1 + types/PermissionsRevokeMessage.html | 1 + types/PermissionsRevokeOptions.html | 1 + types/Persona.html | 2 + types/PrivateJwk.html | 4 + types/ProtocolDefinition.html | 2 + types/ProtocolRuleSet.html | 5 + types/ProtocolTypes.html | 1 + types/ProtocolsConfigureDescriptor.html | 1 + types/ProtocolsConfigureMessage.html | 1 + types/ProtocolsConfigureOptions.html | 1 + types/ProtocolsQueryFilter.html | 1 + types/ProtocolsQueryMessage.html | 1 + types/ProtocolsQueryOptions.html | 1 + types/ProtocolsQueryReply.html | 1 + types/PublicJwk.html | 8 + types/QueryOptions.html | 1 + types/QueryResultEntry.html | 6 + types/RangeCriterion.html | 3 + types/RangeFilter.html | 2 + types/RecordsDeleteMessage.html | 1 + types/RecordsDeleteOptions.html | 2 + types/RecordsQueryMessage.html | 1 + types/RecordsQueryOptions.html | 2 + types/RecordsQueryReply.html | 1 + types/RecordsQueryReplyEntry.html | 9 + types/RecordsReadMessage.html | 1 + types/RecordsReadOptions.html | 4 + types/RecordsReadReply.html | 1 + types/RecordsSubscribeDescriptor.html | 1 + types/RecordsSubscribeMessage.html | 1 + types/RecordsSubscribeOptions.html | 2 + types/RecordsSubscribeReply.html | 1 + types/RecordsWriteDescriptor.html | 1 + types/RecordsWriteMessage.html | 1 + types/RecordsWriteOptions.html | 5 + types/SubscriptionReply.html | 1 + types/UnionMessageReply.html | 10 + 140 files changed, 2726 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/Dwn.html create mode 100644 classes/DwnConstant.html create mode 100644 classes/DwnError.html create mode 100644 classes/Encoder.html create mode 100644 classes/Encryption.html create mode 100644 classes/EventEmitterStream.html create mode 100644 classes/EventLogLevel.html create mode 100644 classes/EventsGet.html create mode 100644 classes/EventsQuery.html create mode 100644 classes/EventsSubscribe.html create mode 100644 classes/HdKey.html create mode 100644 classes/Jws.html create mode 100644 classes/Message.html create mode 100644 classes/MessageStoreLevel.html create mode 100644 classes/MessagesGet.html create mode 100644 classes/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/RecordsSubscribe.html create mode 100644 classes/RecordsWrite.html create mode 100644 classes/Secp256k1.html create mode 100644 classes/TestDataGenerator.html create mode 100644 classes/Time.html create mode 100644 enums/DateSort.html create mode 100644 enums/DwnErrorCode.html create mode 100644 enums/DwnInterfaceName.html create mode 100644 enums/DwnMethodName.html create mode 100644 enums/EncryptionAlgorithm.html create mode 100644 enums/KeyDerivationScheme.html create mode 100644 enums/SortDirection.html create mode 100644 functions/authenticate.html create mode 100644 functions/executeUnlessAborted.html create mode 100644 hierarchy.html create mode 100644 index.html create mode 100644 interfaces/DataStore.html create mode 100644 interfaces/EventLog.html create mode 100644 interfaces/EventStream.html create mode 100644 interfaces/MessageStore.html create mode 100644 interfaces/MessageStoreOptions.html create mode 100644 interfaces/MessageSubscription.html create mode 100644 interfaces/Signer.html create mode 100644 interfaces/TenantGate.html create mode 100644 types/ActiveTenantCheckResult.html create mode 100644 types/CreateFromOptions.html create mode 100644 types/DataStoreGetResult.html create mode 100644 types/DataStorePutResult.html create mode 100644 types/DerivedPrivateJwk.html create mode 100644 types/DwnConfig.html create mode 100644 types/EncryptionInput.html create mode 100644 types/EncryptionProperty.html create mode 100644 types/EqualFilter.html create mode 100644 types/EventSubscriptionHandler.html create mode 100644 types/EventsGetMessage.html create mode 100644 types/EventsGetOptions.html create mode 100644 types/EventsGetReply.html create mode 100644 types/EventsQueryMessage.html create mode 100644 types/EventsQueryOptions.html create mode 100644 types/EventsQueryReply.html create mode 100644 types/EventsSubscribeDescriptor.html create mode 100644 types/EventsSubscribeMessage.html create mode 100644 types/EventsSubscribeOptions.html create mode 100644 types/EventsSubscribeReply.html create mode 100644 types/Filter.html create mode 100644 types/GenericMessage.html create mode 100644 types/GenericMessageReply.html create mode 100644 types/KeyEncryptionInput.html create mode 100644 types/KeyMaterial.html create mode 100644 types/MessageEvent.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/MessagesGetReplyEntry.html create mode 100644 types/OneOfFilter.html create mode 100644 types/Pagination.html create mode 100644 types/PaginationCursor.html create mode 100644 types/PermissionConditions.html create mode 100644 types/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/Persona.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/QueryOptions.html create mode 100644 types/QueryResultEntry.html create mode 100644 types/RangeCriterion.html create mode 100644 types/RangeFilter.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/RecordsReadMessage.html create mode 100644 types/RecordsReadOptions.html create mode 100644 types/RecordsReadReply.html create mode 100644 types/RecordsSubscribeDescriptor.html create mode 100644 types/RecordsSubscribeMessage.html create mode 100644 types/RecordsSubscribeOptions.html create mode 100644 types/RecordsSubscribeReply.html create mode 100644 types/RecordsWriteDescriptor.html create mode 100644 types/RecordsWriteMessage.html create mode 100644 types/RecordsWriteOptions.html create mode 100644 types/SubscriptionReply.html create mode 100644 types/UnionMessageReply.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 000000000..5674cf392 --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,22 @@ +:root { + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --code-background: var(--dark-code-background); +} + +pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 000000000..3092fea0e --- /dev/null +++ b/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Ie=Object.create;var ne=Object.defineProperty;var Pe=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=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ie(_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 He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",H="mouseup",J={x:0,y:0},fe=!1,ee=!1,Be=!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&&(Be=!0,F="touchstart",pe="touchmove",H="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(H,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var 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(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.updateIndexHeadingVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.updateIndexHeadingVisibility()}updateIndexHeadingVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}};var Z=class extends C{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function 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..f07947196 --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WaTXMiNxCG/wtnVxy7YifxzQVe79rr2AFv5ZDKQZ5pQMUgsZIGlkrlv6dmGEAfLal15X370aj11aPh739HBn6Y0d1owgzMpDKji9GGmeXobgSiXevL4+8/Lc26GV2MVlzUo7vf/rs4R+7Eg1JSjWUNQbSlJQlfhAE1ZxX8wdYYxdGTpBcwS1lHMGcxzngQldpvDJfivllIxc1y7ZMQS5z3DPsJKL5lnX9WLSF8MsQS53WjMeEKqs7skxwxzrhvGrm7b5p3EEyYR2asR6oapjXoy9Dj8q6ubeKY1yFizOtUzIQZNjNSwVfYQhOGu3qepICtY5ROSxJ2AgndiUzMWAptmDBo7FHMMPoVggJ6JRX9ICpZAxI8CJnYYRKj4YOWJGxBmIc1NwZULPuhJ0v8KheRCeHIWY5+BGRcTlI+/s8W1D5G6MU8Y9Z+6ErxD2SBeYYU63P9DMiT9D+n4p52Oox62ulUzAtozRbI8w4CITa1qAMLgYePpCWmGG+g1lxrLoV+VOhS9R1E2hS+t6DTvMFDJm7lCsl8YEny+oMEnmE/4wuBbQ6+I02TRlayQebRSSLFj6WY80WrsO4FHhIxsjxdPUWaQiVVjfRsEAixE2gAOzwdmcCJ9MVWCZQpMOQUtkQCI7Fh+Q4C7S/FE+np1RRlBtXm+uZ2dRUiTlIq/h206c7/RxCgmMGO2cCS5PE10pvuV1Kdcw7lx3rWqnJcxPXNLXIwooSjmAX4h7TPwA5oF2Pv3ijHNlBBr32lobO8wUfBHqaoV90gWMuXwvo7qUXCtlA3GCuyLUCsvnYh95XhWzh4x0uoVlPQbWMdPma/6Yp23OaRf/7916uba7t6V8AMfFJyHYzFgRsYcsTTrH4Egz9q6CAz39oc8+TIMrv3LqiHI/FptwqQviFL7Av/OV8EpKOQI5yr7y9i0wad9GQ67U3JDSizjwOPjizze8uaT7wx9qIYYGcpS+n3HGsJfmaibhBkxEfid+VhUNJaXEsn8yKLxNfJvClsmnBUHJXG6guFZG9tRwEz2WPbUcBM9Pqs03inkmQCh0ki8UmEGQtbSGbXdxWyk1n2XYXsRLZdT46LL3vaiu+LLF5FcuiqZSy0e4glR32GfWb7DR0E5gszoDhrENhRylGGXvRD5mNsjchxL3sdTHjfG6UkdtfQUcCMrITQUcBEp4ivl/IehFFZaG/KkV8FvM7xxWVJOcobW3DB3Lr3ADkrdMa4VTrcSn09yztdX4ylqDk6spiHzp1VchNMQE+m0w63QPGjJO4sbSOydCK2UnpkEUVsBfThVouUocBb3k4+S66xvIV8plxjUQvdhR0xVa61uBVKoixfMZ+SJstH4GspGILrfs5GR1/Z6O9qx7vCCcy54OiuGTiozGnbwAyCM9aTqbT3LjjG6kUq6XzLmpiUCW95O7FpGTOWtxCbmDEjuYX+RQQ/lDFPGTeXl5J3NTcol4+SNzY3CC2iEEuW2n40vMIW71HIEVIdLenf8MzdZRFazPl6jjdlYgHj7mZbIfuJq5JY+PSzpCzF/hgRmXSYp4gbGQnMQ+Sm1ghiKaGmH7Zk9tgh6NoIDMVEdFbiLiK7+xSUTqzlKGCm02o5CpippJ50Io9wTRR3lraRTnDpTZEflk516V2RH5ZKetltkf2lL5t1z1XCTmfbtpRQ01m2LTmqfX2NZjcw5IjfBJcidfsVGHJE1polCMMr51PVvBX9v8n0pa27rNtfLAz8gKo18E00oPX9h1QGagyH+QLsP/8D/Itqu6MoAAA=" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 000000000..fe295ef66 --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA829W5PcNrIu+l9a+1HTU8SFZPlNlmxvj5cv27JnxQnHxESpit3iqJosV7Ek9Uys/36CAMFKJDNB8KJ9zpMuBWR+xDXxITPxn7tz/ely99Uf/7n7UFaHu6/EZpslWry8q3ZPxd1Xd28+Va/r6qF8vHt5dz0f7766a55PxeWv/f/fv2+ejncv7/bH3eVSXO6+urv7n5dOWqq1THtZ//xnWzco6EVfBsh7eXfanYuq8eDclCQboXodh/Lwa3Gpjx+Lc4yie7/8iNL7Dh2juymqXdV8t2uivvHeK75Mc/GxqJq3zbnYPUWp9ssv0/1UXC67x+JtU5/jvhtVWKb9sGt28aph6RVa/L/q8LTwmtsWnqxV6NsE+gYrLaumOD/s9sXlr+634HwUG5X30upTUY1KetGVonH3gBgV+2N9KcZ1uGLzlOxOp6I6jGvpy81T81g0pshlXBMsOk/Zn9fi/Byrzi88T+GhOBZNYYV8/fy6jGhPqsrcYVLszjHDxBaboMTfzCzW74rmR7sEocmLfx6ZSozsX4vT8ZmTbH6cIff/tF0cQg0LzJXPI7/9PEP22+u7y/5cviveFO2fp6bGWzNbbqlxERY8Zmzw8JlNoR+5c2Dcw9oTAY1u0c37+jALVF91bURmpP5WPhWXZvd0moltIGRdlA/lsSnOl1ngbnUXYxqZVqFlARdaeUJBqRNnk0PNNP3u2ryvz+W/d01ZV5NB3OPqUyCNWZyRqxgFy6u7DNPIoODXcr/I9PW8q39qW/Z/76rDcXDS4oqtMvg4uVHDj8IeMLXRiQobJvbneIP74lo+RuILWDr0SRYjo7J4KpsobV3B2YqChwmoaPw8EVYUPlJATRGnCkKVP+K76WcKo9EIf1o6sgeyxkazhyu8x0aqur8VH1c5skSWVdmUu+N/n8sBFcKqR3XmYMCdB2c7tR4Ofp+0GH5XVMW53NO7r//j0uFBSBsbIAjd1L2M1xizh6Ha4cES2ukDMOJ2+DEk4U6lBg1RYt3uvYmc1scWLNPIl2bXXLEhO6L3vq8UrX68gbvSb+szs562v6y0nPaiIldTA4rnGYvX52LXFPgcxSi792uMKh7nOYtfru+O5eX9JASwzlIMI4c2Dkb0MS2IBBpnriBYvymLgCgWHFn+HkYyYJzIFwH2i0LLKGWNG1Zv2MgJqw7OpGjl95GTC9a2qPlV4pfdY1lRG8Lth6VrBJI0tkQARFzfXc+XwT5Ka7nvy44pG5mRxxLa90GVruh0jbhzOjLwcj0231TNGW+Q+OdJRlU3WHiOdlhgrnxqc8c/L5JNNQ5ZZqXtjhAaufEhyOHlH94NROq/96pOgBK3Ic2FsyqWotrXh+LwZtfsJuPx666I6XwerEgRaLpai3DgyfGtoUMRFvufS4c/kDI23jsUAYbrz+vuSGIFv0xaFX6uip8fSIngl0kSf91VjwUpEfwyXeLr9uR9Hm65/o9LO4uQNtZpCB3H1Z9r7PvA67rvSscoHHP6qOO1mrLzdPIW0uuw3WF/Xs9aAvLibaYO49SNJaQ1Zk8Z1A935cfd8Trlw+9dhbnaScvqZ2Mi47M6/GlpZw5kjXWkh4tjGOpz88u5PhXnhrQICX33qM648pEObOW9Kc/Fnjg5BEHASotRUEY5qz1slk/QSh4/WLUjB5Cw3sFaVJyfysulHeh1dSip4UsVWbwmcTJH1yUKL9Osp5Y/2ZNH0RH1937VeChTGvztvg60i/l1kiVwq3v57ryrGtZlgy+4XreSkuM7d/AFE7024oBEuG0EBM3w24iENeK4sQBTkASMRhfJCc7GebpV/LX481pcmu9ntiQjaWW8LVn7zedTeS74tTMI0xewMrrHtnRx+HbqOuDAefW/DLbfsCE+DdpvvG2+FNnX2CCahuxr3jaaP9qKY/FIXGbEjjVQfXVkQ05/IjYoYGV0l+B+G8Tlqq6MaD9ucgVhefWXYxszKGhWlyk113TplukY42VQdEXzhZY9wYAZfsd8EyYIZpoRMxS1zIwJQ4s3ZKbjijVlxhBON2amYo3ZgMMop23BM/GFNuEoeHHb8Ex0oY04Cl3cVjwVXdSWF8Y3cdObinBk2wtji974pqKK2frC0KZtfhH4xjel0Q3QLzd/C/xYf+AjLgIlV90ACdGT9j/0EUu2Px7K1N0PSVq6+QWATdn7JqKK3/qC+ObsfJOQgtO3MQ1Dp/ggVlLQCmhHJ2HEjAfFpk34c93U+/p4sdGj13NgxgeKLp7yY7JH53zoO6ZO+kgwMbM+JGrOtI+FNjbvl+AKT/x4hLEzfz7WQ/FgvMKHZlEsSk/CGvi4CfhmDOqtwFqTDUmMnWIAKbfidiUn6b0HtWIBjK38jLvrGJBRj9fJSIzeaShclZUQXJrzdd9cB2kORlDAavORLB6UNxyd8L8k0wGBjxmfj78Fesz8ttYsvAmLnYAW2vgn/Ho9Fm+LgXen/+tanwHFxX6IA8gM2f9VVPvzM3mq5ZXe/9OrFQVgZOr8r92ePCOGQNyqrILgXB8nNPz9P7vyq+i+lP+epLsrP1P3siFntcevET6Me/utnOFTThqGHpB7W3k6mDFjbPd5ASZTeQ1M7KnCuIGQnoZUkdVOEVhm9OkB4p1n3HC6480bT0J8U/fWJ3Na5MrNOy4G0omQZRZoodzsiRLT4tD7PYLxOBsWWBx7TkscjTofIuXCII+P9bls3mMn1rDie1gtFkJc9G4XWvn3Yk+kOgiDYiSshO9D8fwNZ1qMAMNV5yMauFAX+/p8uLwxOZHomUUVmeambQUEJi9RYrYGauIOfl8mnYqQoQvN0fNrsTsEmwkUWOzWTkscdW0fIp0RJR1WHhkpTQiJu7UaLA4jcCLix2OwBDo9MHL7n+cMqPFEVnzBlQbY3FRWgS+YSK/GAYkgVwOCZlCrkbBGiNUFmIK0ajS6SFJ1Ns4HMmwoDl1fdzmmsQkWXLYn5bQa0xRYKxYkSuokmGQmY4sFKrTSQkFJjVwkMOp5C0QAQPzigIXMXxhCcOIWhWlYmHNmBJrRk+YiPL/smvfzMXW1V8R1LvblqRxmV4oABauuiOiyf1884RjeCDh9vTV7zdQeXHnH9Nit5op42vzJwzC9CDi3iiujeTukNyPhvA0RnXPxMDli4iCNpouZuSrGmCbh9XGaWTJxjDPXfDGDfPSqb3Y/crl2IntyPO3O7BH/bX1+2s1YLr26yzCFzJ2g6QZLhA0d/+RbVE0bSXeT+nCt7BXNX+HPk2y0V/um/Fj8ZpLwv35f7D/YnCUIOFNqqZUWEjtmpnHAOTvtAitMx3E/EDAJ1iiL0OxKbCXFoOorLkUjbrklXx2P9adXx+Nvw4ccOi1/HRYJDgWd3Abcvq7sFTY4CYyIfeHXYT51iBqOepA7kxkKYyBiB0AQB0jfRTQvyDYV2bIxH8ZLjf0m8lvgkIHWkGvH1+UhHvq+fjpdmyIk54VXhgba/sZoOO3Ol7B8UGKy9A7bm93jL+9el4dvz/XT188NcL7gvoaqsYZ2lLQ3Rv3ISyi+/tgpDRSOz2FfBRxgkA8f6IA/xg85093jsl64ckFjwQLjuscYtBGq+oLzdTmau3jTBSdGqKXqTEOQikTxCal4zVQKquZy+Et5+UtZvS9aO+kwXf+lfKyK4VAcqu8LrqndtmZ0s3+Bb9+17mG/7J6P9W643NGtgKosQwTHY1P/7e3PP0Wg6Asu1M1fttEpZYgSK5GPkxPMUGAXHWfZxCdTz7ITMrCEuHUWTxypPgFFe/oksuuO4QDV1kJy4pJ4jmHxKq6FBi2NcUiIZXJhmzjHrKFH4Gir+FVXGy8ulN8ExUwdNbjyAlTwhPBm8KobMOX7H+MtHu51Al9U+G2CGybO2OGS9yIt4ZS9o2pOV/KAg5TYUjNVPBYxKmypmSrs42ERWvqCs3uFeVts0Cuhx8VoNeipTFfml2tDcknDAkv3W0bi2HZLIJ1GsYf1jtPrRP1RkrGvYzKPhpq3L7Ba8/oSo5v3hnRm85J6JzTvrX7ETQr5fGgEkpFnRGOwgPPumyEUZzrffopf+ZuaZiOQrBe3cqHPCD1M09Q/v/tXsR/SakNVfcG5uh5YlgUrexhlV+K0RX6bV3SuvsP1ZBLnFfFj4QVdZwKCWFoHK45hd0iF3pD3Tfaiuj4ZTeOvYSS3Jay7PXx12RfVoaweQ+JeEIVZ7IOHMQY628uieKVe6Tla+9u1uG8liy/SG/m9dPlozYMdsDiXH4vDL+fy464p/vbpA16s8e+L9z9S4Oj2N4DJ+X7UdfND8TxwbwiqvYe1IgGMHoFMSZMw833xNKkV7onKa6MifHZiMQUddmYh6sv/UGC/uQhQqPZ8XMBi+N8HCMWt0+Z/4+0Ei474tKG8F0RZ+kMssrBGkyQ2TiEoGqcvdk8DqmK2M6zm9k0/FM9vuMlkF0iiROz+9qZ3YLhECn3hV6G/hsJMr/4dAfO6rpriM96tWQzDaivh8JaFSBDB9SAagfltF90Lt+Kz9MLDwadqaJB9CqdUiLmQcjLG7qFa/VHsz1BwmPTh5Z7O9b64XLBbzUDBoNxkTR93x7KlgRnvgF7ToNxsTR3Y76umeDyXzXANHOgkasRoR2PodbvIMd/ofguvSiiK9013IjcuEG0Su6+Lb+ybLqMqXoxVZ7+v/4oZhxgMIuoUQ6pETfuN9+QM0Gd+WMVXxhMWi9ziYnqwbepRNYfgpMLyh43yGirpTgvgp9hd8BXwd/vbp8uPbQ6p4TEEC37BVgt/kQE9iuPmK/i6PPxYXp52zR5vTWFInIQV0JV19WN9Ln57v6t+roq37sr3p7p5ez2d6jP01o2AGiduCe4+Vs/+46e6+fkTvLoKgeTrroLop7r5zuXpfOXf9kehIuvPRfa694pqy+wndWi47nJEP16PTfl+d3k/ExVXfy6yN+XhRxPlMgkPV2sBilZSc45ZsVDhZTr/3toPkSpd2QUafy0u9fHajvhvd+UxrqWJOnMRfHMQWifb7ytjNkGiiNNP1ZitvX2d+5unsmmKs2U922XoVCDbgIUyVn0RrltUH3gA/veqfDodi6eiipkV8XLmIjUvK++Of/t0+XtxLh/K4vxd0fTH/5/q5tv6Wo0DjRazHs5uAPXb4gyMhIjZ+Nq9xtuAzP/YVzIi2m+s+sq4Ym250eor47L5SWe31636eri+d/f40dZmnIz1ENqNcwG8gYD1sN3MsG/rMzruxwOkpXwJlNHGZqSQlefHT3Xz/xSNjSeYO0mQjLkIDTX7xqP/u/V0FFiw6lw8bl1/7pfz36uLsyRfnz+OoooQMBfb99Wh+Nx9on2h8e/te46/wXswDla47nqI3lKvKsaDehvzwOI0XFDk99WPxVN9noaMEbAIW7f1mb/v3h2LaU0WqL1g3L8pWs7ol+OurKxHROdkHjsfo0TMxdfxqN8VjRsvEYiYSnMx/NJFHU0/vYdqLkUz7+Q+Vns2KpS0/jv3Dkm0YREjYS10P9XNqze0P3EsPFLEWvjMe5jdPdz3h1fVIXCVNg51TNqqqO0d2i/n+n35ro0I+bYsjgd8AxeJmZW1FuLfqz6wauYwoCSsgK57acGu91jnFJBjglbDChvC/s90mKSM2Qh7t4e3Jjji96rdMn+r3xSH6754NchiyaKMlvNlkPqOR/NQjrghzUB4M22v54jDRISA+djsYubfKuy7M1V3UxkBME7KF0DZ5j6+RHNlEwStivX7al+f28fH3wxTe0zCSgv6Mlj7TW8hVCjnyyCdtsFPEbUq3jfOe7kN7vp1kBJrEmBW1sotbA9zfrKsiS3ri/gS+KIO8xECVsX2Y2t2l9Vj10H1+bBsmQrKWxn559ZPJfYIGydjXYRltRwhlrEyQmM0LlxDCSlfAiV+hGQOxpuMVRH+Yuofi8tlxdV+XOiq39DaQF4o8CSwoPYXaFm3hrx2DlZl9fiq2heX1knn/Q48pzGjhWOEr/tN3X8uW2kJKauiNBHS/1027+trM39cEFJWRdnKdHN7ma3CSFqK9vZKRn+Z/O/4tuRqr47KHi+67//5YT7AoaAvhPXnhxlnvzhZqyPuB9TPD1bhfMCUqPXx2m3SGnCT7NYoUevhNcvLonEwlLAeus4ALi7tlvKmODXvv/m8L4rDLKBBYStiro/Fm9qQDN98Li/Nq+a78mNRTTJjYqWthxrSijNgouqLcZlBNQ8TVXUunv6VF/OGzE+1O5z90D890/pLxFggUyQtRtsm2fC25kjHxQgBC7GZzrGRw/ZVrT6qtr1Jjj3oTRS2BmZzJ7gS5HFZCxEP3VJe19XBvL9pPQad/dvdGcWinyH3/8qX/Fr8eY1yApwrdfWvsFPMrVnmIi/6Enim0NW/wWaAOve+syt/Taz41b/Lvwpe/iGsvC+D/Ke6ZzkWYvYlfRm0TsFKzUyI+7K4W0NsZexI5JfBH8n1RwpZbLH4Mfi/V2+nXZ3Gy1mI1B16O3bLD3YuHp9iyJNJohbiRfHqODJ7Mn09W+xK39HODUbb1EVvmsg1bEhr8vUUmbUuOv/Eshj3/5kmayFi+7hecz1XhXWEO0UwmOG6KyBacKrhqy/EtTwIaYKgtbCuNBYnyFuK3OadYGbqtO0sUtZCxH/v0hz0+Q18V8hX1eH7g+F0impC6MtC4Wt/0y0eozpYt6XFXxIUuRC/ebPmVdO0+aJd2JBRSoWBx37BVKFf6hvmRe7PlfqlvqKzizrv+Gjn/9liV/mO+dtSoP4ayCw95lY2P212DDK6/nrIWge3V9XhjX1S7sdrc90dj8/ffN4fr5eYCKw5EtdF/7q14Q8u64vT93217AvGpa73Ff1tru/1vsanTBC9xve4Tp+z9g3rroXI9OBcSKjyGpi+KxrzDvv3h9+rQ/FQVsUhMiQzVspKKL+vyqbcHc0/o3094mSsgfD7p6drA2PMXr/fVY8Tl/6AkDUwzl/5v8Sa38lsx/X31S/n4mNZX6PPGkEJK6LrsnUtB8kJWrklUVLlia04ll55DqqpVAxTd83xP+l8SNZcA43J3/SqOtgA+1l7AitiDXztZH91MSp+rz5U9adqxsYQELIGxsF5EVj7s1o0UuAXwT77mile3JfF/VPdfF/ZPeIt92bXsk8Ja/giX/fm9nzzOv1CC/wi2DtvkvZOe6YhHC3yi+C3P7ZG5QTnnzkS56K3G0KnpT7bf0Zbp2O1V0HVkQgxFBZfbzaSYn8SOv2Q2LRUccnamEpzMfQvwsW65xAV5ur+/XwEnuU/tcF7x6hBHKi4Lpb2tDETTVd1AZ5+xE9rGbramjhiW4WrOAmLl1G2z131026QYh3/bGD42gL58WKEveiLsl/gAwzlIInTCAov0Qli46PU+uUXaXbOpnF6QeklWrtdLkrnrexkjd7Y7FKGkgPz9lvsqOz9hUeFvYBF2U8A6Gh9foZ4XtlopvgxTd9RcXVYzXfhwLlRHXRii4GWsbQVY3r856lZPa7YbD3tjfy4mq7UAi1/XotLRLvdCi7QRSf1GKoaS9wxpsmYuuOKXLHZet74Tzuyit6MvOw4rql3JRhXBotO1AcS3Ft6bpiSvvv/4JrmvYDwbncpUvX7+fgb8z4dlPiCKE1/g8M3rpV5z41TO/Km25jeFvRv9ddO3ojaYeklWlG66ZDKkWTTcfqiWhYVnaWvNrWjBhAuOkvfxbROdDdSxZfpHf9OXDRWX+zTE56ymJcnhqq85cSY0dAO6BW5X+KXlFMbIjIi6IUrxKDt8TA6mOdzkJKRR3RILalI1OCR9zFFT8RjN83l8Jfy8peyel+cu4CSKZrRM+GMYuJd8IV6dz5pzujdDVnxFb6XZGADX87yqZOx+O+n/u3tzz+N6e9LLdHqP6vYl+meJu8h2Fft8M/BGRnxqCIpb+xNxQFGsKB4L9mYtK8TNN73NeIUjzwRiKZPhH5iKi3Q360IPTc3BQlRdzamwSLvH5D8wW1+W2ehv4mKWuotqjmLPVAUtdwPNE1Z8IGyeUv+iPbgog+Uz1r2R3QHF36ge9bSH/HdEYs/aoEFy39wvAU3AIBh1hYw1ExtAjaAMLANwALrbAQDiXFbgYd0+mLMaY1bjr3a4QX5wTj5RzamA3GrtBKKwLbIgojaGCdgiNqaWDQTN6cRXIPtacik+NOv/32dbcoXF7VV3RDO2a6Qwqgti9Q4ZdtCSudtXREogtsXAjFrC4vAENzGEIZZW1lkO0RsZ0SLLNjSRsdlcFtDWGZtbTQCanvrS4a2OFxonW2OlBq31Q1QT9/uQtrjtryBhBUW+yCqiQv+RHyhbTkIK25rjkDjs+qdsxBFuHU/xW88u+IidPq6OXeVx4S+ICqwbJ4DOqa7y9oTr/tWYa7uYl8Wl94rJvbjuVrroIhtBq7WFBT+ZlBevjm1EZrn3fGH4rl9WfNcXC7Eg8wYSqDiBDQTGGVPeySpPFRITScuGz9RIvY6/pUbr5EiX8AKY59zw0s7qHiDJBbAoNYcFIP9tC/9fXW6Nngd9X9dvIMS4ka3TgSQ2Qd2gxEyqvJ+N/o2A64d3otKG27ThTL+vfDmyTgcpvoayD4UzxOA2NIr6UUVBjt1GAdReyYuPPB/GAhHyIYFlg5/RuLYDCCQMs19QEH9k/TfE7VjAY0Mg5N7qhVkWYmC5FdcG81MLOsh4RatESTj61YUEmC4Qh/ywc4Of1zKmgxkjVAmHrBpfMlQ1QhZEq/r23P9FK2vKzxf52MfbBqh81b4L2KR1vICo0cjNPsVFmp/LJpXNBFDfvJIkFV8z4Lwp+gO9ussRYCifaJRDOstav2JnT+sMV/7R/NM6jd/XnfHsnn++QFHCZeE88wQUZyUZSPUdDxkH8KDFBSfpjeOqx0qpYja6foYRnSojqBDp2sb5T6HeoPE53QE9SeKhB6qdeUW62KDB0d0R4cExmEpL2YNOXzd51OKWvWJSkv7P6r5R9hORptvf02YwLvZszeCQx+qIwj0qboKawG+fX56Kppzub9ZhND25SGM1Z+PrO26yB5erKeLxo5Udyv9f91e+//SWluo25pf7SLQCbXVoi24cQkLrCrHQ5pXsaNMB6LKfP193O2ERZWqMxGBT3Z4SRTIKzOixFK6gxM5xndQYJkF/Dx4tSdK9f159I0eSsIIrYATf8RBOY3l/JiPxHt2Yxqa4Bsb8xF5T0FNQxR8/2k6ooufFCUOyyWcD2U6inMXnj99+Lpqq/WQqTpMhhzZSYPaa+E67JqpvdRVWRPB63Jqi9xqrYnDe/4rHkjw3a9ZSFxGj+lgQM218Iz4KIyBinZQmDGr3BMnU+cTqLdmr/0yEw+uu+aYRm9Fx4/qkbehZ+wJlN/N6J4QfwyNbBMvmfHUdsGV10K1u5GclmmMNSD7SwtKwFroiuBN3hi0Ye3V5v8t64LpkOkbKyVgATp8MHjdX1HQx4LB70sPBbTAsSPBEGbQoOqS2CGeNALAPV0/EtR0UyYMJmjITNXObUVhCOMb0VQcI5t1GE70Vj2jb9jNcbSTIrbGqXjIrSgMZGQjmtwioW1opEniNqGpiEa3oDCqCRvQVGTh7ScMK3bzmTzf+SP3yJSPOXBHoElB+3wu9tem+L1q3yN/9c48StRjerhW5inay1+pYmF3PuDC8LdPQ2rvb5/C+xWmbX8oh5Stk/Gi/51ukVY/L9mOuDcj8mGpyVrshSd/cdwrGhacrOtQtNkAfjnuysqmfuBurnqlgRqTtRefm/Nu3wRb0yszWQO8UueH1QtcbJGeODWRWmK9dm86Itx18YcMHOp+3DXFudxhChT8soILnScqwneuB8X7KFJuaZSa+w9jnmh9rVG/yF92Jd7fA1q70jP0zm9Up7eT+Rfe5XgIoMcc9MH726cPM6HcQwFTQY3unOYNvSXgoITl6PBM+4UDePthZNtD8pjO6P8/ehPGRy63zHT/H78Zf+wS2f7t0nmj7oIyX5Dl6ZZ3GMc267BCWGyuntfEBoaVhDjkEQ37+qktOqrFKzdPk/WDgw/5jKgkKyzQzZs9hN5x02e8734qPhWXJma8vyBKz9X68/EwQSsuPUtreWnBj8yGW6GZOlqoozpcoZk6Rr2bkLpox6a4efgjR3yEJiVRaRYGtz72Q/+tMfZGJ0ywXiySWGMUNcC4QTpURWxGZFoy8NtSl3YsasSjHaKa5tA+UDTiz85oinMmHSibGvQfpZ1x9hsonxjsH6WbcWsd6J4Y5B/93UGPT7IFZgX3R4w3xilxgGFiUD+n2Tc+QSn6CmJYYOkhkpE4dpYkkIY57tflIfJjEL/dVYyFMYdLHgEyQiZPxjDC+sc1S/QuGMSFB+DvVfvWja34a3E64rCwwe/hDUMP8sK/bWqwzZYu83j/1eb3+F2oPhVVlLQXXclgU1lw3EZ0rC9xyF+4ovOVQeI8qCrEkscoeiwiFT0GUpbHKPrTS5UXVPVnMJ94jLKDn6w6qO0QTlgdNzSK3Tl2aNii05Qx8wjvEYzmmJ1isEgC4jJC7Iu+yviHEfsFMFR/QZf8g50YF1hqspLyRuzWAchpxiutcsSCjdXZPmdO3laGteNqgZjFaV/f3ouBGjgLf0ybsCKW4evPc/v6FNtJuM7/L/pqOQ7nYx8LAJSfrjnu0EVrnnryisfBHL9oGBPPYPEomINYqBu+UFsEj2R8q8w6l8WOU+ZwRqOZeEILYkB3BKgofVZjSi09sIXEjp3aOODzDioRSOJPK5ywcVelbz6fynMxpfWhu9Kt9qq4ijZT2skj/yfg8mqvieuxLVocfqtnoIJ1vwCmr/FZcwKmr/njwiJM3w5yFk0A9W2ArJ07qrpdf9aYutVdExNwyu3ssoEDQQw8RsyaSC+emRcP7TLJ1ItMXVxXh3LqptHnMIaVV20hihyLaqIwQxaPhj4IRpwZuiIrHgahxPjjoIM6+0DoqY0/EhJ6J5vZnuoFhvYolnFT24My39geRTJubntI5hvcUW0Sa3IPWmep0T0yasfNbg/RfMObwsGa3l3hUePbL7ei+U0InmCAI/iLTXAezSwjHIlbwdwNAJxo8E7CFmHyBpBNMnrn4AqZveO44gzfObiCpu84sEjjdxKyEQMuACrahJuEJ8aIC4CaZsZNa6kRQy7UVNGm3CgizpjznkYlN5O2xKqmXC9wiiVncC4w5G5Kp9hxIa1RPC1UPImoHeqeYULedC+yIMNIYgzIG5Al9mMYR4z5iDvjS7VHvPHot8xy2zE0YmNMxxueJZbjAEXAcGzLRtiNoNiqZiOWO8lqhNhXMBoZLDNtRihtYTR4FMoJIeEzcY5vpRy2KTtpGA/cSG1Uww/FM+OYjwsEB26sMyopNMordYA3KvAorDcceBSrcZhvOqx1PNF0QPN4xj9aaTDrX+hLvSFjY1iHsXv9L/G2lsmLXryqDt9XJnDRRMV4yRDH1LyIE8F9svuWOYPYgxE3eofqyKZ9XVcP5SPlQT4sstiwpSWOWbZDqBNNW0btmG0b1BtpYDKqJ1uYE7BwJiYDZaqNOQEJZ2QySKZamRPbJGxmBlpnnp0ZPWo5Q5NBNNXSDOPAIYm4MGNrcuUWG5tBwaPWJgt/prkZg2aCvcmKG+MoH8yjMkOKMgqfV31dZLSJGYVqzMaciWjcOI9CN8U6n4CU2oDpl7j9n1fbeKPf40bwZm648a9yx+mr2lxxx/Lfxbfm2b8oxcM6SxAEeCxCdwSJxWqdaGAseJM8FsOYYTH/ZfJYBGMGxfz3yae0QZwhscYr5XFjcsyAmP9WeUA/YzgEXiwny6xmMEx+t5yGvNBQWP5eNi0qvOk9+KthLKaHKQviGgbB3Ffe5yCJNwRYVHOMgPiHzrtEj4Np2/3/FGKDftMUCnpxGHnC1KFhg987yuGH4vlN/8Ccl5mcVBustzKS3y9l9fimzyh7QY/nTcTHSvsSqN3waf9jBdikuC+Ju0sZviJ0LPFLoLcZZtYYJ1jSLLSWXbxRo2MTelB6llYXFvSq2heXpj7/UDy/qg5visu+qIZfe/lx1+xH5vxMibPQPxbNL6ZoN15MKsOHYf57Euh45VmYxg4pHobY08n4SP9YnJsYjbjoolHjR3P9WjwUbf1yd/y+aorHc9mMjOJJcmYhvbyvr8eDW1Zescc3DxZfaRYGa2h9X+2P10Nx6dPMxlgAL0brroDo9+q0ABNZOxZV7BUIvRqPPyoUNr7e+NHWSJn9dSn3MhQW91hqh20a80Ioi3sudURb5OtLnt6Jzy+FEUS/vwQhTH6AaYhh0puNUPdUEiYSQfhdPQhgIgUTqT/8iuSw8b/E98c8sohbYhb9EjUyw28BQhwTyRdeO/kqmC1HUy9UkaXMCysz8mEwHy9zig+/rMTqjn5ayZewKPnNKKapD9RMwTb+MhePa8rTXFMwhd5h4dHEPcQyBUfMSyw8nmlPsYzhGpogvxb8Itb+tpL50YuKMz4Mqlmmx01RnOER0hS96d+UTt7ysf5JG/5N78ztPqw9vNnflM/b6sO6wxs9bvD1vztmk/dbYMkWHxqF4Q3+hmHe9j7QTG7ubang1g4KrLSxY4mR2zpEOuW6Iqx17K6CqL3GZs6hmbqVx+MKbZocmrgtMx5D7HNXHJ7pr11NwDZq6LCoJpg58XhijAsO0TTTIoxpaFi8vb5rQxPfsZtXX2AlE8OXF2dn3EDOMjaQyjiLY1RntNmB1E+2PUgkkwwQhGCmFRKBI2yKIBjz7JEIFGGjhOyOL9QWMeYJ0SpLbJTRcRs2VBCaedYKjYE0WfqiQbsFl1rJeCHFRlowA+CLTIgQksl2xEDYDL+QGFxx1tZENCHTJogmzr6ZiGbckAhimmJNTEQWY1IEsU2zKyLQAePibbE/CZ1+SAbLTP9LvDnhbv+oy25f3Au/KP1BN2yc+WICdn4onn+r4TM5jMpB6bla+zv6OLWD4ou+9m+fPvxWf/3cEJc25Pd65Zd98QTVRIWZuskQNaQuGJs2qsE+vDc6YF2pmVoei6o423HgvTHGqBsWX0fvr7tPE1XbGrO1d1F1EUsCKrtUY8TURGVnauw8d2I/c1h8mV7ev4hWPO5hFKn59fuy9amYpn5YKR5DrG8BUhzjXUB+Msh1jkKcQR7yiNjmQHgxLWgkrnhqNDGjZDyMeELwMKMjvDJj8cAsqc/Nm/Jc7L0oqaK6Pl3+6v0WbvhbB1p3tUNZPY5Ke+GVZaB7+EiNr+IVvpqvD5hy7aljMBfa/4w34C7Hohi+gNXLeOF+p0EaAIzkp7Iqn3bHtyMKULHpetq3+a7ntiD/otdNHV16ulZLVMVoHJacq+3nh4dLEfWVXPnpmp3VHqOVKhulMXaZBx8YscIjJXDitF7h5j2I/yo+FseBHv/n4GSKhU6IjPoIhJTZAfYmcDFWqS26RN+7Y73/cPGe0wnp9IpP1Ms/uRPSGHxxJ06X/+ZOsEmDT+7EaYOP7oR0hd7cidP0SLzCR2kKPboTpwm9hBNSNvIQTmyPwadwwj0WegmHnwNgCfnmY1E1/1U/0iuI9+sqC8hQYtT64cNkpvP1WB6+3bVyhjY9odcvvkBv2fqVxmh0BafpGl86CFXBlSNKE71wUP0XXDcidVFDntQVGvFRunanU1ENr0oIZX3JBdrMQ1ym5JB7IlT6xRfofSyaeK2w8AKddvWzkr5+pt6JJnRTlSbOxeEbrQGjaFAi/pDx7loeD2RccVj4C6oi/Y1D/NOXWAbEhAdwZ1tqvOqQsRatNWCvcS0/brJFa6eXeUZxeKkP6Rxf7hmV0c8zzlj2uY6NfqVxsi3HaIx9Q3F8UY7VGP+U4hwrklE64UXFyfY4ozL2GcwZGzk7emIfchy1YL95KpumOL9tzsVumI1wWGQ9W3YoNt6g9VFz1BbrPsXphzWWauftTULxuNEZpTNgeVKtPW5+RmktnsrhXOGUdoVn6Rwk1b3U1Q7drnf/u9QJBYqJyJBrgHDOACV2viSE3x8C9psrH3Y68K8ZeE0jGUxjdXlXmkFtwdtMVt+8TnL6Onl/SSIV9zg5X5PBBWM8hPvT6I0jDWbU/8Vduc8CBWuviIrLWTxANJ6imBmI8AKkuDQtW/OdvcCmKGNcIv7U4m7F8UITFv1iWI2hpwfYx3CMJ3wdg0RJWBsdnQ0vFtn/CRqNk1F1HlL/3XpDTsWE6q7cTl3S4T7ifhbEMWErYW7TaiyBSdRft39njTlUd11EvO9+HKq3o6boXGRMxoQ4WG/Cx6vps2H8ob3xZTb2be4l6OgnsuOxhR05l7Ub+abNlGbrBKyEzVKS3xHUxAgmWHFVLLOWB7/qqnhmLw7D6ivh6jiDOb3mV10Jj0vYs/O8gSIR4cpfAtNbFwqyCByUshDleVcd6qde4NvmDB2RRsBxldfBNAfKqghoD+YggLAP80T9r9/V57fvd0Kn1N1OEAeuugqe7+O3MlhhFd0BR6IQggifolgc1jnqTXn4tbjUx2s7D38tLtdjdJuEBKy01rwpD60z9ryTJ648HVO0QxbTQDHeWUP1/3jZXRV99Z/WRb81Tu6+uhP38n579/LuoSyOh8vdV39YYC/v9vXTUyvrH91vfy9ahW0JW+Svm7uXf2xepvJ+u03+8Y+Xf7ga5gfzH6ZYcvfyj+SlyO7zXHjFEq+YuHv5h6CkCa+YvHv5h3yp8/s8l14x6RVTdy//UFQx5RXTdy//0FQx7RVL717+kVLFUq9Ydvfyj4wqlnnFcq5Y7hXb3r38I3+p0vtUaa/Y1m/etrW3L5W61xK1L+oH0xEbSnHid0XSNnmSkCX93kjaVk8EWdLvkKRt+ITsucTvk6Rt+0S9VNt7KXK/pN8tSdv8iaYGTeL3TNL2QJKSJf3OSdpOSDKypN8/SdsPSU6W9LtItB2RbMnB7feRYCeLQLPFTJfNS5Xd59vML+l3kWj7QSRkSb+LRNsPQryU6b3KUr+k30Wi7QchX2p9r5OtX9LvItH2g1Dkp/tdJDL20/0eEm03CE0q93tItN0gUrKk30Oy7QZB9rr0e0i2/SDIXpd+F0nBfZBES5rkFivpd5A0HbSlvkf6HSTbXpDkXJd+B8mUW2ak3z8y49YZ6fePbDtBJmQL+f0jt2wL+d2j2j6Q4qXc3iuh/PXc7x7V9oGUlHLld49qO0GSI1P5/aPMnkMuMwrtOor7IOX3j9LsyFR+/6iUHe3K7yDVdoMk1zjl95DKWZh+B6m2GyQ5LZTfQ9r0EDkttN9Dml3itN9B2nQQOdq130HaTKDNSy3vNxt/EGu/gzS/xGlkGbTdoMhRrP0e0m03KNJ00X4PaXYKab+DNNtB2u8g3faCIndV7XdQuuFEpn7/pG0vKEU1Zup3UNr2giLNp9TvoNR0EDk0U7+DUmO4kSMu9TsoNR1EjrgUWW+mg8jtN/U7KGX3oNTvoLTtBk2ur6nfQ+mWXbpSv4eyth80OeIyv4uyth80OeIyv4uyth+0pGypzO+iTHKfnvk9lLXdoMl1M/N7KDPWNbluZn4PZW03aHJ8ZMjEbvtBk+Mj87soY+dQ5vdQ1naDJgdS5vdQbnqIHEi530N52w0peTjK/R7KWSsh9zsol+yQy/0eyttuSMmBlPs9lLfdkJIDKfd7KE9ZmH4H5W0vpOQGnKNjUNsNKWn35H4P5Vt2ocn9Htpu2MVr6/fQ1vQQOTi3fg9t2R7a+j20bbshJUfx1u+hrekhchRv/R7amh4iB+fW76Et20Nbv4e2GXt02Po9tM3Zo8MWnVW37L66xcfVth/SLXkQ3KAT66btiYw+sm7QmXXTdkaWUF1vf4Nl2+7IBF0WnVs3bYdkki6LTq6btksyckjb32DZtlcyTctFp9eNYRZSuiw6v24MvZDRZdEJdtP2TUYfYTeo3wybkJGLXzJgGnjOB1MNCX+QTTDZkPBH2QTTDQlv6SWYcDC0AjN0MOVgiAVm6GDSwVALzNDBtIMhF5jhgIkHQy8wwwFRD4khGJjhgMiHxHAMOblrJQJTRG3f5OQmkyAGIhGsbZEgCiKxHAQ9HBAJkVgWgh4OiIZILA9BDwdERCSGb8gFSUAhLiIxjENObncJYiMSwznkpOWUID4ikay5niBCIrGMBN1kiJJIDPPANJnE1J7kmwwRE4mhH3Jyh04QNZEYAiKnuThETiSS3dQSRE8khoXI6YGOGIrE8BB5TpdFvWaoiJxe9xBNkRgyYktPIERUJIpfIxFTkRg+YkvPNcRVJIqfawozsm3HbEnrL0F8RWJYCUYs6jNDS2wZphd1miEmtvSUQKRFYriJLc32It4iMezElh5jiLlIND/VEHWRGIZiS5PDiL1IDEexpfdWxF8khqXY0mMMMRiJZjmmRGMiXfNTApEYiaEqkg09dhGPkRi6ItnQIxJxGYklMzb0OEN8RmJYi2RDL6iI0kh4TiNBpEaS2ssP9VJv7rfbLSqMus6wF8mGXs4QtZEYAiPZ0GMNsRuJ4TCSDT2CEMGRGBoj2dBDKMVXIbb/6DGEaI7E8hwJ3dmI6kgMoZEkdGcjtiNJWUo3QXRHYkgNmtlMEOGRGFqD5ksTRHkkmb29oscbYj0SS3sk9HhDzEeS8VMPUR+JITiYTRmRH4mhOJhNOcP3WBm/KSMCJDE8B03+JIgDSQzTkST0SoxokMSQHQlz8YaYkMTwHQlz94bIkIRnQxJEhySG9GBaGBEiiaE9mBZGlEiSBxZNRIoklhVJMnJcImIkye2ky8lVBXEjSW4nHX1MRvRIYkiQRNDTGTEkieFBEkHf7iKSJDFUSCLo4w7iSZItT9gniCpJtgHjEpEliaFEGGsN0SWJIUXoq4AEESaJZUwEbakg0iQx1Egi6LM94k0Sw44kgp4giDpJtrb36AmC2BOxYbc8gcgTsbF9Rw5OgdgTYRiShL7XFIg+ERt7689caKNL5Y29+N+8lNl9rjBmdK9sSBIWM7paNiwJ2XsCEShik4Xkovtlw5Ik9A2mQBSKMDRJImnPFcShCMOTJPT1pEAkirAkCn1DKRCNIqzLBn1JKRCPIqzXBtMliEgRneMGOTwFYlKE9d2Q2UuV3Es0/wSiUoR135D5S7W53ySoBxGXIqwHR7u6DA04gcgUYQgT+tJFIDJFWDcOtXkp5b1WyO0BO3JYTw6VkN+HfTmsM4cSdGHsz2E6UEm6MOpAS6goemhgrw7BWi0Cu3VYRoX2AMGOHYY1oa0LgV07rG8HzeAL7N5haBP6TlNgBw8R6jzEqQjLqaiUhIxYFSFt52V0YdR5hjohHcQEYlWEYU5IfwuBSBVhiBPyulggTkVI6zNF7pECkSrCkiqKnkqIVhGGOknaeyeqMOo6w53QrlsC8SrCOn/Q950CEStC8dse4lWECpgsAjErwrAnCX2VKhC1InhqRSBqRVhHEA4E6jzLrWh6xCN2Rag0VBh1nrKdR68TiF8R1iuEvq8ViGARyvYevSsghkVYhoW+tRWIYxHWP4S+jxWIZBFaBHYyxLIILQOrEKJZhKVZ6MtegYgWYciUhL7vFYhpEZZpoe9nBWJahGVa6CtagZgWYZkW+vJVIKZFaPakLhDPIizPkjJefKj/LNOS0q2MmBZhmRb6zlQgpkVYpoW+NhWIaRGWaaFvTgViWoRlWlLy6CIQ0yIs00LfSgrEtAjLtDADFDEtwjItGT0yENMiLNOS0SMDcS3C8ClJRo8MRLaILOFPtQKxLcKyLRk9NhDbIizbktFLDGJbhGVbGPMQ8S3CcCr0XonoFpHZ/qPHHOJbhOFUkowec4hwEdblhL5PFYhxEZZxoS9UBWJchGVc6Ks5gRgXYRkXZswhxkVYxoW+yBOIcxF56OCASBdhiJUkpwcoYl2EYVaSnB6giHYRlnahb9IEol2EpV1yeswh2kVY2oW+nBKIdhGWdsnpsYFoF2Fpl5weG4h2EZZ2oS+dBKJdhPVPoW+dBOJdhOFWEvouSSDiRRhyJaFviARiXoRhV5It3YOIehGWeqEvfgSiXoSlXuibH4GoF2GpF/rqRyDqRVjqhb7QEYh6kZZ6oW90JCJfpCVf6CsdicgXubE+EGQPSkS+yI3lPWn/akS+yI29Tid7UCLyRW4sZ032oETkizQMi9iQPSgR/SI31uWI7EGJ6BdpGBZBX6hIRL9Iw7AI+kJFIvpFGoZF0BcqEtEvMrHX6nQPIvpFWi8W+kJFIvpFdm4sdA8i+kVaPxb6NkMi+kUm1iOC7kFEv8jEXjvQPYjoF2kYFkFT/hLRLzKxfmN0DyL+RRqKRdARNxLxL9JQLIIOupGIf5GGYhF03I1E/Iu0ATU0hy4R/yJtTI2gexDxL7ILq6F7EDEwsmNg6B5EFIzsnFroHkQcjBT25ojuQcTBSBtjQ3PSEpEw0obZMNEzONDGRtowATQ41sa6ttBEs8ThNta3RdI9OAi5MT3IRKngsBsbd0NzvBJH3kgbG0X3IA6+MWyLoDleiQNwDNsiaI5X4iAcQ7cImraVOA7H0C2CDvSQiIuRhnARdKyHRGyMNISLkHQPIjZGGsJFKLoHERsjDeUi6AgNifgYaSgXQQdpSMTHSBuco+geRHyMtPE5NBUrER8jDeUiFN2DiI+RhnIRdNSERHyMNJSLoAMnJOJjpKFcBB07IREfIw3lIujwCYn4GGkoF6HpHkR8jDSUi6AZQIn4GGkjd2imTiI+RhrKRWi6BxEfI7WNsKJ7EPEx0lAugibJJOJjpLaRinQPIj5GGtJF0CSZRIyMTK3vBN2DiJGRhnQRNJUlESMjDekiaCpLIkZGGtJF0FSWRIyMNKSLoKksiRgZmdoAOboHESMjDekiaH5KIkZGGtJF0J7/EjEy0pAuguanJGJkZGrDTekeRIyMtN4vND8lESMjO/cXugcRIyMN6SIyugcRIyMN6SJoykkiRkYa0kXQlJNEjIy0HjA05SQRJyOtCwzNIknEyUjrA0OzSBJxMtLQLoJmeyTiZKShXQTN9kjEycjcxgzTPYg4GWloF0GzPRJxMtLQLoJmeyTiZKT1g6EJHIk4GWkdYWhORiJORhraRdCcjEScjDS0i6A5GYk4GWloF0FzMhJxMtLQLoLmZCTiZKShXQTNyUjEyUhDuwiak5GIk5FbG/hN9yDiZKShXQTNyUjEyUjrC0NzMhJxMnJrY8DpHkScjDS0i6A5GYk4GWloF0FzMhJxMtIGEdGcjEScjLRxRDQnIxEnI20oEc3JSMTJKEO7CJqTUYiTUYZ2ETQnoxAnowztImlORiFORhnaRdKcjEKcjDK0i6Q5GYU4GbWxgfx0QDviZJR1iKE5GYU4GWVoF0lzMgpxMsrQLpLmZBTiZJShXSTNySjEyShDu0iak1GIk1GGdpE0J6MQJ6MM7SJpTkYhTkYZ2kXSnIxCnIwytIukORmFOBllaBdJczIKcTLK0C6S5mQU4mSUoV0kzckoxMko6xJDczIKcTLK0C6S5mQU4mSUoV0kzckoxMkoQ7tImpNRiJNRhnaRNCejECejDO0iab9GhTgZZWgXKcjENQpxMsrQLpLmZBTiZJShXSTNySjEySjrF0NfcSnEySiR824bCnEyStiwc3psIE5GSZteg05HgTgZZWgXSbM9CnEyStoepMcG4mSUtD1Ijw3EyShDu0ia7VGIk1HWPYZ2YlGIk1GWkyHvghWiZJRhXSRNIylEySibGIWmkRSiZJRhXSSTyQSnR7H5UZhkJjhDSpcihR4aOEmKzZLCZBXBeVJsohQmX8ggVYrtQHpo4HQphnWRNI2kcMYU6yJD31IqnDTFZk2hOSeF86ZYFxnavVHh3CnWRYaZ3IiSUTqQ4QYxMsp6yNBObwoxMsp6yNAeiwoxMqrzkCE9FhViZJT1kKE9FhViZJQhXSTN1inEyCjNRv0pxMcoQ7nQAf8K0THKusdw7YZ6T/MR7QqxMcoQLpJmFxViY5T1j2HGEGJjlPWPYcYQYmNUKvkxhMgYZd1jmLZAZIyy7jHMGEJkjLLuMcwYQmSMsu4xzBhCZIwyfIukeVmFyBjFByIpRMUo6xzDtAWiYpSlYsjUZwoxMcqQLczgRESMyviACIV4GGWoFklzzgrxMCoLuGQrxMOoLOCSrRAPowzVwow3RMOoLDT3EA2jrGsMM94QDaOsawwz3hANo6xrDDPeEA2jcpshjN4oEQ2jctY5VCESRuWhuYdIGJXzLtkKcTDKcjD02EQUjDIsCx2lqxADo3I78WgjADEwypAskr6JUIiBUVu7ctJGAGJglCFZJH0ToRADo2wwEn0ToRADo7YBvyaFGBhlSBZJX1soxMAoQ7JI+tpCIQZGGZJF0tcWCjEwypAsUiuytxEDo7Z8xjfEvyjrE0NHyirEv2jrE0NHymrEv2hDsUj67kQj/kVb/oW+O9GIf9GWf6HvTjTiX/SGjYfQiH3RNhyJ9mXViH3Rln2h72Q0Yl+0ZV/oOxmN2BdtA5LoLtGIfdGWfaEvcDRiX3QXkERuDhqxL7oLSCI3B43YF23ZF/pqSCP2RVv2JSWP4xqxL9qyLymd9A6xL9qyL/TVkEbsi7bsC301pBH7oi37Ql8NacS+aMu+0FdDGrEv2rIv9NWQRuyLtuwLfTWkEfuiLftC7tgakS9aBA4OGpEvWgQODhqRL9qSL/QFlUbki7bkC31BpRH5oi35ktHjCJEvugtKIrdhjcgXbfgVSd9maUS+6C4qibQyNCJftCVf6KsvjcgXbckXOk2QRuSLtuQLffWlEfmiZWgKIvJFy9AUROSLtrlo6Us1jcgXLW0PkkHSGrEvWgZiAjViX7RlX+gbOI3YF81nptWIe9E2NIkO69aIe9GGXqGDyzWiXrSNTaLd8DWiXrSNTaJj2zSiXrSNTqKDyzWiXrSlXnIy3EEj6kUbdkXSl5EaUS/aUi85PeQQ9aIt9ULTuxpRL9pSL3T4lcaZay31QueZxblrrTMMnT8Wp6815Aodtq5xAttQBlucwtbyLnTYuh5ksdWBRQ4nsrW8Cx3zqHEuW217j4GBes+wK4yxqnFOW0Ov0Pm3NKJetKVe6GtnjagXnfKphxHxoi3xQof7a0S8aEu8MAMZMS865bMZaES86JQ//GnEu2ib5ZYeQoh20Wlo60O0i7ZRScyoQLSLtulumVGBiBdtuBVuVCDiRduoJGaFQ8yLNuyKpB0MNKJedGa7j94nEfeiLfdCOxhoxL3ozK6dtCWHuBed2bWT3qAQ96It90I7GGhEvmjDr0jawUAj8kUbfkXSDgYakS86t2snbRYh8kWH4pI0Il+0JV9obwSNyBfNky8akS/a8CtyS1tQiHzRhmCRWzKyWyP2RfMpcjUiX3Rue4/e2hH7oi37ss3pwqj3LPvCFUa9Z9kXBgZiX/Q2cHZA5IvuMsHQQxmRL3pr9z56KCPyRRt+RdGeFhqRL7pLBkMPZUS+6K1dP+mhjMgXbfgVRXtaaES+aMOwKNrTQiP6RRuGRdGeFhrRL6lhWBTtaZEi+iU1DIuiPS1SRL+kln6hT1Ipol/Sje1BOsM6ol9Sw7Eo2i0jRQRMagkYeslIEQGTGo5F0T4cKSJgUpsRhmY+UkTApF1GGJL5SBEBk24CGd8R/5ImgauHFPEvqeVf6BN5iviX1CaEoU/kKeJfUpsQhj6wpoh/SRPbgeSsShH/kiZs3sgUsS9pYruPnIApYl/SJGDBpIh9SW08EmlGpYh8SQ2/omgPnBSRL6nhV5gHEFDn2dy6VN6PFDEvqSFXyFjmFPEuace7kNZkiniX1CaCoR1IUsS7pJ3TC+kTkiLeJRUp71+RIt4l7XgXyo5LEe2S2lwwtItTimiXVNiuo5+ZQLRLapgVRbs4pYh2SWXgzjZFtEsqA3e2KaJdUvv2D80epIh2SaWdefQ6i2iX1DArinaeShHtkso0BAN1oGFWVHsUJ4YGol1SyadiShHrkspANp8U8S6pCqRiShHvkqpAKqYUES+pCqRiShHxkhpuRdHRfSkiXlL+faAU0S6p4o9+KWJdUkOs0AkpUkS6pIZXoQnEFHEuqaFV6FznKaJcUsOq0LnOU8S4pIZVofOtp4hxSQ2rQqfUTxHjkhpWhX5aIEWMS2pYFTqHeooYl9SQKnQO9RQRLmmIcEkR4ZJ2TwfRWx4iXFIdslgQ4ZLqkMWCCJdUBywW/IxQGrJY8FNCachiwa8JpSGLBT8olIYsFvymkH1UiPbJTPGzQilvsQzeFeKTyqf4ZaE0MO/w40JpYN7h54XSwLxDfEuaBeYdoltSw6gw8wOxLakhVJj5gciW1KaAYcYPIlvSzHYcvf0jsiUNObqkiGxJQ44uKSJb0iy04SGyJc0CGx7iWtIstOEhriXNQxse4lrSPLThIa4lzUMbHuJa0txueLSVhdiWNOc3PMS1pAFHlxRRLanhU2iGOEVcS5qHTgqIa0kNnaJo5+YUcS2pzf/CHE4R15J2XAu9ACCuJd0GspWniGxJLdnCLC2IbEm3AS/5FJEtqSVbaO/tFJEt6TZ0VEdkS2rJFtrVO0VkS7oNbXyIbEm3oY0PkS3pNvQ4G36dLbDxZYhryTaBjS9DXEu2CWx8GeJask1g48sQ15JZroV2ks8Q15Jt2I0vQ0xLtuE3vgwRLZnhUuinQTLEs2SbgJdghniWbMNfE2WIZ8kMlaJoP/0M8SxZEjjtZYhnyZLAaS9DPEtmqBQlSVYtQzxLZnkWetfJEM+SWT8XciRniGjJbN5dppUR0ZJ1RAs9khHRktnHk5mRjJiWLAl4SWSIacmE7UDSUs4Q15LxryhniGvJurQv5EhGZEtm+BTuMUXUeSLg45khriUzdAozkhHVknXxRfQQQlRLZugURceFZIhrybq8u/R7jYhrySzXQseFZIhrySzXQseFZIhryQydoui4kAxxLZmhUxQdF5IhriWTNn8kedOfIa4ls1wLHReSIa4ls1wLHd2QIa4ls1wLswggriWzXAsdWpAhriUzfIqiHeQzRLZkhk9RtBN5hsiWzPApinaFzhDZkhk+RdHuwhkiWzIVyOCaIbIls2QL7VucIbIls2QLs4wjuiWzOXiZZRzxLZkKOClliHDJVMBJKUOMS6b4w0OGGJdMBQ4PGaJcMh04PGSIc8l04PCQIdIl04HDQ4ZYl8z6udD+3hmiXTL+paMMsS6ZDjgpZYh1yXTAekGkS2ZJF9rrIEOkSxYKMMoQ6ZLZ/Lu0W0WGWJcstfOPXucQ65KFIowyxLpkoQijDLEumWVdmLGMWJcsVfxYRqRLlgZYswzRLlkXYUSPZcS7ZJ2rCz2WEfGSda4u9FhGzEtm2BVFRxhk+G3njE1gnuHHne3rzrSZgZ93zgLmC37gOcS8ZPiRZ0OuMCYJfubZEi/MHMEvPWcBH7Ns8Niz2f2YN7Hxe89ZIDgzw28+Z4HgzAwxL5llXphhj5iXLOf9JDJEvGQd8UJ3CSJeMuvkwgx7RLxkXYwRPewR9ZLZ5LvMsEfcS2b4FcW8Po7Il8ySL/Qj3Kj7cv6SNkPMS2bIFWaKIOIl24bO7Yh4ybYBJ7MMES+ZTbzLDGVEvGTWy4WO7ckQ8ZJZ4oV5ZB0RL5n1cmHeWUfES2aJF+apdUS8ZNbLhXltHREvmfVy4d5RRx1oiReas8oQ85JbLxfu3fUNKmyMT+bpdcS85IZcUcxT6Yh5ya2XC/NaOmJecsu8MO+gI+Ylt8wLfYGXI+4l36T8KSZH5EtuCBZFh7/kiH3JOy8X0hTPEfuSbwLWZ47olzwJkJ85ol/yJEB+5oh+yZMA+Zkj+iU3DAvz4jxiX3LLvtCxQDliX3LDsCg6FihH9Etu/VzoWKAc0S95YjuQnFU5ol9yw7AoOhYoR/RLbh1d6CicHNEvuaVf6CicHNEvueFYFJ0mLkcETG5IFkUH1uSIgclFIE4zRxRMblgWRQfW5IiCyUWAvc4RB5MbmkVlJKeZIw4mtxxMRvqQ5oiDye1z0pSXUI4YmNyQLKSXUI74l7x7+Ij0EsoR/5J3Dx+Rxk6O+Jfc+rrQjj854l9yy7+Qjj85ol9yS7/QQUM5ol9yGeo8RL/kln6h0/bliH7JLf2SkS4FOaJfcsl3HiJfcsl3HqJe8s7PhWw1xLzk1s2F3kcQ8ZJb4oVkoXLEu+Q2uoi8NMoR7ZJ3tAtdFnWcIVYUnegwR6xLbogVRccW5Yh1yVXg3ZUcsS65YVa4+Yxol1xtA/MZ0S653gTGD6Jdcs26COaIdMk16yKYI8ol73K60PMZUS65VrzXX45Il1wHsirliHTJu9gieg1CrEuueRfBHJEuueFVFJ3SMkekS64DV7Y5Il1ym2SXNrQQ55KnfN8hxiVP+b5DfEtuA4vo+Yzoltw6ueT0Ror4lpx3cskR25LbuCI6wipHbEueZgFDD7Etuc3nQkdX5Ihtyfl8LjniWvIsENaQI7YlN4wKEzCRI7olzwLn9RzxLbmhVBQdg5QjviW3ni50DFKOCJc8s8smvTkiwiXPbP/R+x0iXHJLuNAxSDkiXHLDqSg6BilHhEtuOBVFxyDliHDJDaei6BikHBEuuSFVFB2DlCPGJTekiqLDinLEuOTW1YVOcpojxiU3pIqik5zmiHHJDami6CSnOWJccsu40ElOc8S45IZWUXToTY44l9zwKpoOvckR6ZJb0oUOvckR65IbYkXToTc5Yl1yQ6xoOvQmR6xLbogVTYfe5Ih1yQ2xounQmxyxLrkhVjQdepMj1iU3xIqmQ29yxLrkhljRdOhNjliX3BArmo6myRHrkhtiRdPRNDliXXJDrGg6QCZHrMvW+rvQW+W2Y13+8fKurD4W56Y4fF8dis93X/3xx90//9k8n4q7l/+5+2dp/zN5aWTeffWfu+Tuq//8z8s74f7M7J9SdH9u7Z9KdX/m9k/dldfdv9NN92dXP5Pdn93veScvT+2f2+7f2+7fSdIJTERXM5Eb9xdXRrkyypVRuvuLdoV1BzRxiJK0+4Qkcz85MO0L3fYvovupfby0+0unon170X657mAoJ7DNI2X/snWtsunkaNdubRxz11DS/aWT08bb2L+4xm39We1f8u5/Wkcf+xfXQZn7wPaaomvizLWtdn8x2v/npRsf5l/teNntm7KuLnAsbBUYDCoLVPxYNEW1q5r9+2L/4VxcrsfGG1QiBZK2LITiInS6b86wbpuQqa/bpmEaqXso9ufnk6e+zXB1E5GPqi8qQkQKReSciONjfS6b90/e129gO7peV1s3DjZuomy7n3I74kn5x/rT7ni0rf24a/y5K7Y3Re3j7oyQ06moDj5CANCBUCyIy76oDmX1CEW0jFovI0/YbrocimPRAj88nneV18ZtTEsvog2osa1i5zglq2mKS7Mzw7Z8rIqzN3jbwPZeWpvkoJt0bO8baVhIBoUIttuvzfuiasr9oEM0HPcx1Q/FZX8uT0193peHp/LytGv27z2ZOZApcnZWApn/+nR5Ki8X1GPto4xAENvKN0FlXT3V56J5v6vqqmjbfNdcz0VVN5fr6VS3W4uvIIUKQl9fe1O+vTi7VRQbt8oKt8p2i1mbX9D2qhBu4Uzcwul2HTffWrfrbuF062XidiS3RbQ30t3CyU4eg7b8t2kNCFp43eKQuv1lEyPO/qOqm/pTVfgtkmdQOjuGobSqbswUKw5NTbRxDiZb+6hlWKI3rFtHRzBRM7e/u+ZM1Jg0twh4iCRcvVzfaCc+U+4vaW9AcKjf7S5Fqq7nY1O/e24Kf0pLuJ9IblQCEfW7fxV7fzeQEsrguuPdsd5/uDT12W+9DK6Uzqpq6ShGyrU8Hv68Fufn+jTYoluO7SZMcZPYtEJT9x/lfwxYB5Ri29SKoBoDbo1KhOtfmjNah9r01qA+t+vsS39xkXCN2HDduD8WO7S2gBW5W0eEdDtw3xtu98ndOpJrbqXdH+uL18FgGCddbTeI3TYkpLMqM2fXuSWsvRHoMLi/6N5C5hp3Xx/8uZQLuF5w83FfP5125wI1bZuF4bbpsRZXV/mpuFx2j0VTPrWb8dPJlwTaImUNklbStcEwEjhRxYabHrfKbSPs+c0Iri5bdpT10p6ux6Z8v7u8ZyVuN1Ai3zVG4mH3eHq3Lw8P5/ppsCYlcAoK1vojRF2ac7HzrU04nUTCw6oO5WA5yTI4drtZkbgdOHUHjDZSjBX7UPqGYabhcpe6ecXOWCPh6q+Z7SMNtzVCcMvcvq4uzfm6b0w1tO5nYMPT7uCYsUtmL+tD8XwozuVHs6medo1njSnY2hlrIPLCrq1Zdtg1u4f6/LRrLpf9++LJ3y/g+poJfh4EVZzOdVPv6+O+rpric0OpAe3TOm8vUtP+B6Ujgzq4rWZEh5G7I1tqC8UHxqgVjywiCeezO66LpD/tO2rAERnt++zdX9xp3xl8bSLi7kjvzM9Nf4DvlvV06w7wyq3vm54ScduPcOd26f7izKDcsQ/bTaAdW8LnoTw2vjnZOqmDhmJ3tnMxsNGg1ZikbhNzFJDbP5VyREjqjPasK6x7E70/9zpGKe0pI1c4dfRJlgjXWK7VnOQsY6eEwQ+Oid56kIKZqxN2GbAyOKu/TUIE9sqwlAN5ck403Jk0u1dbEe35kJCRwrGr2S3byigP5+JSH6/txwzJGg3ZgJw9tFpZ7R7kt2oCW5Wdgn1lwqaV8GCqU3Z09zJOxdmcb+vqci7+vBYXRCtAI0SG27d+eLgUDW3MZAJuZOwCaeT0h2N/sMAP24annaU0vHbZwrHGHn5gdb9dt9CuG5k1XX3qMySkenQS/gymKeGpRbBfcj1farRwga5M3PrXrTDOuFasddLus/5Igy2ieo6IM1Tb+thKhWfhxGHRrHlz2+p9KRJKcUsluxgAg8ETA4eoYKmutvYFnenbDKwAgdvZVP8XR1+z51QjFR92wUhxmwW7L/cCHouG4JAhDyzYY2Yv5Fh8LI7+oFNw0IWa1gg4XUkU8NjJnvytkIFpriX8BHf6ZE3Qw64puiXbn8eQk+xsdHdrojU3m1ppxedTefbt4gxyv5uePgthOl3fHcvL+wKdGqF57VBph8rZQ2lI8KU++62t4FnGGRdCs/OzaM+Ap+OurCxPcdo9H+sdaj0INONWL+IaQcFTWib4mg9lVWJDAbK2iezvcHghHUvudRXkLnp7UnM7Ec+0J/BCREh3D+WusdpMsR0xunU2ljsvsefcVhsyFjU0ShwFomTPeLizoLP/ctZwscKLj0XVXN49D4gCeE3lzGR2frNnuQTua4LlWm4ChieQBBqVor/g2/DfdS4/FrvWnjPDtZ1Y++76qayrD8Wzz/YJeEOyDX5isX9fHg8ng7X4UDz7lzVwKQwMwlaOk/GvTx/8T4WLmWb3O08GwpGkcBzy266RwYmA1rO7Gch6/m7DrjdWqGlxLBOuicLdCeSBXqRvxCDxwXLi7sIHrReQNUk2/VW4OyA5WyVN+c5zF0neLQUc4v31dSc941eSZlcefXMBHgQ37FxBzCK07HN+KygPT0Xzvj7w1BvchbfsuCmNhAHjnEBDWPDTyFT/uDui5Qaa4YKlR71T1sOuPOJPgJQfe3B0Uj76RwGIn6t5PR3tjSJji8AO5PeQT5U/M+D6lrEN/6kaEoFgTrEmiql3afB2lcE5zh5cDu2t2Rlfc8GRkrON1VUd8uiwr3O2rz9VZdUU54fdvjClob2RQOeDJAC+G/O4PjwaKMFBKPZlcbkU+5PQ6YfEd6CAAtiR5gsgvSi2UA43Ynw5pCtFDuVwY6E4CK2TbVmZCYg3ny0ch+xJungqfdVgDPaEGrvtFFU7HA740AhPAOy9rq3rH9/hjZViSbfb7u/dKXk2jmMZ2dv/mxDSI0XCb1DsAniTUlanq9+SGhLyW3dydgSeDjVMJ/N0rk/FufF3XkinJZqbLJ2Qy/PTU9GckcXkk/6QcWEJ5+LP6+44pEnhN2ZsI+ElB55T2R3VmLLt8Gw9TgaLs4K8RM7aVkMhre/AqSCWwa237wcFHmtv2YaMfTdjRmoTJ28gJGcZOGve+2snXCpYnshWfCzQMgMmu2K91/q63T2mv0eCwcium04AxWRCRxbFnm56EefidETWLUAQ/gTjIeArh44OLI0KalNNAC8Egx1/4VwU2ldgAY4IIcNmAMOA3UGtgMv1XWv3vvP3UMgbKn4q+xJoCzrxfOziJNl/mhl6rcqn07FoS2ODEJ6FWB9JJJnoMnhVyt6UIjFkt0G3DNZyQoIGXSfAV/Hr7619vHUDALBLj2T3aiPBojDf8n5XHY7IaAajiL3fLD4X+2tTXKtj27LvBkcPCYkczTLNxefmvNs36Pwj4blFZ9xUIHYiMIUyR/k5B2rhiJTMXRtmmXNxY13FrI6y2h+vh+LSM3rnYl+fDz7pAAdCxvoH+QKvVVgkvNJmXX6sSK+m8EiHzgxyX6tYJ0Z8TQUPP+x5gnbV0HAnZclwc7U1cJVKNJzjLFP72O7gu+O/Pl0+FufyoSzOj0XTMxVV3TzUV+TAu4Vjm70QHgruzGvynifZbqFQrpes0MAdqYb+RDlr8JNySGAaWok5exJxAg/l4UPxfCrOl7pCljy8hmKXXCeHNDMUbPmcHYC+jMFerWBT56xZ70sht7o2QghI4pYYJ6kdp90E/XQuff5WwdUqZ6eJE9W28a70r+vgtXQ+OoI6CefdJ18IhMFSTU5ItyPifmqDoUC7jH0MuFIe+qlDYzpnnesIUdTtNDzJ5qzbMSnsY/0BdRi0s1m2AsjCM0JBl+2cNZR6CZ23T3f+6td6YijBgcBufFjuhXQGU9AZOs9GP9MJG8466AOdZ2Nzt/u44UWHglxezppKSA6xCMB1kr3fR2LIVUBBviDPxyYe223QaTJn78qMmHJP2KKea29wbPfVBxak517MQ0AXXNBKd85+SvR+vu6ayN195eyd4mPR0KEhqXcNy/dWM3S+l/D+RbPBMo9FM3DNhQYkS9y0Fa/nc1FxnixwNrIHqsc2qKs5PyMbNoU+E847TrOWeStlcLCHG6/z7MoDA6QxN6q742CESniDpNkT6mPRfECfARcRHVjpmqr4VFwoeqB9Jg50RkB3fTxwIqArTcACaVpX66rpvDeNdfnQ/QONEEg5ZDIwtKxBiYhVBW/18k2gWcibMwUHR846fD8WzdC9SUHLRbOXOn1dfLaCi7nmdwW8m0sYuKNY91pTzzNNbXCNcajwgAj4HZK3V2iBRKCWgJNe8o1KC6zq5rlobJCmL9U7mU/8bmt8oO8WUCA7dAYC+6sTKtxNQFtfslewQ6n2NoUWqaBIdtsfiLxFVD20vECFRpKA64Fkb9VDcqlILQHXCMlGunQS3nnzEYYvJs6lOXGxVanz0k1ZV7Hb93pi4fK9cXxEH7TswulS9hag/1xPKvRA2zgXIudknLr48pSlEN8fBs4B8JIz5Yakqef7hXTnYr8fPP6I+zS0HMPNkhtptqy3QUO7S/Ye36zOtloH2TpNtp5U1AWLgDuvTLi1ZCjw4+54LXCyAAFdhSXr7QulQWBl9VQ81WcEEK4irNeEKd2tlebvu3fHgv5guH6wplZnX3QT8mMxCA7YeHcBztmOZVpYewVy4ZxZ3i+I/vADQ9mlSMjcJHFz0Bm2iTNsExdglrBny/ICQ/h9Lw/IVznnQOFczwS7xpUXu46161HXFPaMQdjC8HJIswZLeSlOrbfVeXf8UDy3kVDn9prZNwGgw5liPdXKC29NQg9r50um2Rur8tIah8iKAZ+T8uPj0tqEqCZ07mLJknbMP1Ztw1JBtBIuotoRwylrhfzrE3K9h/Yo69/xr08XztWSWjhhzKVkL9IcK/ncc37Xqvf+2Z8/+pMBUpNswBy+DdbQYGdb2NsMCB8/uPsJdjP6UDzTV/kJ3M8T1vvAq0/cv8NZw9qEQyF+d0MyW7OD5EOBz4CQtNIuI0nqvN9zF/aas95pH4rnp5Z4KHd+LDJkUjTLpBBUo4SknM575w6ue44l8g2BtxxufWdpwqedt19DDjjRHOqn3WfneW/yeLT2z7ui8zLxrzvhWs8SQRTfAq98nRXWGXnCOQ8qZ58pF0mvXOi+drlk9LaP0nI2Yh8k7ZyCU3cBlbpUJlnSh7Q5D+LUuTqzJFT3GYjpgEu5c0dmd7CbCP+aCe79KbvwdLUNS+F7H4A1hhtHXWVDUVhzCS9+8FDA3uE71trXDx2u2IAjhvBW0NJL2VMOqE3xE3Az43ZBIILKUAANupQ16ICQAQMIHcZSzkDAAgx15XOiQMpYc6BABBj2yFrhri6OgYFrZTdhWLoQyhj60cB1IVdjLdHKIDvEW+lGBja8U/elgK8aQUKSkMIL5+lWne5Pt54kzgRLnCWTOMfuxC1ZiQu1Ff19cJ+Xy6UaU3kfh+LWtz6f1s2l2v2Pc/hOXa1s01+wu5hTFyqRudv4jL1qs0SEvyZAcrr7ZBds7xjVxH1OIvsLf9cI7J3TU+l7DULvHdbH96msyqfd8XIsCp8mhgx3znKrVRuHdiz/XRBxxtLzhXPeCWxGJ2tJkklboBMtSxTXVRvAOfSegA4M3Fht/eZgJTDju+HkrhFEn5rK7Za56Hco9xc30PKUa/ZBkh8JaXnNBqiZer2NTEU4QQNVsx7Dp91jWQ0Dmr14ZjezuL6/yRjGanp3v1wjeLQ2JnThZ7ABaVYCDsqEQW2sFXfanf3MLQkcZsIZM8oZM6rP3eYO1dpZuunGcWru4J26cNS0T/HijuuZC4HPXFRl5iRn7N2oATuIfILuMCwl5aoGE6QI6Gso2dnuZI2mRxHQdVCyl0y3C206IwkMomE9PcCtuG8NQz5AcHY5qL2vfYIL3i6xt21BXwHYCinrAIdF0K6HkM1k406wqJ4XJqlw6FkpWasEy/RHIXRWTkTvCu5OCS6pZeZOEpnb2TL22g0rJExTmM4lYa8vsKCqbnZ8XKSAFrdkLW4slDKyoHmTshsWlmQGYL8a7qoDzKfiW0+QeY0Z2jf5Nn/K6Vy/L9+VLblfFkf/4CSghSJFLPprdUvwNmxb2CKS3d1GvGWg/1/KEupDIfSEgjR7wi+fA2n++E+9hF99rqSIPunEEaMbWvpJzEDsRJFDESZNYE9xYc8ieEmaxkzb7oKQbPbcu/2PaqdWGNVM8H6Lt1IGkuzFQWjhFnCkSd6IwqLJDoBZEFgSYyAKTqdhlwjYrZJ19CadvOAdPz8gyLBfCbkunbt4H5fUKGcjXm7iCPte+Q65bEf2IcCE+wC8q0jZ0xgWca3am6OmpeCu+4KMlhJw8Es27j8secChCjgqJD92B1JvnPj1jK70PWd71pXhJrKpsfsHJIQzNlbwdK73xeVCxotA92jWpc5ta95chodVd+eZ6P76ypnc7LWZE+rnVN13N+wd5eq3F7R+eOOMl3u+HosL5ZAtYCpmyUYbkKL7yN1zfWxd88pTiZhJAe1+yd6ZkdLLal+fz8WePnQJj/RknbrCkukcN8KLvmSzwIRFs/YQZBoke2HHCLc308Ys8oXCJZZlLUJCBzfm0CNSskGgpEhjvZfVYzcs6vOBHHnQX1KyvDWj4XN7O0Hd4cGTsWTz3tBSy4qVCicgG1rCSDV7ODOK4eybtmB0cs3M9hl1ASMKJZuBiJTaLkBtv/ny4JhlE5aQ8izr0cYojU8NSNVK/ijCq3HDDKTXfNxVe8Mw79/vfM5RQAZJsiQ1ra77T3Jcwxg+ydNBlFzjav2pbN7X12bYC3BGsg7GpNxWlhsv5DoN45wkmxMM5eb091PI8LD+VE4Ck3sIXjiP7haDtDh+DGif89Ex6aMTAbd4AltFuLc8tHtWQ/fBa45ByxyDlvEMkNM1nLbQqz4ZnWWIQILxu46qT1nf1JG4BWgTpCHjCglhTlEwG1TA2MPSunXYGjDd6K0f/GELl2X2vmtEdP3AWF3wIk6ytxKs9H6m1Q9WkSdceykexobmULgdP3Z7HWzeMG2CZCMGWOE4556A16uSjSUcyqMMb+h1nPDMyEAWdWCFllrGevIOZZl1lul1mBZBsokNhzI7S6dlXarHQ3Fq3hef90VxwOLhrsNeSBLi62NxqI0RX3wu2zyxj+XHYpAbTMBcEHJC88JDvC8QbjtscvlA8BK01DOevPIEDO/GYOBhMj6k2TwB0Ec9ifwccuh5kc5xXzXMFwBd0RM2f4Yvhe8puImPCmsXDf8VJdgy/GZpwikG13EwJR2/7VCRHBJe/mr3EJTufbR4W8JJI3kamA6EzbtDxoZImOdYs66jfV10G6g9Fwx2ArraBLUBb4H56xMqtyUMLUncFW+ydV4LLgmn5rk0J5XOAA0jXAW/uDghXA5o6FHBT8EripSDLvK33Iwuf54zz3IW1jDxCGS2lBOQ9qnM2cXfSCKCxeBk7t/l4CYSt7J4kUlc73fLSZv1deg/BFlcbiqed9WByBqgoc9nzt4k2tr7d/X58n7XvkWGfeJg4Cs7hK2UskLxzzDWlTU+bd3eu2CYO0/D4Jmc9bHu5BDVYbgzu6LZ6qTfkIauvzm7BJ131WOxbx28zzgdAVzCgtUJTxJIj7JtWCB/DEjLKpYLJE+QiZf6pl/FWarEWkvYkQL6lfT581kjiUjYIeHlnXLuWhl769CHShvf46p21NXNH7mNKcInfNgzkk3+xYdhQ3M6Y4kOr753nB9maRRw15FsDiVPJGkdwSM0u0t4YijjCK7VGWus9WL8rKnBmwPoeiTZrDad5GEEW++7AcyY2wWzpwnudZJfR6doag8egyhMuN7LsSYf6rGdAOz5Ex2eCCNGJOucyqqxu9W5D+KPUAgPIqwfK6vQ9zCgNcCTCevBH9ZQ1T0f6cuGtjTrnB+W7QTT4OEawoY1xiloD4G0ErgqsIZ0WAlx3QAdCSR7kdqJdVxLx8P6QSvF4xOmIqFToGQjezrhiJHE4TBB7h1GIEnWVQApapua0UKOI0iLStank8u0kcA7EsH6pMPq3WsjxiLoDfHWTZy61oAnHck6gELxVnDPJdv1rItnLH1bUsCcljJghdykk1sSNCzGFi7OqE4gKS9YRyEoxTgQRrYjdCGVbEJ2KJ2gAiDBMbZe3mQMzP/EeyR3bFnENqCCpGc2Zki0tccsE3jRLlmvUSCQGgReHo6x5bgVQlklkHLNxpbcVsiwk7wj3pj5YUU013NVWDfUE7rRgUmqJW/id/lz7GtizOJDrNLQaUyyjs3B7DxeCuFRgCP5KL3nD8YW9kkpKQUMzZVsAjAsetJaBndSNtINayCHMrwOicZKjmcYtMBmdMOSiEENQ8bHvs1u5k3Rxn4/nsvm2fdSbZ+IOBiCuqiYRBnwlCfZ0ElO3S0BRXWwnka0Ei8mbmSwEfHV8CTKOu3C6uD1NtA0I29kC+jhJlm2Z0xPtyV1IRZkdgF4CSfHxgqriHpV21cDbSo2+sdTM7J9wDSmkk04CCW6N+ya3a46dC9hPV2b6+54fC4+74/XC84wAz26JBuFQevYG/dnFy/r9Jj0okM9cBFh80sO9bg1fuBLKOCNuWR9CYcSey8B33N7BD7cUNgbbqjMtT419GGmPcnzc0iaaWRSHJzwPF8HxTHbFHRCGNs2jaBb/rFrZRwbCiJ9hIDX+5JnVn25MAEE6WwC8+dJnmkFUsunp2sDs5Ds37ccIhILlwuehAViqa0Oev4mfe79MfvYirNDvu3ysjqdi49lffV3ZBhHL1lPXEbmMIezgP7Cis2HQcgDzy9wUOH6wiZPI0STR0p4E6rY5BCEtKGNKOFlvGLzKlCyhmsRzLUgeb4byKKyeUOrVbNegZ6UNs5wVx1sWhhqcZDw0lexSSigULO9XYzoa/Whqj9VREaYjZfFIGZKD8wZsMvSyGEeHjarWFBFkEST8JpEsdeVcQqquikr9CAnFfcJ71YUe8Ea1AmeHKQ/C17tsbnIgipuCUmYLUxCtlxFWYkDJe4ehLvUl5D+UKz3BBGCJKHTuGLdmIcBGxK6fynWtRp7y8Hpn7AuhOe6bgZ35knqPQXAfeRw/UpgHFzSB3mwznPdGdoTAVkqwR7pbc2u+zpLFT83C4kXxSYZ8yTVZ/tPam+XkBFSbO6gQSwoJFySTZ95y4U5uhcuU5a4JV9nUl5qf9bA6uvaBPADqkxCJkexed0u7+vrsTdN+6nhM1Xw1RvW07tdiPwNBqa56IOg3bOkmUvpkPMd2C5tfr4LaDOmrIsj2FN8RDAjEDtRQytqAj20hYv2V66rlcsUoXLnxNr7iLqMbKl7QTd1SYVS9yR85jInZi4HReayBmTujfmMPewNLYUE+qeLpA/e75/56/H38ezu3fbMZQRyKX2US+qkbwG9LgDHYUv74Pc+oaTsZ0OfTKPPBdnPjz4w2H2ji5nM3IvwWdIn3HBXzS5VZebAZ/1bj05ylveDzTmtbPqwNL77/eEPzd+EdckkcmVA9wo2zU9LdB/K1lsf+3l5GcTdVGGnMZPd0Uvey2Jods0VGYdg7WA/2fhyNPW73aVI1fXs5+2CgRyK3yecjGF+D7gms0EDNvoA7Q/wwJuwjhEkEesFabm54NJ85PyGCXLiDNOVQ8OPG3XWph4k7wNousnLWo6tedsejboU7uiZdMju5Cwn3PrX+IMY+hex+bJ6txziykZCJl+xN2t+4ld4XcbypMSoSaBTrmBDN5r6XxeUgg/GqAiX1Ee59EPKrXDKLdXaLaKpc0BLlVvOXRK1tF9+XO7aLOkXLfdT/7IyS0o2NfVuDHzukDUCB66nkFlK2K38eiwPrSs9ysSqIDefs9Fv18okW6Zz9yvIyqdsEpDr+QhCf1xCoZZM8ccWnFrs8KSFIfM/8fKwcn1xPR97O5JHBY9EbN4UShTGBI9v7Bbijjrg4r8lSo1LaDPIYzw8XSloJWRspKRT419DnIuHwqTb2R37o5YvHFqzLM3ghLfzkmBPIBOjWQrTCcEp6L1XG1lC0NXuRi75NQmcAYK9Y3WiBicGBZN0pGzgVV8feF0OtzkFj0Epy4o4YUQyX3ibJ9hbx14A/XIEtDDY1A0f22TRnmECH99hoZvsr35fejsDtzXYiuYRz7J5rh8wFYsuHSW01TS7KKFktJ4EuLBq1gWDyP4Mj7L03PvHy7tTeSqOZVXcffXHP/7nf/5fpSBfDEYAAwA="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 000000000..98a437794 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1414 @@ +: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-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-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-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-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-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --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-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --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-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --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-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --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:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { + 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-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + 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-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-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..6abd6f402 --- /dev/null +++ b/classes/AllowAllTenantGate.html @@ -0,0 +1,5 @@ +AllowAllTenantGate | DWN-SDK Documentation - v0.2.17

Class AllowAllTenantGate

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

+

Implements

Constructors

constructor +

Methods

isActiveTenant +

Constructors

constructor

Methods

isActiveTenant

Settings

Member Visibility

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..83b56fe10 --- /dev/null +++ b/classes/Cid.html @@ -0,0 +1,17 @@ +Cid | DWN-SDK Documentation - v0.2.17

Class Cid

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

+

Constructors

constructor +

Methods

computeCid +computeDagPbCidFromBytes +computeDagPbCidFromStream +parseCid +

Constructors

constructor

Methods

Static computeCid

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

  • Computes a V1 CID for the provided payload

    +

    Parameters

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

      the codec to use. Defaults to cbor

      +
    • multihashCode: number = sha256.code

      the multihasher to use. Defaults to sha256

      +

    Returns Promise<string>

    payload CID

    +

    Throws

    codec is not supported

    +

    Throws

    encoding fails

    +

    Throws

    if hasher is not supported

    +

Static computeDagPbCidFromBytes

  • computeDagPbCidFromBytes(content): Promise<string>

  • Parameters

    • content: Uint8Array

    Returns Promise<string>

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

    +

Static computeDagPbCidFromStream

  • computeDagPbCidFromStream(dataStream): Promise<string>

  • Parameters

    • dataStream: Readable

    Returns Promise<string>

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

    +

Static parseCid

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

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

    +

    Parameters

    • str: string

    Returns CID<unknown, number, number, Version>

Settings

Member Visibility

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..1bfdc127c --- /dev/null +++ b/classes/DataStoreLevel.html @@ -0,0 +1,27 @@ +DataStoreLevel | DWN-SDK Documentation - v0.2.17

Class DataStoreLevel

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

+

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

+

Implements

Constructors

constructor +

Properties

blockstore +config +

Methods

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

Constructors

constructor

Properties

blockstore

blockstore: BlockstoreLevel

config

config: DataStoreLevelConfig

Methods

clear

close

delete

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

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

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<void>

get

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

  • Fetches the specified data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<undefined | DataStoreGetResult>

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

    +

open

put

Settings

Member Visibility

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..62ae285ef --- /dev/null +++ b/classes/DataStream.html @@ -0,0 +1,13 @@ +DataStream | DWN-SDK Documentation - v0.2.17

Class DataStream

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

+

Constructors

constructor +

Methods

duplicateDataStream +fromBytes +fromObject +toBytes +toObject +

Constructors

constructor

Methods

Static duplicateDataStream

  • duplicateDataStream(dataStream, count): Readable[]

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

    +

    Parameters

    • dataStream: Readable
    • count: number

    Returns Readable[]

Static fromBytes

  • fromBytes(bytes): Readable

  • Creates a readable stream from the bytes given.

    +

    Parameters

    • bytes: Uint8Array

    Returns Readable

Static fromObject

  • fromObject(object): Readable

  • Creates a readable stream from the object given.

    +

    Parameters

    • object: Record<string, any>

    Returns Readable

Static toBytes

  • toBytes(readableStream): Promise<Uint8Array>

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

    +

    Parameters

    • readableStream: Readable

    Returns Promise<Uint8Array>

Static toObject

  • toObject(readableStream): Promise<object>

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

    +

    Parameters

    • readableStream: Readable

    Returns Promise<object>

Settings

Member Visibility

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..aeb7ed3fa --- /dev/null +++ b/classes/Dwn.html @@ -0,0 +1,14 @@ +Dwn | DWN-SDK Documentation - v0.2.17

Class Dwn

Methods

close +processMessage +validateMessageIntegrity +validateTenant +create +

Methods

close

processMessage

validateMessageIntegrity

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

  • Validates structure of DWN message

    +

    Parameters

    • rawMessage: any

    Returns Promise<undefined | GenericMessageReply>

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

    +

validateTenant

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

  • Checks tenant gate to see if tenant is allowed.

    +

    Parameters

    • tenant: string

      The tenant DID to route the given message to.

      +

    Returns Promise<undefined | GenericMessageReply>

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

    +

Static create

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..60dff0de2 --- /dev/null +++ b/classes/DwnConstant.html @@ -0,0 +1,6 @@ +DwnConstant | DWN-SDK Documentation - v0.2.17

Class 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..d03339f15 --- /dev/null +++ b/classes/DwnError.html @@ -0,0 +1,4 @@ +DwnError | DWN-SDK Documentation - v0.2.17

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..16330e950 --- /dev/null +++ b/classes/Encoder.html @@ -0,0 +1,11 @@ +Encoder | DWN-SDK Documentation - v0.2.17

Class Encoder

Utility class for encoding/converting data into various formats.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

Static base64UrlToBytes

  • base64UrlToBytes(base64urlString): Uint8Array

  • Parameters

    • base64urlString: string

    Returns Uint8Array

Static base64UrlToObject

  • base64UrlToObject(base64urlString): any

  • Parameters

    • base64urlString: string

    Returns any

Static bytesToBase64Url

Static bytesToObject

Static bytesToString

Static objectToBytes

  • objectToBytes(obj): Uint8Array

  • Parameters

    • obj: Record<string, any>

    Returns Uint8Array

Static stringToBase64Url

Static stringToBytes

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..bd43e9edf --- /dev/null +++ b/classes/Encryption.html @@ -0,0 +1,17 @@ +Encryption | DWN-SDK Documentation - v0.2.17

Class Encryption

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

+

Constructors

constructor +

Accessors

isEphemeralKeyCompressed +

Methods

aes256CtrDecrypt +aes256CtrEncrypt +eciesSecp256k1Decrypt +eciesSecp256k1Encrypt +

Constructors

constructor

Accessors

Static isEphemeralKeyCompressed

Methods

Static aes256CtrDecrypt

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

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

    +

    Parameters

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

    Returns Promise<Readable>

Static aes256CtrEncrypt

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

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

    +

    Parameters

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

    Returns Promise<Readable>

Static eciesSecp256k1Decrypt

  • eciesSecp256k1Decrypt(input): Promise<Uint8Array>

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

    +

    Parameters

    • input: EciesEncryptionInput

    Returns Promise<Uint8Array>

Static eciesSecp256k1Encrypt

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

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

    +

    Parameters

    • publicKeyBytes: Uint8Array
    • plaintext: Uint8Array

    Returns Promise<EciesEncryptionOutput>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class EventEmitterStream

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

+

Implements

Constructors

constructor +

Methods

close +emit +open +subscribe +

Constructors

constructor

Methods

close

emit

open

subscribe

Settings

Member Visibility

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..fdac90683 --- /dev/null +++ b/classes/EventLogLevel.html @@ -0,0 +1,28 @@ +EventLogLevel | DWN-SDK Documentation - v0.2.17

Class EventLogLevel

Implements

Constructors

constructor +

Properties

index +ulidFactory +

Methods

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

Constructors

constructor

Properties

index

index: IndexLevel

ulidFactory

ulidFactory: ULIDFactory

Methods

append

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

  • adds an event to a tenant's event log

    +

    Parameters

    • tenant: string

      the tenant's DID

      +
    • messageCid: string

      the CID of the message

      +
    • indexes: KeyValues

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

      +

    Returns Promise<void>

clear

close

deleteEventsByCid

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

  • deletes any events that have any of the messageCids provided

    +

    Parameters

    • tenant: string
    • messageCids: string[]

    Returns Promise<void>

    the number of events deleted

    +

getEvents

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

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

    +

    The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

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

open

queryEvents

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

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

    +

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

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

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

Settings

Member Visibility

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..6675633e5 --- /dev/null +++ b/classes/EventsGet.html @@ -0,0 +1,9 @@ +EventsGet | DWN-SDK Documentation - v0.2.17

Class EventsGet

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class EventsQuery

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class EventsSubscribe

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

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..32368b28b --- /dev/null +++ b/classes/HdKey.html @@ -0,0 +1,9 @@ +HdKey | DWN-SDK Documentation - v0.2.17

Class HdKey

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

+

Constructors

constructor +

Methods

derivePrivateKey +derivePublicKey +

Constructors

constructor

Methods

Static derivePrivateKey

Static derivePublicKey

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

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

    +

    Parameters

    Returns Promise<PublicJwk>

Settings

Member Visibility

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..c06d30633 --- /dev/null +++ b/classes/Jws.html @@ -0,0 +1,18 @@ +Jws | DWN-SDK Documentation - v0.2.17

Class Jws

Utility class for JWS related operations.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

Static createSigner

Static createSigners

Static decodePlainObjectPayload

  • decodePlainObjectPayload(jws): any

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

    +

    Parameters

    • jws: GeneralJws

    Returns any

Static extractDid

  • extractDid(kid): string

  • Extracts the DID from the given kid string.

    +

    Parameters

    • kid: string

    Returns string

Static getKid

  • getKid(signatureEntry): string

  • Gets the kid from a general JWS signature entry.

    +

    Parameters

    • signatureEntry: SignatureEntry

    Returns string

Static getSignerDid

  • getSignerDid(signatureEntry): string

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

    +

    Parameters

    • signatureEntry: SignatureEntry

    Returns string

Static verifySignature

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

  • Verifies the signature against the given payload.

    +

    Parameters

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

    Returns Promise<boolean>

    true if signature is valid; false otherwise

    +

Settings

Member Visibility

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..ff379e015 --- /dev/null +++ b/classes/Message.html @@ -0,0 +1,44 @@ +Message | DWN-SDK Documentation - v0.2.17

Class Message

A class containing utility methods for working with DWN messages.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

Static compareCid

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

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

    +

    Parameters

    Returns Promise<number>

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

    +

Static compareMessageTimestamp

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

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

    +

    Parameters

    Returns Promise<number>

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

    +

Static createAuthorization

  • createAuthorization(input): Promise<AuthorizationModel>

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

    +

    Parameters

    • input: {
          delegatedGrant?: DelegatedGrantMessage;
          descriptor: Descriptor;
          permissionsGrantId?: string;
          protocolRole?: string;
          signer: Signer;
      }
      • Optional delegatedGrant?: DelegatedGrantMessage
      • descriptor: Descriptor
      • Optional permissionsGrantId?: string
      • Optional protocolRole?: string
      • signer: Signer

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    +

Static createSignature

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

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

    +

    Parameters

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

    Returns Promise<GeneralJws>

Static getCid

Static getNewestMessage

Static getOldestMessage

Static getSigner

  • getSigner(message): undefined | string

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

    +

    Parameters

    Returns undefined | string

Static isNewer

Static isOlder

Static isSignedByDelegate

Static validateJsonSchema

  • validateJsonSchema(rawMessage): void

  • Validates the given message against the corresponding JSON schema.

    +

    Parameters

    • rawMessage: any

    Returns void

    Throws

    if fails validation.

    +

Static validateSignatureStructure

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

  • Validates the structural integrity of the message signature given:

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

    Parameters

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

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

      +

    Returns Promise<GenericSignaturePayload>

    the parsed JSON payload object if validation succeeds.

    +

Settings

Member Visibility

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..913031259 --- /dev/null +++ b/classes/MessageStoreLevel.html @@ -0,0 +1,26 @@ +MessageStoreLevel | DWN-SDK Documentation - v0.2.17

Class MessageStoreLevel

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

+

Implements

Constructors

constructor +

Properties

blockstore +config +index +

Methods

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

Constructors

constructor

Properties

blockstore

blockstore: BlockstoreLevel

config

config: MessageStoreLevelConfig

index

index: IndexLevel

Methods

clear

close

delete

get

open

put

query

Static buildQueryOptions

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..a6412cb55 --- /dev/null +++ b/classes/MessagesGet.html @@ -0,0 +1,9 @@ +MessagesGet | DWN-SDK Documentation - v0.2.17

Class MessagesGet

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

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..1ba9e7df2 --- /dev/null +++ b/classes/PermissionsGrant.html @@ -0,0 +1,23 @@ +PermissionsGrant | DWN-SDK Documentation - v0.2.17

Class PermissionsGrant

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

asDelegatedGrant +authorize +toJSON +asDelegatedGrant +create +createFromPermissionsRequest +parse +validateScope +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

asDelegatedGrant

  • asDelegatedGrant(): DelegatedGrantMessage

  • A convenience method for casting a PermissionsGrantMessage to a DelegatedGrantMessage if the delegated property is true.

    +

    Returns DelegatedGrantMessage

    Throws

    if the delegated property is not true.

    +

authorize

toJSON

Static asDelegatedGrant

  • asDelegatedGrant(message): DelegatedGrantMessage

  • A convenience method for casting a PermissionsGrantMessage to a DelegatedGrantMessage if the delegated property is true.

    +

    Parameters

    Returns DelegatedGrantMessage

    Throws

    if the delegated property is not true.

    +

Static create

Static createFromPermissionsRequest

  • createFromPermissionsRequest(permissionsRequest, signer, overrides): Promise<PermissionsGrant>

  • generates a PermissionsGrant using the provided PermissionsRequest

    +

    Parameters

    • permissionsRequest: PermissionsRequest
    • signer: 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 parse

Static validateScope

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..c56831004 --- /dev/null +++ b/classes/PermissionsRequest.html @@ -0,0 +1,9 @@ +PermissionsRequest | DWN-SDK Documentation - v0.2.17

Class PermissionsRequest

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

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..3eb53d70d --- /dev/null +++ b/classes/PermissionsRevoke.html @@ -0,0 +1,10 @@ +PermissionsRevoke | DWN-SDK Documentation - v0.2.17

Class PermissionsRevoke

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorize +toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorize

toJSON

Static create

Static parse

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..8a27171c1 --- /dev/null +++ b/classes/PrivateKeySigner.html @@ -0,0 +1,17 @@ +PrivateKeySigner | DWN-SDK Documentation - v0.2.17

Class PrivateKeySigner

A signer that signs using a private key.

+

Implements

Constructors

constructor +

Properties

algorithm +keyId +

Methods

sign +

Constructors

constructor

Properties

algorithm

algorithm: string

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

+

keyId

keyId: string

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

+

Methods

sign

  • sign(content): Promise<Uint8Array>

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

    +

    Parameters

    • content: Uint8Array

    Returns Promise<Uint8Array>

Settings

Member Visibility

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..ef10eca5e --- /dev/null +++ b/classes/Protocols.html @@ -0,0 +1,7 @@ +Protocols | DWN-SDK Documentation - v0.2.17

Class Protocols

Class containing Protocol related utility methods.

+

Constructors

constructor +

Methods

deriveAndInjectPublicEncryptionKeys +

Constructors

constructor

Methods

Static deriveAndInjectPublicEncryptionKeys

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

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

    +

    Parameters

    Returns Promise<ProtocolDefinition>

Settings

Member Visibility

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..77e2ea8aa --- /dev/null +++ b/classes/ProtocolsConfigure.html @@ -0,0 +1,9 @@ +ProtocolsConfigure | DWN-SDK Documentation - v0.2.17

Class ProtocolsConfigure

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

toJSON

Static create

Static parse

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..8f228fbca --- /dev/null +++ b/classes/ProtocolsQuery.html @@ -0,0 +1,11 @@ +ProtocolsQuery | DWN-SDK Documentation - v0.2.17

Class ProtocolsQuery

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorize +toJSON +create +normalizeFilter +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorize

toJSON

Static create

Static normalizeFilter

Static parse

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..9367ffdae --- /dev/null +++ b/classes/Records.html @@ -0,0 +1,43 @@ +Records | DWN-SDK Documentation - v0.2.17

Class Records

Class containing useful utilities related to the Records interface.

+

Constructors

constructor +

Methods

constructKeyDerivationPath +constructKeyDerivationPathUsingDataFormatsScheme +constructKeyDerivationPathUsingProtocolContextScheme +constructKeyDerivationPathUsingProtocolPathScheme +constructKeyDerivationPathUsingSchemasScheme +convertFilter +decrypt +derivePrivateKey +filterIncludesPublishedRecords +filterIncludesUnpublishedRecords +getParentContextFromOfContextId +normalizeFilter +shouldProtocolAuthorize +validateAncestorKeyAndDescentKeyDerivationPathsMatch +validateDelegatedGrantReferentialIntegrity +

Constructors

constructor

Methods

Static constructKeyDerivationPath

Static constructKeyDerivationPathUsingDataFormatsScheme

  • constructKeyDerivationPathUsingDataFormatsScheme(schema, dataFormat): string[]

  • Constructs the full key derivation path using dataFormats scheme.

    +

    Parameters

    • schema: undefined | string
    • dataFormat: string

    Returns string[]

Static constructKeyDerivationPathUsingProtocolContextScheme

  • constructKeyDerivationPathUsingProtocolContextScheme(contextId): string[]

  • Constructs the full key derivation path using protocolContext scheme.

    +

    Parameters

    • contextId: undefined | string

    Returns string[]

Static constructKeyDerivationPathUsingProtocolPathScheme

  • constructKeyDerivationPathUsingProtocolPathScheme(descriptor): string[]

  • Constructs the full key derivation path using protocolPath scheme.

    +

    Parameters

    Returns string[]

Static constructKeyDerivationPathUsingSchemasScheme

  • constructKeyDerivationPathUsingSchemasScheme(schema): string[]

  • Constructs the full key derivation path using schemas scheme.

    +

    Parameters

    • schema: undefined | string

    Returns string[]

Static convertFilter

  • convertFilter(filter, dateSort?): Filter

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

    +

    Parameters

    • filter: RecordsFilter

      A RecordsFilter

      +
    • Optional dateSort: DateSort

    Returns Filter

    a generic Filter able to be used with MessageStore.

    +

Static decrypt

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

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

    +

    Parameters

    Returns Promise<Readable>

Static derivePrivateKey

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

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

    +

    Parameters

    Returns Promise<Uint8Array>

Static filterIncludesPublishedRecords

  • filterIncludesPublishedRecords(filter): boolean

  • Checks if the filter supports returning published records.

    +

    Parameters

    • filter: RecordsFilter

    Returns boolean

Static filterIncludesUnpublishedRecords

  • filterIncludesUnpublishedRecords(filter): boolean

  • Checks if the filter supports returning unpublished records.

    +

    Parameters

    • filter: RecordsFilter

    Returns boolean

Static getParentContextFromOfContextId

  • getParentContextFromOfContextId(contextId): undefined | string

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

    +

    Parameters

    • contextId: undefined | string

    Returns undefined | string

Static normalizeFilter

  • normalizeFilter(filter): RecordsFilter

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

    +

    Parameters

    • filter: RecordsFilter

      incoming RecordsFilter to normalize.

      +

    Returns RecordsFilter

    a copy of the incoming RecordsFilter with the normalized properties.

    +

Static shouldProtocolAuthorize

  • shouldProtocolAuthorize(signaturePayload): boolean

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

    +

    Parameters

    • signaturePayload: GenericSignaturePayload

    Returns boolean

Static validateAncestorKeyAndDescentKeyDerivationPathsMatch

  • validateAncestorKeyAndDescentKeyDerivationPathsMatch(ancestorKeyDerivationPath, descendantKeyDerivationPath): void

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

    +

    Parameters

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

    Returns void

    Throws

    with DwnErrorCode.RecordsInvalidAncestorKeyDerivationSegment if fails validation.

    +

Static validateDelegatedGrantReferentialIntegrity

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..e3565fc09 --- /dev/null +++ b/classes/RecordsDelete.html @@ -0,0 +1,13 @@ +RecordsDelete | DWN-SDK Documentation - v0.2.17

Class RecordsDelete

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +constructIndexes +toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorizeDelegate

constructIndexes

toJSON

Static create

Static parse

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..d867093c0 --- /dev/null +++ b/classes/RecordsQuery.html @@ -0,0 +1,13 @@ +RecordsQuery | DWN-SDK Documentation - v0.2.17

Class RecordsQuery

A class representing a RecordsQuery DWN message.

+

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorizeDelegate

  • authorizeDelegate(messageStore): Promise<void>

  • Authorizes the delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

toJSON

Static create

Static parse

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..f7ef62c27 --- /dev/null +++ b/classes/RecordsRead.html @@ -0,0 +1,14 @@ +RecordsRead | DWN-SDK Documentation - v0.2.17

Class RecordsRead

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorizeDelegate

toJSON

Static create

Static parse

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class RecordsSubscribe

A class representing a RecordsSubscribe DWN message.

+

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

message

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Returns undefined | GenericSignaturePayload

signer

Methods

authorizeDelegate

toJSON

Static create

Static parse

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..c49f36b61 --- /dev/null +++ b/classes/RecordsWrite.html @@ -0,0 +1,65 @@ +RecordsWrite | DWN-SDK Documentation - v0.2.17

Class RecordsWrite

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

+

Implements

Properties

attesters +

Accessors

author +isSignedByDelegate +message +owner +ownerSignaturePayload +signaturePayload +signer +

Methods

authorizeDelegate +constructIndexes +encryptSymmetricEncryptionKey +getEntryId +isAuthoredByInitialRecordAuthor +isInitialWrite +sign +signAsOwner +toJSON +create +createAttestation +createFrom +createSignerSignature +getAttesters +getAuthor +getEntryId +getInitialWrite +isInitialWrite +parse +verifyEqualityOfImmutableProperties +

Properties

Readonly attesters

attesters: string[]

Accessors

author

isSignedByDelegate

message

owner

ownerSignaturePayload

  • get ownerSignaturePayload(): undefined | GenericSignaturePayload

  • Decoded owner signature payload.

    +

    Returns undefined | GenericSignaturePayload

signaturePayload

  • get signaturePayload(): undefined | RecordsWriteSignaturePayload

  • Returns undefined | RecordsWriteSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

authorizeDelegate

  • authorizeDelegate(messageStore): Promise<void>

  • Authorizes the delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

constructIndexes

encryptSymmetricEncryptionKey

  • encryptSymmetricEncryptionKey(encryptionInput): Promise<void>

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

    +

    Parameters

    Returns Promise<void>

getEntryId

isAuthoredByInitialRecordAuthor

  • isAuthoredByInitialRecordAuthor(tenant, messageStore): Promise<boolean>

  • Checks if the author of the RecordsWrite is the same as the author of the initial RecordsWrite for the record. +Returns true if this is the initial RecordsWrite.

    +

    Parameters

    Returns Promise<boolean>

isInitialWrite

sign

  • sign(options): Promise<void>

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

    +

    Parameters

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

    Returns Promise<void>

signAsOwner

  • signAsOwner(signer, permissionsGrantId?): Promise<void>

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

    +

    Parameters

    • signer: Signer
    • Optional permissionsGrantId: string

    Returns Promise<void>

toJSON

Static create

Static createAttestation

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

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

  • createFrom(options): Promise<RecordsWrite>

  • Convenience method that creates a message by:

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

    Parameters

    Returns Promise<RecordsWrite>

Static createSignerSignature

  • createSignerSignature(input): Promise<GeneralJws>

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

    +

    Parameters

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

    Returns Promise<GeneralJws>

Static getAttesters

  • getAttesters(message): string[]

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

    +

    Parameters

    • message: InternalRecordsWriteMessage

    Returns string[]

Static getAuthor

Static getEntryId

Static getInitialWrite

Static isInitialWrite

Static parse

Static verifyEqualityOfImmutableProperties

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..6f5c94005 --- /dev/null +++ b/classes/Secp256k1.html @@ -0,0 +1,34 @@ +Secp256k1 | DWN-SDK Documentation - v0.2.17

Class Secp256k1

Class containing SECP256K1 related utility methods.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

Static deriveChildPrivateKey

  • deriveChildPrivateKey(privateKey, derivationPathSegment): Promise<Uint8Array>

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

    +

    Parameters

    • privateKey: Uint8Array
    • derivationPathSegment: Uint8Array

    Returns Promise<Uint8Array>

Static derivePrivateKey

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

  • Derives a hardened hierarchical deterministic private key.

    +

    Parameters

    • privateKey: Uint8Array
    • relativePath: string[]

    Returns Promise<Uint8Array>

Static derivePublicKey

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

  • Derives a hardened hierarchical deterministic public key.

    +

    Parameters

    • privateKey: Uint8Array
    • relativePath: string[]

    Returns Promise<Uint8Array>

    uncompressed public key

    +

Static generateKeyPair

Static generateKeyPairRaw

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

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

    +

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

Static getPublicJwk

Static getPublicKey

  • getPublicKey(privateKey): Promise<Uint8Array>

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

    +

    Parameters

    • privateKey: Uint8Array

    Returns Promise<Uint8Array>

Static privateJwkToBytes

  • privateJwkToBytes(privateJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

Static privateKeyToJwk

Static publicJwkToBytes

  • publicJwkToBytes(publicJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

Static publicKeyToJwk

Static sign

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

  • Signs the provided content using the provided JWK.

    +

    Parameters

    Returns Promise<Uint8Array>

Static validateKey

Static verify

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

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

    +

    Parameters

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

    Returns Promise<boolean>

    a boolean indicating whether the signature is valid.

    +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class TestDataGenerator

Utility class for generating data for testing.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

Static createDidResolutionResult

Static generateAuthorization

  • generateAuthorization(): AuthorizationModel

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

    +

    Returns AuthorizationModel

Static generateAuthorizationSignature

  • generateAuthorizationSignature(): GeneralJws

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

    +

    Returns GeneralJws

Static generateDidKeyPersona

Static generateEventsGet

  • generateEventsGet(input?): Promise<GenerateEventsGetOutput>

  • Parameters

    • Optional input: GenerateEventsGetInput

    Returns Promise<GenerateEventsGetOutput>

Static generateEventsQuery

  • generateEventsQuery(input): Promise<GenerateEventsQueryOutput>

  • Parameters

    • input: GenerateEventsQueryInput

    Returns Promise<GenerateEventsQueryOutput>

Static generateEventsSubscribe

  • generateEventsSubscribe(input?): Promise<GenerateEventsSubscribeOutput>

  • Generates a EventsSubscribe message for testing.

    +

    Parameters

    • Optional input: GenerateEventsSubscribeInput

    Returns Promise<GenerateEventsSubscribeOutput>

Static generateFromRecordsWrite

  • generateFromRecordsWrite(input): Promise<GenerateFromRecordsWriteOut>

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

    +

    Parameters

    • input: GenerateFromRecordsWriteInput

    Returns Promise<GenerateFromRecordsWriteOut>

Static generateMessagesGet

  • generateMessagesGet(input): Promise<GenerateMessagesGetOutput>

  • Parameters

    • input: GenerateMessagesGetInput

    Returns Promise<GenerateMessagesGetOutput>

Static generatePermissionsGrant

  • generatePermissionsGrant(input?): Promise<GeneratePermissionsGrantOutput>

  • Generates a PermissionsGrant message for testing.

    +

    Parameters

    • Optional input: GeneratePermissionsGrantInput

    Returns Promise<GeneratePermissionsGrantOutput>

Static generatePermissionsRequest

  • generatePermissionsRequest(input?): Promise<GeneratePermissionsRequestOutput>

  • Generates a PermissionsRequest message for testing.

    +

    Parameters

    • Optional input: GeneratePermissionsRequestInput

    Returns Promise<GeneratePermissionsRequestOutput>

Static generatePermissionsRevoke

  • generatePermissionsRevoke(input?): Promise<GeneratePermissionsRevokeOutput>

  • Generates a PermissionsRevoke message for testing.

    +

    Parameters

    • Optional input: GeneratePermissionsRevokeInput

    Returns Promise<GeneratePermissionsRevokeOutput>

Static generatePersona

Static generateProtocolEncryptedRecordsWrite

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

  • Generates a encrypted RecordsWrite message for testing.

    +

    Parameters

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

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

        +
      • encryptSymmetricKeyWithProtocolPathDerivedKey: boolean

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

        +
      • plaintextBytes: Uint8Array
      • Optional protocolContextDerivedPublicJwk?: PublicJwk
      • Optional protocolContextDerivingRootKeyId?: string
      • protocolDefinition: ProtocolDefinition

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

        +
      • Optional protocolParentContextId?: string
      • protocolPath: string
      • Optional recipient?: string

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

Static generateProtocolsConfigure

  • generateProtocolsConfigure(input?): Promise<GenerateProtocolsConfigureOutput>

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

    +

    Parameters

    • Optional input: GenerateProtocolsConfigureInput

    Returns Promise<GenerateProtocolsConfigureOutput>

Static generateProtocolsQuery

  • generateProtocolsQuery(input?): Promise<GenerateProtocolsQueryOutput>

  • Generates a ProtocolsQuery message for testing.

    +

    Parameters

    • Optional input: GenerateProtocolsQueryInput

    Returns Promise<GenerateProtocolsQueryOutput>

Static generateRecordsDelete

  • generateRecordsDelete(input?): Promise<GenerateRecordsDeleteOutput>

  • Generates a RecordsDelete for testing.

    +

    Parameters

    • Optional input: GenerateRecordsDeleteInput

    Returns Promise<GenerateRecordsDeleteOutput>

Static generateRecordsQuery

  • generateRecordsQuery(input?): Promise<GenerateRecordsQueryOutput>

  • Generates a RecordsQuery message for testing.

    +

    Parameters

    • Optional input: GenerateRecordsQueryInput

    Returns Promise<GenerateRecordsQueryOutput>

Static generateRecordsSubscribe

  • generateRecordsSubscribe(input?): Promise<GenerateRecordsSubscribeOutput>

  • Generates a RecordsSubscribe message for testing.

    +

    Parameters

    • Optional input: GenerateRecordsSubscribeInput

    Returns Promise<GenerateRecordsSubscribeOutput>

Static generateRecordsWrite

  • generateRecordsWrite(input?): Promise<GenerateRecordsWriteOutput>

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

    +

    Parameters

    • Optional input: GenerateRecordsWriteInput

    Returns Promise<GenerateRecordsWriteOutput>

Static randomBytes

Static randomCborSha256Cid

Static randomInt

  • randomInt(min, max): number

  • Generates a random within a range (inclusive).

    +

    Parameters

    • min: number

      lowest potential value.

      +
    • max: number

      greatest potential value.

      +

    Returns number

Static randomSignatureString

Static randomString

Static randomTimestamp

  • randomTimestamp(options?): string

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

    +

    Parameters

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

    Returns string

    random UTC ISO-8601 timestamp

    +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class Time

Time related utilities.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

Static createOffsetTimestamp

  • createOffsetTimestamp(offset, timestamp?): string

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

    +

    Parameters

    • offset: {
          seconds: number;
      }

      Negative number means offset into the past.

      +
      • seconds: number
    • Optional timestamp: string

    Returns string

Static createTimestamp

  • createTimestamp(options): string

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

    +

    Parameters

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

      Options for creating the timestamp.

      +
      • Optional day?: number
      • Optional hour?: number
      • Optional microsecond?: number
      • Optional millisecond?: number
      • Optional minute?: number
      • Optional month?: number
      • Optional second?: number
      • Optional year?: number

    Returns string

    string

    +

Static getCurrentTimestamp

  • getCurrentTimestamp(): string

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

    +

    Returns string

Static minimalSleep

Static sleep

  • sleep(durationInMillisecond): Promise<void>

  • sleeps for the desired duration

    +

    Parameters

    • durationInMillisecond: number

      the desired amount of sleep time

      +

    Returns Promise<void>

    when the provided duration has passed

    +

Static validateTimestamp

  • validateTimestamp(timestamp): void

  • Validates that the provided timestamp is a valid number

    +

    Parameters

    • timestamp: string

      the timestamp to validate

      +

    Returns void

    Throws

    DwnError if timestamp is not a valid number

    +

Settings

Member Visibility

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..19f10dcb0 --- /dev/null +++ b/enums/DateSort.html @@ -0,0 +1,5 @@ +DateSort | DWN-SDK Documentation - v0.2.17

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..408eda2d9 --- /dev/null +++ b/enums/DwnErrorCode.html @@ -0,0 +1,135 @@ +DwnErrorCode | DWN-SDK Documentation - v0.2.17

Enumeration DwnErrorCode

DWN SDK error codes.

+

Enumeration Members

AuthenticateDescriptorCidMismatch +AuthenticateJwsMissing +AuthenticationMoreThanOneSignatureNotSupported +AuthorizationAuthorNotOwner +AuthorizationNotGrantedToAuthor +ComputeCidCodecNotSupported +ComputeCidMultihashNotSupported +DidMethodNotSupported +DidNotString +DidNotValid +DidResolutionFailed +Ed25519InvalidJwk +EventEmitterStreamNotOpenError +EventsSubscribeEventStreamUnimplemented +GeneralJwsVerifierGetPublicKeyNotFound +GeneralJwsVerifierInvalidSignature +GrantAuthorizationGrantExpired +GrantAuthorizationGrantMissing +GrantAuthorizationGrantNotYetActive +GrantAuthorizationGrantRevoked +GrantAuthorizationInterfaceMismatch +GrantAuthorizationMethodMismatch +GrantAuthorizationNotGrantedForTenant +GrantAuthorizationNotGrantedToAuthor +HdKeyDerivationPathInvalid +IndexInvalidCursorSortProperty +IndexInvalidCursorValueType +IndexInvalidSortPropertyInMemory +IndexMissingIndexableProperty +JwsDecodePlainObjectPayloadInvalid +JwsVerifySignatureUnsupportedCrv +MessageGetInvalidCid +ParseCidCodecNotSupported +ParseCidMultihashNotSupported +PermissionsGrantGrantedByMismatch +PermissionsGrantNotADelegatedGrant +PermissionsGrantScopeContextIdAndProtocolPath +PermissionsGrantScopeSchemaProhibitedFields +PermissionsGrantUnauthorizedGrant +PermissionsRevokeMissingPermissionsGrant +PermissionsRevokeUnauthorizedRevoke +PrivateKeySignerUnableToDeduceAlgorithm +PrivateKeySignerUnableToDeduceKeyId +PrivateKeySignerUnsupportedCurve +ProtocolAuthorizationActionNotAllowed +ProtocolAuthorizationActionRulesNotFound +ProtocolAuthorizationDuplicateRoleRecipient +ProtocolAuthorizationIncorrectContextId +ProtocolAuthorizationIncorrectDataFormat +ProtocolAuthorizationIncorrectProtocolPath +ProtocolAuthorizationInvalidSchema +ProtocolAuthorizationInvalidType +ProtocolAuthorizationMatchingRoleRecordNotFound +ProtocolAuthorizationMaxSizeInvalid +ProtocolAuthorizationMinSizeInvalid +ProtocolAuthorizationMissingContextId +ProtocolAuthorizationMissingRuleSet +ProtocolAuthorizationNotARole +ProtocolAuthorizationParentNotFoundConstructingAncestorChain +ProtocolAuthorizationParentlessIncorrectProtocolPath +ProtocolAuthorizationProtocolNotFound +ProtocolAuthorizationQueryWithoutRole +ProtocolAuthorizationRoleMissingRecipient +ProtocolsConfigureInvalidActionMissingOf +ProtocolsConfigureInvalidActionOfNotAllowed +ProtocolsConfigureInvalidRecipientOfAction +ProtocolsConfigureInvalidRuleSetRecordType +ProtocolsConfigureInvalidSize +ProtocolsConfigureQueryNotAllowed +ProtocolsConfigureRecordNestingDepthExceeded +ProtocolsConfigureRoleDoesNotExistAtGivenPath +ProtocolsConfigureUnauthorized +ProtocolsQueryUnauthorized +RecordsDecryptNoMatchingKeyEncryptedFound +RecordsDeleteAuthorizationFailed +RecordsDerivePrivateKeyUnSupportedCurve +RecordsGrantAuthorizationConditionPublicationProhibited +RecordsGrantAuthorizationConditionPublicationRequired +RecordsGrantAuthorizationDeleteProtocolScopeMismatch +RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch +RecordsGrantAuthorizationScopeContextIdMismatch +RecordsGrantAuthorizationScopeNotProtocol +RecordsGrantAuthorizationScopeProtocolMismatch +RecordsGrantAuthorizationScopeProtocolPathMismatch +RecordsGrantAuthorizationScopeSchema +RecordsInvalidAncestorKeyDerivationSegment +RecordsProtocolContextDerivationSchemeMissingContextId +RecordsProtocolPathDerivationSchemeMissingProtocol +RecordsQueryCreateFilterPublishedSortInvalid +RecordsQueryFilterMissingRequiredProperties +RecordsQueryParseFilterPublishedSortInvalid +RecordsReadAuthorizationFailed +RecordsReadReturnedMultiple +RecordsSchemasDerivationSchemeMissingSchema +RecordsSubscribeEventStreamUnimplemented +RecordsSubscribeFilterMissingRequiredProperties +RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch +RecordsValidateIntegrityGrantedToAndSignerMismatch +RecordsWriteAttestationIntegrityDescriptorCidMismatch +RecordsWriteAttestationIntegrityInvalidPayloadProperty +RecordsWriteAttestationIntegrityMoreThanOneSignature +RecordsWriteAuthorizationFailed +RecordsWriteCreateDataAndDataCidMutuallyExclusive +RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive +RecordsWriteCreateMissingSigner +RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive +RecordsWriteDataCidMismatch +RecordsWriteDataSizeMismatch +RecordsWriteGetEntryIdUndefinedAuthor +RecordsWriteGetInitialWriteNotFound +RecordsWriteImmutablePropertyChanged +RecordsWriteMissingDataInPrevious +RecordsWriteMissingDataStream +RecordsWriteMissingEncodedDataInPrevious +RecordsWriteMissingProtocol +RecordsWriteMissingSchema +RecordsWriteMissingSigner +RecordsWriteOwnerAndTenantMismatch +RecordsWriteSignAsOwnerUnknownAuthor +RecordsWriteValidateIntegrityAttestationMismatch +RecordsWriteValidateIntegrityContextIdMismatch +RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload +RecordsWriteValidateIntegrityDateCreatedMismatch +RecordsWriteValidateIntegrityEncryptionCidMismatch +RecordsWriteValidateIntegrityRecordIdUnauthorized +SchemaValidationFailure +SchemaValidatorSchemaNotFound +Secp256k1KeyNotValid +TimestampInvalid +UrlProtocolNotNormalizable +UrlProtocolNotNormalized +UrlSchemaNotNormalizable +UrlSchemaNotNormalized +

Enumeration Members

AuthenticateDescriptorCidMismatch

AuthenticateDescriptorCidMismatch: "AuthenticateDescriptorCidMismatch"

AuthenticateJwsMissing

AuthenticateJwsMissing: "AuthenticateJwsMissing"

AuthenticationMoreThanOneSignatureNotSupported

AuthenticationMoreThanOneSignatureNotSupported: "AuthenticationMoreThanOneSignatureNotSupported"

AuthorizationAuthorNotOwner

AuthorizationAuthorNotOwner: "AuthorizationAuthorNotOwner"

AuthorizationNotGrantedToAuthor

AuthorizationNotGrantedToAuthor: "AuthorizationNotGrantedToAuthor"

ComputeCidCodecNotSupported

ComputeCidCodecNotSupported: "ComputeCidCodecNotSupported"

ComputeCidMultihashNotSupported

ComputeCidMultihashNotSupported: "ComputeCidMultihashNotSupported"

DidMethodNotSupported

DidMethodNotSupported: "DidMethodNotSupported"

DidNotString

DidNotString: "DidNotString"

DidNotValid

DidNotValid: "DidNotValid"

DidResolutionFailed

DidResolutionFailed: "DidResolutionFailed"

Ed25519InvalidJwk

Ed25519InvalidJwk: "Ed25519InvalidJwk"

EventEmitterStreamNotOpenError

EventEmitterStreamNotOpenError: "EventEmitterStreamNotOpenError"

EventsSubscribeEventStreamUnimplemented

EventsSubscribeEventStreamUnimplemented: "EventsSubscribeEventStreamUnimplemented"

GeneralJwsVerifierGetPublicKeyNotFound

GeneralJwsVerifierGetPublicKeyNotFound: "GeneralJwsVerifierGetPublicKeyNotFound"

GeneralJwsVerifierInvalidSignature

GeneralJwsVerifierInvalidSignature: "GeneralJwsVerifierInvalidSignature"

GrantAuthorizationGrantExpired

GrantAuthorizationGrantExpired: "GrantAuthorizationGrantExpired"

GrantAuthorizationGrantMissing

GrantAuthorizationGrantMissing: "GrantAuthorizationGrantMissing"

GrantAuthorizationGrantNotYetActive

GrantAuthorizationGrantNotYetActive: "GrantAuthorizationGrantNotYetActive"

GrantAuthorizationGrantRevoked

GrantAuthorizationGrantRevoked: "GrantAuthorizationGrantRevoked"

GrantAuthorizationInterfaceMismatch

GrantAuthorizationInterfaceMismatch: "GrantAuthorizationInterfaceMismatch"

GrantAuthorizationMethodMismatch

GrantAuthorizationMethodMismatch: "GrantAuthorizationMethodMismatch"

GrantAuthorizationNotGrantedForTenant

GrantAuthorizationNotGrantedForTenant: "GrantAuthorizationNotGrantedForTenant"

GrantAuthorizationNotGrantedToAuthor

GrantAuthorizationNotGrantedToAuthor: "GrantAuthorizationNotGrantedToAuthor"

HdKeyDerivationPathInvalid

HdKeyDerivationPathInvalid: "HdKeyDerivationPathInvalid"

IndexInvalidCursorSortProperty

IndexInvalidCursorSortProperty: "IndexInvalidCursorSortProperty"

IndexInvalidCursorValueType

IndexInvalidCursorValueType: "IndexInvalidCursorValueType"

IndexInvalidSortPropertyInMemory

IndexInvalidSortPropertyInMemory: "IndexInvalidSortPropertyInMemory"

IndexMissingIndexableProperty

IndexMissingIndexableProperty: "IndexMissingIndexableProperty"

JwsDecodePlainObjectPayloadInvalid

JwsDecodePlainObjectPayloadInvalid: "JwsDecodePlainObjectPayloadInvalid"

JwsVerifySignatureUnsupportedCrv

JwsVerifySignatureUnsupportedCrv: "JwsVerifySignatureUnsupportedCrv"

MessageGetInvalidCid

MessageGetInvalidCid: "MessageGetInvalidCid"

ParseCidCodecNotSupported

ParseCidCodecNotSupported: "ParseCidCodecNotSupported"

ParseCidMultihashNotSupported

ParseCidMultihashNotSupported: "ParseCidMultihashNotSupported"

PermissionsGrantGrantedByMismatch

PermissionsGrantGrantedByMismatch: "PermissionsGrantGrantedByMismatch"

PermissionsGrantNotADelegatedGrant

PermissionsGrantNotADelegatedGrant: "PermissionsGrantNotADelegatedGrant"

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"

ProtocolAuthorizationActionRulesNotFound

ProtocolAuthorizationActionRulesNotFound: "ProtocolAuthorizationActionRulesNotFound"

ProtocolAuthorizationDuplicateRoleRecipient

ProtocolAuthorizationDuplicateRoleRecipient: "ProtocolAuthorizationDuplicateRoleRecipient"

ProtocolAuthorizationIncorrectContextId

ProtocolAuthorizationIncorrectContextId: "ProtocolAuthorizationIncorrectContextId"

ProtocolAuthorizationIncorrectDataFormat

ProtocolAuthorizationIncorrectDataFormat: "ProtocolAuthorizationIncorrectDataFormat"

ProtocolAuthorizationIncorrectProtocolPath

ProtocolAuthorizationIncorrectProtocolPath: "ProtocolAuthorizationIncorrectProtocolPath"

ProtocolAuthorizationInvalidSchema

ProtocolAuthorizationInvalidSchema: "ProtocolAuthorizationInvalidSchema"

ProtocolAuthorizationInvalidType

ProtocolAuthorizationInvalidType: "ProtocolAuthorizationInvalidType"

ProtocolAuthorizationMatchingRoleRecordNotFound

ProtocolAuthorizationMatchingRoleRecordNotFound: "ProtocolAuthorizationMatchingRoleRecordNotFound"

ProtocolAuthorizationMaxSizeInvalid

ProtocolAuthorizationMaxSizeInvalid: "ProtocolAuthorizationMaxSizeInvalid"

ProtocolAuthorizationMinSizeInvalid

ProtocolAuthorizationMinSizeInvalid: "ProtocolAuthorizationMinSizeInvalid"

ProtocolAuthorizationMissingContextId

ProtocolAuthorizationMissingContextId: "ProtocolAuthorizationMissingContextId"

ProtocolAuthorizationMissingRuleSet

ProtocolAuthorizationMissingRuleSet: "ProtocolAuthorizationMissingRuleSet"

ProtocolAuthorizationNotARole

ProtocolAuthorizationNotARole: "ProtocolAuthorizationNotARole"

ProtocolAuthorizationParentNotFoundConstructingAncestorChain

ProtocolAuthorizationParentNotFoundConstructingAncestorChain: "ProtocolAuthorizationParentNotFoundConstructingAncestorChain"

ProtocolAuthorizationParentlessIncorrectProtocolPath

ProtocolAuthorizationParentlessIncorrectProtocolPath: "ProtocolAuthorizationParentlessIncorrectProtocolPath"

ProtocolAuthorizationProtocolNotFound

ProtocolAuthorizationProtocolNotFound: "ProtocolAuthorizationProtocolNotFound"

ProtocolAuthorizationQueryWithoutRole

ProtocolAuthorizationQueryWithoutRole: "ProtocolAuthorizationQueryWithoutRole"

ProtocolAuthorizationRoleMissingRecipient

ProtocolAuthorizationRoleMissingRecipient: "ProtocolAuthorizationRoleMissingRecipient"

ProtocolsConfigureInvalidActionMissingOf

ProtocolsConfigureInvalidActionMissingOf: "ProtocolsConfigureInvalidActionMissingOf"

ProtocolsConfigureInvalidActionOfNotAllowed

ProtocolsConfigureInvalidActionOfNotAllowed: "ProtocolsConfigureInvalidActionOfNotAllowed"

ProtocolsConfigureInvalidRecipientOfAction

ProtocolsConfigureInvalidRecipientOfAction: "ProtocolsConfigureInvalidRecipientOfAction"

ProtocolsConfigureInvalidRuleSetRecordType

ProtocolsConfigureInvalidRuleSetRecordType: "ProtocolsConfigureInvalidRuleSetRecordType"

ProtocolsConfigureInvalidSize

ProtocolsConfigureInvalidSize: "ProtocolsConfigureInvalidSize"

ProtocolsConfigureQueryNotAllowed

ProtocolsConfigureQueryNotAllowed: "ProtocolsConfigureQueryNotAllowed"

ProtocolsConfigureRecordNestingDepthExceeded

ProtocolsConfigureRecordNestingDepthExceeded: "ProtocolsConfigureRecordNestingDepthExceeded"

ProtocolsConfigureRoleDoesNotExistAtGivenPath

ProtocolsConfigureRoleDoesNotExistAtGivenPath: "ProtocolsConfigureRoleDoesNotExistAtGivenPath"

ProtocolsConfigureUnauthorized

ProtocolsConfigureUnauthorized: "ProtocolsConfigureUnauthorized"

ProtocolsQueryUnauthorized

ProtocolsQueryUnauthorized: "ProtocolsQueryUnauthorized"

RecordsDecryptNoMatchingKeyEncryptedFound

RecordsDecryptNoMatchingKeyEncryptedFound: "RecordsDecryptNoMatchingKeyEncryptedFound"

RecordsDeleteAuthorizationFailed

RecordsDeleteAuthorizationFailed: "RecordsDeleteAuthorizationFailed"

RecordsDerivePrivateKeyUnSupportedCurve

RecordsDerivePrivateKeyUnSupportedCurve: "RecordsDerivePrivateKeyUnSupportedCurve"

RecordsGrantAuthorizationConditionPublicationProhibited

RecordsGrantAuthorizationConditionPublicationProhibited: "RecordsGrantAuthorizationConditionPublicationProhibited"

RecordsGrantAuthorizationConditionPublicationRequired

RecordsGrantAuthorizationConditionPublicationRequired: "RecordsGrantAuthorizationConditionPublicationRequired"

RecordsGrantAuthorizationDeleteProtocolScopeMismatch

RecordsGrantAuthorizationDeleteProtocolScopeMismatch: "RecordsGrantAuthorizationDeleteProtocolScopeMismatch"

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch: "RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch"

RecordsGrantAuthorizationScopeContextIdMismatch

RecordsGrantAuthorizationScopeContextIdMismatch: "RecordsGrantAuthorizationScopeContextIdMismatch"

RecordsGrantAuthorizationScopeNotProtocol

RecordsGrantAuthorizationScopeNotProtocol: "RecordsGrantAuthorizationScopeNotProtocol"

RecordsGrantAuthorizationScopeProtocolMismatch

RecordsGrantAuthorizationScopeProtocolMismatch: "RecordsGrantAuthorizationScopeProtocolMismatch"

RecordsGrantAuthorizationScopeProtocolPathMismatch

RecordsGrantAuthorizationScopeProtocolPathMismatch: "RecordsGrantAuthorizationScopeProtocolPathMismatch"

RecordsGrantAuthorizationScopeSchema

RecordsGrantAuthorizationScopeSchema: "RecordsGrantAuthorizationScopeSchema"

RecordsInvalidAncestorKeyDerivationSegment

RecordsInvalidAncestorKeyDerivationSegment: "RecordsInvalidAncestorKeyDerivationSegment"

RecordsProtocolContextDerivationSchemeMissingContextId

RecordsProtocolContextDerivationSchemeMissingContextId: "RecordsProtocolContextDerivationSchemeMissingContextId"

RecordsProtocolPathDerivationSchemeMissingProtocol

RecordsProtocolPathDerivationSchemeMissingProtocol: "RecordsProtocolPathDerivationSchemeMissingProtocol"

RecordsQueryCreateFilterPublishedSortInvalid

RecordsQueryCreateFilterPublishedSortInvalid: "RecordsQueryCreateFilterPublishedSortInvalid"

RecordsQueryFilterMissingRequiredProperties

RecordsQueryFilterMissingRequiredProperties: "RecordsQueryFilterMissingRequiredProperties"

RecordsQueryParseFilterPublishedSortInvalid

RecordsQueryParseFilterPublishedSortInvalid: "RecordsQueryParseFilterPublishedSortInvalid"

RecordsReadAuthorizationFailed

RecordsReadAuthorizationFailed: "RecordsReadAuthorizationFailed"

RecordsReadReturnedMultiple

RecordsReadReturnedMultiple: "RecordsReadReturnedMultiple"

RecordsSchemasDerivationSchemeMissingSchema

RecordsSchemasDerivationSchemeMissingSchema: "RecordsSchemasDerivationSchemeMissingSchema"

RecordsSubscribeEventStreamUnimplemented

RecordsSubscribeEventStreamUnimplemented: "RecordsSubscribeEventStreamUnimplemented"

RecordsSubscribeFilterMissingRequiredProperties

RecordsSubscribeFilterMissingRequiredProperties: "RecordsSubscribeFilterMissingRequiredProperties"

RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch

RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch: "RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch"

RecordsValidateIntegrityGrantedToAndSignerMismatch

RecordsValidateIntegrityGrantedToAndSignerMismatch: "RecordsValidateIntegrityGrantedToAndSignerMismatch"

RecordsWriteAttestationIntegrityDescriptorCidMismatch

RecordsWriteAttestationIntegrityDescriptorCidMismatch: "RecordsWriteAttestationIntegrityDescriptorCidMismatch"

RecordsWriteAttestationIntegrityInvalidPayloadProperty

RecordsWriteAttestationIntegrityInvalidPayloadProperty: "RecordsWriteAttestationIntegrityInvalidPayloadProperty"

RecordsWriteAttestationIntegrityMoreThanOneSignature

RecordsWriteAttestationIntegrityMoreThanOneSignature: "RecordsWriteAttestationIntegrityMoreThanOneSignature"

RecordsWriteAuthorizationFailed

RecordsWriteAuthorizationFailed: "RecordsWriteAuthorizationFailed"

RecordsWriteCreateDataAndDataCidMutuallyExclusive

RecordsWriteCreateDataAndDataCidMutuallyExclusive: "RecordsWriteCreateDataAndDataCidMutuallyExclusive"

RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive

RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive: "RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive"

RecordsWriteCreateMissingSigner

RecordsWriteCreateMissingSigner: "RecordsWriteCreateMissingSigner"

RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive

RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive: "RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive"

RecordsWriteDataCidMismatch

RecordsWriteDataCidMismatch: "RecordsWriteDataCidMismatch"

RecordsWriteDataSizeMismatch

RecordsWriteDataSizeMismatch: "RecordsWriteDataSizeMismatch"

RecordsWriteGetEntryIdUndefinedAuthor

RecordsWriteGetEntryIdUndefinedAuthor: "RecordsWriteGetEntryIdUndefinedAuthor"

RecordsWriteGetInitialWriteNotFound

RecordsWriteGetInitialWriteNotFound: "RecordsWriteGetInitialWriteNotFound"

RecordsWriteImmutablePropertyChanged

RecordsWriteImmutablePropertyChanged: "RecordsWriteImmutablePropertyChanged"

RecordsWriteMissingDataInPrevious

RecordsWriteMissingDataInPrevious: "RecordsWriteMissingDataInPrevious"

RecordsWriteMissingDataStream

RecordsWriteMissingDataStream: "RecordsWriteMissingDataStream"

RecordsWriteMissingEncodedDataInPrevious

RecordsWriteMissingEncodedDataInPrevious: "RecordsWriteMissingEncodedDataInPrevious"

RecordsWriteMissingProtocol

RecordsWriteMissingProtocol: "RecordsWriteMissingProtocol"

RecordsWriteMissingSchema

RecordsWriteMissingSchema: "RecordsWriteMissingSchema"

RecordsWriteMissingSigner

RecordsWriteMissingSigner: "RecordsWriteMissingSigner"

RecordsWriteOwnerAndTenantMismatch

RecordsWriteOwnerAndTenantMismatch: "RecordsWriteOwnerAndTenantMismatch"

RecordsWriteSignAsOwnerUnknownAuthor

RecordsWriteSignAsOwnerUnknownAuthor: "RecordsWriteSignAsOwnerUnknownAuthor"

RecordsWriteValidateIntegrityAttestationMismatch

RecordsWriteValidateIntegrityAttestationMismatch: "RecordsWriteValidateIntegrityAttestationMismatch"

RecordsWriteValidateIntegrityContextIdMismatch

RecordsWriteValidateIntegrityContextIdMismatch: "RecordsWriteValidateIntegrityContextIdMismatch"

RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload

RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload: "RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload"

RecordsWriteValidateIntegrityDateCreatedMismatch

RecordsWriteValidateIntegrityDateCreatedMismatch: "RecordsWriteValidateIntegrityDateCreatedMismatch"

RecordsWriteValidateIntegrityEncryptionCidMismatch

RecordsWriteValidateIntegrityEncryptionCidMismatch: "RecordsWriteValidateIntegrityEncryptionCidMismatch"

RecordsWriteValidateIntegrityRecordIdUnauthorized

RecordsWriteValidateIntegrityRecordIdUnauthorized: "RecordsWriteValidateIntegrityRecordIdUnauthorized"

SchemaValidationFailure

SchemaValidationFailure: "SchemaValidationFailure"

SchemaValidatorSchemaNotFound

SchemaValidatorSchemaNotFound: "SchemaValidatorSchemaNotFound"

Secp256k1KeyNotValid

Secp256k1KeyNotValid: "Secp256k1KeyNotValid"

TimestampInvalid

TimestampInvalid: "TimestampInvalid"

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..b9f90c473 --- /dev/null +++ b/enums/DwnInterfaceName.html @@ -0,0 +1,6 @@ +DwnInterfaceName | DWN-SDK Documentation - v0.2.17

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..d8f110505 --- /dev/null +++ b/enums/DwnMethodName.html @@ -0,0 +1,12 @@ +DwnMethodName | DWN-SDK Documentation - v0.2.17

Enumeration DwnMethodName

Enumeration Members

Configure +Create +Delete +Get +Grant +Query +Read +Request +Revoke +Subscribe +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"

Subscribe

Subscribe: "Subscribe"

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..3c12ae7ea --- /dev/null +++ b/enums/EncryptionAlgorithm.html @@ -0,0 +1,3 @@ +EncryptionAlgorithm | DWN-SDK Documentation - v0.2.17

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..89d1c9124 --- /dev/null +++ b/enums/KeyDerivationScheme.html @@ -0,0 +1,7 @@ +KeyDerivationScheme | DWN-SDK Documentation - v0.2.17

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/SortDirection.html b/enums/SortDirection.html new file mode 100644 index 000000000..266df9985 --- /dev/null +++ b/enums/SortDirection.html @@ -0,0 +1,3 @@ +SortDirection | DWN-SDK Documentation - v0.2.17

Enumeration SortDirection

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..29f51e984 --- /dev/null +++ b/functions/authenticate.html @@ -0,0 +1,3 @@ +authenticate | DWN-SDK Documentation - v0.2.17

Function authenticate

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

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

    +

    Parameters

    • authorizationModel: undefined | AuthorizationModel
    • didResolver: DidResolver

    Returns Promise<void>

    Throws

    if fails authentication

    +

Settings

Member Visibility

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..32b4294c5 --- /dev/null +++ b/functions/executeUnlessAborted.html @@ -0,0 +1,2 @@ +executeUnlessAborted | DWN-SDK Documentation - v0.2.17

Function executeUnlessAborted

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

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

    +

    Type Parameters

    • T

    Parameters

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

    Returns Promise<T>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

DWN-SDK Documentation - v0.2.17

Class Hierarchy

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..b13836cad --- /dev/null +++ b/index.html @@ -0,0 +1,133 @@ +DWN-SDK Documentation - v0.2.17

DWN-SDK Documentation - v0.2.17

Index

Enumerations

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

Classes

AllowAllTenantGate +Cid +DataStoreLevel +DataStream +Dwn +DwnConstant +DwnError +Encoder +Encryption +EventEmitterStream +EventLogLevel +EventsGet +EventsQuery +EventsSubscribe +HdKey +Jws +Message +MessageStoreLevel +MessagesGet +PermissionsGrant +PermissionsRequest +PermissionsRevoke +PrivateKeySigner +Protocols +ProtocolsConfigure +ProtocolsQuery +Records +RecordsDelete +RecordsQuery +RecordsRead +RecordsSubscribe +RecordsWrite +Secp256k1 +TestDataGenerator +Time +

Interfaces

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

Type Aliases

ActiveTenantCheckResult +CreateFromOptions +DataStoreGetResult +DataStorePutResult +DerivedPrivateJwk +DwnConfig +EncryptionInput +EncryptionProperty +EqualFilter +EventSubscriptionHandler +EventsGetMessage +EventsGetOptions +EventsGetReply +EventsQueryMessage +EventsQueryOptions +EventsQueryReply +EventsSubscribeDescriptor +EventsSubscribeMessage +EventsSubscribeOptions +EventsSubscribeReply +Filter +GenericMessage +GenericMessageReply +KeyEncryptionInput +KeyMaterial +MessageEvent +MessageSort +MessagesGetMessage +MessagesGetOptions +MessagesGetReply +MessagesGetReplyEntry +OneOfFilter +Pagination +PaginationCursor +PermissionConditions +PermissionScope +PermissionsGrantDescriptor +PermissionsGrantMessage +PermissionsGrantOptions +PermissionsRequestDescriptor +PermissionsRequestMessage +PermissionsRequestOptions +PermissionsRevokeDescriptor +PermissionsRevokeMessage +PermissionsRevokeOptions +Persona +PrivateJwk +ProtocolDefinition +ProtocolRuleSet +ProtocolTypes +ProtocolsConfigureDescriptor +ProtocolsConfigureMessage +ProtocolsConfigureOptions +ProtocolsQueryFilter +ProtocolsQueryMessage +ProtocolsQueryOptions +ProtocolsQueryReply +PublicJwk +QueryOptions +QueryResultEntry +RangeCriterion +RangeFilter +RecordsDeleteMessage +RecordsDeleteOptions +RecordsQueryMessage +RecordsQueryOptions +RecordsQueryReply +RecordsQueryReplyEntry +RecordsReadMessage +RecordsReadOptions +RecordsReadReply +RecordsSubscribeDescriptor +RecordsSubscribeMessage +RecordsSubscribeOptions +RecordsSubscribeReply +RecordsWriteDescriptor +RecordsWriteMessage +RecordsWriteOptions +SubscriptionReply +UnionMessageReply +

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..963af4bf9 --- /dev/null +++ b/interfaces/DataStore.html @@ -0,0 +1,21 @@ +DataStore | DWN-SDK Documentation - v0.2.17

Interface DataStore

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

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

Implemented by

Methods

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

Methods

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

delete

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

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

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<void>

get

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

  • Fetches the specified data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<undefined | DataStoreGetResult>

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

    +

open

put

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

  • Stores the given data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +
    • dataStream: Readable

    Returns Promise<DataStorePutResult>

Settings

Member Visibility

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..9bf1f1620 --- /dev/null +++ b/interfaces/EventLog.html @@ -0,0 +1,25 @@ +EventLog | DWN-SDK Documentation - v0.2.17

Interface EventLog

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

Implemented by

Methods

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

Methods

append

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

  • adds an event to a tenant's event log

    +

    Parameters

    • tenant: string

      the tenant's DID

      +
    • messageCid: string

      the CID of the message

      +
    • indexes: KeyValues

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

      +

    Returns Promise<void>

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

  • close(): Promise<void>

  • closes the connection to the underlying store

    +

    Returns Promise<void>

deleteEventsByCid

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

  • deletes any events that have any of the messageCids provided

    +

    Parameters

    • tenant: string
    • messageCids: string[]

    Returns Promise<void>

    the number of events deleted

    +

getEvents

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

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

    +

    The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

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

open

  • open(): Promise<void>

  • opens a connection to the underlying store

    +

    Returns Promise<void>

queryEvents

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

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

    +

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

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface EventStream

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

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

Implemented by

Methods

close +emit +open +subscribe +

Methods

close

emit

open

subscribe

  • subscribe(id, listener): Promise<EventSubscription>

  • Parameters

    • id: string
    • listener: EventListener

    Returns Promise<EventSubscription>

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..7974668a9 --- /dev/null +++ b/interfaces/MessageStore.html @@ -0,0 +1,18 @@ +MessageStore | DWN-SDK Documentation - v0.2.17

Interface MessageStore

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

Implemented by

Methods

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

Methods

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

delete

get

open

put

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

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

    +

    Parameters

    Returns Promise<void>

query

Settings

Member Visibility

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..6b6145291 --- /dev/null +++ b/interfaces/MessageStoreOptions.html @@ -0,0 +1,2 @@ +MessageStoreOptions | DWN-SDK Documentation - v0.2.17

Interface MessageStoreOptions

interface MessageStoreOptions {
    signal?: AbortSignal;
}

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/MessageSubscription.html b/interfaces/MessageSubscription.html new file mode 100644 index 000000000..cecdc3c81 --- /dev/null +++ b/interfaces/MessageSubscription.html @@ -0,0 +1,3 @@ +MessageSubscription | DWN-SDK Documentation - v0.2.17

Interface MessageSubscription

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

Properties

close +id +

Properties

close

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

id

id: string

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..12ac105ad --- /dev/null +++ b/interfaces/Signer.html @@ -0,0 +1,16 @@ +Signer | DWN-SDK Documentation - v0.2.17

Interface Signer

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

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

Implemented by

Properties

algorithm +keyId +

Methods

sign +

Properties

algorithm

algorithm: string

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

+

keyId

keyId: string

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

+

Methods

sign

  • sign(content): Promise<Uint8Array>

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

    +

    Parameters

    • content: Uint8Array

    Returns Promise<Uint8Array>

Settings

Member Visibility

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..f39e36bfb --- /dev/null +++ b/interfaces/TenantGate.html @@ -0,0 +1,4 @@ +TenantGate | DWN-SDK Documentation - v0.2.17

Interface TenantGate

An interface that gates tenant access to the DWN.

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

Implemented by

Methods

isActiveTenant +

Methods

isActiveTenant

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Type alias ActiveTenantCheckResult

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

The result of the isActiveTenant() call.

+

Type declaration

  • Optional detail?: string

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

    +
  • isActiveTenant: boolean

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

    +

Settings

Member Visibility

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..cdeaa151e --- /dev/null +++ b/types/CreateFromOptions.html @@ -0,0 +1,3 @@ +CreateFromOptions | DWN-SDK Documentation - v0.2.17

Type alias CreateFromOptions

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

Type declaration

  • Optional attestationSigners?: Signer[]
  • Optional data?: Uint8Array
  • Optional datePublished?: string
  • Optional delegatedGrant?: DelegatedGrantMessage

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

    +
  • Optional encryptionInput?: EncryptionInput
  • Optional messageTimestamp?: string
  • Optional protocolRole?: string
  • Optional published?: boolean
  • recordsWriteMessage: RecordsWriteMessage
  • Optional signer?: Signer

    Signer of the message.

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias DataStoreGetResult

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

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

+

Type declaration

  • dataSize: number

    The number of bytes of the data stored.

    +
  • dataStream: Readable

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias DataStorePutResult

DataStorePutResult: {
    dataSize: number;
}

Result of a data store put() method call.

+

Type declaration

  • dataSize: number

    The number of bytes of the data stored.

    +

Settings

Member Visibility

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..fb1350ed8 --- /dev/null +++ b/types/DerivedPrivateJwk.html @@ -0,0 +1 @@ +DerivedPrivateJwk | DWN-SDK Documentation - v0.2.17

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/DwnConfig.html b/types/DwnConfig.html new file mode 100644 index 000000000..e6ce58a9c --- /dev/null +++ b/types/DwnConfig.html @@ -0,0 +1,2 @@ +DwnConfig | DWN-SDK Documentation - v0.2.17

Type alias DwnConfig

DwnConfig: {
    dataStore: DataStore;
    didResolver?: DidResolver;
    eventLog: EventLog;
    eventStream?: EventStream;
    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/EncryptionInput.html b/types/EncryptionInput.html new file mode 100644 index 000000000..75c983c9a --- /dev/null +++ b/types/EncryptionInput.html @@ -0,0 +1,7 @@ +EncryptionInput | DWN-SDK Documentation - v0.2.17

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..81cddb723 --- /dev/null +++ b/types/EncryptionProperty.html @@ -0,0 +1 @@ +EncryptionProperty | DWN-SDK Documentation - v0.2.17

Type alias EncryptionProperty

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EqualFilter

EqualFilter: string | number | boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventSubscriptionHandler

EventSubscriptionHandler: ((event) => void)

Type declaration

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..2c7f91919 --- /dev/null +++ b/types/EventsGetMessage.html @@ -0,0 +1 @@ +EventsGetMessage | DWN-SDK Documentation - v0.2.17

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..3db416765 --- /dev/null +++ b/types/EventsGetOptions.html @@ -0,0 +1 @@ +EventsGetOptions | DWN-SDK Documentation - v0.2.17

Type alias EventsGetOptions

EventsGetOptions: {
    cursor?: PaginationCursor;
    messageTimestamp?: string;
    signer: Signer;
}

Type declaration

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..f85c0d69e --- /dev/null +++ b/types/EventsGetReply.html @@ -0,0 +1 @@ +EventsGetReply | DWN-SDK Documentation - v0.2.17

Type alias EventsGetReply

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsQueryMessage

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

Type declaration

  • authorization: AuthorizationModel
  • descriptor: EventsQueryDescriptor

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsQueryOptions

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsQueryReply

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsSubscribeDescriptor

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

Type declaration

  • filters: EventsFilter[]
  • interface: Events
  • messageTimestamp: string
  • method: Subscribe

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsSubscribeMessage

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsSubscribeOptions

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

Type declaration

  • Optional filters?: EventsFilter[]
  • Optional messageTimestamp?: string
  • signer: Signer

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias EventsSubscribeReply

EventsSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Type declaration

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..c76ecdae2 --- /dev/null +++ b/types/Filter.html @@ -0,0 +1 @@ +Filter | DWN-SDK Documentation - v0.2.17

Type alias Filter

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

Type declaration

  • [property: string]: FilterValue

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..da4c8fb9b --- /dev/null +++ b/types/GenericMessage.html @@ -0,0 +1,2 @@ +GenericMessage | DWN-SDK Documentation - v0.2.17

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/GenericMessageReply.html b/types/GenericMessageReply.html new file mode 100644 index 000000000..17fefd664 --- /dev/null +++ b/types/GenericMessageReply.html @@ -0,0 +1 @@ +GenericMessageReply | DWN-SDK Documentation - v0.2.17

Type alias GenericMessageReply

GenericMessageReply: {
    status: Status;
}

Type declaration

  • status: Status

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..b87cb5596 --- /dev/null +++ b/types/KeyEncryptionInput.html @@ -0,0 +1,7 @@ +KeyEncryptionInput | DWN-SDK Documentation - v0.2.17

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..32ec75e1e --- /dev/null +++ b/types/KeyMaterial.html @@ -0,0 +1,2 @@ +KeyMaterial | DWN-SDK Documentation - v0.2.17

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

Type alias MessageEvent

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

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

+

Type declaration

Settings

Member Visibility

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..651ee8392 --- /dev/null +++ b/types/MessageSort.html @@ -0,0 +1 @@ +MessageSort | DWN-SDK Documentation - v0.2.17

Type alias MessageSort

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

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..829145c4f --- /dev/null +++ b/types/MessagesGetMessage.html @@ -0,0 +1 @@ +MessagesGetMessage | DWN-SDK Documentation - v0.2.17

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..082f7b7d4 --- /dev/null +++ b/types/MessagesGetOptions.html @@ -0,0 +1 @@ +MessagesGetOptions | DWN-SDK Documentation - v0.2.17

Type alias MessagesGetOptions

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

Type declaration

  • messageCids: string[]
  • Optional messageTimestamp?: string
  • signer: Signer

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..f714b3bb0 --- /dev/null +++ b/types/MessagesGetReply.html @@ -0,0 +1 @@ +MessagesGetReply | DWN-SDK Documentation - v0.2.17

Type alias MessagesGetReply

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias MessagesGetReplyEntry

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

Type declaration

  • Optional encodedData?: string
  • Optional error?: string
  • Optional message?: GenericMessage
  • messageCid: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias OneOfFilter

OneOfFilter: EqualFilter[]

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..940615dfb --- /dev/null +++ b/types/Pagination.html @@ -0,0 +1,3 @@ +Pagination | DWN-SDK Documentation - v0.2.17

Type alias Pagination

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

Pagination Options for querying messages.

+

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

+

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PaginationCursor

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

Type declaration

  • messageCid: string
  • value: string | number

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..b45832938 --- /dev/null +++ b/types/PermissionConditions.html @@ -0,0 +1,4 @@ +PermissionConditions | DWN-SDK Documentation - v0.2.17

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..06cbd895c --- /dev/null +++ b/types/PermissionScope.html @@ -0,0 +1 @@ +PermissionScope | DWN-SDK Documentation - v0.2.17

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..def911d16 --- /dev/null +++ b/types/PermissionsGrantDescriptor.html @@ -0,0 +1,8 @@ +PermissionsGrantDescriptor | DWN-SDK Documentation - v0.2.17

Type alias PermissionsGrantDescriptor

PermissionsGrantDescriptor: {
    conditions?: PermissionConditions;
    dateExpires: string;
    delegated?: boolean;
    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

    Timestamp at which this grant will no longer be active.

    +
  • Optional delegated?: boolean

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

    +
  • Optional 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..16c25f234 --- /dev/null +++ b/types/PermissionsGrantMessage.html @@ -0,0 +1 @@ +PermissionsGrantMessage | DWN-SDK Documentation - v0.2.17

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..8301727af --- /dev/null +++ b/types/PermissionsGrantOptions.html @@ -0,0 +1 @@ +PermissionsGrantOptions | DWN-SDK Documentation - v0.2.17

Type alias PermissionsGrantOptions

PermissionsGrantOptions: {
    conditions?: PermissionConditions;
    dateExpires: string;
    delegated?: boolean;
    description?: string;
    grantedBy: string;
    grantedFor: string;
    grantedTo: string;
    messageTimestamp?: string;
    permissionsRequestId?: string;
    scope: PermissionScope;
    signer: Signer;
}

Type declaration

  • Optional conditions?: PermissionConditions
  • dateExpires: string
  • Optional delegated?: boolean
  • Optional description?: string
  • grantedBy: string
  • grantedFor: string
  • grantedTo: string
  • Optional messageTimestamp?: string
  • Optional permissionsRequestId?: string
  • scope: PermissionScope
  • signer: Signer

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..9950f8f30 --- /dev/null +++ b/types/PermissionsRequestDescriptor.html @@ -0,0 +1 @@ +PermissionsRequestDescriptor | DWN-SDK Documentation - v0.2.17

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..36bcbb1ea --- /dev/null +++ b/types/PermissionsRequestMessage.html @@ -0,0 +1 @@ +PermissionsRequestMessage | DWN-SDK Documentation - v0.2.17

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..32b23b93d --- /dev/null +++ b/types/PermissionsRequestOptions.html @@ -0,0 +1 @@ +PermissionsRequestOptions | DWN-SDK Documentation - v0.2.17

Type alias PermissionsRequestOptions

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

Type declaration

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..a74deae7e --- /dev/null +++ b/types/PermissionsRevokeDescriptor.html @@ -0,0 +1 @@ +PermissionsRevokeDescriptor | DWN-SDK Documentation - v0.2.17

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..8f689f37e --- /dev/null +++ b/types/PermissionsRevokeMessage.html @@ -0,0 +1 @@ +PermissionsRevokeMessage | DWN-SDK Documentation - v0.2.17

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..a62c8dc15 --- /dev/null +++ b/types/PermissionsRevokeOptions.html @@ -0,0 +1 @@ +PermissionsRevokeOptions | DWN-SDK Documentation - v0.2.17

Type alias PermissionsRevokeOptions

PermissionsRevokeOptions: {
    messageTimestamp?: string;
    permissionsGrantId: string;
    signer: Signer;
}

Type declaration

  • Optional messageTimestamp?: string
  • permissionsGrantId: string
  • signer: Signer

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias Persona

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

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

+

Type declaration

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..76f4ab69c --- /dev/null +++ b/types/PrivateJwk.html @@ -0,0 +1,4 @@ +PrivateJwk | DWN-SDK Documentation - v0.2.17

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..f1c1a9d7d --- /dev/null +++ b/types/ProtocolDefinition.html @@ -0,0 +1,2 @@ +ProtocolDefinition | DWN-SDK Documentation - v0.2.17

Type alias ProtocolDefinition

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

Type declaration

  • protocol: string
  • published: boolean

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

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

Settings

Member Visibility

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..f273a9292 --- /dev/null +++ b/types/ProtocolRuleSet.html @@ -0,0 +1,5 @@ +ProtocolRuleSet | DWN-SDK Documentation - v0.2.17

Type alias ProtocolRuleSet

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

Type declaration

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

    Encryption setting for objects that are in this protocol path.

    +
  • Optional $role?: boolean

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

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

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

    +
    • Optional max?: number
    • Optional min?: number

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..827569ad4 --- /dev/null +++ b/types/ProtocolTypes.html @@ -0,0 +1 @@ +ProtocolTypes | DWN-SDK Documentation - v0.2.17

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..8722b858f --- /dev/null +++ b/types/ProtocolsConfigureDescriptor.html @@ -0,0 +1 @@ +ProtocolsConfigureDescriptor | DWN-SDK Documentation - v0.2.17

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..47c33c60d --- /dev/null +++ b/types/ProtocolsConfigureMessage.html @@ -0,0 +1 @@ +ProtocolsConfigureMessage | DWN-SDK Documentation - v0.2.17

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..2b3b9b36f --- /dev/null +++ b/types/ProtocolsConfigureOptions.html @@ -0,0 +1 @@ +ProtocolsConfigureOptions | DWN-SDK Documentation - v0.2.17

Type alias ProtocolsConfigureOptions

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

Type declaration

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..23dc41df0 --- /dev/null +++ b/types/ProtocolsQueryFilter.html @@ -0,0 +1 @@ +ProtocolsQueryFilter | DWN-SDK Documentation - v0.2.17

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..99e0720bc --- /dev/null +++ b/types/ProtocolsQueryMessage.html @@ -0,0 +1 @@ +ProtocolsQueryMessage | DWN-SDK Documentation - v0.2.17

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..e4e714c30 --- /dev/null +++ b/types/ProtocolsQueryOptions.html @@ -0,0 +1 @@ +ProtocolsQueryOptions | DWN-SDK Documentation - v0.2.17

Type alias ProtocolsQueryOptions

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

Type declaration

  • Optional filter?: ProtocolsQueryFilter
  • Optional messageTimestamp?: string
  • Optional permissionsGrantId?: string
  • Optional signer?: Signer

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..012ba548d --- /dev/null +++ b/types/ProtocolsQueryReply.html @@ -0,0 +1 @@ +ProtocolsQueryReply | DWN-SDK Documentation - v0.2.17

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..cda8568ba --- /dev/null +++ b/types/PublicJwk.html @@ -0,0 +1,8 @@ +PublicJwk | DWN-SDK Documentation - v0.2.17

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/QueryOptions.html b/types/QueryOptions.html new file mode 100644 index 000000000..446faee78 --- /dev/null +++ b/types/QueryOptions.html @@ -0,0 +1 @@ +QueryOptions | DWN-SDK Documentation - v0.2.17

Type alias QueryOptions

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias QueryResultEntry

QueryResultEntry: GenericMessage & {
    encodedData?: string;
}

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

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

Type declaration

  • Optional encodedData?: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RangeCriterion

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

Type declaration

  • Optional from?: string

    Inclusive starting date-time.

    +
  • Optional to?: string

    Inclusive end date-time.

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RangeFilter

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

Ranger filter. 1 condition is required.

+

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..b00efd462 --- /dev/null +++ b/types/RecordsDeleteMessage.html @@ -0,0 +1 @@ +RecordsDeleteMessage | DWN-SDK Documentation - v0.2.17

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..848f460d5 --- /dev/null +++ b/types/RecordsDeleteOptions.html @@ -0,0 +1,2 @@ +RecordsDeleteOptions | DWN-SDK Documentation - v0.2.17

Type alias RecordsDeleteOptions

RecordsDeleteOptions: {
    delegatedGrant?: DelegatedGrantMessage;
    messageTimestamp?: string;
    protocolRole?: string;
    recordId: string;
    signer: Signer;
}

Type declaration

  • Optional delegatedGrant?: DelegatedGrantMessage

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

    +
  • Optional messageTimestamp?: string
  • Optional protocolRole?: string
  • recordId: string
  • signer: Signer

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..ed4e103a9 --- /dev/null +++ b/types/RecordsQueryMessage.html @@ -0,0 +1 @@ +RecordsQueryMessage | DWN-SDK Documentation - v0.2.17

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..3ad6bdd4e --- /dev/null +++ b/types/RecordsQueryOptions.html @@ -0,0 +1,2 @@ +RecordsQueryOptions | DWN-SDK Documentation - v0.2.17

Type alias RecordsQueryOptions

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

Type declaration

  • Optional dateSort?: DateSort
  • Optional delegatedGrant?: DelegatedGrantMessage

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

    +
  • filter: RecordsFilter
  • Optional messageTimestamp?: string
  • Optional pagination?: Pagination
  • Optional protocolRole?: string
  • Optional signer?: Signer

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..689bc3529 --- /dev/null +++ b/types/RecordsQueryReply.html @@ -0,0 +1 @@ +RecordsQueryReply | DWN-SDK Documentation - v0.2.17

Type alias RecordsQueryReply

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

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..d01fbeac9 --- /dev/null +++ b/types/RecordsQueryReplyEntry.html @@ -0,0 +1,9 @@ +RecordsQueryReplyEntry | DWN-SDK Documentation - v0.2.17

Type alias RecordsQueryReplyEntry

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

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

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

Type declaration

  • Optional encodedData?: string

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

    +
  • Optional initialWrite?: RecordsWriteMessage

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

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsReadMessage

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

Type declaration

  • Optional authorization?: AuthorizationModel
  • descriptor: RecordsReadDescriptor

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..f96abd700 --- /dev/null +++ b/types/RecordsReadOptions.html @@ -0,0 +1,4 @@ +RecordsReadOptions | DWN-SDK Documentation - v0.2.17

Type alias RecordsReadOptions

RecordsReadOptions: {
    delegatedGrant?: DelegatedGrantMessage;
    filter: RecordsFilter;
    messageTimestamp?: string;
    permissionsGrantId?: string;
    protocolRole?: string;
    signer?: Signer;
}

Type declaration

  • Optional delegatedGrant?: DelegatedGrantMessage

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

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

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

    +
  • Optional signer?: Signer

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..627ddac53 --- /dev/null +++ b/types/RecordsReadReply.html @@ -0,0 +1 @@ +RecordsReadReply | DWN-SDK Documentation - v0.2.17

Type alias RecordsReadReply

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

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsSubscribeDescriptor

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

Type declaration

  • filter: RecordsFilter
  • interface: Records
  • messageTimestamp: string
  • method: Subscribe

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsSubscribeMessage

RecordsSubscribeMessage: GenericMessage & {
    descriptor: RecordsSubscribeDescriptor;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsSubscribeOptions

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

Type declaration

  • Optional delegatedGrant?: DelegatedGrantMessage

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

    +
  • filter: RecordsFilter
  • Optional messageTimestamp?: string
  • Optional protocolRole?: string
  • Optional signer?: Signer

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias RecordsSubscribeReply

RecordsSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

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..512c10ad5 --- /dev/null +++ b/types/RecordsWriteDescriptor.html @@ -0,0 +1 @@ +RecordsWriteDescriptor | DWN-SDK Documentation - v0.2.17

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..231dd3fdd --- /dev/null +++ b/types/RecordsWriteMessage.html @@ -0,0 +1 @@ +RecordsWriteMessage | DWN-SDK Documentation - v0.2.17

Type alias RecordsWriteMessage

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

Type declaration

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..86184e0ce --- /dev/null +++ b/types/RecordsWriteOptions.html @@ -0,0 +1,5 @@ +RecordsWriteOptions | DWN-SDK Documentation - v0.2.17

Type alias RecordsWriteOptions

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

Type declaration

  • Optional attestationSigners?: Signer[]
  • Optional data?: Uint8Array
  • Optional dataCid?: string
  • dataFormat: string
  • Optional dataSize?: number
  • Optional dateCreated?: string
  • Optional datePublished?: string
  • Optional delegatedGrant?: DelegatedGrantMessage

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

    +
  • Optional encryptionInput?: EncryptionInput
  • Optional messageTimestamp?: string
  • Optional parentContextId?: string

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

    +
  • Optional permissionsGrantId?: string
  • Optional protocol?: string
  • Optional protocolPath?: string
  • Optional protocolRole?: string
  • Optional published?: boolean
  • Optional recipient?: string
  • Optional recordId?: string
  • Optional schema?: string
  • Optional signer?: Signer

    Signer of the message.

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias SubscriptionReply

SubscriptionReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Type declaration

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..bd1b36843 --- /dev/null +++ b/types/UnionMessageReply.html @@ -0,0 +1,10 @@ +UnionMessageReply | DWN-SDK Documentation - v0.2.17

Type alias UnionMessageReply

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

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

+

Type declaration

  • Optional cursor?: PaginationCursor

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

    +
  • Optional entries?: QueryResultEntry[] | ProtocolsConfigureMessage[] | MessagesGetReplyEntry[] | string[]

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

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

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

    +
  • Optional subscription?: MessageSubscription

    A subscription object if a subscription was requested.

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file