did-comm package

Provides a plugin for the Agent that implements IDIDComm interface. Provides a plugin for the MessageHandler that decrypts messages.

Classes

Class	Description
CoordinateMediationMediatorMessageHandler	(BETA) A plugin for the MessageHandler that handles Mediator Coordinator messages for the mediator role. This API may change without a BREAKING CHANGE notice.
CoordinateMediationRecipientMessageHandler	(BETA) A plugin for the MessageHandler that handles Mediator Coordinator messages for the recipient role. This API may change without a BREAKING CHANGE notice.
CoordinateMediationV3MediatorMessageHandler	(BETA) A plugin for the MessageHandler that handles Mediator Coordinator messages for the mediator role. This API may change without a BREAKING CHANGE notice.
CoordinateMediationV3RecipientMessageHandler	(BETA) A plugin for the MessageHandler that handles Mediator Coordinator messages for the recipient role. This API may change without a BREAKING CHANGE notice.
DIDComm	(BETA) DID Comm plugin for Agent This plugin provides a method of creating an encrypted message according to the initial DIDComm-js implementation.
DIDCommHttpTransport	(BETA) Implementation of IDIDCommTransport to provide a simple transport based on HTTP(S) requests. This API may change without a BREAKING CHANGE notice.
DIDCommMessageHandler	(BETA) A plugin for the MessageHandler that decrypts DIDComm messages. This API may change without a BREAKING CHANGE notice.
PickupMediatorMessageHandler	(BETA) A plugin for the MessageHandler that handles Pickup messages for the mediator role. This API may change without a BREAKING CHANGE notice.
PickupRecipientMessageHandler	(BETA) A plugin for the MessageHandler that handles Pickup messages for the mediator role. This API may change without a BREAKING CHANGE notice.
RoutingMessageHandler	(BETA) A plugin for the MessageHandler that handles forward messages for the Routing protocol. This API may change without a BREAKING CHANGE notice.
TrustPingMessageHandler	(BETA) A plugin for the MessageHandler that handles Trust Ping messages. This API may change without a BREAKING CHANGE notice.

Abstract Classes

Abstract Class	Description
AbstractDIDCommTransport	(BETA) Abstract implementation of IDIDCommTransport. This API may change without a BREAKING CHANGE notice.

Enumerations

Enumeration	Description
CoordinateMediation	(BETA) This API may change without a BREAKING CHANGE notice. Represents the types of messages that can be sent and received by the Mediator Coordinator protocol
DIDCommMessageMediaType	(BETA) Represents different DIDComm v2 message encapsulation. This API may change without a BREAKING CHANGE notice.
MessagePickup	(BETA) This API may change without a BREAKING CHANGE notice.
RecipientUpdateResult	(BETA) This API may change without a BREAKING CHANGE notice. Represents the result of an update action
UpdateAction	(BETA) This API may change without a BREAKING CHANGE notice. Represents the actions (add or remove) that can be taken on a recipient did

Functions

Function	Description
createDeliveryRequestMessage(recipientDidUrl, mediatorDidUrl)	(BETA) This API may change without a BREAKING CHANGE notice.
createMediateGrantMessage(recipientDidUrl, mediatorDidUrl, thid)	(BETA) This API may change without a BREAKING CHANGE notice.
createMediateRequestMessage(recipientDidUrl, mediatorDidUrl)	(BETA) This API may change without a BREAKING CHANGE notice.
createStatusRequestMessage(recipientDidUrl, mediatorDidUrl)	(BETA) This API may change without a BREAKING CHANGE notice.
createV3DeliveryRequestMessage(recipientDidUrl, mediatorDidUrl)	(BETA) This API may change without a BREAKING CHANGE notice.
createV3MediateDenyMessage(recipientDidUrl, mediatorDidUrl, thid)	(BETA) This API may change without a BREAKING CHANGE notice.
createV3MediateGrantMessage(recipientDidUrl, mediatorDidUrl, thid)	(BETA) This API may change without a BREAKING CHANGE notice.
createV3MediateRequestMessage(recipientDidUrl, mediatorDidUrl)	(BETA) This API may change without a BREAKING CHANGE notice.
createV3RecipientQueryMessage(recipientDidUrl, mediatorDidUrl)	(BETA) This API may change without a BREAKING CHANGE notice.
createV3RecipientQueryResponseMessage(recipientDidUrl, mediatorDidUrl, thid, dids)	(BETA) This API may change without a BREAKING CHANGE notice.
createV3RecipientUpdateMessage(recipientDidUrl, mediatorDidUrl, updates)	(BETA) This API may change without a BREAKING CHANGE notice.
createV3RecipientUpdateResponseMessage(recipientDidUrl, mediatorDidUrl, thid, updates)	(BETA) This API may change without a BREAKING CHANGE notice.
createV3StatusRequestMessage(recipientDidUrl, mediatorDidUrl)	(BETA) This API may change without a BREAKING CHANGE notice.

