From cdc314031d2645305e825452c7f3139a4ee20081 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 16 Jul 2024 22:23:31 +0000 Subject: [PATCH] 2024-07-16T22:23:31+00:00 Signed-off-by: GitHub Actions --- .nojekyll | 1 + assets/highlight.css | 22 + assets/icons.js | 18 + assets/icons.svg | 1 + assets/main.js | 60 + assets/navigation.js | 1 + assets/search.js | 1 + assets/style.css | 1448 +++++++++++++++++++++ classes/AllowAllTenantGate.html | 5 + classes/Cid.html | 17 + classes/DataStoreLevel.html | 27 + classes/DataStream.html | 13 + classes/Dwn.html | 16 + classes/DwnConstant.html | 6 + classes/DwnError.html | 4 + classes/Encoder.html | 11 + classes/Encryption.html | 17 + classes/EventEmitterStream.html | 7 + classes/EventLogLevel.html | 28 + classes/HdKey.html | 14 + classes/Jws.html | 18 + classes/Message.html | 46 + classes/MessageStoreLevel.html | 26 + classes/MessagesQuery.html | 17 + classes/MessagesRead.html | 17 + classes/MessagesSubscribe.html | 19 + classes/PermissionGrant.html | 23 + classes/PermissionRequest.html | 16 + classes/PermissionsProtocol.html | 32 + classes/Poller.html | 12 + classes/PrivateKeySigner.html | 17 + classes/Protocols.html | 7 + classes/ProtocolsConfigure.html | 17 + classes/ProtocolsQuery.html | 19 + classes/Records.html | 54 + classes/RecordsDelete.html | 21 + classes/RecordsQuery.html | 21 + classes/RecordsRead.html | 22 + classes/RecordsSubscribe.html | 21 + classes/RecordsWrite.html | 87 ++ classes/ResumableTaskStoreLevel.html | 41 + classes/Secp256k1.html | 27 + classes/Secp256r1.html | 20 + classes/TestDataGenerator.html | 59 + classes/Time.html | 24 + enums/DateSort.html | 5 + enums/DwnErrorCode.html | 149 +++ enums/DwnInterfaceName.html | 4 + enums/DwnMethodName.html | 7 + enums/EncryptionAlgorithm.html | 3 + enums/KeyDerivationScheme.html | 7 + enums/PermissionConditionPublication.html | 3 + enums/SortDirection.html | 3 + functions/authenticate.html | 3 + functions/executeUnlessAborted.html | 2 + hierarchy.html | 1 + index.html | 139 ++ interfaces/DataStore.html | 21 + interfaces/EventLog.html | 25 + interfaces/EventStream.html | 6 + interfaces/EventSubscription.html | 3 + interfaces/MessageStore.html | 18 + interfaces/MessageStoreOptions.html | 2 + interfaces/MessageSubscription.html | 3 + interfaces/ResumableTaskStore.html | 57 + interfaces/Signer.html | 16 + interfaces/TenantGate.html | 4 + types/ActiveTenantCheckResult.html | 4 + types/CreateFromOptions.html | 4 + types/DataEncodedRecordsWriteMessage.html | 3 + types/DataStoreGetResult.html | 3 + types/DataStorePutResult.html | 3 + types/DerivedPrivateJwk.html | 1 + types/DwnConfig.html | 2 + types/EncryptionInput.html | 7 + types/EncryptionProperty.html | 1 + types/EqualFilter.html | 1 + types/EventListener.html | 1 + types/Filter.html | 1 + types/GenericMessage.html | 2 + types/GenericMessageReply.html | 1 + types/KeyEncryptionInput.html | 7 + types/KeyMaterial.html | 2 + types/ManagedResumableTask.html | 6 + types/MessageEvent.html | 3 + types/MessageSort.html | 1 + types/MessageSubscriptionHandler.html | 1 + types/MessagesFilter.html | 2 + types/MessagesPermissionScope.html | 1 + types/MessagesQueryMessage.html | 1 + types/MessagesQueryOptions.html | 1 + types/MessagesQueryReply.html | 1 + types/MessagesReadMessage.html | 1 + types/MessagesReadOptions.html | 1 + types/MessagesReadReply.html | 1 + types/MessagesReadReplyEntry.html | 1 + types/MessagesSubscribeDescriptor.html | 1 + types/MessagesSubscribeMessage.html | 1 + types/MessagesSubscribeOptions.html | 1 + types/MessagesSubscribeReply.html | 1 + types/OneOfFilter.html | 1 + types/Pagination.html | 3 + types/PaginationCursor.html | 1 + types/PermissionConditions.html | 4 + types/PermissionGrantData.html | 7 + types/PermissionRequestData.html | 5 + types/PermissionRevocationData.html | 3 + types/PermissionScope.html | 2 + types/Persona.html | 2 + types/PrivateJwk.html | 4 + types/ProtocolDefinition.html | 2 + types/ProtocolPermissionScope.html | 1 + types/ProtocolRuleSet.html | 8 + types/ProtocolTypes.html | 1 + types/ProtocolsConfigureDescriptor.html | 1 + types/ProtocolsConfigureMessage.html | 1 + types/ProtocolsConfigureOptions.html | 1 + types/ProtocolsQueryFilter.html | 1 + types/ProtocolsQueryMessage.html | 1 + types/ProtocolsQueryOptions.html | 1 + types/ProtocolsQueryReply.html | 1 + types/PublicJwk.html | 8 + types/QueryOptions.html | 1 + types/QueryResultEntry.html | 6 + types/RangeCriterion.html | 3 + types/RangeFilter.html | 2 + types/RecordSubscriptionHandler.html | 1 + types/RecordsDeleteMessage.html | 1 + types/RecordsDeleteOptions.html | 3 + types/RecordsPermissionScope.html | 4 + types/RecordsQueryMessage.html | 1 + types/RecordsQueryOptions.html | 2 + types/RecordsQueryReply.html | 1 + types/RecordsQueryReplyEntry.html | 9 + types/RecordsReadMessage.html | 1 + types/RecordsReadOptions.html | 4 + types/RecordsReadReply.html | 1 + types/RecordsSubscribeDescriptor.html | 1 + types/RecordsSubscribeMessage.html | 1 + types/RecordsSubscribeOptions.html | 2 + types/RecordsSubscribeReply.html | 1 + types/RecordsWriteDescriptor.html | 1 + types/RecordsWriteMessage.html | 1 + types/RecordsWriteOptions.html | 5 + types/RecordsWriteTagValue.html | 1 + types/RecordsWriteTags.html | 1 + types/SubscriptionReply.html | 1 + types/UnionMessageReply.html | 12 + 148 files changed, 3075 insertions(+) create mode 100644 .nojekyll create mode 100644 assets/highlight.css create mode 100644 assets/icons.js create mode 100644 assets/icons.svg create mode 100644 assets/main.js create mode 100644 assets/navigation.js create mode 100644 assets/search.js create mode 100644 assets/style.css create mode 100644 classes/AllowAllTenantGate.html create mode 100644 classes/Cid.html create mode 100644 classes/DataStoreLevel.html create mode 100644 classes/DataStream.html create mode 100644 classes/Dwn.html create mode 100644 classes/DwnConstant.html create mode 100644 classes/DwnError.html create mode 100644 classes/Encoder.html create mode 100644 classes/Encryption.html create mode 100644 classes/EventEmitterStream.html create mode 100644 classes/EventLogLevel.html create mode 100644 classes/HdKey.html create mode 100644 classes/Jws.html create mode 100644 classes/Message.html create mode 100644 classes/MessageStoreLevel.html create mode 100644 classes/MessagesQuery.html create mode 100644 classes/MessagesRead.html create mode 100644 classes/MessagesSubscribe.html create mode 100644 classes/PermissionGrant.html create mode 100644 classes/PermissionRequest.html create mode 100644 classes/PermissionsProtocol.html create mode 100644 classes/Poller.html create mode 100644 classes/PrivateKeySigner.html create mode 100644 classes/Protocols.html create mode 100644 classes/ProtocolsConfigure.html create mode 100644 classes/ProtocolsQuery.html create mode 100644 classes/Records.html create mode 100644 classes/RecordsDelete.html create mode 100644 classes/RecordsQuery.html create mode 100644 classes/RecordsRead.html create mode 100644 classes/RecordsSubscribe.html create mode 100644 classes/RecordsWrite.html create mode 100644 classes/ResumableTaskStoreLevel.html create mode 100644 classes/Secp256k1.html create mode 100644 classes/Secp256r1.html create mode 100644 classes/TestDataGenerator.html create mode 100644 classes/Time.html create mode 100644 enums/DateSort.html create mode 100644 enums/DwnErrorCode.html create mode 100644 enums/DwnInterfaceName.html create mode 100644 enums/DwnMethodName.html create mode 100644 enums/EncryptionAlgorithm.html create mode 100644 enums/KeyDerivationScheme.html create mode 100644 enums/PermissionConditionPublication.html create mode 100644 enums/SortDirection.html create mode 100644 functions/authenticate.html create mode 100644 functions/executeUnlessAborted.html create mode 100644 hierarchy.html create mode 100644 index.html create mode 100644 interfaces/DataStore.html create mode 100644 interfaces/EventLog.html create mode 100644 interfaces/EventStream.html create mode 100644 interfaces/EventSubscription.html create mode 100644 interfaces/MessageStore.html create mode 100644 interfaces/MessageStoreOptions.html create mode 100644 interfaces/MessageSubscription.html create mode 100644 interfaces/ResumableTaskStore.html create mode 100644 interfaces/Signer.html create mode 100644 interfaces/TenantGate.html create mode 100644 types/ActiveTenantCheckResult.html create mode 100644 types/CreateFromOptions.html create mode 100644 types/DataEncodedRecordsWriteMessage.html create mode 100644 types/DataStoreGetResult.html create mode 100644 types/DataStorePutResult.html create mode 100644 types/DerivedPrivateJwk.html create mode 100644 types/DwnConfig.html create mode 100644 types/EncryptionInput.html create mode 100644 types/EncryptionProperty.html create mode 100644 types/EqualFilter.html create mode 100644 types/EventListener.html create mode 100644 types/Filter.html create mode 100644 types/GenericMessage.html create mode 100644 types/GenericMessageReply.html create mode 100644 types/KeyEncryptionInput.html create mode 100644 types/KeyMaterial.html create mode 100644 types/ManagedResumableTask.html create mode 100644 types/MessageEvent.html create mode 100644 types/MessageSort.html create mode 100644 types/MessageSubscriptionHandler.html create mode 100644 types/MessagesFilter.html create mode 100644 types/MessagesPermissionScope.html create mode 100644 types/MessagesQueryMessage.html create mode 100644 types/MessagesQueryOptions.html create mode 100644 types/MessagesQueryReply.html create mode 100644 types/MessagesReadMessage.html create mode 100644 types/MessagesReadOptions.html create mode 100644 types/MessagesReadReply.html create mode 100644 types/MessagesReadReplyEntry.html create mode 100644 types/MessagesSubscribeDescriptor.html create mode 100644 types/MessagesSubscribeMessage.html create mode 100644 types/MessagesSubscribeOptions.html create mode 100644 types/MessagesSubscribeReply.html create mode 100644 types/OneOfFilter.html create mode 100644 types/Pagination.html create mode 100644 types/PaginationCursor.html create mode 100644 types/PermissionConditions.html create mode 100644 types/PermissionGrantData.html create mode 100644 types/PermissionRequestData.html create mode 100644 types/PermissionRevocationData.html create mode 100644 types/PermissionScope.html create mode 100644 types/Persona.html create mode 100644 types/PrivateJwk.html create mode 100644 types/ProtocolDefinition.html create mode 100644 types/ProtocolPermissionScope.html create mode 100644 types/ProtocolRuleSet.html create mode 100644 types/ProtocolTypes.html create mode 100644 types/ProtocolsConfigureDescriptor.html create mode 100644 types/ProtocolsConfigureMessage.html create mode 100644 types/ProtocolsConfigureOptions.html create mode 100644 types/ProtocolsQueryFilter.html create mode 100644 types/ProtocolsQueryMessage.html create mode 100644 types/ProtocolsQueryOptions.html create mode 100644 types/ProtocolsQueryReply.html create mode 100644 types/PublicJwk.html create mode 100644 types/QueryOptions.html create mode 100644 types/QueryResultEntry.html create mode 100644 types/RangeCriterion.html create mode 100644 types/RangeFilter.html create mode 100644 types/RecordSubscriptionHandler.html create mode 100644 types/RecordsDeleteMessage.html create mode 100644 types/RecordsDeleteOptions.html create mode 100644 types/RecordsPermissionScope.html create mode 100644 types/RecordsQueryMessage.html create mode 100644 types/RecordsQueryOptions.html create mode 100644 types/RecordsQueryReply.html create mode 100644 types/RecordsQueryReplyEntry.html create mode 100644 types/RecordsReadMessage.html create mode 100644 types/RecordsReadOptions.html create mode 100644 types/RecordsReadReply.html create mode 100644 types/RecordsSubscribeDescriptor.html create mode 100644 types/RecordsSubscribeMessage.html create mode 100644 types/RecordsSubscribeOptions.html create mode 100644 types/RecordsSubscribeReply.html create mode 100644 types/RecordsWriteDescriptor.html create mode 100644 types/RecordsWriteMessage.html create mode 100644 types/RecordsWriteOptions.html create mode 100644 types/RecordsWriteTagValue.html create mode 100644 types/RecordsWriteTags.html create mode 100644 types/SubscriptionReply.html create mode 100644 types/UnionMessageReply.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 000000000..5674cf392 --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,22 @@ +:root { + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --code-background: var(--dark-code-background); +} + +pre, code { background: var(--code-background); } diff --git a/assets/icons.js b/assets/icons.js new file mode 100644 index 000000000..e88e8ca77 --- /dev/null +++ b/assets/icons.js @@ -0,0 +1,18 @@ +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `""`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/assets/icons.svg b/assets/icons.svg new file mode 100644 index 000000000..e371b8b5d --- /dev/null +++ b/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 000000000..35728810f --- /dev/null +++ b/assets/main.js @@ -0,0 +1,60 @@ +"use strict"; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; +"use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Be(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/assets/navigation.js b/assets/navigation.js new file mode 100644 index 000000000..5958bcf4b --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WaTXPbNhCG/4vOnrr21G7rm0dynNhxrUpOe8jkAJMrCWMIUADQiqaT/94hRUkgsFgAV73vPiCWWHxRX/8bWfhhRzejCbMwV9qOzkYbZlejmxHIZm3OD7//srJrMTobvXFZj27++Hl2itzKO62VHqsagmhHIwmfpAW9YBX8xdYYZaCTpCewK1VHMCcxzriTld5tLFfyViyV5na19kmIJc57hN0ENH9nrX9erSB8MsQS501Br7kxXMmxkjVvQ6bNq+BVF+2jaXe8lfadT7iGCoMOxDjjVgi1vRXiBSST9p5Zp+OVYMaAOQ89Q97FpUsc8zpEjHlNxUyYZXOrNHyGdxBh+FBPkzSwdYzSaiRhK5HQrUzEjJU0lkmLxh7EBKOrQxTQKVT0naxUDUhwLyRi+1JBw3uNJLyDtHdrbi3oWPZDT5L4WS0jA2IgU5yP9SPswvjuZyruYWvCqIetoWKewBi2RAqoFzJiqSIILBk883cDGun/QM7hzIAhZe2qOZR582oqzV/jOTpZKN5pxrzXaM15hjzWDL43YEhab8njmalWVlUKeZeIiWQqIbDi3v9ORnZLFjzCbs6XEmV4Dpq2f1akNo5SVvxYyQVfNhoZCKEnixgZ6EOdIs2gUrpGetYLGbETEIAtoAM5gxPpi6tmUPCSdcQMBlGwviOD9q/mRHo6laaYZs1eBbww80bNlBEjxZ5Dtbm8un67CGlHKSNex+M1Gf8Cxrb7k3uQoJnFtgGBheTxNZLp9tesfdgplB929c4ubIi4vLpGFm6UcBCTAH8T4TOwDQSG2Q9Ob28TwBwXhXQXYJTmGnJBz12zJsnrfTnYVKcRH4UNqwmlhjYK6q9GDghbhobB2GHFAcTOKUPIbWX5O+y94xVUb20HhLP6292mPfzgNo/865+/X1xduqcgDczCB63WwQvecwNDithW334zX7sTZrDp3ONpd05b3Su8B4unJXRkM6dNinl0JJntiRzqfgvzsH0LkL4hSewOawu+DEgHIUU4nZg+yU0TdNKT82lTrTag7S4OPDiSzO8NEx+4sG4B9rCTlKR0czk3FiTCccUUCX+UvKfoFkNeRapgqJaxZrARQbIRS4r6CLvEkAgdGcwnZkFzJhDYQUpRnphky3Z+cCZuH4d5ktx9droxEPAcLZMzvPIcYMJbzzjFWe0+MlmLcMTFnZltGHwkD9Vc1umIOK/UJhjaEVsuvTtERKoG8xRxI0se5inioiUZOnKZ7RkokQLHUkJNJMCxlFDJ7h8NxcQ7aXUa27ly2cdD4QT2paSiRYFYi1tJvETfV8xPvE7fV8wnX+zQlWI/S3he4NOQI6UoU7bk0vtWsYeclHzGuNEmHAC+nuSFX0mCN4J58rndVWG7CY1jj5Z8an9lSHMdUwn5Xe2/EaXgri+fj647hevNFLRREnu49udkdHRjn7+jP9wATmDBJUfHdODIZaZyhdty6bNGwByCvY8n59Je2uAYqxNzSaeb2fj0TnnL24lM8FFjeQuRKT5qzG6h25bgEzLmKeOm8lKygxsGpfJRsocbBqGLHWJJUrtP5NjUcBBSBKqjJf3rn7m9sED3Ur6e4s2YXMK4va7RyGw1VLNY+PBzpCSlu0LKOEJFjXkt9J9IIsMa8xRxI+8a82RyEwsA7spkUxWOWEqodCJKxr4bglZ2YCgmojWFuzLZxMEvdBQw6bQWnPqcCCqp2Wc+/1tdfN2OO0vboBNceibzw+hUl57I/DAq6WXnMffyPZl1z1XCprNdcvfvhtBZdi0l1Be2/IeJhnzYg6eQSz5qq6d47tKFjoLAkCJ+kVxJ6k45MKSIrLErkLb9f6CTw0Uju//6mXNXH7Kuf3Mw8AOqxsIXKcCY21elLdQYDvMF2G//A6ajbiunKgAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 000000000..1dcc194b1 --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8S9W5PbyJH3/V2kvZTbjTrDd7I09o5n5/CMZrzxxsSGgyKhFi022UOCOtix3/0NVAFkVeJfQAKEnudqNM2qzASQdfxlZf372fHw6fTsT7/9+9mH7X7z7E/ivrSFFi+e7VeP1bM/PXv9af/qsH+3fXj24tn5uHv2p2f1l6fq9MfL3+/e14+7Zy+erXer06k6PfvTs2f/+6KTZrSW5iLrH/9o6g4Ken4pE8l78expdaz2dWLOVUlxL9RFx2a7+bk6HXYfqyNH0V1afkTpXWtdRndd7Vf7+q+rmvWMd0nx2zRXH6t9/aY+VqtHluq0/G26H6vTafVQvakPR95zkwq3ad+s6hVfdVx6gTf+X4fhZpG87lD4Nq3H6nR+XL3dVb+sTh/4jw2rTbZE6GtT/oY+/nZfV8d3q3V1+mP322DPIO6Vu0g7PFX7UUnP21LY7otBGRXr3eFUjevois1Tsnp6qvabcS2XcvPUPFS1L3Ia1xQXnafs93N1/MJVlxaep3BT7aq6CkL+/OXVlvE+UZW5blKtjhw3CcUmKEmH1VBke6qrfW+gSn67dXjtCxsbYlPTBpo/GW/oywo/8zuB0/ntaX3cvs230kji87j0wHO0NmZUVo/bmqWtLThb0WAHFysa7+OGFQ13c7EmRk/XV9VzgfAVnurtYeD5okKD7pAMdQPtvifw+ViLT+zMKBx5dT2dnBeI1Q42W6biO04rTuoGe/Nd0vdhWuYrkk4k/unWDqkna6w/SuwanoMyVd1di4+rHJmRbffberva/fdx25v1Z9WTOnNsoB8v/tI/V0+7L8SW3u8j/XIq/a/NULBdfw/fcvrjre4BpI05CLEut1Cowgs40OE2r/EuqcNRPuIsq3P9/nDc/muV9JejZtBq8ywZ/qjIaUCJZT/vVeS0bxyMzbzkU72qz6dpeu8uldjqx19wW/rN4ZjpT5tfFupOL6KYvak3Kr+krl4dq1VdbXjK7tIao4rHl/TVT+e3u+3p/SQL4jq32tCOEL9sH6tTvXp8YpoBqs2wJJ5mdQVHJlqg2K1TrZzIockWsnbqdCurd3jCNayaO+UaVj426UK1x6ZdP60etns0IFx/uLWPIJLGuojIoty3Ox9PvXEUa7m7lB1TNtIid9t4sTaosis6XSP9OP+n2c/4uTqdd/U3+/pIB0j686RJVessp79sd3VvDyD9caFBIpbGHCc667Kz37blsBXexVU4qkc76vr9ITNKIPWX8gvofjoe6sP6sONrj2os8uycQQq/hWnjVNaenFP/XK02eLkASsxqNk19NGnt/X6bdNTscaGlGimQym2sxOpht4l3VrkW3CV1pxjDc+XZBi1rTYOJppvS1rrNjpxD+qFmuEXFRWY5fTuc5dvUtcAs+W+6PdvXubX4QMmlmldONLeNoYeYOTqOmDJhqESSbhg3xwxjDqJzrGKNaOP2TRzeplv6zg+IdJuBa+C19gJ2jTa34W6DFlu8oU3Zy8vaPmNHjWMIc28tK2pkHGH3czN3H/l2jTrJUL+fFprT98dL4v9c7Te73IoHFFxqiywjmbtjBp4g/9hwUbfMYm7CIq63eOth6N/Pqx20Nfpl0vf+cV/9+A5KjH6ZJPHn1f6hghKjX6ZLfNXQl2O/10h/vPVjAWljH41Ylxt/jgca6pXXddeW5igci3E78LX6svN05nfJXg3vPYWfl9sxi+Tx981aG6euv4a0clZevfrDn/Ljanee8uB3XYW52uHu2o++R6UTqfinWz9mT9bYh0zsylGmw7H+6Xh4qo413BUE+u5InXHlIx+wkfd6e6zWYPIzaERc6WYr0MZsVvvw1uwErXALOqt2ZBN6WG+vL2o38U4hUPJ8zK9nh4re3EeNyR7tr4aeY+KSlmsMY007KGrGopZt2siq9ia7Bpe1EyxkrmtvsHVTvfPxKX0exbUykbCEfbkG+HrM1GuBpRobkchtYpGl01jCsN5xngDqjzCNDHgfM2SUvU+2xOudZkVXZSELTvXxvK7PvSD7ESviavMtudkpr3a0wv9QTDcoepjx9vjLwBfzvy3VCq/CuA0wmDb+CD+fd9WbqseZ01+XeoxYHPdBOgMzLvsf1X59/PI00CcCpXf/SGqxDBhpOv+xWqNp/aAR1yqLWHA87Ca8+Lt/tOUX0X3a/muS7rb8TN23uVzQzu8jUjPuwrPmJj7bSW6YGHIXKk83Zmwytvp8g02+8uI2/Ue9epjUVtry/48cptHevRMx+X1427Ottvr9vD1Wm19mvJCLSXf/IGKmGzjav+12h0+/7v1c92ZrobAlbM4uXf2KF26qoiKLLVWpTPYSNbZ33gw6p5s/h04kzNglwBguW27SlnZq44im2YECqQREjECJSRper+rVN/v1YVNtfq7Wh+Pm5E9J4AcaLjxJ7zeXCVBmU69f4OaTeVji6PG8vqU5Nrp7OBy39XvKCYYV38XVuCbwDsm0lPXv1bq/UzZiVEbCQvZ9qL58k5s3jxhGq863qEepgku/9mdbcQNARaaRsCBgoNMAJWZrQB1G7/fbpKNwPVxojp58VGO/wM3kEEscpYd9S2eETgwrZwZNACEzwyVGzGEESnBsGfjoA547L860rTweEZcvuJCDzY2HG3iCieyAZwiDHAwImsENmGaNUIMbbBpkBmzrmMRgtp3vYGQGz7pL3dttGmtgg932pBC4MU0DfcUNcVRBwngYVbbcMt3F3CCqvPmjL9bP6cf6R1Joob4RSWX2i9TqeX3igAH8/pAKmd8XDpnD6wen2ZJZ0jOsGV3U32TPT6v6/Xyb2toL2nWs1tunbT9vA8OouOqCFp3W76tHeoaCYc6l3oK2gL1VhiWDO6zzvMfX/nZG24pqLmhPc16lH4TGMOdacWFr3vSxCdOcN0MAZa49mVPwPJNGD8TP7J05s8LhfnrajHCij2fCBzhOPhpCMPs75rIJML/keGKB2R7/l8PxcTWj207q3mbT0LQLcA3685JTrYu8KZOsX1KcNPI4fwdBr6jInCXAwFb11P3piS9uxg5RYuz8LaKc+ml7RImU0bnO4bgZHEWROVG1pSxZH/Z19Xl4QEemxPWWsmVs6yxrDH/vbII1q7puBpc5XpPUXMqebFDMmDmMuBiWNSZtU9W+3q7jNMHvzvsQ/PLH+OdJfdDLdb39WP3icwq/el+tP4S8FOSBM6Vu7YuGxI71RznDcyvmU1xhuh13PQGTzBpth/VqS9erHKsuFW+1RlyTQb5swgpe7na/9PNSt1r+2C8y6Aq6EHH3F4IDoz5nROzztE7mUftWx14fJbvMuMKYEVwHGLQjStEEXm+UUYj5ZjkPlpfKfSb4LLHLxOvB7j2+2m74pq8Pj0/nuhqS8zwpgw1tfstoeFodT8PyoxKTpbe2vV49/PT21Xbzl+Ph8c9f6iisNfc0qMYS2kmWXY76kcTuqX5uk44UjrfhVEXsYDGM7emIf+S7nP/c47Ked+UGx/FgWO7z+CU9Q9Wl4Hxd3fy5auj+A08tqjPNAiMKlc/KkteM0rDUp80ftqc/bPfvq2ZytJmu/7R9iNNj59VfCi6pPbxN9mv/Cs++agLvf1p92R1W/e4OvwVS5TaLYn+sD3978+MPDCsuBW/UnY/0wEdGQYmFltiTD5AiY2/a0MsebJy6mzfhhOUQ2M3awyO6E6xo9t9ABtUxO6JqS1nylEvUOGZLUnEpa0jXyLMEdJM3vpMuGrl/1mL0raRVF/OXduTb/PXYXx6Oeg2tfINV8Qrhde+Smmgqf/mRP+PJXSeQihq+TOBqU26yk0vQSrQMp2UdVfN0hgscoiSUmqnioeKoCKVmqgg3kDC0XArO/iqZC0p6X2XohhKsph+K7cv8dK7hXlK/wK3jbUbi6KVgfUunQcZhveOAEdQfxSyXOn+tRl7vpcBirzeVyH69V0tnvl6od8LrvdZnsGR4GxrDkpFb0Ri2xF3/z/kbu6LG2y91+2CQkTk8KgBzpw4POb3D4wRf8bF6aC4ngp1gTndU51b1D8fV2ymq2/K3P3W0BGQ98WqIL3HVVp/rzI1mOcWXGreqzg+pOdUjY+sU384MsnnfHhptRxSThHmr/eqhOdAU1SG9GCpy69iQlTmaHg/Zm2M3vYSjI1rvhvIMo7pjkWD8d3mNA/N1lrNh+1gdzr0bQUbNuFRbzJJjVR+/vDqc+9c9jRmT1LzJnmhn+HV/0O42ma4/8YfF+oD37Yms59dyQwP+0J1r9eHHt/+s1n0A1Vd1KThX17ssj6DK3o1yCJ425rMlRefq25yfdp58833hOa4zwQIuAKGKORwEKkxcPt3cqvbnR69p/G6g4tqht5GGL0/rar/Z7h+GxD0HhbO2964J6ulsAsv4SpPSc7ReIvF4zwqL36SX+by4PFtzb61YHbcfq81Px+3HVV397RMdxHq/37xShAJHF4o9M3Mjz+FQf1d96UVODaq9i2sxDRjdLPQlt4f9mybufNJbuAOVl7YKnDPg2jR4yGCWRZfy31X0eBPDKFJ7vl3RjOE/N7EpXT/t/8qfJwTrwKP15T0HZfGDBMuGNTZdxJqnMCo6X9/Fajx/GHjM4WkEQ/d31ZdfT9v9w39+2LwbV0xK87RyR/FIG2cAp2quT/Zd9eV1rvsIQwIowR3RX1/Cu09Moc/TKvhpkM14vGvhzKsQqsq1oV9tITuSjpBpxGAPyLbA/7Zif4Vr8Vl64+XQp31/CvppOJElJ1ilkzEWo9Lo5+w49uQOU6e81HRDsW/uMGbKy306HtbV6UTj8nsKeuUma/q42m0b8JyJR7xo6pWbrak19tt9XT0ct3V/LOnpBDU42olnvmq6zswzdr8N93UkI9vrlgH4oMtq88vhz1Wb2WdUxfOx6tnnuzzFjMUgNYK1GoQqyav95njE+vwPi0TnJsK4lge7skchNrBlJWo2g42Kyu+/lFexknbVFf3EHVtfRhH2f/t0+n57OoHlHBX8PFtt+Im80aN2XM9nvdpuvt+eHlf1mg54wyblJCxg3faw//5wrH55v9r/uK/edEFmPxzqN+enp8MxPiHJMJUn7ha7L8eOwv/8cKh//BQHywwZma+7iEU/HGofW9L0US/T+EKWVbD+XMteXeKwmzLrSR90uO7tFn1/3tXb96vT+5lW5erPteybjdC6KL/d+4E03oLJ2YJqzNb+sdrX3zxu67o6hv3ExjGfKjJaZE0Zqz7Xru6CKO+TiaN2XVCzmidJHHJWThR2q82XZCyJqr+stjuGozGFLGaj/4Lh0/263z4+7arHas9pEVMkzbX2r9W+Oq52f/t0+nt13L7bVse/VvVl0+KHQ/2Xw3k/bipbzHJ2to3zMgjNsBGImG1fz/H9X775/NSksh23baz6wnZxZ06j1Re26+fq4+HD/Pd1rb6cXd92IQTsuR1PxnIWfu/T99xgXk/AcrZdJz1/ORzJ4ppvIJbyNaxkT+2YQhZuHz8c6v+vqsN5wbmNhMiYa6HfXn2dQIu2Px01bLDqXHu6fv3LpTv/dX/qZo+vjh9HrWIImGvbt/tN9bl9xHDDmk9U8UtM73JmDdddzqI36FY0vlFvOBekTbMrFvnt/vvq8XCcZllGwE22tUOf/3cTHDPtlQ3UvsHvX1fNDs1Pu9V2H+I42kNk3PbIEnHrfLhJttp5DMOmbLUl7Lhl2ZCvf6Nlf63q6e+HVrr17fiDMbe8ngEBS3y5todeH56qGd8N1Z5r1U/tSfXp+y9DNW+1Zt7ey1jt2VZVx8emxzvsTxe+6NFVO1sPmVWbz9F2jOwNh1skL/40P1e/n6vT13keluwFn+ivVe2VtL3KLQ+QF7WgvX9v4Vigt7/uq89P1brubpWYY/aoxK9i/eGpetUll/rpeHi/fductm7nB9uKUuyJT8KQ/rWeqvsje306Q+DXsp20tF9W4zsms0R+BfubrZBAbCJVS3yDMcGzn+USs/TGH3X+de9jzw+vq815Xb3sXYiSNZ0t5+tYmgZHzrNyJFRyhoXXhez5yNg6YAiYb1vwmpTYrdsdlDYKgGEgT8pXsLK5vuvE3hmfIGhRW7/drw/H5qrw1/1UpZNsxYK+jq2vemkZ55n6ajRN462WDkS3TTWWFfQ2097X3QmLJlXDz71U45MMzspa+A2HrZs0CfnEN5uK+Br2sbbuGAIWte37Zgje7h/aD3Q4bm7rpgblLWz55yYGjLthxZOxrIXb/e0WUhkLW+hnljf2oUDK17CSXtY8x8arjEUt/MnX31Wn04K9/bjQRZ+hmQMliX0mGRvV/gpvtutDXnXBi82n9L3Lq/er6NLhGe93XPSyz9P+8bZeFkhZ1MrmS3Yt5rYZQEbSotY2KeEXmAMgMbfaeb3m9TIVetmE3n67n9qbcSR9BWub77eIsVTQcrZeQnL+xe+7crUXtyos29oW8OO7+Qb2BX0lW398N2NNzZP1lSwOF6L+97Z+fzjXr9JzMDMNxyK/kv2/PjWbZIvaj0Uubv+lS//xXdA7324kanl7Q/cTxvdJ6zGWqMXt/WX1MHFEGxSxnH3t0q46NdOl19VT/f6bz+uq2szqMgaFLWjzYVe9Pvjts28+b0/1y/qv24/VftIEnSvtZqs9E/91f0nxPOG9oqpz7WkZYpgnvU7yZb7cb77d+Eev9hMiHedI/ArWTzl4wxbzFey8hgfuN/5oyiXSbAnzWdK/wlM1s4LXOHXrjKeA0m60+nXlr4L54dBtaH13ufm9iSjlrNymSLrZ2ma6MicGhyHgRtt8dxSmIH/x6aIv2VKaWDvu5thEYUvY7CNcFjJ5XNaNFvcDd18d9put3yzwZyq6fYOW43OtnyH3/8qTNDEurGMSc6Uu/hShiXWjdAf2J3XhU4Uu/gwhB/bxcrpo4afhil/8udJol9sfJCvv61g+OV5msriva3czaV7YdiLy5vE1TZHz6/7NtOAIvpwbLe12Afbr6lQfjmkCkurhkbORO0nUjfb6WeeSC4spApe3fcayYlTK8lYut6iYK3z5Z5q/pOAKu9Fmki2J5gWajGJni13oOZoeNqONHQE8S+QSc/swFb+AqTDrmxA5O03WjRY3xxB+rurzcV+FcPsnBqUdrruARTesNpc/D9PFut98gH6CoKVsXcgXJ8i71fKQ9SzTUpkb1tNk3Wixv6735fWy4Us+LJSahmv6VKFf6xnmZROaK/VrPUV34iOcIWQfkZwtdpHnmN8FDtRfwrKwRda1ovTyMI5luP5yljWBwS/3m+Y//gxZfV7tdl+++bzenU+cc+pzJC5r/atmZbTpMtF1+r7d3/YE41KXe4pLEMx+k6yaF3iUCaKXeJ7uo8/p+/p1l7LIf8G5JpHKS9j016r+Zl8fv3y7+XW/qd5t99WGmbiCK2UhK3+oPlWn2v/fxJDkCYIWsvXb/bbernb+f+eamZGxhIXfPj6e6zhrwKv3q/3DxGFqQMgSNs4fpb7G+NTKbNrgt/ufjtXH7eHMnoMPSljQujbb6e1G5gQt/CbJ5R4T3+LYNR9zrJq6RZGpu6T/T1o3wZpLWON3w17uNyFl0qzxKytiCfuaxv4y3bP7df9hf/i0nzGYMYQtbPMitn4NG7uzupeVU7SamuUFTIFfxfbZKI8v7uva/cOh/nYfxrU3uZvhb3uUYQ1f5emaq2/aq4GW+S5Y4FexvY3YaeIGZi402CK/iv3hx2bSPiGkcI7EudaHQazVcji+3ITgjNWum3ROiEqfJmshi5v9G87uYbbaQnaE/2WvRcZqL2TVr/vq42p3Xl1TiNzwQceEzba5Wj8JbT4UIQHt31lhXplKN9pwnGMDrTTXhl+2j81I/fjEDXUDFebq/vW4i063/dAkD9ixOquBisva0qyEZ1rTVr3Bnkv7nPZmcLVJdiQ3NFyy0/6w6l2ERH/2RqTaBnO2ccQ9jwpnnyI1cjjenqU0Ln2L1nZcZem8lp2sMfliIWEv/lzX37jf6nIMYlTY87ho9hEi66A+D9rHdXXFZuv5uUITbKrm56Hbthla/IRqXE1XbLae1+md2llFr4dv0mZousDncWVx0Yn6oqtzwsZV/7Kb9u+DfpzcrfR2daqM+vW4+yVzg3As8TkojZ+hs29ca+bG3ZzakVt3x/Q2Rv9y+HMnb0Rtv/QtWt/UxziB/JDKS9Fb9LHeLCk6S9/B12Y5EC06S9/Jvx32Z0TFb9M7/py0KFcf91KrRBnnTqu+qrg76d2b0VPYK8HvYp6awx9Mgc+7wvgp+nZmdGauA8woHbkccFCrEYWKLnfL3LuXUfwIrt+rT5s/bE9/2O7fV8f2SMkcS04pTxox5NRnSAvZsUq3ekfsWPX3dBd8H3AfkfFmsruDs22LfbU+/O3Njz9w7bmUXsKK9OLtXtkf/fbctasL9x/nig32CIxruAfljt3GnbU96vDiO/xI8+BbcAeaCseQkUun257gspMwxzIgY1Eb3/nIyknu0Jl2rbqoRU+XpKs+Sr13xTrLNiTkZivTuXq70Y2G8fYn/nC6qk5Cm1f1sa08JvQ5qJCdI3SGjuluT/XydV8rzNVdrbfV6bLbyH34XK1lrOC+hlytKVakw9n29M1TEyl8XO2+q740NwEeq9MJXCBLTRmoOMGaCfPURDtzqtpXiJpTLsMxKMHd2HnZ+StT5PO4wtjjXO2Fur9JnIRrQK/WHCvoTOBa+tv907kmvSr59dZxH4kbG+6pgZnxYdXzkFGVd6vRfNe09vAYtQ3hbW2Y89+rpJ2Mm5OpvoRlH6ovEwwJpRfSSyrQOcWIHaD2TLuo43/XE04s6xe41f0zEsdaALA087o35HDJJP13oDbXoLHJW3fZZW/aNmJSWnFpa2baspwluU5rxJLxfotlSTRxjeMfeiN7/OOte0E9WSPbQIlh03aA+qpGNn/4uv5yPDyy9bWF5+t8uASiM3ReC/9B3KR1e4qjtRma0wo3ag+vLgqkY7/utM6tFpC4MbYV/Xo3ff+Jn6JfY772j/5asG9+P6922/rLj+9ojPwWbJD3LeJJuekdhQ8f71oMvqC4+Hy976p6/T6cvpjWhz7P17zRmvbLzzEHV51mD2+XvG8A2iCfri+zB91XB7afp2sb3Wnu6x3cZJ5uweET2vrvq+3K3awrG6Q7opsdesuzZXvyPezmz1/SPHmscSpbdRmLkij7SQbRmrf6Jss1Rna55/jGG67uTLVJlqQz6gmDwGqRESDDdPrqAM6ZqqsKc/o3Xx4fq/q4XV/n+PFqJm/CWP35ljVOxPS1m/W0Z0OY6q6lF9E6oV3jWv/X1wH/L1cBt83Aux1kfyM0a5oJqszXf4n2nzzE5GsuYM1UN8xWnGhLun2WHIOD8BiUuHUDLSdybAcNGZsZQI69W0BYqu+Oo3d+IAkjG1X06CbPlKexU5vzLUlSiE+zZjBf+HyLkot8plk0eIvPdItO6bFWni2n4ROt062oVw/chtjZ0FZZyoJje1xqegPqqi3mI75qP9Ec0016tZeya7Oqp/pJW2VJC15tp76Ra60l7Uius+EbMniPzSxLuhOW042Jai5lz0iU0JhR7AChGa2qS+s9tT1F9Zb8aj/NtIfWXdKnyZ2yfK8euUN2xqiEot9GRyX+Qpz5TnC+UuZ74eUnnW7V6ooKwtbD1JETCljKumqQTo+Z1q+9WPsficQb7QfYQXgs2+jC5NUFuuFlSe/3WxclWODYkqRv5uB0KryE78luOsOAO1yfadT0icywMYPTmDnaYUc7bsNINzvVktyQOGzI+IA41Q4w+R82YXDqP1X7yJRl2BL2hGWGl2SnCKOOwpggTLUHDsjDhowMx5PfyNBgPPJKeEPxVItGB+JhqyYMw1MtGx6Eh83iDsGTe5v81sdIh8PZ+GBYY6L387lan5tcUs3tzS/f+gseLja9O+/9BYenP6Jiw4G6UXDS3z71t37/9ml43KYb599t+5vmnYznl9/xG2n05yUHj3s9Ij8uNVlLCJ7IB6FcFPULTta1qZrTgz/tVtt9OCqa47wXpQM1JmuvPtfH1boefJtJmcka4vCcvFs9p8Vu0sNTw9TCjce/6mAE4tMH6YXKfr+qq+N2Rbeio18WCI5NRDGiYi9G5aOPUcApUnP3YSzG9FJrNOL5p9WWju8DWtvSM/TOf6md3lbmH/KHCfoGXGwejK7926cPM025iwVMNWp05PT3Ed1iXCzhdutoS/spZ+D1h5Fhj8jLfIzL39mDMF16dt1M+3f+YPyxTa/2t1MbZ74alPkclsdvvrNxbLAeVhgXm6vnFRjAqJKhnfQRDevDY1N0VEtSbp6mEFMbp+8fUQkr3KA7P+0BesenPuPfLsRkcvz9OSg9V+uPu80ErbT0LK3bU2P8SGu4FpqpozF1VEdXaKYOZiwgUToxDJBtxXCARsYIXnAGr1/4PrcRM9RJgEqzbOj662tUn598jjbgwXpcS7iTY/ICxifIfVUoqUqSVIvo8j/eenymJ4uZRcUbNu34TF8VM3cK1TUtbcpV3dyMKcP6R5KlXNXPzJMyrH0kRcpV+8zsKOPPzkqMkr6Fm3KiDHneSDqUqxUzM6H0dOMkKE2x4fwnUYlbl7k5kdysJ7Gxw/vw/fiOEd13SUW2GXP2u8csYWZe4VvBTLoy8mb4+Vb4lnETm+RMm57TZNg2MKylOSlpM/W/LjWwXYUxR7Zg27yhLVLGHNt62qYNbpHCuaPbiAUjw1tkwMzxbUT/yAAX6Z85wjGenzXEkTdx0xg36IMjg1xkx8xRrq8dD3PhzvnBcS4ustRA15PJHekSe+cMLjnN3NElqX9LvqysIdxcWRMsWZ+Pp17WkVFDLrUWs4M54GYtmjziTrCNO+RmjZs+5g5bR5vsr/vm6phQ9efqaUczVfR+Hx5+dS/1+Jv6EK3Ht11a7cuj+9/5Y/rhqdqzpD1vSw6+rGBcbkjfHU48y593Recri4n/oKohvM9R9FAxFYWC8xX9nkzlBlX9PphinKNsk2blHtS2Gc7MzXONanXkukYoOk1Zph3RMTWjmTOu9ga3iLgyxD6/VBl/MDCyRlP/n9Ierjd9Ib/fOv1H4kYWANTCzEsEiAQqG1jzMjU9ND+CuS9Udy18u86K+T6vhW/S2WzS+gIgBSHUm1a4TXd7VzfCUFh3UuEm3cfq93N1qsHpW6g5Ln7z+/7m89P2CE7AZt/3tcKN77uN9+O+7Wvxm/Se1ocnpld3RW/Stz7sw81ZzFeclJ+sGfazPwd/GdDflliur40Fsnvbzs45/W2ikNXjjmhrGxnY8cgojSvcqJvXFyXap/VGo/rH2ybRzm+dI7rH2meil9tCR3Sy2miieFIrBdphOz31LtTtW3Epw5/snY9btsDnofDYE10tHW49yaHuUd1ppZtt8JOSaRbEVRZ4Bx8Pax+mMvU1kHo3W+LvmN+OdCfEiqTOHAv648X4OERsILVutiJsxU82g1ZbyI6x5Q+0Yvh0xIx30fna9NcR1bzZmkuIBg7by9rSq3ezJT5b3cRPk9S52YImSrAZ15qDEvEg0hy2m9CVDUu52cr3q0uRNyNDNrEM1JxjDTcgJ+/HjOCckU42HsZDGO131ZdMJCgtMDiAsx8OCeU9GbWXFek+rHc40p2rsZ+6eFjreM7iAc3jqcaw0sF0Y0NPmrgMvTjzqrP9hb8i8ym2q5f7zbd7f1LGh2EnWdjG1Dznicg9cvcsc5w4MYPnvX118NX2L9nsab0UuXn5iyWOrX/7pk6LOcipHQk8GNbLiz7IqZ4agjDFlkwcQs6UicEIUyzJRCTkLJkYljD1nQzGJgy9nVkBCnyvzUQp5CyaGKowYgc9A0ML46CFbLlbIxeGBY+FL+TNn0fKWdbwcXle3Nih8d7qdIp9nIXqTMtgDAjPqpFAkLkWjcUX8IzjBxlMsRMNvzi+L/15sWGXHeFHzJs53PJj/Hj69t218n/xsTssxf06t1hwyefJ0h2Xnqp14vTihuhGrg1j04r58Y1cC8amE/MjHKe8A940YokYR55Pjk0f5kc5DujPTBsG4hxhmcWmC5MjHbHJN04Tbo+ow6I4AZCTbXo3pUNcYjowNyZ0jiXsacACcYZc+/p3PvUabft3/oC/PXHuGukOPE65XGRg8/Xl4EUfl93Vl6xrPvLbNfjSz0TLZuSOzxEdl42U76ovry83sEEYlagdrLewJb+etvuH15e8aSdyu9xE+7LSvobVXcNo/rCA2VDc17S7zT+8oOlU4tewPpCeJfyESprZjps90+uG71iD7pWepbXDXi/36+pUH47fVV9e7jevq9O62vef9vT9ql6PtPmZEuf2sT/5oq2/+Ixg7/rJtHM970jlWTaNLb4SG7irrhGd29ObenWsT/+9rd9z1MLyszS/PW93m19WDyPXXwS1/cJz2/XH6lj/sno4cR4WFb9F7wSdt+nrWtLrJKHhz9W7qqm/Xe2+3dfVw3Fbj/QVk+TMsvT0/nDebbrO+2V28Z+Yla80y4YwTf92v96dN9XpkhOTM4N8Plp3AYt+3T/dYBOszbWKi8/wmDdpagom76/TExZEWfj11p27vjDena2tbdP27YAy3q2tI9qYVwkleifeJTRswWUfbuzmntgEVGmiDZOuY4x1T93CY1owfC1dbMDEDTym/uELIvsv/2s8P+f+RPomZm3esTxz+AK72I6JW3d57fAqqVBu8C6ppMit+3ZZmczbpFJ7s+GlQ5fhZHWzb8NJJSxxpUjepql3ikyxbfw6p7xdU+5zmmLT0NUZeWt4d2dMezfn/YyXEiotZgXnCo+8OdPu8Bizqz8Rgpm3ot8WmgRx827FVs2aALGzbjE0saceNP3UhInHvKRfPb0zJx2zUn71lM+bcMxK+JV54cs/N2eqsUC2L4YXDk8zZuf6ymmGU4x8pq9+gYWmF1PzfAFLpyC3Ya1jvA3UXmJKcXNWrcl2DQ3dM3OOTbaBeU/S7Xm9pls2OtnKGjVhqsW3hzO1yFk0bWLBTn3Wln9zftuc2HybHbouBRaaYKTyeLOMq5GzphpEJW++MaqTPekg6ifPPKAlk6YfxIKZcxCGHcMTEWLGvNkIw4rhKQn8HF/pXXAmJ+Ct3DJDGfXb4WkKsWbeXAXbACcsl6KDsxZaaqGpCxTLnL/0DL9pAjFkyeRZRE/YjMgmjl28udZEa4YmNoPW8GY3E60Zn0gM2jRlNjHRMs6UYtC2afMKhnXR5OJNtX4S2nwoet3M5Rf+dKIjkCisIRX3PC2KH+hqW2764g+cfVd9+eUQ3yuSUdkrPVfrJRqDp7ZX/Kan/dunD78c/vylBuAIPm9S/rYnnqAaVJipGx6xJOoGz1aOagg3lY06bFdqppaHal8dgx8klzJl1PWLL6P359WniapDjdna21OhjC6BlL1VI6NpkrJ8jVzSTvRxWDtSBzrsY7bDPi7bYR+nd9jHGzvs46wOe0Art/s6zu2+8rqHuq/jhO4rr2G4+zpO6r7yWpjd13Fe95XX+7Z5/b8c/rx9+BYk2CBaaWG+zokN+ji9QaePGKXvJNkfotSajLQPA5kXsKCRlAtTEy1klIxnWJiQVyGjY7jVUPFRB3o41q+3x2qdHCCt9ufH0x+T34Zf/PUDhpjXzXb/MCrteVI2Y3piH9T4kq/w5Xx90aDTLGh7baH5I3+oOe2qqn/700XG8+53bKQ3ICP5cbvfPq52b0YUkGLT9TT35J2PTcH8bVZXdbj0dK1hD5SjsV9yrrYf3707VaynzJWfrrmbX3C0orIsjdxuPnpARg9PlMQNpzla4lMc/1f1seqn6Ut/HmxMXNOBSNZDEEszI8Dan+rmKg1Fb9H3dndYfzglGeKHdCbFJ+rNZ5Ef0jiYRJ6nK00jP/hKB7PI87TFeeSHdA2lkedpihPJD2kayiPP00SSuw8pG8ntzv1icXb34S82lNw93waiLuSbj9W+/q/DA+5Bkl8X6UD6Eln9R2pmpjmfd9vNX1aNnP6CBehNi9+gd9uETXM0dgWn6RrvOoCqwZ6DpQl3HOj7DfYbTF3I5aGuIY9n6Vo9PVX7PoUDyi4lb9Dm75bwJfv7AkBlWvwGvQ9VzdcaF75BZ+j9gqQ/f0F3NgPdqNLEtti/yG1gUtQrwV9k+JNnMOnCsPDnqCJ+xr7907vYjBETLn+dPVPLqx6arLG1DszXcm9+fMrG1o67+Yzi4a5+SOd4d59Ryb5xaEa3n/uw7IuHJs/lMhq51wKNd8pcjfzbgebMIjNKJ1wSNHk+nlHJvdlpxkCe9R7u3URDXf7P1en8uHq7q35ZnT4MdPyZcovMaodkM89A4ofIQf+300zw5RfRnOn4x17AUPc/bsF4lziof7BjnKgdd4/Djz/YSU7Uf6wetvAakEETolqLWPFwXE30wLbGQu8ARtENPv9qKKp4kvbqc43WD4P6L3UWsSAzlAz3AMMDyuRWgLr5kVYw1NkzeiG6afHN47auq+Ob+lit+rm5+0WW277oi+XvYaRW52hGNhg7pz+ucav2/BYDUDy+z8DSObDZgN72+I4DS2v1uO1Pj3JK28KzdJIEftXxdNhfr5Vok6SFv94a0hqLGU3L1xqSm2Vs6UkOIPxuM3y9lS8/HMKYkuW8ppF8/lxdSYTBoLbB4IKsvnkfqdPXyvtDwVR8sTMXudoLV+KbcPc0Gr+EjRmNpu0iYGYZFdde0CqcTxFYNJZBMeuIMfOuTnWzQf/XEMqCKCEtwd+o6uJjaEczLPp5v1qGSPZsH7Nj/PqDMZOQhKWtw9mhuZb9n8F9gslW+WjsV/g804hJadWF7Gnjv3HmyxGDSN2Fv1t7Jcglp9EsE8eELWRzkx7uFjNB/WW/76w2QOoua1H+ZCLPqjejU+O5lmVyUvHMej28IJtsU7tdNu8D0soL2zT7EyIBC9sG82kwzfp5aFthskVd8jp8/92ISbTy17DpTXck8SbjYik3Wnlc7TeHx4vAN/UxjlocMS5XeRmb5piyqAU4FH3QgOFg9In6X709HN+8XwltEAgetINWXcQeFOA9aMVQkPdE3QNRh0MWMAIQuXaESMrX283P1emwO9f+7sXTecd+J0MCFuprXm83TUD/vDULrTzdJnb0ZuYFcUI5B9Qn99Ucdjt0+Yf/Mz9i/+mw2/1c1ccvOHg5Eve8VzSztA2GDehrfPYAoCNVdi3H1JRizcNu9+u+3u7enNfr6nT68cjVm6vFtIJ9h2CklnWBYP9xe3uG6fXdjR/19yr6ZRbYT8wIZewuApNze429O96Z6u9mXPbuZYwdq+7fec+3KK67nE3pXfRcayZeSs+wA9xPzzVmzkX12KJ8A/HbH4PN41JiucaRiuQ3jauxNzgiVD7RDa8yhj/+MXwUtGE/aE1cbylbmlMa33x+2h6rvCdm3k1SczF7Rjux3Jfid2FcW4Y7C2wHt6vg2sDoKLAhk7qJAWuGRtHuvviRgTQutuRY2pM7ZThNbL9pBMuZMXkQSwRN+BBvBv3U/zoCPvDtaCMacKmbP/CAWO4dadTwbDRqe251ugl3cd1JxowmSazfH3KXfw0ZdKl4ozXUGbqNumFnyJS61RmGxI45Q87wic7AMIHhDDkpM5yBY9CIM8yzpsvANMOeqOqNFmVynw17Jy50q3MOSGUmPrvRNccNYHhmRsgMx2SYM+KXs2zJuCXDmlGvnGXPunfrFdugNffOq3lvKLkncPJb4twWOGqXA9OXV91MNaT6WYG0D8OFh7fzTNRX/H7eHqOlBVv486jq2DwOPg6056fj4f327baeZVFS+Uab8lPLV+PLj2uR5eb2RCZ/Xh/ZOxjMtRqc02P1d2lVvimXZvA/L9oTUH/6d5MVqCn17E/PxJ28K5+9ePZuW+02p2d/+i2Y+uLZ+vD4WHmEsjmsz/6f/9MW+3vV7IU2hUPpP94/e/Hb/Quj7nSp/ud/XvzWVfY/+D90Mq5/8RWLZy9+K14IeydKm1QsehWLpKJ49uI3gTSKXkWRVJTPXvwmX+jyTjmTVJS9ijKpqJ69+E2hiqpXUSUV9bMXv2lUUfcq6qSiefbiN4Mqml5Fk1S0z178ZlFF26tok4ru2YvfHKroehVdUrHMaSx7FcvUARp/KF8odSeETj2g7zsFcR7vPfcvlLgzQqSVgf+kDlQ0blEUyOai70NF6kRF4xqFgJX7flSkjlQ07lFAHyz6vlSkzlQ0LlJAPyz6/lSkDlU0blLoF8reCeXSyn2fKlKnKhpXKQxqc0Xfr4rUsQqXbeh91ypS3yrKXMsr+t5VpO4lGo8p7Att7gpRpB1F379E6l/C+xdsD6LvX4J0UCLn2AJ0Ual7CZl1bNF3L5G6l/DuVcK+se9eInUv0TiMuH+hiztzT95X371E6l7C5M3uu5dI3UvYnIeIvneJ1LtE4zCigI/cdy+Rupcos4r77iVS95KNwwiBnlj23Uum7iUbhxESWS377iVT95J+AFSwct+/JBkDG48RGlYGw2DqX1Ll3pfsu5dM3Ut69zIvtLwz92kHJPvuJVP3ko3DCAsr991Lpu4lG48RDj5y379k6l8y23vJvnvJ1L1k4zECNkfZ9y+Z+pdqPEbCmZXq+5dK/UtlJ1eq714qdS/VOIwsUL+p+u6lUvdSfo4l0IdSffdSZJrVeIyUL9T93b0gEy0w00r9SzUeI2GrUH3/Uql/KZPt+1Tfv1TqX8pm+z7V9y+V+pfK+pfq+5dK/Us1HiPh/FL1/Uul/qXvc4p137106l668RhpkIvovn/p1L+09y84Y9R9/9Kpf2nvX7At675/6dS/tPcv2B513780mcrr7PsCk/nUvXTjMOoeTb5037106l66cRhVwMp999Kpe+nGY5R4odydKsu0ct+/dOpfusy2R933L536l2lcRsEhzvQdzKQOZhqXUbAxm76DmdTBTOMyCg5xpu9gJnUwI3Of2fT9y6T+Zfw6ETYL0/cvk/qX0dn5hOk7mCHLRe9gcK5rwIoxdTDjHQy2KdN3MJM6mPEOBtuU6TuYSR3MNC6j4Rhn+g5mUgez2Q7M9v3Lpv5li2yDtH3/sql/WZFtkLbvXzb1Lyuzbcr2HcymDmYbl9FwaLZ9B7Opg1m/GQE3TmzfwWzqYNZkX3bfvyzZkrDZyZsFuxKpf1mXnTbavn/Z1L+s9y/YB9m+f9nUv1zjMhr2Qa7vYC51MJedgLm+f7nUv1zjMVq/UOVdKdO6ffdyqXu5bPfl+t7lUu9y3rvgKt/1vcul3uW8d1lYue9dLvUu1ziMhj2Q67uXS93LNQ6jYQ/k+u7lyK5XdvrlwL5X6l2u8RcDey/X9y6XelfZ+IuB69ay711l6l1l4zAGNuWy715l6l6lyD1y2XevMnWvUmZHuLLvX2XqX2XjMQa2xrLvX2XqX2XjMQa2xrLvX2XqX2W29yr77lWm7lU2DmPgbKLsu1eZulfZeIyBG7ll379KsrFaZifKJdhbpZur99k5evgtrR79ra3vfQw26PAbrU/2WO+zbhZ+otXJLuu9zI7Q4Tdan2y03qvsIB1+o/XJXuu9zo7T4Tdan2y33vsdfIdfP9hwvSc7rvfe7WCvFn6j9cmm631+1/UebLvek33X+zK7bgi/0frE+/x2vb1Hw3aBdvd72/uNN1nYPRZwg594n9+0t7CHLNAeP93kL7LjaIF2+ek2v9+5t7CrK9BGP93pL7KLzQJt9dO9fr99b2FnWaDdfrrdX2Q3ZAu03083/P0mvtXQ99GeP9309xv5FuMGtO9PNv4Lv5dvcdcFtv4Lsvdf+O18C6cjBdj9L8j2fyHyXR8AAAUhAIXf1Le46QMGUBAIUPh9fQfnJQXAAAXhAIXf2ncFbLuABBQEBRQiO9oWgAUUBAYUfoPf4aYLeEBBgEDh9/gdbnsACRSECRR+n9/hxgOwQEG4QCGz69ICgIGCkIHCb/Znel7ABgoCBwq/3+/gfKUAeKAgfKDwW/4ONz5ACAqCCAq/7e9w4wOUoCCYoPA7/w43PgAKCkIKCr/573DrAaygILCgkPm+D9CCguCCwiOAEu4kF4AYFAQZFJ4ClJhNA2hQEGpQeBBQ4tYDuEFBwEHhYUCJWw9gBwWBB4XnASVuPQAfFIQfFB4JlNh9AUEoCEIoPBUosfsCiFAQilB4MFBi9wUcoSAgoVD5zg+QhIKghELl90oKABMKQhMKld8uKQBQKAhRKDwkKHHrA0yhIFCh8KCgxK0PcIWCgIVC56OCAFkoCFooPC3IrBoAXCgIXSg8MMisGgBfKAhgKHSeYBUAMRSEMRSeG8CtnwJQhoJghkIHCo+HfkAaCoIaCh1QFp53A9pQENxQeIJQ3OP+BxCHgiCHQmeRfAGYQ0GgQ+E5QnGP+y/AHQoCHgqTd0BAHgqCHgoz4IAAPhSEPhRmwAEBgCgIgSgCgsCzB8AgCgIhCs8VinsFOxDAIQoCIgoTXBBCyQKwiILAiMIEF4R7JgXgEQUBEoVnDJnpK0ASBWEShccMxT0eAgCWKAiXKAKYuIfBQwVgEwWBE4UNwW0lfATAJwoCKAqbR/gFQBQFYRTFAKQoAKUoCKYoPHnIrP4BqCgIqSg8fMBRBAVgFQWBFUWgFcU9fgHACQmxKDyEKArcDwJoURBqUdj89gvAFgXhFoVHEUWBu1GALgrCLgqPI4pMpCHAFwXhF0UeYBSAYBQEYRQeS2TmMYBiFARjFIFjNMGO4AsClFEQllF4PFEUuB8COKMgPKNw+XilAhCNgiCNwgUfxDNRQDUKgjUKTyoyuygAbBSEbBQBbRS4HwN0oyB4o3DBCfFkEBCOgiCOosyvhAHjKAjkKDy3KIoSvgHAOQoCOopAOgSeDgHYURDaUZQh1hd3AwB4FIR4FB5iFEK8kObOGBKnDKBHQahH4UFG9h0ANyTko/A0A3cDgH0UBH4UpR3SD7yQAJDCM40ChzoWgIEUBIIUnmsUONyxABykICBEeLBR4JBHAUiIICREeLJRCNiSBUAhgqAQEVCIgC1RABgiCAwR9zLvRgLQEEFoiLgPfgibsgA4RBAcIjzeKET5Qsk7WdJoahAeTHiI8HyjkPcwKhoAEUGAiPCAo5BwXicAERGEiAiPOHCAjQBIRBAkIjziKKR4Ie3dvaUGgHhhwkSEZxxFM63Sd4UkrwBAEUGgiAiHHqTCAlBYOnHEcPBBaiwAOCLBIiJgEYmbAgAjgoARUWQjiAXgIoJwEVHkqZwAYEQQMCI86IDrawG4iCBcRAQugpGsAGREEDIiPOnAEZsCkBFByIgohnwQoBFBz0SEQxHSoTeATkXQYxHhXIQsYX3ggb2TESJ3sEnAsxHE/zzqyJysAN5Hj0eE8xH4lAI6IEFPSIhwAgcubAQ6JEFPSQQ0onAnhg5K0JMS4agEXuALdFqCHpfwtAOfAxLowAQ9MRGOTOC4ToFOTRA8IvJ4RAA8IggeEXJgbSwAHxGEjwjPOwocWyoAIBEEkAiZRcMC8BFB+IgIZyhyDwCckAASIYMT4k4EEBJBCIkIhARXBy5IAInwxAO3QQBIBAEkIhyoyBxwAg5IAImQwQFxHwIIiSCERHjiUSjciQNEIggiEeFwhYKxHQIwEkEYiVDBBUtsAXBBAkmEhx65XgBQEkEoifDUI9MLAEoiCCURnnoUOHJXAEwiCCYReUwiACYRBJOIgEnwWTWASQTBJCKcutD42BjgJIJwEuG5R4GjaQUAJYKAEhGOX+DYVAFIiSCkRARSkukGACsRhJUIzz4KHOAqACwRBJYIDz8KjRdWgJYIQkuEDl6IZ5MAlwiCS0Q4k4GjTgUAJoIAExGACY48FQCYCAJMRAAmmZUZACaCABMRgElmSgmAiSDARARgguNfBUAmgiATEZAJjmMVAJkIgkxEQCY4llUAaCIINBEeghQ4nlUAaiIINRHh0AYOLRUAmwiCTYTJL0sANRGEmohATXB0qgDURBBqIgI1MbgxA2oiCDURgZoY3JQANRGEmghPQQoc7ykANhEEm4iATQxuSgCbCIJNRMAmBo+KAJsIgk1EwCYWOzLAJoJgE+ExSIGjDgXgJoJwE+E5SIHDDgUAJ4KAE2EH9gsFICeCkBPhSUiBIw8FQCeCoBMR0AmOHRQAnQiCTkRAJxaPCgCdCIJOREAnGEEKAE8EgSciwBMcPygAPBEEnogAT3AAoQDwRBB4IgI8yWx2AXwiCD4RLp9BANATQeiJcANJBAA8EQSeiABPcASkAPBEEHgiXHBDPCgBeiIIPRGBnuAgRgHoiSD0RHgaUrhMYgDghgSfiIBPcByiAPhEEHwiAj7JtGWATwTBJyLgE4fbMgAoggAUEQBKxgIAUAQBKCIAFBwLKQBAEQSgiABQcDSiAABFEIAiAkDB4YgCABRBAIoIAAXHIwoAUAQBKCKcHcEBiQIgFEEQiggIBUckCoBQBEEoIiCUErcFgFAEQSgiIJQStwWAUARBKDIgFBxVKAFCkQShyIBQcFihBAhFEoQiA0LBcYUSIBRJEIoMCAUHFkqAUCRBKDIgFBxZKAFCkQShyIBQcGihBAhFEoQiA0LBwXkSIBRJEIoMCAVH50mAUCRBKDIgFBxfJgFDkYShSI9EBI4vk4ChSMJQpEciAseXScBQJGEo0iMRgQPEJGAokjAU6ZGIuMeeCBiKJAxFeiQi7rEnAoYiCUORHoqIe+yJgKJIQlFkETL9YE8EGEUSjCKLkC4DeyIAKZKAFFmE/RvsiQCkSAJSZBHS/mBPBCRFEpIiPRgROMJHApIiCUmRnowIHKIjAUqRBKVIj0ZEgT0RsBRJWIr0cEQUmURAKBMQ8USPR0SBPRHwFEl4ivR8ROAYFwmAiiRARYacUzhGRQKgIglQkZ6PCByjIgFQkQSoSM9HBM6ZJQFQkQSoyJCACgeZSEBUJCEq0gMSgYNMJCAqkiaiajNRYU9EuahoMqqQjSqTjgrlo6IJqUJGqkxKKpSTqpeUyntiLi0VyktFPNFDEoFjNCRKTkWzU4X0VDhGQ6IEVTRDVUhRlUkzhZJU0SxVIU1VJl0USlRFM1V5UiJwyiiJslXRdFUhX5XEnogyVhG0Ij0pERJ7IkArkqAVqUJeNOyJAK1IglakJyUCp4GSAK1IglakJyVCYk8EaEUStCI9KhE4REICtiIJW5EelQiJPRGwFUnYigzJrHCSJAnoiiR0RQa6ghMlSYBXJMErMpxCUdgTAV6RBK9IT0uEwp4I8IokeEV6WiIU9kSAVyTBK9LTEoE5twR4RRK8InXI0oc9EeAVSfCK9LRE4DxGEuAVSfCK9LREKOyJAK9IglekpyVCYU8EeEUSvCI9LRE4tZAEeEUSvCI9LRE4vZAEeEUSvCI9LREYVEqAVyTBK9LTEoFJoQR4RRK8Ij0tEZgUSoBXJMEr0tMSgUmhBHhFErwiPS0RGPRJgFckwSvShJyR2BMBXpEEr0jPSwQGfRIAFkkAiwzJsTDokwCwSAJYpOclAoM+CQCLJIBFel4iMGaTALBIAlikCSfzsCcCwCIJYJGelwiM2SQALJIAFul5icCYTQLAIglgkZ6XCIzZJAAskgAW6XmJwJxMAsAiCWCRnpcInI1FAsAiCWCRnpcIzMkkACySABZpw7EA7IkAsEgCWKTnJQJzMgkAiySARYZ0Wjg1iASARRLAIkNKLczJJAAskgAW6XmJwJxMAsAiCWCRnpcIzMkkACySABbpeYnAmEsCwCIJYJHt+RTsiQCxSIJYpEcmAmMuCRiLJIxFemQiMKWSgLFIwlhkOKCCKZUEjEUSxiJdSKqLPREwFkkYi3ThsDL2RMBYJGEs0iMTgSmPBIxFEsYiPTIRmPJIwFgkYSzSIxOBKY8EjEUSxiI9MhEY0kjAWCRhLNIjE4EZiwSMRRLGIj0yEZixSMBYJGEs0iMTgRmLBIxFEsYiPTIRmLFIwFgkYSzSIxOBGYsEjEUSxiLLkOI5k2oZeCJhLNIjE4EZiwSMRRLGIsuQ6xl7ImAskjAW5ZGJwIxFAcaiCGNRHpkIzFgUYCyKMBblkYnAjEUBxqIIY1EemQjMWBRgLIowFuWRicCMRQHGoghjUR6ZCMxYFGAsijAW5ZGJwIxFAcaiCGNRHpkIzFgUYCyKMBblkYnEjEUBxqIIY1EemUjMWBRgLIowFlWEzOPYEwFjUYSxKI9MJGYsCjAWRRiL8shEYsaiAGNRhLEoj0wkZiwKMBZFGIvyyERixqIAY1GEsahwUgUzFgUYiyKMRXlkIjFjUYCxKMJYlEcmEjMWBRiLIoxFhcMqmLEowFgUYSzKIxOJGYsCjEURxqI8MpGYsSjAWBRhLMojE4kZiwKMRRHGokQ4SY89ETAWRRiL8shEYsaiAGNRhLEoj0wkZiwKMBZFGIvyyERixqIAY1GEsSiPTCRmLAowFkUYi/LIRGLGogBjUYSxKI9MJGYsCjAWRRiL8shEYsaiAGNRhLEoj0wkZiwKMBZFGIvyyERixqIAY1GEsSiPTCRmLAowFkUYi5LhagbsiYCxKMJYlEcmEjMWBRiLIoxFyZDWAXsiYCyKMBblkYnEjEUBxqIIY1EemUjMWBRgLIowFuWRicxcywEYiyKMRcmQUx97ImAsil4LEu4FwYxFoZtB6NUgHplIzFgUuh6E3g8SLgjJXLWBrgihd4SES0IyF1ega0J694SENEvwDJCCV4UQTwyXhWDGotB1IfS+EI9MJGYsCl0ZQu8M8chESniwXqFrQ+i9IeEICz6FpNDdIfTykHB7CIY0Ct0fQhiLCkdY8CkkBRiLIoxFhSMs8NYCBRCLIohFhZtEMCVSALEoglhUuE0EUyIFEIsiiEWFfF+YEimAWBRBLEqHW2sy19age2uII3piIjElUgCxKIJYlCcmElMiBRCLIohFeWIiMSVSALEoglhUuGYEUyIFEIsiiEV5YiIxJVIAsSiCWJQZCJRVALEogliUJyYSYyYFEIsiiEWFEyw4v4ICiEURxKLCCRYccq4AYlEEsaiB+0cUICyKEBYVjrDgo+kKEBZFCIsKR1hwegQFCIsihEWFIyw4PYIChEURwqLCERacHkEBwqIIYVEemEgMCxUgLIoQFmWzWZcU4CuK8BUVDrBkvgHgK4rwFTWQ+EsBvKIIXlEDF5QoQFcUoSsqJP7SeEgBdEURuqI8LMFJkxSAK4rAFeVZicSwVQG4oghcUTZkeMAdOoArisAV5VmJxLBVAbiiCFxRLjgh7tABXFEErijPSiSGrQrAFUXginJioDsFcEURuKI8K5GY1ioAVxSBK8qzEolprQJwRRG4ojwrkZjWKgBXFIEryrMSaXBTAHBFEbiiXDYPsQJoRRG0olw+D7ECZEURsqJcPg+xAmBFEbCiynD9BJ5aAbCiCFhRnpNIDJsVACuKgBXlOYnEsFkBsKIIWFFlNtGDAlhFEayiwtEVfKZTAayiCFZRZfBB3BMArKIIVlEh9xeG3QpgFUWwivKUJONEgKooQlWUhyQSw3IFqIoiVEW1yb/wtAhQFUWoig4nV/C0SAOqoglV0ffBDfGNg4CqaEJV9H1wQ3isVQOqoglV0R6SyCabJhLQd0RNqIr2kERiXK8BVdGEquhwFwrG9RpQFU2oivaQRGJcrwFV0YSqaA9JJMb1GlAVTaiKDlQF43oNqIomVEUHqoJxvQZURROqogNVwbheA6qiCVXR4eQKnKBrAFU0gSq6Tf4F59caQBVNoIpuk3/B+bUGUEUTqKIDVMEBBxpAFU2gig5QBQccaABVNIEqOkAVh9sSgCqaQBUdoIqD46IGUEUTqKLDbeh4iq4BVNEEqugAVXDEggZQRROoogNUcbgxAqiiCVTRbQ4wuEzSAKpoAlV0gCo45EEDqKIJVNEBqjiNBiYNoIomUEUHqIJDHjSAKppAFR2gCg550ACqaAJVdIAqmWEBQBVNoIoOUCUzLACooglU0QGqOJgISgOooglU0QGq4KALDaCKJlBFB6iCgy40gCqaQBUdoAoOutAAqmgCVbTM3tSjAVLRBKnokAoMJzvXAKloglS0zKdr14CoaEJUtBxI164BUdGEqGhpsvkANQAqmgAVLQeytWsAVDQBKlrms7VrwFM04Sk6pAPDiaI14Cma8BQdeAqOu9GAp2jCU7THI/juXQ1wiiY4RYdsYDhdvAY4RROcokM2MJxRTgOcoglO0QGnwKWqBjRFE5qiVT4rpwYwRROYoj0bweniNWApmrAUHVgKTBevAUrRBKXogFJwungNUIomKEWrgbScGqAUTe9iDygFptXU6Dp2eh97uJC9hHmeNbqSnd7JHlAK3q7Q6Fp2ei97QCl4506jq9np3ezt5ex4UoCuZ+/dz66zfTm8oZ04YUgFhjPma3RLO72mPdzTjvsBdFE7valdD3khuqyd3tbusUimGaH72glG0Z6KZLpiQFE0oSjaFPluAEAUTSCKDhAFN2PAUDRhKDowlEwrBAxFE4aiW4YCWyFAKJogFO2RSK4VAoaiCUPRZmDTUAOGoglD0S1DgcM5QCiaIBTtiYjEEZwaIBRNEIr2RETiCE4NEIomCEUHhIIjODVAKJogFG1DV4gXmQCiaAJRdLg8BUdwagBRNIEo2kMRhSM4NaAomlAU7amIwhGcGmAUTTCK9lRE4QhODTCKJhhFeyyicASnBhxFE46i7UBeRA04iiYcRXssonAIqAYcRROOom32IikNKIomFEV7KKKaqT3ojQBF0YSiaA9FVGZmDCiKJhRFu/zaBDAUTRiKdsEL8XgEGIomDEW74IUwwEQDhqIJQ9FODwkAXkgYinZm6BGAFxKGosMBFbxlBiCKJhBFu+CEuCsAFEUTiqI9FVE4hFYDjKIJRtGeiigcQqsBRtEEo2hPRRQOodUAo2iCUbSnIgqH0GqAUTTBKDrcGY9DaDUAKZqAFO25iMIhtBqAFE1AivZcROEQWg1AiiYgRXsuonAIrQYgRROQoj0YUTiEVgOSoglJ0YGkZDYuAUnRhKTocJl8ZuMSkBRNSIq5D54I24IBJMUQkmI8GFE4iNcAkmIISTH3A1jZAJJiCEkx4U55HAVsAEkxhKSY9hoViKMMICmGkBQTcoBhHGUASTGEpJhwPgX2aAaAFENAimlvUYFzZANAiiEgxYR75TFFMACkGAJSTHuNCqQIBoAUQ0CKaa9RgdvPBoAUQ0CKKYIjwi7RAJJiCEkxRXZkNoCjGMJRjMciTQL7/qhmAEYxBKOYcIdK5hsCjGIIRjEDt6gYQFEMoSgmUBS81jeAohhCUYyHIgoHwxtAUQyhKCZQlExDBBTFEIpi2otUcEMEFMUQimJC+i/cEAFEMQSimBai4I8IIIohEMWIAZxnAEQxBKIYMYDzDIAohkAUE25TyTREAFEMgSjGMxGFjzQYAFEMgSgmf9O8AQjFEIRixFBnCBCKIQjFeCKCw90MICiGEBQTCAruCQBAMQSgmABQcEMG/MQQfmICP8k0ZMBPDOEnxgMRhc+UGEBQDCEoxgMRyE8M4CeG8BPjeQjMk2wAPjEEn5gWn8BGDOiJIfTEBHqC7wMyAJ8Ygk9MwCf4PiAD8Ikh+MS051HgMQID+Ikh/MS016lkXAD4IOEnJlynAq8SMQCfGIJPTMAn+FSRAfzEEH5iVPBBODk3gJ8Ywk+MCtNCODk3gJ8Ywk+MGpoWAoBiCEAxIeUXjLMyAKAYAlCMByIKH2sygKAYQlCMJyIKH2syAKEYglCMJyIKH2syAKEYglCMJyKq2f1F7wD4IUEoxiMRJeHmqwEMxRCGYjwSUVJhAcARCUMx4fJ5CbeMDGAohjAUE26fl/DOWQMYiiEMxXgkoiS8dtcAhmIIQzEeiih8rMkAimIIRTGBomSaAqAohlAUo/M3+xhAUQyhKEYHR8RNAVAUQyiK0UOOCDCKIRjFmPsBNwAcxRCOYkwx4AYApBgCUky4hD7jBoCkGEJSTLiFHh8NM4CkGEJSTLiGHp/MMgClGIJSjCcjCp/MMgClGIJSjCcjCp/MMgClGIJSjEcjCp/MMoClGMJSjEcjBu5+GoBSDEEpxpMRhU92GYBSDEEpxpMRhU92GYBSDEEpxpMRhU92GYBSDEEpxpMRhU92GYBSDEEpJqAUfLLLAJRiCEoxAaXgg1kGoBRDUIoJKAUf6TEApRiCUkxAKTj/nwEoxRCUYoZQigEoxRCUYgJKwWdaDEAphqAUYwdusjAAphgCU8wQTDEAphgCU4xnIzgQ3QCWYghLMU7kAwYNoCmG0BTjBo4sG0BTDKEpJtAUfC7IAJpiCE0x4UqVzEcANMUQmmICTcEHiwygKYbQFBNOpGTGdoBTDMEpJlypktl0ATjFEJxiQrovvOkCaIohNMWEG1UyC35AUwyhKSbcqJLZdAE0xRCaYsKNKplNF0BTDKEpJhxKyWy6AJpiCE0xgabg42EG0BRDaIops3E2BrAUQ1iKCYdS8J4FQCmGoBTjyUhmWAUkxRCSYsqBAGwDSIohJMUEkpLZNAEkxRCSYgNJwefrLCAplpAU215IDxuiBSTFEpJiA0nBDdECkmIJSbGBpGgYs2gBSbGEpNj74IVwYLeApFhCUux9/riyBSDFEpBi7weOK1tAUiwhKfZ+4LiyBSTFEpJi7weOK1tAUiwhKfZ+4LiyBSTFEpJiPRhR+JCjBSTFEpJii+xxZQs4iiUcxYY0X7ArsACkWAJSrAcj8DZ3CziKJRzFDnEUCziKJRzFFgOnlS0AKZaAFBtACs5jYgFIsQSk2ABScE5gC0CKJSDFei6i8DFNC0CKJSDFei6i8DFNC0CKJSDFiuCEcGJkAUmxhKRYD0YUPiZpAUmxhKRYD0YUPiZpAUmxhKRYEYAe7tABSbGEpFgPRhQ+ZGgBSbGEpNhwMT0+TWIBSbGEpFiPRhROKmwBS7GEpVgRol9xXwJYiiUsxQo3MKQAmGIJTLEejih8zNECmmIJTbGejih8zNECnGIJTrEynATAbQHgFEtwig04BR9ztACnWIJTrOcjCh9ztACoWAJUbDiQgo85WoBULEEq1iMShY85WsBULGEq1iMShQ8JWsBULGEqVg6sly1gKpYwFesRicKnDC1gKpYwFSsHTi1bwFQsYSpWDZxatgCqWAJVbMjxhc92WQBVLIEqNhxKkRBMWQBVLIEqNtyjgudngKlYwlSsGhqcAVOxhKnYcEV9Zn4GoIolUMWGK+oz8zMAVSyBKlbZgfkZgCqWQBUboApOj20BVLEEqliVjYG1AKlYglRsOJWCz1ZZgFQsQSpW508EWEBULCEqNlxRD8PZLQAqlgAVqwdOBFgAVCwBKjYAFZxf3AKgYglQseFQCjxSYAFPsYSnWI9HFD7tawFPsYSnWD2waWMBULEEqFg9sGljAVCxBKjYcEF9pisBQMUSoGJNPtTGAp5iCU+xZiDUxgKeYglPsWYg1MYCnmIJT7FmINTGAp5iCU+xZiDUxgKeYglPsYGnODw1ATzFEp5iTTbUxgKaYglNsR6O4KUaYCmWsBQbzqXgjgSwFEtYijUDB/QsYCmWsBTbZvbCSz3AUixhKTZk9sJdGUAplqAU26b2gh0JICmWkBQbSAo+c28BSbGEpFg7EORgAUmxhKRYOxD7agFJsYSk2HA1faYjASTFEpJibf44gAUgxRKQYu3A1qEFIMUSkGIDSMl0JACkWAJSbLiZPtORAJBiCUixbiB3gwUkxRKSYj0YUfi2CQtIiiUkxbpsViULOIolHMWGzF64JwAYxRKMYj0VwR0RgCiWQBTrhrYNAUSxBKJYlz+hZwFDsYSh2JahwH4AIBRLEIoNJ1Jw5gsLGIolDMWGEynOwqUFYCiWMBQbTqRk1iaAoVjCUGw4kYLzTljAUCxhKDacSMF5JyxgKJYwFBsYCs6OZgFDsYSh2JDaC/NICyiKJRTFhhMppcAWAD8kGMWGEyn4rKoFHMUSjmI9FlH4vLYFHMUSjmI9FlH4rKkFHMUSjuICR8FnTR3gKI5wFHc/kPbVAY7iCEdxHosofFjVAY7iCEdxgaPgxuQAR3GEo7jAUXBjcoCjOMJRnOciGVd2AKQ4AlJcyO2FXdkBkOIISHH3Nu/KDoAUR0CKu3d5V3YApDgCUtx98ES45eQASHEEpLhwJCXjSACkOAJSXDGwRHEApTiCUpxHI5kICwdYiiMsxXk4giMsHIApjsAUF3J7ZdwAwBRHYIrzbMRAFOIAS3GEpbgi9IhwVHCApTjCUpxHIxof23aApTjCUpxHIxof23aApTjCUpxHIxof23aApTjCUpxHIxof23aApTjCUpxHIxqfunaApTjCUpxHIxpfvOMAS3GEpTiPRjS+eMcBluIIS3EejWh88Y4DLMURluLEQKCNAyzFEZbiPBrR+OYeB1iKIyzFiYEdbAdYiiMsxYVzKffwVIADLMURluI8GtEFPG7qAEtxhKU4j0bgwQwHSIojJMV5MIIPZjgAUhwBKS7k9cIHMxwAKY6AFBcye+GDGQ6AFEdAivNcJHOuwgGQ4ghIceFsCjxX4QBHcYSjOI9FND457gBHcYSjuCGO4gBHcYSjOBlOR+HuDHAURziKk8EL8cAOOIojHMWpvBcCiuIIRXFqwAsBRHEEorgAUfAnBAzFEYbiQmIvPDUDDMURhuJahoLrAxckCMUFhIInZoCgOEJQXCAo8ECFAwDFEYDiPA/ROHOAAwDFEYDiVPBAPBoBgOIIQHFqIPLVAYTiCEJx+n6gJwYIxRGE4jwSyfXEgKE4wlCcZyK5RgQgiiMQxXkmghsRQCiOIBTniUimEQGC4ghBcYGgZHpigFAcQSgu3JCCj8g5gFAcQSguIJRMVw4QiiMIxQWEkhmNAEJxBKG4gFBwRwIIiiMExXkionECDAcQiiMIxQ1dkOIAQnEEoTgTvBDPygBCcQShOCMHGhJAKI4gFGeyR0UdACiOABRn8kdFHeAnjvATF/iJwusbQFAcISgupPZSeKsAMBRHGIozAxdGOQBRHIEoLkAUBYOMHIAojkAUZwcujHIAojgCUVyAKLgdAIjiCERxNnghnpkDiuIIRXFWDrQDQFEcoSguUBSY0cgBiOIIRHGeiWAvBgjFEYTiAkLBXgwIiiMExYWzKHi3CRAURwiKs2FAxot0QFAcISgun9XLAX7iCD9xHodonIPGAX7iCD9xbVYvvM8C+Ikj/MQFfoLTgjnATxzhJy7PTxzgJ47wE9dm9cIeCACKIwDFDWX1cgChOIJQ3BBCcQChOIJQnEciGqfxcYChOMJQnGciGieAcQCiOAJRnGciGucvcQCiOAJRXBn8EM9sAURxBKI4z0Q0TrzgAERxBKI4z0Q0PnbvAERxBKI4z0Q0PnbvAERxBKI4z0Q0PnbvAERxBKI4z0Q0PvXuAERxBKI4z0Q0PvXuAERxBKI4z0Q0PvXuAERxBKI4z0Q0vszTAYjiCERxnolofJmnAxDFEYhSeiai8WWeJYAoJYEopWciWkJPLAFEKQlEKT0T0RJ6YgkgSkkgSumZiMaXeZYAopQEopSeiWh86r0EEKUkEKX0TETjQ+clgCglgSilZyIaH7guAUQpCUQpPRPR+MB1CSBKSSBK6ZmIxgeuSwBRSgJRSs9END5wXQKIUhKIUnomovGB6xJAlJJAlLIYWKSUAKKUBKKUnolofOK6BBClJBClDAdS8InrElCUklCU0kMRjU9cl4CilISilJ6KaHziugQYpSQYpSzM0EsEnkgwShkwCj6yXQKMUhKMUobcXmiCUwKIUhKIUoYDKTj9QgkgSkkgShkOpOAEECWAKCWBKKUYyN9QAohSEohSioH8DSWAKCWBKGWAKPjUewkgSkkgShlSe8FvABBKSRBKGRJ75V4h8EKCUMpwHAUncykBQikJQinDcRSczKUECKUkCKUMx1EybgQQSkkQShmOo+S8APghQShlOI6S8QIAUUoCUUoPRTROXVACilISilLmb0cpAUMpCUMpw2GUjBcAhlIShlJ6JKJx6oQSMJSSMJRShmAvPCYBiFISiFLKbNRrCRBKSRBK6YmIukf7FSUgKCUhKGU4iVLg+sAHCUApA0DBSQdKAFBKAlDKcBAFPj8AKCUBKGXI7YWfHwCUkgCUMqT2ws8PAEpJAErZZvZC+00lACglASilCg6IJwSAoJSEoJQqe1a+BAClJAClDHm9Mu8P+B8BKGVI65V5f8D/CD8pwwGUzPsD/kfwSRnwSQGzZpQAn5QEn5ThBAq+36gE+KQk+KQM+ARnOygBPikJPikDPsGH9UuAT0qCT0odxmI8IwMApSQApdTBCfGEChCUkhCUMn8xSgn4SUn4SelxiManxEvAT7q//c+LZ9v9x+pYV5tv95vq87M//fbbs3/8o/7yVD178e9n/9iGPxYvvJ5nf/r3s+LZn/79vy+eFS78V9j2v2X4r1Ttf9vfVVtetf+v79v/6vBfI8N/bft3a8J/XVvPtb+7tn4p2v+25Yp70f2jLVEUsvuH7v7RGlmIrrDoqsv77h9dGdX9pLtH1e2zFab7i+10dWYWZStHFO0LEJ1kIVt7RCdZmLZMczd4+3Za7c0FteH9SNG9qPYpmtsPwj9c+1OTtDj8o3ucJpFHeI1FK7k5L9a+2LaMvbzSTqDr/lIWl7fcWlh2ZjTDZviHuu/+0eoqg4X/+6LzuPDnztf8b43zrdb19rA/xX5lTeRYRckW87Gqq/1qX6/fV+sPx+p03tWJuxYukuuYcquT0GZdH2NJzfXUF0nNBdSTJG2q9fHLU50KVJHA4Ed8gdUeCJSxQMsTuHs4HLf1+8dYUnkfvbRL++0aXnNvcPCxS9MMDY2hbHf4tNrtwid7WNVp1yLizqWcIPK831TvtvtqU68eEq9y0RspBPMVPz1V+03qRLGU9pEV077TutpvtvuHWGATtniR6Arml6rr6lSvmpaTGhe3HGemyjptH/bVMXlrzZ1IF5G66/ya64/4sqnI+Es0V5SyJJ3r99W+3q6poxQ2fmTmZ42EbarT+rh9qg/H9XbzuD09rur1+0SDizSIkvngkYZ/fjo9bk8n8t0LZ2KxzD7kKnZ72D8ejlX9frU/7Kvmy63q87HaH+rT+enp0IzdqToXq2O6xrl+f0h6vuYE1FVM0Xb6yrS9gL6MPd24a7rBtcmn1Y7pthuEumHJtGWsZXbK3q7tv3oNQESfqhua7GUI7/4RRsppWsL/7A/14dO+Sl+JK+M3y2zAsez9oX44rvZ1takP4JXHPbAo+R7eyE/aioqHrSYt0yRJ4R+balfRzlrGb0CLad+wQhKbo4LXZ746TOcn3dzL2imOvP1X5b8efIb4LWvJ65Terk6VUefjrj68/VJXaS+nRDQCa94IEQk8vP1ntU7HdBWP6Zr3+d7uDusPp/pwTJ62iUq7DjrdLN2F7n1c5nm72/x+ro5fDk+9yVsTs3cVrXju6iXWqwcvI32PTVaXq9NyP0zzNerD5XWmrzGeazFnqZ3A7cN2n3yU5uzJ9XHveb7fSkOf2MS28fqSVtqpPpIhRiodS+M1lfU2HTdEPG1i9j7rXbVK+7DIkKJb74husajaZYXpFhFNRHQ7s+qmWF2Ld5bno+vd4ZR2KfE8th2KRLcGa03qRgghLsu1zsZuMWQupsluwtstZp1uaznTlWF2T+vDJrXVqbjL5w1X68Pj0+pYke/X3B927ddK5ssLoh6r02n1UNXbx2aC+PiUyo36/ObCKK7cc01NLISKXYzXhK6impe3zk57ynggmSz78byrt+9Xp/d5+dHrldNew2b18PR2vd28Ox4ee8NHIeLp4T3/uxHBp/pYrR5TyfF89p7rXPvNttfXN4jj6gSd+5tuOleKyzYB98Xs323J6qiMByrXtbSuozC8cTUIPqeDoJRR160Ut6nuT/XxvK7BUCXjObbujLWK+/FayR+qL5vquP3o54ZPqzpZjTTp9q7DIXPxlBd9bpYlm1W9enc4Pq7q02n9vnpMJ41GxwpvfRav8Ol4qA/rw2592NfV5xoptbFS9kfmKG3+gDSaWCO7VQxp9FpW8J26WBlvJndRRpYHQsS9Zzdw3XdDm+7GNNv95NqhVHQrMmUuG47d9mK3aDLdRqq5/KXbH2yyVAcH7zZJ3f1lD6hrn6IbCbsdYXcp3G1Buk57E3EbuotufC4LdqNs/IgMK8mkw3Vbl4o7BvgN8HfbXZ0u95ocf9F8lO0ojbRmSwpJlLFEZgs7Vr01U7xOvO9mWe7ykds3oO/vu2/b7bYXl0/a9VndZ7fdlKzJDdUuuXgz5mBgZqNK2mhY1syVaCsxt/ZvLjqNZjrMD+NlbuDOXBEvl4Vm+k0Q2OwqAYkm/kSG2XkHidvNsToddufmsft72zpeG5bMZUiQ3MwSkm8Td06aO/O4iAJLQllGTUYzF65Bot8XSb6yiqcc3MWAl3V49+5U1XA225xajqYZzPHGSz1Wv5+rE7HRxDZO+czH6uNh3Xdt5WKBU1z7sjGYNpX4gzB316/ySPd1H7c77oonEpZOKe/j9cqkvqaVhh5YxpsI+n6K1Iy/xJsc3NnC+XhKx24Z+cmFK166Z+ZGWjN7S4eTyFfaUUB3a1TN3FNohNJl2n2MzzoyqxXv4RuB1b5Zq22O1fpw3Jw+Hbd1t8RMOE2sRvI+1XUGm84A4jW/vbyLDjpr3m5GND1OpMcTAcH0+0bWiWzLFvEap7CXvYnLP7qBm4mZvA664xf3SK1cpttexD1UNYCq8W6aYE6HLiJ31cdqlzaseDtNTHipjbinM7QwRhYTGhVYOscbaqLbCRLMbdPNqq7awTzpBKKpULfdVdhuIq54o2Uju/r8tD2SzVMZfR3TdTGlYHcCVQsmUqGRxYa5w9vIejq/3W1P78njx9vkXYyG7aIbuh05bdieVZ0Ox9QB4l0K0UV9CG7rf5vubkeyHNeoqun3nnar7T5s+T6tvuwOq/SlxhhYW2ZL70cSNPn8r4sJZvCEJ+ZbOuuI54FFt55o7joL/2CSrg62EBfSsV92a0zTBZF0C5KSyekvSnrzxSbfXtT6L8NgN3x1qyLbBdTYrulZJkxudJOVWIx+xCUWqvNu1SlvLmRtF8XdznG3WnfMWWNQXn2s9vXp7Rc6Ysf7qpcddWafmt2BKuKdEmG4XtCJ6++GFPEOk+imLIqJxL3katWstXzTavqYdRsRsz3sP1Rf0h4xjrQxzNCdoGPz5J+h+uenD6n58fjC3JBMJX6ovqQS4w7LcN2wkfih+uK3nt5/2LxLJyuxS7K7l0Zkzsa4XV3i9ARzvkYk97e/4w0CwVzxtFK9B1BzbbzyZi4b8SK+SVQWBexwm1OIMqELu3j0M92OmNGX7q/rELt9tFJyP10X1ZKER0Qtt5u9XIIW1SV6kfsN69U2mbwVIp5vM3dgNmmfpWMZzRlupgy/OfIxXZnGLs+Tc37ahaAgPP3TcQwNk6duPqUhWjZu29zn+7Tvo5HoPU2RcqrpCOnipuaY/XkTR3EkO9FxXJco2UZ5QX0EGg8KzC2Kzaf9dl9Xx3erdeXrJrQnjp5gMpnNp/1jVb8/bPrSbCyN12Kq9bY6nar1k9DmQ5FuBERfUzEbYCoORpXG0QRMX0ulwtDSOKqAGbFVbYTWRbndf1ztths6gsYxhpK541g9bokbx5P8bhbF8+awMZFuzah4WaZ5/cd12hGLsjGHKC69bBfbzdw5uMqGYboy7puU47WXq8zt/umcfmUTP7/r9k66qbo2U61+Oh6eqmOdjMpx3FghJ0k8fXl8rOojmeqlNDbe5GRudlS/n1e7PqKJGxJzzujn5I2TNuGvvaFEx+7qmPObvsgmHvGpAl1xvOMumYzfi99tT3VFIxzjqGJmi/KyDsmAFSPddjYzSVZ/sygOxnZc//Frpd4HiWPC2hY6wbrT+S2c38VBMkzMW32u1ue6Ou93zdbo217EiSyj7kQzFwfV55rGsavEtC7MyjAf+nN9XK1rMndT9zHVs7znfVfV6/d9zKOjAdFMEeU3Mla7eJM5JQGRG+qCNyZ6wfvqU9X4TU5uvJfPBHCgo0m4QuuI3daE6ELnbHeYyXaB15Y5Zwgat/v17rypTpcNufapUowQt1fmPnwq/rwfVhAHQTBbb1BAAk4jMZcjVF0sEnMDiULQeD7GPCmEw7jikUMw0afHqL3Y0ELHKwdm3OpD05evdv/8dPpYHbfvttXxoaovK+T9oX53OJOOIQ5olfe8z9JX0870II0r4hW0vOeNKEHFAP/X8Z5iyZxFQqnQaB3DupI5pHbiN9vNh+rLU3U8HfYJrNMxPimZ3VEntfGTXH/UZGeKPJjneJ1g3x33I0yapFWRzGlvuHn+1TYlx/G835aXKCJekyWCj6tPqew4TIcZt9yJbKnkyce4p04g4jcwT+qxSrf+dQxpSmYMKRXazkDeEp+Vsbm8fqyTjLw1jjVzzP3xi7w2/q6dsKccONUSMxbm0p9qOcGQTx1Hsztmx94T3XeLOILZMXc+OrHta+hjBB1zNsfELUQqMDXevWSeZiNCM76WDJlTxo2LYOAK8cKLuaPohW7XILQg7r+YG6mpsGP1tEteZ9zLSu4XIng63n67HNm+hEl258Qde8Sv8anLeBtCs/vYun8grblzPEKMbEm9kwnxaoHdaOr1+Xis9rk4rrghMoOVH5pj4/XxS2qejAGH7uIhNTMkoZHpF4bp/ni83dF+VubeYXMMI6xswNIjDsBiz9jqD+SBy3hlxOSPD1Ud1kWgtak4AFezpyD1YbfJCYzXWOy+q27OsuzrNkjYT67fwYhhFUMiywySuMynyaZmc7vV1RXZo3oN8ZWKF/2WPZDXp/XhyU8Tn6qjP4PcxI42XW261o7jOZghd43wfihgHHCl2cNrK2lD/TGOQ2Uiu4fj6m3au8aLpsv5Mia19vPgZGkQwmF8oE1irIjDNyS3d8XiwWFxEe+sSObuQkb8/lB/qeqQLyPVER+eLphugHU0Yawf6BuKT0pxVzo98Re+g47qizgUVRZslyE6AvLBCuJ91YI5H+kpuB74ftfs7+3J5peIo0slM5/GkBZ0rFzEIc+yYPbOXl7aKcfzPqMmNCwyq4gnpoYZpeLl9I5IxQF/hgkq3q9O0dIhzXOkdEzpmbzm/aYXMRETKuZGq5eSxuK0Oyvpt4ynocyQBCoi3lwKVS6ZibooPNNlbDDMMOIgPNmsixdgl/gnJl/zQtrnD9HUTawfIksinlxK5lZ+X/zH1e5c0bRXIh7lJHP+G8uOjd7uH6vHw5EYH3eVzDN+vm47dPh/r97uKvxq4k6SOUdu555tz/KxoqfQ4mO2RfdZFXMGkJvYiqQ3Z4pqh4eUS8TE5Fm7hR7+W3QH5YoObRaX46vdGqzsoudLZre0PcXpqJJOICZCRXcAr+gSdBXMVf72VD01YXTH1e5D9aU59ntsoH06f4r3i5Vjvr9TfpURv8XurWnmLHl7apYJZLIYrzeYGwbbU7M6IHLieSL7Bea2HFQMvi0TdzbN7mFfbd5+GcqSEr/ADuVo5ibiVUM+hUkcyKO7OGfNXC1sT6d6daxPn7b1e3RGMX4rzCD6f34ix8Di5RtzAPznp1MufBoNhHHIq2Qy/45afLns+5/3l8P+6+PHdJiM0QXTO2hgQrx/opgbH8k0AMTQxnsAgrmG+1B9wRErcVKDQrENHAwniQE7cyOvLzL1pzjwVjFxxIfqC4XW8S6F60Kzu3+4S5I3Zg/6ofry2Oxoble7VE0cjcLM8IeYSTxt15eke8yUVrstiZqKw9i6AZDZYTyu9quHZhf/dH5s5hr16pRGdcUIXzC3uR5XyXQx7jILZgDF4+pzd8rKJwRslj9vq/bsWRoxFgeIMmkG2lVOUoB0E+R26tzlQVPdX3R3uF13EWDmcrZCXLyvy2/VHdG26kL8u1BrZmxbazDdfI3Pg12yerbamSvOVrLf50w74fi1ThHlNznD9Jv26/HeBDPIvENjadxm3A8xzy52gvrDYny4hAn3O2Fg26HdcGiOBYSVaArN402B+0mfiJ6IipfszO69k3TdSOwtk3V8tKKUzF4kh1pVPPs3zJE2kZa83Her7Y5sSMXzRsnc108UoC3q5KD2dJHg9LyK4aKZ6PteaI9axbFfzAiyHLxWcWs3E92yETb6leJtKu4QEMnPdShxa2Ie+I/Fom8fO+y0VtVIhJ8+3nhi7mfGMvtfPvalmfI8LEv3x2IHnSy0nXx7VAG+fzzhZq42B4MiZDwvURPtvUgccdsiXutIZoKTnhJ8iicJjZzWy14kR1Gw5/328WlXNeXpM8SDLjNpQk8TaCjxdipzqdITi9KMxBxLMQFmT3CvyegkSGmS0F7azWi20M61mGEIsUQQBx1Tb+YWfCwRdj3JDHFaV5GJhk7mXtO+eyTx/Wq/2ZGo2fj5J313GEWQnhRqZ+vdjLzbLuxm5kWX9q7ofhLdWVvV/UV3++a6y3VliosDdHP+8rIzecly22VM7s5cW+bZgwCw0k2yePXZSrvckdA9ge4errt/oezyX5ZdhHjJda9tegYm3vbkDrfb/fZxtTvtqooEecQMgbk9vm8SeOy2/6rA3lZ8dMZ2O5uWuXQJW1IwAXC8/8rMNnDYN2mK+mHhcUQcr+U050KSPZ3oA3R3UIjuv53ndjve4nKZxOVkeuen7gLRO29x3QLSMTvzXgptGYeCayaL9FIuW3YgpYKMnU4zgXYqtR/iIONNA80ES09NZuN+ErT4HF2Xk4+Jk64S+1mF4u1F5q5YEiFDwzDiB2auFoM8mj8oztTPnLg8rY4kjW+MicX9hVR2uRXK7gx116mZ7sSduaQZ7hiQ6XZgbJe40Hboyl46SebZE29oL7FtfIaVGQLUCRpMaytiXCuZPVUneTSprYjXdJK52e+lw2Ro8eqA+9kvuwyXxLMhLqof9R8fsCiZmXiA+PRISZz5r2Ru7FyF9k8zxWGihpnGicijab50vAwomUMqkUlaejwvV5cUPPqyLXiJTe0mMV1js91sxjJn3XE4Wt9j4ry8hhn22pPYe1/xpkfJ3E+KpXaJ+fofImotJZNTD26jxf23nOp8J7R5qGIEbpg5SoDMKCljFwvemN+GHSDNItkdZ+aBzmpuvy1bdxxAMP3LdDK7QMp2KwmrisEjMw0aUOUVJHkgu1/q1QOMSIvHQ8kMQR9QHHIWn/fV56dqfTmkkWpMouhn+9JV4+Gpukw9no6H99u329pvgjexK9t0Vi2SHCbzW0einfhQvUqDL5Mgf+ZBxTGV3R/xN403XphHL9FxnXjvzDGZ49Nh11tdxwfrmEGPjZhjVR+/9JdvMXsqmaypEdes1Q9nkvbWxrKY3nDY7c77ers7ndfr6tTAESTZxZKZ3wAmiFJxdJ7uElHrLn22Yy7orsLBYlPFAVi2ywLumJt210RMIKY73v8yXCciAs97T4gbAnteVzCBhYihlJRL6OmxfhGfqJJMQtXXcQ0OOR9JDHV8PlByF0sXBfWBuk6cIcMywyaejofGrcHGaxGvswVzM+naI6ezlLh9MK83glOTeHnZJUe57+7W7KaaxSV7ebchUXZEvGRmoOyUp9d6rdtI6TZUIP2Y8fSBuQU6oOV43lUndORaxBujkgmloaJLAqvjYdccqts+bSsC5+PJtWTGM0Jd2/36cDxWa7xtIOLj0pKZxXRYD07yK+JtFMldWw0qim+KSFXF4zJzBzujKgQC+8lWqiKezjH3WodU9IKX45WAvKXp+GnLdv/QutrhuIG+He88S+blCxl9n5uYHhT1F/chUnN7XaRju8/qiDsD7j4D1uEnm7jVxHxWMqPih7T4Pic9cCri6Zyc2HPTAyar5uun0uM2wl28I+lhD7HJgjPeMFWS2PCGziYo7Rw5uuznIbj4+v0qBRsinidKZk5ArLr9I25FcbfAPHwBtTTfq/MNOD7E20qSSS2gpuayk3w/F2+aSObdGuTaoHRmE2+1MkPjOnmZ9McJMZkmsZczN47+LC7BgV3uTd0l4ywndl6D20jxjSDcRWQrl7bqIp41iC5MUXdXrOpLGqIuhtR25yssM6HkRXO/w4rz7BfMw02Xs1wp142JSzd/NMxkecOZJf7/yq5ly1UbCP5L1lkEJMDOr+Rk4djMjHN9YcLAzZ1F/j1HiJZLUospVsmcnHRjHupXVbVF5aaWXL2cm9QRH6gHXJHKNoptSQ4vjr1zH7TYgL1HQ4KYdjy596jgCMMpiUTKHW3ni8+vvYKG4y+Mi6JeU+MQ1ZALrL9wuZ2k40vsCAMs22zddzS+FGoUHH+Y9ljkK/ha3l2Xauc+YsQj6ZVFlyEIjS/ee+wKwx6Jpyy78q+hD+RZXoyKX4YERRZdpSs+akSoGBJzVrTuImseUZG3ZNg5W+ZCW8iC+qVsazszrGGM8OVtSYGI3PJWfPQfLk279e/zW//z2vcJ2r/Gsbhh51S5s/HR38a1ju9/3t1qs9f7jz4Tya+Rm2JI8YKywJDFs6tjJ8mRuRxUgvqoFTvljWxqLwtqhbLDgcio9qLgx9mR2gGx1QzWd8KYys4RIpPL8NxhHj97/NhJbdcwe/h8jzu7SOyq2A73tAwJLB3bw2yBVJi448M4sxWPKpGCiJBGNiw3IjZ8YhuUYlvti+ObQ2qJqRIsBtdeWJKuGiyl2kIR9IdMRcSW0iVGAJuQik8k6ljdyoNk30rwYpWoajaiDNCwlZv40BctYuiq2WRQTJZWLSK5i424SyLNhQy2OiA25f00YTk5ly5kx7rBbp8NKgsCujyRH9dqV5GbwpNDJkJkJ7Z0EuPRRr632/Hr1nJlzAEsK8lO1HQZborQaoO38kzOvbyt61/j9PF2qZs2wW81+PzPpLCWt3kfkmkiYkTIZoK39MQizlPyjjfYjz6T3JvNqmIMBzrk2eGN6VJs2JQ9k4pI02V47a+Okj+lUScaZfPGFCwtCqOSzzQhPVXY9KtFHcLKBpUTWT6oDbgK+chVWOBIplI+F04XIWOiF8LsE+rI5VOKhLPBIY8VfGVH9mg2g7Figt/g5dY53db8uh8KUk8YQg250GjHo8NFqm6wviaxoDtunoJMwy2GGuvesWVBoqt3vLseQnlVWt1GYpaHHuK2fWQYZSr05O47kau0nY29VUN2a4s6qRZx3h2JHIisfcVBxGzIkBCIyIFSKJ2j6MzlPJFNrU5CvnxHDveC0Xgl1y7MAf0Ykjm/+cl5zxrEVwcd1FgMGVKQ4ZBfBzDMtP2wAW1IpYWiV//wIq0x9dPHgYYhW9RFpz6dmwLJjXCP5x5ZiBXdxxA/3R+edCQiat/fLsIOgTCGzgIYd64TpLvEM49NYbxLac8O15WvF2vB9K/fkxSixmrfkCJcm6tIXYgOxkiKMaSiTdlhKRbjfjFDMlvKXg6GYuyWGRKJVXb+RSTGlqshuxabs92RIAI5yUpQzMaz11SLaBfUgD1BQ7Z5E7fuqyr4VOHY2N0zZKFakkyvEP9bs5URGPMzFF+JhLbFCjtVcCYotGVIvjE6827CiN+HswKWGvtGhmxpoS8trcFag4SyoUklq6mwyqhJwDDaXKlJ7O3Hk4zkEqOvrM+Msi0VCU/LDGaNE5QXqI59yZmCxymi4x96CxgBD+zAGlLtDsxr7xi27kkYHlhUE2ck+ZOzYTCZP3XcnU2i3iJ78zINvafqvScIK8QEG1LvMDBm3Njwo3CSKkNFrFIsiTzY2xJhMYx2x8r2L2QxcKlQdayncUgWo0aovSHF0lJHR05pJOBacvaX+tPA4ChZXh377vdkOCwmL92xcqmswlGhAnpFIuA2q/viERUKk1dkK7+4Bg47NvbYabca87s7gtT563SfP5/veykzxiBj2UbwF16F7eaJ9aqSMEYheywxKrr9Pk79/HYZxqFX93DVmGFYcg9X5PSreIVPkB0kgH2f7Tmw+mW4uX+slOt5uTwen/3P62P5SIX38eSy7HBA9Xh1ReJN5A/F67qPL/VqfotE4I6/qd6rhI6MN1RjCLTs8CSzH6Clwy2qsPd/GgoBkdsS0LU8NeVTM3haWBKKkNpeH45qHMMtqfcVGVcjY4VmKxLVh2afG3KWYQXL9rd8oYBBjKslaYKJFxSf1nDQBtVPLYmGSHz4fTXrX2XagsEpjD1Wc6ym79+/LzNKsF/f3DgqcYJHDckxRCdaVI+mvqJi2xwL7964/7Ld+3of3qf+x31c4ukPaiFbklFf8JAv5DWo4G9JoRXF+ib8uvMzUM7fkvoriiOtD2FQyd+SUkWK7TwzN/icLanir1nOFW6QrmqPzfJWy5o0G+bMDcnEj2y6FtpluHlFffXsxCmnJaW/0cWabcS9umX4Noz/DspZh/KRlhTfKDjbcYKHHSl9iU4cTjQ+GzCHPjZ2E4M/3EaM2Cimz8caVqtRocWHDBCyQv1B46lJ6qHuOtydTBiUibWkTCznbhjn++A/wF0dK6TxW1ICc/cK3B9b0qj+ZFQXsqS60K7Dp4x7Ka1CySFLglF3XQoSooTSNChMYklhkql/dWOQOLtC8lkdVtqQwPhN0STh3COYqaVL0tVSovONHOa22dKBM/0arybzBUsoS0t3y/LJaoOw5jNJdxRD6emGbcyK/kpAvD6T60SgkDdQk+ofuV1FtBP3A9JJ+Tx9XsclgQwhmaamW19BYSZ7vCgSTLIuUsYYznMrNvEZxznDylYIOazJly3PlyqsHCrhqzWkYM7WN40M4oS8JuOet7OdVeN0uXkAwuUhVYLO8jEoZGTJ9Cnx5TodSSvFoGiRJZkdiVn/p1pCoU6QJfFrifVlcAf7cnnKARXvEOZKJJw/X/SGk6Y2CJ+JaOu5Dv9CPu7++l437bcq7o+Ck46czgdL33p3B7K5lUHJIEuyPTejU3x52P86kf21YKl4eZhEkYfox9u4PELXJ0TxGPqF95J97PfXWIcTG9ZNHWihQmWV5Vwn2dNxIhsPa1KXiJ3AzW3J8SjUCvFl4yYYsjxQipzYZrQPhnyNdnLXCqVNall9YkXQuJE1yK0ovrTh/p/l/ssKlU5YB52ofXbkgDYvcisU6ql/C+qrsrlOcLdWRJIbkRFtRKq1acO1C3BfUPatHBRtLf/pHGSe5dfI29TJ/9UFAK2cPF0bFKAFrCuU8S6wZOSmnkgYU8pNRChURTYSFE1muJ8nslvjZvC3uxN2SKn3qBAmoGqyP1baCIl4YXJo6orQJZnF4eiPNOKQ9vP41+Wjb+0yxf0hBJJbkkwTLOaK01gokimlF7hIMgNEQVRkK1ed92KtLrIBVnTNTySeGgd42WAwEl7krjSrHLAtIjSfKpxRQsdpyDuaL8JCehOJyvWNrux8ht+6XSYJ25k3SdTX3jXS0o0SWH2fSGyiY33ERwAaIfuoivJehRoENYmdCBQUBdNj8Ku1ZMY/j9HhEdF3SAPZ91khC7wmy915/PsjPh0rlLGoZVuAlRDRhOAjvL22lrgkK746iXidkM46EVjrSFj1PHrl+/gH4pWRhK6c8YqfIzkEWx7328uqaxHv7sDm5ImkBizDugN8Ha3kC3SwqmnJA2eZ7nGBjTuTSNGGZXqAQpCsM3A9huhdR4VDS4Yo3XRSYEU7w9g7OT1CfVgyi104UjBRen2Ah3ZT75UHOmf7svNmo0X6SUf2wsRpjNqd+pd+lbq/PELnMS5QEAxDFsHiyn34eSfD4titIckXYjIhNVvM9zvJUU8kgkSMbt+KegMqpIrUZIoaixHHnw52Rkn8WDAHVMo857HY9W5JrJuYVjY9I96/JhkNwZzKqMRx8Yks+LJ5DQpTkFhsv6ArbhIgZlQ215xI7Iq31/+zXB73+XN8SWflCQDOIP+mOeRDRRAZxNs0pD5DjvRCcrBl0pQ/f/3l/f7eP+5D/8vvf/z533//A7KeTOBEngMA"; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 000000000..9d619a641 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1448 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +*:focus-visible, +.tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +footer > p { + margin: 0 1em; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} +a.tsd-anchor-link { + color: var(--color-text); +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; +} + +.tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; +} + +.tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-navigation .tsd-nav-link { + display: none; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation-section { + margin-left: 10px; +} +.tsd-page-navigation-section > summary { + padding: 0.25rem; +} +.tsd-page-navigation-section > div { + margin-left: 20px; +} +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; + vertical-align: text-top; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} +.tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; +} +.tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/classes/AllowAllTenantGate.html b/classes/AllowAllTenantGate.html new file mode 100644 index 000000000..c36acdb5d --- /dev/null +++ b/classes/AllowAllTenantGate.html @@ -0,0 +1,5 @@ +AllowAllTenantGate | DWN-SDK Documentation - v0.4.2

