feat(docs): (bc3c361) chore(release): release 3.0.0

# [3.0.0](v2.5.0...v3.0.0) (2023-11-07)

* docs!: Introduced breaking changes in Pluto as we are intro… (#116) ([be8c6e8](be8c6e8)), closes [#116](#116)

### Features

* **Agent:** add initialize function ([#107](#107)) ([14389a1](14389a1))

### BREAKING CHANGES

* Introduced breaking changes in Pluto as we are introducing credential abstraction and anoncred issuing functionality.
- X25519 keys were wrongly set as EC (elliptic) key types which is wrong. EC25519 + Secp256k1 belong to EC key type, X25519 should have Curve25519 instead to be valid. If you previously had a key stored as EC (x25519) changing that keyType to KeyTypes.X25519 (Curve25519).
- As we have introduced new credential types we have also built a credential abstraction so storing and fetching credentials becomes easier.

classes/AnonCredsCredential.html

@@ -26,7 +26,7 @@ <h4>Implements</h4>
 <ul class="tsd-hierarchy">
 <li><a href="../interfaces/Domain.StorableCredential.html" class="tsd-signature-type tsd-kind-interface">StorableCredential</a></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/pollux/models/AnonCredsVerifiableCredential.ts#L19">src/pollux/models/AnonCredsVerifiableCredential.ts:19</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/pollux/models/AnonCredsVerifiableCredential.ts#L19">src/pollux/models/AnonCredsVerifiableCredential.ts:19</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">
@@ -71,26 +71,26 @@ <h5><span class="tsd-kind-parameter">credential</span>: <a href="../modules/Doma
 <h4 class="tsd-returns-title">Returns <a href="AnonCredsCredential.html" class="tsd-signature-type tsd-kind-class">AnonCredsCredential</a></h4><aside class="tsd-sources">
 <p>Overrides <a href="Domain.Credential.html">Credential</a>.<a href="Domain.Credential.html#constructor">constructor</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/pollux/models/AnonCredsVerifiableCredential.ts#L27">src/pollux/models/AnonCredsVerifiableCredential.ts:27</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/pollux/models/AnonCredsVerifiableCredential.ts#L27">src/pollux/models/AnonCredsVerifiableCredential.ts:27</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="credentialType" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>credential<wbr/>Type</span><a href="#credentialType" 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">credential<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/Domain.CredentialType.html" class="tsd-signature-type tsd-kind-enum">CredentialType</a><span class="tsd-signature-symbol"> = CredentialType.AnonCreds</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/pollux/models/AnonCredsVerifiableCredential.ts#L23">src/pollux/models/AnonCredsVerifiableCredential.ts:23</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/pollux/models/AnonCredsVerifiableCredential.ts#L23">src/pollux/models/AnonCredsVerifiableCredential.ts:23</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="properties" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>properties</span><a href="#properties" 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">properties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Map</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/AnonCredsCredentialProperties.html" class="tsd-signature-type tsd-kind-enum">AnonCredsCredentialProperties</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <p>Overrides <a href="Domain.Credential.html">Credential</a>.<a href="Domain.Credential.html#properties">properties</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/pollux/models/AnonCredsVerifiableCredential.ts#L25">src/pollux/models/AnonCredsVerifiableCredential.ts:25</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/pollux/models/AnonCredsVerifiableCredential.ts#L25">src/pollux/models/AnonCredsVerifiableCredential.ts:25</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="recoveryId" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>recovery<wbr/>Id</span><a href="#recoveryId" 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">recovery<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = AnonCredsRecoveryId</span></div><aside class="tsd-sources">
 <p>Overrides <a href="Domain.Credential.html">Credential</a>.<a href="Domain.Credential.html#recoveryId">recoveryId</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/pollux/models/AnonCredsVerifiableCredential.ts#L24">src/pollux/models/AnonCredsVerifiableCredential.ts:24</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/pollux/models/AnonCredsVerifiableCredential.ts#L24">src/pollux/models/AnonCredsVerifiableCredential.ts:24</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Accessors</h2>
 <section class="tsd-panel tsd-member"><a id="claims" class="tsd-anchor"></a>
@@ -101,7 +101,7 @@ <h3 class="tsd-anchor-link"><span>claims</span><a href="#claims" aria-label="Per
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
 <p>Overrides Credential.claims</p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/pollux/models/AnonCredsVerifiableCredential.ts#L56">src/pollux/models/AnonCredsVerifiableCredential.ts:56</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/pollux/models/AnonCredsVerifiableCredential.ts#L56">src/pollux/models/AnonCredsVerifiableCredential.ts:56</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">
@@ -110,7 +110,7 @@ <h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink"
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
 <p>Overrides Credential.id</p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/pollux/models/AnonCredsVerifiableCredential.ts#L52">src/pollux/models/AnonCredsVerifiableCredential.ts:52</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/pollux/models/AnonCredsVerifiableCredential.ts#L52">src/pollux/models/AnonCredsVerifiableCredential.ts:52</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="issuer" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>issuer</span><a href="#issuer" 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">
@@ -119,7 +119,7 @@ <h3 class="tsd-anchor-link"><span>issuer</span><a href="#issuer" aria-label="Per
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
 <p>Overrides Credential.issuer</p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/pollux/models/AnonCredsVerifiableCredential.ts#L65">src/pollux/models/AnonCredsVerifiableCredential.ts:65</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/pollux/models/AnonCredsVerifiableCredential.ts#L65">src/pollux/models/AnonCredsVerifiableCredential.ts:65</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="subject" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>subject</span><a href="#subject" 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">
@@ -128,7 +128,7 @@ <h3 class="tsd-anchor-link"><span>subject</span><a href="#subject" aria-label="P
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
 <p>Overrides Credential.subject</p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/pollux/models/AnonCredsVerifiableCredential.ts#L61">src/pollux/models/AnonCredsVerifiableCredential.ts:61</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/pollux/models/AnonCredsVerifiableCredential.ts#L61">src/pollux/models/AnonCredsVerifiableCredential.ts:61</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="getProperty" class="tsd-anchor"></a>
@@ -144,7 +144,7 @@ <h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-typ
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
 <p>Inherited from <a href="Domain.Credential.html">Credential</a>.<a href="Domain.Credential.html#getProperty">getProperty</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/domain/models/Credential.ts#L19">src/domain/models/Credential.ts:19</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/domain/models/Credential.ts#L19">src/domain/models/Credential.ts:19</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="isProvable" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>is<wbr/>Provable</span><a href="#isProvable" 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-inherited">
@@ -153,7 +153,7 @@ <h3 class="tsd-anchor-link"><span>is<wbr/>Provable</span><a href="#isProvable" a
 <h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol"> is </span><a href="../interfaces/Domain.ProvableCredential.html" class="tsd-signature-type tsd-kind-interface">ProvableCredential</a></h4><aside class="tsd-sources">
 <p>Inherited from <a href="Domain.Credential.html">Credential</a>.<a href="Domain.Credential.html#isProvable">isProvable</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/domain/models/Credential.ts#L23">src/domain/models/Credential.ts:23</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/domain/models/Credential.ts#L23">src/domain/models/Credential.ts:23</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="isStorable" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>is<wbr/>Storable</span><a href="#isStorable" 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-inherited">
@@ -162,7 +162,7 @@ <h3 class="tsd-anchor-link"><span>is<wbr/>Storable</span><a href="#isStorable" a
 <h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol"> is </span><a href="../interfaces/Domain.StorableCredential.html" class="tsd-signature-type tsd-kind-interface">StorableCredential</a></h4><aside class="tsd-sources">
 <p>Inherited from <a href="Domain.Credential.html">Credential</a>.<a href="Domain.Credential.html#isStorable">isStorable</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/domain/models/Credential.ts#L27">src/domain/models/Credential.ts:27</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/domain/models/Credential.ts#L27">src/domain/models/Credential.ts:27</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="toStorable" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>to<wbr/>Storable</span><a href="#toStorable" 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">
@@ -186,7 +186,7 @@ <h5><span class="tsd-kind-property">subject</span><span class="tsd-signature-sym
 <h5><span class="tsd-kind-property">valid<wbr/>Until</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5></li></ul><aside class="tsd-sources">
 <p>Implementation of <a href="../interfaces/Domain.StorableCredential.html">StorableCredential</a>.<a href="../interfaces/Domain.StorableCredential.html#toStorable">toStorable</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/d616f73/src/pollux/models/AnonCredsVerifiableCredential.ts#L69">src/pollux/models/AnonCredsVerifiableCredential.ts:69</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/bc3c361/src/pollux/models/AnonCredsVerifiableCredential.ts#L69">src/pollux/models/AnonCredsVerifiableCredential.ts:69</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">