From 24e8292dd8059f701c92d265a5a0dd922b1cc109 Mon Sep 17 00:00:00 2001 From: uport-automation-bot Date: Tue, 19 Sep 2023 08:20:20 +0000 Subject: [PATCH] chore(release): :rocket: api docs v5.4.1 --- docs/api/core-types.ikey.md | 2 +- ...ore-types.iresolver.getdidcomponentbyid.md | 8 ++--- docs/api/core-types.iresolver.resolvedid.md | 14 ++++----- docs/api/core-types.key_alg_mapping.md | 17 +++++++++++ docs/api/core-types.keymetadata.algorithms.md | 2 +- docs/api/core-types.keymetadata.md | 6 ++-- docs/api/core-types.md | 10 ++++--- docs/api/core-types.talg.md | 19 ++++++++++++ docs/api/data-store-json.datastorejson.md | 8 ++--- .../data-store-json.datastorejson.schema.md | 6 +++- docs/api/data-store.datastoreorm.md | 8 ++--- docs/api/data-store.datastoreorm.schema.md | 6 +++- docs/api/did-manager.didmanager.md | 8 ++--- docs/api/did-manager.didmanager.schema.md | 6 +++- docs/api/key-manager.keymanager.md | 8 ++--- docs/api/key-manager.keymanager.schema.md | 6 +++- ...elective-disclosure.selectivedisclosure.md | 8 ++--- ...e-disclosure.selectivedisclosure.schema.md | 25 ++++++++++++++-- docs/api/utils.intersect.md | 30 +++++++++++++++++++ docs/api/utils.md | 1 + 20 files changed, 152 insertions(+), 46 deletions(-) create mode 100644 docs/api/core-types.key_alg_mapping.md create mode 100644 docs/api/core-types.talg.md create mode 100644 docs/api/utils.intersect.md diff --git a/docs/api/core-types.ikey.md b/docs/api/core-types.ikey.md index 39a37bf..07ba8e3 100644 --- a/docs/api/core-types.ikey.md +++ b/docs/api/core-types.ikey.md @@ -8,7 +8,7 @@ hide_title: true ## IKey interface -Cryptographic key +Cryptographic key, usually managed by the current Veramo instance. **Signature:** diff --git a/docs/api/core-types.iresolver.getdidcomponentbyid.md b/docs/api/core-types.iresolver.getdidcomponentbyid.md index 359cf85..0312ce6 100644 --- a/docs/api/core-types.iresolver.getdidcomponentbyid.md +++ b/docs/api/core-types.iresolver.getdidcomponentbyid.md @@ -39,7 +39,7 @@ 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, @@ -47,9 +47,9 @@ const fragment = await agent.getDIDComponentById({ 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', }) ``` diff --git a/docs/api/core-types.iresolver.resolvedid.md b/docs/api/core-types.iresolver.resolvedid.md index f795588..172728d 100644 --- a/docs/api/core-types.iresolver.resolvedid.md +++ b/docs/api/core-types.iresolver.resolvedid.md @@ -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'], }) ``` diff --git a/docs/api/core-types.key_alg_mapping.md b/docs/api/core-types.key_alg_mapping.md new file mode 100644 index 0000000..24eff6e --- /dev/null +++ b/docs/api/core-types.key_alg_mapping.md @@ -0,0 +1,17 @@ +--- +id: core-types.key_alg_mapping +title: KEY\_ALG\_MAPPING variable +hide_title: true +--- + + + +## 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> +``` diff --git a/docs/api/core-types.keymetadata.algorithms.md b/docs/api/core-types.keymetadata.algorithms.md index 4bdedf4..1513d7b 100644 --- a/docs/api/core-types.keymetadata.algorithms.md +++ b/docs/api/core-types.keymetadata.algorithms.md @@ -11,5 +11,5 @@ hide_title: true **Signature:** ```typescript -algorithms?: string[]; +algorithms?: TAlg[]; ``` diff --git a/docs/api/core-types.keymetadata.md b/docs/api/core-types.keymetadata.md index 55e5ca9..33eb4ec 100644 --- a/docs/api/core-types.keymetadata.md +++ b/docs/api/core-types.keymetadata.md @@ -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)_ | diff --git a/docs/api/core-types.md b/docs/api/core-types.md index af64462..a481e0d 100644 --- a/docs/api/core-types.md +++ b/docs/api/core-types.md @@ -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) |

Key manager interface.

This defines an interface for a plugin that orchestrates various implementations of [AbstractKeyManagementSystem](./key-manager.abstractkeymanagementsystem.md).

See [KeyManager](./key-manager.keymanager.md) for a reference implementation.

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.