Class AllowAllTenantGate

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

+

Implements

Constructors

constructor +

Methods

isActiveTenant +

Constructors

constructor

Methods

isActiveTenant

Settings

Member Visibility

On This Page

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

Class Cid

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

+

Constructors

constructor +

Methods

computeCid +computeDagPbCidFromBytes +computeDagPbCidFromStream +parseCid +

Constructors

constructor

Methods

StaticcomputeCid

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

  • Computes a V1 CID for the provided payload

    +

    Parameters

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

      the codec to use. Defaults to cbor

      +
    • multihashCode: number = sha256.code

      the multihasher to use. Defaults to sha256

      +

    Returns Promise<string>

    payload CID

    +

    Throws

    codec is not supported

    +

    Throws

    encoding fails

    +

    Throws

    if hasher is not supported

    +

StaticcomputeDagPbCidFromBytes

  • computeDagPbCidFromBytes(content): Promise<string>

  • Parameters

    • content: Uint8Array

    Returns Promise<string>

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

    +

StaticcomputeDagPbCidFromStream

  • computeDagPbCidFromStream(dataStream): Promise<string>

  • Parameters

    • dataStream: Readable

    Returns Promise<string>

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

    +

StaticparseCid

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

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

    +

    Parameters

    • str: string

    Returns CID<unknown, number, number, Version>

