From bee35da0ae4c2857ef11a8dab8f14bdba2cb5ada Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 4 Apr 2024 18:17:27 +0000 Subject: [PATCH] 2024-04-04T18:17:27+00:00 Signed-off-by: GitHub Actions --- .nojekyll | 1 + assets/highlight.css | 22 + assets/icons.js | 15 + assets/icons.svg | 1 + assets/main.js | 59 + assets/navigation.js | 1 + assets/search.js | 1 + assets/style.css | 1415 +++++++++++++++++++++++ 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 | 46 + classes/MessageStoreLevel.html | 26 + classes/MessagesGet.html | 9 + classes/PermissionsGrant.html | 23 + classes/PermissionsProtocol.html | 20 + 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 | 45 + classes/RecordsDelete.html | 13 + classes/RecordsQuery.html | 13 + classes/RecordsRead.html | 14 + classes/RecordsSubscribe.html | 13 + classes/RecordsWrite.html | 83 ++ classes/Secp256k1.html | 34 + classes/TestDataGenerator.html | 65 ++ classes/Time.html | 24 + enums/DateSort.html | 5 + enums/DwnErrorCode.html | 146 +++ 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 | 134 +++ 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 | 4 + types/DataStoreGetResult.html | 3 + types/DataStorePutResult.html | 3 + types/DerivedPrivateJwk.html | 1 + types/DwnConfig.html | 2 + types/EncryptionInput.html | 7 + types/EncryptionProperty.html | 1 + types/EqualFilter.html | 1 + types/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 | 2 + types/PermissionsGrantDescriptor.html | 8 + types/PermissionsGrantMessage.html | 1 + types/PermissionsGrantOptions.html | 2 + types/PermissionsRequestDescriptor.html | 1 + types/PermissionsRequestMessage.html | 1 + types/PermissionsRequestOptions.html | 1 + types/PermissionsRevokeDescriptor.html | 1 + types/PermissionsRevokeMessage.html | 1 + types/PermissionsRevokeOptions.html | 1 + types/Persona.html | 2 + types/PrivateJwk.html | 4 + types/ProtocolDefinition.html | 2 + types/ProtocolRuleSet.html | 5 + types/ProtocolTypes.html | 1 + types/ProtocolsConfigureDescriptor.html | 1 + types/ProtocolsConfigureMessage.html | 1 + types/ProtocolsConfigureOptions.html | 1 + types/ProtocolsQueryFilter.html | 1 + types/ProtocolsQueryMessage.html | 1 + types/ProtocolsQueryOptions.html | 1 + types/ProtocolsQueryReply.html | 1 + types/PublicJwk.html | 8 + types/QueryOptions.html | 1 + types/QueryResultEntry.html | 6 + types/RangeCriterion.html | 3 + types/RangeFilter.html | 2 + types/RecordsDeleteMessage.html | 1 + types/RecordsDeleteOptions.html | 2 + types/RecordsQueryMessage.html | 1 + types/RecordsQueryOptions.html | 2 + types/RecordsQueryReply.html | 1 + types/RecordsQueryReplyEntry.html | 9 + types/RecordsReadMessage.html | 1 + types/RecordsReadOptions.html | 4 + types/RecordsReadReply.html | 1 + types/RecordsSubscribeDescriptor.html | 1 + types/RecordsSubscribeMessage.html | 1 + types/RecordsSubscribeOptions.html | 2 + types/RecordsSubscribeReply.html | 1 + types/RecordsWriteDescriptor.html | 1 + types/RecordsWriteMessage.html | 1 + types/RecordsWriteOptions.html | 5 + types/SubscriptionReply.html | 1 + types/UnionMessageReply.html | 10 + 143 files changed, 2800 insertions(+) create mode 100644 .nojekyll create mode 100644 assets/highlight.css create mode 100644 assets/icons.js create mode 100644 assets/icons.svg create mode 100644 assets/main.js create mode 100644 assets/navigation.js create mode 100644 assets/search.js create mode 100644 assets/style.css create mode 100644 classes/AllowAllTenantGate.html create mode 100644 classes/Cid.html create mode 100644 classes/DataStoreLevel.html create mode 100644 classes/DataStream.html create mode 100644 classes/Dwn.html create mode 100644 classes/DwnConstant.html create mode 100644 classes/DwnError.html create mode 100644 classes/Encoder.html create mode 100644 classes/Encryption.html create mode 100644 classes/EventEmitterStream.html create mode 100644 classes/EventLogLevel.html create mode 100644 classes/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/PermissionsProtocol.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/icons.js b/assets/icons.js new file mode 100644 index 000000000..b79c9e89f --- /dev/null +++ b/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/assets/icons.svg b/assets/icons.svg new file mode 100644 index 000000000..7dead6118 --- /dev/null +++ b/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 000000000..1daeb6900 --- /dev/null +++ b/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Ce=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?Ce(_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),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof 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.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.scrollToHash(),this.updateIndexVisibility())}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()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.scrollToHash(),this.updateIndexVisibility())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&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 y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}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 I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!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",fe="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(fe,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=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(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.showPage(),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.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-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..ee351b654 --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WaTXMiNxCG/wtnVxy7YifxzQVe79rr2AFv5ZDKQZ5pQMUgsZIGlkrlv6dmGEAfLal15X37kdT61vD3vyMDP8zobjRhBmZSmdHFaMPMcnQ3AtGu9eXx95+WZt2MLkYrLurR3W//XZwjd+JBKanGsoYg2tKShC/CgJqzCv5ga4zi6EnSC5ilrCOYsxhnPIhK7TeGS3HfLKTiZrn2SYglznuG/QQU37LOP6uWENYMscR5XW9MuIKqM/skR4wz7ptG7u6b5h0EE+aRGatKVcO0Bn0Zelze1bVNHPM6RIx5nYqZMMNmRir4CltownBXz5MUsHWM0mlJwk4goTuRiRlLoQ0TBo09ihlGP0NQQK+koh9EJWtAggchEzsMYjR80JKELQjzsObGgIplP/RkiV/lIjIgHDnL0Y+A9MtJysf/2YLaxwi9mGfM2g9dKf6BTDDPkGJ9rp8BqUn/cyruaafDqKedTsW8gNZsgdR3EAixqUkdWAg8vCctMcV4A7XmWnMp9KNCp6rvINLelDSykkgbEROROYXvLeh0HQcPmbiVK6Q3A0uS129O8Az7GV8IbMHxHWnaISfI2DxJpPixFHO+aBXWvMBDIkamvKunSFOopKqRlg0CIXYCDWAbsiMTOJG22CqBMgWG7OyWSGAkFkHfQaD9pXgiPb2aosyg2lzf3K6uQsRJSsW/gzbdmeIRBChmsK07sCR5fI20pvuVdHY6h/LjGdk6ObmI65tbZLNFCUcxC/A3fp+Bbfouxt4RUI5toIJe+9OLzvIGHwV7GKLeiQnBWr4U1l9JLRK2hLrB2MHdAsTO7C7kvjJ8CwfveAnVagq6bazNx+w33UUAt3nkn3//9erm2r4RKGAGPim5DvriwA0MOeJpVD+CwasaOsjMtzbHPDmyzO4uB/WwJT7tVgHSN2SJ/WVizhcB6SjkCOcT/RexaYNGejKd9qbkBpTZx4FHR5b5vWXNJ94Ye1IMsLOUpfRrjjUFPzNRNwgy4iPxuyNncEy2uJZO5kUmia+TeVPYNGGvOCqN1R8Ukq21HQXMZIttRwEz0eqzTuOdjiQTOAwSiQ8izFhYQjK7vquQncyy7ypkJ7LtenJcfNrTZnx/yOJVJIeuWsZCm4dYctRn2GeW39BBYL4wA4qzBoEdpRxlaEXfZT7G1ogc9wHZwYRvyFFKYnUNHQXMyEwIHQVMdIj4einvQRiVhfamHPlVwOscn1yWlKO8sQUXzD33HiBnhc4Yt0qHS6mvZ3mn54uxFDVHexbz0LmzSm6CAejJdNrhZSm+lcSdpWVEpk7EVkqPTKKIrYA+vGqRMhR4y8vJZ8k1lpeQz5RrLCqhe7Ajpsq1FpdCSZTlK+ZT0mT5CHwtBUNw3c/Z6OiVjX5XO74VTmDOBUdXzcBBZU7bBmYQ7LGeTKW9d8ExVi9SSedX1sSgTHjLy4kNy5ixvITYwIwZySX0FxF8U8Y8ZdxcXkruam5QLh8lNzY3CD1EIZYstf1oeIVN3qOQI6QaWtK+oc7dYxF6mPP1HG/KxALG3cu2QtYTVyWx8OFnSVmK/TEiMugwTxE30hOYh8hNzRHEUkJNV7Zk9Ngh6NwIDMVEdFTiLiK7+xSUTqzlKGCm02o5CpippJ50Io/wTBR3lpaRTnDpS5Eflk516VuRH5ZKetlrkf2lL5t1z1XCTmfbtpRQ01m2LTmq/XyNZjcw5IjfBJci9foVGHJE1polCMMr51PVvBX9P9T0pa27rNtfLAz8gKo18E00oPX9h1QGagyH+QLsP/8D+JS13PcoAAA=" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 000000000..f9daeccbb --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA82925LcNrIu/C6tfanpKeLAg+9kyfaWvXxYlj0r/nBMTJSq2N0cVZPtKpaknol59z8IEKxEMhMEWdTe+0qHAjI/4pj4kJn4982x+XS6+eqPf998qOr9zVdiU2SJFi9v6u1jefPVzZtP9eumvqvub17enI+Hm69u2uen8vTX4f9vH9rHw83Lm91hezqVp5uvbm7+89JJS7WW6SDrH//o6gYFvRjKAHkvb562x7JuPTgXJclGqEHHvtr/Wp6aw8fyGKPo1i8/ofS2R8fobst6W7ffbduob7z1il+nufxY1u279lhuH6NU++Wv0/1Ynk7b+/Jd2xzjvhtVuE77fttu41XD0iu0+H814WnhNbctPFur0JcJ9A1WWtVtebzb7srTX91vwfkoNiofpDVPZT0p6UVfisY9AGJU7A7NqZzW4YotU7J9eirr/bSWodwyNfdla4qcpjXBosuU/Xkuj8+x6vzCyxTuy0PZllbI18+vq4j2pKosHSbl9hgzTGyxGUr8zcxi/a5sf7RLEJq8+OeJqcTI/rV8Ojxzks2PC+T+d9fFIdSwwFL5PPLLzwtkvzu/P+2O1fvyTdn9+dQ2eGtmy11rXIQFTxkbPHxmUxhG7hIYt7D2TECTW3T70OwXgRqqro3IjNTfqsfy1G4fnxZiGwlZF+VddWjL42kRuEvdqzFNTKvQsoALrTyhoNSZs8mhZpp+e24fmmP1r21bNfVsELe4+hxIUxZn5CpGwfLqXodpYlDwa7lfZP563td/6lr2f2/r/WF00uKKrTL4OLlRw4/CHjC10YkKGyb253iD++RaPkbiC1g69EkWI6OyfKzaKG19wcWKgocJqGj6PBFWFD5SQE0RpwpClT/i++lnCqPRCH+6dmSPZE2NZg9XeI+NVHV7KT6tcmKJrOqqrbaH/zlWIyqEVY/qLMGAOw/Odmo9HP0+azH8rqzLY7Wjd1//x2uHByFtaoAgdHP3Ml5jzB6GaocHS2inD8CI2+GnkIQ7lRo0RIl1u/cicl4fW7BMI5/abXvGhuyE3tuhUrT66QbuS79rjsx62v2y0nI6iIpcTQ0onmcsXx/LbVvicxSj7NavMal4mucsfzm/P1Snh1kIYJ1rMUwc2jgY0ce0IBJonLmCYP2mLAKiWHBk+XsYyYBxIl8E2C8KLaOUNW5YvWEjJ6w6OJOild9GTi5Y26LmV4lftvdVTW0Ilx+uXSOQpKklAiDi+u58PI32UVrL7VB2StnEjDxU0L4PqnRF52vEndOTgafzof2mbo94g8Q/zzKq+sHCc7TjAkvlU5s7/vkq2VTjkGVW2u4IoZEbH4IcXv7h3UCk/luv6gwocRvSUjirYinrXbMv92+27XY2Hr/uipiOx9GKFIGmr3UVDjw5vjV0KMJi//Pa4Q+kTI33HkWA4frzvD2QWMEvs1aFn+vy5ztSIvhllsRft/V9SUoEv8yX+Lo7eR/HW67/47WdRUib6jSEjuPqjw32feB13falYxROOX008VpN2WU6eQvpddjusD+vZy0BefE2U49x7sYS0hqzp4zqh7vy4/ZwnvPht67CUu2kZfWzMZHxWR3+dG1njmRNdaSHi2MYmmP7y7F5Ko8taRES+m5RnWnlEx3YyXtTHcsdcXIIgoCVrkZBGeWs9rBZPkMrefxg1U4cQMJ6R2tReXysTqduoDf1vqKGL1Xk6jWJkzm5LlF4mWZ96viTHXkUnVB/61eNhzKnwd/tmkC7mF9nWQKXuqfvjtu6ZV02+ILrdSspOb5zR18w02sjDkiE20ZA0AK/jUhYE44bV2AKkoDR6CI5wcU4ny4Vfy3/PJen9u3ClmQkrYy3I2u/+fxUHUt+7QzC9AWsjO6+K13uv527DjhwXv0vg+03bIjPg/Ybb5tfi+xrbBDNQ/Y1bxstH23lobwnLjNixxqovjqyMac/ExsUsDK6U3C/DeJyVVdGtJs2uYKwvPrXY5syKGhWlym11HTpl+kY42VUdEXzhZY9w4AZf8dyEyYIZp4RMxZ1nRkThhZvyMzHFWvKTCGcb8zMxRqzAYdRztuCF+ILbcJR8OK24YXoQhtxFLq4rXguuqgtL4xv5qY3F+HEthfGFr3xzUUVs/WFoc3b/CLwTW9KkxugX275Fvix+cBHXARKrroBEqJn7X/oI67Z/ngoc3c/JOnazS8AbM7eNxNV/NYXxLdk55uFFJy+jWkYOsUHsZKCVkA7OQkjZjwoNm/CH5u22TWHk40ePR8DMz5Q9OopPyV7cs6HvmPupI8EEzPrQ6KWTPtYaFPz/hpc4YkfjzB25i/Hui/vjFf42CyKRelJWAMfNwHfTEG9FFhrsiGJsVMMIOVW3L7kLL23oFYsgKmVn3F3nQIy6fE6G4nROw+Fq7ISglN7PO/a8yjNwQQKWG05kqsH5QVHL/wvyXxA4GOm5+NvgR4zv601Cy/CYieghTb9Cb+eD+W7cuTd6f+61mdAcbEf4gAyQ/Z/lfXu+Eyeanmlt//wakUBmJg6/2u7I8+IIRCXKqsgODaHGQ1/+4++/Cq6T9W/Zunuyy/Ufd2Qs9rj1wgfxq39Vs7wqWYNQw/Ira08H8yUMbb9fAUmU3kNTOypwriBkJ6GVJHVThFYZvTpAeJdZtxwuuPNG09CfFMP1idzWuTKLTsuBtKJkGWu0EK52RMl5sWhD3sE43E2LnB17DktcTLqfIyUC4M83DfHqn3ATqxhxbewWiyEuOjdPrTyb+WOSHUQBsVIWAnfh/L5G860mACGqy5HNHKhLnfNcX96Y3Ii0TOLKjLPTdsKCExeosRiDdTEHf1+nXQqQoYutETPr+V2H2wmUOBqt3Za4qRr+xjpgijpsPLISGlCSNyt1WhxmIATET8egyXQ6YGRO/y8ZEBNJ7LiC640wJamsgp8wUx6NQ5IBLkaELSAWo2ENUGsXoEpSKtGo4skVRfjvCPDhuLQDXWvxzQ1wYLL9qycVlOaAmvFFYmSegkmmcnUYoEKrbRQUFIjFwmMetkCEQAQvzhgIcsXhhCcuEVhHhbmnBmBZvKkeRWeX7btw3JMfe0VcR3LXfVUjbMrRYCCVVdEdNo9lI84hjcCzlBvzV4ztUdX3jE9dqm5Ip4uf/I4TC8CzqXiymjejenNSDjvQkTnUjxMjpg4SJPpYhauijGmSXh9nGeWzBzjzDVfzCCfvOpb3I9crp3InpxOu7N4xH/bHB+3C5ZLr+51mELmTtB0gyXCho5/8i3rtouku0i9O9f2iuav8OdZNtqrXVt9LH8zSfhfP5S7DzZnCQLOlLrWSguJnTLTOOCcnXaCFebjuB0JmAVrkkVotxW2kmJQDRWvRSMuuSVfHQ7Np1eHw2/jhxx6LX8dFwkOBZ1cBtyuqe0VNjgJTIh94ddhPnWMGo56kDuTGQpTIGIHQBAHSN9FNC/INhXZsjEfxkuN/SbyW+CQgdaQa8fX1T4e+q55fDq3ZUjOC68MDbT7jdHwtD2ewvJBidnSe2xvtve/vH9d7b89No9fP7fA+YL7GqrGGtpR0t4Y9RMvofj6Y6c0UDg9h30VcIBBPnykA/4YP+RMd0/LeuHKBY0FC4zrHmPQRqgaCi7X5Wju8k0fnBihlqozD0EqEsUnpOI1Uymo2tP+L9XpL1X9UHZ20n6+/lN1X5fjoThWPxRcU7ttzehm/wLfvu3cw37ZPh+a7Xi5o1sBVbkOERyPbfP9u59/ikAxFLxSN3/ZRqeUIUqsRD7OTjBDgb3qOMsmPpl7lp2RgSXErbN44kj1GSi60yeRXXcKB6i2FpInLonnFBav4lpo0NIYh4RYJq9sE+eYNfYInGwVv+pq48WF8pugmLmjBle+AhU8IbwZveoGTPnhx3iLh3udwBcVfpvggokzdrjkvUhLOGXvpJqnM3nAQUpsqYUq7ssYFbbUQhX28bAILUPBxb3CvC026pXQ42K0GvRUpivzy7kluaRxgWv3W0bi1HZLIJ1HsYf1TtPrRP1JknGoYzKPhpp3KLBa8/oSo5v3gnRh85J6ZzTvpX7ETQr5fGgEkolnRGOwgPPumzEUZzpffopf+duGZiOQrBeXcqHPCD1M0zY/v/9nuRvTamNVQ8Gluu5YlgUru5tkV+K0RX6bV3Spvv35ySTOK+PHwgu6zgwEsbQOVhzD7pAKvSHvm+xlfX40mqZfw0guS1h/e/jqtCvrfVXfh8S9IAqz2EcPY4x0dpdF8Uq90ku0Drdrcd9KFr9Kb+T30uWjNY92wPJYfSz3vxyrj9u2/P7TB7xY49+v3v9IgZPb3wgm5/vRNO0P5fPIvSGo9hbWigQweQQyJU3CzIfycVYr3BKV10ZF+OzEYgo67CxCNJT/ocR+cxGgUO3luIDF8L/3EIpbp83/xtsJFh3xaWN5L4iy9IdYZGGNJklsnEJQNE5f7J4GVMVsZ1jN5Zt+KJ/fcJPJLpBEidj97c3gwHCKFPrCr0J/DYWZXv17AuZ1U7flZ7xbsxjG1VbC4S0LkSCC60E0AvPbNroXLsUX6YWHg0/12CD7FE6pEHMh5WRM3UN1+qPYn7HgMOnDy306NrvydMJuNSMFo3KzNX3cHqqOBma8AwZNo3KLNfVg39ZteX+s2vEaONJJ1IjRjsbQ626RY77R/RZelVAU75v+RG5cILokdl+X39g3XSZVvJiqzn7f8BULDjEYRNQphlSJmvYb78kZoM/8sIqvjCcsFrnFxfRg19STavbBSYXljxvlNVTSnxbAT7G74Cvg7/b9p9OPXQ6p8TEEC37BVgt/kQE9iePiK/i62v9YnR637Q5vTWFInIQV0FVN/WNzLH972NY/1+U7d+X7U9O+Oz89NUforRsBNU7cNbiHWD37j5+a9udP8OoqBJKvuwqin5r2O5en85V/2x+Fiqy/FNnrwSuqK7Ob1aHhutcj+vF8aKuH7elhISqu/lJkb6r9jybKZRYertYVKDpJ7TFmxUKFr9P5t85+iFTpyl6h8dfy1BzO3Yj/dlsd4lqaqLMUwTd7oXVSvK2N2QSJIk4/VWOx9u517m8eq7Ytj5b17JahpxLZBiyUqepX4bpE9YEH4H+vq8enQ/lY1jGzIl7OUqTmZeXt4ftPp7+Vx+quKo/fle1w/P+pab9tzvU00Ggx6+HsB9CwLS7ASIhYjK/ba7wNyPyPfSUjov2mqq+MK9aWm6y+Mi6bn3Rxe12qr4frrbvHj7Y242Ssh9BunFfAGwlYD9vFDPu2OaLjfjxAWsqXQBltbEYKWXl+/NS0/1/Z2niCpZMEyViK0FCzbzz6v19PJ4EFqy7F49b152E5/70+OUvy9fHjJKoIAUuxva335ef+E+0LjX/r3nP8Dd6DcbDCdddD9I56VTEe1LuYBxbn4YIi39Y/lo/NcR4yRsBV2Pqtz/x9+/5QzmuyQO0rxv2bsuOMfjlsq9p6RPRO5rHzMUrEUnw9j/pd2brxEoGIqbQUwy991NH803uo5rVolp3cp2ovRoWS1n/n3iGJNixiJKyF7qemffWG9ieOhUeKWAufeQ+zv4d7u39V7wNXadNQp6Stitreof1ybB6q911EyLdVedjjG7hIzKystRD/Xg+BVQuHASVhBXT9Swt2vcc654CcErQaVtgQ9n/mwyRlLEY4uD28M8ERv9fdlvlb86bcn3flq1EWSxZltJwvg9R3PFqGcsINaQHCi2l7PkYcJiIELMdmFzP/VmHXn6n6m8oIgHFSvgDKLvfxKZormyFoVaxv611z7B4ffzNO7TELKy3oy2AdNr0roUI5XwbpvA1+jqhV8b5x3stdcNevo5RYswCzslZuYXuY85NlzWxZX8SXwBd1mI8QsCq2Hzuzu6rv+w5qjvvrlqmgvJWRf+78VGKPsHEy1kVY1dcjxDJWRmiMxivXUELKl0CJHyFZgvEiY1WEv5j6h/J0WnG1nxa66jd0NpAXCjwLLKj9BVrWrSGvnYNVVd+/qnflqXPSediC5zQWtHCM8HW/qf/P61ZaQsqqKE2E9P9U7UNzbpePC0LKqig7mW5uX2erMJKuRQvecnPG0KvOQfBtPXc9i5H0BdB27bIKWCxoPazDNf2/4kcpV3t1VPbg1o+sn++WAxwL+kJYf75bcKqOk/WFENt3LPpl5rXvV78QOC3yC+H//alzKF8VPy1ydfzDUvnzndW7HDclan28dvmxR5NZJ7IoUevhNRvnVfNwLGE9dP3Rrjx1xtKb8ql9+Obzriz3i4AGha2IuTmUbxpDn33zuTq1r9rvqo9lPctAj5W2HmpImC+AiapfjcsMqmWYqKpL8fRZfKwB59/Rvar3b/emS8p6hk/WEolfAP2coIVoMV8A58WRqd4bt/7BJ2YN+FHSv8BXLbg0nivtStRvSvMe2E+NI9p+GJ4R63zfYk6TcyRdjbYzorxjVqQTeoSAK7GZ5cgaRvaFxCFDQucVFEvazRS2Bmbj37ES5GlZVyIeuxi+buq9eUvZen87LqO//49Fv0Du/5Ev+bX88xzl0L1U6upfYaeY26WNU8bcJXyu0NW/wWbzOw5xECt/Taz41b/Ld+u5/kNYeV8G+U/NwFhfidmX9GXQOgUrNTMh7svi7o4eK2NHIr8M/sh720ghV1ssfj6V3+t389xg4uVcidSxPf1NhZ+4orx/jCHCZ4m6Eq+x49c8qs0RuD72BQe1SSnro1zvmLZU+PrftPyQFivsSswoyw7OJzP70n2x2JW+o9sFGG1zt/d5Itc4LdnDzXCxZ+3oPqqiKqe9lufJuhKxfRK4PR/r0rrvP0Xcu4brroDoivM7X/1KXNeHTs8QtBbWlcbiDHnXIrfZspiZOs9wi5R1JWLzqturtu1eVHCBtSY7E5UoJRb6XKFf6huW5bZZKvVLfUVvbfbxY9HhcYvFrvIdy5fAQP01kFnS0c0i/2GJGGR0/fWQdS7gr+r9G/vo6o/n9rw9HJ6/+bw7nE8xMcpLJK6L/nV3Mtq7vGhO39v6ui+YlrreVwz+Tn5c2BqfMkP0Gt/jOn3J2jeuuxYi04NLIaHKa2D6rmy/qdvj89v97/W+vKvqch+ZtCBWykoo39ZVW20P5p/R3pBxMtZA+Pbx8dzCKOzXD9v6fubSHxCyBsblK/+XWPN7md24flv/ciw/Vs052q4NSlgRXZ/P8nqQnKCVWxI9OzCzFaceIFiCau6xn6m75vifdRYha66BxjBMr+q9TUGzaE9gRayBr5vsr3we7Pf6Q918qhdsEBHCVsa8CtYvgfFvfU7g4TQCTiiLRkGkwC+CffGFY7y4L4v7p6Z9W9t97R33Eud1nxLW8EW+rnuUo3+0ZJ1+oQV+Eey9X1Hn3bDQeI8W+UXw2x87Q3iG4+MSiUvR202s19Ic7T+jLeqp2qug6omPGNqNr7cYSbl7Ejr9kNhkk3EpWJlKSzEM77zGOmoRFZbq/v14APFiP3Uh+YeoQRyouC6W7oS0EE1f9Qo8w4if1zJ0tTVxxLYKV3EWFi9P/JCR8qft6OEU/LOB4Wsjv9Bmq40R9mIoyn6BDzCUWSxOIyh8jU6Q8SZKrV/+Ks3O0T5OLyh9jdZ+l4vSeSk7W6M3NvtE4OTAvPwWOyqHWIlJYS9gUfYTADpaHxPfNVI2GbQ1pek7KmATq/kuHIw5qYN2wBhpmXKtmNJj35if1OOKLdbT3VhPq+lLXaHlz3N5imi3S8ErdNGpusaqptJxTWkypu60IldssZ43/oPNrKI3E+81T2sartqnlcGiM/WBZ2sspTh+aKb//+Ca5r1r9H57KlP1+/HwG/PqLJT4gihNf4PDN62VeaWVUzvxUuuU3g70b83XTt6E2nHpa7SiRyRCKieekIjTF9WyqOgifY2pHTWAcNFF+k6mdaK7kSp+nd7p78RFY/XFPijlKYt5T2qsyltOjBkN7YBBkfslfkl56oKFJgS9cIUYtAMeRgfzKB5SMvE0HqklFYkCD6Uxb9ghRY/EE3btaf+X6vSXqn4oj31o0RzNJ/+mjlF8Gt/KXal365PmjN7tmBVf4XtJBjbw5SyfOhuL/yr69+9+/mlK/1DqGq3+Y8lDmZ8NYXlZYuxbtfjn4IyMeCqZlDf1UvIII1hQvPfpTDL3GRpvhxpxiice/kXTJ0I/MZWu0N+vCAM3NwcJUXcxptEi7x+Q/MFtfltnob+IilrqLaoliz1QFLXcjzTNWfCBsmVL/oT24KIPlC9a9id0Bxd+oHvR0h/x3RGLP2qBK5b/4HgLbgAAw6ItYKyZ2gRsKGlgG4AF1tkIRhLjtgIP6fzFmNMatxx7tcML8p1xgo9sTAfiUmklFIFtkQURtTHOwBC1NbFoZm5OE7hG29OYSfGn3/D7OtuULy5qq7ogXLJdIYVRWxapcc62hZQu27oiUAS3LwRi0RYWgSG4jSEMi7ayyHaI2M6IFrliS5scl8FtDWFZtLXRCKjtbSgZ2uJwoXW2OVJq3FY3Qj1/uwtpj9vyRhJWWOyDqGYu+DPxhbblIKy4rTkCjc+q985CFOHW/xS/8WzLk9Dp6/bYV54S+oKowLJ5DuiU7j5/U7zuS4WlustdVZ4Gr5jYj+dqrYMithm4WnNQ+JtBdfrmqYtgPG4PP5TP3XvZx/J0KolNAUEJVJyBZgaj7GmPJJXHCqnpxL2xQ5SIvY5/5cZrpMgXsMLU51zw0g4q3iCJBTCqtQTFaD8dSr+tn84tXkf9X6/eQQlxk1snAsjsA9vRCJlUebudfHEJ1w7vRZUNEerDL/9WevNkGg5TfQ1kH8rnGUBs6ZX0ogqjnTqMg6i9EBce+D+MhCNk4wLXDn9G4tQMIJAyzb1HQe+z9N8StWMBTQyDJ/cAO8hCEgXJr7g2moVY1kPCLVoTSKbXrSgkwHCFPuSjnR3+eC1rMpI1QZl4wObxJWNVE2RJvK5vj81jtL6+8HKd90OAbITOS+G/iKu0VicY8Rqh2a9wpfb7sn1FEzHkJ08EWcX3LAh/iu5gv861CFC0TzSKcb2rWn9m549rLNf+0Tx+/s2f5+2hap9/vsORzRXhPDNGFCfluhFqOh6yD+FBCoov13tXtruHvq3nLdsvAlXn4YnjjscAKOJ4vj6GoR2rI+jZ+domudix3iAROx9B84kixcdqXbmrdbHBjBO6o0MU47BUJ7Om7b9+9rOeR+1FbNV1EHnRyLMA4ZrXjs2ooTHBDC8ZG+9idTPVZiHxreYZy+52lTWXufkYqyOuPebqKq3d/u758bFsj9XuYsfDEwsPYar+cmTdIIoca1fr6WPoI9VdSq+idca8pmv9H7f1/29a+tfZvI4lflvvy89Rhh1RZbn+ISp69hbD11wBzdxhyFacicWnyLx0IeRFK1HiWpKMEznFklFgmQ3kOHrBMUr17XHyvUZKwgQZhVPcxEF5mspusxyJ91DVPDTBV6mWI/KeBZ2HKPgW6HxEJz/9TxyWUzjzz3wUxz6pw/zh66qt1kOm6jjFdGQnjWqvhWu/bef2Ul9lTQSvq7ktcqm1Jg7vwdJ4IMGXShchcXlg5oMBNdfCM+HZMgUq2q1lwaxyTyTNnU+g3pq99stCPLjummP62y4BxdwN3Ku42p5AeWtN7gnxx+DINqFfKohsl7iXCeaj2l6ocXvwjzUgh6suSsBa6Mrg/e8UtHHt1eb/JVeH6ZD5Gysl4Ap0+GDwerjYoo8Fo9+vPRTQAqeOBGOYQYPKNsKPiM2OAHBL148ENd+UCYMJGjJLtJNL7TSGiYV2LhJuUwwDmd4S5+KYMBvCcKKNhgX9xG7Tk10VsUnPxUNuimEgE1vi7BYJbYgTTRK3Hc5FNLkZhlHN2ArnIgtvhGFYsdvg7PnOH/4npnzM0T8CTQra53O5O3dZZw/l6fTqvXlebcB0d67NM/Knv1LFwu6owAXn+09j8vP7T+GdE1PHP1Rj2tjJeDH8TrdIp5+XbEfcmwn5sNRsLfbCnnd8GBSNC87WtS+7bBa/HLZVbVOXcDedg9JAjdnay8/tcbtrg63plZmtAbqE8MPqBS52lZ44NZFaYr3OLzoi3M3xh4wcQn/ctuWx2mIyFvyygguoJyrC93MAxfvYUm6VlJrbD1OelEOtSb/eX7YV3t8DWvvSC/Qub1Snt5f5F95lfgxgwBz0If3+04eFUG6hgLmgJndO8xroNeCghOvR4Zn2Cwfw8sPEtofkMZ0x/H/0JowPf26Z6f8/fjP+2Cdi/v7Ue1NvgzJfkOXplncYpzbrsEJYbKme18QGhpWE2OwJDbvmsSs6qcUrt0yT9eOEj2dNqCQrXKGbN3sIvdOmz3Tf/VR+Kk9tzHh/QZReqvXnw36GVlx6kdbq1IGfmA2XQgt1dFAndbhCC3VEesMhpTMd4aJRhF0UGBBx7glx68KPHBETWiSISoswuPX64tdmjM/JCRysF4sk1jhGDTBtII9VEZsjmeYP/HZtiAgWNREhAlHNCxAZKZqID2E0xTlDj5TNTaIRpZ1xCB0pn5k8I0o345Y90j0zaUb0dwc9lskWWJQsI2K8Me6iIwwzk2Rwmn1jGJSiL2fGBa491DISp862BNIw5/662kd+DOLb+4qxMJZw2xNAJsjt2RgmbiHimiV6FwziwgPw97p7O8pW/LV8OuAwy9Hv4Q1Dj95ZeNc2YJutXCb/4avN7/G7UPNU1lHSXvQlg01lwXEb0aE5xSF/4YouVwaJ/KCqEGsfo+i+jFR0H3gCIEbRn17qyaCqP4P5+WOU7f3k70Ft+3AC+LihUW6PsUPDFp2njJlHeI9gNMfsFKNFEhCpEWJfDFWmP4zYL4Ch+gtyfxjtxLjAtSYrKW/Cbh2BnGe80ionLNhYndvTG/r2NKwdVwvEAM/7+u6eDtTAr1rEtAkr4jp8w3lu1zzFdhKu8/9EX12Pw4UgxAIA5edrjjt00ZrnnrzicTDHLxrGzDNYPArmIBbqhi/UFsEjGd8qi85lseOUOZzRaGae0IIY0J0FKkqf1ZhS1x7YQmKnTm0c8GUHlQgk8acVTti069Q3n5+qYzmn9aH71KX2qrjKLvPgk3cZMQOXV3tNXPdd0XL/W7MAFaz7BTB9jc+aMzB9zR8XrsL07SgH2AxQ3wbI2qWjqt/1F42pS901MQF35d4uGzk0xMBjxKyJ9OSZefHQTrNMvchU4E29r+ZuGkNOcFh51RaiyLGoJgozZPFo6INgxJmhL7LiYRBKjD8OOqiLD4Se2vgjIaF3tpntqb7C0J7EMm1qe1CWG9uTSKbNbQ/JcoM7qk1iTe5R61xrdE+M2mmz20O03PCmcLCmd1940vj2y61ofhOCZxjgCP7VJjiPZpERjsStYO4GAM40eGdhizB5A8hmGb1LcIXM3mlccYbvElxB03caWKTxOwvZhAEXABVtws3CE2PEBUDNM+PmtdSEIRdqqmhTbhIRbcz9gpNmENuJKxN/ZXE+VtECX9jCkx84IGUjD00DeDk3JnX7la7GYKbbPASwygpt8LHZGR/Kuc2A6l2NZF/emSTchPsni8KrswTB+EgRcVbxMaBaV6OwZ4bZMHC1lXBMXmtQKKIvNWLbwo21+c0Bai5BE+vtx+OI8PybmCTcmdp78Z206bsSq56oB4FzDtQG5xXn6YvSOcfpkNao6zKoeNZ92Vj3gpP8RfdVB/kwkphz/AXINcf4MI6YUzzujC/VHvFneL9lrj/Ch0ZszAn+gueaA/wIReD83pWNOL6DYque3rHcWYd3iH2FszuDZeHRHUq7Ml1JFMoZOUsW4pw+0XDY5hxownjgRmqD3X4on5l4LVwgOHCjrQRKaJyJgPFGxaOG9YbjUWM1jp/RCGudfj8joHk6JS6tNJgWN/Sl3pCxptk4pHv4Jd7WMs+9lK/q/dvaxLObYEkvW/CUmhdxIrhPdt+yZBB7MOJG71gd2bSvm/quuqcCecZFrjZsaYlTlu0Y6kzTllE7ZdsG9UYamIzq2RbmDCyciclAmWtjzkDCGZkMkrlW5sw2CZuZgdZZZmdGj1rO0GQQzbU0wzhwpDouzNiaXLmrjc2g4Elrk4W/0NyMQTPD3mTFTV0VjWi6OfhiGLuFyGgTMwrVlI25ENG0cR6Fbo51PgMptQH/txflMZr95ufVNt6LtNhN18JbuOECdbGbbVBf3eXYO1T/Kr81rxlHKR7XuQZBgMcidEeQWKzWmQYG0LrYuJjAMGVYAAhLjYoJBFMGxajpv0gbxBkSqDWuMyKCY3LKgABIlhoPY/2M4WAKThgNsMxqBsNIaLSx4EG+0lDgUCwwEjxR4U3vzl8NYzHdzVkQ1zAIWCSxxsAMJPGGAItqiREwgXD8Bulo2vb/P4fYoJ9qh4Je7CdeZndouI3eUQ4/lM9vhndzyftrT22w3spIfj9V9f2bIRPvCb0JPBMfK+1LoHbDp/uPFWCT4r4k7v5NixWhY4lfAr1NPLbGOMGSFqG17OKFGp2a0KPSi7S66MxX9a48tc3xh/L5Vb1/U552ZT3+2tOP23Y3MecXSlyE/r5sfzFF+/FiMtzejR9oIYFOV16EaeqQ4mGIPZ1Mj/SP5bGN0YiLXjVq/KDaX8u7sqtfbQ9v67a8P1btxCieJWcR0tNDcz7s3bLyij2+ebD4SoswWEPrbb07nPflacg+HmMBvJisuwKi3+unKzCRtWNRxV6B0Kvx9Gu3YePrjZ/0Aimzv17LvYyFxb0B32Obx7wQyuJegZ/QFvlsoad35ruFYQQDkzL1SiCEQFWaiWHW089Q91wSJhJB+AlcCGAmBROpP/wY9bjxv8T3x7zVjFtiEf0SNTLDj+VCHDPJF147+WylLUdTL1SRa5kXVmbky5U+XtZXOvT0H6s7+u0/X8JVOcgmMc19QW0OtumnI3lcc96OnIMp9FAYjybupbA5OGKeCuPxzHsrbArX2AT5teQXse63lcyPQVSc8WFQLTI9LoriDI+QpuhN/6J09paP9c/a8C96F273Ye3hzf6ifNlWH9Yd3uhxg6//3TGbvN8C12zxoVEY3uAvGJZt7yPN5ObelQpu7aDAShs7lhi5rUOkc64rwlqn7iqI2mts5hyauVt5PK7Qpsmhidsy4zHEvsfI4Zn/HOMMbJOGDotqhpkTjyfGuOAQzTMtwpjGhsW78/suQvw9u3kNBVYyMXx5cXbGBeQiYwOpjLM4JnVGmx1I/Wzbg0QyywBBCBZaIRE4wqYIgrHMHolAETZKyO74Qm0RY54QrXKNjTI5bsOGCkKzzFqhMZAmy1A0aLfgUisZL6TYSAtmBPwqEyKEZLYdMRK2wC8kBlectTUTTci0CaKJs29mopk2JIKY5lgTM5HFmBRBbPPsigh0wLh4V+6ehE4/JKNlZvgl3pxwt3/UZbcv7oVflP6gCzbOfDEBOz+Uz7818PU0RuWo9FKtwx19nNpR8au+9vtPH35rvn5uiUsb8nu98td98QzVRIWFuskQNaQuGJs2qcG+xzo5YF2phVruy7o82nHgPT3JqBsXX0fvr9tPM1XbGou191F1EUsCKnutxoipicou1Nh77sR+5rj4dXp5/yJa8bSHUaTm1w9V51MxT/24UjyGWN8CpDjGu4D8ZPDkBApxBs9BRMQ2B8KLaUETccVzo4kZJdNhxDOChxkd4ZUZiwdmSXNs31THcudFSZX1+fH0V++3cMNfOtC6q+2r+n5S2guvLAPdw0dqfBWv8NVyfcCU604do7nQ/We8AXc6lOX4IcJBxgv3Ow3SAGAkP1Z19bg9vJtQgIrN19M92Xo+dgX5hxUv6ujS87VaoipG47jkUm0/392dyqiv5MrP1+ys9hitVNkojbHLPPjAiBUeKYETp/MKN8/y/Ff5sRwn5fN/Dk6mWOiEyKiPQEiZHWBnAhdjldqi1+h7f2h2H07eq2YhnV7xmXr5l89CGoMPn8Xp8p8+CzZp8OWzOG3w7bOQrtDTZ3Ga7onHUClNobfP4jShB8lCyibeI4vtMfgiWbjHQg+S8XMALCHffCzr9r+ae3oF8X5dZQEZS4xaP3yYzHQ+H6r9t9tOztimJ/T6xa/QW3V+pTEaXcF5uqaXDkJVcOWI0kQvHFT/BdeNSF3UkCd1hUZ8lK7t01NZj69KCGVDySu0mfcQTckx90So9Itfofe+bOO1wsJX6LSrn5X09fPrKqqRqUoz5+L4qeyAUTQqEX/IeH+uDnsyrjgs/AVVkf7GMf75SywDYsY75IstNV51yFiL1hqw17iWnzbZorXTyzyjOLzUh3ROL/eMyuhXchcs+1zHRj+WO9uWYzTGPmU7vSjHaox/0XaJFckonfGw7Wx7nFEZ+xrxgo2cHT2x7+lOWrDfPFZtWx7ftcdyO85GOC6yni07Fhtv0PqoOWqLdZ/i9MMa12rn7U1C8bTRGaUzYHlSrT1tfkZpLR+r8VzhlPaFF+kcJdU9NfUW3a73/3utEwoUE5Eh1wDhnAEq7HxJCL/dB+w3Vz7sdOBfM/CaJjKYxuryrjSD2oK3may+ZZ3k9PXy/pJEKh5wcr4mowvGeAi3T5M3jjSYSf8Xd+W+CBSsvSIqLmfxCNF0imJmIMILkPLUdmzNd/YCm6KMcYn4U4u7FccLTVj0i3E1hp4eYZ/CMZ3wdQoSJWFtdHQ2vFhk/x00Gmej6j2k/qfzhpyLCdVduZ36pMNDxP0iiFPCVsLcpdW4BiZRf93+XTTmUN11EfG++3Go3k2aokuRMRkT4mC9CR+v5s+G6fdOp5fZsYT10dFP+sRjCztyXtdu5Js2c5qtF7ASNktJfkdQExOYYMVVsSxaHvyqq+JZvDiMq6+Eq+cMlvSaX3UlPC5hD/2A1QQiXPlLYHrnQkGuAgelXInyuK33zeMg8F17hI5IE+C4yutgWgJlVQS0B3MQQNiHeab+1++b47uHrdApdbcTxIGrroLnbfxWBiusojvgSBRCEOFTFIvDOke9qfa/lqfmcO7m4a/l6XyIbpOQgJXWmjfVvnPGXnbyxJXnY4p2yGIaKMY7a6z+7y/7q6Kv/t256HfGyc1XN+JW3hY3L2/uqvKwP9189YcF9vJm1zw+drL+3v/2t7JT2JWwRf66uXn5x+Zlqm5Fkf397y//cDXMD+Y/TLHk5uUfyUuR3yZ57hVLvGLi5uUfgpImvGLy5uUf8qUubpO88IpJr5i6efmHooopr5i+efmHpoppr1h68/KPlCqWesWym5d/ZFSxzCuWc8Vyr1hx8/KP/KVKbwudeMUKv3m71i5eKnWbS9S+qB9MR2woxYnfFUnX5ElClvR7I+laPRFkSb9Dkq7hE7LnEr9Pkq7tE/VSFbepVH5Jv1uSrvkTTQ2axO+ZpOuBJCVL+p2TdJ2QZGRJv3+Srh+SnCzpd5HoOiIpyMHt95FgJ4tAs8VMl81Lld+KjfRL+l0kun4QCVnS7yLR9YMQL2V6m+XCL+l3kej6QciXWt/mwu8i4XeR6PpBKPLT/S4SGfvpfg+JrhuEJpX7PSS6bhApWdLvIdl1gyB7Xfo9JLt+EGSvS7+LpOA+SKIlTXKLlfQ7SJoOKqjvkX4Hya4XJDnXpd9BMuWWGen3j8y4dUb6/SO7TpAJ2UJ+/8iCbSG/e1TXB1K8lMVt5g9h5feO6rpASkq38ntHdX0gyYGp/O5RZsshVxmFNh3FfY/yu0dpdmAqv3tUyg525feP6npBkkuc8jtI5SxMv39U1wuSnBXK7yBtOoicFdrvIc2ucNrvIG06iBzs2u8gbebP5qWWtzLxx7D2O0jzK5xGhkHXDYocxNrvId11gyItF+33kGZnkPY7SLMdpP0O0l0vKHJT1X4HpRtOZOr3T9r1glJUY6Z+B6VdLyjSekr9DkpNB5FDM/U7KDV2GzniUr+DUtNB5IhLkfFmOojcfVO/g1J2C0r9Dkq7btDk8pr6PZQW3MqV+h2Udd2gyQGX+T2Udd2gyQGX+T2Udd2gJWVJZX4PZZL78szvoKzrBU0um5nfQZmxrcllM/M7KOt6QZPDI0MGdtcNmhwemd9DGTuFMr+Dsq4bNDmOMr+HctND5DjK/R7Ku25IyaNR7vdQztoIud9BuWRHXO73UN51Q0oOpNzvobzrhpQcSLnfQ3nKwvQ7KO96ISX33xwdgrpuSEmrJ/d7KC/YdSb3e6jYsGtX4fdQYXqIHJyF30MF20OF30NF1w0pOYoLv4cK00PkKC78HipMD5GDs/B7qGB7qPB7qMjYg0Ph91CRsweHAp1UC3ZbLfBhteuHtCCPgRt0Xt10PZHRB9YNOrFuus7IEqrr7W+wbNcdmaDLolPrpuuQTNJl0bl103VJRg5p+xss2/VKpmm56Oy6MbxCSpdFp9eNIRcyuiw6v266vsnoA+wG9ZvhEjJy8UtGPAPP+GCiIeGPsQmmGhL+IJtgsiHhDb0E0w2GVGCGDiYcDK3ADB1MORhigRk6mHQw1AIzHDDtYMgFZjgg4iEx9AIzHBD1kBiGISd3rURggqjrm5zcZBLEPySCtS0SREAkloGghwOiIBLLQdDDAZEQiWUh6OGAaIjEsA25IOknxEQkhm/Iye0uQVxEYhiHnLScEsRGJJK11hNERySWj6CbDBESieEdmCaTmNiTfJMhWiIx5ENOHlITREwkhn7IaSYOUROJZDe1BJETieEgcnqgI34iMSxEntNlUa8ZIiKn1z1EUiSGiyjoCYR4ikTxayQiKhJDRxT0XENURaL4uaYwH9t1TEFafwmiKxJDSjBiUZ8ZVqJgeF7UaYaXKOgpgTiLxFATBc31ItoiMeREQY8xRFwkmp9qiLlIDEFR0NQwIi8SQ1EU9N6K6IvEkBQFPcYQgZFolmJKNKbRNT8lEIeRGKYi2dBjF9EYiWErkg09IhGVkVguY0OPM0RnJIa0SDb0gooYjYSnNBLEaSSpvfpQL3VyKzdohUK0RmLIi2RDHjgSxGwkhr9INvRYQ+RGYiiMZEOPIMRvJIbFSDb0EErxRYjtP3oMIZYjsTRHQnc2YjoSw2ckCd3ZiOxIUpbQTRDdkRhSgyY2E0R4JIbWoOnSBFEeSWbvrujxhliPxNIeCT3eEPORZPzUQ9RHYggOZlNG5EdiKA5mU87wLVbGb8qIAEkMz0GTPwniQBLDdCQJvRIjGiQxZEfCXLshJiQxfEfC3LwhMiTh2ZAE0SGJIT2YFkaESGJoD6aFESWS5IFFE5EiiWVFkowcl4gYSXI76XJyVUHcSJLbSUcfkxE9khgSJBH0dEYMSWJ4kETQd7uIJEkMFZII+riDeJKk4Pn6BFElSREwLhFZkhhKhLHWEF2SGFKEvglIEGGSWMaEvsRMEGmSGGokEfTZHvEmiWFHEkFPEESdJIXtPXqCIPZEbNgtTyDyRGxs35GDUyD2RBiGJKFvNQWiT8TG3vkz19noSnljr/03L2V2m2YJKoxulQ1JwmJGF8uGJSHtTIEIFLHJQnLR7bJhSRL6/lIgCkUYmiSRtN8K4lCE4UkS+nZSIBJFWBKFvqAUiEYR1mGDvqMUiEcR1meD6RJEpIjebYMcngIxKcJ6bsjspUpuUywYdZ/13ZD5S7W5lQn2dUAdaN03usVlPLEF4lKE4UvIKxeBqBRhXTjU5qWUt7lGLg/YicN6caiE+jrsxmH9OJQgy2JPDtN5SpJlUd9ZLkXRowK7cwjWYBHYn8OSKbTrB/boMIQJbVgI7NNhnTpo8l5gvw7DmNC3mQJ7dohQzyE6RVg6RaUkZESoCGm7LqMLo74zrAnpGSYQoSIMaUI6WgjEpwjDmZAXxQLRKUJaZylyexSITxGWT1EFdQwSiFERhjVJuisnqjDqOkOb0D5bAlEqwnp90FedAnEqQvE7HqJUhApYKwKRKsIQJwl9iyoQqyJ4VkUgVkVYFxAOBOo8S6toesQjYkWoNFQYdZ6ynUevE4haEdYfhL6qFYhbEcr2Hr0hIHJFWHKFvrAViF4R1jOEvooViF8RWgQ2MUSwCC0DqxBiWIRlWOh7XoE4FmF4lIS+6hWIZBGWZKGvZgUiWYQlWejbWYFIFmFJFvreVSCSRWj2kC4QxSIsxZIy7nuo/yzJktKtjEgWYUkW+rpUIJJFWJKFvjEViGQRlmShL00FIlmEJVlS8tQiEMkiLMlCX0gKRLIIS7IwAxSRLMKSLBk9MhDJIizJktEjA9EswlApSUaPDMSziCzhD7QCES3CEi0ZPTYQ0SIs0ZLRSwwiWoQlWhjTEFEtwtAp9F6JmBaR2f6jxxyiWoShU5KMHnOIaxHW24S+ShWIbBGWbKHvUgUiW4QlW+hbOYHIFmHJFmbMIbJFWLKFvsMTiG4ReejMgPgWYTiVJKcHKCJchCFVkpweoIhxEZZxoS/RBGJchGVccnrMIcZFWMaFvpcSiHERlnHJ6bGBGBdhGZecHhuIcRGWcaHvmwRiXIR1TaEvnASiXIShVRL6GkkgzkUYXiWhL4cEIl2EIVaSgu5BxLoIy7rQdz4CsS7Csi70pY9ArIuwrAt96yMQ6yIs60Lf5QjEukjLutCXORLxLtLyLvRtjkS8i9xY9weyByXiXeTGUp60YzXiXeTG3qSTPSgR7yI3lq4me1Ai3kUackVsyB6UiHmRG+ttRPagRMyLNOSKoO9SJGJepCFXBH2XIhHzIg25Iui7FImYF5nYG3W6BxHzIq0DC32XIhHzInsPFroHEfMirQsLfZEhEfMiE+sMQfcgol5kYm8c6B5E1Is07Iqg2X6JqBeZWJcxugcR+SINvyLoUBuJyBdpCBZBR9tIxL5Iw7AIOuBGIvpF2kgamj6XiH+RNphG0D2I+BfZx9PQPYgYGNkzMHQPIgpG9v4sdA8iDkYKe2lE9yDiYKQNrqHpaIlIGGnja5iwGRxhY0NsmMgZHGRjvVpojlniOBvr1iLpHhzF2pgeZMJTcLyNDbih6V2JQ26kDYqiexBH3Ri2RdD0rsSRN4ZtETS9K3H0jaFbBM3YShyAY+gWQYd4SMTFSEO4CDrKQyI2RhrCRUi6BxEbIw3hIhTdg4iNkYZyEXRshkR8jDSUi6DDMyTiY6QNy1F0DyI+RtrIHJqKlYiPkYZyEYruQcTHSEO5CDpeQiI+RhrKRdAhExLxMdJQLoKOmpCIj5GGchF04IREfIw0lIvQdA8iPkYaykXQDKBEfIy0MTs0UycRHyMN5SI03YOIj5HaxlbRPYj4GGkoF0GTZBLxMVLbEEW6BxEfIw3pImiSTCJGRqbWbYLuQcTISEO6CJrKkoiRkYZ0ETSVJREjIw3pImgqSyJGRhrSRdBUlkSMjExtaBzdg4iRkYZ0ETQ/JREjIw3pIminf4kYGWlIF0HzUxIxMjK1caZ0DyJGRlrHF5qfkoiRkb3nC92DiJGRhnQRGd2DiJGRhnQRNOUkESMjDekiaMpJIkZGWucXmnKSiJOR1vuFZpEk4mSkdX+hWSSJOBlpaBdBsz0ScTLS0C6CZnsk4mRkboOF6R5EnIw0tIug2R6JOBlpaBdBsz0ScTLSusDQBI5EnIy0PjA0JyMRJyMN7SJoTkYiTkYa2kXQnIxEnIw0tIugORmJOBlpaBdBczIScTLS0C6C5mQk4mSkoV0EzclIxMnIwkZ80z2IOBlpaBdBczIScTLSusHQnIxEnIwsbPA33YOIk5GGdhE0JyMRJyMN7SJoTkYiTkba+CGak5GIk5E2hIjmZCTiZKSNIqI5GYk4GWVoF0FzMgpxMsrQLoLmZBTiZJShXSTNySjEyShDu0iak1GIk1GGdpE0J6MQJ6M2NoKfDmVHnIyyvjA0J6MQJ6MM7SJpTkYhTkYZ2kXSnIxCnIwytIukORmFOBllaBdJczIKcTLK0C6S5mQU4mSUoV0kzckoxMkoQ7tImpNRiJNRhnaRNCejECejDO0iaU5GIU5GGdpF0pyMQpyMMrSLpDkZhTgZZd1haE5GIU5GGdpF0pyMQpyMMrSLpDkZhTgZZWgXSXMyCnEyytAukuZkFOJklKFdJM3JKMTJKEO7SJqTUYiTUYZ2kTQnoxAnowztImlORiFORhnaRdKcjEKcjBLWoYnuQcTJKGEDzukeRJyMkjavBt2DiJNRhnaRNCejECejDO0iaU5GIU5GGdpF0pyMQpyMMrSLlGTOIYU4GWXzoEjSaUIhTkYZ2kUyOUEQJ6MM7SK5tCCoB617DH2jqRAno6x/DO2lo3BiFJsZhUn7gZOj9NlRyPtdhfOj2AQpNNujcIoUmyOFZnvUKEuK6UGa7VE4U4qhXSTN9iicLKX3kSF9lhTOl2I5GfLqX+GMKYZ1kTSNpHDWFJs2haaRFKJklM2cQtNIClEyyrAukqaRFKJklE2gQtNIClEyyrAukqaRFKJklLYdSA8NRMkobTuQHhqIklGGdZE0jaQQJaN0wMVCIUpGGdZF0pyTQpSMsi4ypCOrQoyMsj4yzNxGjIxKEzaREeJjlPWQoT0cFeJjlPWQIX1TFaJjlHWQIX1TFWJjlPWPIX1TFSJjVGr7jp4jiIxRfKoVhagYZdgWOquDQkyMSgNuoQoxMcoyMaTTq0JEjDJci6SJRYWIGGVdY+jhg3gYZT1jmOGDeBiVKXb4IBZGZTrQEoiFUdYzhh4+iIRR1jGGHj6Ig1HWL4YePoiCUYZlkTQbqxAFo3LWLVQhAkZZpximIRABoywBQ8aEKMS/KEOxMOMS0S8q5/MRKMS+KEOwSJppVoh9UdYjhh5qiHxR1iGGGWqIfFE560WvEPWi8tCkQ9SLKngveoWYF1XwXvQKES+q4L3oFeJdVGEzutE7I+JdVMEndUOsiypCcw6xLqrgcxIoRLooS7rQwxJxLsrQKnQAtkKUiyrsnGMyvOEUb8ZSoa8eNKJc9Maul+SurxHloi3lQl89aES5aEu50FcPGlEuOhR+pBHloi3lQt9TaES5aEu50PcUGlEu2lIu9D2FRpSLtpRLSobGakS56A3rzKsR4aJt+BEdBK0R4aL7ZLF0blxEuGhLuNCXJRoRLtoSLvRliUaEi7aEC31ZohHhohM2S4FGdIu20Ue0r7JGdIu2dAt9CaMR3aIt3UJfwmhEt2gbf8R1Ceo/S7fQNzYa0S3aBiCR+4JGbIu2AUj0vqAR26It20JfBWnEtmjLtmR0gkLEtmjLttD5kzRiW7RlW+irII3YFm3ZFvoqSCO2RVu2hb4K0oht0ZZtoa+CNGJbtGVb6KsgjdgWbdkW+ipII7ZFW7aFvgrSiG3Rlm2hdnaNuBYtFbtZa0S16D4SidqsNWJatGVa6NsojZgWbZmWnF5pEdOibfLZnB5EiGnRhkyROb0KIKZF20gkenPXiGnRlmmhr640Ylq0ZVroqyuNmBZtY5FIO0cjokVbooW+5tKIaNGWaMnJGEuNiBZtuBRJX3NpRLRom5mWvubSiGnRlmlhlgzEtOg+QS3d2zhFrWVaCpI41DhLrWVa6As0jTPV9qlq6e0dJ6u1TAt9gaZxvlo+3YseJaw1849OMKBxzlpDpdBpDjTOWmtpFjoqROPMtTYSiQ611Dh7raVZ6DQHGvEsOrXdRwZbasSzaMuz0HeJGjEtOrXdR7ccYlq0ZVroBAoaUS06DUQDasS1aMOnMAmPEdeiU/7woBHVog2fQidQ0Ihr0ZZroVMpI65FW66FPpVoxLXoLLR6IrJFZ4EQXI3IFp3Z3qMHEWJbdCYDtjViW7ShVOhMcBrRLTqzmSfoBRHRLTpj85ppxLboLJB4QiO6RRtKhRvIiG/RWaj7EN+iDanCjCFEuGjr8UKPTcS3aMOpMOMN8S3axiAxQwgRLtrGIDFDCDEu2jIuzBBCjIvO08AQQpSLtpQLsxwiykXndvLR+yQiXbTNiks7E2hEumibGJd2JtCIddGGWVG0M4FGtIsubAfSuxniXXRhE7XTVhHiXbQhVxTtTKAR86L7xC+0pYOYF23YFUU7E2hEvegicMmgEfeiDb+iaM8DjcgXXfBHd0S9pIZdUQmZozRF1Etq2BVFP8qSIuol3bApl1JEvKSGW1EJuWCkiHhJDbeiEkUXRqncNzpUGGVzN9wKCwMldLfEC5l+HdEu6cb2HTmSU0S7pIZbUbRTRYqIlzSxvUdntUfES5rY3qMT2yPiJTXciqKdKlJEvKSGW1G0U0WKiJfUcCuKdqpIEfGSGnZF0U4VKaJe0sS+l0CuRSmiXlLDrijaqSJF1EuaBM5+KaJe0iRw9ksR9ZIadkXR7hopol5SQ68o2l0jRdxLKgJ5DFLEvaTC9iA9kBD3ktrsLyQDlCLqJRWaZ4BSRL2kvaMLNacQ8ZL26V/ILTtFxEsqcpZsSBHvkvbpXyiyIUW0S9pnf6FOzCliXVJp+46efYh1SfkHflLEuaT2iR/adyZFrEvasy50qyHaJZV85p4U0S6pYVYU7ZSTItolNcwKPT0Q6ZLahLpUapsUUS6pYVXIcP0UES5pT7iQRmeKCJfUJn+hnWZSRLikvWsLeaJNEeGSWsKF9ilJEeOS2vQvZB6cFBEuqeFUFO31lCLCJVW26+glFhEuqeFUFB2JliLCJbXZX+h1AvEtqU3+wqwTiG9JDaWiJL0cI74lNZSKot2pUsS3pIZSUbTTU4r4ltS+DsTBQP1nSBXFjAzEuKTWs4VcCBHfktrUL8yURoRLagkXeiFEfEva8y3kQojoltTSLfRCiJ8LSm3n0QshfjIoZZNZp/jNIBtlRC9X+NUgw6bQ6VZS/G6QIVPoBPopfjnIkCl0Ev909HZQyibxT/HrQYZMoR8SSPEDQoZMoYnLFD8hZLgU+s2MFPEsqaFS6McBUkSzpIZJoR8HSBHLkmYBb6QUsSxpZqccvdshliXNAnYKYlnSLGSnIJYlzXg7BbEsaRayUxDLkmYBOwWRLGkWsFMQx5LmATsFcSxpbl/pondyRLKkfFrdFHEsac4nZk0RxZLmgSmHGJY0D0w5RLCkeWDKIX4lzQNTDtErqWFQmKmB2JXUECjM1EDkSloEqM0UkSupJVdod9YUkSupJVdor9MUkSupJVdor9MUkSupJVdor9MUkSupJVdor9MUkSup4U/otyBSxK2khj5RzMNwiFtJLbfCvA2HuJXUECiKeR4OsSuZZVdoD9UMsSvZJpBjKUPsSraxT+SR0zRD/Epm8+qSC2GG6JVsE0iRlSF6JbP0Cm3UZIheyTbsqpkhciXbBFbNDNEr2YZfNTPErmQbftXMELmSJfyqmSFuJbPcCvPIHuJWsoRdNTPErGQJv2pmiFjJEv5SIUO8SpYE/MkyxKtkllfh3gVEXZcEWM0M8SpZkvPsY4Z4lSzk0pIhXiWzLi30nXOGeJXMRhDRgR8Z4lUyYWceuRpmiFfJRCC7WYZ4lcxwJ4p5AhERK5ngMyJniFfJRCAjcoaYlUywxGaGeJWs51XoUYSIlawnVshpioiVrCdWyGmKiJWsz6pLTlPEq2TS9h39dCRiVjLJ5mbNEK+SSd4JN0O0SmafKSK3sQzRKpkMHO4yRKtkkn9eKkO8SmbIE8W8jImYlUzyMQsZolYyFYhZyBC1kim7atIP2yNqJVMisNcgaiVTrCdShoiVTAU4sQwxK5nNq0sPYkSsZDZkiB7EiFfJbFZdehAjWiVTtu/oh0URr5Ip9iooQ6xKpvmghQyRKpnhTZj3XxGnkunAAS9DnEpmaBNmECNKJbPBQnQIXoYolcw+u0y7DWeIVMnsy8u023CGSJXMECeKdhvOEKuSGeZE0Z7AGaJVMvsIM+0JnCFeJbO8Cu0JnCFeJesz6pIuIRliVjL7HDOd3iRD1ErWv8jMvLmLetA+yswsAIhcyey7zLR7b4bYlcw+zUy792aIXslS24P02ED8SmYdWWg33AwRLJkhURTtWZvhd5qtJwtjLOCnmg2Nomhv2Qy/1hwIG8rwe82hsKEMv9lsw4Zoz7cMP9vccyy0TYZfbuY5lmz0dHPotIBfbw5wLBl+wDnAsWSIY8kCHEuGOJbMcix0HpsMcSwZz7FkiGPJcsk7smWIZMkCgUMZIlkym0qXdjbJEMuS5SGjBdEsWe/GQnrTZIhnyawbC53SJ0NES5YHrBZEtGRFyGpBREtmY4eYYYyIlsy+XUQOY0SzZEXACylDNEtW8P7TGWJZsoL3n84QyZLZLLr0MEYkS2ZJFtpTPkMkS2aT6JLDGFEsmWFRGOMCMSz5hjdackSw5JtAvF6OCJbccCi0IZIjfiW3/Ao9PXJEsOSbgP9YjgiW3BIsdHxBjgiWfMNH7OWIYck3gYi9HDEsef9wETnic0Sx5DZVCzXic8Sw5EmA38wRxZLbuCFyxOeIYcktw0KO+BxRLHnCu73niGLJre8KHcGRI44l54OGcsSw5AnvdJsjgiU3HAo9O3LEr+RJ4ICeI34l758sokcx4lfy/skiehQjfiW3fit0LEuO+JXc8it0LEuO+JXc+q3QsSw54ldyy6/QsSw54ldyw6EoOpAkRwRLbjgUlZMbeo4IltwSLDQ1lSOKJbcvF9E50HJEseSGRlF0DrQccSy54VEUHUiSI5Ilt94rdCBJjliW3LIsdHBIjliW3LIs9F1sjniW3Pqv0MeWHBEtubQ9SA8kxLTklmmhbe8cMS25DBicOaJachngOHNEteQywHHmiGvJVYDjzBHXkhs6JSWvhXNEteSWaqFjcHJEteSGT1F0DE6OyJbc8CmKTjWXI7Ilt24sdKRMjtiW3Lqx0JEyOaJbcuvGQkfK5IhvyS3fQqeayxHfkhtSRdHhITliXHLrx0KnmssR5ZLrwPVQjjiX3Pqx0HnpcsS55DpAUueIdMkNr6I39HxFpEtueBW9IUNackS65DZyiPL1yhHlkhtWhfT1yhHhkvduLKSvV44Il1wHEiTliHDJbXoW2n0rR4RLbgkX0n0rR3xLbigVTTvg54hvydNQ5yG+JU9t59EzCvEteWo7j14yEN+Sp3znIbYlT/nOQ1xLnvKPv+WIaslt0BA9LhHTklumhWQtckS05P3TRXRZ1HM9z0KXRR1nqBRNxzfkiGfJM9tx9BqEeJa851noIYF4ltyQKdx8RkxLbsgUbj4jpiW3z0Qz4wdRLbmhU+jxg5iW3LAp9PhBREueB3w3c0S05HnAdzNHVEueB3w3c0S15H3IEL0GIa4l77kWcswjqiXPbefRuw2iWvI8cDObI6oltxlyaUMLMS15zvcdIlrygu87RLPkhU3MSY4exLLkhV0x6Y0U8Sx5wd7r5YhlyQs77ehtFNEsuXVmYQw9xLPkNlKIWYIQ0ZIXbEqrHNEseR8nRMaw5Ihoya0vCx0dkyOmpdgEDusFoloKw6ZoOlypQFRLYegUTSdKLRDXUhg6RdOJUgvEtRSGTtF0otQCcS2FoVM0nSi1QFxLYfgUTcf0FIhsKQyfoumYngKRLYXhUzQd01MgsqUwjIqmY3oKRLcUhlHRdExPgeiWwlAqmo7pKRDfUhhORdMxPQUiXApDqmg6pqdAjEthSBVNx/QUiHEpDK2i6ZieAnEuheFVNB15UyDSpbCkCx15UyDWpTDEiqaDaQrEuhSGWNF0XEiBWJfCECuaDvYoEOtSCHtHS/cgYl0KQ6xoOmSgQKxLYYgVTYcMFIh1KQyxoumQgQKxLoUhVjSdKLVArEvRPxdN9yBiXQphaTO6BxHrUljHFnqrLHrW5e8vb6r6Y3lsy/3bel9+vvnqjz9u/vGP9vmpvHn575t/VPY/k5dG5s1X/75Jbr76939e3gj3Z2b/lKL/s7B/KtX/mds/dV9e9/9ON/2fff1M9n/2v+e9vDy1fxb9v4v+30nSC0xEXzORG/cXV0a5MsqVUbr/i3aFdQ80cYiStP+EJHM/OTBi05fpHgi3f1Huf5yK7pFY++Xu07qUe/YvRV+ryz3Vt0qPRzsYXYS7/UtRuJbqtaeujbuoAfsXB6xzueub0bWjKlyDup8K17ROaWcp9H8xUP/z0o0P869uvGx3bdXUJzgWCgUGgwpV/Fi2Zb2t291DuftwLE/nQ+sNKpECSfZzKUnlSeh01x5h3S6z2FC3yyc2UXdf7o7PT576LlUbELGZElHWhIjsIkLxX3C4b45V+/Doff0GtqPr0S7RWP8X13/uL7nk5R+aT9vDwbb2/bb1564oLorERnJCnp7Keu8jBAATNx1ZEKddWe+r+h6K6Bi1QUauWN2nfXkoO+D7++O29tq4C00aRKRu2naRSYysti1P7dYM2+q+Lo/e4O2yGFw6PRNuUdJBaVhIDrq9y0DE1D23D2XdVrtRh2g47vOI6vvytDtWT21z3FX7x+r0uG13D57MHMjsXm+dlvnPT6fH6nRCPda9HgsEsRPrIqhq6sfmWLYP27qpy67Nt+35WNZNezo/PTXd1uIrSKGC0Nc33pTvbs0uFYVbU9N+DVNu4ezSZNpelf2a2oXH9qMmc7tO/z+db7X9i3DzzW0R2VDGLdu5nQUs2upfpjUgaOF1i4Ps9hd2zYHi7D/qpm0+1aXfInAcdg/rRkirm9ZMsXLfNkQb52BNFMUUvtKfqBmcqMo1sGvO4Dwx0uxf3FLgT1u43OupbigpGd3V7+XbEmd3ZA5f4Za4TXhMVv8qTU/QOBXEyX3x++2pTNX5eGib989t6S8uCnyqUlynAhHN+3+WO39fUgCG0lw3vj80uw+ntjl639AxY5c1WztbIePWlPfn6rD/81wen5unkbHQsX0XYdagomR0rdA2w0f5H6Phx3B934ugGgNu0uy+0dc/tUe0InYp4kF9rk93lb/MSbhasUNqdyi3aJUDe0Pf9kK69ctZ1Xk67MfOqGO3sN2hOXkdDKaBszZk5qxPp9HZt256pM6wz12Z3Nm3ubNvc3bB2DV7fy7mAq5c3LDYNY9P22OJmrbL/nFZaNg1ua/8WJ5O2/uyrR47s+DxyZMEl+dU8Ogfn84thpFI+A0bbqJeKneNsOO3Rbg6FaGPstIez4e2etieHliJxQZKZMetlbjf3j+931X7u2PzOFqTEmiDiWCLI1Gn9lhufbtXwi0x4WHV+2q0nGQZHLv90E/EcJYczkV8b9R31b2/Qm3gcucmWMZZPlbC2V8zJfwoJbmlctfUp/Z43rWmGlr3CwG3jo3bnvi50cv6UD7vy2P10WzvT9vWsws79+9Bauf0PVfYuTMQ99t2e9ccH7ft6bR7KB/9fT9NoIrJb6dVPB2bttk1h11Tt+XnllIjoZpAB8eo6f6D0iGgDnbRDuswcrdkS4FplKX8ctOLR7aZhPN54xboZOAdHEnh1mWRO44mdzayW7u1q64LZxELRxNs+lrZYCI5hiXL3ELvGJbc0Tq5dlSCs8dzt3PkeS+nEIEG7Tiou+rQ+hZu5ygPWozd4o7lyNiDhmySut3MsVJysMXdOcIRUMrB1a5Fugw//fbrKJnBaHTt2AWg9WbuMHNdq7nzSOeRGMIPTq7ewpAB+0OLCRncQaTLggU2TXbZNVL25GE+0XCL0uzCZEV0R1ZCBlyPhA536L7aH8tTczh3HzPmjzRcdAvBrm1GVrcZ+a0Kl1vBWYWXyoRxq+DWobPwx3QynsqjOXI39elY/nkuT4jpgNYIa+hacWOeREGriOWibO3m7u5UtrRNVIApl7PnDyuH+gpobqcsu+Hqf2x247GqwEDLWGbOihgIB9+w28DRHu5dSxP5HQtZoiI8sgiWqcu0COqHB0Zfn/oMCe0dzS+fRg7Tm/D8pVgJ5+PJ323gCdIdNoqBc3GrZ861bGcx+NYNbJHU8W4ZB6irj+1tAW8hBpInDUGwRosvRUIpjmx3nH+X2XVKnG8aw3VEsOxoV/uECJMu8TGA4jZrNfzF7dEpt9Qaqfj8DjrcbXuSW+4HAfdlSxD0Gn4by98MQg7lx/Lgjz4wj3L26DwIeDqTKOBJmiXBrZDRaUNL+AnuQK24Kb3ftmW/+fjDF85DKyRxV1KatUs6aeXnp+rom/oZJNaduZWGBnL5dH5/qE4PPioFtx93w1W4GyU3SXUeaPfy1Bz91oZsi3C3e4KlTfZld6x9Omyr2lIvT9vnQ7NFOKEFUwRE4QsWBU2OjDUX9uVdVVd4G4GUeDJwwW7Kd2HqnLT+LsLrM8jLOE4zTdn1i73PSOD+KKS798mG+1FnUTo7NHc2Zs4SFJ02ZP9qaGc5ekc56jlVg7nujFN+KTfCy49l3Z7eP49IEHgZ2IvK2AHHnlOTFN4KpNMCxqer7rkaIGK4UGOneier3HYmqhm33Qzb9Zd8VVN/KJ/9PR2uJJkIIix3D9Vh/2Swlh/KZ08OJHrywCDs5DgZ//z0wf9UuKqx51RfBsKRwKOV4BcfI4MTAQ8EqTsTDdykZPctK9S0OJYJF0eRunOm5PHR946Q1OF3rv5aDS0cGVw4NoPDgSNhU7eUsLzl5brOuwuCQ9w5CTh/hIwz9/dlu60Ovt0Az7Yb9uP8maqhTZsXLPRq/1i2D82epxXhdswv5pWRMGLTE0hziRCMumk/bg9ouYH3QII1rL2D4922OuBPgHQma947KR/9wwHEz9U8Px3svS1jlMAOZA96+0+1PzPg+paxDf+pHpOcYDawe4ipd2rxdpXBOc5bx92N2BFfJsKRwlshfdXxHQHsa/Z6Y/+pruq2PN5td6UpDc02OFOUDHx6P+Zxfch7K8kNlHJXladTuXsSOv2Q+G4q8D6Q5X98AZSvCqRNNDvlfTmkwwo0ZDfcyCv3QuukqGozAfHmU8BxyHoOlY+Vrxp8gRwckFgEdTcc9vgYCY8C7O25reu7CykwaxV7DL7s/t59mWfjDF4G00JIvx8JOWa94Yb1RUpVP53RYNBQgjPzHd+oWaeNi8ynY/NUHlt/593A72QJ9l7I6fnxsWyPyGLyvWTgkV9xK33553l7GDO/GlLlbF285MADK7ujGlO2G56dX89oce4CES77JN+WIyGdh8ZTSSyDhbfvs8OmE3hovGUbkt/9jJmoPTqCdxFYl89hDWtr3vtrZwHXvmBjnu5LtMyAeapY+3So29/R+nskGIzBTugEEOSshGNBpZMijuXTAVm3AAG7ypnqxvvBVw6dOMIj0dammgBedobbkHO/kHAaKXb3BkLGzQBmcRIWcDq/7+ze9/4equHVKLuNIwm0BZ14noxxkuw/zQw919Xj06HsSmODEJ6FWO4cSSa6TEDDMjzkBjFkt0GXE9bGRoJGXSfAV7HGD2gf7wQFANilhz2CWQkWhfmWh229PyCjGYwifi35XO7ObXmuD13Lvh8dPRT0TNKs62D5uT1udy06/yi4rmv24HFXtrsHQyZtD8dy1xz3p0/HCnl5QcNWs+Qqsal5FII7+fUbuBiuEN2lauZcwHN2/bE6qnp3OO/L08AS9si974cH64wlrnyB5zosEppjLPdtRXo1hcdf9BaVc1RXrE2JL/HgOYpd3GiPFjjDBHvLZS7+Rh5lCXT7Fqx73X1nDGwP//x0+lgeq7uqPN6X7UB61E1715yRxzW8JZHsxddYcG+pk5dICSThJWvzW6GBG2QNl5OC3ZBIOSQwDReFgt1bnMB9tf9QPj+Vx1NT+4cCCfqyYC/InRzSYtFwRBYJtzr4Mkbbvobrf5Fwe50vhdw1NfRMK1gDyEnqxim3WmloyBTsGdSJ6tp4W/l3gZBJz8VUR/USjttPvhB4E8luR05Iv7mO+wl+DLssOingwn1ExGt4n1iwHhGEKOLWW8ML54L1kCOFfWw+oL4XUBa37QJZoxmRwE9j6YJBQu8U1R/lhrWeGEpwVLJRN1juifSZ68JfgbDJz3TCxrMOXkIUm6m523/c+M5EQ/OySKZGaC+HgAPXSdbzF4mhVwFofBesiykSRXQbXJZYysGIqXaEWet7N0ZVHxmjcJFmo8bQbE+gI4hwTmfKuSKnavA+c4ZSzs+8lonl8S5RQ9VH0RISMrKatffvy3bkwQx9ZAIjrd2dj8ey5jx14LIcatOybo/PPoTuCXGA3bkasNRYJ2XEEcBlxkUg5uxpt3PCtob12KLOIFcU2GHaD9iqh5/B+p/fl21dfipPFNOg4D6QBrb+tjnsORECiuAnWNt5pNdt7+RqrMu7/h/ou+B9aMbezg0GJeJoFeTecvaEAu1RvzrkwEKTgvCdguZGGliz+rqjYxpkzFl+eLSbS299UexA6Op5pqmNhjJOGh4QAZ37JL+H0gKJyDoBT6+S3+9ogXXTPpetjar1pXqHfLa5aanW+EDfLaBAdjqMBA63MFR8ooDzVPJb0EiqvZihRSookl19RyIvIXB3HcVQo5EkNhrKZZfVgFwqtE5AJxjJmwVWwntvPsK1OnHuIInzz07dLXnKstWX7/XEwuXbRZknyeDc4uSz4aTD53pSoVfbxrklORfs1LkJpCwVaKSOAhk8h0SWvnnYj3wU4F0r60ln6vnuKf2Z2u9Dj8biFhm0osH7Hq6DbFmPtwffm7tGy1mHSVOth2y9OTvPLuqeR8BdW7LHi7HAj9vDucSZIQSMEpfsKQpKg8Cq+rF8bI4IIFyB2A3ZlO7XWfP37ftDSX8wXHvY3bm3TfrJ/LEcxV9svCsJ5/zHnvVYWwdeDfCV+8XUH35gKLt8GJmbYG7+Olsucb5liYtWSFgfr+oE8zX4ziaQ63LOisJ5wAl2faxO5VPnonXcHj6Uz11o2LG7m/aNUBg6pNktsTrxdiO0FhyTqFk+rzp1ZqBvr0DmJ2WZlurUWX+opucjzTeEMXT2758D8c0w6l4P4Z4syXaRyYciQ9JGD0cmlmb75yfkwg6XLTae7p+fTpwHKLV+woOoZNvaEZvPA214rgdfpN3xoz8nILvJTkZ8Nw3Na82uWt6eQHgcwg1UsJT6h/KZdixIoEmQsEa+V5/wBoBHJ3a1HAvxj8HQG1Czm8KH8hmfZOHhyaXHyZyvXO6Gcs76an0onx877qLa+q7jcF/R7K05xVbC7SN1K1bOunkdKuSporygYFedqf249bZtSOAnrMP74/azCwgwuVs6E+p92fu8+JevcMnPOYODomzg7beLj+0XAZEM0W9966ghMC537iQukVC6GSIEnQnncgKkLuVG5pwkM+cwnjkH42wo49zlc/aQ0n/GDjsugu4YxtWkCH81g84MKXuT2dc2RIfXmNBi4oZiX9mwHNZqwosfPFew24Ujvn2TAbSBYo/zDGeu4BaesqFuoDZFcUAZ3CIDRFDhcvC+J2VZBSBkRCJ6MW7cioIFGPbLJ86AFG5ZcFJQfIT0kkZN1B2l1gB1+ynExopDGYRXD6T+WF9QKIPqEDiuUzXVnuCG319vwVdNyCB5TOFFGTkTrjdvXS42F1yQuFUocQtUkjkT2KUzE8OVsgtYVi6qQl0ivtxfXJR0KoeDrwv8dXHTmQuyzlwYSTYE6DvJudv8ctausVyGvyZAfrv/ZJfWwClN3OckcvAZcI3AuqA/Vr4PI/QlYj2OH6u6etweToeyREwzPIyywVN1Fx53qP5VEoHc8Mo8c7x9xq4k1pIk0+NAl142CLmpuxjXsQMGmDZsvG7nxQcrwTsYi9vdRIhhkxzsHO0iFobQhWy4m+D2vVFiJwnTo2jW79jUG2xkIvBKQhdqzS41vpwxpSvh1a1mz6xP2/uqHgfzegS9m6DcJnqRMQ5JhT7Q7D2PR7CjKw84CXQaloBjT2HIHtuRT9ujn2ongTmxhGPW1JAi0jkBKZfmUru8mqlbCVOXQTN1NlrmSLXMLQyZO95lTmCWu1HHEqMG7CicCzrmsASXqxrMaCPgRYBkj7JO1mQ+GwEvzSR7jjXyyLh0eC/BuhhdbubpDDSp55cxKQSZcdAtlrVCQe1d47Nt8JTGcqAhpwcFOzhl7wyxCNodE5482fMdFjUQ3CSnDy+8JeviiWX6gxgunok7kOhh9jhLInNRkdmQu4S95cEKCQMZ3mAm7BEHC6qbdsvHigrokSBFxHAzIkhTD1rObOoZLMkMwGEx3dZ7mD/Ht+EgDcxGR5Lybb6cp2PzUL2vuluKqjz4xzcB7STJnmCw9HN9SQg4bltodkoRMZnct/urCjShYxYEMvEHPJCw1vxYCD0tYcRWwq/hI2n+LEq9NHGOQWCdPMfiiDkC2YwkZjj3oqgBrTxaIEoWdrRSkFrIYiZ/f19KNnvuOUNEC6OaCV738abSSJK9Cwkt/wKS3VJErNlWNNUBXiwWS7yORMFJOe4SATl1ybrUUD5v8G4uZ9Pd0QHVChLTqbthTTdDnBo77AdxxFlFwY7M+Y8ZgqsJbwo/oilWxLnuLsPajk4870oyDk1AD1PJes2GJY/4YAH9MyU/dkdSL/z++Yg8HLwwBtY36CKybUbeMDCjKb/UH5tdeTqRkTjQW5xNDUhtENCTJnEWR6KHG7kh//uUUD8n8K53OOjpY7+9oA3FOtoG5B7Ph/JE+acLSKNKlsEjRQ8x0cfm0HkqVk8VYlkFtE0lmxmBlF7Vu+Z4LHf0yU94BC5veAcl0/mEhBfXylKzYdGsVQVZfMmmU2CE28t2Y1z5QuESy5ILIaEjJwDoICpZnoEUac4AVX3fD4vmuCdHHnTvkiwHz2j43N20UPeR8Hgu2dRCtNSqZqXCCci6ojFSzR7OjGI4+3gaJiDXzGz/dkBAQ0qyqTJIqd0C1PWbLw+OWTbsl5RnqZcu+mt6akDDW7JOyQE1bpiBpKz323pn2PLdw9bnTwWksSRLldPq+v8kxzV0a5Iss0rKNZ7nn6r2oTm3416AM5I/51NyO1luvJDrNGRSJOsxjDK6+vsppJnYQH4ngUnvBC/PJ3eLUcIhP7p2SBDq0gaxeWydQNziCWwV4d6i0e69G+3SOWVuy88djZfzXJbTNZ62MI1KMjnLEA0F74aHGw3+PBYM41BepH7IuEJCmFMUzLMVMPZG0px5se38tqqaXOngas/6CAVkd33OiIZLPnsvOBbdbx/W7rIhKf2MHue0FfAsINmrjwkl/cxu7nzRXnaOqU2AEd3cMRYpPCpKNpXchPTzU5evLtA6cIVmLyJZJcNS19xZfb5wuExP2upj4XbIWPtmZD3BWyk5ufCMhOO8kgLeb0v2sm8sjzr5QC/4ZMaHk4wBvH2bNJUvssxGxw0tuBexmSbGMntTs6O96vt9+dQ+lJ93ZbnH4uGSweZEIcQ3h3LfmFNU+bnqsjrfVx/LUdo7ASOYJU/LjuRDFsUXCPuev+Nig+kUbNBs0tC2AsYXrTDmOJme8WwKDBgzkUxPDS4PhvIixSdNFi4VBvSJTKYHm5HC9hS8zpRsYhYnrFs0/GfYYMvwZrsJ7xldykL3Rza9BB1ZBJ2p083gJOZuu1lPvUEaSZTBJDU8LUnFKkmY10Dz14yuLroThjS3Zp2yhtoEtwRvpfmrCSp/KwzSSpwHQTI8EujiLzTr9zdIpfO1Q+9qwa/dTgiXsR265/BT8IwiN2HYxeBZ4zwRc2cW56wDyzinDjysK+dCkirnVsgmmDOSiOBFOJmHRwu4puZWFtg6bERLv5x0mY3HzmjwWpobPsdtvSeyWGjIaxXsnYOtvXvfHE8P2+4xQ+RgCc8DBTuErZQKBdFDzq5grX9b9+JiMkoLqSGzWLAXv72ccXXIwhXsScZWJ53QNGTFCnYJOm7r+3LXhSEccXoM6ODEzRJTnXBL8oI9ubolcu6BNJNidwDyCJ94WZ2GFy9Yq9laS9idBnoFpYM/HDt+xglkpBcL41aJjD3a9CL8OAp7tdvl8d0bU6usmRBEuBxKfqrxOpi3FwVcAyTr0hYQfAkbrPe+MxatD550WDfYgL4JrwOYtFKyDrJDHgUTVVA3jsi9RBp0AYeY74L+MzJl5wmXo0HB6MKMDTX36nvk1jgbrIDGkGSjODyRpKkKCaWpUWDFUJYqpMYy9l57EONnZw7eo0EPFcnaFL3kcXjr4A8FbMqL04bfovAQMtVJcZq6U+AoRBuafpLNOs7qsZ0ADldP9HyDYT6Sdc9g1VjT4Thk+IhQCBcUNvslq9D32qE1wCWE9YQNa6ibgZ33ZcPlI7CdhWQ7wTR4uIbwe22Ugu5ETiuBqwIbdhtWQly+wRddJJuzrBfr+K/+VsIPRyvvHzExDz1/5NTa4UUORm+i8LgjWZObV8HtobkXYjMxxwi5M7dQeOCU7BmEVzexg0LHD8keC3rx6KIERxwGrwQhXS7Z8H+kqBvzjBZyQsNIUskmA+DyISXw6lawAYqwev9ilrGTh+NpF4lD3bZCn1jJ+qdB8VbwcMVlN5Y+crzyT1gC3jJJNuUklE7aBtDcnrLYuKNmAu8KBX9OA1KMM3RsO0LzgD0HQ+kEQQZpvynL8SJjdChOvLfnp8xEfDJScAfKpjqtqz1lIkKmRrJZhoBAahB42ZKm7MxOCGkeQg6d9WIHQsad5BEfU1aTFdGej3VpXfSf0EUzdHCSbGSEy3Jmn8ZkFh9iu4Qsp2SZylAONQU38pzNPINFMAmIvfdupkzBWTmIBXwXRrKexFj0nLUMPooiWQ9JrIEcyvCWdsqKCWU6VtAeyqc2Bz7VceLlC5863BB5JGAQI08/gergtc4uWcf9sWqfL4OGM3PgWwKSjZmY0tMv333EF5nzBEbsSTb2fUrRY3Ms24dt3dT0O4sCuiFINiLFUzOx1MKkdnJqgTMS3Zul7XZb7/uHAx/P7Xl7ODyXn3eH8wnnzIKBYJL17aV17EwchAvfd3pMwuSxHsjQsel8x3rcejhyBxaQc5PsXctY4uDo44dwTMCHLwCwiYOhMtf6xNCX8CZZsc72WJppZFIcjKViU8d44pglHfoRTR2ajKBLRsVzbXyTyj2RHHLjZWCImRooQSLlLyZhHjU1tZsZMdXj47mFuZF2Dx0LjcTCfO9syCAUS20L0Hk/KYbIq5hJ3A/5rsur+ulYfqyas88Vw2Qpis2fxsgcJ7iX0CZXbJgMIQ+8TcNBhTdVbCwYIZo6fkloVCs20IKQNranJLSrFZv3hpI1jgqGOQgUmwcKyqKeOoDrvWY9BTwp3XF8W+9tsipycYCmtmKz2UChZnvzT/rn+kPdfKqJqQ0taDVltGDxAbFeZrCYuW3pobYcNmywidMNA+c5G04SVBEkFiW0wxR7nx6noG7aqkbPI1NR7nAFV6wHQFAnePeV/iw4o1l/zaCKS/olboeEl3IqyggdKXEXdZzXiYQRpYq/KB0HKUrofa5Yh+u+5jh9I3QbCRzk3HvgYwEwK1PAcsYRZRL6tyvWUxa788JlKWEdho5N0458SpLUewWG68fx6pzAzkmGTEys21l/mvZEQOpDsId7W7MfPb0djt8ehzG3imWbPEnN0f6TtFxghLBifRVGIe/w+J64XFRJ4vLZuQwvKUvzkA/zKXgZlrPzYKhrH+wYkWYSBhEr1v3h9NCcD4PhPcxM3w0EvnTMMl7dOugBgKyBdq+JZsL52bjw95wNQzErqx/TDP1BUjYmAWxp/oYO/bFiapPZCyHxo9n4hdC2kMBAFOHyaij3eqtyaYOUe3ldD25K7nXWVA+5N1yCjY37i/Pwz9yLgNlQxj3BnbMG1tiaSuAyJZIhUYrLFOJyEql0yB0yvJvjPs3l/FDDG+DO30q7aaJdSqPUjYx0eBnbpa5JXRKR1DVRWriPdRMwS4ahlrsGce3g3q3P3EvpWTbEPgzJ4IaUCy4/XzKkTxpyvPW1CvbkjD2f4ek4YR38ifRGME6XDe7piPN91QUlYW9KmB3JoWfjs7i8vNCrg71k6Ww7dNiAlgn7ycZjqm3eb09lqs5H/4AB/cUV6wM0yBilZILBA4r1M7RBVmiXgYtFwq9RFLHrxaK6Sa3cesdvByCN2fiRCmgec5PXnjtGKxZA009e9hzd2ejd8bF/uAO9YQnPaAVLu3RebP4ghp6IrJ0zOL8RV0ASZgdQrA+cn+4bOpyzvCsxahIYUiHYFb5t/nlCWVOhKSnEsC4OOd9cckuXcFK7XJSpW7NTl4ApzYeMpe4vLmtypoZFy/3kcsfl7ImybajXwuB7uawpOXLwhjt7wsamng/V/s7EPPmP0ECeKGe9kc61SbFPv9iioFNlygYKn4+Vb6hD64G9ZTgfDyAu0mWO62gqf0TC4ySbpIAWhk4+wpvb/NccBhuWRwXXXDZIjRKFMcGTK5stwZ3ygB9IR0Ebd+12lLd+fLBU0OkuY0MNnBrfr+FY3pUmIdr2MJwyfeEwtIK983XCu9k8PvkoSBukLLnnhODnSqDfS84eLVztfryTX5PAc4Fg3X6cqNFpRUFnh5QNpBvqA4/o8eao4PBI2UOKE0Ykb4e3a4LlYQcB9CtD8KTEhjZ+7B4H8MwZmHODW39smm9PHfRoyfkpYSqat6Or9rm5wyQ3uvqUcIRoNicGyjru4YJsp2aXtfHNIoxTV7Rt+feXN0/VU3mo6vLmqz/+/p///P/PVu2Uch0DAA=="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 000000000..072daed85 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1415 @@ +: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: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +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..89b419225 --- /dev/null +++ b/classes/AllowAllTenantGate.html @@ -0,0 +1,5 @@ +AllowAllTenantGate | DWN-SDK Documentation - v0.2.22

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

constructorisActiveTenant

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

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

constructorcomputeCidcomputeDagPbCidFromBytescomputeDagPbCidFromStreamparseCid

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

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

constructorblockstoreconfigclearclosedeletegetopenput

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

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

constructorduplicateDataStreamfromBytesfromObjecttoBytestoObject

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

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

closeprocessMessagevalidateMessageIntegrityvalidateTenantcreate

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

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

constructormaxDataSizeAllowedToBeEncoded

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

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

constructorcode

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

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

constructorbase64UrlToBytesbase64UrlToObjectbytesToBase64UrlbytesToObjectbytesToStringobjectToBytesstringToBase64UrlstringToBytes

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

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

constructorisEphemeralKeyCompressedaes256CtrDecryptaes256CtrEncrypteciesSecp256k1DecrypteciesSecp256k1Encrypt

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

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

constructorcloseemitopensubscribe

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

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

constructorindexulidFactoryappendclearclosedeleteEventsByCidgetEventsopenqueryEvents

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

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

authormessagesignaturePayloadsignertoJSONcreateparse

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

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

authormessagesignaturePayloadsignertoJSONcreateparse

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..0fcbe0a70 --- /dev/null +++ b/classes/EventsSubscribe.html @@ -0,0 +1,11 @@ +EventsSubscribe | DWN-SDK Documentation - v0.2.22

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

authormessagesignaturePayloadsignertoJSONcreateparse

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

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

constructorderivePrivateKeyderivePublicKey

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

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

constructorcreateSignercreateSignersdecodePlainObjectPayloadextractDidgetKidgetSignerDidverifySignature

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..683b9746a --- /dev/null +++ b/classes/Message.html @@ -0,0 +1,46 @@ +Message | DWN-SDK Documentation - v0.2.22

Class Message

A class containing utility methods for working with DWN messages.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

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 isSignedByAuthorDelegate

Static isSignedByOwnerDelegate

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

constructorcompareCidcompareMessageTimestampcreateAuthorizationcreateSignaturegetCidgetNewestMessagegetOldestMessagegetSignerisNewerisOlderisSignedByAuthorDelegateisSignedByOwnerDelegatevalidateJsonSchemavalidateSignatureStructure

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

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

constructorblockstoreconfigindexclearclosedeletegetopenputquerybuildQueryOptions

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

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

authormessagesignaturePayloadsignertoJSONcreateparse

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

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

authormessagesignaturePayloadsignerasDelegatedGrantauthorizetoJSONasDelegatedGrantcreatecreateFromPermissionsRequestparsevalidateScope

Generated using TypeDoc

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

Class PermissionsProtocol

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

+

Constructors

constructor +

Properties

definition +grantPath +requestPath +revocationPath +uri +

Methods

createGrant +createRequest +createRevocation +parseRequest +

Constructors

constructor

Properties

Static Readonly definition

definition: ProtocolDefinition = ...

The definition of the Permissions protocol.

+

Static Readonly grantPath

grantPath: "grant" = 'grant'

The protocol path of the grant record.

+

Static Readonly requestPath

requestPath: "request" = 'request'

The protocol path of the request record.

+

Static Readonly revocationPath

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

The protocol path of the revocation record.

+

Static Readonly uri

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

The URI of the DWN Permissions protocol.

+

Methods

Static createGrant

  • createGrant(options): Promise<{
        permissionGrantBytes: Uint8Array;
        permissionGrantModel: PermissionGrantModel;
        recordsWrite: RecordsWrite;
    }>

  • Convenience method to create a permission grant.

    +

    Parameters

    • options: PermissionGrantCreateOptions

    Returns Promise<{
        permissionGrantBytes: Uint8Array;
        permissionGrantModel: PermissionGrantModel;
        recordsWrite: RecordsWrite;
    }>

Static createRequest

  • createRequest(options): Promise<{
        permissionRequestBytes: Uint8Array;
        permissionRequestModel: PermissionRequestModel;
        recordsWrite: RecordsWrite;
    }>

  • Convenience method to create a permission request.

    +

    Parameters

    • options: PermissionRequestCreateOptions

    Returns Promise<{
        permissionRequestBytes: Uint8Array;
        permissionRequestModel: PermissionRequestModel;
        recordsWrite: RecordsWrite;
    }>

Static createRevocation

  • createRevocation(options): Promise<{
        permissionRevocationBytes: Uint8Array;
        permissionRevocationModel: PermissionRevocationModel;
        recordsWrite: RecordsWrite;
    }>

  • Convenience method to create a permission revocation.

    +

    Parameters

    • options: PermissionRevocationCreateOptions

    Returns Promise<{
        permissionRevocationBytes: Uint8Array;
        permissionRevocationModel: PermissionRevocationModel;
        recordsWrite: RecordsWrite;
    }>

Static parseRequest

  • parseRequest(base64UrlEncodedRequest): PermissionRequestModel

  • Parameters

    • base64UrlEncodedRequest: string

    Returns PermissionRequestModel

Settings

Member Visibility

Theme

On This Page

constructordefinitiongrantPathrequestPathrevocationPathuricreateGrantcreateRequestcreateRevocationparseRequest

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

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

authormessagesignaturePayloadsignertoJSONcreateparse

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

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

authormessagesignaturePayloadsignerauthorizetoJSONcreateparse

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

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

constructoralgorithmkeyIdsign

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

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

constructorderiveAndInjectPublicEncryptionKeys

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

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

authormessagesignaturePayloadsignertoJSONcreateparse

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

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

authormessagesignaturePayloadsignerauthorizetoJSONcreatenormalizeFilterparse

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..f0972ceb1 --- /dev/null +++ b/classes/Records.html @@ -0,0 +1,45 @@ +Records | DWN-SDK Documentation - v0.2.22

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

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

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

    +

    Parameters

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

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

      +
    • Optional ownerSignaturePayload: GenericSignaturePayload

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

      +

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorconstructKeyDerivationPathconstructKeyDerivationPathUsingDataFormatsSchemeconstructKeyDerivationPathUsingProtocolContextSchemeconstructKeyDerivationPathUsingProtocolPathSchemeconstructKeyDerivationPathUsingSchemasSchemeconvertFilterdecryptderivePrivateKeyfilterIncludesPublishedRecordsfilterIncludesUnpublishedRecordsgetParentContextFromOfContextIdnormalizeFiltershouldProtocolAuthorizevalidateAncestorKeyAndDescentKeyDerivationPathsMatchvalidateDelegatedGrantReferentialIntegrity

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

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

authormessagesignaturePayloadsignerauthorizeDelegateconstructIndexestoJSONcreateparse

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

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

authormessagesignaturePayloadsignerauthorizeDelegatetoJSONcreateparse

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

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

authormessagesignaturePayloadsignerauthorizeDelegatetoJSONcreateparse

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..2bf4281b2 --- /dev/null +++ b/classes/RecordsSubscribe.html @@ -0,0 +1,13 @@ +RecordsSubscribe | DWN-SDK Documentation - v0.2.22

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

authormessagesignaturePayloadsignerauthorizeDelegatetoJSONcreateparse

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

Class RecordsWrite

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

+

Implements

Properties

attesters +

Accessors

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

Methods

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

Properties

Readonly attesters

attesters: string[]

Accessors

author

isSignedByAuthorDelegate

isSignedByOwnerDelegate

message

owner

  • get owner(): undefined | string

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

    +

    Returns undefined | string

ownerSignaturePayload

  • get ownerSignaturePayload(): undefined | GenericSignaturePayload

  • Decoded owner signature payload.

    +

    Returns undefined | GenericSignaturePayload

ownerSignatureSigner

  • get ownerSignatureSigner(): undefined | string

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

    +

    Returns undefined | string

signaturePayload

  • get signaturePayload(): undefined | RecordsWriteSignaturePayload

  • Returns undefined | RecordsWriteSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

authorizeAuthorDelegate

  • authorizeAuthorDelegate(messageStore): Promise<void>

  • Authorizes the author-delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

authorizeOwnerDelegate

  • authorizeOwnerDelegate(messageStore): Promise<void>

  • Authorizes the owner-delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

constructIndexes

encryptSymmetricEncryptionKey

  • encryptSymmetricEncryptionKey(encryptionInput): Promise<void>

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

    +

    Parameters

    Returns Promise<void>

getEntryId

isInitialWrite

sign

  • sign(options): Promise<void>

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

    +

    Parameters

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

    Returns Promise<void>

signAsOwner

  • signAsOwner(signer): Promise<void>

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

    +

    Parameters

    Returns Promise<void>

signAsOwnerDelegate

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

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

    +

    Parameters

    • signer: Signer
    • delegatedGrant: DelegatedGrantMessage

    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 fetchInitialRecordsWrite

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

  • Fetches the initial RecordsWrite of a record.

    +

    Parameters

    Returns Promise<undefined | RecordsWrite>

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

    +

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

attestersauthorisSignedByAuthorDelegateisSignedByOwnerDelegatemessageownerownerSignaturePayloadownerSignatureSignersignaturePayloadsignerauthorizeAuthorDelegateauthorizeOwnerDelegateconstructIndexesencryptSymmetricEncryptionKeygetEntryIdisInitialWritesignsignAsOwnersignAsOwnerDelegatetoJSONcreatecreateAttestationcreateFromcreateSignerSignaturefetchInitialRecordsWritegetAttestersgetAuthorgetEntryIdgetInitialWriteisInitialWriteparseverifyEqualityOfImmutableProperties

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

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

constructorderiveChildPrivateKeyderivePrivateKeyderivePublicKeygenerateKeyPairgenerateKeyPairRawgetPublicJwkgetPublicKeyprivateJwkToBytesprivateKeyToJwkpublicJwkToBytespublicKeyToJwksignvalidateKeyverify

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

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

constructorcreateDidResolutionResultgenerateAuthorizationgenerateAuthorizationSignaturegenerateDidKeyPersonagenerateEventsGetgenerateEventsQuerygenerateEventsSubscribegenerateFromRecordsWritegenerateMessagesGetgeneratePermissionsGrantgeneratePermissionsRequestgeneratePermissionsRevokegeneratePersonagenerateProtocolEncryptedRecordsWritegenerateProtocolsConfiguregenerateProtocolsQuerygenerateRecordsDeletegenerateRecordsQuerygenerateRecordsSubscribegenerateRecordsWriterandomBytesrandomCborSha256CidrandomIntrandomSignatureStringrandomStringrandomTimestamp

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..f7716c0d0 --- /dev/null +++ b/classes/Time.html @@ -0,0 +1,24 @@ +Time | DWN-SDK Documentation - v0.2.22

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

constructorcreateOffsetTimestampcreateTimestampgetCurrentTimestampminimalSleepsleepvalidateTimestamp

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

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

CreatedAscendingCreatedDescendingPublishedAscendingPublishedDescending

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..593eee63a --- /dev/null +++ b/enums/DwnErrorCode.html @@ -0,0 +1,146 @@ +DwnErrorCode | DWN-SDK Documentation - v0.2.22

Enumeration DwnErrorCode

DWN SDK error codes.

+

Enumeration Members

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

Enumeration Members

AuthenticateDescriptorCidMismatch

AuthenticateDescriptorCidMismatch: "AuthenticateDescriptorCidMismatch"

AuthenticateJwsMissing

AuthenticateJwsMissing: "AuthenticateJwsMissing"

AuthenticationMoreThanOneSignatureNotSupported

AuthenticationMoreThanOneSignatureNotSupported: "AuthenticationMoreThanOneSignatureNotSupported"

AuthorizationAuthorNotOwner

AuthorizationAuthorNotOwner: "AuthorizationAuthorNotOwner"

AuthorizationNotGrantedToAuthor

AuthorizationNotGrantedToAuthor: "AuthorizationNotGrantedToAuthor"

ComputeCidCodecNotSupported

ComputeCidCodecNotSupported: "ComputeCidCodecNotSupported"

ComputeCidMultihashNotSupported

ComputeCidMultihashNotSupported: "ComputeCidMultihashNotSupported"

DidMethodNotSupported

DidMethodNotSupported: "DidMethodNotSupported"

DidNotString

DidNotString: "DidNotString"

DidNotValid

DidNotValid: "DidNotValid"

DidResolutionFailed

DidResolutionFailed: "DidResolutionFailed"

Ed25519InvalidJwk

Ed25519InvalidJwk: "Ed25519InvalidJwk"

EventEmitterStreamNotOpenError

EventEmitterStreamNotOpenError: "EventEmitterStreamNotOpenError"

EventsSubscribeEventStreamUnimplemented

EventsSubscribeEventStreamUnimplemented: "EventsSubscribeEventStreamUnimplemented"

GeneralJwsVerifierGetPublicKeyNotFound

GeneralJwsVerifierGetPublicKeyNotFound: "GeneralJwsVerifierGetPublicKeyNotFound"

GeneralJwsVerifierInvalidSignature

GeneralJwsVerifierInvalidSignature: "GeneralJwsVerifierInvalidSignature"

GrantAuthorizationGrantExpired

GrantAuthorizationGrantExpired: "GrantAuthorizationGrantExpired"

GrantAuthorizationGrantMissing

GrantAuthorizationGrantMissing: "GrantAuthorizationGrantMissing"

GrantAuthorizationGrantNotYetActive

GrantAuthorizationGrantNotYetActive: "GrantAuthorizationGrantNotYetActive"

GrantAuthorizationGrantRevoked

GrantAuthorizationGrantRevoked: "GrantAuthorizationGrantRevoked"

GrantAuthorizationInterfaceMismatch

GrantAuthorizationInterfaceMismatch: "GrantAuthorizationInterfaceMismatch"

GrantAuthorizationMethodMismatch

GrantAuthorizationMethodMismatch: "GrantAuthorizationMethodMismatch"

GrantAuthorizationNotGrantedForTenant

GrantAuthorizationNotGrantedForTenant: "GrantAuthorizationNotGrantedForTenant"

GrantAuthorizationNotGrantedToAuthor

GrantAuthorizationNotGrantedToAuthor: "GrantAuthorizationNotGrantedToAuthor"

HdKeyDerivationPathInvalid

HdKeyDerivationPathInvalid: "HdKeyDerivationPathInvalid"

IndexInvalidCursorSortProperty

IndexInvalidCursorSortProperty: "IndexInvalidCursorSortProperty"

IndexInvalidCursorValueType

IndexInvalidCursorValueType: "IndexInvalidCursorValueType"

IndexInvalidSortPropertyInMemory

IndexInvalidSortPropertyInMemory: "IndexInvalidSortPropertyInMemory"

IndexMissingIndexableProperty

IndexMissingIndexableProperty: "IndexMissingIndexableProperty"

JwsDecodePlainObjectPayloadInvalid

JwsDecodePlainObjectPayloadInvalid: "JwsDecodePlainObjectPayloadInvalid"

JwsVerifySignatureUnsupportedCrv

JwsVerifySignatureUnsupportedCrv: "JwsVerifySignatureUnsupportedCrv"

MessageGetInvalidCid

MessageGetInvalidCid: "MessageGetInvalidCid"

ParseCidCodecNotSupported

ParseCidCodecNotSupported: "ParseCidCodecNotSupported"

ParseCidMultihashNotSupported

ParseCidMultihashNotSupported: "ParseCidMultihashNotSupported"

PermissionsGrantGrantedByMismatch

PermissionsGrantGrantedByMismatch: "PermissionsGrantGrantedByMismatch"

PermissionsGrantNotADelegatedGrant

PermissionsGrantNotADelegatedGrant: "PermissionsGrantNotADelegatedGrant"

PermissionsGrantScopeContextIdAndProtocolPath

PermissionsGrantScopeContextIdAndProtocolPath: "PermissionsGrantScopeContextIdAndProtocolPath"

PermissionsGrantScopeSchemaProhibitedFields

PermissionsGrantScopeSchemaProhibitedFields: "PermissionsGrantScopeSchemaProhibitedFields"

PermissionsGrantUnauthorizedGrant

PermissionsGrantUnauthorizedGrant: "PermissionsGrantUnauthorizedGrant"

PermissionsRevokeMissingPermissionsGrant

PermissionsRevokeMissingPermissionsGrant: "PermissionsRevokeMissingPermissionsGrant"

PermissionsRevokeUnauthorizedRevoke

PermissionsRevokeUnauthorizedRevoke: "PermissionsRevokeUnauthorizedRevoke"

PrivateKeySignerUnableToDeduceAlgorithm

PrivateKeySignerUnableToDeduceAlgorithm: "PrivateKeySignerUnableToDeduceAlgorithm"

PrivateKeySignerUnableToDeduceKeyId

PrivateKeySignerUnableToDeduceKeyId: "PrivateKeySignerUnableToDeduceKeyId"

PrivateKeySignerUnsupportedCurve

PrivateKeySignerUnsupportedCurve: "PrivateKeySignerUnsupportedCurve"

ProtocolAuthorizationActionNotAllowed

ProtocolAuthorizationActionNotAllowed: "ProtocolAuthorizationActionNotAllowed"

ProtocolAuthorizationActionRulesNotFound

ProtocolAuthorizationActionRulesNotFound: "ProtocolAuthorizationActionRulesNotFound"

ProtocolAuthorizationDuplicateRoleRecipient

ProtocolAuthorizationDuplicateRoleRecipient: "ProtocolAuthorizationDuplicateRoleRecipient"

ProtocolAuthorizationIncorrectContextId

ProtocolAuthorizationIncorrectContextId: "ProtocolAuthorizationIncorrectContextId"

ProtocolAuthorizationIncorrectDataFormat

ProtocolAuthorizationIncorrectDataFormat: "ProtocolAuthorizationIncorrectDataFormat"

ProtocolAuthorizationIncorrectProtocolPath

ProtocolAuthorizationIncorrectProtocolPath: "ProtocolAuthorizationIncorrectProtocolPath"

ProtocolAuthorizationInvalidSchema

ProtocolAuthorizationInvalidSchema: "ProtocolAuthorizationInvalidSchema"

ProtocolAuthorizationInvalidType

ProtocolAuthorizationInvalidType: "ProtocolAuthorizationInvalidType"

ProtocolAuthorizationMatchingRoleRecordNotFound

ProtocolAuthorizationMatchingRoleRecordNotFound: "ProtocolAuthorizationMatchingRoleRecordNotFound"

ProtocolAuthorizationMaxSizeInvalid

ProtocolAuthorizationMaxSizeInvalid: "ProtocolAuthorizationMaxSizeInvalid"

ProtocolAuthorizationMinSizeInvalid

ProtocolAuthorizationMinSizeInvalid: "ProtocolAuthorizationMinSizeInvalid"

ProtocolAuthorizationMissingContextId

ProtocolAuthorizationMissingContextId: "ProtocolAuthorizationMissingContextId"

ProtocolAuthorizationMissingRuleSet

ProtocolAuthorizationMissingRuleSet: "ProtocolAuthorizationMissingRuleSet"

ProtocolAuthorizationNotARole

ProtocolAuthorizationNotARole: "ProtocolAuthorizationNotARole"

ProtocolAuthorizationParentNotFoundConstructingAncestorChain

ProtocolAuthorizationParentNotFoundConstructingAncestorChain: "ProtocolAuthorizationParentNotFoundConstructingAncestorChain"

ProtocolAuthorizationParentlessIncorrectProtocolPath

ProtocolAuthorizationParentlessIncorrectProtocolPath: "ProtocolAuthorizationParentlessIncorrectProtocolPath"

ProtocolAuthorizationProtocolNotFound

ProtocolAuthorizationProtocolNotFound: "ProtocolAuthorizationProtocolNotFound"

ProtocolAuthorizationQueryWithoutRole

ProtocolAuthorizationQueryWithoutRole: "ProtocolAuthorizationQueryWithoutRole"

ProtocolAuthorizationRoleMissingRecipient

ProtocolAuthorizationRoleMissingRecipient: "ProtocolAuthorizationRoleMissingRecipient"

ProtocolsConfigureDuplicateActorInRuleSet

ProtocolsConfigureDuplicateActorInRuleSet: "ProtocolsConfigureDuplicateActorInRuleSet"

ProtocolsConfigureDuplicateRoleInRuleSet

ProtocolsConfigureDuplicateRoleInRuleSet: "ProtocolsConfigureDuplicateRoleInRuleSet"

ProtocolsConfigureInvalidActionDeleteWithoutCreate

ProtocolsConfigureInvalidActionDeleteWithoutCreate: "ProtocolsConfigureInvalidActionDeleteWithoutCreate"

ProtocolsConfigureInvalidActionMissingOf

ProtocolsConfigureInvalidActionMissingOf: "ProtocolsConfigureInvalidActionMissingOf"

ProtocolsConfigureInvalidActionOfNotAllowed

ProtocolsConfigureInvalidActionOfNotAllowed: "ProtocolsConfigureInvalidActionOfNotAllowed"

ProtocolsConfigureInvalidActionUpdateWithoutCreate

ProtocolsConfigureInvalidActionUpdateWithoutCreate: "ProtocolsConfigureInvalidActionUpdateWithoutCreate"

ProtocolsConfigureInvalidRecipientOfAction

ProtocolsConfigureInvalidRecipientOfAction: "ProtocolsConfigureInvalidRecipientOfAction"

ProtocolsConfigureInvalidRuleSetRecordType

ProtocolsConfigureInvalidRuleSetRecordType: "ProtocolsConfigureInvalidRuleSetRecordType"

ProtocolsConfigureInvalidSize

ProtocolsConfigureInvalidSize: "ProtocolsConfigureInvalidSize"

ProtocolsConfigureQueryNotAllowed

ProtocolsConfigureQueryNotAllowed: "ProtocolsConfigureQueryNotAllowed"

ProtocolsConfigureRecordNestingDepthExceeded

ProtocolsConfigureRecordNestingDepthExceeded: "ProtocolsConfigureRecordNestingDepthExceeded"

ProtocolsConfigureRoleDoesNotExistAtGivenPath

ProtocolsConfigureRoleDoesNotExistAtGivenPath: "ProtocolsConfigureRoleDoesNotExistAtGivenPath"

ProtocolsConfigureUnauthorized

ProtocolsConfigureUnauthorized: "ProtocolsConfigureUnauthorized"

ProtocolsQueryUnauthorized

ProtocolsQueryUnauthorized: "ProtocolsQueryUnauthorized"

RecordsAuthorDelegatedGrantAndIdExistenceMismatch

RecordsAuthorDelegatedGrantAndIdExistenceMismatch: "RecordsAuthorDelegatedGrantAndIdExistenceMismatch"

RecordsAuthorDelegatedGrantCidMismatch

RecordsAuthorDelegatedGrantCidMismatch: "RecordsAuthorDelegatedGrantCidMismatch"

RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch

RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch: "RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch"

RecordsAuthorDelegatedGrantNotADelegatedGrant

RecordsAuthorDelegatedGrantNotADelegatedGrant: "RecordsAuthorDelegatedGrantNotADelegatedGrant"

RecordsDecryptNoMatchingKeyEncryptedFound

RecordsDecryptNoMatchingKeyEncryptedFound: "RecordsDecryptNoMatchingKeyEncryptedFound"

RecordsDeleteAuthorizationFailed

RecordsDeleteAuthorizationFailed: "RecordsDeleteAuthorizationFailed"

RecordsDerivePrivateKeyUnSupportedCurve

RecordsDerivePrivateKeyUnSupportedCurve: "RecordsDerivePrivateKeyUnSupportedCurve"

RecordsGrantAuthorizationConditionPublicationProhibited

RecordsGrantAuthorizationConditionPublicationProhibited: "RecordsGrantAuthorizationConditionPublicationProhibited"

RecordsGrantAuthorizationConditionPublicationRequired

RecordsGrantAuthorizationConditionPublicationRequired: "RecordsGrantAuthorizationConditionPublicationRequired"

RecordsGrantAuthorizationDeleteProtocolScopeMismatch

RecordsGrantAuthorizationDeleteProtocolScopeMismatch: "RecordsGrantAuthorizationDeleteProtocolScopeMismatch"

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch: "RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch"

RecordsGrantAuthorizationScopeContextIdMismatch

RecordsGrantAuthorizationScopeContextIdMismatch: "RecordsGrantAuthorizationScopeContextIdMismatch"

RecordsGrantAuthorizationScopeNotProtocol

RecordsGrantAuthorizationScopeNotProtocol: "RecordsGrantAuthorizationScopeNotProtocol"

RecordsGrantAuthorizationScopeProtocolMismatch

RecordsGrantAuthorizationScopeProtocolMismatch: "RecordsGrantAuthorizationScopeProtocolMismatch"

RecordsGrantAuthorizationScopeProtocolPathMismatch

RecordsGrantAuthorizationScopeProtocolPathMismatch: "RecordsGrantAuthorizationScopeProtocolPathMismatch"

RecordsGrantAuthorizationScopeSchema

RecordsGrantAuthorizationScopeSchema: "RecordsGrantAuthorizationScopeSchema"

RecordsInvalidAncestorKeyDerivationSegment

RecordsInvalidAncestorKeyDerivationSegment: "RecordsInvalidAncestorKeyDerivationSegment"

RecordsOwnerDelegatedGrantAndIdExistenceMismatch

RecordsOwnerDelegatedGrantAndIdExistenceMismatch: "RecordsOwnerDelegatedGrantAndIdExistenceMismatch"

RecordsOwnerDelegatedGrantCidMismatch

RecordsOwnerDelegatedGrantCidMismatch: "RecordsOwnerDelegatedGrantCidMismatch"

RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch

RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch: "RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch"

RecordsOwnerDelegatedGrantNotADelegatedGrant

RecordsOwnerDelegatedGrantNotADelegatedGrant: "RecordsOwnerDelegatedGrantNotADelegatedGrant"

RecordsProtocolContextDerivationSchemeMissingContextId

RecordsProtocolContextDerivationSchemeMissingContextId: "RecordsProtocolContextDerivationSchemeMissingContextId"

RecordsProtocolPathDerivationSchemeMissingProtocol

RecordsProtocolPathDerivationSchemeMissingProtocol: "RecordsProtocolPathDerivationSchemeMissingProtocol"

RecordsQueryCreateFilterPublishedSortInvalid

RecordsQueryCreateFilterPublishedSortInvalid: "RecordsQueryCreateFilterPublishedSortInvalid"

RecordsQueryFilterMissingRequiredProperties

RecordsQueryFilterMissingRequiredProperties: "RecordsQueryFilterMissingRequiredProperties"

RecordsQueryParseFilterPublishedSortInvalid

RecordsQueryParseFilterPublishedSortInvalid: "RecordsQueryParseFilterPublishedSortInvalid"

RecordsReadAuthorizationFailed

RecordsReadAuthorizationFailed: "RecordsReadAuthorizationFailed"

RecordsReadReturnedMultiple

RecordsReadReturnedMultiple: "RecordsReadReturnedMultiple"

RecordsSchemasDerivationSchemeMissingSchema

RecordsSchemasDerivationSchemeMissingSchema: "RecordsSchemasDerivationSchemeMissingSchema"

RecordsSubscribeEventStreamUnimplemented

RecordsSubscribeEventStreamUnimplemented: "RecordsSubscribeEventStreamUnimplemented"

RecordsSubscribeFilterMissingRequiredProperties

RecordsSubscribeFilterMissingRequiredProperties: "RecordsSubscribeFilterMissingRequiredProperties"

RecordsWriteAttestationIntegrityDescriptorCidMismatch

RecordsWriteAttestationIntegrityDescriptorCidMismatch: "RecordsWriteAttestationIntegrityDescriptorCidMismatch"

RecordsWriteAttestationIntegrityInvalidPayloadProperty

RecordsWriteAttestationIntegrityInvalidPayloadProperty: "RecordsWriteAttestationIntegrityInvalidPayloadProperty"

RecordsWriteAttestationIntegrityMoreThanOneSignature

RecordsWriteAttestationIntegrityMoreThanOneSignature: "RecordsWriteAttestationIntegrityMoreThanOneSignature"

RecordsWriteAuthorizationFailed

RecordsWriteAuthorizationFailed: "RecordsWriteAuthorizationFailed"

RecordsWriteCreateDataAndDataCidMutuallyExclusive

RecordsWriteCreateDataAndDataCidMutuallyExclusive: "RecordsWriteCreateDataAndDataCidMutuallyExclusive"

RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive

RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive: "RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive"

RecordsWriteCreateMissingSigner

RecordsWriteCreateMissingSigner: "RecordsWriteCreateMissingSigner"

RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive

RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive: "RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive"

RecordsWriteDataCidMismatch

RecordsWriteDataCidMismatch: "RecordsWriteDataCidMismatch"

RecordsWriteDataSizeMismatch

RecordsWriteDataSizeMismatch: "RecordsWriteDataSizeMismatch"

RecordsWriteGetEntryIdUndefinedAuthor

RecordsWriteGetEntryIdUndefinedAuthor: "RecordsWriteGetEntryIdUndefinedAuthor"

RecordsWriteGetInitialWriteNotFound

RecordsWriteGetInitialWriteNotFound: "RecordsWriteGetInitialWriteNotFound"

RecordsWriteImmutablePropertyChanged

RecordsWriteImmutablePropertyChanged: "RecordsWriteImmutablePropertyChanged"

RecordsWriteMissingDataInPrevious

RecordsWriteMissingDataInPrevious: "RecordsWriteMissingDataInPrevious"

RecordsWriteMissingDataStream

RecordsWriteMissingDataStream: "RecordsWriteMissingDataStream"

RecordsWriteMissingEncodedDataInPrevious

RecordsWriteMissingEncodedDataInPrevious: "RecordsWriteMissingEncodedDataInPrevious"

RecordsWriteMissingProtocol

RecordsWriteMissingProtocol: "RecordsWriteMissingProtocol"

RecordsWriteMissingSchema

RecordsWriteMissingSchema: "RecordsWriteMissingSchema"

RecordsWriteMissingSigner

RecordsWriteMissingSigner: "RecordsWriteMissingSigner"

RecordsWriteOwnerAndTenantMismatch

RecordsWriteOwnerAndTenantMismatch: "RecordsWriteOwnerAndTenantMismatch"

RecordsWriteSignAsOwnerDelegateUnknownAuthor

RecordsWriteSignAsOwnerDelegateUnknownAuthor: "RecordsWriteSignAsOwnerDelegateUnknownAuthor"

RecordsWriteSignAsOwnerUnknownAuthor

RecordsWriteSignAsOwnerUnknownAuthor: "RecordsWriteSignAsOwnerUnknownAuthor"

RecordsWriteValidateIntegrityAttestationMismatch

RecordsWriteValidateIntegrityAttestationMismatch: "RecordsWriteValidateIntegrityAttestationMismatch"

RecordsWriteValidateIntegrityContextIdMismatch

RecordsWriteValidateIntegrityContextIdMismatch: "RecordsWriteValidateIntegrityContextIdMismatch"

RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload

RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload: "RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload"

RecordsWriteValidateIntegrityDateCreatedMismatch

RecordsWriteValidateIntegrityDateCreatedMismatch: "RecordsWriteValidateIntegrityDateCreatedMismatch"

RecordsWriteValidateIntegrityEncryptionCidMismatch

RecordsWriteValidateIntegrityEncryptionCidMismatch: "RecordsWriteValidateIntegrityEncryptionCidMismatch"

RecordsWriteValidateIntegrityRecordIdUnauthorized

RecordsWriteValidateIntegrityRecordIdUnauthorized: "RecordsWriteValidateIntegrityRecordIdUnauthorized"

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

AuthenticateDescriptorCidMismatchAuthenticateJwsMissingAuthenticationMoreThanOneSignatureNotSupportedAuthorizationAuthorNotOwnerAuthorizationNotGrantedToAuthorComputeCidCodecNotSupportedComputeCidMultihashNotSupportedDidMethodNotSupportedDidNotStringDidNotValidDidResolutionFailedEd25519InvalidJwkEventEmitterStreamNotOpenErrorEventsSubscribeEventStreamUnimplementedGeneralJwsVerifierGetPublicKeyNotFoundGeneralJwsVerifierInvalidSignatureGrantAuthorizationGrantExpiredGrantAuthorizationGrantMissingGrantAuthorizationGrantNotYetActiveGrantAuthorizationGrantRevokedGrantAuthorizationInterfaceMismatchGrantAuthorizationMethodMismatchGrantAuthorizationNotGrantedForTenantGrantAuthorizationNotGrantedToAuthorHdKeyDerivationPathInvalidIndexInvalidCursorSortPropertyIndexInvalidCursorValueTypeIndexInvalidSortPropertyInMemoryIndexMissingIndexablePropertyJwsDecodePlainObjectPayloadInvalidJwsVerifySignatureUnsupportedCrvMessageGetInvalidCidParseCidCodecNotSupportedParseCidMultihashNotSupportedPermissionsGrantGrantedByMismatchPermissionsGrantNotADelegatedGrantPermissionsGrantScopeContextIdAndProtocolPathPermissionsGrantScopeSchemaProhibitedFieldsPermissionsGrantUnauthorizedGrantPermissionsRevokeMissingPermissionsGrantPermissionsRevokeUnauthorizedRevokePrivateKeySignerUnableToDeduceAlgorithmPrivateKeySignerUnableToDeduceKeyIdPrivateKeySignerUnsupportedCurveProtocolAuthorizationActionNotAllowedProtocolAuthorizationActionRulesNotFoundProtocolAuthorizationDuplicateRoleRecipientProtocolAuthorizationIncorrectContextIdProtocolAuthorizationIncorrectDataFormatProtocolAuthorizationIncorrectProtocolPathProtocolAuthorizationInvalidSchemaProtocolAuthorizationInvalidTypeProtocolAuthorizationMatchingRoleRecordNotFoundProtocolAuthorizationMaxSizeInvalidProtocolAuthorizationMinSizeInvalidProtocolAuthorizationMissingContextIdProtocolAuthorizationMissingRuleSetProtocolAuthorizationNotARoleProtocolAuthorizationParentNotFoundConstructingAncestorChainProtocolAuthorizationParentlessIncorrectProtocolPathProtocolAuthorizationProtocolNotFoundProtocolAuthorizationQueryWithoutRoleProtocolAuthorizationRoleMissingRecipientProtocolsConfigureDuplicateActorInRuleSetProtocolsConfigureDuplicateRoleInRuleSetProtocolsConfigureInvalidActionDeleteWithoutCreateProtocolsConfigureInvalidActionMissingOfProtocolsConfigureInvalidActionOfNotAllowedProtocolsConfigureInvalidActionUpdateWithoutCreateProtocolsConfigureInvalidRecipientOfActionProtocolsConfigureInvalidRuleSetRecordTypeProtocolsConfigureInvalidSizeProtocolsConfigureQueryNotAllowedProtocolsConfigureRecordNestingDepthExceededProtocolsConfigureRoleDoesNotExistAtGivenPathProtocolsConfigureUnauthorizedProtocolsQueryUnauthorizedRecordsAuthorDelegatedGrantAndIdExistenceMismatchRecordsAuthorDelegatedGrantCidMismatchRecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatchRecordsAuthorDelegatedGrantNotADelegatedGrantRecordsDecryptNoMatchingKeyEncryptedFoundRecordsDeleteAuthorizationFailedRecordsDerivePrivateKeyUnSupportedCurveRecordsGrantAuthorizationConditionPublicationProhibitedRecordsGrantAuthorizationConditionPublicationRequiredRecordsGrantAuthorizationDeleteProtocolScopeMismatchRecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatchRecordsGrantAuthorizationScopeContextIdMismatchRecordsGrantAuthorizationScopeNotProtocolRecordsGrantAuthorizationScopeProtocolMismatchRecordsGrantAuthorizationScopeProtocolPathMismatchRecordsGrantAuthorizationScopeSchemaRecordsInvalidAncestorKeyDerivationSegmentRecordsOwnerDelegatedGrantAndIdExistenceMismatchRecordsOwnerDelegatedGrantCidMismatchRecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatchRecordsOwnerDelegatedGrantNotADelegatedGrantRecordsProtocolContextDerivationSchemeMissingContextIdRecordsProtocolPathDerivationSchemeMissingProtocolRecordsQueryCreateFilterPublishedSortInvalidRecordsQueryFilterMissingRequiredPropertiesRecordsQueryParseFilterPublishedSortInvalidRecordsReadAuthorizationFailedRecordsReadReturnedMultipleRecordsSchemasDerivationSchemeMissingSchemaRecordsSubscribeEventStreamUnimplementedRecordsSubscribeFilterMissingRequiredPropertiesRecordsWriteAttestationIntegrityDescriptorCidMismatchRecordsWriteAttestationIntegrityInvalidPayloadPropertyRecordsWriteAttestationIntegrityMoreThanOneSignatureRecordsWriteAuthorizationFailedRecordsWriteCreateDataAndDataCidMutuallyExclusiveRecordsWriteCreateDataCidAndDataSizeMutuallyInclusiveRecordsWriteCreateMissingSignerRecordsWriteCreateProtocolAndProtocolPathMutuallyInclusiveRecordsWriteDataCidMismatchRecordsWriteDataSizeMismatchRecordsWriteGetEntryIdUndefinedAuthorRecordsWriteGetInitialWriteNotFoundRecordsWriteImmutablePropertyChangedRecordsWriteMissingDataInPreviousRecordsWriteMissingDataStreamRecordsWriteMissingEncodedDataInPreviousRecordsWriteMissingProtocolRecordsWriteMissingSchemaRecordsWriteMissingSignerRecordsWriteOwnerAndTenantMismatchRecordsWriteSignAsOwnerDelegateUnknownAuthorRecordsWriteSignAsOwnerUnknownAuthorRecordsWriteValidateIntegrityAttestationMismatchRecordsWriteValidateIntegrityContextIdMismatchRecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayloadRecordsWriteValidateIntegrityDateCreatedMismatchRecordsWriteValidateIntegrityEncryptionCidMismatchRecordsWriteValidateIntegrityRecordIdUnauthorizedSchemaValidationFailureSchemaValidatorSchemaNotFoundSecp256k1KeyNotValidTimestampInvalidUrlProtocolNotNormalizableUrlProtocolNotNormalizedUrlSchemaNotNormalizableUrlSchemaNotNormalized

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

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

EventsMessagesPermissionsProtocolsRecords

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

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

ConfigureCreateDeleteGetGrantQueryReadRequestRevokeSubscribeWrite

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

Enumeration EncryptionAlgorithm

Enumeration Members

Aes256Ctr +EciesSecp256k1 +

Enumeration Members

Aes256Ctr

Aes256Ctr: "A256CTR"

EciesSecp256k1

EciesSecp256k1: "ECIES-ES256K"

Settings

Member Visibility

Theme

On This Page

Aes256CtrEciesSecp256k1

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

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

DataFormatsProtocolContextProtocolPathSchemas

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

Enumeration SortDirection

Enumeration Members

Ascending +Descending +

Enumeration Members

Ascending

Ascending: 1

Descending

Descending: -1

Settings

Member Visibility

Theme

On This Page

AscendingDescending

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

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

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..ea8c9b6be --- /dev/null +++ b/hierarchy.html @@ -0,0 +1 @@ +DWN-SDK Documentation - v0.2.22

DWN-SDK Documentation - v0.2.22

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

DWN-SDK Documentation - v0.2.22

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

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

clearclosedeletegetopenput

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

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

appendclearclosedeleteEventsByCidgetEventsopenqueryEvents

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..cc6f3a2ac --- /dev/null +++ b/interfaces/EventStream.html @@ -0,0 +1,6 @@ +EventStream | DWN-SDK Documentation - v0.2.22

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(tenant, id, listener): Promise<EventSubscription>;
}

Implemented by

Methods

close +emit +open +subscribe +

Methods

close

emit

open

subscribe

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

  • Parameters

    • tenant: string
    • id: string
    • listener: EventListener

    Returns Promise<EventSubscription>

Settings

Member Visibility

Theme

On This Page

closeemitopensubscribe

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

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

clearclosedeletegetopenputquery

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

Interface MessageStoreOptions

interface MessageStoreOptions {
    signal?: AbortSignal;
}

Properties

signal? +

Properties

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

signal

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..e0c59d326 --- /dev/null +++ b/interfaces/MessageSubscription.html @@ -0,0 +1,3 @@ +MessageSubscription | DWN-SDK Documentation - v0.2.22

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

closeid

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

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

algorithmkeyIdsign

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

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

isActiveTenant

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

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..6062b9806 --- /dev/null +++ b/types/CreateFromOptions.html @@ -0,0 +1,4 @@ +CreateFromOptions | DWN-SDK Documentation - v0.2.22

Type alias CreateFromOptions

CreateFromOptions: {
    attestationSigners?: Signer[];
    data?: Uint8Array;
    dataFormat?: string;
    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 dataFormat?: string

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

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

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

    +

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

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..15ce230a5 --- /dev/null +++ b/types/DataStorePutResult.html @@ -0,0 +1,3 @@ +DataStorePutResult | DWN-SDK Documentation - v0.2.22

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

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..711616b2f --- /dev/null +++ b/types/DwnConfig.html @@ -0,0 +1,2 @@ +DwnConfig | DWN-SDK Documentation - v0.2.22

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

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

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..655c4171b --- /dev/null +++ b/types/EqualFilter.html @@ -0,0 +1 @@ +EqualFilter | DWN-SDK Documentation - v0.2.22

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..2258ce990 --- /dev/null +++ b/types/EventSubscriptionHandler.html @@ -0,0 +1 @@ +EventSubscriptionHandler | DWN-SDK Documentation - v0.2.22

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

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

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

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..73e662669 --- /dev/null +++ b/types/EventsQueryMessage.html @@ -0,0 +1 @@ +EventsQueryMessage | DWN-SDK Documentation - v0.2.22

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..15079ff76 --- /dev/null +++ b/types/EventsQueryOptions.html @@ -0,0 +1 @@ +EventsQueryOptions | DWN-SDK Documentation - v0.2.22

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

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

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

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..90cf602aa --- /dev/null +++ b/types/EventsSubscribeOptions.html @@ -0,0 +1 @@ +EventsSubscribeOptions | DWN-SDK Documentation - v0.2.22

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type alias PermissionScope

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

The data model for a permission scope.

+

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

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..567668fdc --- /dev/null +++ b/types/PermissionsGrantMessage.html @@ -0,0 +1 @@ +PermissionsGrantMessage | DWN-SDK Documentation - v0.2.22

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

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

    Expire time in UTC ISO-8601 format with microsecond precision.

    +
  • 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..16c02c5f8 --- /dev/null +++ b/types/PermissionsRequestDescriptor.html @@ -0,0 +1 @@ +PermissionsRequestDescriptor | DWN-SDK Documentation - v0.2.22

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

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

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

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

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

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

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

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

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

Type alias ProtocolRuleSet

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

Type declaration

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

    Encryption setting for objects that are in this protocol path.

    +
  • Optional $role?: boolean

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

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

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

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

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

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

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

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

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

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

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

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

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..942cd8948 --- /dev/null +++ b/types/QueryResultEntry.html @@ -0,0 +1,6 @@ +QueryResultEntry | DWN-SDK Documentation - v0.2.22

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..9467101de --- /dev/null +++ b/types/RangeCriterion.html @@ -0,0 +1,3 @@ +RangeCriterion | DWN-SDK Documentation - v0.2.22

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..91ee85a4e --- /dev/null +++ b/types/RangeFilter.html @@ -0,0 +1,2 @@ +RangeFilter | DWN-SDK Documentation - v0.2.22

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

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

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

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

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

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

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

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

Type alias RecordsReadOptions

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

Type declaration

  • Optional delegatedGrant?: DelegatedGrantMessage

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

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

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

    +
  • Optional signer?: Signer

Settings

Member Visibility

Theme

Generated using TypeDoc

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

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..331ee68da --- /dev/null +++ b/types/RecordsSubscribeDescriptor.html @@ -0,0 +1 @@ +RecordsSubscribeDescriptor | DWN-SDK Documentation - v0.2.22

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

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..124b15f22 --- /dev/null +++ b/types/RecordsSubscribeOptions.html @@ -0,0 +1,2 @@ +RecordsSubscribeOptions | DWN-SDK Documentation - v0.2.22

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

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

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

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

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 invoked to sign on behalf of the logical author, which is the grantor 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

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

    +

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

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

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