From 358d8a1f92d041d6f580c87c84f48c1811dbeafa Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 15 Feb 2024 14:48:00 +0000 Subject: [PATCH] 2024-02-15T14:48:00+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 | 133 +++ 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 | 10 + 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, 2729 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..53ac29082 --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA829W5PcNrKo+19a+1HTU8SFZPlNlmxv2cuXbdmz4oRjYqJUxW5xVE3WVLEk90ys/36CAMFKJDNB8KJ9zpMuBWQmCRBIfEgk/nN3rj9f7r764z93H8vqcPeV2GyzRIuXd9Xuqbj76u7N5+p1XT2Uj3cv767n491Xd83zqbj8tf//+w/N0/Hu5d3+uLtcisvdV3d3//PSSUu1lmkv6x//aOsGBb3oywB5L+9Ou3NRNZ45NyXJRqhex6E8/Fpc6uOn4hyj6N4vP6L0vrOO0d0U1a5qvts1Uc947xVfprn4VFTNu+Zc7J6iVPvll+l+Ki6X3WPxrqnPcc+NKizTftg1u3jVsPQKb/y/6vBn4b1uW3iyVqFvH9A3WGlZNcX5YbcvLn91vwW/R7FReS+tPhXVqKQXXSna7t4gRsX+WF+KcR2u2Dwlu9OpqA7jWvpy89Q8Fo0pchnXBIvOU/ava3F+jlXnF56n8FAci6awQr5+fl1GvE+qytxuUuzOMd3EFpugxJ/MrK3fFc2PdghCHy/+eeRTYmT/WpyOz5xk8+MMuf+nbeKQ1bDAXPm85befZ8h+d31/2Z/L98Wbov3z1NR4ambLLXUuwoLHnA3efGZS6HvuHDPuYe2JBo1O0c2H+jDLqL7q2haZnvpb+VRcmt3TaaZtAyHrWvlQHpvifJll3K3uYptGPqvQsIALrfxBQakTvyZnNfPqd9fmQ30u/71ryrqabMQ9rj7FpDGPM3IUo8zy6i6zaaRT8GO5X2T6eN7VP7Vv9n/vqsNxsNLiiq3S+Ti5Ud2Psj3gaqMVFXZM7M/xDvfFvfkYiS9g6dAjWRsZlcVT2URp6wrOVhRcTEBF4+uJsKLwkgJqilhVEKr8Ht99fqYw6o3wp6U9eyBrrDd7doXn2EhV97fi4ypHhsiyKptyd/zvczlAIax6VGeODbjx4NdOjYeD3ycNht8VVXEu9/Ts6/+4tHsQ0sY6CLJu6lzGa4yZw1DtcGcJzfQBM+Jm+DFLwo1KdRqixLrNexM5rY2tscxLvjS75ood2RG9932laPXjL7gr/a4+M+Np+8tKw2kvKnI0NUbxnLF4fS52TYHXUYyye7/GqOJxzln8cn1/LC8fJlkA6yy1YWTRxpkRvUwLWgKdM1cQjN+UR0AUC/Ysfw4jCRgn8kWAflHWMkpZ54bVG3ZywqqDX1K08vvIjwvWtlbzo8Qvu8eyoiaE2w9LxwgkaWyIABZxbXc9XwbzKK3lvi87pmzkizyW0L8PqnRFp2vEjdPBwMv12HxTNWc8QeKfJzlVXWfhGe2wwFz51OSOf14km3o5ZJmVpjtCaOTEh0wOD/9wbyBS/71XdYIpcRPSXHNWtaWo9vWhOLzZNbvJ9vh1V7TpfB6MSBHWdLUW2YE/jm8NDkW22P9c2v2BlLH+3lkRIFz/uu6OpK3gl0mjws9V8fMDKRH8Mknir7vqsSAlgl+mS3zdrrzPwynX/3FpYxHSxhoNWcex+nONYx94Xfdd6RiFY0EfdbxWU3aeTt5Deh32O+zP63lLQF68z9TZOHViCWmNmVMG9cNN+Wl3vE558HtXYa520rP62bjIeK0Of1ramANZYw3p2cURhvrc/HKuT8W5IT1CQt89qjOufKQBW3lvynOxJ1YOQSNgpcVWUE45qz3slk/QSi4/WLUjC5Cw3sFYVJyfysul7eh1dSip7ksVWTwmcTJHxyXKXua1nlp+sieXoiPq7/2q8aZMeeHv9nXgvZhfJ3kCt7qX7867qmFDNviC6zUrKTm+cQdPMDFqI86QiLCNgKAZcRuRZo0EbiywKQgBo62LZIKz7TzdKv5a/OtaXJq3M98kI2lle1tY+82fp/Jc8GNn0ExfwMrWPbali8O3U8cBZ5xX/8vY9ht2xKeZ9hvvmy+17GvsEE2z7GveN5rf24pj8UhsZsT2NVB9dcuGTH+ibVDAytZdgvNt0C5XdWWL9uMuV9Asr/5y28YcCprqMqXmui7dMB3jvAyKrui+0LInODDD55jvwgSNmebEDEUtc2PCpsU7MtPtinVlxiyc7sxMtTVmAg5bOW0KnmlfaBKOMi9uGp5pXWgijrIubiqeal3UlBe2b+KkN9XCkWkvbFv0xDfVqpipL2zatMkvwr7xSWl0AvTLzZ8CP9Uf+RMXgZKrToCE6EnzH3qIJdMfb8rU2Q9JWjr5BQybMvdNtCp+6gvaN2fmm2QpWH0b1zC0ig/aSgpawdrRjzDiiwfFpn3w57qp9/XxYk+PXs+BLz5QdPEnPyZ79JsPPcfUjz7SmJivPiRqzmcfa9rYd7/ErvCHH29h7Jc/39ZD8WCiwoduUayVnoQ17OM+wDdjpt4KrPWxIYmxnxiwlBtxu5KT9N6DWrEGjI38TLjrmCGjEa+TLTF6p1nhqqxkwaU5X/fNdZDmYMQKWG2+JYs75c2OTvhfkukGgYcZ/x5/C7SY+W2tr/AmLPYDtKaNP8Kv12PxrhhEd/q/rvUYUFzsgzgDmS77v4pqf34mV7W80vt/eLWiDBj5dP7Xbk+uEUNG3KqsYsHjsX6/O/5aHye8/vt/eLVWsWNfV03xZzPVEL/aTEtY19XEGpDhbFSR1VxVLDPaRYX2zptBOd3xc6gnIf5V9y4OsyThys1bkwRyVpBlFmihYrmJEtMOO/cDERPWNCyw+IAzLXH0aPPQUu6s3fGxPpfNBxwpGVZ8D6vFmhB3RLQ7v/e3Yk+cpw8bxUhYyb6PxfM33Pw1YhiuOt+iQZxusa/Ph8sbk3iH/rKoItNiga2AwMdLlJitgfpwB78vk04dw6ALzdHza7E7BF8TKLA4dpqWOBo/PbR0xlHcsPLI47iEkLitkcHgMGJOxCHlGFsCjR7ouf3PczrUeLYkvuBKHWxuvqTAE0xkeHGGRBC8gKAZ/C7SrBF6t8CmILuLti6S3M2284E8mxJnXV93uU1jH1hw2J6UOGlMU2CsWJCNp5NgMmaMDRao0EoDBSU1cpDAVs8bIAIGxA8OWMj8gSFkTtygMM0WZp0ZYc3oSnORPb/smg/zbepqr2jXudiXp3KYwifCKFh1RYsu+w/FEz4oGmFOX2/NVjO1B/uqMS12q7miPW2S3uFZsAhzbhVXtuZd+e8ZAxCoua49TCKSOJNGc5LMHBVjXJPw+DjNLZnYx5m9pJhOPrqfNLsduYQukS05nttldo//tj4/7WYMl17dZTaF3J2g6wZLhB0df+VbVE17XOsm9eFa2X2Av8KfJ/lor/ZN+an4zWR6f/2h2H+0iTGQ4UyppV5aSOyYm8YZzvlpF1hhuh33AwGTzBqlCM2uxF5SjFV9xaXWiFsCw1fHY/351fH42/C2gE7LX4dFgl1BJ7cOt68ru08KVgIjYl/4dZhHHVoNez1I0Mh0hTEjYjtA0A6QI4p4vSClUeSbjXkwXmrsM5HPArsM9Ibce3xdHuJN39dPp2tThOS88MrQhra/MRpOu/MlLB+UmCy9s+3N7vGX96/Lw7fn+unr5wbs8HNPQ9VYQzvKDBujfuS6DV9/7CcNFI5/w74K2MEgDx/ogD/GdznT3OOyXrhyQWfBGsY1j3FoI1T1Befrcpi7eNOdgItQS9WZZkEqEsVnPeI1U3mOmsvhL+XlL2X1oWj9pMN0/ZfysSqGXXGovi+4pnb7NqNf+xd49l0bg/TL7vlY74bDHf0WUJVlFsH+2NTfv/v5pwgr+oILdfObbXTeEqLESvBxchYTythFy1k2u8bUteyENB8hts7aEwfVJ1jRrj6JFK5jdoBqa1ly4jJFjtniVVzLGjQ0xllCDJML34mLxRrGeY2+Fb/qav3FnRc3Jy+m9hpceYFVcIXwZnB1GHDl+x/jPR4uBb4vKpwA/2YT5+xwGWKRlnBe2FE1pyu5wEFKbKmZKh6LGBW21EwV9oaqCC19wdmtwlxgNWiV0A1WtBp0H6Mr88u1IVnSsMDS+ZaRODbdEpZOQ+xhveN4nag/Chn7Oia9Zej19gVWe72+xOjXe7N05usl9U54vbf6ETsp5B2VEZaM3FUZYwtY774ZmuJc59tP8SN/U9M0Asl6cSsXeozQ7SdN/fP7fxb7IVYbquoLztX1wFIWrOxhlK7EaYt8Nq/oXH2H68lkZyvi+8ILus4EC2KxDlYcQ3dIhV6X9132oro+GU3jVy4ktyGs2z18ddkX1aGsHkPiXhCFWdsHty8MdLabRfFKvdJztPa7a3HPShZfpDfyeeny0ZoHM2BxLj8Vh1/O5addU3z/+SMerPHvi+c/UuDo9Dcwk4v9qOvmh+J5EN4QVHsPa0UaMLoEMiVNVsYPxdOkt3BPVF7bKiJmJ9amYMDOLIv68j8UOG4uwihUe75dwGP43wdoihunzf/G+wnWOuLRhvJeEGXpB7GWhTWaTKRxCkHROH2xcxpQFTOdYTW3Z/qheH7DfUx2gCRKxM5vb/oAhkuk0Bd+FfppKJvp0b8DMK/tmbtYG4bVVrLDGxYijQiOB9EWmN920a1wKz5LL1wcfK6GDtnn8Ln9mA0pJ2NsH6rVH0V/hoLD0IeXezrX++JywWE1AwWDcpM1fdodyxYDM9EBvaZBudmaOmPfVk3xeC6b4Rg40EnUiNGO+tDrdpBjntH9Fh6VvB2J3Z9vuhW5CYFoM6V9XXxjLw4ZVfFirDr7fP1TzFjEYCOiVjGkSvRqv/HuNQH6zA+rxMp4wmItt3YxLdi+6lE1h+BHheUPX8prqKRbLYCfYmfBVyDe7fvPlx/bREXDZQgW/IKtFn4iY/SoHbdYwdfl4cfy8rRr9nhqCpvESVjBurKufqzPxW8fdtXPVfHObfn+VDfvrqdTfYbRuhGmxolbYnd/Vs/+46e6+fkz3LoKGcnXXcWin+rmO5cM8pW/2x9lFVl/rmWv+6iotsx+UoOG6y636MfrsSk/7C4fZlrF1Z9r2Zvy8KM55TLJHq7WAitaSc05ZsRChZfp/FvrP0SqdGUXaPy1uNTHa9vjv92Vx7g3TdSZa8E3B6F1sn1bGbcJgiJOP1Vjtvb2CuhvnsqmKc6WerbD0KlAvgFrylj1RXbdTvWBW8Z/r8qn07F4KqqYryJezlxLzfW9u+P3ny9/K87lQ1mcvyuafvn/U918W1+rcUOjxaxnZ9eB+mlxho2EiNn2tXONNwGZ/7FXMUS8v7HqK9sV68uNVl/ZLpsEc/b7ulVfz663bh8/2tuMk7GehXbiXGDeQMB6tt3csG/rM1ruxxtIS/kSVkY7m5FCVv4+fqqb/6do7HmCuR8JkjHXQoNm33j4vxtPRw0LVp1rjxvXn/vh/Pfq4jzJ1+dPo1ZFCJhr29vqUPzZPaK9BvBv7aWBv8F9MM6scN31LHpHXd0Xb9S7mFv8ptkFRb6tfiye6vM0yxgBi2zrpj7z9937YzHtlQVqL+j3b4qWGf1y3JWVjYjogsxjv8coEXPt6zjqd0Xj+kuERUyluTb80p06mr56D9Vcas28lftY7dlWoczo37nLLqIdixgJa1n3U928ekPHE8eaR4pYyz5z6WK3D/f28Ko6BLbSxk0dk7aq1XYP7Zdz/aF8354I+bYsjge8AxdpMytrLYt/r/qDVTO7ASVhBeu6dP52vMc6pxg5Jmg1W+GLsP8z3UxSxmwL+7CHd+ZwxO9VO2X+Vr8pDtd98WqQxZK1MlrOl7HUDzyaZ+VIGNIMC2+u7fUcsZiIEDDfNjuY+bsK+25N1e1URhgYJ+ULWNmmO75Es7IJgla19Y2LW319y+T86yAn0iSrx0R+Gfu/61Nir2U+LXFV699W+/rc3i/+ZphYZZLRtKAvY2vvciw0Fcr5MpZOc6+miFrZXrsw9RN/TbTTF/El7IsCExECVrWtc4EW9klCypew0jt1OcfA4NnLhbahOyVmmdfLWNXCX0z9Y3G5rPhljwtd9Rlab2N+84PaX+DNOt/itQtlKqvHV9W+uLThMB92ZbXkDccIX/eZuv9c5noRUla10pxF/u+y+VBfm/n9gpCyqpWtTPdtL/OqGElLrb3dRwGczVfNjS3MGiimSl3vKW4+54oPESV0vWfoZvtJvZqrvbpVdknV9cSfH+YbOBT0hWz9+WHGejdO1vpt7j7tnx+swgUdgBC1nr1m4Fz0XocS1rMOArMZpqHqi+0yjzrPJqrqXHv6+0vM7Sg/1T+2uwdl9fhDf6lKGwkQM+NPkbTY2jZ9hDcVRobkRQhYaJtpHHsm1t4X1Z8XbfdIY/cJJwpbw2az27WSyeOyFlo8DLh47a4Wt7Fwzt/s5uVY62fI/b/yJO0l5VHhbXOlrv4U9hNzY5bZoore3pwpdPVnsLmNzn1U6MpPEyt+9efyNzmXPwgr78tY/lPdU4WFNvuSvoy1TsFKr5kQ92XtbpcyK9uORH4Z+yPJb6SQxR6Lf7r89+rdtE3BeDkLLXVLm44m+cd4i8enGFgxSdRCe9FJbHzmeDLKni12pedovw1G29RBb5rINXxI6/L1SMp6F13kXVmMR7ZMk7XQYnttXHM9V4UN8TpFsJVw3RUsWrCq4asvtGv58ZoJgtaydaW+OEHeUsttRgXmS502nUXKWmjx37oD/P3JfT/I71V1eHv45s/y0hTVhEMdC4Wv/Uy3kwbVwQbkLH6SoMiF9pvbWF41TZsJ2R2IMUqpA86xTzBV6Jd6hnln0udK/VJP0flFXdx3dFj7bLGrPMf8aSlQfw3LLB5zI5ufEDrGMrr+epa1wUOvqsMbe1naj9fmujsen7/5c3+8XmLOFs2RuK71r1sf/uDymTh9b6tlTzAudb2n6HdP/XjuNR5lgug1nsc1+pyxb1h3LYtMC841CVVew6bvisbcMP728Ht1KB7KqjhEHjaMlbKSlW+rsil3R/PP6NiKOBlrWPj26enawNNTrz/sqseJQ39AyBo2zh/5v8SY38ls+/Xb6pdz8amsr9FrjaCEFa3r8lAtN5ITtPKbROmCJ77FscTBc6yaimKYumv2/0nrQ7LmGtaYzESvqoM9Oj5rTmBFrGFf+7G/uhgVv1cfq/pzNWNiCAhZw8bBehF4+7PeaKTAL2L77G2meHFf1u6f6uZtZeeId9xtVMseJazhizzdm9vFxOu0Cy3wi9jeRZO0e9ozHeFokV/Efvtj61ROCP6ZI3Gu9XZC6LTUZ/vPaO90rPYqVnUQIQZh8fVmW1LsT0KnHxObcCkuDRlTaa4N/V1nseE5RIW5un8/H0Ek90/twahjVCcOVFzXlna1MdOaruoCe/oeP+3N0NXWtCP2rXAVJ9ni5UrtszL9tBskD8c/GzN8bYHMbzHCXvRF2SfwDQxl14jTCAov0QlOfUep9csv0uyCTeP0gtJLtHazXJTOW9nJGr2+2SXDJDvm7bfYXtnHC48KewGLso8ArKP1+bnPeWWjOdDHNH1HnWPDar4LH1Qb1UGnbBhoGUvIMKbHv3iZ1eOKzdbT7siPq+lKLdDyr2txiXhvt4ILdNHpKoaqxlJSjGkyru64Ildstp43/qWFrKI3I3cWjmvqQwnGlcGiE/WB1O0Wzw2TrXf/HxzTvNz+73eXIlW/n4+/MTevQYkviNL0Mzj7xrUyN5VxakduKxvT2xr9W/21kzeidlh6iVaUSDmkciSNcpy+qDeLis7SV5vaUR0IF52l72LeTnQzUsWX6R1/Tlw0Vl/spQqespg7FYaqvOHEuNHQD+gVuV/ih5RTe0RkRNALV4ixtreH0cFcDIOUjFwPQ2rxb6l/Yu5xQYqeiGtcQpfCR2hGF2Aziokbrxfq3fnQnNG7G1LxFZ6XJLCBJ2d56mRb/JtBv3/3809j+vtSS7T6Fwb2ZbpLt3sT7H1t+OfgFxlxXSApb+y2wIGNYEDx7mgxCU0naLzva8QpnnN/fFD/yOXxE/V3I0LP5qZYQtSdbdNgkPcXSH7nNr+tM9DfREUN9daqOYM9UBQ13A80TRnwgbJ5Q/6I9uCgD5TPGvZHdAcHfqB71tAf8dwRgz96AwuG/2B/C04AwIZZU8BQMzUJ2AOEgWkAFlhnIhhIjJsKPEunD8ac1rjh2KsdHpAfTJB/5Mt0RtwqrWRFYFpkjYiaGCfYEDU1sdZMnJxG7BpMT0OS4n9+/e/rTFO+uKip6mbhnOkKKYyaskiNU6YtpHTe1BVhRXD6QkbMmsIibAhOY8iGWVNZ5HuImM6IN7JgShvtl8FpDdkya2qjLaCmt75kaIrDhdaZ5kipcVPdwOrp011Ie9yUN5CwwmAftGrigD/RvtC0HDQrbmqOsMan6l2wEAXcup/iJ55dcRE6fd2cu8pjQl8QFVia5wwd091l7YnXfaswV3exL4tLHxUT+/BcrXWsiH0NXK0pVviTQXn55tSe0Dzvjj8Uz+2dkeficiGuGsamBCpOsGYCUfa0R0LloULqc+LyzBMlYrfjX7n+GinyBaww9jg3e+kAFa+TxBowqDXHisF82pd+W52uDR5H/V8Xz6CEuNGpExnIzAO7QQ8ZVXm/G711ANcOz0WlPW7THWX8W+F9J+PmMNXXsOxj8TzBEFt6Jb2owmCmDttB1J5pF+74PwyEI8uGBZZ2f0bi2BdAWMq87gM61D9J/z1RO9agkW5wcpeQgiwrUSb5Fde2ZqYt61nCDVojloyPW1GWAMcVxpAPZnb441JqMpA1gkw8w6bxkqGqEVgSr+vbc/0Ura8rPF/nY3/YNELnrfBfxCKt5QWeHo3Q7FdYqP2xaF7RIIZ85JFDVvEtC44/RTewX2epBei0T7QVw3qL3v7Exh/WmK/9k7kA9Jt/XXfHsnn++QGfEi6J4JmhRXFSlvVQ0/CQPoQ7KSg+TW8cqx0qpUDtdH0MER2qI3DodG2j7HOoNwg+p1tQf6Yg9FCtK7dYF3t4cER39JHAOFvKixlDDl/3+ZSiRn2i0tL2j3r9I7ST0eb7XxM+4N3srzeCoQ/VEQB9qq7CeoDvnp+eiuZc7m8eIfR9eRPG6s+3rG26yBZerKc7jR2p7lb6/7q/9v+lt7ZQt3W/2kGgE2qrRXtw4xIWeFWOQ5r7nqNcB6LKfP39udsJgypVZ6IFPuzwkiiQW2ZEiaW4gxM5xjsoY5kB/Dy4JSdK9f159E4cSsIIVsCJP+JMOY3l/JhviXd/zTRrgrfUzLfIu6RmmkXBG2qmW3Txk6LE2XIJ50OZbsW5O54/vfu6aqu1kKk6TIYc2UiD2mvZddg1U1upq7KmBa/LqW/kVmtNO9qEaDMM6aqtaInL6DHdGFBzLXtGYhTGjIoOUJjxVbkrTqZ+T6Demq32y0x7cN01+zS6hze+V4/cuztjTqDibkbnhPhlaOQ78ZIZT30vuPJaVu1ukNOSxlgHst+0oASsZV0R3MkbM21Ye7Xv/5Z1wTTI9ImVErDAOrwweN1vUdDLgsHvSxcFtMCxJcHQzKBD1SWxQ5w0woB7un6kUdNdmbAxQUdmqnZuKgqbMD4RTbVjZLIOmxM9Vc9oG3ZyHG2kiKlxqj3kVBQ2ZGQimvxGQtPQyCuJm4SmWjQ6BYWtmjABTbUsPP2EzYqdfCZ/7/ySe+STj1lwR1iTgvfzZ7G/NsXvVXv/96v35lKi3qaHa2UuHL38lSoWDucDIQzffx6ive8/h+crjG1/KIfI1sl40f9Ov5FWPy/Z9rg3I/Jhqcla7IYnv3HcKxoWnKzrULTZAH457srKpn7gdq56pYEak7UXfzbn3b4Jvk2vzGQNcEud71YvcLFFeuLURGqJjdq96YgI18UPMgio+3HXFOdyhxEo+GWFEDpPVETsXG8UH6NIhaVRau4/jkWi9bVG4yJ/2ZV4fg9o7UrP0Dv/pTq9ncy/8CHHQwN6m4MxeN9//jjTlHsoYKpRozOnuUNviXFQwnLr8Jf2C2fg7YeRaQ/JYxqj///oSRgvudww0/1//GT8qUtk+/2li0bdBWW+IMvTb97ZODZZhxXCYnP1vCYmMKwkxJBHNOzrp7boqBav3DxNNg4OXuQzopKssEA37/YQesddn/G2+6n4XFyamP7+gig9V+vPx8MErbj0LK3lpTV+5Gu4FZqpozV1VIcrNFPHaHQTUhcd2BT3Hf7IgY/QR0lUmmWDGx/7rv/OOHujH0ywXqwlsc4oegHjDulQFTEZkWnJwG9LQ9qxqJGIdmjVtID2gaKReHZGU1ww6UDZ1EP/UdqZYL+B8omH/aN0M2GtA90TD/lHP3cw4pN8A7MO90f0NyYocWDDxEP9nGbf+QSl6C2IYYGli0hG4thakrA0zLhfl4fIh0F8u6sYa8YcljxiyAhMnmzDCPWPey3Rs2DQLtwBf6/au25sxV+L0xEfCxv8Hp4w9CAv/LumBtNs6TKP909tfo+fhepTUUVJe9GVDL4qaxw3ER3rS5zlL1zR+cogOA+qClHyGEWPRaSix0DK8hhF//JS5QVV/SuYTzxG2cFPVh3UdggnrI7rGsXuHNs1bNFpypjvCM8RjOaYmWIwSAJwGSH2RV9l/MGI+QI4qr+gTf7BTIwLLHVZSXkjfuvAyGnOK61yxION1dleZ07uVoa142qBM4vTnr7dFwM1cBb+mHfCilhmX7+e29en2EbCdf5/0VbL7XAx9rEGgPLTNcctumjNU1de8XYwyy/ajIlrsHgrmIVYqBm+0LsILsn4tzJrXRbbT5nFGW3NxBVa0Aa0R4CK0ms1ptTSBVtI7NiqjTN83kIlwpL41QonbDxU6Zs/T+W5mPL2YbjSrfaqdhVtprSTB/8n2OXVXtOux7ZocfitnmEVrPsFbPoarzUn2PQ1v1xYZNO3g5xFE4z6NgBr5/aqbtaf1adudde0CQTldn7ZIIAgxjxGzJqWXjw3L960yyRXLzJ1cV0dyqmTRp/DGFZe9Q1RcCzqFYUJWbw19EIwYs3QFVlxMQglxi8HnamzF4Se2vglIaF3spvtqV7gaI/aMu5qe6bMd7ZHLRl3tz1L5jvcUe8k1uUevJ2lTvdIrx13uz2L5jvelB2s690VHnW+/XIrut+E4AkOODJ/sQvOWzPLCUfiVnB3AwZOdHgn2Rbh8gYsm+T0zrEr5PaO2xXn+M6xK+j6jhsW6fxOsmzEgQsYFe3CTbInxokLGDXNjZv2pkYcudCrinblRi3inDnvalRyMmlLrOrK9QKneHLGzgWO3E3pFD8upDWK00LFk0DtUPcMF/Kme5EHGbYkxoG8GbLEfwzbEeM+4sb4Uu8j3nn038xy3zHUY2Ncx5s9SzzHgRUBx7EtG+E3gmKruo1Y7iSvEdq+gtPI2DLTZ4TSFp4Gj7JywpHwmXaOT6WcbVNm0rA9cCK1pxp+KJ6ZwHxcINhxY4NRSaFRUakDe6MOHoX1hg8exWoc5psOax1PNB3QPJ7xj1YazPoXelKvy9gzrMOze/0v8b6WyYtevKoObytzcNGcivGSIY6peREngntk9yxzOrFnRlzvHaojX+3runooH6kI8mGRxY4tLXHMsx2aOtG1ZdSO+bZBvZEOJqN6soc5wRbOxWRMmepjTrCEczIZS6Z6mRPfSdjNDLydeX5mdK/lHE3GoqmeZtgOfCQRF2Z8Ta7cYmczKHjU22TNn+luxlgzwd9kxY0xygdzqcwQUUbZ51Vf1zLaxYyyaszHnGnRuHMeZd0U73yCpdQETN/E7f+82sQbfR83Mm/mhBt/K3ecvqrNFXcs/118a679i1I8rLPEggDHInRHQCxW60QHY8Gd5LE2jDkW828mj7VgzKGYfz/5lHcQ50iscUt5XJ8ccyDm31Ue0M84DoEby8kyqzkMk+8tp01e6Cgsvy+bFhWe9B780TDWpocpA+IaDsHcW97nWBLvCLBWzXEC4i867xI9Dj7b7v+ngA36TlMo6MVh5ApTZw17+L1DDj8Uz2/6C+a8zOSk2mC9lS35/VJWj2/6jLIXdHneRPtYaV/Catd92v9YwWxS3Je0u0sZvqLpWOKXsN5mmFmjn2BJs6y1dPGGRsc+6EHpWVrdsaBX1b64NPX5h+L5VXV4U1z2RTV82suPu2Y/8s3PlDjL+sei+cUU7fqLSWX4MMx/Txo6XnmWTWOLFM+G2NXJeE//VJybGI246KJe45/m+rV4KNr65e74tmqKx3PZjPTiSXJmWXr5UF+PBzesvGKXb55ZfKVZNlhH6221P14PxaVPMxvjAbwYrbuCRb9XpwU2kbVjrYrdAqFH4/FLhcLO1xv/tDVSZn9dyl6GwuIuS+1sm0ZeCGVx16WOaIu8fcnTO/H6pbAF0fcvQRMmX8A0tGHSnY1Q91QIE2lB+F49aMBEBBOpP3yL5PDlf4nnj7lkEb+JWfglqmeG7wKEdkyEL7x28lYwW45GL1SRpeSFlRl5MZhvL7OKD9+sxOqOvlrJl7Ao+c2oTVMvqJli2/jNXLxdU67mmmJT6B4W3pq4i1im2BFzEwtvz7SrWMbsGrogvxb8INb+tpL70YuKcz6MVbNcj5uiOMcjpCl60r8pnTzlY/2TJvyb3pnTfVh7eLK/KZ831Yd1hyd6/MLXf+6YSd5/A0um+FAvDE/wNxvmTe8DzeTk3pYKTu2gwEoTO5YYOa1DS6dsV4S1ju1VELXXmMw5a6ZO5fF2hSZNzpq4KTPehtjrrjh7pt92NcG2UUeHtWqCmxNvT4xzwVk0zbUI2zR0LN5d37dHE9+zk1dfYCUXw5cX52fcjJzlbCCVcR7HqM5otwOpn+x7kJZMckCQBTO9kAg7wq4IMmOePxJhRdgpIZvjC72LGPeEeCtLfJTRfht2VJA187wV2gbSZemLBv0WXGol54UUG+nBDAxf5EKELJnsRwyEzYgLibErztuaaE3ItQlaE+ffTLRm3JEI2jTFm5hoWYxLEbRtml8RYR1wLt4V+5PQ6cdkMMz0v8S7E273j9rs9sW98IvSD3SzjXNfzIGdH4rn32p4TQ6jclB6rtZ+jz5O7aD4oqf9/vPH3+qvnxti04Z8Xq/8sieeoJqoMFM3eUQNqQueTRvVYC/eG+2wrtRMLY9FVZxtP/DuGGPUDYuvo/fX3eeJqm2N2dq7U3URQwIqu1RjxKeJys7U2EXuxD7msPgyvXx8Ea14PMIoUvPrD2UbUzFN/bBSvA2xsQVIcUx0AfnIINc5OuIM8pBHnG0OHC+mBY2cK556mphRMn6MeMLhYUZHeGTG4oFbUp+bN+W52HunpIrq+nT5q/db+MXfGtCGqx3K6nFU2guvLGO6Zx+p8VW8wlfz9QFXrl11DL6F9j/jHbjLsSiGN2D1Ml6432kjjQGM5KeyKp92x3cjClCx6Xrau/mu57Ygf6PXTR1derpWC6piNA5LztX288PDpYh6Sq78dM3Oa4/RSpWN0hg7zIMHjBjhkRL44bRR4eY+iP8qPhXHgR7/5+DHFGs6ITLqIZClzAywNwcXY5Xaokv0vT/W+48X7zqdkE6v+ES9/JU7IY3BG3fidPl37gRfafDKnTht8NKdkK7QnTtxmh6JW/goTaFLd+I0oZtwQspGLsKJbTF4FU64xUI34fDfABhCvvlUVM1/1Y/0COL9usoAMpQYNX74ZjKf8/VYHr7dtXKGPj2h1y++QG/ZxpXGaHQFp+kaHzoIVcGRI0oTPXBQ7RccNyJ1UV2e1BXq8VG6dqdTUQ23SghlfckF2sxFXKbkkD0RKv3iC/Q+Fk28Vlh4gU47+llJXz9T90QTuqlKE7/F4R2tAadoUCJ+kfH+Wh4P5LnisPAXVEX6GYf2Tx9iGSMmXIA721PjVYectWitAX+Ne/PjLlu0dnqYZxSHh/qQzvHhnlEZfT3jjGGfa9joWxon+3KMxtg7FMcH5ViN8VcpzvEiGaUTblSc7I8zKmOvwZwxkbO9J/Yix1EP9punsmmK87vmXOyG2QiHRdbzZYdi4x1a32oObbHhU5x+WGOpdt7fJBSPO51ROgOeJ/W2x93PKK3FUzn8VjilXeFZOgdJdS91tUO7693/Lg1CgWIiMuQaQ7hggBIHXxLC7w8B/82VDwcd+NsMvKaRDKaxurwtzaC24G4mq29eIzl9nby/JJGKezu5WJPBBmO8Cfen0R1H2pjR+Be35T7LKFh7Rau4nMUDi8ZTFDMdEW6AFJempTXf2Q1sChnjEvGrFrcrjgeasOgXw2oMnh7YPmbHeMLXMZMoCWtbR2fDi7Xs/wSdxslWdRFS/91GQ061CdVd+T11SYf7E/ezTBwTtpLNbVqNJWYS9ddt31l9DtVd1yI+dj/Oqnejruhcy5iMCXFmvQkvr6Z/DeMX7Y0Ps7F3cy+xjr4iO962cCDnsvdG3mkz5bV1AlayzSLJ7wg0MWITrLiqLbOGB7/qqvbMHhyG1Veyq2MGc1rNr7qSPS5hz86LBoq0CFf+Eja9c0dBFhkHpSy08ryrDvVTL/Bdc4aBSCPGcZXXsWmOKataQEcwBw0IxzBP1P/6fX1+92EndErt7QTtwFVXsedt/FQGK6yiOxBIFLIgIqYo1g4bHPWmPPxaXOrjtf0Ofy0u12P0OwkJWGmseVMe2mDseStPXHm6TdEBWcwLionOGqr/+8tuq+ir/7Qh+q1zcvfVnbiX99u7l3cPZXE8XO6++sMa9vJuXz89tbL+3v32t6JV2JawRf66uXv5x+ZlKu+3Mv3731/+4WqYH8x/mGLJ3cs/kpciv99stl6xxCsm7l7+IShpwism717+IV/q/D4XuVdMesXU3cs/FFVMecX03cs/NFVMe8XSu5d/pFSx1CuW3b38I6OKZV6xnCuWe8W2dy//yF+q9F77r23rv932ZW9fKnWvssx/vagZTDtsKL2J3xJJ+8aThCzpN0bSvvREkCX99kja956QDZf4TZK0rz5RL9X2XmTSL+m3StK+/URTfSbxGyZpGyBJyZJ+2yRtGyQZWdJvnqRthyQnS/pNJNqGSLZk3/bbSLDfikAfi/laNi9Vdp8r4Zf0m0i07SASsqTfRKJtByFeyvReicQv6TeRaNtByJda36vUbyLhN5Fo20Eo8tH9JhIZ++h+C4m2GYQmlfstJNpmEClZ0m8h2TaDIFtd+i0k23YQZKtLv4mk4B5IohFNcmOV9BtImgbaUs8j/QaSbStI8luXfgPJlBllpN88MuOGGek3j2zbQCbkC/KbR27ZF+S3jmqbQIqXcnsvU7+k8ltHtU0gJaVc+a2j2jaQZMdUfvMoM+OQo4xCc47iHkj5zaM02zGV3zwqZTu78htItc0gySFO+S2kctZMv4FU2wyS/CqU30LatBD5VWi/hTQ7wmm/gbRpILKza7+BtPl+Ni+1uN9qv6DfPpof4DRyC9pWUGQn1n4D6bYVFOm3aL+BNPsFab99NNs+2m8f3TaCIudU7bdPuuFEpn7zpG0jKEW8y9RvnrRtA0W6TqnfPKlpHrJjpn77pMZpI/tb6rdPatqH7G8p8txM+5Bzb+q3T8pOQKnfPmnbCpocXFO/gdItO3ClfgNlbTNossNlfgtlbTtossNlfhNlbTtoSTlSmd9EmeQePfNbKGubQZOjZua3UGY8a3LUzPwWytpm0GT/yJB73baDJvtH5jdRxn5Cmd9CWdsMmuxImd9CuWkhsiPlfgvlbTOk5MIo91soZ12E3G+gXLJdLvdbKG+bISU7Uu63UN42Q0p2pNxvoTxlzfQbKG9bISWn3xwtgdpmSEmnJ/dbKN+yA03ut9B2w41dW7+BtqaByL659RtoyzbQ1m+gbdsKKdmJt34DbU0DkZ146zfQ1jQQ2Te3fgNt2Qba+g20zdhlw9ZvoG3OLhu2aJm6ZWfVLV6qtu2QbslF4AatVjdtS2T0cnWD1qubtjGyhGh5+xMs2rZGJsiiaMW6aZsjk2RRtGTdtO2Rkd3Z/gbLtk2SaVIsWrVuDFBIyaJo2boxUCEji6J166ZtlYxeuG5QixmGkJGjXjLgCzzowYAh4ZevCUYMCb+ATTBkSHgPL8GYwcAEutNgzmBoAt1pMGgwOIHuNJg0GJ5AdwSMGgxQoDsCYg2JIQp0R0CwITFMIScnqkRgJNS2Sk7OKwkiDolg3YkEIYfEMge6IyDokFjqQHcEhB0Syx3ojoDAQ2L4Qi5I4ITYQ2IIQ07OcAmiD4lhDDnpLCWIPySSddATBCASSyDoV4YQRGJIA/PKJEZ5kn9lCEQkBjfk5KScIBSRGOCQ0+wNwYhEshNZgnhEYrBDTvZzRCQSwx3ynCyK2syQh5we7xCVSAx72NKfD+ISieLHRgQmEoMftvSXhtBEovgvTWH+2jbLlnT3EoQnEgMhGLGoxQyF2DJcFzWZ4RBb+oNAjCIxKGJLs12EKRIDI7Z0D0OgIjE4YkvzXYQqEp5VJAhWJAZJ0L0R0YrEQIktPf0iYJEYLLGlu6PG2Nw02obuj4haJIZNJBu6lyFwkWh2ZZwgdJFYdrERL/XmfqswvUftZiBFsqE7DyIYiUUYG7r3IIqRpHavg9kaQG1neEWyofsPghmJQRbJhu5AiGckhlokG7qtEdJIUtt+dGOneOeDHygR1kgMvaARYoLIRmL4BQ0mE8Q2EkMwkoTubwhvJAZiJAnd3xDhSDL+u0OII8kCjiSCHEkWcCQR50iygCOJSEdiUQfJWRLEOhJDNJKEHoYzvGllvruE9jYQ8Ugs8kjo7wNRjyRj0XuCsEdi4AbzhhH4SAzeYN4wQh9Jzo+YCH4kBnEkCd2FEf9IDOVIEnK3NkEIJDGgI0nIzdgEUZDEYhBmxw+RkCS3bUevdREMSQzySASFsBOEQxIDPWguniAgkhjuwfRixEQSQz5oJwlBkcSwDxK4JwiLJFu7QUzvJSMykhj+kQh6OxnBkcQgkETQHwfiI4kFJPQ+ZIIYSbLlpzsESZKtbTi6ZyJOkhgakgh6nkGoRBgcktBbkgKxEmF4SHtuQ2b3WY4Lo51jQ0QYmwXCJWLDhlsIhEvERoXkog3kjW09Zk8c7SEbLJJIcqYRiJkIA0YSegNSIGoiDBpJJB12griJMGwkoXcXBQInItkEmgSRE2HJCb0bKRA7ETY6Q+qXKrkXCkcJoPazARoybbcgtjpDhVELdjEaGeW8CYRPhGEk9N6GQPxE2EANmb+U8l5tUWgBIijCxmrILf18qAFtuIba0IVRA9qIDZXQhVED2qANemdP4LCNQNzGIHBD8FEWOHTD0BLasxA4eMPQkoTeDRQ4fsPgEq4sajwRajwcxGGjOBQZvSNwIIewjafpwqjxDDEhZ3WBYIowxISKaRCIpQjDS8g9WYFQirDhHIpicAKhFGFwSaLoDwmxFCFtw+V0YdRwkg+OEgimCAtT6L1PgXCKkHz4DcIpQvLeikA8RdgYD00P3QioCMVCMIF4irA8hbYBARVhoEmiSR9EIKIiLFHhCuOAKdN09GasQFBFWKii6ekDYRWhbGgbPSMgriIMO0nozVaBwIqw0R/0fqtAZEWobWAWQ2hF6E1gBEJsRVi2Qm/mCkRXhLYtSHreAvEVoW0L0t0eARZhIEpCb9YKRFiEJSz05qpAhEVodoUuEF8Rlq/QW7ECERZhCUvKvGXUfpawpHQ3QoRFWMJC74sKRFiEJSz0jqdAhEVYwpJmpGuICIuwhCXNyQdEhEVYwsJ0UERYhCUsKd0zEGERlrBkdM9AjEXY2JGM7hkIsog055ezAlEWYSlLRvcNRFmEpSwZPcQgyiIsZWFcQ8RZhGEp9ESJMIuwwSQZ3ecQZxGGpSQZ3ecQaBEGpiQZ3ecQaRGWtGT0AINIi7Ckhd4TFYi0CEtamD6HSIuwpIXeQRWItYg8tGhAsEUYoJLQ23cC0RZhI03o/TuBeIuwvCWn+xziLcLylpzuc4i3CMtb6D0xgXiLsLwlp/sG4i3C8hZ6m0kg3iIsb8npvoGAi8htnDfdNxBxEYaqJPQGkkDIRRiuktA7SAJBF2FDUeh9IYGwi7DYhd7tEQi7CItdtnQLIuwiLHahN3EEwi7CYhd6F0cg7CIsdqG3cQQCL8KCF3ofRyDwIix4obdcBAIv0oIXes9FIvAiN3YvlmxBicCL3FhWTYdGI/AiDV0RG7IFJUIvcmN30ckWlAi9SENXBL2RIhF6kYauCHojRSL0Ijc2uohsQYnQizR0RdAbKRKhF2noiqA3UiRCLzKxxJpuQYReZGKRNd2CCL1IG7ZC72JIhF5kF7dCtyBCL9IGrtCoXyL0IhMbCEG3IGIv0uAVQZ+SkYi9SINXBH1QRiL2IhMbIka3IGIv0uAVQcNzidiLNHhF0CdmJGIv0gAWIegWRPRFdvSFbkGEX6Q9OiPoFkT8RXanZ+gWRPxF2lAWmkdLBGBkF8tCtyACMNIwFkFDZokAjLRHaZhzLwjASHuahjn6gs/T2AM1NN+V+EiNjWih+a7Ep2psSAtzwGRwssa0IM13JT5dY4/X0HxX4gM20h6BolsQn7ExsEXQZ0gkPmhjcIugT3JIfNjG8BZBn9GQ+LyN4S2CPqYhEYyRhrgISbcgwjHSIBeh6BZEPEYa5CLo0xUS8RhpkIugMaxEPEYa5CIU3YKIx0h7CEfRLYh4jLTncBTdgojHSINcBH3kQSIeIw1yEfSpB4l4jDTIRdAHHyTiMdIgF0HzP4l4jDTIRdCgTiIeIw1yEfRxBYl4jDTIRdCQTCIeI+0RHRqSScRjpEEugoZkEvEYqe1JKroFEZGR2sZM0C2IiIzU9kAi3YKIyEgDXQSNsiQiMtJAF0GjLImIjDTQRdAoSyIiIw10ETTKkojISANdBM2nJCIy0kAXQR8CkIjIyNQehKNbEBEZaaCLoPmURERG2qgXmk9JRGRkF/ZCtyAiMjK1p0rpFkRERhroImjkJBGRkQa6CBo5SURkpI18oZGTRExG2tAXmiJJxGSkjX2hKZJETEYa7CJo2iMRk5EGuwia9kjEZKTBLoKmPRIxGWmwi6Bpj0RMRhrsImjaIxGTkTb+hQY4EjEZaQNgaCYjEZORBrsImslIxGSkwS6CZjISMRlpsIugmYxETEYa7CJoJiMRk5EGuwiayUjEZKTBLoJmMhIxGWmwi6CZjERMRhrsImgmIxGTkTYKhmYyEjEZabCLoJmMRExGGuwiaCYjEZORBrsImslIxGTk1h71plsQMRlpsIugmYxETEYa7CJoJiMRk5H2vBDNZCRiMtIeGaKZjERMRtpTQzSTkYjJKINdBM1kFGIyymAXSTMZhZiMMthF0kxGISajbDAMzWQUYjLKYBdJMxmFmIza2PP69HF0xGSUwS6SZjIKMRllsIukmYxCTEYZ7CJpJqMQk1EGu0iaySjEZJTBLpJmMgoxGWWwi6SZjEJMRhnsImkmoxCTUQa7SJrJKMRklMEukmYyCjEZZcNhaCajEJNRBrtImskoxGSUwS6SZjIKMRmV2OwLZECjQkxGGewiE3KnTSEmowx2kTSTUYjJKINdJM1kFGIySgh+I0ohJqNEILRCISajDHaRNO1RiMkoYQOaBJlrATEZZbCLpGmPQkxGGewiadqjEJNRBrtImvYoxGSUsAfM6b6BmIyyZ4zoQBOFmIyyTIYMM1UIyShDXSSNkRRCMspQF0ljJIWQjJK2AelOh5CMsklPaIykEJJRhrpIGiMphGSUoS6SxkgKIRllE6AwSUgQklGGukgmDwlOg2LzoDCpSHAmFBWICVU4GYrNhsJkD8H5UGyIDB2AqAYpUVTg48ZpURQfU6hwYhQVCEtTODeKCsQUKpweRQViChVOkaICMYUKERll06QwGVUQkVH86SOFeIwyyIU8+a4QjVE2OoZ5bYjGqEDCFIVgjNL266O/awRjlA2OYboQgjHKhscwXQjBGKVzvgshFqNsdAz3LlDb2egYpgshFqNsdAzThRCLUTY6hulCiMUog1skjWUVYjEq5RMSIRKjbGwM8y4QiVGWxJD5vxQCMcqwFrpvIgyjLIahuxuiMMqmVqGJs0IURtm4GKa7IQqjQnExClEYlQm+uyEIo7LQp4cgjLKBMUx3QxBG2cAYprshCKNsYAzT3RCEUYazSJrVKwRhFJ91RSEEo7LQp4cQjMr5YywKERhlCQzdNRGAUYax0GdXFeIvyiAWSe9DKMRflEEskt6HUIi/KINYJL0PoRB/UQaxSHofQiH+onLbePSsjviLygNRTQrxF2UPIdGbFgrxF2UQi6Q3LRTiL8ogFklvWijEX5RBLLLNi0O0NuIvasuelVaIvigbEUOfYlWIvigbEUOfYlWIvigDWCS9c6IQfVEGsEh650Qh+qIMYJH0zolC9EVt2fN/CrEXbeNh6HhTjdiLtuyF3pHRiL1oy17oHRmN2IveSL5JNGIv2rIXevtGI/ai7VEkenLQiL3o7igSOTloxF60ZS/0xpBG7EVb9qLJxbhG7EVb9qLJ04UasRdt2Qu9MaQRe9GWvdAbQxqxF23ZC70xpBF70Za90BtDGrEXbdkLvTGkEXvRlr3QG0MasRdt2Qs5Y2uEXnToKJJG6EWHjiJphF60RS/09pRG6EVb9EJvT2mEXrRFL3T4tEboRXfohZyGNUIvWtgGJIdmjdCL7o4jkV6GRuhFW/RCb3xphF60RS9k4h6NyIu25IXe99KIvGgR+gIRedEi9AUi8qINXJH0jppG5EUbuiLpZFIaoRdtTyXRR/Y0Qi/aohd6+00j9KIlu3bQCLxoeyiJPnKtEXjRNuEsde5bI+yi7ZkkOlBeI+yi7akk+uSZRthF22NJNCbVCLtoi10y+vEQdtE2Ay29EakRdtEWu2R0j0PYRVvsQp8o1wi7aItdyPNRGlEXbakLnWkVURet+LxKGkEXbbgKeaJcI+SiDVWhU7gi4KK7I0nkAS2N09LaI0nM+IYz01rgQh9H1Dg7rU1Pm9GtgRPUasn7qRonqTVghU5HpQdpak3T0fvNGmeq5U8kaZyq1iIX+iS+xulqLXJhejFOWWuwCt0pEHHRKb/s0wi4aJu3luxACLfoNDTnIdyi7WEkpk8g3KINU+H6BAIu2jAVrk8g4KLtYSRmcEPERRusIum4Ao2YizZcRdJxBRpBF22hS07PYwi66MzmhKZdOARdtOEqko4r0Ai6aAtd6LgCjaiLNmBF0nEFGlEXbcCKpOMKNKIuOrMfH+0PIeqiLXWhl9caURdtqQsdhKARddE8ddGIuujM5g4hXScEXbQBK3JLDwGIuuicz+qNoIvObV5vktBoRF20pS5bRRdGjWepC1cYNZ6lLpwZqPHywJoBQRdtoQsdX6ERdNGGq0g6vkIj6KK7zC90T0bQRVvoQsdXaARdtIUudHyFRtBFd9lf6M6JoIve2tzs9FiEsIs2ZEXR8RUaYRdtyIqi4ys0wi7akBVFx1dohF20xS7MCgphF721ngvd3Ai7aMNWFB2MoRF4STeBw4ApAi/pxs5/dO50BF7STSCDSIrAS7oJZBBJEXhJLXihE54j7pJuAjsOKeIuacddyJV4irhLalPA0CvxFHGX1KaAoReqKeIu6cY2IJ14HnGXNOGT7iPqkia2+eg09Yi6pEnAgUkRdUkTPqtniqBLariKouNuUgRd0oS9OilFyCVNuDtGUgRc0oS9IyFFuCXtcAuVjyNFtCXtEr+Qq+QU0ZbU0hY6DiRFtCW1iV/omIoU0ZbU0hbSiUsRbEkNT1F0WFOKYEsqbMORA2eKYEtqc7/QYU0pgi2pCGzUpoi2pCKwUZsi2pIaoKISEnOkiLakBqgoOmAqRbQlNUBF0QFTKaItqQEqnBmItqQGqKiEzGOQItqSdoEu5FiIYEtqYQvzSSPcklrcwoyFCLekXRIYeixEwCW1wIUZCxFwSaVtQHosRMAl5e/6SRFuSRW/7EsRbUkVnyQ+RbAlNTyFTLedItSSKjZJfIpAS6rYJPEp4iypYhOOpwizpAal0AgwRZglNSyFTqqfIs6SGphC5hFPEWdJDUoh84iniLKkIcqSIsqSavvB0VMdoiypDnkqiLKkOuSpIMqS6oCngihLqkOeCqIsqQ55KoizpDrkqSDOkuqQp4I4S2rvBqIjMFN8O1DgeiB8P5A9ZUR/nfiKoJT/4vAdQSn/xeFLglL+i8O3BKX8Fze4Jihlvwx8T5BBKPSXgW8KsqlemJ6DLwtKbZPRUz6iK2kopCVFdCUNhbSkiK6kWWiSQ3QlzQKTHIIraRaa5BBcSbPQJIfgSpqFJjkEV9IsNMkhuJIagqLoI+Apwispn1U3RXQlDYS0pAiupIag0EA4RXQlzUNrA0RXUgNQFB3EnCK6kuaBTEspoitpR1fILw/BldSmeaF39lNEV1JLV+hPGsGVNA/EwqcIrqT2miE6RjtFcCXdhpbmCK6khp8oOqA7RXAl3YYmPARX0m1owkNwJd0GJjzEVtJtaMJDbCXdhiY8xFbSbWjCQ2wl3YYmPMRWUstW6FD4FLGVbMNOeBkiK9mGn/AyBFYyw07oazEyxFWyTSAaMENcJdvwe0IZ4iqZQSeKjsbPEFfJNoH1XYa4SrYJrO8yxFWyjR05SYqWIa6SWa5CzzkZ4iqZjWche3KGwErWZdal3zICK1kHVsienCGwktnMunRPzhBZyZJANESGyEqW2AYkPeQMsZUsYTf1MgRXMpvche7JiK5khqAwdwciupIlgVjODNGVzAAUpicjuJLZUBb6fFKG4EpmAIqiT39kiK5klq7Qpz8yRFcyS1fo0x8ZoitZl1mXnFMzRFcyA1AUffojQ3QlMwBF0ac/MkRXMptal864mCG6klm6Qp/+yBBdySxdoc8wZIiuZJauMIMAoiuZpSv0CYIM0ZXMXppMx8FnCK9khqAoOlg8Q3glMwRF0SHPGcIrmSEoig4LzhBeySxeod2GDOGVzOIVOoY4Q3gls3iFGcYRYMlsml1mGEeEJVOBaKQMIZZMBaKRMgRZMsUvHTJEWTIVWDpkiLNkKrB0yBBpyVRg6ZAh1JKpwNIhQ6wlszEtdFx3hmhLptilQ4ZoS6YD4UgZoi2ZDngvCLZkFrbQQQYZgi1Z6BxRhmBLZrPs0lEUGaItmb17mQ5xzxBtyUIHiTJEW7LQQaIM0ZbM0hamLyPakukt35cRbMnSAC3LEG7J7EEipi8j3pJ1B4novoyIS9ZFttB9GTGXzN7MTJ8kyBB1yVL29rAMUZfMoBXGzUDYJUsD7gviLlmIu2SIu2QGrTAuCb6m2WIX5hvBNzVngYCyDF/WbLELfaQiw/c1Z4EjmBm+szkLHMHM8LXNHXehuz2+uTnj4yKywd3NWaBJ8PXNNqaF6fb4CmeLXZhuj8BLZlPsMt0ekZfM0BVFn1zJEHrJ+MucMwRespzflM0Qd8kMWmE+EYRdsjywbs8Qd8nyQExZhrhLZtPrMl0ZgZcstzMf7Zsh8JJ19zvTvhkCL5m94pm5Jx2Bl8yCF+aqdAReMhvVQh+fyRB4yWxUC3MPOgIvmQUvJLLKEHjJbFALc206Ai+ZDWphbk5H4CUzbEUxl6cj8JLZoBbuWnTUgBa80EnKMgRe8u40EbkgyBF6ye21RvQiJkfsJTd8RTHXriP4klv4QnviOYIv+SbgfOaIvuQbnnzmCL7kmwD5zBF8yTc8+cwRe8kNXmFuV0foJbfohbkxHqGX3OAVxVwaj9hLboNamOvgEXvJE9t85CeVI/aSG7yi6AM/OWIvuY1qoY/a5Ii95Ja90EdtcsRecgNYFJ0JLkf0JTeERdGnZ3KEX/IkcBgzR/wlN4hF0adncsRfchFA1zkCMLlhLCojY+1zBGByC2AyMmA0RwAmN4yFCgnKEX3JDWAhQ4JyxF5yodmQoByhl9wGttAhQTlCL3l3qxEZ5ZMj9JJ3txpRM2WOyEtuyQt9MChH5CWXoaZD5CW35IXOy5cj8pJb8pKR4DpH5CWXbNMh7JJLvukQdMkD9xrliLnkNqSFDPrIEXLJO+RCl0UNZ08Q0Z0dAZe8Ay50WdRuBqkoOpFhjnhLrmy70QMQ4i255S1Mj0C8JTdMhfuYEXDJDVPhPmYEXHLDVLjug4BLrrhgwBzRllyxwYA5Yi15l7KF/poRa8nVlg/wyxFtyXUgaVKOaEvenSAiByBEW3LNBwPmCLbk2jYdPdEg2JLrwEZtjmBLblPokme/csRacs22HAItueZbDmGW3B4eoj9mRFlyG9NCp+LMEWbJ+ZiWHEGW3B4eok9R5Qiy5KngHTzEWHKbrIU+Q5EjxpLzyVpyRFjyNHB4IUeMJTcchTkWkSPIkqeBVXqOKEtuQIqiDxrliLLkNrqFPmiUI8ySG5KicnpeRJglz2zz0VMdwiy5xSz0QaMcYZbckBRFHzTKEWbJDUlR9EGjHGGW3JAURR80yhFmyQ1KUfRBoxxxltygFEWfHcoRZ8lteAudwDRHnCU3KEXRCUxzxFlyg1IUncA0R5wlt5yFTmCaI86SG5ii6AM2OSItuQ1xoQ/Y5Ai15AanKPqATY5YS25wiqIP2OSIteQGpyj6gE2OWEtucIqmD9jkiLXkBqdo+oBNjlhLbnCKpg/Y5Ii15AanaPqATY5YS25wiqYP2OSIteQGp2j6zEyOWEtucIqmz8zkiLXkhqdo+hhMjmBL3t0gTU+UHWz5+8u7svpUnJvi8LY6FH/effXHH3f/+EfzfCruXv7n7h+l/c/kpZF599V/7pK7r/7zPy/vhPszs39K0f25tX8q1f2Z2z91V153/0433Z9d/Ux2f3a/5528PLV/brt/b7t/J0knMBFdzURu3F9cGeXKKFdG6e4vzp5EdwYkqauVuZ+y7lnaa7Htw/ZPLd3/qE5pe+mhfWAnuU1BZv/inqnNw9P9pZPcphqwf3HVtSvcHiy0byhxr8q92/T28rr/aaN67F+STk67rWb/kmr3ZvtXunF/Mdr/56XrFuZfbTfZ7Zuyri6wC2wV6AMqC1T8VDRFtaua/Ydi//FcXK7HxutLAkqy7UlJKi5Cp/vmDOu2WZb6um1upZG6h2J/fj41vggJROTsG3AiiooQIaAIyYk4Ptbnsvnw5D39BtRNdN8zXD/YdF0kdR2/BWWc/GP9eXc82rf9uGv8T1ZkN0Viw76q06moDr6FwMCuD+aSNeKyL6pDWT1CES1B62XkCav7ciiORWv44fG8q7x33B5Z6UW052W6TyDhZDVNcWl2ptuWj1Vx9jpve2i9l9amL7Avm+//RhoWkkIhgm32a/OhqJpyP2gQCfu9jqh+KC77c3lq6vO+PDyVl6dds//gycyBTMF3ZiDzn58vT+XlglqsvQ0RCIp4trKunupz0XzYVXVVtO9811zPRVU3l+vpVLcziq9AQQWhp6+9T77dJbtVTDI3vbi/uMGsTRrYzTSZm2JS12u6ITB1o2wbYW3/4uaTNv6tGzjdeJl2nT+zQzJrbflv8zag0ULDh3WWuomGHTyhOPuPqm7qz1Xhv5Hck85+mVBaVTfmEysOTU284zyFEsfsK/wPFYwzqXMD2kD6bmbajklzg4Df6nD0SlzTyr6R3F/cCJplXJd6v7sUqbqej039/rkp/E9awPlEct0eiKjf/7PY+7OB2EIZ3Df4/ljvP16a+uy/vQyOlMLN0IqVci2Ph39di/NzfRpM0S1WuwlT3FBp3kJT9w/lPYzcwIdh36kVQbwMCadGyfWkrv6lOaNxqM1YDepzfXtf+oMLbAKx4azeH4ud3++hJ6Kda+eGhr413Becu59yO4OQKuqL18DAMOfHOd/ReZ5C9r60+3rcENZuAXSq3V/cwJdr7uXu64P/LeUb+HVz3WJfP5125wK92jbFwm3SYz2urvJTcbnsHoumfGon46eT1zs3GkrixtRW0rXBZiSwXwrWJbpVbl/Cnp+M4OiSj5vydD025Yfd5QMvMYcSuTGvk3jYPZ7e78vDw7l+GoxJCfyExGbEOCjq0pyLne9tSugfsEPxvq4O5WA4gaNJsum+gUS4tYfqVyN8R6weSt8xzBI43DnvUnEDr5Vw9cfM9t6F2xgh+P5cXZrzdd+Yamjcz8CXr933l7FDZi/rY/F8KM7lJzOpnnaN540pOHhlrIPIC7u2btlh1+we6vPTrrlc9h+KJ3++gJ0jE9w0MaLidK6bel8f93XVFH82lBoF1fCfW5Sa9j8oHRLqYAftsA4jd0e+KQ3FB/qoFY88IugYiE0PPdxq33V+4Rb5wq3b23vMOxfVgYDcLekz53665XqaK+eHugW8mx1ytxJs98O7ycCt2x3pyJ0b1O572L+w64qurc/10Z+fgOeXqMAA0UKih/LY+L5oG85+e8uSnRbPxcDBgy5nIt1bdO/MTb6qB0luulSujO79+37R7GhUexy680MdRXHspT3I033t7pU7yVnGfk/GfrDG9NeF4LPXCTuGWBnckqFNTwSmx7CUA7nsTjSc1vSIiHZxScmAHZ/3c6yM8nAuLvXx2j7MkPS0VPM22m/Z8dDIaicw733Ah9Eb9vvtKxMOsYSeT5svcEzGqTibxXFdXc7Fv67FBTEJMKS0aTlC4uqHh0vR0J5QCt5xnrCjq5HTr6x9Xwo+2DbcSpaH+O8F9jV25QSro/cKncKRr6arTz2GhJxIJ+HHYF4lXPIk7JNczxd/gFcQL3VjhBuDlQNEinVt2knadyjgG3HDstac99bWxy5uAtcKuVsksL7RzU/wJy7I6t2gp9mRHXgbnpgM+tsp10Xb2hcEBBLoniVu7hPS/cVNi5pd5BqpeKUMhpJu2BfsF9gLeCwaAkBr+GxyVMix+FR4i2QFX04bgTYi4HSlrFBwzcqudK2QgV+vQSsL191EqK8U3ZDtzzkQaHYOfu72JhT3NbXSij9P5dl3quFbSZzLlLI+dSvldH1/LC8ffKsUHNvcxo3b/9H9hlIaEnypz+htw4WQW1ULza1nD0W7gDwdd2VlIcdp93ysd/7bg9RMZ9zoRexBKLiazQRf86GsSuwoQPqXOCzQHr/mhHSI3WsqCD42DngothOymL4NmQfv1bVNv9uXOq/LOaiZc8gyFjO22pCzCLd9hHtm5dzgtF9Iih6O8A3bCi8+FVVzef88oAzQGXbONvt9swvBJIWwW48LGC5f2hspgAj3Ytl9HCOr2LX+nOmu7Ye17/auyrr6WDz7qBBuwqUsr7BS9x/K4+FkbC0+Fs/+/AuHwkAnbOU4Gf/8/NF/VDiYsV6aLwPZkaSwH6bht8SJgN5z6gBzD/827HhjhZo3PpAJO677GPJAK9LbaZCasBTH7Rah8SKD48Wm3z53O2pu8khTvvHcLpS3xQHXb27T3+2up6zfUzS78ui7C3AFumUfzv9SFfTsc34qKA9PRfOhPvDcDs7CLN48lEbCAFcnW+hKsIs2W/3T7oiGmy3s+KwX762yHnblET3CFvJCdpXlpHzylwKwLlfzejra7UjGF4E9QbEt/9nrlUkGx7eMffGfqyFFBO88XO/S4OkKMk2RsfNdu+V2RkQIbiGLjO2nXdUhhIdtnbPv+nNVVk1xftjtC1Ma+htwelIJ6z1/rro+P6gPN6oE9+qKfVlcLsX+JHT6MfHjHqAAtrf7AsgQDDAkKXYD05dDxmEoKIebOIqD0DrZlpX5APHks4X9cMu91OKp9FWDPnjbFeL6flG13eGAF43QiWe/AFvXX77D0A7FQrfb7O8BP8/HcUFLbIe8CSHDWdo70kATcF/FTUpZna7+m4SrMdW7+c7x1ynbrL3M07k+FefGn3k3cB2s2T5mhVyen56K5ow8Jn+BD1clLK0u/nXdHYeYVEOczvYxPORoyPrZr611Zdvu2YarDAZnBblErrnJYSikDTw4FcQwCOPABEubjcBj7Q3boKc4N32kNrHyBr03Z9f/1r33xz44VLCcyFZ8LNCeNpjglGK/FFe32wT150jQGdm+6ARQJBPGQyh2ddOLOBenI/JEgQXcystWN+EFvnIYJcE66KA29QrgbmKw4S9cfIOEvEKlwc5shQxfA3gSFtxYAZfr+9bvfe/PoRBOtPewRkmgPejEC1qIk2T/ab7Qa1U+nY5FWxo7hHAtxAZYIslEk8E1IrsHiMRQzaZgTEcW7ny9oEHTwUlPhl/XcBgEBtihh431sRKsFeZZPuyqwxE5zaAXsRGJxZ/F/toU1+rYvtn3g6WHhB6hZklzu2e32zdo/SNhBIPOuIchZiJv07VbrrloOOFiqTO3PMxcVHTGBhdaHWW1P14PxaUneudiX58PPnSAHSFjg4t8gdcqLBLOkSxFtSK9msLjK50blPb+ENeqeJsKbpexiwI6zgM6BYJlb2ZraxBnlWj4jbPh2I/tDL47/vPz5VNxLh/K4vxYND2pqOrmob6i6N+tt66PF9y51+Q+T7KFyy429McKDeyRKhiMlLMOPymH3keDm645uxJxAg/l4WPxfCrOl7ryPfkN3IZiVxFODulmKOhZ5WwH9GUM5moFB/+cdet9KeRUp2BPyNmQYCep7afdB/r5XPr8VsHRKmcdYCeqfce70t+ug5AhY+c0JOG8++wLgS7oSN9u3Iw4bCf4MOyw6KSALeVhkDtENzk7fBCiqN1pSJNyNmaZFPap/ojaHvrZOTfbAln4i1AwoDxnHaVeQhcq1K2/+rGe6EqwV7ITH5Z7ISPJFAyfz9kl+EDY8KuD0e05u1ZzgrqHG250KMgTc9ZVQnIIc+A4ye7vIzH0KAABac4SMySKaDY4LLF7ZUZMuSd8URjNxW5z+tUHHqS3juPfLdrgglOXdAe4nKOUJh36zoU7r8MS0MeiYc6VwMBYdm3aVh9E7ku4/6LZkzaPRTOI64UOJAtu2orX87mouEgW+DWySPKxPRHWnJ+RCdB30i7AVIvA+xsu7BOIeVw0nAyIMDuqu+Ogh0q44aYTvos1H7ErDisGRrqmKj4XFwoPKAirNIvwWzRwPHAiYChNwANp2jjtqunCAY13+dD9A22xQOSQsSuu3qFEYLXNmAUm28BrIXfOlO9YBxqUCG+Cnotmw7v7uoO1FQwO5meFY/1+dxzEU0LSww8F2BOQMGxHsXG9pp7n1tpTPSYYA/nxcOeRf/20QOqEGHSVJbuDyQis6ua5aOzpUG8VBg8FSDaun5FqHZeDLxCSeXbPdiiw33ahztkJ+IFKdpt7KNXuxNAiBRTJfvMDkbejXA8tU6hQTxIbCeXG96TwETGxUVAsO0lZCe+9bxlC22TTAZikP6bnInxT9jjm7Xk9sXDo3ziWkfTRLO4v7A5C/7ieVHg+1wUWJ+5YdepOkqcsfvxwGAQBwCU1u1dt6vkxJd2a2m+HFLYD58WgoRzODdw3Zst6sB36bO7oXc6GhZlqnck24LKNwqI2Z8QGjiWs1zIU+Gl3vBY4OYHYQBzHhkdAadCwsnoqnmrfgRbwELRkQ7pN6W6sNH/fvT8W5ANDN0Wyga6db9J9kJ+KwakE+G0n2kVdsLswrK/jbSSzlbsB0X/XoCu7lAwug4LzvxIXX5e4kzVJjxrZtWR5gbkD/AgROKduXRyp++IFO8aVFzuOteNR9yrs+oTwo+EYpVlnp7wUpzZS67w7fiye2yNY53aL2ncfFFxmsFFu5YVtHeg56Y0Lx2R3u8pL61j6uAR2FM33j0vrT6Ka0PlhQUvb5x+r9sVSp3clDHvSLjpPs8Tln59ReLk3XnFO1D8/X7gwTWrgTOB8y/r3jmg+97zwWvWRQ/vzJ/9j8LYkODvxTjLc9lfsG/YmAyo+EO4esVPcx+KZDgNIYDsnbMCcV5/Yu4cDCeukD4X4zQ33uRXbST4WeP0IgZd2qVDS3IVjuLjWnI1s+1g8P7XQotz5h6AhhdEshSEwpYRAT7uTYDnrKxxLFFeivBMmXXXuw3/a/ekC8E0ukNaVeV90wSb+3itcDLAPRGEX2DQu3NadfXOulnKulurzmbjxXjvHSef9YS3n7jmYkrrY4NQlAUpdOpTMHbjLVB9I7PLasCyqewwEPGCYSdof6B4V4e82Qb8lZd2CrraBFX4QAhguuI+lq2xIhfV88DgG/XsWuTh47euHEI2NQ+C4NxztUnZlBWpTmALKGLOdDoVQ0N1LWXcPCBmAQBhOzg6dWIAhWD6sBVLGXiY6jyA99DVSFx+Fgbiw+2BYaghlEOE0EN+pGDuoBoHObcoee3ZSwNa6LwU81cjTkCxSwFBWlzCk+9Pl20pcVH/icG3iRqHE5Y9J3DEw0Z9BdWKUGziUG9q1i6DTfU4ud5Y17cdLd74sdbUydzomc4vgzJ2YyPqEaIHBqWUK/pgAGXX3yO7AvrMncbvciez3/d1P7G7jU1mVT7vj5VgUCPzCtSHrTVXtybJj+e+CODkMgygyR38zNpzC+ndUDhdvNcOOq3XVHskcxkPAU+Jct2sj4WAlYHnXsVzKOdGfSXETX+4aJHc9LXd9JmfX4oOcPxIyBM1GLpl6vedKnVmChxw0G3V02j2W1XD73VtUuI+Ee2k3GcPTl96pEa7FPVCNXD8Yx63ZJayVgI9ZwhAwdsv/tDv7iVwSuAMl3FJXOb9E9fn/Mjc09Oeq3Eo1dYNO6g7bpVnvU/X5klzAjcv2lznJGbvbaYwdnGWCgwILilzVYL4UAaMnJTvXOFmj2VIEdEQk64jctqjpBCVwDGKj0cE+t+8LwVU6GxEJau9rHzvBL4ndbwnu/kNPLuW/IySCDiaEK252vY9F9bSWBNTwDcmYN2TE+b0QruQTdzpP9w6/y3GZuUVB5nJcZOxGGlZIeJlwuZOwHiIWVNXNjj/pKGAAq2QjWLFQ0l+C7ic7YWFJpgP2o+GuOsD0Kr6lXnhi7OMb+Tadyulcfyjfly1yL4ujvwYSMGxV8jMIkn6tbvnehu8WYkXJZvQZy84A/XE2+8VQCP1BweM+CYuoh9L8/p96+b/61EkRH1Mnjujd8OhbMuFlUV0RvviUPagajhWC3mca89l223bka8+9/XwO3AyEUa8JsnI2qGAoyeL80MAt4BPLeCPJBgADZMoGbQ1Ewc9p2CQCSpXsiowK24LdPuc7BHmQV8IIRp27Ezwux1HOLpJv4gj/XnmHZ9jgiNuh3mFAgILBvim7sMIirlW7n9O0NO26L8jzTwJKluy+fVjygGwKGHkvec9gIPVGqq9ntNEON1EkG81/E9nUg4AOGGrN+1vnel9cLuQJEBjwzDuz3bTmfcvw8IjLkJXcUlY42sgGgDuhforVfbfv3dFT/31B74dNHxaQe74eiwsVYi28kwz8yESJ7s/ignRebc7GU1ngMQo6AezeUVjJLcSF0QFdAXbTjNRRVvv6fC729PpOeKiUPeEYlkwnyBHe0U0WN4RFs64X5OWSPWPCCLdb08YD84XCMYZNMBsSOtgyh/n9JHsSgxTZTZBMu8FRZtrX2MnFAVUCRm1KNqNsUGT7JRaoF8BvkPfBKantgDG0En4KLEkl5VlK0Z4Siuhf8KtmM5ME1LgBCWTHfNxVewN39x92pZ/GGp52kzxmIdV1/0mOgBD2SvZEJSnXBDt/LpsP9XWQzFDAQBfJhgmTcltZrr+Qgx2kX5LNXYVSa/rzHyQy7IEvJ4HJ/gPPcY5+uIPENN5BVOehCYe19ejnhd94Ao/gi36B75J96f74mJurM0e8Mh69OV3DzxZuryajbYCADzxB26c/YaNDR04OQHcqDTlDSAiYt3fNbZ3NfvDw/Uo29Gqoh1ldwU3/UafgJu3mCMQZDWcB9mTbUE03W1n/qfsY6wdfNBy32fjaEdH1A+P0wY1ByebMY6X3A0f9YBX5wuEUwW768cIHgx2cGHmkMJBHuOYwWDhhswQMRZErWpipjw08HsoyAzvTLtpLtxH/tcFlsi8QTkBsltPAgR/ow2dsOKwvYLj7BA9hJONdgjtbD0OzEz06LLL3B0B/PuMxvydneMQeRmAn7FauL4VvKDijj/bM1s/1by2COIl3NMwJhMF+F9xz47kDdfhBwvNzul+e9qFJbNBBL40EIfDsNpsuijxOIeE+p2YD2Pu6+KQOBDts6Edfm2AH8OQ3m2aLTAcJz7IlzrFItn0W0X5TgR1qnFQmaTIMpON7mBPCpE2GO5qC/wSv6HAZjAzv7065JfzuMwtxr3yYqwOiP+UEpH3qcHZSM5KI81XQ4+p3srnJhhtZvPuguL7fDSdtotRhrA2cVLg2Ou+qA3HQXsOTFjkbTWdr79/X58uHXXv3F44fg2dF2S5spZT+2kHDYMuc9RZt3X77fphuTsOhNWdDizs5RHV4Qpj1fG11MsZGw+M6OTsEnXfVY7Fv45rPaEj1TmAH7H8kIka8I+CcU3kuUMADBLSK5Z7kki/xkuY4jK3ZVZcNLseRCjBw45Zynu0/wxwXEu7nKXfgNGN3fvrTxSbktqrNzm5ZPd7CcNujNHhJDicXyQ5g/MlluDzOWKDi1ffW38PEhgLOOpJ1JDyRFHbeeMmXRt9aK4ZyjpSXw2v0Af1Eo0E0D/0MyXKBTvLw4FYfHAHcmNsizX+jcPXEpqubpKl13PHhQwEPb0p2Ymb12EYA7vyJPpUHp27JxrCzauxsde7PvY8rhLO8HOtKQ4X+Fj6tAS5M2MD1sIaq7gGiLxv60vwsGpTtBNPGwzGEDe+NU9BCBVoJHBVYRzqshIDsMJhIsjuVnVhHEzpw6p/VKB6fMDuEsUKSPdDSCUcIEZ8CCfJ3GAYk2b14pKh91YwWuh/Bz449H80lp0jg3oNgg+hh9e6CDuMR9I54G1JNnfOBKx3JRlhC8VZwD3/teNYd4yt9X1LANJCSTfQBpZNTEnQsxr5yzqlOIO0WbCQOlGIi9GLfI5yV2MvmoHQCBUC+MTbi3GQM3P8ExvwnYyML9gGV8oJ8R4aMtvaYZwIPCUt2JxsIJDsBpDZjA1krhPRKPKc44sUMG8m78HdszLAimuu5Kmyc5wlRSbjJIdlELy7ljL29ixl8iFEaHkmWgUVAIKGN8pYgYwaOpHD00o+MDYWTsjgKeCJVsjmzsOhJYxmcSdngd6yB6soeJYhuFrI/w1MBbGg4lkR0ahj9xa80rRw7mTdFe+T58Vw2z34YaHurQnt2/NIUFZMfAq7y5GR1t7wL1cGG8tBKoBfBxopxKZgkHNA1e2gaVgcXnoFXM3IntYAhZJI97z2mp5uSujMM5KF6GAgpx/oKq4i6xdp/HuhTsUnaPDUj00fuHQQcGYKMRHftW7PbVYfu8qina3PdHY/PxZ/74/WCE6vA8EfJZqmjdexNfLE7W+r0mIycQz1wEGHZ3lCPG+MHwXoCxoxLNlhvKLHf1vdDo0fMhxMKuyUNlbm3T3V9uDsveT6HpJmXTIqDHzzP66A4ZpqC+75RI8ctZde1MpEIBZE1QUA2L3my6suFeQ/I6BCYck7ypBVILZ+erg1MvrH/0DJEXyw81S15CAvEUlMd5OuJO6esx/xjK852+bbJy+p0Lj6V9dWfkWF8g2S3nBiZw7THAgbkSvZYCCEP3FjAmQrHF/b8CyGaXFLCtFmSzYlASCN8RJj9S7LpBChZw7EI7h9KnncDWVQCbOi1ajYq0JPSHuTbVQebDYUcHODesWRzL0ChZnq7GNHX6mNVf66ITxqGAkh2+x6KHbgzYJalLYdp3NlMYkEVQYgm4TaJYrcr4xRUdVNW6A5L6mAl3FtR7AZrUCe4pY9+LC8ZQ0w3Gqi45eFgpjAJt7lUlJc4UOL2QbhNfQm3wxQbPEGc8ZEwMF6xUdnDExESxmspNub6XNfNYPc7gdxUsCP9cCRK/DsPur1YzYZtdqthP2YQ6mYX57Zm1xCdz4nvWoXMSbHnQT1J9dn+k5qlJdxWUWzmvsGxSbhSStxdzInb1Urd9Y4pi2DJq4kUDK7KWFepr2uznw+gl4TASrEZfS4f6uuxdzL7Tu4bBK94ZIO22yHFnypgGoT+vLC7DTZzDkfON2A7SPlZHuDqPGXPqIDZwbcIprRhP7nQ2JjAdyFcdINyTa1cfgTl7iHQfXim6yCp7I9Ou//pL1N3+ccyF5+QuQP2WX+LH7tsG875CYyxFu4Yv3Btofo7k3R/9NslYktdHhyXWEG5rETa5ZLQ2h0Pd7al/Tlxd6g8dTdcpq5wqvtkhu7NZP0ZWldr25XJXNbCLOnTTLhNY5drMXPGZ2l/4NalYMj6DBR9JqX+BBfb/MMEETDkgc1418LnQ9mGvOPYKy8ZvrOD/SCZRIOpl9+bq9zsmity2MAowPYcE1/R1O93lyJV17OfQgpucih+xHcyhkkt4OjKniewIfxopIfrnISvSsFR70BPf82qu12VJecwp8sw67Y3ZTMSrJ87yCMHrOk+Q9btaV3OdrnSZSJHt31D4pKzG3BtzIvfiWH/Ybeq+lAZYhtFwp0LxZ5F93OQwn1tFqARvSbRXg4cbqRv6n9eUDY4eCBDuNFCqX5gc+ku3KCrXYad1GVuSd2xvFT3Q5T7H5eLJnPpdzIXtZf1FwQHnpO6/gTe3sKGxQ/CQSFZSNiv8nosD20AN0oKqiAvz9mTY9fK5P2lU9AruNmSstm7rucjOD/jsui0gMMPDILrHLZ70sKwSw7XZOxx9+v52HuEvFVwmcKmBqJEIZvg5opipxC3/ACb8S28NGGazSCl7nDFo+ABs4w9FOHU+FsD5+KhMDlmdsd++eMLh34pu/R3wtvvcriOkJCOaHYec0IGmdShJ8pCOle767nk0yTQeRfsjpETNfD9VeKFcXK9rK8PIiGH05yCCxrNkgonjMgrC7GMYHfYegH0BQhwqGaTpHxq8xZ7jgmcj1jNJhGp35ZwJ5sFeraiuYuybJ7rB4xH0UaghM6WZgcllBfVkwAxumbDIoZ7UvCwiKK/vb+/vDuVp+JYVsXdV3/8/X/+5/8FsH0ggGH7AgA="; \ 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..474f0701b --- /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..ad88683b7 --- /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..d7bf582cb --- /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..7ab80b216 --- /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..0f2852ebf --- /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..0d9d228bc --- /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..4297e5d83 --- /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..a50aa837d --- /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..a3b0f3569 --- /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..a8b808868 --- /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..8146c407d --- /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..fdb0e56e6 --- /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..3ce6bbcfa --- /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..0ecb62089 --- /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..b1246dbc5 --- /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..468328429 --- /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..7fe0f1531 --- /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..1e57ea3e7 --- /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..c4588d30e --- /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..7147eab88 --- /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..50ec3db23 --- /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..169b0a8bf --- /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..3b9dea3ed --- /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..b2bfe6415 --- /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..4fafa700d --- /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..8b5957f20 --- /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..765cca8e2 --- /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..520d712be --- /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..c10d3ee7e --- /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..dc3df9f04 --- /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..729b81256 --- /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..e6858f0d5 --- /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..31d6de81f --- /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..a3f34ecff --- /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..fc3b782fe --- /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..40babf757 --- /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..e6f67be15 --- /dev/null +++ b/enums/DwnErrorCode.html @@ -0,0 +1,133 @@ +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 +ProtocolAuthorizationDuplicateContextRoleRecipient +ProtocolAuthorizationDuplicateGlobalRoleRecipient +ProtocolAuthorizationIncorrectContextId +ProtocolAuthorizationIncorrectDataFormat +ProtocolAuthorizationIncorrectProtocolPath +ProtocolAuthorizationInvalidSchema +ProtocolAuthorizationInvalidType +ProtocolAuthorizationMissingContextId +ProtocolAuthorizationMissingRole +ProtocolAuthorizationMissingRuleSet +ProtocolAuthorizationNotARole +ProtocolAuthorizationParentNotFoundConstructingAncestorChain +ProtocolAuthorizationParentlessIncorrectProtocolPath +ProtocolAuthorizationProtocolNotFound +ProtocolAuthorizationQueryWithoutRole +ProtocolAuthorizationRoleMissingRecipient +ProtocolsConfigureContextRoleAtProhibitedProtocolPath +ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath +ProtocolsConfigureInvalidActionMissingOf +ProtocolsConfigureInvalidActionOfNotAllowed +ProtocolsConfigureInvalidRecipientOfAction +ProtocolsConfigureInvalidRole +ProtocolsConfigureQueryNotAllowed +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"