Settings

Member Visibility

On This Page

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

Class DataStoreLevel

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

+

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

+

Implements

Constructors

constructor +

Properties

blockstore +config +

Methods

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

Constructors

constructor

Properties

blockstore

blockstore: BlockstoreLevel

config

config: DataStoreLevelConfig

Methods

clear

close

delete

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

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

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<void>

get

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

  • Fetches the specified data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<undefined | DataStoreGetResult>

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

    +

open

put

Settings

Member Visibility

On This Page

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

Class DataStream

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

+

Constructors

constructor +

Methods

duplicateDataStream +fromBytes +fromObject +toBytes +toObject +

Constructors

constructor

Methods

StaticduplicateDataStream

  • duplicateDataStream(dataStream, count): Readable[]

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

    +

    Parameters

    • dataStream: Readable
    • count: number

    Returns Readable[]

StaticfromBytes

  • fromBytes(bytes): Readable

  • Creates a readable stream from the bytes given.

    +

    Parameters

    • bytes: Uint8Array

    Returns Readable

StaticfromObject

  • fromObject(object): Readable

  • Creates a readable stream from the object given.

    +

    Parameters

    • object: Record<string, any>

    Returns Readable

StatictoBytes

  • toBytes(readableStream): Promise<Uint8Array>

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

    +

    Parameters

    • readableStream: Readable

    Returns Promise<Uint8Array>

