readonly | [ICredentialIssuerEIP712](./credential-eip712.icredentialissuereip712.md) | **_(BETA)_** |
-| [schema](./credential-eip712.credentialissuereip712.schema.md) | readonly | { components: { schemas: { ICreateVerifiableCredentialEIP712Args: { type: string; properties: { credential: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; }; required: string\[\]; description: string; }; CredentialPayload: { type: string; properties: { issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; /\*\* {@inheritdoc ICredentialIssuerEIP712.createVerifiableCredentialEIP712} \*/ }; issuanceDate: { $ref: string; }; expirationDate: { $ref: 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; }; DateType: { type: string; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: 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; }; ICreateVerifiablePresentationEIP712Args: { type: string; properties: { presentation: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; }; required: string\[\]; description: string; }; PresentationPayload: { type: string; properties: { holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: 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; }; IVerifyCredentialEIP712Args: { type: string; properties: { credential: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; IVerifyPresentationEIP712Args: { type: string; properties: { presentation: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; }; methods: { createVerifiableCredentialEIP712: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiablePresentationEIP712: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; verifyCredentialEIP712: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; verifyPresentationEIP712: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | **_(BETA)_** |
+| Property | Modifiers | Type | Description |
+| ---------------------------------------------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
+| [methods](./credential-eip712.credentialissuereip712.methods.md) | readonly | [ICredentialIssuerEIP712](./credential-eip712.icredentialissuereip712.md) | **_(BETA)_** |
+| [schema](./credential-eip712.credentialissuereip712.schema.md) | readonly | { components: { schemas: { ICreateVerifiableCredentialEIP712Args: { type: string; properties: { credential: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; }; required: string\[\]; description: string; }; CredentialPayload: { type: string; properties: { issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: 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; }; DateType: { type: string; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: 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; }; ICreateVerifiablePresentationEIP712Args: { type: string; properties: { presentation: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; }; required: string\[\]; description: string; }; PresentationPayload: { type: string; properties: { holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: 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; }; IVerifyCredentialEIP712Args: { type: string; properties: { credential: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; IVerifyPresentationEIP712Args: { type: string; properties: { presentation: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; }; methods: { createVerifiableCredentialEIP712: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiablePresentationEIP712: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; verifyCredentialEIP712: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; verifyPresentationEIP712: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | **_(BETA)_** |
## Methods
diff --git a/docs/api/credential-eip712.credentialissuereip712.schema.md b/docs/api/credential-eip712.credentialissuereip712.schema.md
index 2b3cca2..34621e1 100644
--- a/docs/api/credential-eip712.credentialissuereip712.schema.md
+++ b/docs/api/credential-eip712.credentialissuereip712.schema.md
@@ -47,7 +47,7 @@ readonly schema: {
};
};
"@context": {
- $ref: string; /** {@inheritdoc ICredentialIssuerEIP712.createVerifiableCredentialEIP712} */
+ $ref: string;
};
issuanceDate: {
$ref: string;
diff --git a/docs/api/did-comm.didcomm.md b/docs/api/did-comm.didcomm.md
index 20757bc..1d8e313 100644
--- a/docs/api/did-comm.didcomm.md
+++ b/docs/api/did-comm.didcomm.md
@@ -36,11 +36,11 @@ This API may change without a BREAKING CHANGE notice.
## Properties
-| Property | Modifiers | Type | Description |
-| ---------------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
-| [methods](./did-comm.didcomm.methods.md) | readonly | [IDIDComm](./did-comm.ididcomm.md) | **_(BETA)_** Plugin methods |
-| [schema](./did-comm.didcomm.schema.md) | readonly | { components: { schemas: { IPackedDIDCommMessage: { type: string; properties: { message: { type: string; }; }; required: string\[\]; description: string; }; DIDCommMessageMediaType: { type: string; enum: string\[\]; description: string; }; IPackDIDCommMessageArgs: { type: string; properties: { message: { $ref: string; }; packing: { $ref: string; }; keyRef: { type: string; }; options: { $ref: string; }; }; required: string\[\]; description: string; }; IDIDCommMessage: { type: string; properties: { type: { type: string; }; from: { type: string; }; to: { type: string; }; thid: { type: string; }; pthid: { type: string; }; id: { type: string; }; expires_time: { type: string; }; created_time: { type: string; }; next: { type: string; }; from_prior: { type: string; }; body: {}; attachments: { type: string; items: { $ref: string; }; }; return_route: { type: string; }; }; required: string\[\]; description: string; }; IDIDCommMessageAttachment: { 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; }; IDIDCommMessageAttachmentData: { type: string; properties: { jws: {}; hash: { type: string; }; links: { type: string; items: { type: string; }; }; base64: { type: string; }; json: {}; }; description: string; }; DIDCommMessagePacking: { type: string; enum: string\[\]; description: string; }; IDIDCommOptions: { type: string; properties: { bcc: { type: string; items: { type: string; }; description: string; }; recipientKids: { type: string; items: { type: string; }; description: string; }; }; description: string; }; ISendDIDCommMessageArgs: { type: string; properties: { packedMessage: { $ref: string; }; messageId: { type: string; }; returnTransportId: { type: string; }; recipientDidUrl: { type: string; }; }; required: string\[\]; description: string; }; ISendMessageDIDCommAlpha1Args: { type: string; properties: { url: { type: string; }; save: { type: string; }; data: { type: string; properties: { id: { type: string; }; from: { type: string; }; to: { type: string; }; type: { type: string; }; body: { anyOf: { type: string; }\[\]; }; }; required: string\[\]; }; headers: { type: string; additionalProperties: { type: string; }; }; }; required: string\[\]; deprecated: 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; }; IUnpackDIDCommMessageArgs: { $ref: string; description: string; }; IUnpackedDIDCommMessage: { type: string; properties: { metaData: { $ref: string; }; message: { $ref: string; }; }; required: string\[\]; description: string; }; IDIDCommMessageMetaData: { type: string; properties: { packing: { $ref: string; }; }; required: string\[\]; description: string; }; }; methods: { getDIDCommMessageMediaType: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; packDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; sendDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; sendMessageDIDCommAlpha1: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; unpackDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; }; }; } | **_(BETA)_** |
-| [transports](./did-comm.didcomm.transports.md) | readonly | [IDIDCommTransport](./did-comm.ididcommtransport.md)\[\] | **_(BETA)_** |
+| Property | Modifiers | Type | Description |
+| ---------------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
+| [methods](./did-comm.didcomm.methods.md) | readonly | [IDIDComm](./did-comm.ididcomm.md) | **_(BETA)_** Plugin methods |
+| [schema](./did-comm.didcomm.schema.md) | readonly | { components: { schemas: { IPackedDIDCommMessage: { type: string; properties: { message: { type: string; }; }; required: string\[\]; description: string; }; DIDCommMessageMediaType: { type: string; enum: string\[\]; description: string; }; IPackDIDCommMessageArgs: { type: string; properties: { message: { $ref: string; }; packing: { $ref: string; }; keyRef: { type: string; }; options: { $ref: string; }; }; required: string\[\]; description: string; }; IDIDCommMessage: { type: string; properties: { type: { type: string; }; from: { type: string; }; to: { type: string; }; thid: { type: string; }; pthid: { type: string; }; id: { type: string; }; expires_time: { type: string; }; created_time: { type: string; }; next: { type: string; }; from_prior: { type: string; }; body: {}; attachments: { type: string; items: { $ref: string; }; }; return_route: { type: string; }; }; required: string\[\]; description: string; }; IDIDCommMessageAttachment: { 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; }; IDIDCommMessageAttachmentData: { type: string; properties: { jws: {}; hash: { type: string; }; links: { type: string; items: { type: string; }; }; base64: { type: string; }; json: {}; }; description: string; }; DIDCommMessagePacking: { type: string; enum: string\[\]; description: string; }; IDIDCommOptions: { type: string; properties: { bcc: { type: string; items: { type: string; }; description: string; }; recipientKids: { type: string; items: { type: string; }; description: string; }; enc: { type: string; enum: string\[\]; description: string; }; alg: { type: string; enum: string\[\]; description: string; }; }; description: string; }; ISendDIDCommMessageArgs: { type: string; properties: { packedMessage: { $ref: string; }; messageId: { type: string; }; returnTransportId: { type: string; }; recipientDidUrl: { type: string; }; }; required: string\[\]; description: string; }; ISendMessageDIDCommAlpha1Args: { type: string; properties: { url: { type: string; }; save: { type: string; }; data: { type: string; properties: { id: { type: string; }; from: { type: string; }; to: { type: string; }; type: { type: string; }; body: { anyOf: { type: string; }\[\]; }; }; required: string\[\]; }; headers: { type: string; additionalProperties: { type: string; }; }; }; required: string\[\]; deprecated: 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; }; IUnpackDIDCommMessageArgs: { $ref: string; description: string; }; IUnpackedDIDCommMessage: { type: string; properties: { metaData: { $ref: string; }; message: { $ref: string; }; }; required: string\[\]; description: string; }; IDIDCommMessageMetaData: { type: string; properties: { packing: { $ref: string; }; }; required: string\[\]; description: string; }; }; methods: { getDIDCommMessageMediaType: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; packDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; sendDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; sendMessageDIDCommAlpha1: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; unpackDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; }; }; } | **_(BETA)_** |
+| [transports](./did-comm.didcomm.transports.md) | readonly | [IDIDCommTransport](./did-comm.ididcommtransport.md)\[\] | **_(BETA)_** |
## Methods
diff --git a/docs/api/did-comm.didcomm.schema.md b/docs/api/did-comm.didcomm.schema.md
index 5a6a705..b222267 100644
--- a/docs/api/did-comm.didcomm.schema.md
+++ b/docs/api/did-comm.didcomm.schema.md
@@ -170,6 +170,16 @@ readonly schema: {
};
description: string;
};
+ enc: {
+ type: string;
+ enum: string[];
+ description: string;
+ };
+ alg: {
+ type: string;
+ enum: string[];
+ description: string;
+ };
};
description: string;
};
diff --git a/docs/api/did-comm.ididcommoptions.alg.md b/docs/api/did-comm.ididcommoptions.alg.md
new file mode 100644
index 0000000..5ee180f
--- /dev/null
+++ b/docs/api/did-comm.ididcommoptions.alg.md
@@ -0,0 +1,19 @@
+---
+id: did-comm.ididcommoptions.alg
+title: IDIDCommOptions.alg property
+hide_title: true
+---
+
+
+
+## IDIDCommOptions.alg property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Optional key wrapping algorithm to use. Defaults to 'ECDH-ES+A256KW'
+
+**Signature:**
+
+```typescript
+alg?: 'ECDH-ES+A256KW' | 'ECDH-1PU+A256KW' | 'ECDH-ES+XC20PKW' | 'ECDH-1PU+XC20PKW';
+```
diff --git a/docs/api/did-comm.ididcommoptions.enc.md b/docs/api/did-comm.ididcommoptions.enc.md
new file mode 100644
index 0000000..78cb349
--- /dev/null
+++ b/docs/api/did-comm.ididcommoptions.enc.md
@@ -0,0 +1,19 @@
+---
+id: did-comm.ididcommoptions.enc
+title: IDIDCommOptions.enc property
+hide_title: true
+---
+
+
+
+## IDIDCommOptions.enc property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Optional content encryption algorithm to use. Defaults to 'A256GCM'
+
+**Signature:**
+
+```typescript
+enc?: 'XC20P' | 'A256GCM' | 'A256CBC-HS512';
+```
diff --git a/docs/api/did-comm.ididcommoptions.md b/docs/api/did-comm.ididcommoptions.md
index 9d14ff4..12edcbb 100644
--- a/docs/api/did-comm.ididcommoptions.md
+++ b/docs/api/did-comm.ididcommoptions.md
@@ -22,7 +22,9 @@ export interface IDIDCommOptions
## Properties
-| Property | Modifiers | Type | Description |
-| ------------------------------------------------------------- | --------- | ---------- | ---------------------------------------------------------------------- |
-| [bcc?](./did-comm.ididcommoptions.bcc.md) | | string\[\] | **_(BETA)_** _(Optional)_ Add extra recipients for the packed message. |
-| [recipientKids?](./did-comm.ididcommoptions.recipientkids.md) | | string\[\] | **_(BETA)_** _(Optional)_ Restrict to a set of kids for recipient |
+| Property | Modifiers | Type | Description |
+| ------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| [alg?](./did-comm.ididcommoptions.alg.md) | | 'ECDH-ES+A256KW' | 'ECDH-1PU+A256KW' | 'ECDH-ES+XC20PKW' | 'ECDH-1PU+XC20PKW' | **_(BETA)_** _(Optional)_ Optional key wrapping algorithm to use. Defaults to 'ECDH-ES+A256KW' |
+| [bcc?](./did-comm.ididcommoptions.bcc.md) | | string\[\] | **_(BETA)_** _(Optional)_ Add extra recipients for the packed message. |
+| [enc?](./did-comm.ididcommoptions.enc.md) | | 'XC20P' | 'A256GCM' | 'A256CBC-HS512' | **_(BETA)_** _(Optional)_ Optional content encryption algorithm to use. Defaults to 'A256GCM' |
+| [recipientKids?](./did-comm.ididcommoptions.recipientkids.md) | | string\[\] | **_(BETA)_** _(Optional)_ Restrict to a set of kids for recipient |
diff --git a/docs/api/did-provider-jwk.jwkdidsupportedkeytypes.md b/docs/api/did-provider-jwk.jwkdidsupportedkeytypes.md
index 57fae0a..5e38f6d 100644
--- a/docs/api/did-provider-jwk.jwkdidsupportedkeytypes.md
+++ b/docs/api/did-provider-jwk.jwkdidsupportedkeytypes.md
@@ -11,5 +11,7 @@ hide_title: true
**Signature:**
```typescript
-export type JwkDidSupportedKeyTypes = 'Secp256r1' | 'Secp256k1' | 'Ed25519' | 'X25519'
+export type JwkDidSupportedKeyTypes = keyof typeof SupportedKeyTypes
```
+
+**References:** [SupportedKeyTypes](./did-provider-jwk.supportedkeytypes.md)
diff --git a/docs/api/utils.converted25519privatekeytox25519.md b/docs/api/utils.converted25519privatekeytox25519.md
new file mode 100644
index 0000000..ef2778a
--- /dev/null
+++ b/docs/api/utils.converted25519privatekeytox25519.md
@@ -0,0 +1,29 @@
+---
+id: utils.converted25519privatekeytox25519
+title: convertEd25519PrivateKeyToX25519() function
+hide_title: true
+---
+
+
+
+## convertEd25519PrivateKeyToX25519() function
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Converts Ed25519 private keys to X25519
+
+**Signature:**
+
+```typescript
+export declare function convertEd25519PrivateKeyToX25519(privateKey: Uint8Array): Uint8Array
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| ---------- | ---------- | ------------------------------------------------------------------------------------------------------- |
+| privateKey | Uint8Array | The bytes of an Ed25519P private key
This API may change without a BREAKING CHANGE notice.
| + +**Returns:** + +Uint8Array diff --git a/docs/api/utils.converted25519publickeytox25519.md b/docs/api/utils.converted25519publickeytox25519.md new file mode 100644 index 0000000..e040a8b --- /dev/null +++ b/docs/api/utils.converted25519publickeytox25519.md @@ -0,0 +1,29 @@ +--- +id: utils.converted25519publickeytox25519 +title: convertEd25519PublicKeyToX25519() function +hide_title: true +--- + + + +## convertEd25519PublicKeyToX25519() function + +> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. + +Converts Ed25519 public keys to X25519 + +**Signature:** + +```typescript +export declare function convertEd25519PublicKeyToX25519(publicKey: Uint8Array): Uint8Array +``` + +## Parameters + +| Parameter | Type | Description | +| --------- | ---------- | ------------------------------------------------------------------------------------------------------ | +| publicKey | Uint8Array |The bytes of an Ed25519P public key
This API may change without a BREAKING CHANGE notice.
| + +**Returns:** + +Uint8Array diff --git a/docs/api/utils.extractissuer.md b/docs/api/utils.extractissuer.md index cff32dc..24b1f63 100644 --- a/docs/api/utils.extractissuer.md +++ b/docs/api/utils.extractissuer.md @@ -22,14 +22,18 @@ export declare function extractIssuer( | CredentialPayload | PresentationPayload | null, + options?: { + removeParameters?: boolean + }, ): string ``` ## Parameters -| Parameter | Type | Description | -| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| input | [W3CVerifiableCredential](./core-types.w3cverifiablecredential.md) | [W3CVerifiablePresentation](./core-types.w3cverifiablepresentation.md) | [CredentialPayload](./core-types.credentialpayload.md) | [PresentationPayload](./core-types.presentationpayload.md) | null |_(Optional)_ the credential or presentation whose issuer/holder needs to be extracted.
This API may change without a BREAKING CHANGE notice.
| +| Parameter | Type | Description | +| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| input | [W3CVerifiableCredential](./core-types.w3cverifiablecredential.md) | [W3CVerifiablePresentation](./core-types.w3cverifiablepresentation.md) | [CredentialPayload](./core-types.credentialpayload.md) | [PresentationPayload](./core-types.presentationpayload.md) | null | _(Optional)_ the credential or presentation whose issuer/holder needs to be extracted. | +| options | { removeParameters?: boolean; } |_(Optional)_ removeParameters - Remove all DID parameters from the issuer ID
This API may change without a BREAKING CHANGE notice.
| **Returns:** diff --git a/docs/api/utils.md b/docs/api/utils.md index d5ff210..6379392 100644 --- a/docs/api/utils.md +++ b/docs/api/utils.md @@ -12,40 +12,43 @@ Contains helper methods for Veramo plugins. ## Functions -| Function | Description | -| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [asArray(arg)](./utils.asarray.md) | **_(BETA)_** Ensures that a given input is an array. If the input is a single item, it is converted to an array with a single entry. | -| [base58ToBytes(s)](./utils.base58tobytes.md) | Converts a base58 string to the Uint8Array it represents. | -| [base64ToBytes(s)](./utils.base64tobytes.md) | Converts a base64url string to the Uint8Array it represents. | -| [bytesToBase58(byteArray)](./utils.bytestobase58.md) | Converts a base58 string to the Uint8Array it represents. | -| [bytesToBase64(b)](./utils.bytestobase64.md) | Encodes a Uint8Array to a base64 string representation with padding. | -| [bytesToBase64url(b)](./utils.bytestobase64url.md) | Converts a Uint8Array to a base64url string | -| [bytesToHex(byteArray, prefix)](./utils.bytestohex.md) | **_(BETA)_** Converts a Uint8Array input to a hex string | -| [bytesToMultibase(byteArray, type)](./utils.bytestomultibase.md) | Converts a Uint8Array to a multibase string. | -| [bytesToUtf8String(b)](./utils.bytestoutf8string.md) | Builds a string from a Uint8Array using the utf-8 encoding. | -| [compressIdentifierSecp256k1Keys(identifier)](./utils.compressidentifiersecp256k1keys.md) | **_(BETA)_** Converts any Secp256k1 public keys of an [IIdentifier](./core-types.iidentifier.md) to their compressed form. | -| [computeEntryHash(input)](./utils.computeentryhash.md) | **_(BETA)_** Computes a hash for a given credential or presentation. This hash is usable as an internal ID for database indexing | -| [concat(arrays, length)](./utils.concat.md) | **_(BETA)_** Concatenates a bunch of arrays into one Uint8Array | -| [convertIdentifierEncryptionKeys(identifier)](./utils.convertidentifierencryptionkeys.md) | **_(BETA)_** Converts any Ed25519 keys of an [IIdentifier](./core-types.iidentifier.md) to X25519 to be usable for encryption. | -| [decodeBase64url(s)](./utils.decodebase64url.md) | **_(BETA)_** Decodes a base64url string to a utf8 string represented by the same bytes. | -| [decodeCredentialToObject(input)](./utils.decodecredentialtoobject.md) | **_(BETA)_** Parses a [W3CVerifiableCredential](./core-types.w3cverifiablecredential.md) and converts it to a [VerifiableCredential](./core-types.verifiablecredential.md) so it is easier to use programmatically. | -| [decodeJoseBlob(blob)](./utils.decodejoseblob.md) | **_(BETA)_** Decodes a base64url string representing stringified JSON to a JSON object. | -| [decodePresentationToObject(input)](./utils.decodepresentationtoobject.md) | **_(BETA)_** Parses a [W3CVerifiablePresentation](./core-types.w3cverifiablepresentation.md) and converts it to a [VerifiablePresentation](./core-types.verifiablepresentation.md) so it is easier to use programmatically. | -| [dereferenceDidKeys(didDocument, section, context)](./utils.dereferencedidkeys.md) |**_(BETA)_** Dereferences keys from DID document and normalizes them for easy comparison.
When dereferencing keyAgreement keys, only Ed25519 and X25519 curves are supported. Other key types are omitted from the result and Ed25519 keys are converted to X25519
| -| [encodeBase64url(s)](./utils.encodebase64url.md) | **_(BETA)_** Encodes the bytes of an input string to base64url | -| [encodeJoseBlob(payload)](./utils.encodejoseblob.md) | **_(BETA)_** Stringifies a JSON object and encodes the bytes of the resulting string to a base64url representation. | -| [extractIssuer(input)](./utils.extractissuer.md) | **_(BETA)_** Decodes a credential or presentation and returns the issuer IDiss from a JWT or issuer/issuer.id from a VC or holder from a VP |
-| [extractPublicKeyHex(pk, convert)](./utils.extractpublickeyhex.md) | **_(BETA)_** Converts the publicKey of a VerificationMethod to hex encoding (publicKeyHex) |
-| [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) |
-| [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. |
-| [multibaseKeyToBytes(s)](./utils.multibasekeytobytes.md) | Converts a multibase string to the Uint8Array it represents. |
-| [processEntryToArray(inputEntryOrArray, startWithEntry)](./utils.processentrytoarray.md) | **_(BETA)_** Processes an entry or an array of entries into an array of entries. If a startWithEntry param is provided, it is set as the first item in the result array. |
-| [resolveDidOrThrow(didUrl, context)](./utils.resolvedidorthrow.md) | **_(BETA)_** Resolve a DID document or throw an error if the resolution fails. |
-| [stringToUtf8Bytes(s)](./utils.stringtoutf8bytes.md) | Encodes a string to a Uint8Array using the utf-8 encoding. |
+| Function | Description |
+| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [asArray(arg)](./utils.asarray.md) | **_(BETA)_** Ensures that a given input is an array. If the input is a single item, it is converted to an array with a single entry. |
+| [base58ToBytes(s)](./utils.base58tobytes.md) | Converts a base58 string to the Uint8Array it represents. |
+| [base64ToBytes(s)](./utils.base64tobytes.md) | Converts a base64url string to the Uint8Array it represents. |
+| [bytesToBase58(byteArray)](./utils.bytestobase58.md) | Converts a base58 string to the Uint8Array it represents. |
+| [bytesToBase64(b)](./utils.bytestobase64.md) | Encodes a Uint8Array to a base64 string representation with padding. |
+| [bytesToBase64url(b)](./utils.bytestobase64url.md) | Converts a Uint8Array to a base64url string |
+| [bytesToHex(byteArray, prefix)](./utils.bytestohex.md) | **_(BETA)_** Converts a Uint8Array input to a hex string |
+| [bytesToMultibase(byteArray, type)](./utils.bytestomultibase.md) | Converts a Uint8Array to a multibase string. |
+| [bytesToUtf8String(b)](./utils.bytestoutf8string.md) | Builds a string from a Uint8Array using the utf-8 encoding. |
+| [compressIdentifierSecp256k1Keys(identifier)](./utils.compressidentifiersecp256k1keys.md) | **_(BETA)_** Converts any Secp256k1 public keys of an [IIdentifier](./core-types.iidentifier.md) to their compressed form. |
+| [computeEntryHash(input)](./utils.computeentryhash.md) | **_(BETA)_** Computes a hash for a given credential or presentation. This hash is usable as an internal ID for database indexing |
+| [concat(arrays, length)](./utils.concat.md) | **_(BETA)_** Concatenates a bunch of arrays into one Uint8Array |
+| [convertEd25519PrivateKeyToX25519(privateKey)](./utils.converted25519privatekeytox25519.md) | **_(BETA)_** Converts Ed25519 private keys to X25519 |
+| [convertEd25519PublicKeyToX25519(publicKey)](./utils.converted25519publickeytox25519.md) | **_(BETA)_** Converts Ed25519 public keys to X25519 |
+| [convertIdentifierEncryptionKeys(identifier)](./utils.convertidentifierencryptionkeys.md) | **_(BETA)_** Converts any Ed25519 keys of an [IIdentifier](./core-types.iidentifier.md) to X25519 to be usable for encryption. |
+| [decodeBase64url(s)](./utils.decodebase64url.md) | **_(BETA)_** Decodes a base64url string to a utf8 string represented by the same bytes. |
+| [decodeCredentialToObject(input)](./utils.decodecredentialtoobject.md) | **_(BETA)_** Parses a [W3CVerifiableCredential](./core-types.w3cverifiablecredential.md) and converts it to a [VerifiableCredential](./core-types.verifiablecredential.md) so it is easier to use programmatically. |
+| [decodeJoseBlob(blob)](./utils.decodejoseblob.md) | **_(BETA)_** Decodes a base64url string representing stringified JSON to a JSON object. |
+| [decodePresentationToObject(input)](./utils.decodepresentationtoobject.md) | **_(BETA)_** Parses a [W3CVerifiablePresentation](./core-types.w3cverifiablepresentation.md) and converts it to a [VerifiablePresentation](./core-types.verifiablepresentation.md) so it is easier to use programmatically. |
+| [dereferenceDidKeys(didDocument, section, context)](./utils.dereferencedidkeys.md) | **_(BETA)_** Dereferences keys from DID document and normalizes them for easy comparison.
When dereferencing keyAgreement keys, only Ed25519 and X25519 curves are supported. Other key types are omitted from the result and Ed25519 keys are converted to X25519
| +| [encodeBase64url(s)](./utils.encodebase64url.md) | **_(BETA)_** Encodes the bytes of an input string to base64url | +| [encodeJoseBlob(payload)](./utils.encodejoseblob.md) | **_(BETA)_** Stringifies a JSON object and encodes the bytes of the resulting string to a base64url representation. | +| [extractIssuer(input, options)](./utils.extractissuer.md) | **_(BETA)_** Decodes a credential or presentation and returns the issuer IDiss from a JWT or issuer/issuer.id from a VC or holder from a VP |
+| [extractPublicKeyHex(pk, convert)](./utils.extractpublickeyhex.md) | **_(BETA)_** Converts the publicKey of a VerificationMethod to hex encoding (publicKeyHex) |
+| [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) |
+| [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. |
+| [multibaseKeyToBytes(s)](./utils.multibasekeytobytes.md) | Converts a multibase string to the Uint8Array it represents. |
+| [processEntryToArray(inputEntryOrArray, startWithEntry)](./utils.processentrytoarray.md) | **_(BETA)_** Processes an entry or an array of entries into an array of entries. If a startWithEntry param is provided, it is set as the first item in the result array. |
+| [removeDIDParameters(did)](./utils.removedidparameters.md) | **_(BETA)_** Remove all DID parameters from a DID url |
+| [resolveDidOrThrow(didUrl, context)](./utils.resolvedidorthrow.md) | **_(BETA)_** Resolve a DID document or throw an error if the resolution fails. |
+| [stringToUtf8Bytes(s)](./utils.stringtoutf8bytes.md) | Encodes a string to a Uint8Array using the utf-8 encoding. |
## Variables
diff --git a/docs/api/utils.removedidparameters.md b/docs/api/utils.removedidparameters.md
new file mode 100644
index 0000000..83d67ab
--- /dev/null
+++ b/docs/api/utils.removedidparameters.md
@@ -0,0 +1,29 @@
+---
+id: utils.removedidparameters
+title: removeDIDParameters() function
+hide_title: true
+---
+
+
+
+## removeDIDParameters() function
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Remove all DID parameters from a DID url
+
+**Signature:**
+
+```typescript
+export declare function removeDIDParameters(did: string): string
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --------- | ------ | ------------------------------------------------------------------------------ |
+| did | string | the DID URL
This API may change without a BREAKING CHANGE notice.
| + +**Returns:** + +string diff --git a/package.json b/package.json index 536ec3d..decff30 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "veramo-site-docs", - "version": "5.2.0", + "version": "5.4.0", "private": true, "scripts": { "start": "NODE_ENV=production HTTPS=true docusaurus serve --port $PORT",