ProtocolAuthorizationDuplicateContextRoleRecipient

ProtocolAuthorizationDuplicateContextRoleRecipient: "ProtocolAuthorizationDuplicateContextRoleRecipient"

ProtocolAuthorizationDuplicateGlobalRoleRecipient

ProtocolAuthorizationDuplicateGlobalRoleRecipient: "ProtocolAuthorizationDuplicateGlobalRoleRecipient"

ProtocolAuthorizationIncorrectContextId

ProtocolAuthorizationIncorrectContextId: "ProtocolAuthorizationIncorrectContextId"

ProtocolAuthorizationIncorrectDataFormat

ProtocolAuthorizationIncorrectDataFormat: "ProtocolAuthorizationIncorrectDataFormat"

ProtocolAuthorizationIncorrectProtocolPath

ProtocolAuthorizationIncorrectProtocolPath: "ProtocolAuthorizationIncorrectProtocolPath"

ProtocolAuthorizationInvalidSchema

ProtocolAuthorizationInvalidSchema: "ProtocolAuthorizationInvalidSchema"

ProtocolAuthorizationInvalidType

ProtocolAuthorizationInvalidType: "ProtocolAuthorizationInvalidType"

ProtocolAuthorizationMissingContextId

ProtocolAuthorizationMissingContextId: "ProtocolAuthorizationMissingContextId"