StatictoObject

  • toObject(readableStream): Promise<object>

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

    +

    Parameters

    • readableStream: Readable

    Returns Promise<object>

Settings

Member Visibility

On This Page

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

Class Dwn

Methods

close +open +processMessage +validateMessageIntegrity +validateTenant +create +

Methods

close

open

  • open(): Promise<void>

  • Initializes the DWN instance and opens the connection to it.

    +

    Returns Promise<void>

processMessage

validateMessageIntegrity

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

  • Validates structure of DWN message

    +

    Parameters

    • rawMessage: any

    Returns Promise<undefined | GenericMessageReply>

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

    +

validateTenant

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

  • Checks tenant gate to see if tenant is allowed.

    +

    Parameters

    • tenant: string

      The tenant DID to route the given message to.

      +

    Returns Promise<undefined | GenericMessageReply>

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

    +

Staticcreate

Settings

Member Visibility

On This Page

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

Class DwnConstant

Constructors

constructor +

Properties

maxDataSizeAllowedToBeEncoded +

Constructors

constructor

Properties

Static ReadonlymaxDataSizeAllowedToBeEncoded

maxDataSizeAllowedToBeEncoded: 30000 = 30_000

The maximum size of raw data that will be returned as encodedData.

+

We chose 30k, as after encoding it would give plenty of headroom up to the 65k limit in most SQL variants. +We currently encode using base64url which is a 33% increase in size.

