feat(oob): allow to append attachments to invitations

[genaris]

Adds an optional appendedAttachments field for OOB invitations (and legacy Connection Invitation messages) that allows to append attachments as per Aries RFC 0017.

Signed-off-by: Ariel Gentile [email protected]

[codecov-commenter]

Codecov Report

Merging #926 (7c92b88) into main (7eae144) will increase coverage by 0.02%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #926      +/-   ##
==========================================
+ Coverage   87.70%   87.72%   +0.02%     
==========================================
  Files         475      475              
  Lines       11339    11343       +4     
  Branches     1874     1875       +1     
==========================================
+ Hits         9945     9951       +6     
+ Misses       1327     1325       -2     
  Partials       67       67              

Impacted Files	Coverage Δ
...e/src/decorators/attachment/AttachmentExtension.ts	64.28% <ø> (+14.28%)	⬆️
packages/core/src/modules/oob/helpers.ts	100.00% <ø> (ø)
packages/core/src/index.ts	100.00% <100.00%> (ø)
...onnections/messages/ConnectionInvitationMessage.ts	98.11% <100.00%> (+0.03%)	⬆️
packages/core/src/modules/oob/OutOfBandModule.ts	87.50% <100.00%> (+0.04%)	⬆️
...re/src/modules/oob/messages/OutOfBandInvitation.ts	96.25% <100.00%> (+0.04%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7eae144...7c92b88. Read the comment docs.

[TimoGlastra]

Do you think there's a lot of benefit in doing:

new ConnectionInvitationMessage({
  appendedAttachments: [attachment]
})

over

const invitation = new ConnectionInvitationMessage({
  appendedAttachments: []
})
invitation.appendedAttachments.push(attachment)

Or is there something else this will unlock?

[TimoGlastra]

Can you update the branch?

[genaris]

Do you think there's a lot of benefit in doing:

new ConnectionInvitationMessage({
  appendedAttachments: [attachment]
})

over

const invitation = new ConnectionInvitationMessage({
  appendedAttachments: []
})
invitation.appendedAttachments.push(attachment)

Or is there something else this will unlock?

You're right, not so much added value 😄. But in case attachment is undefined, invitation.appendedAttachments will result an empty array instead of undefined, and if I'm not wrong it will be encoded when transforming the invitation to JSON, isn't it?

But besides that, it's true that we can handle in OutOfBandModule like it's currently being done with request messages (i.e. not adding any new field to invitation constructor options, and calling invitation.addAppendedAttachment once the object is constructed). However, we use these attachments for invitations quite a lot and believe that it's a good approach to add some arbitrary information without leaving the standards (as seen with the controversial imageUrl 😛), so making it explicit in constructor options could be convenient.

[TimoGlastra]

But besides that, it's true that we can handle in OutOfBandModule like it's currently being done with request messages (i.e. not adding any new field to invitation constructor options, and calling invitation.addAppendedAttachment once the object is constructed). However, we use these attachments for invitations quite a lot and believe that it's a good approach to add some arbitrary information without leaving the standards (as seen with the controversial imageUrl 😛), so making it explicit in constructor options could be convenient.

Yeah no problem in adding it, just curious :)