ProtocolAuthorizationMissingRole

ProtocolAuthorizationMissingRole: "ProtocolAuthorizationMissingRole"

ProtocolAuthorizationMissingRuleSet

ProtocolAuthorizationMissingRuleSet: "ProtocolAuthorizationMissingRuleSet"

ProtocolAuthorizationNotARole

ProtocolAuthorizationNotARole: "ProtocolAuthorizationNotARole"

ProtocolAuthorizationParentNotFoundConstructingAncestorChain

ProtocolAuthorizationParentNotFoundConstructingAncestorChain: "ProtocolAuthorizationParentNotFoundConstructingAncestorChain"

ProtocolAuthorizationParentlessIncorrectProtocolPath

ProtocolAuthorizationParentlessIncorrectProtocolPath: "ProtocolAuthorizationParentlessIncorrectProtocolPath"

ProtocolAuthorizationProtocolNotFound

ProtocolAuthorizationProtocolNotFound: "ProtocolAuthorizationProtocolNotFound"

ProtocolAuthorizationQueryWithoutRole

ProtocolAuthorizationQueryWithoutRole: "ProtocolAuthorizationQueryWithoutRole"

ProtocolAuthorizationRoleMissingRecipient

ProtocolAuthorizationRoleMissingRecipient: "ProtocolAuthorizationRoleMissingRecipient"

