chore(docs): Rebuild docs + coverage [skip ci]

trust0-project · Feb 1, 2024 · c1971f7 · c1971f7
1 parent 5df4bd7
commit c1971f7
Show file tree

Hide file tree

Showing 87 changed files with 2,843 additions and 328 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -3,7 +3,83 @@
 # Pluto Encrypted
 Is a community maintained project which aims to bring a scalable and future proof storage solution for Wallet SDK on typescript. By using this package you can ensure that this dependency will fit the AtalaPrism wallet SDK contract and provide the SDK with storage finally.
 
-This package is compatible with Atala Prism Wallet SDK v3.2.0
+## Interface
+Edge SDK Pluto interface [v4.0.0](https://input-output-hk.github.io/atala-prism-wallet-sdk-ts/interfaces/Domain.Pluto.html)
+```typescript
+
+export interface Pluto {
+
+    storeCredentialMetadata(metadata: Anoncreds.CredentialRequestMeta, linkSecret: Anoncreds.LinkSecret): Promise<void>;
+
+    fetchCredentialMetadata(linkSecretName: string): Promise<Anoncreds.CredentialRequestMeta | null>;
+
+    start(): Promise<void>;
+
+    storePrismDID(did: DID, keyPathIndex: number, privateKey: PrivateKey, privateKeyMetaId: string | null, alias?: string): Promise<void>;
+
+    storePeerDID(did: DID, privateKeys: Array<PrivateKey>): Promise<void>;
+
+    storeDIDPair(host: DID, receiver: DID, name: string): Promise<void>;
+
+    storeMessage(message: Message): Promise<void>;
+
+    storeMessages(messages: Array<Message>): Promise<void>;
+
+    storePrivateKeys(privateKey: PrivateKey, did: DID, keyPathIndex: number, metaId: string | null): Promise<void>;
+
+    storeMediator(mediator: DID, host: DID, routing: DID): Promise<void>;
+
+    storeCredential(credential: Credential): Promise<void>;
+
+    getAllPrismDIDs(): Promise<PrismDIDInfo[]>;
+
+    getDIDInfoByDID(did: DID): Promise<PrismDIDInfo | null>;
+
+    getDIDInfoByAlias(alias: string): Promise<PrismDIDInfo[]>;
+
+    getPrismDIDKeyPathIndex(did: DID): Promise<number | null>;
+
+    getPrismLastKeyPathIndex(): Promise<number>;
+
+    getAllPeerDIDs(): Promise<Array<PeerDID>>;
+
+    getDIDPrivateKeysByDID(did: DID): Promise<Array<PrivateKey>>;
+
+    getDIDPrivateKeyByID(id: string): Promise<PrivateKey | null>;
+
+    getAllDidPairs(): Promise<Array<DIDPair>>;
+
+    getPairByDID(did: DID): Promise<DIDPair | null>;
+
+    getPairByName(name: string): Promise<DIDPair | null>;
+
+    getAllMessages(): Promise<Array<Message>>;
+
+    getAllMessagesByDID(did: DID): Promise<Array<Message>>;
+
+    getAllMessagesSent(): Promise<Array<Message>>;
+
+    getAllMessagesReceived(): Promise<Array<Message>>;
+
+    getAllMessagesSentTo(did: DID): Promise<Array<Message>>;
+
+    getAllMessagesReceivedFrom(did: DID): Promise<Array<Message>>;
+
+    getAllMessagesOfType(type: string, relatedWithDID?: DID): Promise<Array<Message>>;
+
+    getAllMessagesByFromToDID(from: DID, to: DID): Promise<Array<Message>>;
+
+    getMessage(id: string): Promise<Message | null>;
+
+    getAllMediators(): Promise<Array<Mediator>>;
+
+    getAllCredentials(): Promise<Array<Credential>>;
+
+    getLinkSecret(linkSecretName?: string): Promise<Anoncreds.LinkSecret | null>;
+
+    storeLinkSecret(linkSecret: Anoncreds.LinkSecret, linkSecretName: string): Promise<void>;
+}
+```
 
 We currently support database wrappers for IndexDB, InMemory and are working together to bring you level-db with electron compatibility.
 We are not going to stop here but ensure that our SDK can be used in any platform and language.

diff --git a/docs/classes/database-1.WALLET_SDK_DOMAIN.AgentError.CannotFindLinkSecret.md b/docs/classes/database-1.WALLET_SDK_DOMAIN.AgentError.CannotFindLinkSecret.md
@@ -0,0 +1,199 @@
+[@pluto-encrypted](../README.md) / [Exports](../modules.md) / [database](../modules/database-1.md) / [WALLET\_SDK\_DOMAIN](../modules/database-1.WALLET_SDK_DOMAIN.md) / [AgentError](../modules/database-1.WALLET_SDK_DOMAIN.AgentError.md) / CannotFindLinkSecret
+
+# Class: CannotFindLinkSecret
+
+[WALLET\_SDK\_DOMAIN](../modules/database-1.WALLET_SDK_DOMAIN.md).[AgentError](../modules/database-1.WALLET_SDK_DOMAIN.AgentError.md).CannotFindLinkSecret
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`CannotFindLinkSecret`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](database-1.WALLET_SDK_DOMAIN.AgentError.CannotFindLinkSecret.md#constructor)
+
+### Properties
+
+- [cause](database-1.WALLET_SDK_DOMAIN.AgentError.CannotFindLinkSecret.md#cause)
+- [message](database-1.WALLET_SDK_DOMAIN.AgentError.CannotFindLinkSecret.md#message)
+- [name](database-1.WALLET_SDK_DOMAIN.AgentError.CannotFindLinkSecret.md#name)
+- [stack](database-1.WALLET_SDK_DOMAIN.AgentError.CannotFindLinkSecret.md#stack)
+- [prepareStackTrace](database-1.WALLET_SDK_DOMAIN.AgentError.CannotFindLinkSecret.md#preparestacktrace)
+- [stackTraceLimit](database-1.WALLET_SDK_DOMAIN.AgentError.CannotFindLinkSecret.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](database-1.WALLET_SDK_DOMAIN.AgentError.CannotFindLinkSecret.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new CannotFindLinkSecret**(`message?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message?` | `string` |
+
+#### Inherited from
+
+Error.constructor
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1073
+
+• **new CannotFindLinkSecret**(`message?`, `options?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message?` | `string` |
+| `options?` | `ErrorOptions` |
+
+#### Inherited from
+
+Error.constructor
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:28
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+Error.cause
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:24
+
+___
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1068
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1067
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1069
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:28
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:30
+
+## Methods
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:21
diff --git a/...classes/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidBasicMessageBodyError.md b/...classes/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidBasicMessageBodyError.md
@@ -47,7 +47,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:64
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:66
 
 ## Properties
 

diff --git a/docs/classes/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidCredentialBodyError.md b/docs/classes/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidCredentialBodyError.md
@@ -47,7 +47,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:49
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:51
 
 ## Properties
 

diff --git a/docs/classes/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidCredentialFormats.md b/docs/classes/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidCredentialFormats.md
@@ -41,7 +41,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:82
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:84
 
 ## Properties
 

diff --git a/...sses/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidIssueCredentialBodyError.md b/...sses/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidIssueCredentialBodyError.md
@@ -47,7 +47,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:52
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:54
 
 ## Properties
 

diff --git a/...asses/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidMediationGrantBodyError.md b/...asses/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidMediationGrantBodyError.md
@@ -47,7 +47,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:76
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:78
 
 ## Properties
 

diff --git a/...sses/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidOfferCredentialBodyError.md b/...sses/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidOfferCredentialBodyError.md
@@ -47,7 +47,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:73
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:75
 
 ## Properties
 

diff --git a/...es/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidPickupDeliveryMessageError.md b/...es/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidPickupDeliveryMessageError.md
@@ -41,7 +41,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:27
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:29
 
 ## Properties
 

diff --git a/...classes/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidPresentationBodyError.md b/...classes/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidPresentationBodyError.md
@@ -47,7 +47,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:67
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:69
 
 ## Properties
 

diff --git a/...es/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidProposeCredentialBodyError.md b/...es/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidProposeCredentialBodyError.md
@@ -47,7 +47,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:70
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:72
 
 ## Properties
 

diff --git a/.../database-1.WALLET_SDK_DOMAIN.AgentError.InvalidProposePresentationBodyError.md b/.../database-1.WALLET_SDK_DOMAIN.AgentError.InvalidProposePresentationBodyError.md
@@ -47,7 +47,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:61
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:63
 
 ## Properties
 

diff --git a/...es/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidRequestCredentialBodyError.md b/...es/database-1.WALLET_SDK_DOMAIN.AgentError.InvalidRequestCredentialBodyError.md
@@ -47,7 +47,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:55
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:57
 
 ## Properties
 

diff --git a/.../database-1.WALLET_SDK_DOMAIN.AgentError.InvalidRequestPresentationBodyError.md b/.../database-1.WALLET_SDK_DOMAIN.AgentError.InvalidRequestPresentationBodyError.md
@@ -47,7 +47,7 @@ Error.constructor
 
 #### Defined in
 
-node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:58
+node_modules/@atala/prism-wallet-sdk/build/typings/domain/models/errors/Agent.d.ts:60
 
 ## Properties