| | [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. | @@ -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 @@ -131,6 +132,7 @@ Provides [Agent](./core.agent.md) implementation and defines [IResolver](./core- | [ProofFormat](./core-types.proofformat.md) |

The type of encoding to be used for the Verifiable Credential or Presentation to be generated.

Only jwt and lds is supported at the moment.

| | [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) |

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.

| | [TClaimsColumns](./core-types.tclaimscolumns.md) |

**_(BETA)_** The columns that can be searched for the claims of a [VerifiableCredential](./core-types.verifiablecredential.md)

See [IDataStoreORM.dataStoreORMGetVerifiableCredentialsByClaims()](./core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaims.md) See [IDataStoreORM.dataStoreORMGetVerifiableCredentialsByClaimsCount()](./core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaimscount.md)

This API may change without a BREAKING CHANGE notice.

| | [TCredentialColumns](./core-types.tcredentialcolumns.md) |

**_(BETA)_** The columns that can be searched for a [VerifiableCredential](./core-types.verifiablecredential.md)

See [IDataStoreORM.dataStoreORMGetVerifiableCredentials()](./core-types.idatastoreorm.datastoreormgetverifiablecredentials.md) See [IDataStoreORM.dataStoreORMGetVerifiableCredentialsCount()](./core-types.idatastoreorm.datastoreormgetverifiablecredentialscount.md)

This API may change without a BREAKING CHANGE notice.

| | [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 new file mode 100644 index 0000000..9d024fc --- /dev/null +++ b/docs/api/core-types.talg.md @@ -0,0 +1,19 @@ +--- +id: core-types.talg +title: TAlg type +hide_title: true +--- + + + +## 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 +``` diff --git a/docs/api/data-store-json.datastorejson.md b/docs/api/data-store-json.datastorejson.md index 5e66483..832259e 100644 --- a/docs/api/data-store-json.datastorejson.md +++ b/docs/api/data-store-json.datastorejson.md @@ -34,10 +34,10 @@ export declare class DataStoreJson implements IAgentPlugin ## Properties -| Property | Modifiers | Type | Description | -| ----------------------------------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -| [methods](./data-store-json.datastorejson.methods.md) | readonly | [IDataStore](./core-types.idatastore.md) & [IDataStoreORM](./core-types.idatastoreorm.md) | **_(BETA)_** | -| [schema](./data-store-json.datastorejson.schema.md) | readonly | { components: { schemas: { FindIdentifiersArgs: { $ref: string; description: string; }; "FindArgs-TIdentifiersColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TIdentifiersColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TIdentifiersColumns: { type: string; enum: string\[\]; description: string; deprecated: string; }; "Order-TIdentifiersColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; PartialIdentifier: { type: string; properties: { did: { type: string; description: string; }; alias: { type: string; description: string; }; provider: { type: string; description: string; }; controllerKeyId: { type: string; description: string; }; keys: { type: string; items: { $ref: string; }; description: string; }; services: { type: string; items: { $ref: string; }; description: string; }; }; description: string; }; IKey: { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; TKeyType: { type: string; enum: string\[\]; description: string; }; KeyMetadata: { type: string; properties: { algorithms: { type: string; items: { type: string; }; }; }; description: string; }; IService: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; serviceEndpoint: { anyOf: ({ $ref: string; type?: undefined; items?: undefined; } | { type: string; items: { $ref: string; }; $ref?: undefined; })\[\]; description: string; }; description: { type: string; description: string; }; }; required: string\[\]; description: string; }; IServiceEndpoint: { anyOf: { type: string; }\[\]; description: string; }; FindMessagesArgs: { $ref: string; description: string; }; "FindArgs-TMessageColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TMessageColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TMessageColumns: { type: string; enum: string\[\]; description: string; }; "Order-TMessageColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; IMessage: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; createdAt: { type: string; description: string; }; expiresAt: { type: string; description: string; }; threadId: { type: string; description: string; }; raw: { type: string; description: string; }; data: { anyOf: { type: string; }\[\]; description: string; }; replyTo: { type: string; items: { type: string; }; description: string; }; replyUrl: { type: string; description: string; }; from: { type: string; description: string; }; to: { type: string; description: string; }; metaData: { anyOf: ({ type: string; items: { $ref: string; }; } | { type: string; items?: undefined; })\[\]; description: string; }; credentials: { type: string; items: { $ref: string; }; description: string; }; presentations: { type: string; items: { $ref: string; }; description: string; }; attachments: { type: string; items: { $ref: string; }; description: string; }; returnRoute: { type: string; description: string; }; }; required: string\[\]; description: string; }; IMetaData: { type: string; properties: { type: { type: string; description: string; }; value: { type: string; description: string; }; }; required: string\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: string; description: string; }; IMessageAttachment: { type: string; properties: { id: { type: string; }; description: { type: string; }; filename: { type: string; }; media_type: { type: string; }; format: { type: string; }; lastmod_time: { type: string; }; byte_count: { type: string; }; data: { $ref: string; }; }; required: string\[\]; description: string; }; IMessageAttachmentData: { type: string; properties: { jws: {}; hash: { type: string; }; links: { type: string; items: { type: string; }; }; base64: { type: string; }; json: {}; }; description: string; }; FindCredentialsArgs: { $ref: string; description: string; }; "FindArgs-TCredentialColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TCredentialColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TCredentialColumns: { type: string; enum: string\[\]; description: string; }; "Order-TCredentialColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; UniqueVerifiableCredential: { type: string; properties: { hash: { type: string; }; verifiableCredential: { $ref: string; }; }; required: string\[\]; description: string; }; FindClaimsArgs: { $ref: string; description: string; }; "FindArgs-TClaimsColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TClaimsColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TClaimsColumns: { type: string; enum: string\[\]; description: string; }; "Order-TClaimsColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; FindPresentationsArgs: { $ref: string; description: string; }; "FindArgs-TPresentationColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TPresentationColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TPresentationColumns: { type: string; enum: string\[\]; description: string; }; "Order-TPresentationColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; UniqueVerifiablePresentation: { type: string; properties: { hash: { type: string; }; verifiablePresentation: { $ref: string; }; }; required: string\[\]; description: string; }; }; methods: { dataStoreORMGetIdentifiers: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetIdentifiersCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetMessages: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetMessagesCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiableCredentials: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiableCredentialsByClaims: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiableCredentialsByClaimsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiableCredentialsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiablePresentations: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiablePresentationsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | **_(BETA)_** | +| Property | Modifiers | Type | Description | +| ----------------------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| [methods](./data-store-json.datastorejson.methods.md) | readonly | [IDataStore](./core-types.idatastore.md) & [IDataStoreORM](./core-types.idatastoreorm.md) | **_(BETA)_** | +| [schema](./data-store-json.datastorejson.schema.md) | readonly | { components: { schemas: { FindIdentifiersArgs: { $ref: string; description: string; }; "FindArgs-TIdentifiersColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TIdentifiersColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TIdentifiersColumns: { type: string; enum: string\[\]; description: string; deprecated: string; }; "Order-TIdentifiersColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; PartialIdentifier: { type: string; properties: { did: { type: string; description: string; }; alias: { type: string; description: string; }; provider: { type: string; description: string; }; controllerKeyId: { type: string; description: string; }; keys: { type: string; items: { $ref: string; }; description: string; }; services: { type: string; items: { $ref: string; }; description: string; }; }; description: string; }; IKey: { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; TKeyType: { type: string; enum: string\[\]; description: string; }; KeyMetadata: { type: string; properties: { algorithms: { type: string; items: { $ref: string; }; }; }; description: string; }; TAlg: { type: string; description: string; }; IService: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; serviceEndpoint: { anyOf: ({ $ref: string; type?: undefined; items?: undefined; } | { type: string; items: { $ref: string; }; $ref?: undefined; })\[\]; description: string; }; description: { type: string; description: string; }; }; required: string\[\]; description: string; }; IServiceEndpoint: { anyOf: { type: string; }\[\]; description: string; }; FindMessagesArgs: { $ref: string; description: string; }; "FindArgs-TMessageColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TMessageColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TMessageColumns: { type: string; enum: string\[\]; description: string; }; "Order-TMessageColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; IMessage: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; createdAt: { type: string; description: string; }; expiresAt: { type: string; description: string; }; threadId: { type: string; description: string; }; raw: { type: string; description: string; }; data: { anyOf: { type: string; }\[\]; description: string; }; replyTo: { type: string; items: { type: string; }; description: string; }; replyUrl: { type: string; description: string; }; from: { type: string; description: string; }; to: { type: string; description: string; }; metaData: { anyOf: ({ type: string; items: { $ref: string; }; } | { type: string; items?: undefined; })\[\]; description: string; }; credentials: { type: string; items: { $ref: string; }; description: string; }; presentations: { type: string; items: { $ref: string; }; description: string; }; attachments: { type: string; items: { $ref: string; }; description: string; }; returnRoute: { type: string; description: string; }; }; required: string\[\]; description: string; }; IMetaData: { type: string; properties: { type: { type: string; description: string; }; value: { type: string; description: string; }; }; required: string\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: string; description: string; }; IMessageAttachment: { type: string; properties: { id: { type: string; }; description: { type: string; }; filename: { type: string; }; media_type: { type: string; }; format: { type: string; }; lastmod_time: { type: string; }; byte_count: { type: string; }; data: { $ref: string; }; }; required: string\[\]; description: string; }; IMessageAttachmentData: { type: string; properties: { jws: {}; hash: { type: string; }; links: { type: string; items: { type: string; }; }; base64: { type: string; }; json: {}; }; description: string; }; FindCredentialsArgs: { $ref: string; description: string; }; "FindArgs-TCredentialColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TCredentialColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TCredentialColumns: { type: string; enum: string\[\]; description: string; }; "Order-TCredentialColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; UniqueVerifiableCredential: { type: string; properties: { hash: { type: string; }; verifiableCredential: { $ref: string; }; }; required: string\[\]; description: string; }; FindClaimsArgs: { $ref: string; description: string; }; "FindArgs-TClaimsColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TClaimsColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TClaimsColumns: { type: string; enum: string\[\]; description: string; }; "Order-TClaimsColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; FindPresentationsArgs: { $ref: string; description: string; }; "FindArgs-TPresentationColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TPresentationColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TPresentationColumns: { type: string; enum: string\[\]; description: string; }; "Order-TPresentationColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; UniqueVerifiablePresentation: { type: string; properties: { hash: { type: string; }; verifiablePresentation: { $ref: string; }; }; required: string\[\]; description: string; }; }; methods: { dataStoreORMGetIdentifiers: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetIdentifiersCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetMessages: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetMessagesCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiableCredentials: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiableCredentialsByClaims: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiableCredentialsByClaimsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiableCredentialsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiablePresentations: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiablePresentationsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | **_(BETA)_** | ## Methods diff --git a/docs/api/data-store-json.datastorejson.schema.md b/docs/api/data-store-json.datastorejson.schema.md index 8a3a77d..df2d233 100644 --- a/docs/api/data-store-json.datastorejson.schema.md +++ b/docs/api/data-store-json.datastorejson.schema.md @@ -175,12 +175,16 @@ readonly schema: { algorithms: { type: string; items: { - type: string; + $ref: string; }; }; }; description: string; }; + TAlg: { + type: string; + description: string; + }; IService: { type: string; properties: { diff --git a/docs/api/data-store.datastoreorm.md b/docs/api/data-store.datastoreorm.md index bc674c6..9e34d9b 100644 --- a/docs/api/data-store.datastoreorm.md +++ b/docs/api/data-store.datastoreorm.md @@ -32,10 +32,10 @@ export declare class DataStoreORM implements IAgentPlugin ## Properties -| Property | Modifiers | Type | Description | -| ----------------------------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -| [methods](./data-store.datastoreorm.methods.md) | readonly | [IDataStoreORM](./core-types.idatastoreorm.md) | **_(BETA)_** | -| [schema](./data-store.datastoreorm.schema.md) | readonly | { components: { schemas: { FindIdentifiersArgs: { $ref: string; description: string; }; "FindArgs-TIdentifiersColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TIdentifiersColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TIdentifiersColumns: { type: string; enum: string\[\]; description: string; deprecated: string; }; "Order-TIdentifiersColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; PartialIdentifier: { type: string; properties: { did: { type: string; description: string; }; alias: { type: string; description: string; }; provider: { type: string; description: string; }; controllerKeyId: { type: string; description: string; }; keys: { type: string; items: { $ref: string; }; description: string; }; services: { type: string; items: { $ref: string; }; description: string; }; }; description: string; }; IKey: { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; TKeyType: { type: string; enum: string\[\]; description: string; }; KeyMetadata: { type: string; properties: { algorithms: { type: string; items: { type: string; }; }; }; description: string; }; IService: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; serviceEndpoint: { anyOf: ({ $ref: string; type?: undefined; items?: undefined; } | { type: string; items: { $ref: string; }; $ref?: undefined; })\[\]; description: string; }; description: { type: string; description: string; }; }; required: string\[\]; description: string; }; IServiceEndpoint: { anyOf: { type: string; }\[\]; description: string; }; FindMessagesArgs: { $ref: string; description: string; }; "FindArgs-TMessageColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TMessageColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TMessageColumns: { type: string; enum: string\[\]; description: string; }; "Order-TMessageColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; IMessage: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; createdAt: { type: string; description: string; }; expiresAt: { type: string; description: string; }; threadId: { type: string; description: string; }; raw: { type: string; description: string; }; data: { anyOf: { type: string; }\[\]; description: string; }; replyTo: { type: string; items: { type: string; }; description: string; }; replyUrl: { type: string; description: string; }; from: { type: string; description: string; }; to: { type: string; description: string; }; metaData: { anyOf: ({ type: string; items: { $ref: string; }; } | { type: string; items?: undefined; })\[\]; description: string; }; credentials: { type: string; items: { $ref: string; }; description: string; }; presentations: { type: string; items: { $ref: string; }; description: string; }; attachments: { type: string; items: { $ref: string; }; description: string; }; returnRoute: { type: string; description: string; }; }; required: string\[\]; description: string; }; IMetaData: { type: string; properties: { type: { type: string; description: string; }; value: { type: string; description: string; }; }; required: string\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: string; description: string; }; IMessageAttachment: { type: string; properties: { id: { type: string; }; description: { type: string; }; filename: { type: string; }; media_type: { type: string; }; format: { type: string; }; lastmod_time: { type: string; }; byte_count: { type: string; }; data: { $ref: string; }; }; required: string\[\]; description: string; }; IMessageAttachmentData: { type: string; properties: { jws: {}; hash: { type: string; }; links: { type: string; items: { type: string; }; }; base64: { type: string; }; json: {}; }; description: string; }; FindCredentialsArgs: { $ref: string; description: string; }; "FindArgs-TCredentialColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TCredentialColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TCredentialColumns: { type: string; enum: string\[\]; description: string; }; "Order-TCredentialColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; UniqueVerifiableCredential: { type: string; properties: { hash: { type: string; }; verifiableCredential: { $ref: string; }; }; required: string\[\]; description: string; }; FindClaimsArgs: { $ref: string; description: string; }; "FindArgs-TClaimsColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TClaimsColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TClaimsColumns: { type: string; enum: string\[\]; description: string; }; "Order-TClaimsColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; FindPresentationsArgs: { $ref: string; description: string; }; "FindArgs-TPresentationColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TPresentationColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TPresentationColumns: { type: string; enum: string\[\]; description: string; }; "Order-TPresentationColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; UniqueVerifiablePresentation: { type: string; properties: { hash: { type: string; }; verifiablePresentation: { $ref: string; }; }; required: string\[\]; description: string; }; }; methods: { dataStoreORMGetIdentifiers: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetIdentifiersCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetMessages: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetMessagesCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiableCredentials: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiableCredentialsByClaims: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiableCredentialsByClaimsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiableCredentialsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiablePresentations: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiablePresentationsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | **_(BETA)_** | +| Property | Modifiers | Type | Description | +| ----------------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| [methods](./data-store.datastoreorm.methods.md) | readonly | [IDataStoreORM](./core-types.idatastoreorm.md) | **_(BETA)_** | +| [schema](./data-store.datastoreorm.schema.md) | readonly | { components: { schemas: { FindIdentifiersArgs: { $ref: string; description: string; }; "FindArgs-TIdentifiersColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TIdentifiersColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TIdentifiersColumns: { type: string; enum: string\[\]; description: string; deprecated: string; }; "Order-TIdentifiersColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; PartialIdentifier: { type: string; properties: { did: { type: string; description: string; }; alias: { type: string; description: string; }; provider: { type: string; description: string; }; controllerKeyId: { type: string; description: string; }; keys: { type: string; items: { $ref: string; }; description: string; }; services: { type: string; items: { $ref: string; }; description: string; }; }; description: string; }; IKey: { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; TKeyType: { type: string; enum: string\[\]; description: string; }; KeyMetadata: { type: string; properties: { algorithms: { type: string; items: { $ref: string; }; }; }; description: string; }; TAlg: { type: string; description: string; }; IService: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; serviceEndpoint: { anyOf: ({ $ref: string; type?: undefined; items?: undefined; } | { type: string; items: { $ref: string; }; $ref?: undefined; })\[\]; description: string; }; description: { type: string; description: string; }; }; required: string\[\]; description: string; }; IServiceEndpoint: { anyOf: { type: string; }\[\]; description: string; }; FindMessagesArgs: { $ref: string; description: string; }; "FindArgs-TMessageColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TMessageColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TMessageColumns: { type: string; enum: string\[\]; description: string; }; "Order-TMessageColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; IMessage: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; createdAt: { type: string; description: string; }; expiresAt: { type: string; description: string; }; threadId: { type: string; description: string; }; raw: { type: string; description: string; }; data: { anyOf: { type: string; }\[\]; description: string; }; replyTo: { type: string; items: { type: string; }; description: string; }; replyUrl: { type: string; description: string; }; from: { type: string; description: string; }; to: { type: string; description: string; }; metaData: { anyOf: ({ type: string; items: { $ref: string; }; } | { type: string; items?: undefined; })\[\]; description: string; }; credentials: { type: string; items: { $ref: string; }; description: string; }; presentations: { type: string; items: { $ref: string; }; description: string; }; attachments: { type: string; items: { $ref: string; }; description: string; }; returnRoute: { type: string; description: string; }; }; required: string\[\]; description: string; }; IMetaData: { type: string; properties: { type: { type: string; description: string; }; value: { type: string; description: string; }; }; required: string\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: string; description: string; }; IMessageAttachment: { type: string; properties: { id: { type: string; }; description: { type: string; }; filename: { type: string; }; media_type: { type: string; }; format: { type: string; }; lastmod_time: { type: string; }; byte_count: { type: string; }; data: { $ref: string; }; }; required: string\[\]; description: string; }; IMessageAttachmentData: { type: string; properties: { jws: {}; hash: { type: string; }; links: { type: string; items: { type: string; }; }; base64: { type: string; }; json: {}; }; description: string; }; FindCredentialsArgs: { $ref: string; description: string; }; "FindArgs-TCredentialColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TCredentialColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TCredentialColumns: { type: string; enum: string\[\]; description: string; }; "Order-TCredentialColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; UniqueVerifiableCredential: { type: string; properties: { hash: { type: string; }; verifiableCredential: { $ref: string; }; }; required: string\[\]; description: string; }; FindClaimsArgs: { $ref: string; description: string; }; "FindArgs-TClaimsColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TClaimsColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TClaimsColumns: { type: string; enum: string\[\]; description: string; }; "Order-TClaimsColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; FindPresentationsArgs: { $ref: string; description: string; }; "FindArgs-TPresentationColumns": { type: string; properties: { where: { type: string; items: { $ref: string; }; description: string; }; order: { type: string; items: { $ref: string; }; description: string; }; skip: { type: string; description: string; }; take: { type: string; description: string; }; }; description: string; }; "Where-TPresentationColumns": { type: string; properties: { column: { $ref: string; }; value: { type: string; items: { type: string; }; }; not: { type: string; }; op: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; TPresentationColumns: { type: string; enum: string\[\]; description: string; }; "Order-TPresentationColumns": { type: string; properties: { column: { $ref: string; }; direction: { type: string; enum: string\[\]; }; }; required: string\[\]; description: string; }; UniqueVerifiablePresentation: { type: string; properties: { hash: { type: string; }; verifiablePresentation: { $ref: string; }; }; required: string\[\]; description: string; }; }; methods: { dataStoreORMGetIdentifiers: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetIdentifiersCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetMessages: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetMessagesCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiableCredentials: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiableCredentialsByClaims: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiableCredentialsByClaimsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiableCredentialsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; dataStoreORMGetVerifiablePresentations: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; dataStoreORMGetVerifiablePresentationsCount: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | **_(BETA)_** | ## Methods diff --git a/docs/api/data-store.datastoreorm.schema.md b/docs/api/data-store.datastoreorm.schema.md index 706d3ab..d0367e2 100644 --- a/docs/api/data-store.datastoreorm.schema.md +++ b/docs/api/data-store.datastoreorm.schema.md @@ -175,12 +175,16 @@ readonly schema: { algorithms: { type: string; items: { - type: string; + $ref: string; }; }; }; description: string; }; + TAlg: { + type: string; + description: string; + }; IService: { type: string; properties: { diff --git a/docs/api/did-manager.didmanager.md b/docs/api/did-manager.didmanager.md index e8e7f85..962ee88 100644 --- a/docs/api/did-manager.didmanager.md +++ b/docs/api/did-manager.didmanager.md @@ -26,10 +26,10 @@ export declare class DIDManager implements IAgentPlugin ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | -| [methods](./did-manager.didmanager.methods.md) | readonly | [IDIDManager](./core-types.ididmanager.md) | Plugin methods | -| [schema](./did-manager.didmanager.schema.md) | readonly | { components: { schemas: { IDIDManagerAddKeyArgs: { type: string; properties: { did: { type: string; description: string; }; key: { $ref: string; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKey: { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; TKeyType: { type: string; enum: string\[\]; description: string; }; KeyMetadata: { type: string; properties: { algorithms: { type: string; items: { type: string; }; }; }; description: string; }; IDIDManagerAddServiceArgs: { type: string; properties: { did: { type: string; description: string; }; service: { $ref: string; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; IService: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; serviceEndpoint: { anyOf: ({ $ref: string; type?: undefined; items?: undefined; } | { type: string; items: { $ref: string; }; $ref?: undefined; })\[\]; description: string; }; description: { type: string; description: string; }; }; required: string\[\]; description: string; }; IServiceEndpoint: { anyOf: { type: string; }\[\]; description: string; }; IDIDManagerCreateArgs: { type: string; properties: { alias: { type: string; description: string; }; provider: { type: string; description: string; }; kms: { type: string; description: string; }; options: { type: string; description: string; }; }; description: string; }; IIdentifier: { type: string; properties: { did: { type: string; description: string; }; alias: { type: string; description: string; }; provider: { type: string; description: string; }; controllerKeyId: { type: string; description: string; }; keys: { type: string; items: { $ref: string; }; description: string; }; services: { type: string; items: { $ref: string; }; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerDeleteArgs: { type: string; properties: { did: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerFindArgs: { type: string; properties: { alias: { type: string; description: string; }; provider: { type: string; description: string; }; }; description: string; }; IDIDManagerGetArgs: { type: string; properties: { did: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerGetByAliasArgs: { type: string; properties: { alias: { type: string; description: string; }; provider: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerGetOrCreateArgs: { type: string; properties: { alias: { type: string; description: string; }; provider: { type: string; description: string; }; kms: { type: string; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; MinimalImportableIdentifier: { type: string; properties: { did: { type: string; description: string; }; alias: { type: string; description: string; }; provider: { type: string; description: string; }; controllerKeyId: { type: string; description: string; }; keys: { type: string; items: { $ref: string; }; }; services: { type: string; items: { $ref: string; }; }; }; required: string\[\]; description: string; }; MinimalImportableKey: { $ref: string; description: string; }; "RequireOnly<IKey,(\\"privateKeyHex\\"|\\"type\\"|\\"kms\\")>": { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; description: string; }; IDIDManagerRemoveKeyArgs: { type: string; properties: { did: { type: string; description: string; }; kid: { type: string; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerRemoveServiceArgs: { type: string; properties: { did: { type: string; description: string; }; id: { type: string; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerSetAliasArgs: { type: string; properties: { did: { type: string; description: string; }; alias: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerUpdateArgs: { type: string; properties: { did: { type: string; description: string; }; document: { type: string; properties: { "@context": { anyOf: ({ type: string; properties: {}; allOf?: undefined; } | { type: string; properties?: undefined; allOf?: undefined; } | { allOf: ({ type: string; items: { type: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; type?: undefined; properties?: undefined; })\[\]; }; id: { type: string; }; alsoKnownAs: { allOf: ({ type: string; items: { type: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; controller: { anyOf: ({ type: string; allOf?: undefined; } | { allOf: ({ type: string; items: { type: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; type?: undefined; })\[\]; }; verificationMethod: { allOf: ({ type: string; items: { $ref: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; service: { allOf: ({ type: string; items: { $ref: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; publicKey: { allOf: ({ type: string; items: { $ref: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; deprecated: boolean; }; authentication: { allOf: ({ type: string; items: { anyOf: ({ type: string; $ref?: undefined; } | { $ref: string; type?: undefined; })\[\]; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; assertionMethod: { allOf: ({ type: string; items: { anyOf: ({ type: string; $ref?: undefined; } | { $ref: string; type?: undefined; })\[\]; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; keyAgreement: { allOf: ({ type: string; items: { anyOf: ({ type: string; $ref?: undefined; } | { $ref: string; type?: undefined; })\[\]; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; capabilityInvocation: { allOf: ({ type: string; items: { anyOf: ({ type: string; $ref?: undefined; } | { $ref: string; type?: undefined; })\[\]; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; capabilityDelegation: { allOf: ({ type: string; items: { anyOf: ({ type: string; $ref?: undefined; } | { $ref: string; type?: undefined; })\[\]; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; }; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; VerificationMethod: { type: string; properties: { id: { type: string; }; type: { type: string; }; controller: { type: string; }; publicKeyBase58: { type: string; }; publicKeyBase64: { type: string; }; publicKeyJwk: { $ref: string; }; publicKeyHex: { type: string; }; publicKeyMultibase: { type: string; }; blockchainAccountId: { type: string; }; ethereumAddress: { type: string; }; conditionOr: { type: string; items: { $ref: string; }; }; conditionAnd: { type: string; items: { $ref: string; }; }; threshold: { type: string; }; conditionThreshold: { type: string; items: { $ref: string; }; }; conditionWeightedThreshold: { type: string; items: { $ref: string; }; }; conditionDelegated: { type: string; }; relationshipParent: { type: string; items: { type: string; }; }; relationshipChild: { type: string; items: { type: string; }; }; relationshipSibling: { type: string; items: { type: string; }; }; }; required: string\[\]; description: string; }; JsonWebKey: { type: string; properties: { alg: { type: string; }; crv: { type: string; }; e: { type: string; }; ext: { type: string; }; key_ops: { type: string; items: { type: string; }; }; kid: { type: string; }; kty: { type: string; }; n: { type: string; }; use: { type: string; }; x: { type: string; }; y: { type: string; }; }; required: string\[\]; description: string; }; ConditionWeightedThreshold: { type: string; properties: { condition: { $ref: string; }; weight: { type: string; }; }; required: string\[\]; }; Service: { type: string; properties: { id: { type: string; }; type: { type: string; }; serviceEndpoint: { anyOf: ({ $ref: string; type?: undefined; items?: undefined; } | { type: string; items: { $ref: string; }; $ref?: undefined; })\[\]; }; }; required: string\[\]; description: string; }; ServiceEndpoint: { anyOf: { type: string; }\[\]; description: string; }; }; methods: { didManagerAddKey: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerAddService: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerCreate: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; didManagerDelete: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerFind: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; didManagerGet: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; didManagerGetByAlias: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; didManagerGetOrCreate: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; didManagerGetProviders: { description: string; arguments: { type: string; }; returnType: { type: string; items: { type: string; }; }; }; didManagerImport: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; didManagerRemoveKey: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerRemoveService: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerSetAlias: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerUpdate: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; }; }; } | | +| Property | Modifiers | Type | Description | +| ---------------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | +| [methods](./did-manager.didmanager.methods.md) | readonly | [IDIDManager](./core-types.ididmanager.md) | Plugin methods | +| [schema](./did-manager.didmanager.schema.md) | readonly | { components: { schemas: { IDIDManagerAddKeyArgs: { type: string; properties: { did: { type: string; description: string; }; key: { $ref: string; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKey: { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; TKeyType: { type: string; enum: string\[\]; description: string; }; KeyMetadata: { type: string; properties: { algorithms: { type: string; items: { $ref: string; }; }; }; description: string; }; TAlg: { type: string; description: string; }; IDIDManagerAddServiceArgs: { type: string; properties: { did: { type: string; description: string; }; service: { $ref: string; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; IService: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; serviceEndpoint: { anyOf: ({ $ref: string; type?: undefined; items?: undefined; } | { type: string; items: { $ref: string; }; $ref?: undefined; })\[\]; description: string; }; description: { type: string; description: string; }; }; required: string\[\]; description: string; }; IServiceEndpoint: { anyOf: { type: string; }\[\]; description: string; }; IDIDManagerCreateArgs: { type: string; properties: { alias: { type: string; description: string; }; provider: { type: string; description: string; }; kms: { type: string; description: string; }; options: { type: string; description: string; }; }; description: string; }; IIdentifier: { type: string; properties: { did: { type: string; description: string; }; alias: { type: string; description: string; }; provider: { type: string; description: string; }; controllerKeyId: { type: string; description: string; }; keys: { type: string; items: { $ref: string; }; description: string; }; services: { type: string; items: { $ref: string; }; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerDeleteArgs: { type: string; properties: { did: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerFindArgs: { type: string; properties: { alias: { type: string; description: string; }; provider: { type: string; description: string; }; }; description: string; }; IDIDManagerGetArgs: { type: string; properties: { did: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerGetByAliasArgs: { type: string; properties: { alias: { type: string; description: string; }; provider: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerGetOrCreateArgs: { type: string; properties: { alias: { type: string; description: string; }; provider: { type: string; description: string; }; kms: { type: string; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; MinimalImportableIdentifier: { type: string; properties: { did: { type: string; description: string; }; alias: { type: string; description: string; }; provider: { type: string; description: string; }; controllerKeyId: { type: string; description: string; }; keys: { type: string; items: { $ref: string; }; }; services: { type: string; items: { $ref: string; }; }; }; required: string\[\]; description: string; }; MinimalImportableKey: { $ref: string; description: string; }; "RequireOnly<IKey,(\\"privateKeyHex\\"|\\"type\\"|\\"kms\\")>": { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; description: string; }; IDIDManagerRemoveKeyArgs: { type: string; properties: { did: { type: string; description: string; }; kid: { type: string; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerRemoveServiceArgs: { type: string; properties: { did: { type: string; description: string; }; id: { type: string; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerSetAliasArgs: { type: string; properties: { did: { type: string; description: string; }; alias: { type: string; description: string; }; }; required: string\[\]; description: string; }; IDIDManagerUpdateArgs: { type: string; properties: { did: { type: string; description: string; }; document: { type: string; properties: { "@context": { anyOf: ({ type: string; properties: {}; allOf?: undefined; } | { type: string; properties?: undefined; allOf?: undefined; } | { allOf: ({ type: string; items: { type: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; type?: undefined; properties?: undefined; })\[\]; }; id: { type: string; }; alsoKnownAs: { allOf: ({ type: string; items: { type: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; controller: { anyOf: ({ type: string; allOf?: undefined; } | { allOf: ({ type: string; items: { type: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; type?: undefined; })\[\]; }; verificationMethod: { allOf: ({ type: string; items: { $ref: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; service: { allOf: ({ type: string; items: { $ref: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; publicKey: { allOf: ({ type: string; items: { $ref: string; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; deprecated: boolean; }; authentication: { allOf: ({ type: string; items: { anyOf: ({ type: string; $ref?: undefined; } | { $ref: string; type?: undefined; })\[\]; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; assertionMethod: { allOf: ({ type: string; items: { anyOf: ({ type: string; $ref?: undefined; } | { $ref: string; type?: undefined; })\[\]; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; keyAgreement: { allOf: ({ type: string; items: { anyOf: ({ type: string; $ref?: undefined; } | { $ref: string; type?: undefined; })\[\]; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; capabilityInvocation: { allOf: ({ type: string; items: { anyOf: ({ type: string; $ref?: undefined; } | { $ref: string; type?: undefined; })\[\]; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; capabilityDelegation: { allOf: ({ type: string; items: { anyOf: ({ type: string; $ref?: undefined; } | { $ref: string; type?: undefined; })\[\]; }; properties?: undefined; } | { type: string; properties: {}; items?: undefined; })\[\]; }; }; description: string; }; options: { type: string; description: string; }; }; required: string\[\]; description: string; }; VerificationMethod: { type: string; properties: { id: { type: string; }; type: { type: string; }; controller: { type: string; }; publicKeyBase58: { type: string; }; publicKeyBase64: { type: string; }; publicKeyJwk: { $ref: string; }; publicKeyHex: { type: string; }; publicKeyMultibase: { type: string; }; blockchainAccountId: { type: string; }; ethereumAddress: { type: string; }; conditionOr: { type: string; items: { $ref: string; }; }; conditionAnd: { type: string; items: { $ref: string; }; }; threshold: { type: string; }; conditionThreshold: { type: string; items: { $ref: string; }; }; conditionWeightedThreshold: { type: string; items: { $ref: string; }; }; conditionDelegated: { type: string; }; relationshipParent: { type: string; items: { type: string; }; }; relationshipChild: { type: string; items: { type: string; }; }; relationshipSibling: { type: string; items: { type: string; }; }; }; required: string\[\]; description: string; }; JsonWebKey: { type: string; properties: { alg: { type: string; }; crv: { type: string; }; e: { type: string; }; ext: { type: string; }; key_ops: { type: string; items: { type: string; }; }; kid: { type: string; }; kty: { type: string; }; n: { type: string; }; use: { type: string; }; x: { type: string; }; y: { type: string; }; }; required: string\[\]; description: string; }; ConditionWeightedThreshold: { type: string; properties: { condition: { $ref: string; }; weight: { type: string; }; }; required: string\[\]; }; Service: { type: string; properties: { id: { type: string; }; type: { type: string; }; serviceEndpoint: { anyOf: ({ $ref: string; type?: undefined; items?: undefined; } | { type: string; items: { $ref: string; }; $ref?: undefined; })\[\]; }; }; required: string\[\]; description: string; }; ServiceEndpoint: { anyOf: { type: string; }\[\]; description: string; }; }; methods: { didManagerAddKey: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerAddService: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerCreate: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; didManagerDelete: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerFind: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; didManagerGet: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; didManagerGetByAlias: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; didManagerGetOrCreate: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; didManagerGetProviders: { description: string; arguments: { type: string; }; returnType: { type: string; items: { type: string; }; }; }; didManagerImport: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; didManagerRemoveKey: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerRemoveService: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerSetAlias: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; didManagerUpdate: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; }; }; } | | ## Methods diff --git a/docs/api/did-manager.didmanager.schema.md b/docs/api/did-manager.didmanager.schema.md index 56f0ad7..2e34007 100644 --- a/docs/api/did-manager.didmanager.schema.md +++ b/docs/api/did-manager.didmanager.schema.md @@ -81,12 +81,16 @@ readonly schema: { algorithms: { type: string; items: { - type: string; + $ref: string; }; }; }; description: string; }; + TAlg: { + type: string; + description: string; + }; IDIDManagerAddServiceArgs: { type: string; properties: { diff --git a/docs/api/key-manager.keymanager.md b/docs/api/key-manager.keymanager.md index aae7c82..cd58779 100644 --- a/docs/api/key-manager.keymanager.md +++ b/docs/api/key-manager.keymanager.md @@ -30,10 +30,10 @@ export declare class KeyManager implements IAgentPlugin ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- | -| [methods](./key-manager.keymanager.methods.md) | readonly | [IKeyManager](./core-types.ikeymanager.md) | Plugin methods | -| [schema](./key-manager.keymanager.schema.md) | readonly | { components: { schemas: { IKeyManagerCreateArgs: { type: string; properties: { type: { $ref: string; description: string; }; kms: { type: string; description: string; }; meta: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; TKeyType: { type: string; enum: string\[\]; description: string; }; KeyMetadata: { type: string; properties: { algorithms: { type: string; items: { type: string; }; }; }; description: string; }; ManagedKeyInfo: { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerDecryptJWEArgs: { type: string; properties: { kid: { type: string; description: string; }; data: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerDeleteArgs: { type: string; properties: { kid: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerEncryptJWEArgs: { type: string; properties: { kid: { type: string; description: string; }; to: { type: string; properties: { kid: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; data: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerGetArgs: { type: string; properties: { kid: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKey: { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; MinimalImportableKey: { $ref: string; description: string; }; "RequireOnly<IKey,(\\"privateKeyHex\\"|\\"type\\"|\\"kms\\")>": { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; description: string; }; IKeyManagerSharedSecretArgs: { type: string; properties: { secretKeyRef: { type: string; description: string; }; publicKey: { type: string; properties: { publicKeyHex: { type: string; description: string; }; type: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerSignArgs: { type: string; properties: { keyRef: { type: string; description: string; }; algorithm: { type: string; description: string; }; data: { type: string; description: string; }; encoding: { type: string; enum: string\[\]; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerSignEthTXArgs: { type: string; properties: { kid: { type: string; description: string; }; transaction: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerSignJWTArgs: { type: string; properties: { kid: { type: string; description: string; }; data: { anyOf: ({ type: string; properties?: undefined; required?: undefined; additionalProperties?: undefined; } | { type: string; properties: { BYTES_PER_ELEMENT: { type: string; }; buffer: { anyOf: ({ type: string; properties: { byteLength: { type: string; }; }; required: string\[\]; } | { type?: undefined; properties?: undefined; required?: undefined; })\[\]; }; byteLength: { type: string; }; byteOffset: { type: string; }; length: { type: string; }; }; required: string\[\]; additionalProperties: { type: string; }; })\[\]; description: string; }; }; required: string\[\]; description: string; }; }; methods: { keyManagerCreate: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; keyManagerDecryptJWE: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerDelete: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerEncryptJWE: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerGet: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; keyManagerGetKeyManagementSystems: { description: string; arguments: { type: string; }; returnType: { type: string; items: { type: string; }; }; }; keyManagerImport: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; keyManagerSharedSecret: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerSign: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerSignEthTX: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerSignJWT: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | | +| Property | Modifiers | Type | Description | +| ---------------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | +| [methods](./key-manager.keymanager.methods.md) | readonly | [IKeyManager](./core-types.ikeymanager.md) | Plugin methods | +| [schema](./key-manager.keymanager.schema.md) | readonly | { components: { schemas: { IKeyManagerCreateArgs: { type: string; properties: { type: { $ref: string; description: string; }; kms: { type: string; description: string; }; meta: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; TKeyType: { type: string; enum: string\[\]; description: string; }; KeyMetadata: { type: string; properties: { algorithms: { type: string; items: { $ref: string; }; }; }; description: string; }; TAlg: { type: string; description: string; }; ManagedKeyInfo: { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerDecryptJWEArgs: { type: string; properties: { kid: { type: string; description: string; }; data: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerDeleteArgs: { type: string; properties: { kid: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerEncryptJWEArgs: { type: string; properties: { kid: { type: string; description: string; }; to: { type: string; properties: { kid: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; data: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerGetArgs: { type: string; properties: { kid: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKey: { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; MinimalImportableKey: { $ref: string; description: string; }; "RequireOnly<IKey,(\\"privateKeyHex\\"|\\"type\\"|\\"kms\\")>": { type: string; properties: { kid: { type: string; description: string; }; kms: { type: string; description: string; }; type: { $ref: string; description: string; }; publicKeyHex: { type: string; description: string; }; privateKeyHex: { type: string; description: string; }; meta: { anyOf: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; description: string; }; IKeyManagerSharedSecretArgs: { type: string; properties: { secretKeyRef: { type: string; description: string; }; publicKey: { type: string; properties: { publicKeyHex: { type: string; description: string; }; type: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerSignArgs: { type: string; properties: { keyRef: { type: string; description: string; }; algorithm: { type: string; description: string; }; data: { type: string; description: string; }; encoding: { type: string; enum: string\[\]; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerSignEthTXArgs: { type: string; properties: { kid: { type: string; description: string; }; transaction: { type: string; description: string; }; }; required: string\[\]; description: string; }; IKeyManagerSignJWTArgs: { type: string; properties: { kid: { type: string; description: string; }; data: { anyOf: ({ type: string; properties?: undefined; required?: undefined; additionalProperties?: undefined; } | { type: string; properties: { BYTES_PER_ELEMENT: { type: string; }; buffer: { anyOf: ({ type: string; properties: { byteLength: { type: string; }; }; required: string\[\]; } | { type?: undefined; properties?: undefined; required?: undefined; })\[\]; }; byteLength: { type: string; }; byteOffset: { type: string; }; length: { type: string; }; }; required: string\[\]; additionalProperties: { type: string; }; })\[\]; description: string; }; }; required: string\[\]; description: string; }; }; methods: { keyManagerCreate: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; keyManagerDecryptJWE: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerDelete: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerEncryptJWE: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerGet: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; keyManagerGetKeyManagementSystems: { description: string; arguments: { type: string; }; returnType: { type: string; items: { type: string; }; }; }; keyManagerImport: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; keyManagerSharedSecret: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerSign: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerSignEthTX: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; keyManagerSignJWT: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | | ## Methods diff --git a/docs/api/key-manager.keymanager.schema.md b/docs/api/key-manager.keymanager.schema.md index 184abd8..6986773 100644 --- a/docs/api/key-manager.keymanager.schema.md +++ b/docs/api/key-manager.keymanager.schema.md @@ -44,12 +44,16 @@ readonly schema: { algorithms: { type: string; items: { - type: string; + $ref: string; }; }; }; description: string; }; + TAlg: { + type: string; + description: string; + }; ManagedKeyInfo: { type: string; properties: { diff --git a/docs/api/selective-disclosure.selectivedisclosure.md b/docs/api/selective-disclosure.selectivedisclosure.md index 154a6e8..3919245 100644 --- a/docs/api/selective-disclosure.selectivedisclosure.md +++ b/docs/api/selective-disclosure.selectivedisclosure.md @@ -32,10 +32,10 @@ export declare class SelectiveDisclosure implements IAgentPlugin ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -| [methods](./selective-disclosure.selectivedisclosure.methods.md) | readonly | [ISelectiveDisclosure](./selective-disclosure.iselectivedisclosure.md) | **_(BETA)_** | -| [schema](./selective-disclosure.selectivedisclosure.schema.md) | readonly | { components: { schemas: { ICreateProfileCredentialsArgs: { type: string; properties: { holder: { type: string; description: string; }; verifier: { type: string; description: string; }; name: { type: string; description: string; }; picture: { type: string; description: string; }; url: { type: string; description: string; }; save: { type: string; description: string; }; send: { type: string; description: string; }; }; required: string\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; CompactJWT: { type: string; description: string; }; ICreateSelectiveDisclosureRequestArgs: { type: string; properties: { data: { $ref: string; }; }; required: string\[\]; description: string; }; ISelectiveDisclosureRequest: { type: string; properties: { issuer: { type: string; description: string; }; subject: { type: string; description: string; }; replyUrl: { type: string; description: string; }; tag: { type: string; }; claims: { type: string; items: { $ref: string; }; description: string; }; credentials: { type: string; items: { type: string; }; description: string; }; }; required: string\[\]; description: string; }; ICredentialRequestInput: { type: string; properties: { reason: { type: string; description: string; }; essential: { type: string; description: string; }; credentialType: { type: string; description: string; }; credentialContext: { type: string; description: string; }; claimType: { type: string; description: string; }; claimValue: { type: string; description: string; }; issuers: { type: string; items: { $ref: string; }; description: string; }; }; required: string\[\]; description: string; }; Issuer: { type: string; properties: { did: { type: string; description: string; }; url: { type: string; description: string; }; }; required: string\[\]; description: string; }; IGetVerifiableCredentialsForSdrArgs: { type: string; properties: { sdr: { type: string; properties: { subject: { type: string; description: string; }; replyUrl: { type: string; description: string; }; tag: { type: string; }; claims: { type: string; items: { $ref: string; }; description: string; }; credentials: { type: string; items: { type: string; }; description: string; }; }; required: string\[\]; description: string; }; did: { type: string; description: string; }; }; required: string\[\]; description: string; }; ICredentialsForSdr: { type: string; properties: { reason: { type: string; description: string; }; essential: { type: string; description: string; }; credentialType: { type: string; description: string; }; credentialContext: { type: string; description: string; }; claimType: { type: string; description: string; }; claimValue: { type: string; description: string; }; issuers: { type: string; items: { $ref: string; }; description: string; }; credentials: { type: string; items: { $ref: string; }; }; }; required: string\[\]; description: string; }; UniqueVerifiableCredential: { type: string; properties: { hash: { type: string; }; verifiableCredential: { $ref: string; }; }; required: string\[\]; description: string; }; IValidatePresentationAgainstSdrArgs: { type: string; properties: { presentation: { $ref: string; }; sdr: { $ref: string; }; }; required: string\[\]; description: string; }; IPresentationValidationResult: { type: string; properties: { valid: { type: string; }; claims: { type: string; items: { $ref: string; }; }; }; required: string\[\]; description: string; }; }; methods: { createProfilePresentation: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createSelectiveDisclosureRequest: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; getVerifiableCredentialsForSdr: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; validatePresentationAgainstSdr: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; }; }; } | **_(BETA)_** | +| Property | Modifiers | Type | Description | +| ---------------------------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| [methods](./selective-disclosure.selectivedisclosure.methods.md) | readonly | [ISelectiveDisclosure](./selective-disclosure.iselectivedisclosure.md) | **_(BETA)_** | +| [schema](./selective-disclosure.selectivedisclosure.schema.md) | readonly | { components: { schemas: { ICreateProfileCredentialsArgs: { type: string; properties: { holder: { type: string; description: string; }; verifier: { type: string; description: string; }; name: { type: string; description: string; }; picture: { type: string; description: string; }; url: { type: string; description: string; }; save: { type: string; /\*\* \* This class adds support for creating \* {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure} \* requests and interpret the responses received. \* \* This implementation of the uPort protocol uses \* {@link https://www.w3.org/TR/vc-data-model/\#presentations | W3C Presentation} \* as the response encoding instead of a \`shareReq\`. \* \* @beta This API may change without a BREAKING CHANGE notice. \*/ description: string; }; send: { type: string; description: string; }; }; required: string\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; /\*\* \* Creates a Selective disclosure request, encoded as a JWT. \* \* @remarks See \* {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure} \* \* @param args - The param object with the properties necessary to create the request. See \* {@link ISelectiveDisclosureRequest} \* @param context - \*RESERVED\* This is filled by the framework when the method is called. \* \* @beta This API may change without a BREAKING CHANGE notice. \*/ }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; CompactJWT: { type: string; description: string; }; ICreateSelectiveDisclosureRequestArgs: { type: string; properties: { data: { $ref: string; }; }; required: string\[\]; description: string; }; ISelectiveDisclosureRequest: { type: string; properties: { issuer: { type: string; description: string; }; subject: { type: string; description: string; }; replyUrl: { type: string; description: string; }; tag: { type: string; }; claims: { type: string; items: { $ref: string; }; description: string; }; credentials: { type: string; items: { type: string; }; description: string; }; }; required: string\[\]; description: string; }; ICredentialRequestInput: { type: string; properties: { reason: { type: string; description: string; }; essential: { type: string; description: string; }; credentialType: { type: string; description: string; }; credentialContext: { type: string; description: string; }; claimType: { type: string; description: string; }; claimValue: { type: string; description: string; }; issuers: { type: string; items: { $ref: string; }; description: string; }; }; required: string\[\]; description: string; }; Issuer: { type: string; properties: { did: { type: string; description: string; }; url: { type: string; description: string; }; }; required: string\[\]; description: string; }; IGetVerifiableCredentialsForSdrArgs: { type: string; properties: { sdr: { type: string; properties: { subject: { type: string; description: string; }; replyUrl: { type: string; description: string; }; tag: { type: string; }; claims: { type: string; items: { $ref: string; }; description: string; }; credentials: { type: string; items: { type: string; }; description: string; }; }; required: string\[\]; description: string; }; did: { type: string; description: string; }; }; required: string\[\]; description: string; }; ICredentialsForSdr: { type: string; properties: { reason: { type: string; description: string; }; essential: { type: string; description: string; }; credentialType: { type: string; description: string; }; credentialContext: { type: string; description: string; }; claimType: { type: string; description: string; }; claimValue: { type: string; description: string; }; issuers: { type: string; items: { $ref: string; }; description: string; }; credentials: { type: string; items: { $ref: string; }; }; }; required: string\[\]; description: string; }; UniqueVerifiableCredential: { type: string; properties: { hash: { type: string; }; verifiableCredential: { $ref: string; }; }; required: string\[\]; description: string; }; IValidatePresentationAgainstSdrArgs: { type: string; properties: { presentation: { $ref: string; }; sdr: { $ref: string; }; }; required: string\[\]; description: string; }; IPresentationValidationResult: { type: string; properties: { valid: { type: string; }; claims: { type: string; items: { $ref: string; }; }; }; required: string\[\]; description: string; }; }; methods: { createProfilePresentation: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createSelectiveDisclosureRequest: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; getVerifiableCredentialsForSdr: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; validatePresentationAgainstSdr: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; }; }; } | **_(BETA)_** | ## Methods diff --git a/docs/api/selective-disclosure.selectivedisclosure.schema.md b/docs/api/selective-disclosure.selectivedisclosure.schema.md index 9bc5a0d..325b2a0 100644 --- a/docs/api/selective-disclosure.selectivedisclosure.schema.md +++ b/docs/api/selective-disclosure.selectivedisclosure.schema.md @@ -40,7 +40,17 @@ readonly schema: { description: string; }; save: { - type: string; + type: string; /** + * This class adds support for creating + * {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure} + * requests and interpret the responses received. + * + * This implementation of the uPort protocol uses + * {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Presentation} + * as the response encoding instead of a `shareReq`. + * + * @beta This API may change without a BREAKING CHANGE notice. + */ description: string; }; send: { @@ -70,7 +80,18 @@ readonly schema: { anyOf: ({ type: string; items: { - type: string; + type: string; /** + * Creates a Selective disclosure request, encoded as a JWT. + * + * @remarks See + * {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure} + * + * @param args - The param object with the properties necessary to create the request. See + * {@link ISelectiveDisclosureRequest} + * @param context - *RESERVED* This is filled by the framework when the method is called. + * + * @beta This API may change without a BREAKING CHANGE notice. + */ }; } | { type: string; diff --git a/docs/api/utils.intersect.md b/docs/api/utils.intersect.md new file mode 100644 index 0000000..912068b --- /dev/null +++ b/docs/api/utils.intersect.md @@ -0,0 +1,30 @@ +--- +id: utils.intersect +title: intersect() function +hide_title: true +--- + + + +## intersect() function + +Compute the intersection of two arrays Elements are compared by reference so object types will appear as unique even if they contain the same data. + +**Signature:** + +```typescript +export declare function intersect(a: T[] | any, b: any[] | any): T[] +``` + +## Parameters + +| Parameter | Type | Description | +| --------- | ------------------ | ------------ | +| a | T\[\] | any | first array | +| b | any\[\] | any | second array | + +**Returns:** + +T\[\] + +The intersection of the two arrays. diff --git a/docs/api/utils.md b/docs/api/utils.md index 6379392..f80dc7f 100644 --- a/docs/api/utils.md +++ b/docs/api/utils.md @@ -41,6 +41,7 @@ Contains helper methods for Veramo plugins. | [getChainIdForDidEthr(verificationMethod)](./utils.getchainidfordidethr.md) | **_(BETA)_** Extracts the chain ID from a supporting legacy representations as well. | | [getEthereumAddress(verificationMethod)](./utils.getethereumaddress.md) | **_(BETA)_** Extracts an ethereum address from a supporting legacy representations. | | [hexToBytes(hexString)](./utils.hextobytes.md) | **_(BETA)_** Converts a hex string (with or without prefix) to a byte array (Uint8Array) | +| [intersect(a, b)](./utils.intersect.md) | Compute the intersection of two arrays Elements are compared by reference so object types will appear as unique even if they contain the same data. | | [isDefined(arg)](./utils.isdefined.md) | **_(BETA)_** Checks if a variable is defined and not null. After this check, typescript sees the variable as defined. | | [isIterable(obj)](./utils.isiterable.md) | **_(BETA)_** Checks if an object is iterable (can be used for for..of) | | [mapIdentifierKeysToDoc(identifier, section, context)](./utils.mapidentifierkeystodoc.md) | **_(BETA)_** Maps the keys of a locally managed [IIdentifier](./core-types.iidentifier.md) to the corresponding entries from the DID document. |