ProtocolsConfigureContextRoleAtProhibitedProtocolPath

ProtocolsConfigureContextRoleAtProhibitedProtocolPath: "ProtocolsConfigureContextRoleAtProhibitedProtocolPath"

ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath

ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath: "ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath"

ProtocolsConfigureInvalidActionMissingOf

ProtocolsConfigureInvalidActionMissingOf: "ProtocolsConfigureInvalidActionMissingOf"

ProtocolsConfigureInvalidActionOfNotAllowed

ProtocolsConfigureInvalidActionOfNotAllowed: "ProtocolsConfigureInvalidActionOfNotAllowed"

ProtocolsConfigureInvalidRecipientOfAction

ProtocolsConfigureInvalidRecipientOfAction: "ProtocolsConfigureInvalidRecipientOfAction"

ProtocolsConfigureInvalidRole

ProtocolsConfigureInvalidRole: "ProtocolsConfigureInvalidRole"

ProtocolsConfigureQueryNotAllowed

ProtocolsConfigureQueryNotAllowed: "ProtocolsConfigureQueryNotAllowed"

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..4e188966b --- /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..5fdeda71f --- /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..879aae46f --- /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..1318d4d4b --- /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..07be9821e --- /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..8177a35f8 --- /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..1f19f9ce4 --- /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..0dcd8fde6 --- /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..b19dfe80d --- /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..a0f3b0ae0 --- /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..05358d4f5 --- /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..cb388379c --- /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..ab9e80e82 --- /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..3073a0256 --- /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..74df5a28e --- /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..0c0a059d8 --- /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..c276229db --- /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..d3d950f77 --- /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..569372704 --- /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..7359d8656 --- /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..800a84ba7 --- /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..82ece27f7 --- /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..78680aac3 --- /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..b52e22d0c --- /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..a6a0df50d --- /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..13d153060 --- /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..07a55220b --- /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..b4d25a11f --- /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..06f742339 --- /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..c52f05fc0 --- /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..0abae3b33 --- /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..89d69a712 --- /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..7a674f872 --- /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..0e7ab312e --- /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..1f26f95d9 --- /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..8d3ed8522 --- /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..98a470d48 --- /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..7e6d4c70a --- /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..8af613bc5 --- /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..02cc3c8f7 --- /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..d460eb72e --- /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..2dfa4d1d9 --- /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..c2cbd671c --- /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..2b3df068c --- /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..6b34eccee --- /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..6c6f75245 --- /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..94ce553ef --- /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..dc4aa21ab --- /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..fa565b766 --- /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..b58f54b6b --- /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..b5a6e075d --- /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..03a44123f --- /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..99f3f51d0 --- /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..c893b3c44 --- /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..2b87dda99 --- /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..2e6a3338c --- /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..1a35a59ff --- /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..1d7c64fdc --- /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..3b78b3a15 --- /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..173558369 --- /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..de52956b7 --- /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..604c4f9d2 --- /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..35a267fa9 --- /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..2eadb30ec --- /dev/null +++ b/types/ProtocolRuleSet.html @@ -0,0 +1,10 @@ +ProtocolRuleSet | DWN-SDK Documentation - v0.2.17

Type alias ProtocolRuleSet

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

Type declaration

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

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

    +
  • Optional $encryption?: ProtocolPathEncryption

    Encryption setting for objects that are in this protocol path.

    +
  • Optional $globalRole?: boolean

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

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProtocolTypes.html b/types/ProtocolTypes.html new file mode 100644 index 000000000..797c59874 --- /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..cb7a5fbb1 --- /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..c78f3df6f --- /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..ec4e397d7 --- /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..63258c331 --- /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..925de429c --- /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..7972d670e --- /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..21482824f --- /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..348971642 --- /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..717d8b461 --- /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..ecaf6bcef --- /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..ed54396de --- /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..2da19e041 --- /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..91204bb27 --- /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..13ccd131c --- /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..44e57337c --- /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..42b90a0a4 --- /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..13812b01c --- /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..6a090ae56 --- /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..53e8a08f6 --- /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..8104826ab --- /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 a $globalRole record 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..762bb0779 --- /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..03ff8bbc2 --- /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..048f71a48 --- /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..0bd26d4da --- /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..fad26c7e5 --- /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..8b30fe96e --- /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..5fc530a4a --- /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..eb2779d85 --- /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..c79556fa1 --- /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..45805291e --- /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