Interfaces

Interface	Description
CoordinateMediationV3MediatorMessageHandlerOptions	(BETA) This API may change without a BREAKING CHANGE notice. Parameter options for the CoordinateMediationV3MediatorMessageHandler CoordinateMediationV3MediatorMessageHandler
DIDCommConfig	(BETA) The config for the DIDComm DIDComm plugin. This API may change without a BREAKING CHANGE notice.
IDIDComm	(BETA) DID Comm plugin interface for Agent This API may change without a BREAKING CHANGE notice.
IDIDCommMessage	(BETA) The DIDComm message structure. See https://identity.foundation/didcomm-messaging/spec/\#plaintext-message-structure This API may change without a BREAKING CHANGE notice.
IDIDCommMessageAttachment	(BETA) The DIDComm message structure for attachments. See https://identity.foundation/didcomm-messaging/spec/\#attachments This API may change without a BREAKING CHANGE notice.
IDIDCommMessageAttachmentData	(BETA) The DIDComm message structure for data in an attachment. See https://identity.foundation/didcomm-messaging/spec/\#attachments This API may change without a BREAKING CHANGE notice.
IDIDCommMessageMetaData	(BETA) Metadata resulting from unpacking a DIDComm v2 message. This API may change without a BREAKING CHANGE notice.
IDIDCommOptions	(BETA) Extra options when packing a DIDComm message. - This API may change without a BREAKING CHANGE notice.
IDIDCommTransport	(BETA) Common interface for transports that can be used in the DIDComm module. This API may change without a BREAKING CHANGE notice.
IDIDCommTransportResult	(BETA) Result interface for sending DIDComm messages through IDIDCommTransport.send(). This API may change without a BREAKING CHANGE notice.
IPackDIDCommMessageArgs	(BETA) The input to the IDIDComm.packDIDCommMessage() method. When packing is authcrypt or jws, a keyRef MUST be provided. This API may change without a BREAKING CHANGE notice.
IPackedDIDCommMessage	(BETA) The result of packing a DIDComm v2 message. The message is always serialized as string. This API may change without a BREAKING CHANGE notice.
ISendDIDCommMessageArgs	(BETA) The input to the IDIDComm.sendDIDCommMessage() method. The provided messageId will be used in the emitted event to allow event/message correlation. This API may change without a BREAKING CHANGE notice.
ISendDIDCommMessageResponse	(BETA) The response from the IDIDComm.sendDIDCommMessage() method. This API may change without a BREAKING CHANGE notice. return_message is only present if the return_route: 'all' was used in the packedMessage.
ISendMessageDIDCommAlpha1Args	(BETA)
IUnpackedDIDCommMessage	(BETA) The result of unpacking a DIDComm v2 message. This API may change without a BREAKING CHANGE notice.
Update	(BETA) This API may change without a BREAKING CHANGE notice. Represents the structure of a specific update on RECIPIENT_UPDATE
UpdateResult	(BETA) This API may change without a BREAKING CHANGE notice. Represents an update response on RECIPIENT_UPDATE_RESPONSE

Variables

Variable	Description
DELIVERY_REQUEST_MESSAGE_TYPE	(BETA) This API may change without a BREAKING CHANGE notice.
MEDIATE_DENY_MESSAGE_TYPE	(BETA) This API may change without a BREAKING CHANGE notice.
MEDIATE_GRANT_MESSAGE_TYPE	(BETA) This API may change without a BREAKING CHANGE notice.
MEDIATE_REQUEST_MESSAGE_TYPE	(BETA) This API may change without a BREAKING CHANGE notice.
schema
STATUS_REQUEST_MESSAGE_TYPE	(BETA) This API may change without a BREAKING CHANGE notice.

Type Aliases

Type Alias	Description
DIDCommMessagePacking	(BETA) The possible types of message packing. authcrypt, anoncrypt, anoncrypt+authcrypt, and anoncrypt+jws will produce DIDCommMessageMediaType.ENCRYPTED messages. jws will produce DIDCommMessageMediaType.SIGNED messages. none will produce DIDCommMessageMediaType.PLAIN messages. This API may change without a BREAKING CHANGE notice.
IUnpackDIDCommMessageArgs	(BETA) The input to the IDIDComm.unpackDIDCommMessage() method. This API may change without a BREAKING CHANGE notice.