update main to latest development work

.github/workflows/main.yml

@@ -11,12 +11,12 @@ on:
   workflow_dispatch:
 jobs:
   build:
-    name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
+    name: Build, lint, and test on Node 18.12.1 and ${{ matrix.os }}
 
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ macOS-latest]
+        os: [ macOS-latest, ubuntu-latest]
 
     steps:
       - name: Checkout repo
@@ -38,4 +38,4 @@ jobs:
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v3
         env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/update-documentation.yml

@@ -0,0 +1,39 @@
+name: CI
+on:
+  push:
+    branches:
+      - 'main'
+  workflow_dispatch:
+jobs:
+  update:
+    name: Updater documentation
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '18.12.1'
+          cache: 'npm'
+
+      - name: build
+        run: |
+          npm cache clean --force
+          npm set registry https://registry.npmjs.org/
+          npm i
+          npx typedoc src/index.ts
+
+      - name: Commit files
+        run: |
+            git config --local user.email "github-actions[bot]@users.noreply.github.com"
+            git config --local user.name "github-actions[bot]"
+            git add .
+            git commit -a -m "Update documentation"
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}

README.md

@@ -5,6 +5,7 @@ Project Name: signify-ts
 [![TypeScript](https://badges.frapsoft.com/typescript/code/typescript.png?v=101)](https://github.com/ellerbrock/typescript-badges/)
 [![Tests](https://github.com/WebOfTrust/signify-ts/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/WebOfTrust/signify-ts/actions/workflows/main.yml)
 [![codecov](https://codecov.io/gh/WebOfTrust/signify-ts/branch/main/graph/badge.svg?token=K3GK7MCYVW)](https://codecov.io/gh/WebOfTrust/signify-ts)
+[![Documentation](https://img.shields.io/badge/documentation-grey?)](https://weboftrust.github.io/signify-ts/)
 
 ## Signify - KERI Signing at the Edge
 
@@ -17,7 +18,7 @@ Of the five functions in a KERI agent,
 5. Event Validation
 
 Signify-TS splits off two, key generation and event signing into a TypeScript library to provide "signing at the edge".
-It accomplishes this by using [libsodium](https://doc.libsodium.org/) to generate ed25510 key pairs for signing and x25519 key pairs for encrypting the
+It accomplishes this by using [libsodium](https://doc.libsodium.org/) to generate ed25519 key pairs for signing and x25519 key pairs for encrypting the
 private keys, next public keys and salts used to generate the private keys.  The encrypted private key and salts are then stored on a
 remote cloud agent that never has access to the decryption keys.  New key pair sets (current and next) will be generated 
 for inception and rotation events with only the public keys and blake3 hash of the next keys made available to the agent.

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/6de32b6/src/keri/core/authing.ts#L7">keri/core/authing.ts:7</a></li></ul></aside>
+<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>
 <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/6de32b6/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/m00sey/signify-ts/blob/119d3df/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/6de32b6/src/keri/core/authing.ts#L16">keri/core/authing.ts:16</a></li></ul></aside></section>
+<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>
 <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/6de32b6/src/keri/core/authing.ts#L15">keri/core/authing.ts:15</a></li></ul></aside></section>
+<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>
 <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/6de32b6/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/m00sey/signify-ts/blob/119d3df/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/6de32b6/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/m00sey/signify-ts/blob/119d3df/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/6de32b6/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/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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -150,42 +150,53 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="Authenticater.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Authenticater</span></a></li>
 <li><a href="BexCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Bex<wbr/>Codex</span></a></li>
 <li><a href="CesrNumber.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cesr<wbr/>Number</span></a></li>
+<li><a href="Challenges.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Challenges</span></a></li>
 <li><a href="Cigar.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cigar</span></a></li>
 <li><a href="Cipher.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cipher</span></a></li>
-<li><a href="Client.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Client</span></a></li>
 <li><a href="Codex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Codex</span></a></li>
+<li><a href="Contacts.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Contacts</span></a></li>
 <li><a href="Controller.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Controller</span></a></li>
 <li><a href="Counter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Counter</span></a></li>
 <li><a href="CounterCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Counter<wbr/>Codex</span></a></li>
 <li><a href="Creatory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Creatory</span></a></li>
 <li><a href="CredentialTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Credential<wbr/>Types</span></a></li>
+<li><a href="Credentials.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Credentials</span></a></li>
 <li><a href="Decrypter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Decrypter</span></a></li>
 <li><a href="Diger.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Diger</span></a></li>
 <li><a href="DigiCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Digi<wbr/>Codex</span></a></li>
 <li><a href="EmptyMaterialError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Empty<wbr/>Material<wbr/>Error</span></a></li>
 <li><a href="Encrypter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Encrypter</span></a></li>
+<li><a href="Escrows.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Escrows</span></a></li>
 <li><a href="GroupKeeper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Group<wbr/>Keeper</span></a></li>
 <li><a href="Hab.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Hab</span></a></li>
 <li><a href="Habery.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Habery</span></a></li>
+<li><a href="Identifier.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Identifier</span></a></li>
 <li><a href="IndexedBothSigCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Indexed<wbr/>Both<wbr/>Sig<wbr/>Codex</span></a></li>
 <li><a href="IndexedCurrentSigCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Indexed<wbr/>Current<wbr/>Sig<wbr/>Codex</span></a></li>
 <li><a href="IndexedSigCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Indexed<wbr/>Sig<wbr/>Codex</span></a></li>
 <li><a href="Indexer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Indexer</span></a></li>
 <li><a href="IndexerCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Indexer<wbr/>Codex</span></a></li>
 <li><a href="Inputage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Inputage</span></a></li>
+<li><a href="KeyEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Key<wbr/>Events</span></a></li>
 <li><a href="KeyManager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Key<wbr/>Manager</span></a></li>
+<li><a href="KeyStates.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Key<wbr/>States</span></a></li>
 <li><a href="Manager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Manager</span></a></li>
 <li><a href="Matter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Matter</span></a></li>
 <li><a href="MatterCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Matter<wbr/>Codex</span></a></li>
 <li><a href="NonTransCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Non<wbr/>Trans<wbr/>Codex</span></a></li>
+<li><a href="Notifications.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Notifications</span></a></li>
 <li><a href="NumCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Num<wbr/>Codex</span></a></li>
+<li><a href="Oobis.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Oobis</span></a></li>
+<li><a href="Operations.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Operations</span></a></li>
 <li><a href="Prefixer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Prefixer</span></a></li>
 <li><a href="RandyCreator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Randy<wbr/>Creator</span></a></li>
 <li><a href="RandyKeeper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Randy<wbr/>Keeper</span></a></li>
+<li><a href="Registries.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Registries</span></a></li>
 <li><a href="Saider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Saider</span></a></li>
 <li><a href="Salter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Salter</span></a></li>
 <li><a href="SaltyCreator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Salty<wbr/>Creator</span></a></li>
 <li><a href="SaltyKeeper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Salty<wbr/>Keeper</span></a></li>
+<li><a href="Schemas.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Schemas</span></a></li>
 <li><a href="Seqner.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Seqner</span></a></li>
 <li><a href="Serder.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Serder</span></a></li>
 <li><a href="Siger.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Siger</span></a></li>