+

Settings

Member Visibility

On This Page

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

Class DwnError

A class that represents a DWN error.

+

Hierarchy

  • Error
    • DwnError

Constructors

constructor +

Properties

code +

Constructors

constructor

Properties

code

code: string

Settings

Member Visibility

On This Page

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

Class Encoder

Utility class for encoding/converting data into various formats.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

Staticbase64UrlToBytes

  • base64UrlToBytes(base64urlString): Uint8Array

  • Parameters

    • base64urlString: string

    Returns Uint8Array

Staticbase64UrlToObject

  • base64UrlToObject(base64urlString): any

  • Parameters

    • base64urlString: string

    Returns any

StaticbytesToBase64Url

StaticbytesToObject

StaticbytesToString

StaticobjectToBytes

  • objectToBytes(obj): Uint8Array

  • Parameters

    • obj: Record<string, any>

    Returns Uint8Array

StaticstringToBase64Url

StaticstringToBytes

Settings

Member Visibility

On This Page

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

Class Encryption

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

+

Constructors

constructor +

Accessors

isEphemeralKeyCompressed +

Methods

aes256CtrDecrypt +aes256CtrEncrypt +eciesSecp256k1Decrypt +eciesSecp256k1Encrypt +

Constructors

constructor

Accessors

StaticisEphemeralKeyCompressed

Methods

Staticaes256CtrDecrypt

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

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

    +

    Parameters

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

    Returns Promise<Readable>

Staticaes256CtrEncrypt

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

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

    +

    Parameters

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

    Returns Promise<Readable>

StaticeciesSecp256k1Decrypt

  • eciesSecp256k1Decrypt(input): Promise<Uint8Array>

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

    +

    Parameters

    • input: EciesEncryptionInput

    Returns Promise<Uint8Array>

StaticeciesSecp256k1Encrypt

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

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

    +

    Parameters

    • publicKeyBytes: Uint8Array
    • plaintext: Uint8Array

    Returns Promise<EciesEncryptionOutput>

Settings

Member Visibility

On This Page

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

Class EventEmitterStream

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

+

Implements

Constructors

constructor +

Methods

close +emit +open +subscribe +

Constructors

constructor

Methods

close

emit

open

subscribe

Settings

Member Visibility

On This Page

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

Class EventLogLevel

Implements

Constructors

constructor +

Properties

index +ulidFactory +

Methods

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

Constructors

constructor

Properties

index

index: IndexLevel

ulidFactory

ulidFactory: ULIDFactory

Methods

append

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

  • adds an event to a tenant's event log

    +

    Parameters

    • tenant: string

      the tenant's DID

      +
    • messageCid: string

      the CID of the message

      +
    • indexes: KeyValues

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

      +

    Returns Promise<void>

clear

close

deleteEventsByCid

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

  • deletes any events that have any of the messageCids provided

    +

    Parameters

    • tenant: string
    • messageCids: string[]

    Returns Promise<void>

    the number of events deleted

    +

getEvents

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

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

    +

    The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

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

open

queryEvents

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

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

    +

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

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

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

Settings

Member Visibility

On This Page

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

Class HdKey

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

+

Constructors

constructor +

Methods

deriveKeyUsingHkdf +derivePrivateKey +derivePrivateKeyBytes +derivePublicKey +

Constructors

constructor

Methods

StaticderiveKeyUsingHkdf

  • deriveKeyUsingHkdf(params): Promise<Uint8Array>

  • Derives a key using HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as defined in RFC 5869. +TODO: Consolidate HKDF implementation and usage with web5-js - https://github.com/TBD54566975/dwn-sdk-js/issues/742

    +

    Parameters

    • params: {
          hashAlgorithm: "SHA-256" | "SHA-384" | "SHA-512";
          info: Uint8Array;
          initialKeyMaterial: Uint8Array;
          keyLengthInBytes: number;
      }
      • hashAlgorithm: "SHA-256" | "SHA-384" | "SHA-512"
      • info: Uint8Array
      • initialKeyMaterial: Uint8Array
      • keyLengthInBytes: number

    Returns Promise<Uint8Array>

StaticderivePrivateKey

StaticderivePrivateKeyBytes

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

  • Derives a hardened hierarchical deterministic private key.

    +

    Parameters

    • privateKey: Uint8Array
    • relativePath: string[]

    Returns Promise<Uint8Array>

StaticderivePublicKey

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

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

    +

    Parameters

    Returns Promise<PublicJwk>

Settings

Member Visibility

On This Page

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

Class Jws

Utility class for JWS related operations.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticcreateSigner

StaticcreateSigners

StaticdecodePlainObjectPayload

  • decodePlainObjectPayload(jws): any

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

    +

    Parameters

    • jws: GeneralJws

    Returns any

StaticextractDid

  • extractDid(kid): string

  • Extracts the DID from the given kid string.

    +

    Parameters

    • kid: string

    Returns string

StaticgetKid

  • getKid(signatureEntry): string

  • Gets the kid from a general JWS signature entry.

    +

    Parameters

    • signatureEntry: SignatureEntry

    Returns string

StaticgetSignerDid

  • getSignerDid(signatureEntry): string

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

    +

    Parameters

    • signatureEntry: SignatureEntry

    Returns string

StaticverifySignature

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

  • Verifies the signature against the given payload.

    +

    Parameters

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

    Returns Promise<boolean>

    true if signature is valid; false otherwise

    +

Settings

Member Visibility

On This Page

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

Class Message

A class containing utility methods for working with DWN messages.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticcompareCid

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

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

    +

    Parameters

    Returns Promise<number>

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

    +

StaticcompareMessageTimestamp

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

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

    +

    Parameters

    Returns Promise<number>

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

    +

StaticcreateAuthorization

  • createAuthorization(input): Promise<AuthorizationModel>

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

    +

    Parameters

    Returns Promise<AuthorizationModel>

    used as an authorization property.

    +

StaticcreateSignature

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

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

    +

    Parameters

    • descriptor: Descriptor
    • signer: Signer
    • OptionaladditionalPayloadProperties: {
          delegatedGrantId?: string;
          permissionGrantId?: string;
          protocolRole?: string;
      }
      • OptionaldelegatedGrantId?: string
      • OptionalpermissionGrantId?: string
      • OptionalprotocolRole?: string

    Returns Promise<GeneralJws>

StaticgetCid

StaticgetNewestMessage

StaticgetOldestMessage

StaticgetSigner

  • getSigner(message): undefined | string

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

    +

    Parameters

    Returns undefined | string

StaticisNewer

StaticisOlder

StaticisSignedByAuthorDelegate

StaticisSignedByOwnerDelegate

StaticvalidateJsonSchema

  • validateJsonSchema(rawMessage): void

  • Validates the given message against the corresponding JSON schema.

    +

    Parameters

    • rawMessage: any

    Returns void

    Throws

    if fails validation.

    +

StaticvalidateSignatureStructure

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

  • Validates the structural integrity of the message signature given:

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

    Parameters

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

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

      +

    Returns Promise<GenericSignaturePayload>

    the parsed JSON payload object if validation succeeds.

    +

Settings

Member Visibility

On This Page

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

Class MessageStoreLevel

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

+

Implements

Constructors

constructor +

Properties

blockstore +config +index +

Methods

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

Constructors

constructor

Properties

blockstore

blockstore: BlockstoreLevel

config

config: MessageStoreLevelConfig

index

index: IndexLevel

Methods

clear

close

delete

get

open

put

query

StaticbuildQueryOptions

Settings

Member Visibility

On This Page

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

Class MessagesQuery

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class MessagesRead

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class MessagesSubscribe

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class PermissionGrant

A class representing a Permission Grant for a more convenient abstraction.

+

Properties

conditions? +dateExpires +dateGranted +delegated? +description? +grantee +grantor +id +requestId? +scope +

Methods

parse +

Properties

Optional Readonlyconditions

conditions?: PermissionConditions

Optional conditions that must be met when the grant is used.

+

ReadonlydateExpires

dateExpires: string

Timestamp at which this grant will no longer be active.

+

ReadonlydateGranted

dateGranted: string

The date at which the grant was given.

+

Optional Readonlydelegated

delegated?: boolean

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

+

Optional Readonlydescription

description?: string

Optional string that communicates what the grant would be used for

+

Readonlygrantee

grantee: string

The grantee of the permission.

+

Readonlygrantor

grantor: string

The grantor of the permission.

+

Readonlyid

id: string

The ID of the permission grant, which is the record ID DWN message.

+

Optional ReadonlyrequestId

requestId?: string

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

+

Readonlyscope

scope: PermissionScope

The scope of the allowed access.

+

Methods

Staticparse

Settings

Member Visibility

On This Page

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

Class PermissionRequest

A class representing a Permission Request for a more convenient abstraction.

+

Properties

conditions? +delegated? +description? +id +requester +scope +

Methods

parse +

Properties

Optional Readonlyconditions

conditions?: PermissionConditions

Optional conditions that must be met when the requested grant is used.

+

Optional Readonlydelegated

delegated?: boolean

Whether the requested grant is delegated or not. +If true, the requestor will be able to act as the grantor of the permission within the scope of the requested grant.

+

Optional Readonlydescription

description?: string

Optional string that communicates what the requested grant would be used for.

+

Readonlyid

id: string

The ID of the permission request, which is the record ID DWN message.

+

Readonlyrequester

requester: string

The requester for of the permission.

+

Readonlyscope

scope: PermissionScope

The scope of the allowed access.

+

Methods

Staticparse

Settings

Member Visibility

On This Page

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

Class PermissionsProtocol

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

+

Constructors

constructor +

Properties

definition +grantPath +requestPath +revocationPath +uri +

Methods

createGrant +createRequest +createRevocation +fetchGrant +getScopeFromPermissionRecord +hasProtocolScope +parseRequest +validateSchema +

Constructors

constructor

Properties

Static Readonlydefinition

definition: ProtocolDefinition = ...

The definition of the Permissions protocol.

+

Static ReadonlygrantPath

grantPath: "grant" = 'grant'

The protocol path of the grant record.

+

Static ReadonlyrequestPath

requestPath: "request" = 'request'

The protocol path of the request record.

+

Static ReadonlyrevocationPath

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

The protocol path of the revocation record.

+

Static Readonlyuri

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

The URI of the DWN Permissions protocol.

+

Methods

StaticcreateGrant

StaticcreateRequest

StaticcreateRevocation

StaticfetchGrant

  • fetchGrant(tenant, messageStore, permissionGrantId): Promise<PermissionGrant>

  • Fetches PermissionGrant with the specified recordID.

    +

    Parameters

    • tenant: string
    • messageStore: MessageStore
    • permissionGrantId: string

    Returns Promise<PermissionGrant>

    the PermissionGrant matching the recordId specified.

    +

    Throws

    if PermissionGrant does not exist

    +

StaticgetScopeFromPermissionRecord

StatichasProtocolScope

StaticparseRequest

StaticvalidateSchema

  • validateSchema(recordsWriteMessage, dataBytes): void

  • Validates the given Permissions protocol RecordsWrite. It can be a request, grant, or revocation.

    +

    Parameters

    Returns void

Settings

Member Visibility

On This Page

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

Class Poller

Constructors

constructor +

Properties

pollRetrySleep +pollTimeout +

Methods

pollUntilSuccessOrTimeout +

Constructors

constructor

Properties

StaticpollRetrySleep

pollRetrySleep: number = 20

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

+

StaticpollTimeout

pollTimeout: number = 2000

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

+

Methods

StaticpollUntilSuccessOrTimeout

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

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

    +

    Type Parameters

    • T

    Parameters

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

      a function that returns a promise and may throw.

      +
        • (): Promise<T>

        • Returns Promise<T>

    • retrySleep: number = Poller.pollRetrySleep

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

      +
    • timeout: number = Poller.pollTimeout

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

      +

    Returns Promise<T>

    Throws

    Operation timed out if the timeout is exceeded.

    +

Settings

Member Visibility

On This Page

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

Class PrivateKeySigner

A signer that signs using a private key.

+

Implements

Constructors

constructor +

Properties

algorithm +keyId +

Methods

sign +

Constructors

constructor

Properties

algorithm

algorithm: string

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

+

keyId

keyId: string

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

+

Methods

sign

  • sign(content): Promise<Uint8Array>

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

    +

    Parameters

    • content: Uint8Array

    Returns Promise<Uint8Array>

Settings

Member Visibility

On This Page

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

Class Protocols

Class containing Protocol related utility methods.

+

Constructors

constructor +

Methods

deriveAndInjectPublicEncryptionKeys +

Constructors

constructor

Methods

StaticderiveAndInjectPublicEncryptionKeys

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

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

    +

    Parameters

    Returns Promise<ProtocolDefinition>

Settings

Member Visibility

On This Page

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

Class ProtocolsConfigure

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class ProtocolsQuery

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorize +toJSON +create +normalizeFilter +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

authorize

toJSON

Staticcreate

StaticnormalizeFilter

Staticparse

Settings

Member Visibility

On This Page

Accessors
Methods
diff --git a/classes/Records.html b/classes/Records.html new file mode 100644 index 000000000..2363894ab --- /dev/null +++ b/classes/Records.html @@ -0,0 +1,54 @@ +Records | DWN-SDK Documentation - v0.4.2

Class Records

Class containing useful utilities related to the Records interface.

+

Constructors

constructor +

Methods

buildTagIndexes +constructKeyDerivationPath +constructKeyDerivationPathUsingDataFormatsScheme +constructKeyDerivationPathUsingProtocolContextScheme +constructKeyDerivationPathUsingProtocolPathScheme +constructKeyDerivationPathUsingSchemasScheme +convertFilter +convertTagsFilter +decrypt +derivePrivateKey +filterIncludesPublishedRecords +filterIncludesUnpublishedRecords +getAuthor +getParentContextFromOfContextId +isRecordsWrite +isStartsWithFilter +normalizeFilter +shouldProtocolAuthorize +validateAncestorKeyAndDescentKeyDerivationPathsMatch +validateDelegatedGrantReferentialIntegrity +

Constructors

constructor

Methods

StaticbuildTagIndexes

  • buildTagIndexes(tags): KeyValues

  • This will create individual keys for each of the tags that look like tag.tag_property

    +

    Parameters

    Returns KeyValues

StaticconstructKeyDerivationPath

StaticconstructKeyDerivationPathUsingDataFormatsScheme

  • constructKeyDerivationPathUsingDataFormatsScheme(schema, dataFormat): string[]

  • Constructs the full key derivation path using dataFormats scheme.

    +

    Parameters

    • schema: undefined | string
    • dataFormat: string

    Returns string[]

StaticconstructKeyDerivationPathUsingProtocolContextScheme

  • constructKeyDerivationPathUsingProtocolContextScheme(contextId): string[]

  • Constructs the full key derivation path using protocolContext scheme.

    +

    Parameters

    • contextId: undefined | string

    Returns string[]

StaticconstructKeyDerivationPathUsingProtocolPathScheme

  • constructKeyDerivationPathUsingProtocolPathScheme(descriptor): string[]

  • Constructs the full key derivation path using protocolPath scheme.

    +

    Parameters

    Returns string[]

StaticconstructKeyDerivationPathUsingSchemasScheme

  • constructKeyDerivationPathUsingSchemasScheme(schema): string[]

  • Constructs the full key derivation path using schemas scheme.

    +

    Parameters

    • schema: undefined | string

    Returns string[]

StaticconvertFilter

  • convertFilter(filter, dateSort?): Filter

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

    +

    Parameters

    • filter: RecordsFilter

      A RecordsFilter

      +
    • OptionaldateSort: DateSort

    Returns Filter

    a generic Filter able to be used with MessageStore.

    +

StaticconvertTagsFilter

  • convertTagsFilter(tags): Filter

  • This will create individual keys for each of the tag filters that look like tag.tag_filter_property

    +

    Parameters

    • tags: {
          [property: string]: RecordsWriteTagsFilter;
      }
      • [property: string]: RecordsWriteTagsFilter

    Returns Filter

Staticdecrypt

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

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

    +

    Parameters

    Returns Promise<Readable>

StaticderivePrivateKey

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

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

    +

    Parameters

    Returns Promise<Uint8Array>

StaticfilterIncludesPublishedRecords

  • filterIncludesPublishedRecords(filter): boolean

  • Checks if the filter supports returning published records.

    +

    Parameters

    • filter: RecordsFilter

    Returns boolean

StaticfilterIncludesUnpublishedRecords

  • filterIncludesUnpublishedRecords(filter): boolean

  • Checks if the filter supports returning unpublished records.

    +

    Parameters

    • filter: RecordsFilter

    Returns boolean

StaticgetAuthor

StaticgetParentContextFromOfContextId

  • getParentContextFromOfContextId(contextId): undefined | string

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

    +

    Parameters

    • contextId: undefined | string

    Returns undefined | string

StaticisRecordsWrite

StaticisStartsWithFilter

  • isStartsWithFilter(filter): filter is StartsWithFilter

  • Parameters

    • filter:
          | string
          | number
          | boolean
          | {
              gt: RangeValue;
          } & {
              gte?: undefined;
          } & Partial<{
              gt: RangeValue;
          } & {
              gte?: undefined;
          }> & Partial<{
              lt: RangeValue;
          } & {
              lte?: undefined;
          }>
          | {
              gt: RangeValue;
          } & {
              gte?: undefined;
          } & Partial<{
              gt: RangeValue;
          } & {
              gte?: undefined;
          }> & Partial<{
              lt?: undefined;
          } & {
              lte: RangeValue;
          }>
          | never
          | never
          | never
          | never
          | {
              gt?: undefined;
          } & {
              gte: RangeValue;
          } & Partial<{
              gt?: undefined;
          } & {
              gte: RangeValue;
          }> & Partial<{
              lt: RangeValue;
          } & {
              lte?: undefined;
          }>
          | {
              gt?: undefined;
          } & {
              gte: RangeValue;
          } & Partial<{
              gt?: undefined;
          } & {
              gte: RangeValue;
          }> & Partial<{
              lt?: undefined;
          } & {
              lte: RangeValue;
          }>
          | {
              lt: RangeValue;
          } & {
              lte?: undefined;
          } & Partial<{
              gt: RangeValue;
          } & {
              gte?: undefined;
          }> & Partial<{
              lt: RangeValue;
          } & {
              lte?: undefined;
          }>
          | never
          | {
              lt: RangeValue;
          } & {
              lte?: undefined;
          } & Partial<{
              gt?: undefined;
          } & {
              gte: RangeValue;
          }> & Partial<{
              lt: RangeValue;
          } & {
              lte?: undefined;
          }>
          | never
          | never
          | {
              lt?: undefined;
          } & {
              lte: RangeValue;
          } & Partial<{
              gt: RangeValue;
          } & {
              gte?: undefined;
          }> & Partial<{
              lt?: undefined;
          } & {
              lte: RangeValue;
          }>
          | never
          | {
              lt?: undefined;
          } & {
              lte: RangeValue;
          } & Partial<{
              gt?: undefined;
          } & {
              gte: RangeValue;
          }> & Partial<{
              lt?: undefined;
          } & {
              lte: RangeValue;
          }>
          | StartsWithFilter

    Returns filter is StartsWithFilter

