Skip to content

Commit

Permalink
chore(release): 🚀 api docs v5.4.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@uport-automation-bot
uport-automation-bot committed Sep 19, 2023
1 parent 8b9eafd commit 24e8292
Show file tree
Hide file tree
Showing 20 changed files with 152 additions and 46 deletions.
2 changes: 1 addition & 1 deletion docs/api/core-types.ikey.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hide_title: true

## IKey interface

Cryptographic key
Cryptographic key, usually managed by the current Veramo instance.

**Signature:**

Expand Down
8 changes: 4 additions & 4 deletions docs/api/core-types.iresolver.getdidcomponentbyid.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,17 @@ This API may change without a BREAKING CHANGE notice.
## Example

```typescript
const did = 'did:ethr:goerli:0xb09b66026ba5909a7cfe99b76875431d2b8d5190'
const did = 'did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190'
const didFragment = `${did}#controller`
const fragment = await agent.getDIDComponentById({
didDocument: (await agent.resolveDid({ didUrl: did }))?.didDocument,
didUrl: didFragment,
section: 'authentication',
})
expect(fragment).toEqual({
id: 'did:ethr:goerli:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#controller',
id: 'did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#controller',
type: 'EcdsaSecp256k1RecoveryMethod2020',
controller: 'did:ethr:goerli:0xb09b66026ba5909a7cfe99b76875431d2b8d5190',
blockchainAccountId: 'eip155:5:0xb09B66026bA5909A7CFE99b76875431D2b8D5190',
controller: 'did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190',
blockchainAccountId: 'eip155:1:0xb09B66026bA5909A7CFE99b76875431D2b8D5190',
})
```
14 changes: 7 additions & 7 deletions docs/api/core-types.iresolver.resolvedid.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,20 @@ Promise<DIDResolutionResult>

```typescript
const doc = await agent.resolveDid({
didUrl: 'did:ethr:goerli:0xb09b66026ba5909a7cfe99b76875431d2b8d5190',
didUrl: 'did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190',
})
expect(doc.didDocument).toEqual({
'@context': ['https://www.w3.org/ns/did/v1', 'https://w3id.org/security/suites/secp256k1recovery-2020/v2'],
id: 'did:ethr:goerli:0xb09b66026ba5909a7cfe99b76875431d2b8d5190',
id: 'did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190',
verificationMethod: [
{
id: 'did:ethr:goerli:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#controller',
id: 'did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#controller',
type: 'EcdsaSecp256k1RecoveryMethod2020',
controller: 'did:ethr:goerli:0xb09b66026ba5909a7cfe99b76875431d2b8d5190',
blockchainAccountId: 'eip155:5:0xb09B66026bA5909A7CFE99b76875431D2b8D5190',
controller: 'did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190',
blockchainAccountId: 'eip155:1:0xb09B66026bA5909A7CFE99b76875431D2b8D5190',
},
],
authentication: ['did:ethr:goerli:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#controller'],
assertionMethod: ['did:ethr:goerli:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#controller'],
authentication: ['did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#controller'],
assertionMethod: ['did:ethr:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#controller'],
})
```
17 changes: 17 additions & 0 deletions docs/api/core-types.key_alg_mapping.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
id: core-types.key_alg_mapping
title: KEY\_ALG\_MAPPING variable
hide_title: true
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

## KEY_ALG_MAPPING variable

Mapping of known key types([TKeyType](./core-types.tkeytype.md)) to the known algorithms([TAlg](./core-types.talg.md)) they should support.

**Signature:**

```typescript
KEY_ALG_MAPPING: Record<TKeyType, ReadonlyArray<TAlg>>
```
2 changes: 1 addition & 1 deletion docs/api/core-types.keymetadata.algorithms.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ hide_title: true
**Signature:**

```typescript
algorithms?: string[];
algorithms?: TAlg[];
```
6 changes: 3 additions & 3 deletions docs/api/core-types.keymetadata.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ export interface KeyMetadata

## Properties

| Property | Modifiers | Type | Description |
| ----------------------------------------------------- | --------- | ---------- | ------------ |
| [algorithms?](./core-types.keymetadata.algorithms.md) | | string\[\] | _(Optional)_ |
| Property | Modifiers | Type | Description |
| ----------------------------------------------------- | --------- | -------------------------------- | ------------ |
| [algorithms?](./core-types.keymetadata.algorithms.md) | | [TAlg](./core-types.talg.md)\[\] | _(Optional)_ |
10 changes: 6 additions & 4 deletions docs/api/core-types.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Provides [Agent](./core.agent.md) implementation and defines [IResolver](./core-
| [IEventListener](./core-types.ieventlistener.md) | Describes a listener interface that needs to be implemented by components interested in listening to events emitted by an agent. |
| [IHandleMessageArgs](./core-types.ihandlemessageargs.md) | Input arguments for [handleMessage](./core-types.imessagehandler.handlemessage.md) |
| [IIdentifier](./core-types.iidentifier.md) | Identifier interface |
| [IKey](./core-types.ikey.md) | Cryptographic key |
| [IKey](./core-types.ikey.md) | Cryptographic key, usually managed by the current Veramo instance. |
| [IKeyManager](./core-types.ikeymanager.md) | <p>Key manager interface.</p><p>This defines an interface for a plugin that orchestrates various implementations of [AbstractKeyManagementSystem](./key-manager.abstractkeymanagementsystem.md).</p><p>See [KeyManager](./key-manager.keymanager.md) for a reference implementation.</p><p>The methods of this plugin are used automatically by other plugins, such as [DIDManager](./did-manager.didmanager.md), [CredentialPlugin](./credential-w3c.credentialplugin.md), or [DIDComm](./did-comm.didcomm.md) to perform their required cryptographic operations using the managed keys.</p> |
| [IKeyManagerCreateArgs](./core-types.ikeymanagercreateargs.md) | Input arguments for [keyManagerCreate](./core-types.ikeymanager.keymanagercreate.md) |
| [IKeyManagerDecryptJWEArgs](./core-types.ikeymanagerdecryptjweargs.md) | **_(BETA)_** Input arguments for [keyManagerDecryptJWE](./core-types.ikeymanager.keymanagerdecryptjwe.md) This API may change without a BREAKING CHANGE notice. |
Expand Down Expand Up @@ -98,9 +98,10 @@ Provides [Agent](./core.agent.md) implementation and defines [IResolver](./core-

## Variables

| Variable | Description |
| ---------------------------------------- | --------------------------------------------- |
| [CoreEvents](./core-types.coreevents.md) | This collection defines the core event types. |
| Variable | Description |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| [CoreEvents](./core-types.coreevents.md) | This collection defines the core event types. |
| [KEY_ALG_MAPPING](./core-types.key_alg_mapping.md) | Mapping of known key types([TKeyType](./core-types.tkeytype.md)) to the known algorithms([TAlg](./core-types.talg.md)) they should support. |

## Type Aliases

Expand Down Expand Up @@ -131,6 +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> |
| [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) |
Expand Down
19 changes: 19 additions & 0 deletions docs/api/core-types.talg.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: core-types.talg
title: TAlg type
hide_title: true
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

## TAlg type

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.

**Signature:**

```typescript
export type TAlg = 'ES256K' | 'ES256K-R' | 'ES256' | 'EdDSA' | 'ECDH' | 'ECDH-ES' | 'ECDH-1PU' | string
```
Loading

0 comments on commit 24e8292

Please sign in to comment.