chore(release): 🚀 api docs v5.6.0

uport-project · Jan 16, 2024 · a9e0c14 · a9e0c14
1 parent 17de124
commit a9e0c14
Show file tree

Hide file tree

Showing 98 changed files with 1,494 additions and 435 deletions.
diff --git a/docs/api/core-types.diddocumentsection.md b/docs/api/core-types.diddocumentsection.md
@@ -15,13 +15,5 @@ See [verification relationships](https://www.w3.org/TR/did-core/#verification-re
 **Signature:**
 
 ```typescript
-export type DIDDocumentSection =
-  | 'verificationMethod'
-  | 'publicKey'
-  | 'service'
-  | 'authentication'
-  | 'assertionMethod'
-  | 'keyAgreement'
-  | 'capabilityInvocation'
-  | 'capabilityDelegation'
+export type DIDDocumentSection = KeyCapabilitySection | 'verificationMethod' | 'publicKey' | 'service'
 ```
diff --git a/docs/api/core-types.icredentialissuer.listusableproofformats.md b/docs/api/core-types.icredentialissuer.listusableproofformats.md
@@ -0,0 +1,30 @@
+---
+id: core-types.icredentialissuer.listusableproofformats
+title: ICredentialIssuer.listUsableProofFormats() method
+hide_title: true
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ICredentialIssuer.listUsableProofFormats() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Returns a list of supported proof formats.
+
+**Signature:**
+
+```typescript
+listUsableProofFormats(identifier: IIdentifier, context: IAgentContext<{}>): Promise<Array<ProofFormat>>;
+```
+
+## Parameters
+
+| Parameter  | Type                                                     | Description                                                                                                                                                     |
+| ---------- | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| identifier | [IIdentifier](./core-types.iidentifier.md)               | The identifier that may be used to sign a credential or presentation                                                                                            |
+| context    | [IAgentContext](./core-types.iagentcontext.md)&lt;{}&gt; | <p>This reserved param is automatically added and handled by the framework, \*do not override\*</p><p>This API may change without a BREAKING CHANGE notice.</p> |
+
+**Returns:**
+
+Promise&lt;Array&lt;[ProofFormat](./core-types.proofformat.md)&gt;&gt;
diff --git a/docs/api/core-types.icredentialissuer.md b/docs/api/core-types.icredentialissuer.md
@@ -28,3 +28,4 @@ Please see [W3C Verifiable Credentials data model](https://www.w3.org/TR/vc-data
 | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
 | [createVerifiableCredential(args, context)](./core-types.icredentialissuer.createverifiablecredential.md)     | Creates a Verifiable Credential. The payload, signer and format are chosen based on the <code>args</code> parameter.   |
 | [createVerifiablePresentation(args, context)](./core-types.icredentialissuer.createverifiablepresentation.md) | Creates a Verifiable Presentation. The payload, signer and format are chosen based on the <code>args</code> parameter. |
+| [listUsableProofFormats(identifier, context)](./core-types.icredentialissuer.listusableproofformats.md)       | **_(BETA)_** Returns a list of supported proof formats.                                                                |
diff --git a/docs/api/core-types.iresolver.resolvedid.md b/docs/api/core-types.iresolver.resolvedid.md
@@ -33,7 +33,7 @@ const doc = await agent.resolveDid({
   didUrl: 'did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190',
 })
 expect(doc.didDocument).toEqual({
-  '@context': ['https://www.w3.org/ns/did/v1', 'https://w3id.org/security/suites/secp256k1recovery-2020/v2'],
+  '@context': expect.anything(),
   id: 'did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190',
   verificationMethod: [
     {

diff --git a/docs/api/core-types.md b/docs/api/core-types.md
@@ -132,7 +132,7 @@ Provides [Agent](./core.agent.md) implementation and defines [IResolver](./core-
 | [ProofFormat](./core-types.proofformat.md)                                 | <p>The type of encoding to be used for the Verifiable Credential or Presentation to be generated.</p><p>Only <code>jwt</code> and <code>lds</code> is supported at the moment.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [RequireOnly](./core-types.requireonly.md)                                 | Represents an object type where a subset of keys are required and everything else is optional.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | [TAgent](./core-types.tagent.md)                                           | Utility type for constructing agent type that has a list of available methods                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
-| [TAlg](./core-types.talg.md)                                               | <p>Known algorithms supported by some of the above key types defined by [TKeyType](./core-types.tkeytype.md).</p><p>Actual implementations of [Key Management Systems](./key-manager.abstractkeymanagementsystem.md) can support more. One should check the property to see what is possible for a particular managed key.</p>                                                                                                                                                                                                                                                                                                                                                 |
+| [TAlg](./core-types.talg.md)                                               | <p>Known algorithms supported by some of the above key types defined by [TKeyType](./core-types.tkeytype.md).</p><p>Actual implementations of [Key Management Systems](./key-manager.abstractkeymanagementsystem.md) can support more. One should check the [IKey.meta.algorithms](./core-types.ikey.meta.md) property to see what is possible for a particular managed key.</p>                                                                                                                                                                                                                                                                                               |
 | [TClaimsColumns](./core-types.tclaimscolumns.md)                           | <p>**_(BETA)_** The columns that can be searched for the claims of a [VerifiableCredential](./core-types.verifiablecredential.md)</p><p>See [IDataStoreORM.dataStoreORMGetVerifiableCredentialsByClaims()](./core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaims.md) See [IDataStoreORM.dataStoreORMGetVerifiableCredentialsByClaimsCount()](./core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaimscount.md)</p><p>This API may change without a BREAKING CHANGE notice.</p>                                                                                                                                                                |
 | [TCredentialColumns](./core-types.tcredentialcolumns.md)                   | <p>**_(BETA)_** The columns that can be searched for a [VerifiableCredential](./core-types.verifiablecredential.md)</p><p>See [IDataStoreORM.dataStoreORMGetVerifiableCredentials()](./core-types.idatastoreorm.datastoreormgetverifiablecredentials.md) See [IDataStoreORM.dataStoreORMGetVerifiableCredentialsCount()](./core-types.idatastoreorm.datastoreormgetverifiablecredentialscount.md)</p><p>This API may change without a BREAKING CHANGE notice.</p>                                                                                                                                                                                                              |
 | [TIdentifiersColumns](./core-types.tidentifierscolumns.md)                 | **_(BETA)_** The columns that can be queried for an [IIdentifier](./core-types.iidentifier.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

diff --git a/docs/api/core-types.talg.md b/docs/api/core-types.talg.md
@@ -10,7 +10,7 @@ hide_title: true
 
 Known algorithms supported by some of the above key types defined by [TKeyType](./core-types.tkeytype.md).
 
-Actual implementations of [Key Management Systems](./key-manager.abstractkeymanagementsystem.md) can support more. One should check the property to see what is possible for a particular managed key.
+Actual implementations of [Key Management Systems](./key-manager.abstractkeymanagementsystem.md) can support more. One should check the [IKey.meta.algorithms](./core-types.ikey.meta.md) property to see what is possible for a particular managed key.
 
 **Signature:**
 

diff --git a/docs/api/core-types.tcredentialcolumns.md b/docs/api/core-types.tcredentialcolumns.md
@@ -27,4 +27,5 @@ export type TCredentialColumns =
   | 'subject'
   | 'expirationDate'
   | 'issuanceDate'
+  | 'hash'
 ```
diff --git a/docs/api/core.agent.md b/docs/api/core.agent.md
@@ -10,7 +10,7 @@ hide_title: true
 
 Provides a common context for all plugin methods.
 
-This is the main entry point into the API of the DID Agent Framework. When plugins are installed, they extend the API of the agent and the methods they provide can all use the common context so that plugins can build on top of each other and create a richer experience.
+This is the main entry point into the API of Veramo. When plugins are installed, they extend the API of the agent and the methods they provide can all use the common context so that plugins can build on top of each other and create a richer experience.
 
 **Signature:**
 

diff --git a/docs/api/core.md b/docs/api/core.md
@@ -12,10 +12,10 @@ Provides [Agent](./core.agent.md) implementation
 
 ## Classes
 
-| Class                                        | Description                                                                                                                                                                                                                                                                                                                                  |
-| -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [Agent](./core.agent.md)                     | <p>Provides a common context for all plugin methods.</p><p>This is the main entry point into the API of the DID Agent Framework. When plugins are installed, they extend the API of the agent and the methods they provide can all use the common context so that plugins can build on top of each other and create a richer experience.</p> |
-| [ValidationError](./core.validationerror.md) | <p>Represents a Schema validation error.</p><p>This can occur when a method of the agent is invoked with certain parameters or the returned value doesn't match the declared plugin schema.</p>                                                                                                                                              |
+| Class                                        | Description                                                                                                                                                                                                                                                                                                                 |
+| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Agent](./core.agent.md)                     | <p>Provides a common context for all plugin methods.</p><p>This is the main entry point into the API of Veramo. When plugins are installed, they extend the API of the agent and the methods they provide can all use the common context so that plugins can build on top of each other and create a richer experience.</p> |
+| [ValidationError](./core.validationerror.md) | <p>Represents a Schema validation error.</p><p>This can occur when a method of the agent is invoked with certain parameters or the returned value doesn't match the declared plugin schema.</p>                                                                                                                             |
 
 ## Functions
 

diff --git a/docs/api/credential-w3c.credentialplugin.listusableproofformats.md b/docs/api/credential-w3c.credentialplugin.listusableproofformats.md
@@ -0,0 +1,26 @@
+---
+id: credential-w3c.credentialplugin.listusableproofformats
+title: CredentialPlugin.listUsableProofFormats() method
+hide_title: true
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## CredentialPlugin.listUsableProofFormats() method
+
+**Signature:**
+
+```typescript
+listUsableProofFormats(did: IIdentifier, context: IssuerAgentContext): Promise<ProofFormat[]>;
+```
+
+## Parameters
+
+| Parameter | Type                                                     | Description |
+| --------- | -------------------------------------------------------- | ----------- |
+| did       | [IIdentifier](./core-types.iidentifier.md)               |             |
+| context   | [IssuerAgentContext](./core-types.issueragentcontext.md) |             |
+
+**Returns:**
+
+Promise&lt;[ProofFormat](./core-types.proofformat.md)\[\]&gt;