StaticnormalizeFilter

  • normalizeFilter(filter): RecordsFilter

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

    +

    Parameters

    • filter: RecordsFilter

      incoming RecordsFilter to normalize.

      +

    Returns RecordsFilter

    a copy of the incoming RecordsFilter with the normalized properties.

    +

StaticshouldProtocolAuthorize

  • shouldProtocolAuthorize(signaturePayload): boolean

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

    +

    Parameters

    • signaturePayload: GenericSignaturePayload

    Returns boolean

StaticvalidateAncestorKeyAndDescentKeyDerivationPathsMatch

  • validateAncestorKeyAndDescentKeyDerivationPathsMatch(ancestorKeyDerivationPath, descendantKeyDerivationPath): void

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

    +

    Parameters

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

    Returns void

    Throws

    with DwnErrorCode.RecordsInvalidAncestorKeyDerivationSegment if fails validation.

    +

StaticvalidateDelegatedGrantReferentialIntegrity

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

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

    +

    Parameters

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

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

      +
    • OptionalownerSignaturePayload: GenericSignaturePayload

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

      +

    Returns Promise<void>

Settings

Member Visibility

On This Page

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

Class RecordsDelete

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +constructIndexes +toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

authorizeDelegate

constructIndexes

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class RecordsQuery

A class representing a RecordsQuery DWN message.

+

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

authorizeDelegate

  • authorizeDelegate(messageStore): Promise<void>

  • Authorizes the delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class RecordsRead

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

authorizeDelegate

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class RecordsSubscribe

A class representing a RecordsSubscribe DWN message.

+

Hierarchy

Accessors

author +message +signaturePayload +signer +

Methods

authorizeDelegate +toJSON +create +parse +

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

message

  • get message(): M

  • Valid JSON message representing this DWN message.

    +

    Returns M

signaturePayload

  • get signaturePayload(): undefined | GenericSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | GenericSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

authorizeDelegate

toJSON

Staticcreate

Staticparse

Settings

Member Visibility

On This Page

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

Class RecordsWrite

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

+

Implements

Properties

attesters +

Accessors

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

Methods

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

Properties

Readonlyattesters

attesters: string[]

Accessors

author

  • get author(): undefined | string

  • DID of the logical author of this message. +NOTE: we say "logical" author because a message can be signed by a delegate of the actual author, +in which case the author DID would not be the same as the signer/delegate DID, +but be the DID of the grantor (grantedBy) of the delegated grant presented.

    +

    Returns undefined | string

isSignedByAuthorDelegate

isSignedByOwnerDelegate

message

owner

  • get owner(): undefined | string

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

    +

    Returns undefined | string

ownerSignaturePayload

  • get ownerSignaturePayload(): undefined | GenericSignaturePayload

  • Decoded owner signature payload.

    +

    Returns undefined | GenericSignaturePayload

ownerSignatureSigner

  • get ownerSignatureSigner(): undefined | string

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

    +

    Returns undefined | string

signaturePayload

  • get signaturePayload(): undefined | RecordsWriteSignaturePayload

  • Decoded payload of the signature of this message.

    +

    Returns undefined | RecordsWriteSignaturePayload

signer

  • get signer(): undefined | string

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

    +

    Returns undefined | string

Methods

authorizeAuthorDelegate

  • authorizeAuthorDelegate(messageStore): Promise<void>

  • Authorizes the author-delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

authorizeOwnerDelegate

  • authorizeOwnerDelegate(messageStore): Promise<void>

  • Authorizes the owner-delegate who signed this message.

    +

    Parameters

    • messageStore: MessageStore

      Used to check if the grant has been revoked.

      +

    Returns Promise<void>

constructIndexes

encryptSymmetricEncryptionKey

  • encryptSymmetricEncryptionKey(encryptionInput): Promise<void>

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

    +

    Parameters

    Returns Promise<void>

getEntryId

isInitialWrite

sign

signAsOwner

  • signAsOwner(signer): Promise<void>

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

    +

    Parameters

    Returns Promise<void>

signAsOwnerDelegate

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

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

    +

    Parameters

    Returns Promise<void>

toJSON

Staticcreate

StaticcreateAttestation

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

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

    +

    Parameters

    • descriptorCid: string
    • Optionalsigners: Signer[]

    Returns Promise<undefined | GeneralJws>

StaticcreateFrom

  • createFrom(options): Promise<RecordsWrite>

  • Convenience method that creates a message by:

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

    Parameters

    Returns Promise<RecordsWrite>

StaticcreateSignerSignature

  • createSignerSignature(input): Promise<GeneralJws>

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

    +

    Parameters

    • input: {
          attestation: undefined | GeneralJws;
          contextId: undefined | string;
          delegatedGrantId?: string;
          descriptorCid: string;
          encryption: undefined | EncryptionProperty;
          permissionGrantId?: string;
          protocolRole?: string;
          recordId: string;
          signer: Signer;
      }
      • attestation: undefined | GeneralJws
      • contextId: undefined | string
      • OptionaldelegatedGrantId?: string
      • descriptorCid: string
      • encryption: undefined | EncryptionProperty
      • OptionalpermissionGrantId?: string
      • OptionalprotocolRole?: string
      • recordId: string
      • signer: Signer

    Returns Promise<GeneralJws>

StaticfetchInitialRecordsWrite

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

  • Fetches the initial RecordsWrite of a record.

    +

    Parameters

    Returns Promise<undefined | RecordsWrite>

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

    +

StaticfetchNewestRecordsWrite

StaticgetAttesters

  • getAttesters(message): string[]

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

    +

    Parameters

    • message: InternalRecordsWriteMessage

    Returns string[]

StaticgetEntryId

StaticgetInitialWrite

StaticisInitialWrite

Staticparse

StaticverifyEqualityOfImmutableProperties

Settings

Member Visibility

On This Page

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

Class ResumableTaskStoreLevel

A simple single-instance implementation of ResumableTaskStore that works in both browsers and node.js. +Leverages LevelDB under the hood.

+

Implements

Constructors

constructor +

Properties

config +db +

Methods

clear +close +delete +extend +grab +open +read +register +

Constructors

constructor

Properties

config

config: ResumableTaskStoreLevelConfig

db

db: LevelWrapper<string>

Methods

clear

close

delete

  • delete(taskId): Promise<void>

  • Deletes the task associated with the task ID provided. +No-op if the task is not found, as this implies that the task has already been completed. +Called when the task has been successfully completed.

    +

    Parameters

    • taskId: string

    Returns Promise<void>

extend

  • extend(taskId, timeoutInSeconds): Promise<void>

  • Extends the timeout of the task associated with the task ID provided. +No-op if the task is not found, as this implies that the task has already been completed. +This allows the client that is executing the task to continue working on it before the task is considered timed out.

    +

    Parameters

    • taskId: string

      ID of the task to extend the timeout for.

      +
    • timeoutInSeconds: number

      Timeout in seconds from the current time.

      +

    Returns Promise<void>

grab

  • grab(count): Promise<ManagedResumableTask[]>

  • Grabs a number of unhandled tasks from the store. +Unhandled tasks are tasks that are not currently in-flight/under processing (ie. tasks that have timed-out). +NOTE: The implementation must make sure that once a task is grabbed by a client, +tis timeout must be updated so that it is considered in-flight/under processing +and cannot be grabbed by another client until it is timed-out.

    +

    Parameters

    • count: number

      Desired number of tasks to grab.

      +

    Returns Promise<ManagedResumableTask[]>

    A list of tasks exclusive for the caller to handle; or empty array if there is no tasks, or if all tasks are already grabbed by others.

    +

open

read

register

  • register(task, timeoutInSeconds): Promise<ManagedResumableTask>

  • Registers a new resumable task that is currently in-flight/under processing to the store. +If the task is timed out, a client will be able to grab it through the grab() method and resume the task.

    +

    Parameters

    • task: any

      Task specific data. This is deliberately of type any because this store should not have to be ware of its type.

      +
    • timeoutInSeconds: number

      Timeout in seconds from the current time.

      +

    Returns Promise<ManagedResumableTask>

    A ManagedResumableTask object that can be used to extend or delete the task.

    +

    Throws

    with code set to ResumableTaskAlreadyExists if the same task is already registered.

    +

Settings

Member Visibility

On This Page

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

Class Secp256k1

Class containing SECP256K1 related utility methods.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticgenerateKeyPair

StaticgenerateKeyPairRaw

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

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

    +

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

StaticgetPublicJwk

StaticgetPublicKey

  • getPublicKey(privateKey): Promise<Uint8Array>

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

    +

    Parameters

    • privateKey: Uint8Array

    Returns Promise<Uint8Array>

