Update documentation

cardano-foundation · Aug 24, 2023 · ee3df3e · ee3df3e
1 parent 2ee551e
commit ee3df3e
Show file tree

Hide file tree

Showing 151 changed files with 1,402 additions and 1,020 deletions.
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/Agent.html b/docs/classes/Agent.html
@@ -25,7 +25,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">Agent</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L20">keri/app/controller.ts:20</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L20">keri/app/controller.ts:20</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -63,39 +63,39 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">agent</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="Agent.html" class="tsd-signature-type tsd-kind-class">Agent</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L28">keri/app/controller.ts:28</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L28">keri/app/controller.ts:28</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="anchor" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>anchor</span><a href="#anchor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">anchor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L22">keri/app/controller.ts:22</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L22">keri/app/controller.ts:22</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="pre" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>pre</span><a href="#pre" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">pre</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L21">keri/app/controller.ts:21</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L21">keri/app/controller.ts:21</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="said" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>said</span><a href="#said" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">said</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L26">keri/app/controller.ts:26</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L26">keri/app/controller.ts:26</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="sn" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>sn</span><a href="#sn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">sn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L25">keri/app/controller.ts:25</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L25">keri/app/controller.ts:25</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="state" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L24">keri/app/controller.ts:24</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L24">keri/app/controller.ts:24</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="verfer" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>verfer</span><a href="#verfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">verfer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Verfer.html" class="tsd-signature-type tsd-kind-class">Verfer</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L23">keri/app/controller.ts:23</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L23">keri/app/controller.ts:23</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="event" class="tsd-anchor"></a>
@@ -110,7 +110,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">evt</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="Verfer.html" class="tsd-signature-type tsd-kind-class">Verfer</a><span class="tsd-signature-symbol">, </span><a href="Diger.html" class="tsd-signature-type tsd-kind-class">Diger</a><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L60">keri/app/controller.ts:60</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L60">keri/app/controller.ts:60</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="parse" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>parse</span><a href="#parse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-is-private">
@@ -123,7 +123,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">agent</span>: <a href="Agent.html" class="tsd-signature-type tsd-kind-class">Agent</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L38">keri/app/controller.ts:38</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L38">keri/app/controller.ts:38</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -290,6 +290,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="../functions/nowUTC.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>nowUTC</span></a></li>
 <li><a href="../functions/openManager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>open<wbr/>Manager</span></a></li>
 <li><a href="../functions/pad.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>pad</span></a></li>
+<li><a href="../functions/parseRangeHeaders.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>parse<wbr/>Range<wbr/>Headers</span></a></li>
 <li><a href="../functions/randomNonce.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>random<wbr/>Nonce</span></a></li>
 <li><a href="../functions/randomPasscode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>random<wbr/>Passcode</span></a></li>
 <li><a href="../functions/range.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>range</span></a></li>

diff --git a/docs/classes/Authenticater.html b/docs/classes/Authenticater.html
@@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">Authenticater</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L7">keri/core/authing.ts:7</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L7">keri/core/authing.ts:7</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -57,24 +57,24 @@ <h5><span class="tsd-kind-parameter">csig</span>: <a href="Signer.html" class="t
 <h5><span class="tsd-kind-parameter">verfer</span>: <a href="Verfer.html" class="tsd-signature-type tsd-kind-class">Verfer</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="Authenticater.html" class="tsd-signature-type tsd-kind-class">Authenticater</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L18">keri/core/authing.ts:18</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L18">keri/core/authing.ts:18</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_csig" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>_csig</span><a href="#_csig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">_csig</span><span class="tsd-signature-symbol">:</span> <a href="Signer.html" class="tsd-signature-type tsd-kind-class">Signer</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L16">keri/core/authing.ts:16</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L16">keri/core/authing.ts:16</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_verfer" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_verfer</span><a href="#_verfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">_verfer</span><span class="tsd-signature-symbol">:</span> <a href="Verfer.html" class="tsd-signature-type tsd-kind-class">Verfer</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L15">keri/core/authing.ts:15</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L15">keri/core/authing.ts:15</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="DefaultFields" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>Default<wbr/>Fields</span><a href="#DefaultFields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">Default<wbr/>Fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L9">keri/core/authing.ts:9</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L9">keri/core/authing.ts:9</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member"><a id="sign" class="tsd-anchor"></a>
@@ -95,7 +95,7 @@ <h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-typ
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">fields</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Headers</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L84">keri/core/authing.ts:84</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L84">keri/core/authing.ts:84</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="verify" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>verify</span><a href="#verify" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -112,7 +112,7 @@ <h5><span class="tsd-kind-parameter">method</span>: <span class="tsd-signature-t
 <h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L23">keri/core/authing.ts:23</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L23">keri/core/authing.ts:23</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -276,6 +276,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="../functions/nowUTC.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>nowUTC</span></a></li>
 <li><a href="../functions/openManager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>open<wbr/>Manager</span></a></li>
 <li><a href="../functions/pad.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>pad</span></a></li>
+<li><a href="../functions/parseRangeHeaders.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>parse<wbr/>Range<wbr/>Headers</span></a></li>
 <li><a href="../functions/randomNonce.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>random<wbr/>Nonce</span></a></li>
 <li><a href="../functions/randomPasscode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>random<wbr/>Passcode</span></a></li>
 <li><a href="../functions/range.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>range</span></a></li>