StaticprivateJwkToBytes

  • privateJwkToBytes(privateJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

StaticprivateKeyToJwk

StaticpublicJwkToBytes

  • publicJwkToBytes(publicJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

StaticpublicKeyToJwk

Staticsign

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

  • Signs the provided content using the provided JWK.

    +

    Parameters

    Returns Promise<Uint8Array>

StaticvalidateKey

Staticverify

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

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

    +

    Parameters

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

    Returns Promise<boolean>

    a boolean indicating whether the signature is valid.

    +

Settings

Member Visibility

On This Page

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

Class Secp256r1

Class containing SECP256R1 related utility methods.

+

Constructors

constructor +

Methods

bytesToBigInt +generateKeyPair +privateJwkToBytes +publicKeyToJwk +sign +validateKey +verify +

Constructors

constructor

Methods

StaticbytesToBigInt

StaticgenerateKeyPair

StaticprivateJwkToBytes

  • privateJwkToBytes(privateJwk): Uint8Array

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

    +

    Parameters

    Returns Uint8Array

StaticpublicKeyToJwk

Staticsign

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

  • Signs the provided content using the provided JWK. +Signature that is outputted is JWS format, not DER.

    +

    Parameters

    Returns Promise<Uint8Array>

StaticvalidateKey

Staticverify

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

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

    +

    Parameters

    • content: Uint8Array
    • signature: Uint8Array

      the signature to verify. Can be in either DER or compact format. If using Oracle Cloud KMS, keys will be DER formatted.

      +
    • publicJwk: PublicJwk

    Returns Promise<boolean>

    a boolean indicating whether the signature is valid.

    +

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/classes/TestDataGenerator.html b/classes/TestDataGenerator.html new file mode 100644 index 000000000..7342e016e --- /dev/null +++ b/classes/TestDataGenerator.html @@ -0,0 +1,59 @@ +TestDataGenerator | DWN-SDK Documentation - v0.4.2

Class TestDataGenerator

Utility class for generating data for testing.

+

Constructors

constructor +

Methods

createDidResolutionResult +generateAuthorization +generateAuthorizationSignature +generateDidKeyPersona +generateFromRecordsWrite +generateGrantCreate +generateMessagesQuery +generateMessagesRead +generateMessagesSubscribe +generatePersona +generateProtocolEncryptedRecordsWrite +generateProtocolsConfigure +generateProtocolsQuery +generateRecordsDelete +generateRecordsQuery +generateRecordsSubscribe +generateRecordsWrite +randomBytes +randomCborSha256Cid +randomInt +randomSignatureString +randomString +randomTimestamp +

Constructors

constructor

Methods

StaticcreateDidResolutionResult

StaticgenerateAuthorization

  • generateAuthorization(): AuthorizationModel

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

    +

    Returns AuthorizationModel

StaticgenerateAuthorizationSignature

  • generateAuthorizationSignature(): GeneralJws

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

    +

    Returns GeneralJws

StaticgenerateDidKeyPersona

StaticgenerateFromRecordsWrite

  • generateFromRecordsWrite(input): Promise<GenerateFromRecordsWriteOut>

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

    +

    Parameters

    • input: GenerateFromRecordsWriteInput

    Returns Promise<GenerateFromRecordsWriteOut>

StaticgenerateGrantCreate

  • generateGrantCreate(input?): Promise<GenerateGrantCreateOutput>

  • Parameters

    • Optionalinput: GenerateGrantCreateInput

    Returns Promise<GenerateGrantCreateOutput>

StaticgenerateMessagesQuery

  • generateMessagesQuery(input): Promise<GenerateMessagesQueryOutput>

  • Parameters

    • input: GenerateMessagesQueryInput

    Returns Promise<GenerateMessagesQueryOutput>

StaticgenerateMessagesRead

  • generateMessagesRead(input): Promise<GenerateMessagesReadOutput>

  • Parameters

    • input: GenerateMessagesReadInput

    Returns Promise<GenerateMessagesReadOutput>

StaticgenerateMessagesSubscribe

  • generateMessagesSubscribe(input?): Promise<GenerateMessagesSubscribeOutput>

  • Generates a MessagesSubscribe message for testing.

    +

    Parameters

    • Optionalinput: GenerateMessagesSubscribeInput

    Returns Promise<GenerateMessagesSubscribeOutput>

StaticgeneratePersona

StaticgenerateProtocolEncryptedRecordsWrite

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

  • Generates a encrypted RecordsWrite message for testing.

    +

    Parameters

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

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

        +
      • encryptSymmetricKeyWithProtocolPathDerivedKey: boolean

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

        +
      • plaintextBytes: Uint8Array
      • OptionalprotocolContextDerivedPublicJwk?: PublicJwk
      • OptionalprotocolContextDerivingRootKeyId?: string
      • protocolDefinition: ProtocolDefinition

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

        +
      • OptionalprotocolParentContextId?: string
      • protocolPath: string
      • Optionalrecipient?: string

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

StaticgenerateProtocolsConfigure

  • generateProtocolsConfigure(input?): Promise<GenerateProtocolsConfigureOutput>

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

    +

    Parameters

    • Optionalinput: GenerateProtocolsConfigureInput

    Returns Promise<GenerateProtocolsConfigureOutput>

StaticgenerateProtocolsQuery

  • generateProtocolsQuery(input?): Promise<GenerateProtocolsQueryOutput>

  • Generates a ProtocolsQuery message for testing.

    +

    Parameters

    • Optionalinput: GenerateProtocolsQueryInput

    Returns Promise<GenerateProtocolsQueryOutput>

StaticgenerateRecordsDelete

  • generateRecordsDelete(input?): Promise<GenerateRecordsDeleteOutput>

  • Generates a RecordsDelete for testing.

    +

    Parameters

    • Optionalinput: GenerateRecordsDeleteInput

    Returns Promise<GenerateRecordsDeleteOutput>

StaticgenerateRecordsQuery

  • generateRecordsQuery(input?): Promise<GenerateRecordsQueryOutput>

  • Generates a RecordsQuery message for testing.

    +

    Parameters

    • Optionalinput: GenerateRecordsQueryInput

    Returns Promise<GenerateRecordsQueryOutput>

StaticgenerateRecordsSubscribe

  • generateRecordsSubscribe(input?): Promise<GenerateRecordsSubscribeOutput>

  • Generates a RecordsSubscribe message for testing.

    +

    Parameters

    • Optionalinput: GenerateRecordsSubscribeInput

    Returns Promise<GenerateRecordsSubscribeOutput>

StaticgenerateRecordsWrite

  • generateRecordsWrite(input?): Promise<GenerateRecordsWriteOutput>

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

    +

    Parameters

    • Optionalinput: GenerateRecordsWriteInput

    Returns Promise<GenerateRecordsWriteOutput>

StaticrandomBytes

StaticrandomCborSha256Cid

StaticrandomInt

  • randomInt(min, max): number

  • Generates a random within a range (inclusive).

    +

    Parameters

    • min: number

      lowest potential value.

      +
    • max: number

      greatest potential value.

      +

    Returns number

StaticrandomSignatureString

StaticrandomString

StaticrandomTimestamp

  • randomTimestamp(options?): string

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

    +

    Parameters

    • Optionaloptions: {
          day?: number;
          hour?: number;
          microsecond?: number;
          millisecond?: number;
          minute?: number;
          month?: number;
          second?: number;
          year?: number;
      }
      • Optionalday?: number
      • Optionalhour?: number
      • Optionalmicrosecond?: number
      • Optionalmillisecond?: number
      • Optionalminute?: number
      • Optionalmonth?: number
      • Optionalsecond?: number
      • Optionalyear?: number

    Returns string

    random UTC ISO-8601 timestamp

    +

Settings

Member Visibility

On This Page

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

Class Time

Time related utilities.

+

Constructors

constructor +

Methods

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

Constructors

constructor

Methods

StaticcreateOffsetTimestamp

  • createOffsetTimestamp(offset, timestamp?): string

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

    +

    Parameters

    • offset: {
          seconds: number;
      }

      Negative number means offset into the past.

      +
      • seconds: number
    • Optionaltimestamp: string

    Returns string

StaticcreateTimestamp

  • createTimestamp(options): string

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

    +

    Parameters

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

      Options for creating the timestamp.

      +
      • Optionalday?: number
      • Optionalhour?: number
      • Optionalmicrosecond?: number
      • Optionalmillisecond?: number
      • Optionalminute?: number
      • Optionalmonth?: number
      • Optionalsecond?: number
      • Optionalyear?: number

    Returns string

    string

    +

StaticgetCurrentTimestamp

  • getCurrentTimestamp(): string

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

    +

    Returns string

StaticminimalSleep

Staticsleep

  • sleep(durationInMillisecond): Promise<void>

  • sleeps for the desired duration

    +

    Parameters

    • durationInMillisecond: number

      the desired amount of sleep time

      +

    Returns Promise<void>

    when the provided duration has passed

    +

StaticvalidateTimestamp

  • validateTimestamp(timestamp): void

  • Validates that the provided timestamp is a valid number

    +

    Parameters

    • timestamp: string

      the timestamp to validate

      +

    Returns void

    Throws

    DwnError if timestamp is not a valid number

    +

Settings

Member Visibility

On This Page

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

Enumeration DateSort

Enumeration Members

CreatedAscending +CreatedDescending +PublishedAscending +PublishedDescending +

Enumeration Members

CreatedAscending

CreatedAscending: "createdAscending"

CreatedDescending

CreatedDescending: "createdDescending"

PublishedAscending

PublishedAscending: "publishedAscending"

PublishedDescending

PublishedDescending: "publishedDescending"

Settings

Member Visibility

On This Page

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

Enumeration DwnErrorCode

DWN SDK error codes.

+

Enumeration Members

AuthenticateDescriptorCidMismatch +AuthenticateJwsMissing +AuthenticationMoreThanOneSignatureNotSupported +AuthorizationAuthorNotOwner +AuthorizationNotGrantedToAuthor +ComputeCidCodecNotSupported +ComputeCidMultihashNotSupported +Ed25519InvalidJwk +EventEmitterStreamNotOpenError +GeneralJwsVerifierGetPublicKeyNotFound +GeneralJwsVerifierInvalidSignature +GrantAuthorizationGrantExpired +GrantAuthorizationGrantMissing +GrantAuthorizationGrantNotYetActive +GrantAuthorizationGrantRevoked +GrantAuthorizationInterfaceMismatch +GrantAuthorizationMethodMismatch +GrantAuthorizationNotGrantedForTenant +GrantAuthorizationNotGrantedToAuthor +HdKeyDerivationPathInvalid +IndexInvalidCursorSortProperty +IndexInvalidCursorValueType +IndexInvalidSortPropertyInMemory +IndexMissingIndexableProperty +JwsDecodePlainObjectPayloadInvalid +JwsVerifySignatureUnsupportedCrv +MessageGetInvalidCid +MessagesGrantAuthorizationMismatchedProtocol +MessagesQueryAuthorizationFailed +MessagesReadAuthorizationFailed +MessagesReadInvalidCid +MessagesReadVerifyScopeFailed +MessagesSubscribeAuthorizationFailed +MessagesSubscribeEventStreamUnimplemented +ParseCidCodecNotSupported +ParseCidMultihashNotSupported +PermissionsProtocolCreateGrantRecordsScopeMissingProtocol +PermissionsProtocolCreateRequestRecordsScopeMissingProtocol +PermissionsProtocolGetScopeInvalidProtocol +PermissionsProtocolValidateRevocationProtocolTagMismatch +PermissionsProtocolValidateSchemaUnexpectedRecord +PermissionsProtocolValidateScopeContextIdProhibitedProperties +PermissionsProtocolValidateScopeMissingProtocolTag +PermissionsProtocolValidateScopeProtocolMismatch +PrivateKeySignerUnableToDeduceAlgorithm +PrivateKeySignerUnableToDeduceKeyId +PrivateKeySignerUnsupportedCurve +ProtocolAuthorizationActionNotAllowed +ProtocolAuthorizationActionRulesNotFound +ProtocolAuthorizationDuplicateRoleRecipient +ProtocolAuthorizationIncorrectContextId +ProtocolAuthorizationIncorrectDataFormat +ProtocolAuthorizationIncorrectProtocolPath +ProtocolAuthorizationInvalidSchema +ProtocolAuthorizationInvalidType +ProtocolAuthorizationMatchingRoleRecordNotFound +ProtocolAuthorizationMaxSizeInvalid +ProtocolAuthorizationMinSizeInvalid +ProtocolAuthorizationMissingContextId +ProtocolAuthorizationMissingRuleSet +ProtocolAuthorizationNotARole +ProtocolAuthorizationParentNotFoundConstructingRecordChain +ProtocolAuthorizationParentlessIncorrectProtocolPath +ProtocolAuthorizationProtocolNotFound +ProtocolAuthorizationRoleMissingRecipient +ProtocolAuthorizationTagsInvalidSchema +ProtocolsConfigureDuplicateActorInRuleSet +ProtocolsConfigureDuplicateRoleInRuleSet +ProtocolsConfigureInvalidActionDeleteWithoutCreate +ProtocolsConfigureInvalidActionMissingOf +ProtocolsConfigureInvalidActionOfNotAllowed +ProtocolsConfigureInvalidActionUpdateWithoutCreate +ProtocolsConfigureInvalidRecipientOfAction +ProtocolsConfigureInvalidRuleSetRecordType +ProtocolsConfigureInvalidSize +ProtocolsConfigureInvalidTagSchema +ProtocolsConfigureRecordNestingDepthExceeded +ProtocolsConfigureRoleDoesNotExistAtGivenPath +ProtocolsQueryUnauthorized +RecordsAuthorDelegatedGrantAndIdExistenceMismatch +RecordsAuthorDelegatedGrantCidMismatch +RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch +RecordsAuthorDelegatedGrantNotADelegatedGrant +RecordsDecryptNoMatchingKeyEncryptedFound +RecordsDeleteAuthorizationFailed +RecordsDerivePrivateKeyUnSupportedCurve +RecordsGrantAuthorizationConditionPublicationProhibited +RecordsGrantAuthorizationConditionPublicationRequired +RecordsGrantAuthorizationDeleteProtocolScopeMismatch +RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch +RecordsGrantAuthorizationScopeContextIdMismatch +RecordsGrantAuthorizationScopeProtocolMismatch +RecordsGrantAuthorizationScopeProtocolPathMismatch +RecordsInvalidAncestorKeyDerivationSegment +RecordsOwnerDelegatedGrantAndIdExistenceMismatch +RecordsOwnerDelegatedGrantCidMismatch +RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch +RecordsOwnerDelegatedGrantNotADelegatedGrant +RecordsProtocolContextDerivationSchemeMissingContextId +RecordsProtocolPathDerivationSchemeMissingProtocol +RecordsQueryCreateFilterPublishedSortInvalid +RecordsQueryFilterMissingRequiredProperties +RecordsQueryParseFilterPublishedSortInvalid +RecordsReadAuthorizationFailed +RecordsReadReturnedMultiple +RecordsSchemasDerivationSchemeMissingSchema +RecordsSubscribeEventStreamUnimplemented +RecordsSubscribeFilterMissingRequiredProperties +RecordsWriteAttestationIntegrityDescriptorCidMismatch +RecordsWriteAttestationIntegrityInvalidPayloadProperty +RecordsWriteAttestationIntegrityMoreThanOneSignature +RecordsWriteAuthorizationFailed +RecordsWriteCreateDataAndDataCidMutuallyExclusive +RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive +RecordsWriteCreateMissingSigner +RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive +RecordsWriteDataCidMismatch +RecordsWriteDataSizeMismatch +RecordsWriteGetEntryIdUndefinedAuthor +RecordsWriteGetInitialWriteNotFound +RecordsWriteGetNewestWriteRecordNotFound +RecordsWriteImmutablePropertyChanged +RecordsWriteMissingDataInPrevious +RecordsWriteMissingDataStream +RecordsWriteMissingEncodedDataInPrevious +RecordsWriteMissingProtocol +RecordsWriteMissingSchema +RecordsWriteMissingSigner +RecordsWriteOwnerAndTenantMismatch +RecordsWriteSignAsOwnerDelegateUnknownAuthor +RecordsWriteSignAsOwnerUnknownAuthor +RecordsWriteValidateIntegrityAttestationMismatch +RecordsWriteValidateIntegrityContextIdMismatch +RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload +RecordsWriteValidateIntegrityDateCreatedMismatch +RecordsWriteValidateIntegrityEncryptionCidMismatch +RecordsWriteValidateIntegrityRecordIdUnauthorized +SchemaValidatorAdditionalPropertyNotAllowed +SchemaValidatorFailure +SchemaValidatorSchemaNotFound +SchemaValidatorUnevaluatedPropertyNotAllowed +Secp256k1KeyNotValid +Secp256r1KeyNotValid +TimestampInvalid +UrlProtocolNotNormalizable +UrlProtocolNotNormalized +UrlSchemaNotNormalized +

Enumeration Members

AuthenticateDescriptorCidMismatch

AuthenticateDescriptorCidMismatch: "AuthenticateDescriptorCidMismatch"

AuthenticateJwsMissing

AuthenticateJwsMissing: "AuthenticateJwsMissing"

AuthenticationMoreThanOneSignatureNotSupported

AuthenticationMoreThanOneSignatureNotSupported: "AuthenticationMoreThanOneSignatureNotSupported"

AuthorizationAuthorNotOwner

AuthorizationAuthorNotOwner: "AuthorizationAuthorNotOwner"

AuthorizationNotGrantedToAuthor

AuthorizationNotGrantedToAuthor: "AuthorizationNotGrantedToAuthor"

ComputeCidCodecNotSupported

ComputeCidCodecNotSupported: "ComputeCidCodecNotSupported"

ComputeCidMultihashNotSupported

ComputeCidMultihashNotSupported: "ComputeCidMultihashNotSupported"

Ed25519InvalidJwk

Ed25519InvalidJwk: "Ed25519InvalidJwk"

EventEmitterStreamNotOpenError

EventEmitterStreamNotOpenError: "EventEmitterStreamNotOpenError"

GeneralJwsVerifierGetPublicKeyNotFound

GeneralJwsVerifierGetPublicKeyNotFound: "GeneralJwsVerifierGetPublicKeyNotFound"

GeneralJwsVerifierInvalidSignature

GeneralJwsVerifierInvalidSignature: "GeneralJwsVerifierInvalidSignature"

GrantAuthorizationGrantExpired

GrantAuthorizationGrantExpired: "GrantAuthorizationGrantExpired"

GrantAuthorizationGrantMissing

GrantAuthorizationGrantMissing: "GrantAuthorizationGrantMissing"

GrantAuthorizationGrantNotYetActive

GrantAuthorizationGrantNotYetActive: "GrantAuthorizationGrantNotYetActive"

GrantAuthorizationGrantRevoked

GrantAuthorizationGrantRevoked: "GrantAuthorizationGrantRevoked"

GrantAuthorizationInterfaceMismatch

GrantAuthorizationInterfaceMismatch: "GrantAuthorizationInterfaceMismatch"

GrantAuthorizationMethodMismatch

GrantAuthorizationMethodMismatch: "GrantAuthorizationMethodMismatch"

GrantAuthorizationNotGrantedForTenant

GrantAuthorizationNotGrantedForTenant: "GrantAuthorizationNotGrantedForTenant"

GrantAuthorizationNotGrantedToAuthor

GrantAuthorizationNotGrantedToAuthor: "GrantAuthorizationNotGrantedToAuthor"

HdKeyDerivationPathInvalid

HdKeyDerivationPathInvalid: "HdKeyDerivationPathInvalid"

IndexInvalidCursorSortProperty

IndexInvalidCursorSortProperty: "IndexInvalidCursorSortProperty"

IndexInvalidCursorValueType

IndexInvalidCursorValueType: "IndexInvalidCursorValueType"

IndexInvalidSortPropertyInMemory

IndexInvalidSortPropertyInMemory: "IndexInvalidSortPropertyInMemory"

IndexMissingIndexableProperty

IndexMissingIndexableProperty: "IndexMissingIndexableProperty"

JwsDecodePlainObjectPayloadInvalid

JwsDecodePlainObjectPayloadInvalid: "JwsDecodePlainObjectPayloadInvalid"

JwsVerifySignatureUnsupportedCrv

JwsVerifySignatureUnsupportedCrv: "JwsVerifySignatureUnsupportedCrv"

MessageGetInvalidCid

MessageGetInvalidCid: "MessageGetInvalidCid"

MessagesGrantAuthorizationMismatchedProtocol

MessagesGrantAuthorizationMismatchedProtocol: "EventsGrantAuthorizationMismatchedProtocol"

MessagesQueryAuthorizationFailed

MessagesQueryAuthorizationFailed: "MessagesQueryAuthorizationFailed"

MessagesReadAuthorizationFailed

MessagesReadAuthorizationFailed: "MessagesReadAuthorizationFailed"

MessagesReadInvalidCid

MessagesReadInvalidCid: "MessagesReadInvalidCid"

MessagesReadVerifyScopeFailed

MessagesReadVerifyScopeFailed: "MessagesReadVerifyScopeFailed"

MessagesSubscribeAuthorizationFailed

MessagesSubscribeAuthorizationFailed: "MessagesSubscribeAuthorizationFailed"

MessagesSubscribeEventStreamUnimplemented

MessagesSubscribeEventStreamUnimplemented: "MessagesSubscribeEventStreamUnimplemented"

ParseCidCodecNotSupported

ParseCidCodecNotSupported: "ParseCidCodecNotSupported"

ParseCidMultihashNotSupported

ParseCidMultihashNotSupported: "ParseCidMultihashNotSupported"

PermissionsProtocolCreateGrantRecordsScopeMissingProtocol

PermissionsProtocolCreateGrantRecordsScopeMissingProtocol: "PermissionsProtocolCreateGrantRecordsScopeMissingProtocol"

PermissionsProtocolCreateRequestRecordsScopeMissingProtocol

PermissionsProtocolCreateRequestRecordsScopeMissingProtocol: "PermissionsProtocolCreateRequestRecordsScopeMissingProtocol"

PermissionsProtocolGetScopeInvalidProtocol

PermissionsProtocolGetScopeInvalidProtocol: "PermissionsProtocolGetScopeInvalidProtocol"

PermissionsProtocolValidateRevocationProtocolTagMismatch

PermissionsProtocolValidateRevocationProtocolTagMismatch: "PermissionsProtocolValidateRevocationProtocolTagMismatch"

PermissionsProtocolValidateSchemaUnexpectedRecord

PermissionsProtocolValidateSchemaUnexpectedRecord: "PermissionsProtocolValidateSchemaUnexpectedRecord"

PermissionsProtocolValidateScopeContextIdProhibitedProperties

PermissionsProtocolValidateScopeContextIdProhibitedProperties: "PermissionsProtocolValidateScopeContextIdProhibitedProperties"

PermissionsProtocolValidateScopeMissingProtocolTag

PermissionsProtocolValidateScopeMissingProtocolTag: "PermissionsProtocolValidateScopeMissingProtocolTag"

PermissionsProtocolValidateScopeProtocolMismatch

PermissionsProtocolValidateScopeProtocolMismatch: "PermissionsProtocolValidateScopeProtocolMismatch"

PrivateKeySignerUnableToDeduceAlgorithm

PrivateKeySignerUnableToDeduceAlgorithm: "PrivateKeySignerUnableToDeduceAlgorithm"

PrivateKeySignerUnableToDeduceKeyId

PrivateKeySignerUnableToDeduceKeyId: "PrivateKeySignerUnableToDeduceKeyId"

PrivateKeySignerUnsupportedCurve

PrivateKeySignerUnsupportedCurve: "PrivateKeySignerUnsupportedCurve"

ProtocolAuthorizationActionNotAllowed

ProtocolAuthorizationActionNotAllowed: "ProtocolAuthorizationActionNotAllowed"

ProtocolAuthorizationActionRulesNotFound

ProtocolAuthorizationActionRulesNotFound: "ProtocolAuthorizationActionRulesNotFound"

ProtocolAuthorizationDuplicateRoleRecipient

ProtocolAuthorizationDuplicateRoleRecipient: "ProtocolAuthorizationDuplicateRoleRecipient"

ProtocolAuthorizationIncorrectContextId

ProtocolAuthorizationIncorrectContextId: "ProtocolAuthorizationIncorrectContextId"

ProtocolAuthorizationIncorrectDataFormat

ProtocolAuthorizationIncorrectDataFormat: "ProtocolAuthorizationIncorrectDataFormat"

ProtocolAuthorizationIncorrectProtocolPath

ProtocolAuthorizationIncorrectProtocolPath: "ProtocolAuthorizationIncorrectProtocolPath"

ProtocolAuthorizationInvalidSchema

ProtocolAuthorizationInvalidSchema: "ProtocolAuthorizationInvalidSchema"

ProtocolAuthorizationInvalidType

ProtocolAuthorizationInvalidType: "ProtocolAuthorizationInvalidType"

ProtocolAuthorizationMatchingRoleRecordNotFound

ProtocolAuthorizationMatchingRoleRecordNotFound: "ProtocolAuthorizationMatchingRoleRecordNotFound"

ProtocolAuthorizationMaxSizeInvalid

ProtocolAuthorizationMaxSizeInvalid: "ProtocolAuthorizationMaxSizeInvalid"

ProtocolAuthorizationMinSizeInvalid

ProtocolAuthorizationMinSizeInvalid: "ProtocolAuthorizationMinSizeInvalid"

ProtocolAuthorizationMissingContextId

ProtocolAuthorizationMissingContextId: "ProtocolAuthorizationMissingContextId"

ProtocolAuthorizationMissingRuleSet

ProtocolAuthorizationMissingRuleSet: "ProtocolAuthorizationMissingRuleSet"

ProtocolAuthorizationNotARole

ProtocolAuthorizationNotARole: "ProtocolAuthorizationNotARole"

ProtocolAuthorizationParentNotFoundConstructingRecordChain

ProtocolAuthorizationParentNotFoundConstructingRecordChain: "ProtocolAuthorizationParentNotFoundConstructingRecordChain"

ProtocolAuthorizationParentlessIncorrectProtocolPath

ProtocolAuthorizationParentlessIncorrectProtocolPath: "ProtocolAuthorizationParentlessIncorrectProtocolPath"

ProtocolAuthorizationProtocolNotFound

ProtocolAuthorizationProtocolNotFound: "ProtocolAuthorizationProtocolNotFound"

ProtocolAuthorizationRoleMissingRecipient

ProtocolAuthorizationRoleMissingRecipient: "ProtocolAuthorizationRoleMissingRecipient"

ProtocolAuthorizationTagsInvalidSchema

ProtocolAuthorizationTagsInvalidSchema: "ProtocolAuthorizationTagsInvalidSchema"

ProtocolsConfigureDuplicateActorInRuleSet

ProtocolsConfigureDuplicateActorInRuleSet: "ProtocolsConfigureDuplicateActorInRuleSet"

ProtocolsConfigureDuplicateRoleInRuleSet

ProtocolsConfigureDuplicateRoleInRuleSet: "ProtocolsConfigureDuplicateRoleInRuleSet"

ProtocolsConfigureInvalidActionDeleteWithoutCreate

ProtocolsConfigureInvalidActionDeleteWithoutCreate: "ProtocolsConfigureInvalidActionDeleteWithoutCreate"

ProtocolsConfigureInvalidActionMissingOf

ProtocolsConfigureInvalidActionMissingOf: "ProtocolsConfigureInvalidActionMissingOf"

ProtocolsConfigureInvalidActionOfNotAllowed

ProtocolsConfigureInvalidActionOfNotAllowed: "ProtocolsConfigureInvalidActionOfNotAllowed"

ProtocolsConfigureInvalidActionUpdateWithoutCreate

ProtocolsConfigureInvalidActionUpdateWithoutCreate: "ProtocolsConfigureInvalidActionUpdateWithoutCreate"

ProtocolsConfigureInvalidRecipientOfAction

ProtocolsConfigureInvalidRecipientOfAction: "ProtocolsConfigureInvalidRecipientOfAction"

ProtocolsConfigureInvalidRuleSetRecordType

ProtocolsConfigureInvalidRuleSetRecordType: "ProtocolsConfigureInvalidRuleSetRecordType"

ProtocolsConfigureInvalidSize

ProtocolsConfigureInvalidSize: "ProtocolsConfigureInvalidSize"

ProtocolsConfigureInvalidTagSchema

ProtocolsConfigureInvalidTagSchema: "ProtocolsConfigureInvalidTagSchema"

ProtocolsConfigureRecordNestingDepthExceeded

ProtocolsConfigureRecordNestingDepthExceeded: "ProtocolsConfigureRecordNestingDepthExceeded"

ProtocolsConfigureRoleDoesNotExistAtGivenPath

ProtocolsConfigureRoleDoesNotExistAtGivenPath: "ProtocolsConfigureRoleDoesNotExistAtGivenPath"

ProtocolsQueryUnauthorized

ProtocolsQueryUnauthorized: "ProtocolsQueryUnauthorized"

RecordsAuthorDelegatedGrantAndIdExistenceMismatch

RecordsAuthorDelegatedGrantAndIdExistenceMismatch: "RecordsAuthorDelegatedGrantAndIdExistenceMismatch"

RecordsAuthorDelegatedGrantCidMismatch

RecordsAuthorDelegatedGrantCidMismatch: "RecordsAuthorDelegatedGrantCidMismatch"

RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch

RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch: "RecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatch"

RecordsAuthorDelegatedGrantNotADelegatedGrant

RecordsAuthorDelegatedGrantNotADelegatedGrant: "RecordsAuthorDelegatedGrantNotADelegatedGrant"

RecordsDecryptNoMatchingKeyEncryptedFound

RecordsDecryptNoMatchingKeyEncryptedFound: "RecordsDecryptNoMatchingKeyEncryptedFound"

RecordsDeleteAuthorizationFailed

RecordsDeleteAuthorizationFailed: "RecordsDeleteAuthorizationFailed"

RecordsDerivePrivateKeyUnSupportedCurve

RecordsDerivePrivateKeyUnSupportedCurve: "RecordsDerivePrivateKeyUnSupportedCurve"

RecordsGrantAuthorizationConditionPublicationProhibited

RecordsGrantAuthorizationConditionPublicationProhibited: "RecordsGrantAuthorizationConditionPublicationProhibited"

RecordsGrantAuthorizationConditionPublicationRequired

RecordsGrantAuthorizationConditionPublicationRequired: "RecordsGrantAuthorizationConditionPublicationRequired"

RecordsGrantAuthorizationDeleteProtocolScopeMismatch

RecordsGrantAuthorizationDeleteProtocolScopeMismatch: "RecordsGrantAuthorizationDeleteProtocolScopeMismatch"

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch

RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch: "RecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatch"

RecordsGrantAuthorizationScopeContextIdMismatch

RecordsGrantAuthorizationScopeContextIdMismatch: "RecordsGrantAuthorizationScopeContextIdMismatch"

RecordsGrantAuthorizationScopeProtocolMismatch

RecordsGrantAuthorizationScopeProtocolMismatch: "RecordsGrantAuthorizationScopeProtocolMismatch"

RecordsGrantAuthorizationScopeProtocolPathMismatch

RecordsGrantAuthorizationScopeProtocolPathMismatch: "RecordsGrantAuthorizationScopeProtocolPathMismatch"

RecordsInvalidAncestorKeyDerivationSegment

RecordsInvalidAncestorKeyDerivationSegment: "RecordsInvalidAncestorKeyDerivationSegment"

RecordsOwnerDelegatedGrantAndIdExistenceMismatch

RecordsOwnerDelegatedGrantAndIdExistenceMismatch: "RecordsOwnerDelegatedGrantAndIdExistenceMismatch"

RecordsOwnerDelegatedGrantCidMismatch

RecordsOwnerDelegatedGrantCidMismatch: "RecordsOwnerDelegatedGrantCidMismatch"

RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch

RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch: "RecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatch"

RecordsOwnerDelegatedGrantNotADelegatedGrant

RecordsOwnerDelegatedGrantNotADelegatedGrant: "RecordsOwnerDelegatedGrantNotADelegatedGrant"

RecordsProtocolContextDerivationSchemeMissingContextId

RecordsProtocolContextDerivationSchemeMissingContextId: "RecordsProtocolContextDerivationSchemeMissingContextId"

RecordsProtocolPathDerivationSchemeMissingProtocol

RecordsProtocolPathDerivationSchemeMissingProtocol: "RecordsProtocolPathDerivationSchemeMissingProtocol"

RecordsQueryCreateFilterPublishedSortInvalid

RecordsQueryCreateFilterPublishedSortInvalid: "RecordsQueryCreateFilterPublishedSortInvalid"

RecordsQueryFilterMissingRequiredProperties

RecordsQueryFilterMissingRequiredProperties: "RecordsQueryFilterMissingRequiredProperties"

RecordsQueryParseFilterPublishedSortInvalid

RecordsQueryParseFilterPublishedSortInvalid: "RecordsQueryParseFilterPublishedSortInvalid"

RecordsReadAuthorizationFailed

RecordsReadAuthorizationFailed: "RecordsReadAuthorizationFailed"

RecordsReadReturnedMultiple

RecordsReadReturnedMultiple: "RecordsReadReturnedMultiple"

RecordsSchemasDerivationSchemeMissingSchema

RecordsSchemasDerivationSchemeMissingSchema: "RecordsSchemasDerivationSchemeMissingSchema"

RecordsSubscribeEventStreamUnimplemented

RecordsSubscribeEventStreamUnimplemented: "RecordsSubscribeEventStreamUnimplemented"

RecordsSubscribeFilterMissingRequiredProperties

RecordsSubscribeFilterMissingRequiredProperties: "RecordsSubscribeFilterMissingRequiredProperties"

RecordsWriteAttestationIntegrityDescriptorCidMismatch

RecordsWriteAttestationIntegrityDescriptorCidMismatch: "RecordsWriteAttestationIntegrityDescriptorCidMismatch"

RecordsWriteAttestationIntegrityInvalidPayloadProperty

RecordsWriteAttestationIntegrityInvalidPayloadProperty: "RecordsWriteAttestationIntegrityInvalidPayloadProperty"

RecordsWriteAttestationIntegrityMoreThanOneSignature

RecordsWriteAttestationIntegrityMoreThanOneSignature: "RecordsWriteAttestationIntegrityMoreThanOneSignature"

RecordsWriteAuthorizationFailed

RecordsWriteAuthorizationFailed: "RecordsWriteAuthorizationFailed"

RecordsWriteCreateDataAndDataCidMutuallyExclusive

RecordsWriteCreateDataAndDataCidMutuallyExclusive: "RecordsWriteCreateDataAndDataCidMutuallyExclusive"

RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive

RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive: "RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive"

RecordsWriteCreateMissingSigner

RecordsWriteCreateMissingSigner: "RecordsWriteCreateMissingSigner"

RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive

RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive: "RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive"

RecordsWriteDataCidMismatch

RecordsWriteDataCidMismatch: "RecordsWriteDataCidMismatch"

RecordsWriteDataSizeMismatch

RecordsWriteDataSizeMismatch: "RecordsWriteDataSizeMismatch"

RecordsWriteGetEntryIdUndefinedAuthor

RecordsWriteGetEntryIdUndefinedAuthor: "RecordsWriteGetEntryIdUndefinedAuthor"

RecordsWriteGetInitialWriteNotFound

RecordsWriteGetInitialWriteNotFound: "RecordsWriteGetInitialWriteNotFound"

RecordsWriteGetNewestWriteRecordNotFound

RecordsWriteGetNewestWriteRecordNotFound: "RecordsWriteGetNewestWriteRecordNotFound"

RecordsWriteImmutablePropertyChanged

RecordsWriteImmutablePropertyChanged: "RecordsWriteImmutablePropertyChanged"

RecordsWriteMissingDataInPrevious

RecordsWriteMissingDataInPrevious: "RecordsWriteMissingDataInPrevious"

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"

SchemaValidatorAdditionalPropertyNotAllowed

SchemaValidatorAdditionalPropertyNotAllowed: "SchemaValidatorAdditionalPropertyNotAllowed"

SchemaValidatorFailure

SchemaValidatorFailure: "SchemaValidatorFailure"

SchemaValidatorSchemaNotFound

SchemaValidatorSchemaNotFound: "SchemaValidatorSchemaNotFound"

SchemaValidatorUnevaluatedPropertyNotAllowed

SchemaValidatorUnevaluatedPropertyNotAllowed: "SchemaValidatorUnevaluatedPropertyNotAllowed"

Secp256k1KeyNotValid

Secp256k1KeyNotValid: "Secp256k1KeyNotValid"

Secp256r1KeyNotValid

Secp256r1KeyNotValid: "Secp256r1KeyNotValid"

TimestampInvalid

TimestampInvalid: "TimestampInvalid"

UrlProtocolNotNormalizable

UrlProtocolNotNormalizable: "UrlProtocolNotNormalizable"

UrlProtocolNotNormalized

UrlProtocolNotNormalized: "UrlProtocolNotNormalized"

UrlSchemaNotNormalized

UrlSchemaNotNormalized: "UrlSchemaNotNormalized"

Settings

Member Visibility

On This Page

Enumeration Members
AuthenticateDescriptorCidMismatchAuthenticateJwsMissingAuthenticationMoreThanOneSignatureNotSupportedAuthorizationAuthorNotOwnerAuthorizationNotGrantedToAuthorComputeCidCodecNotSupportedComputeCidMultihashNotSupportedEd25519InvalidJwkEventEmitterStreamNotOpenErrorGeneralJwsVerifierGetPublicKeyNotFoundGeneralJwsVerifierInvalidSignatureGrantAuthorizationGrantExpiredGrantAuthorizationGrantMissingGrantAuthorizationGrantNotYetActiveGrantAuthorizationGrantRevokedGrantAuthorizationInterfaceMismatchGrantAuthorizationMethodMismatchGrantAuthorizationNotGrantedForTenantGrantAuthorizationNotGrantedToAuthorHdKeyDerivationPathInvalidIndexInvalidCursorSortPropertyIndexInvalidCursorValueTypeIndexInvalidSortPropertyInMemoryIndexMissingIndexablePropertyJwsDecodePlainObjectPayloadInvalidJwsVerifySignatureUnsupportedCrvMessageGetInvalidCidMessagesGrantAuthorizationMismatchedProtocolMessagesQueryAuthorizationFailedMessagesReadAuthorizationFailedMessagesReadInvalidCidMessagesReadVerifyScopeFailedMessagesSubscribeAuthorizationFailedMessagesSubscribeEventStreamUnimplementedParseCidCodecNotSupportedParseCidMultihashNotSupportedPermissionsProtocolCreateGrantRecordsScopeMissingProtocolPermissionsProtocolCreateRequestRecordsScopeMissingProtocolPermissionsProtocolGetScopeInvalidProtocolPermissionsProtocolValidateRevocationProtocolTagMismatchPermissionsProtocolValidateSchemaUnexpectedRecordPermissionsProtocolValidateScopeContextIdProhibitedPropertiesPermissionsProtocolValidateScopeMissingProtocolTagPermissionsProtocolValidateScopeProtocolMismatchPrivateKeySignerUnableToDeduceAlgorithmPrivateKeySignerUnableToDeduceKeyIdPrivateKeySignerUnsupportedCurveProtocolAuthorizationActionNotAllowedProtocolAuthorizationActionRulesNotFoundProtocolAuthorizationDuplicateRoleRecipientProtocolAuthorizationIncorrectContextIdProtocolAuthorizationIncorrectDataFormatProtocolAuthorizationIncorrectProtocolPathProtocolAuthorizationInvalidSchemaProtocolAuthorizationInvalidTypeProtocolAuthorizationMatchingRoleRecordNotFoundProtocolAuthorizationMaxSizeInvalidProtocolAuthorizationMinSizeInvalidProtocolAuthorizationMissingContextIdProtocolAuthorizationMissingRuleSetProtocolAuthorizationNotARoleProtocolAuthorizationParentNotFoundConstructingRecordChainProtocolAuthorizationParentlessIncorrectProtocolPathProtocolAuthorizationProtocolNotFoundProtocolAuthorizationRoleMissingRecipientProtocolAuthorizationTagsInvalidSchemaProtocolsConfigureDuplicateActorInRuleSetProtocolsConfigureDuplicateRoleInRuleSetProtocolsConfigureInvalidActionDeleteWithoutCreateProtocolsConfigureInvalidActionMissingOfProtocolsConfigureInvalidActionOfNotAllowedProtocolsConfigureInvalidActionUpdateWithoutCreateProtocolsConfigureInvalidRecipientOfActionProtocolsConfigureInvalidRuleSetRecordTypeProtocolsConfigureInvalidSizeProtocolsConfigureInvalidTagSchemaProtocolsConfigureRecordNestingDepthExceededProtocolsConfigureRoleDoesNotExistAtGivenPathProtocolsQueryUnauthorizedRecordsAuthorDelegatedGrantAndIdExistenceMismatchRecordsAuthorDelegatedGrantCidMismatchRecordsAuthorDelegatedGrantGrantedToAndOwnerSignatureMismatchRecordsAuthorDelegatedGrantNotADelegatedGrantRecordsDecryptNoMatchingKeyEncryptedFoundRecordsDeleteAuthorizationFailedRecordsDerivePrivateKeyUnSupportedCurveRecordsGrantAuthorizationConditionPublicationProhibitedRecordsGrantAuthorizationConditionPublicationRequiredRecordsGrantAuthorizationDeleteProtocolScopeMismatchRecordsGrantAuthorizationQueryOrSubscribeProtocolScopeMismatchRecordsGrantAuthorizationScopeContextIdMismatchRecordsGrantAuthorizationScopeProtocolMismatchRecordsGrantAuthorizationScopeProtocolPathMismatchRecordsInvalidAncestorKeyDerivationSegmentRecordsOwnerDelegatedGrantAndIdExistenceMismatchRecordsOwnerDelegatedGrantCidMismatchRecordsOwnerDelegatedGrantGrantedToAndOwnerSignatureMismatchRecordsOwnerDelegatedGrantNotADelegatedGrantRecordsProtocolContextDerivationSchemeMissingContextIdRecordsProtocolPathDerivationSchemeMissingProtocolRecordsQueryCreateFilterPublishedSortInvalidRecordsQueryFilterMissingRequiredPropertiesRecordsQueryParseFilterPublishedSortInvalidRecordsReadAuthorizationFailedRecordsReadReturnedMultipleRecordsSchemasDerivationSchemeMissingSchemaRecordsSubscribeEventStreamUnimplementedRecordsSubscribeFilterMissingRequiredPropertiesRecordsWriteAttestationIntegrityDescriptorCidMismatchRecordsWriteAttestationIntegrityInvalidPayloadPropertyRecordsWriteAttestationIntegrityMoreThanOneSignatureRecordsWriteAuthorizationFailedRecordsWriteCreateDataAndDataCidMutuallyExclusiveRecordsWriteCreateDataCidAndDataSizeMutuallyInclusiveRecordsWriteCreateMissingSignerRecordsWriteCreateProtocolAndProtocolPathMutuallyInclusiveRecordsWriteDataCidMismatchRecordsWriteDataSizeMismatchRecordsWriteGetEntryIdUndefinedAuthorRecordsWriteGetInitialWriteNotFoundRecordsWriteGetNewestWriteRecordNotFoundRecordsWriteImmutablePropertyChangedRecordsWriteMissingDataInPreviousRecordsWriteMissingDataStreamRecordsWriteMissingEncodedDataInPreviousRecordsWriteMissingProtocolRecordsWriteMissingSchemaRecordsWriteMissingSignerRecordsWriteOwnerAndTenantMismatchRecordsWriteSignAsOwnerDelegateUnknownAuthorRecordsWriteSignAsOwnerUnknownAuthorRecordsWriteValidateIntegrityAttestationMismatchRecordsWriteValidateIntegrityContextIdMismatchRecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayloadRecordsWriteValidateIntegrityDateCreatedMismatchRecordsWriteValidateIntegrityEncryptionCidMismatchRecordsWriteValidateIntegrityRecordIdUnauthorizedSchemaValidatorAdditionalPropertyNotAllowedSchemaValidatorFailureSchemaValidatorSchemaNotFoundSchemaValidatorUnevaluatedPropertyNotAllowedSecp256k1KeyNotValidSecp256r1KeyNotValidTimestampInvalidUrlProtocolNotNormalizableUrlProtocolNotNormalizedUrlSchemaNotNormalized
diff --git a/enums/DwnInterfaceName.html b/enums/DwnInterfaceName.html new file mode 100644 index 000000000..2e8aeeed5 --- /dev/null +++ b/enums/DwnInterfaceName.html @@ -0,0 +1,4 @@ +DwnInterfaceName | DWN-SDK Documentation - v0.4.2

Enumeration DwnInterfaceName

Enumeration Members

Messages +Protocols +Records +

Enumeration Members

Messages

Messages: "Messages"

Protocols

Protocols: "Protocols"

Records

Records: "Records"

Settings

Member Visibility

On This Page

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

Enumeration DwnMethodName

Enumeration Members

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

Enumeration Members

Configure

Configure: "Configure"

Delete

Delete: "Delete"

Query

Query: "Query"

Read

Read: "Read"

Subscribe

Subscribe: "Subscribe"

Write

Write: "Write"

Settings

Member Visibility

On This Page

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

Enumeration EncryptionAlgorithm

Enumeration Members

Aes256Ctr +EciesSecp256k1 +

Enumeration Members

Aes256Ctr

Aes256Ctr: "A256CTR"

EciesSecp256k1

EciesSecp256k1: "ECIES-ES256K"

Settings

Member Visibility

On This Page

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

Enumeration KeyDerivationScheme

Enumeration Members

DataFormats +ProtocolContext +ProtocolPath +Schemas +

Enumeration Members

DataFormats

DataFormats: "dataFormats"

Key derivation using the dataFormat value for Flat-space records.

+

ProtocolContext

ProtocolContext: "protocolContext"

ProtocolPath

ProtocolPath: "protocolPath"

Schemas

Schemas: "schemas"

Key derivation using the schema value for Flat-space records.

+

Settings

Member Visibility

On This Page

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

Enumeration PermissionConditionPublication

Enumeration Members

Prohibited +Required +

Enumeration Members

Prohibited

Prohibited: "Prohibited"

Required

Required: "Required"

Settings

Member Visibility

On This Page

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

Enumeration SortDirection

Enumeration Members

Ascending +Descending +

Enumeration Members

Ascending

Ascending: 1

Descending

Descending: -1

Settings

Member Visibility

On This Page

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

Function authenticate

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

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

    +

    Parameters

    • authorizationModel: undefined | AuthorizationModel
    • didResolver: DidResolver

    Returns Promise<void>

    Throws

    if fails authentication

    +

Settings

Member Visibility
diff --git a/functions/executeUnlessAborted.html b/functions/executeUnlessAborted.html new file mode 100644 index 000000000..9a34d2cc1 --- /dev/null +++ b/functions/executeUnlessAborted.html @@ -0,0 +1,2 @@ +executeUnlessAborted | DWN-SDK Documentation - v0.4.2

Function executeUnlessAborted

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

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

    +

    Type Parameters

    • T

    Parameters

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

    Returns Promise<T>

Settings

Member Visibility
diff --git a/hierarchy.html b/hierarchy.html new file mode 100644 index 000000000..7800f0805 --- /dev/null +++ b/hierarchy.html @@ -0,0 +1 @@ +DWN-SDK Documentation - v0.4.2

DWN-SDK Documentation - v0.4.2

Class Hierarchy

Settings

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

DWN-SDK Documentation - v0.4.2

Index

Enumerations

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

Classes

AllowAllTenantGate +Cid +DataStoreLevel +DataStream +Dwn +DwnConstant +DwnError +Encoder +Encryption +EventEmitterStream +EventLogLevel +HdKey +Jws +Message +MessageStoreLevel +MessagesQuery +MessagesRead +MessagesSubscribe +PermissionGrant +PermissionRequest +PermissionsProtocol +Poller +PrivateKeySigner +Protocols +ProtocolsConfigure +ProtocolsQuery +Records +RecordsDelete +RecordsQuery +RecordsRead +RecordsSubscribe +RecordsWrite +ResumableTaskStoreLevel +Secp256k1 +Secp256r1 +TestDataGenerator +Time +

Interfaces

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

Type Aliases

ActiveTenantCheckResult +CreateFromOptions +DataEncodedRecordsWriteMessage +DataStoreGetResult +DataStorePutResult +DerivedPrivateJwk +DwnConfig +EncryptionInput +EncryptionProperty +EqualFilter +EventListener +Filter +GenericMessage +GenericMessageReply +KeyEncryptionInput +KeyMaterial +ManagedResumableTask +MessageEvent +MessageSort +MessageSubscriptionHandler +MessagesFilter +MessagesPermissionScope +MessagesQueryMessage +MessagesQueryOptions +MessagesQueryReply +MessagesReadMessage +MessagesReadOptions +MessagesReadReply +MessagesReadReplyEntry +MessagesSubscribeDescriptor +MessagesSubscribeMessage +MessagesSubscribeOptions +MessagesSubscribeReply +OneOfFilter +Pagination +PaginationCursor +PermissionConditions +PermissionGrantData +PermissionRequestData +PermissionRevocationData +PermissionScope +Persona +PrivateJwk +ProtocolDefinition +ProtocolPermissionScope +ProtocolRuleSet +ProtocolTypes +ProtocolsConfigureDescriptor +ProtocolsConfigureMessage +ProtocolsConfigureOptions +ProtocolsQueryFilter +ProtocolsQueryMessage +ProtocolsQueryOptions +ProtocolsQueryReply +PublicJwk +QueryOptions +QueryResultEntry +RangeCriterion +RangeFilter +RecordSubscriptionHandler +RecordsDeleteMessage +RecordsDeleteOptions +RecordsPermissionScope +RecordsQueryMessage +RecordsQueryOptions +RecordsQueryReply +RecordsQueryReplyEntry +RecordsReadMessage +RecordsReadOptions +RecordsReadReply +RecordsSubscribeDescriptor +RecordsSubscribeMessage +RecordsSubscribeOptions +RecordsSubscribeReply +RecordsWriteDescriptor +RecordsWriteMessage +RecordsWriteOptions +RecordsWriteTagValue +RecordsWriteTags +SubscriptionReply +UnionMessageReply +

Functions

authenticate +executeUnlessAborted +

Settings

Member Visibility
diff --git a/interfaces/DataStore.html b/interfaces/DataStore.html new file mode 100644 index 000000000..154faacc3 --- /dev/null +++ b/interfaces/DataStore.html @@ -0,0 +1,21 @@ +DataStore | DWN-SDK Documentation - v0.4.2

Interface DataStore

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

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

Implemented by

Methods

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

Methods

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

delete

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

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

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<void>

get

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

  • Fetches the specified data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +

    Returns Promise<undefined | DataStoreGetResult>

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

    +

open

put

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

  • Stores the given data.

    +

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

      +
    • dataCid: string

      The IPFS CID of the data.

      +
    • dataStream: Readable

    Returns Promise<DataStorePutResult>

Settings

Member Visibility

On This Page

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

Interface EventLog

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

Implemented by

Methods

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

Methods

append

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

  • adds an event to a tenant's event log

    +

    Parameters

    • tenant: string

      the tenant's DID

      +
    • messageCid: string

      the CID of the message

      +
    • indexes: KeyValues

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

      +

    Returns Promise<void>

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

  • close(): Promise<void>

  • closes the connection to the underlying store

    +

    Returns Promise<void>

deleteEventsByCid

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

  • deletes any events that have any of the messageCids provided

    +

    Parameters

    • tenant: string
    • messageCids: string[]

    Returns Promise<void>

    the number of events deleted

    +

getEvents

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

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

    +

    The cursor is a messageCid.

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

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

open

  • open(): Promise<void>

  • opens a connection to the underlying store

    +

    Returns Promise<void>

queryEvents

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

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

    +

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

    +

    Returns an array of messageCids that represent the events.

    +

    Parameters

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

Settings

Member Visibility

On This Page

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

Interface EventStream

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

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

Implemented by

Methods

close +emit +open +subscribe +

Methods

close

emit

open

subscribe

Settings

Member Visibility

On This Page

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

Interface EventSubscription

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

Properties

close +id +

Properties

close

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

id

id: string

Settings

Member Visibility

On This Page

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

Interface MessageStore

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

Implemented by

Methods

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

Methods

clear

  • clear(): Promise<void>

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

    +

    Returns Promise<void>

close

delete

get

open

put

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

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

    +

    Parameters

    Returns Promise<void>

query

Settings

Member Visibility

On This Page

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

Interface MessageStoreOptions

interface MessageStoreOptions {
    signal?: AbortSignal;
}

Properties

signal? +

Properties

Optionalsignal

signal?: AbortSignal

Settings

Member Visibility

On This Page

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

Interface MessageSubscription

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

Properties

close +id +

Properties

close

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

id

id: string

Settings

Member Visibility

On This Page

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

Interface ResumableTaskStore

Interface for interacting with the resumable task store.

+

Implementer's Note: +The store implementation used in a horizontally scalable deployment, such as in a Kubernetes cluster, +must account for concurrent access by multiple ResumableTaskStore instances. +It would be undesirable to have many kubernetes pods all trying to handle the same resumable task. +A minimal viable implementation can use a per tenant exclusive lock on the store when grab() and method is called. +This would prevent issues that occur from concurrent modification to the same task to the store, +but negatively impacts the throughput performance of the DWN. +Requirements for a more performant implementation that allows distributed processing of resumable tasks across multiple clients:

+
    +
  1. The implementation probably requires both: +a. a persistent store for storing the data of each resumable task; and +b. an message streaming queue/service for distributing the each task exclusively to one of multiple handling clients.
    2. +
  2. The grab() and/or open() implementation will need to copy the timed-out tasks from persistent store into the message queue/service +for distributed processing by multiple clients when there is no resumable tasks to grab in the message queue. +During the move, the persistent store should be locked to prevent multiple copies of the same tasks from being copied.
    3. +
  3. Both Google's pub-sub and Amazon's SQS require an Ack ID / Receipt Handle to acknowledge the message, +The value of Ack ID / Receipt Handle is not known until the message is received, +therefore the implementer will likely need to have an in-memory mapping of task ID -> Ack ID / Receipt Handle +so that delete() can be called with task ID.
    4. +
+
interface ResumableTaskStore {
    clear(): Promise<void>;
    close(): Promise<void>;
    delete(taskId: string): Promise<void>;
    extend(taskId: string, timeoutInSeconds: number): Promise<void>;
    grab(count: number): Promise<ManagedResumableTask[]>;
    open(): Promise<void>;
    read(taskId: string): Promise<undefined | ManagedResumableTask>;
    register(task: any, timeoutInSeconds: number): Promise<ManagedResumableTask>;
}

Implemented by

Methods

clear +close +delete +extend +grab +open +read +register +

Methods

clear

close

delete

  • delete(taskId): Promise<void>

  • Deletes the task associated with the task ID provided. +No-op if the task is not found, as this implies that the task has already been completed. +Called when the task has been successfully completed.

    +

    Parameters

    • taskId: string

    Returns Promise<void>

extend

  • extend(taskId, timeoutInSeconds): Promise<void>

  • Extends the timeout of the task associated with the task ID provided. +No-op if the task is not found, as this implies that the task has already been completed. +This allows the client that is executing the task to continue working on it before the task is considered timed out.

    +

    Parameters

    • taskId: string

      ID of the task to extend the timeout for.

      +
    • timeoutInSeconds: number

      Timeout in seconds from the current time.

      +

    Returns Promise<void>

grab

  • grab(count): Promise<ManagedResumableTask[]>

  • Grabs a number of unhandled tasks from the store. +Unhandled tasks are tasks that are not currently in-flight/under processing (ie. tasks that have timed-out). +NOTE: The implementation must make sure that once a task is grabbed by a client, +tis timeout must be updated so that it is considered in-flight/under processing +and cannot be grabbed by another client until it is timed-out.

    +

    Parameters

    • count: number

      Desired number of tasks to grab.

      +

    Returns Promise<ManagedResumableTask[]>

    A list of tasks exclusive for the caller to handle; or empty array if there is no tasks, or if all tasks are already grabbed by others.

    +

open

read

  • read(taskId): Promise<undefined | ManagedResumableTask>

  • Reads the task associated with the task ID provided regardless of whether it is in-flight/under processing or not. +This is mainly introduced for testing purposes: ie. to check the status of a task for easy test verification.

    +

    Parameters

    • taskId: string

      ID of the task to read.

      +

    Returns Promise<undefined | ManagedResumableTask>

register

  • register(task, timeoutInSeconds): Promise<ManagedResumableTask>

  • Registers a new resumable task that is currently in-flight/under processing to the store. +If the task is timed out, a client will be able to grab it through the grab() method and resume the task.

    +

    Parameters

    • task: any

      Task specific data. This is deliberately of type any because this store should not have to be ware of its type.

      +
    • timeoutInSeconds: number

      Timeout in seconds from the current time.

      +

    Returns Promise<ManagedResumableTask>

    A ManagedResumableTask object that can be used to extend or delete the task.

    +

    Throws

    with code set to ResumableTaskAlreadyExists if the same task is already registered.

    +

Settings

Member Visibility

On This Page

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

Interface Signer

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

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

Implemented by

Properties

algorithm +keyId +

Methods

sign +

Properties

algorithm

algorithm: string

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

+

keyId

keyId: string

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

+

Methods

sign

  • sign(content): Promise<Uint8Array>

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

    +

    Parameters

    • content: Uint8Array

    Returns Promise<Uint8Array>

Settings

Member Visibility

On This Page

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

Interface TenantGate

An interface that gates tenant access to the DWN.

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

Implemented by

Methods

isActiveTenant +

Methods

isActiveTenant

Settings

Member Visibility

On This Page

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

Type Alias ActiveTenantCheckResult

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

The result of the isActiveTenant() call.

+

Type declaration

  • Optionaldetail?: string

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

    +
  • isActiveTenant: boolean

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

    +

Settings

Member Visibility
diff --git a/types/CreateFromOptions.html b/types/CreateFromOptions.html new file mode 100644 index 000000000..9c579ffd2 --- /dev/null +++ b/types/CreateFromOptions.html @@ -0,0 +1,4 @@ +CreateFromOptions | DWN-SDK Documentation - v0.4.2

Type Alias CreateFromOptions

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

Type declaration

  • OptionalattestationSigners?: Signer[]
  • Optionaldata?: Uint8Array
  • OptionaldataFormat?: string

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

    +
  • OptionaldatePublished?: string
  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • OptionalencryptionInput?: EncryptionInput
  • OptionalmessageTimestamp?: string
  • OptionalprotocolRole?: string
  • Optionalpublished?: boolean
  • recordsWriteMessage: RecordsWriteMessage
  • Optionalsigner?: Signer

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

    +
  • Optionaltags?: RecordsWriteTags

Settings

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

Type Alias DataEncodedRecordsWriteMessage

DataEncodedRecordsWriteMessage: RecordsWriteMessage & {
    encodedData: string;
}

Represents a RecordsWrite message with encoded data attached.

+

Type declaration

  • encodedData: string

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

    +

Settings

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

Type Alias DataStoreGetResult

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

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

+

Type declaration

  • dataSize: number

    The number of bytes of the data stored.

    +
  • dataStream: Readable

Settings

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

Type Alias DataStorePutResult

DataStorePutResult: {
    dataSize: number;
}

Result of a data store put() method call.

+

Type declaration

  • dataSize: number

    The number of bytes of the data stored.

    +

Settings

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

Type Alias DerivedPrivateJwk

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

Settings

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

Type Alias DwnConfig

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

DWN configuration.

+

Settings

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

Type Alias EncryptionInput

EncryptionInput: {
    algorithm?: EncryptionAlgorithm;
    initializationVector: Uint8Array;
    key: Uint8Array;
    keyEncryptionInputs: KeyEncryptionInput[];
}

Input that describes how data is encrypted as spec-ed in TP18 (https://github.com/TBD54566975/technical-proposals/pull/6).

+

Type declaration

  • Optionalalgorithm?: EncryptionAlgorithm

    Algorithm used for encrypting the Data. Uses {EncryptionAlgorithm.Aes256Ctr} if not given.

    +
  • initializationVector: Uint8Array

    Initialization vector used for encrypting the data.

    +
  • key: Uint8Array

    Symmetric key used to encrypt the data.

    +
  • keyEncryptionInputs: KeyEncryptionInput[]

    Array of input that specifies how the symmetric key is encrypted. +Each entry in the array will result in a unique ciphertext of the symmetric key.

    +

Settings

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

Type Alias EncryptionProperty

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

Settings

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

Type Alias EqualFilter

EqualFilter: string | number | boolean

Settings

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

Type Alias EventListener

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

Settings

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

Type Alias Filter

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

Settings

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

Type Alias GenericMessage

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

Intersection type for all concrete message types.

+

Settings

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

Type Alias GenericMessageReply

GenericMessageReply: {
    status: Status;
}

Settings

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

Type Alias KeyEncryptionInput

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

Input that specifies how a symmetric key is encrypted.

+

Type declaration

  • Optionalalgorithm?: EncryptionAlgorithm

    Algorithm used for encrypting the symmetric key. Uses {EncryptionAlgorithm.EciesSecp256k1} if not given.

    +
  • derivationScheme: KeyDerivationScheme

    Key derivation scheme used to derive the public key to encrypt the symmetric key.

    +
  • publicKey: PublicJwk

    Public key to be used to encrypt the symmetric key.

    +
  • publicKeyId: string

    Fully qualified ID of root public key used derive the public key to be used to to encrypt the symmetric key. +(e.g. did:example:abc#encryption-key-id)

    +

Settings

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

Type Alias KeyMaterial

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

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

+

Settings

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

Type Alias ManagedResumableTask

ManagedResumableTask: {
    id: string;
    retryCount: number;
    task: any;
    timeout: number;
}

An managed resumable task model.

+

Type declaration

  • id: string

    Globally unique ID. Used to extend or delete the task.

    +
  • retryCount: number

    Number of retries

    +
  • task: any

    Task specific data. This is deliberately of type any because this store should not have to be ware of its type.

    +
  • timeout: number

    Task timeout in Epoch Time.

    +

Settings

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

Type Alias MessageEvent

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

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

+

Type declaration

Settings

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

Type Alias MessageSort

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

Settings

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

Type Alias MessageSubscriptionHandler

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

Settings

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

Type Alias MessagesFilter

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

filters used when filtering for any type of Message across interfaces

+

Settings

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

Type Alias MessagesPermissionScope

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

Settings

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

Type Alias MessagesQueryMessage

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

Settings

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

Type Alias MessagesQueryOptions

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

Settings

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

Type Alias MessagesQueryReply

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

Settings

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

Type Alias MessagesReadMessage

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

Settings

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

Type Alias MessagesReadOptions

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

Settings

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

Type Alias MessagesReadReply

MessagesReadReply: GenericMessageReply & {
    entry?: MessagesReadReplyEntry;
}

Settings

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

Type Alias MessagesReadReplyEntry

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

Settings

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

Type Alias MessagesSubscribeDescriptor

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

Settings

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

Type Alias MessagesSubscribeMessage

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

Settings

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

Type Alias MessagesSubscribeOptions

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

Settings

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

Type Alias MessagesSubscribeReply

MessagesSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Settings

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

Type Alias OneOfFilter

OneOfFilter: EqualFilter[]

Settings

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

Type Alias Pagination

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

Pagination Options for querying messages.

+

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

+

Settings

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

Type Alias PaginationCursor

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

Settings

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

Type Alias PermissionConditions

PermissionConditions: {
    publication?: PermissionConditionPublication;
}

Type declaration

  • Optionalpublication?: PermissionConditionPublication

    indicates whether a message written with the invocation of a permission must, may, or must not +be marked as public. +If undefined, it is optional to make the message public.

    +

Settings

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

Type Alias PermissionGrantData

PermissionGrantData: {
    conditions?: PermissionConditions;
    dateExpires: string;
    delegated?: boolean;
    description?: string;
    requestId?: string;
    scope: PermissionScope;
}

Type for the data payload of a permission grant message.

+

Type declaration

  • Optionalconditions?: PermissionConditions
  • dateExpires: string

    Timestamp at which this grant will no longer be active.

    +
  • Optionaldelegated?: boolean

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

    +
  • Optionaldescription?: string

    Optional string that communicates what the grant would be used for

    +
  • OptionalrequestId?: string

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

    +
  • scope: PermissionScope

    The scope of the allowed access.

    +

Settings

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

Type Alias PermissionRequestData

PermissionRequestData: {
    conditions?: PermissionConditions;
    delegated: boolean;
    description?: string;
    scope: PermissionScope;
}

Type for the data payload of a permission request message.

+

Type declaration

  • Optionalconditions?: PermissionConditions
  • delegated: boolean

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

    +
  • Optionaldescription?: string

    Optional string that communicates what the grant would be used for.

    +
  • scope: PermissionScope

    The scope of the allowed access.

    +

Settings

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

Type Alias PermissionRevocationData

PermissionRevocationData: {
    description?: string;
}

Type for the data payload of a permission revocation message.

+

Type declaration

  • Optionaldescription?: string

    Optional string that communicates the details of the revocation.

    +

Settings

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

Type Alias PermissionScope

PermissionScope: ProtocolPermissionScope | MessagesPermissionScope | RecordsPermissionScope

The data model for a permission scope.

+

Settings

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

Type Alias Persona

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

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

+

Settings

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

Type Alias PrivateJwk

PrivateJwk: PublicJwk & {
    d: string;
}

Type declaration

  • d: string

    the Elliptic Curve private key value. +It is represented as the base64url encoding of the octet string representation of the private key value +MUST be present to represent Elliptic Curve private keys.

    +

Settings

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

Type Alias ProtocolDefinition

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

Type declaration

  • protocol: string
  • published: boolean

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

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

Settings

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

Type Alias ProtocolPermissionScope

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

Settings

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

Type Alias ProtocolRuleSet

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

Type declaration

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

    Encryption setting for objects that are in this protocol path.

    +
  • Optional$role?: boolean

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

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

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

    +
    • Optionalmax?: number
    • Optionalmin?: number
  • Optional$tags?: {
        $allowUndefinedTags?: boolean;
        $requiredTags?: string[];
        [key: string]: any;
    }

    If $tags is set, the record must conform to the tag rules.

    +
    • [key: string]: any
    • Optional$allowUndefinedTags?: boolean

      allow properties other than those explicitly listed. defaults to false

      +
    • Optional$requiredTags?: string[]

      array of required tags

      +

Settings

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

Type Alias ProtocolTypes

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

Settings

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

Type Alias ProtocolsConfigureDescriptor

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

Settings

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

Type Alias ProtocolsConfigureMessage

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

Settings

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

Type Alias ProtocolsConfigureOptions

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

Settings

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

Type Alias ProtocolsQueryFilter

ProtocolsQueryFilter: {
    protocol: string;
}

Settings

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

Type Alias ProtocolsQueryMessage

ProtocolsQueryMessage: GenericMessage & {
    descriptor: ProtocolsQueryDescriptor;
}

Settings

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

Type Alias ProtocolsQueryOptions

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

Settings

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

Type Alias ProtocolsQueryReply

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

Settings

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

Type Alias PublicJwk

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

Type declaration

  • crv: "Ed25519" | "secp256k1" | "P-256"

    The "crv" (curve) parameter identifies the cryptographic curve used with the key. +MUST be present for all EC public keys

    +
  • x: string

    the x coordinate for the Elliptic Curve point. +Represented as the base64url encoding of the octet string representation of the coordinate. +MUST be present for all EC public keys

    +
  • Optionaly?: string

    the y coordinate for the Elliptic Curve point. +Represented as the base64url encoding of the octet string representation of the coordinate.

    +

Settings

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

Type Alias QueryOptions

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

Settings

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

Type Alias QueryResultEntry

QueryResultEntry: GenericMessage & {
    encodedData?: string;
}

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

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

Settings

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

Type Alias RangeCriterion

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

Type declaration

  • Optionalfrom?: string

    Inclusive starting date-time.

    +
  • Optionalto?: string

    Inclusive end date-time.

    +

Settings

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

Type Alias RangeFilter

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

Ranger filter. 1 condition is required.

+

Settings

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

Type Alias RecordSubscriptionHandler

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

Settings

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

Type Alias RecordsDeleteMessage

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

Settings

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

Type Alias RecordsDeleteOptions

RecordsDeleteOptions: {
    delegatedGrant?: DataEncodedRecordsWriteMessage;
    messageTimestamp?: string;
    protocolRole?: string;
    prune?: boolean;
    recordId: string;
    signer: Signer;
}

Type declaration

  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • OptionalmessageTimestamp?: string
  • OptionalprotocolRole?: string
  • Optionalprune?: boolean

    Denotes if all the descendent records should be purged. Defaults to false.

    +
  • recordId: string
  • signer: Signer

Settings

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

Type Alias RecordsPermissionScope

RecordsPermissionScope: {
    contextId?: string;
    interface: Records;
    method:
        | Read
        | Write
        | Query
        | Subscribe
        | Delete;
    protocol: string;
    protocolPath?: string;
}

The data model for a permission scope that is specific to the Records interface.

+

Type declaration

  • OptionalcontextId?: string

    May only be present when protocol is defined and protocolPath is undefined

    +
  • interface: Records
  • method:
        | Read
        | Write
        | Query
        | Subscribe
        | Delete
  • protocol: string
  • OptionalprotocolPath?: string

    May only be present when protocol is defined and contextId is undefined

    +

Settings

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

Type Alias RecordsQueryMessage

RecordsQueryMessage: GenericMessage & {
    descriptor: RecordsQueryDescriptor;
}

Settings

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

Type Alias RecordsQueryOptions

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

Type declaration

  • OptionaldateSort?: DateSort
  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • filter: RecordsFilter
  • OptionalmessageTimestamp?: string
  • Optionalpagination?: Pagination
  • OptionalprotocolRole?: string
  • Optionalsigner?: Signer

Settings

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

Type Alias RecordsQueryReply

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

Settings

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

Type Alias RecordsQueryReplyEntry

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

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

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

Type declaration

  • OptionalencodedData?: string

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

    +
  • OptionalinitialWrite?: RecordsWriteMessage

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

    +

Settings

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

Type Alias RecordsReadMessage

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

Settings

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

Type Alias RecordsReadOptions

RecordsReadOptions: {
    delegatedGrant?: DataEncodedRecordsWriteMessage;
    filter: RecordsFilter;
    messageTimestamp?: string;
    permissionGrantId?: string;
    protocolRole?: string;
    signer?: Signer;
}

Type declaration

  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • filter: RecordsFilter
  • OptionalmessageTimestamp?: string
  • OptionalpermissionGrantId?: string
  • OptionalprotocolRole?: string

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

    +
  • Optionalsigner?: Signer

Settings

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

Type Alias RecordsReadReply

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

Settings

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

Type Alias RecordsSubscribeDescriptor

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

Settings

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

Type Alias RecordsSubscribeMessage

RecordsSubscribeMessage: GenericMessage & {
    descriptor: RecordsSubscribeDescriptor;
}

Settings

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

Type Alias RecordsSubscribeOptions

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

Type declaration

  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • filter: RecordsFilter
  • OptionalmessageTimestamp?: string
  • OptionalprotocolRole?: string
  • Optionalsigner?: Signer

Settings

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

Type Alias RecordsSubscribeReply

RecordsSubscribeReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Settings

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

Type Alias RecordsWriteDescriptor

RecordsWriteDescriptor: {
    dataCid: string;
    dataFormat: string;
    dataSize: number;
    dateCreated: string;
    datePublished?: string;
    interface: Records;
    messageTimestamp: string;
    method: Write;
    parentId?: string;
    protocol?: string;
    protocolPath?: string;
    published?: boolean;
    recipient?: string;
    schema?: string;
    tags?: RecordsWriteTags;
}

Settings

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

Type Alias RecordsWriteMessage

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

Settings

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

Type Alias RecordsWriteOptions

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

Type declaration

  • OptionalattestationSigners?: Signer[]
  • Optionaldata?: Uint8Array
  • OptionaldataCid?: string
  • dataFormat: string
  • OptionaldataSize?: number
  • OptionaldateCreated?: string
  • OptionaldatePublished?: string
  • OptionaldelegatedGrant?: DataEncodedRecordsWriteMessage

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

    +
  • OptionalencryptionInput?: EncryptionInput
  • OptionalmessageTimestamp?: string
  • OptionalparentContextId?: string

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

    +
  • OptionalpermissionGrantId?: string
  • Optionalprotocol?: string
  • OptionalprotocolPath?: string
  • OptionalprotocolRole?: string
  • Optionalpublished?: boolean
  • Optionalrecipient?: string
  • OptionalrecordId?: string
  • Optionalschema?: string
  • Optionalsigner?: Signer

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

    +
  • Optionaltags?: RecordsWriteTags

Settings

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

Type Alias RecordsWriteTagValue

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

Settings

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

Type Alias RecordsWriteTags

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

Settings

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

Type Alias SubscriptionReply

SubscriptionReply: GenericMessageReply & {
    subscription?: MessageSubscription;
}

Settings

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

Type Alias UnionMessageReply

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

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

+

Type declaration

  • Optionalcursor?: PaginationCursor

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

    +
  • Optionalentries?: QueryResultEntry[] | ProtocolsConfigureMessage[] | string[]

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

    +
  • Optionalentry?: MessagesReadReplyEntry

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

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

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

    +
  • Optionalsubscription?: MessageSubscription

    A subscription object if a subscription was requested.

    +

Settings

Member Visibility