refactor(oob)!: make label optional (#1680)

Signed-off-by: Timo Glastra <timo@animo.id> Co-authored-by: Ariel Gentile <gentilester@gmail.com>
openwallet-foundation · Jan 29, 2024 · c66b37e · c66b37e
1 parent 3d1903a
commit c66b37e
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 8 deletions.
diff --git a/packages/core/src/modules/oob/OutOfBandService.ts b/packages/core/src/modules/oob/OutOfBandService.ts
@@ -67,7 +67,6 @@ export class OutOfBandService {
     // initiating the flow
     const outOfBandInvitation = new OutOfBandInvitation({
       id: did,
-      label: '',
       services: [did],
       handshakeProtocols,
     })

diff --git a/packages/core/src/modules/oob/helpers.ts b/packages/core/src/modules/oob/helpers.ts
@@ -45,15 +45,17 @@ export function convertToOldInvitation(newInvitation: OutOfBandInvitation) {
   if (typeof service === 'string') {
     options = {
       id: newInvitation.id,
-      label: newInvitation.label,
+      // label is optional
+      label: newInvitation.label ?? '',
       did: service,
       imageUrl: newInvitation.imageUrl,
       appendedAttachments: newInvitation.appendedAttachments,
     }
   } else {
     options = {
       id: newInvitation.id,
-      label: newInvitation.label,
+      // label is optional
+      label: newInvitation.label ?? '',
       recipientKeys: service.recipientKeys.map(didKeyToVerkey),
       routingKeys: service.routingKeys?.map(didKeyToVerkey),
       serviceEndpoint: service.serviceEndpoint,

diff --git a/packages/core/src/modules/oob/messages/OutOfBandInvitation.ts b/packages/core/src/modules/oob/messages/OutOfBandInvitation.ts
@@ -17,7 +17,7 @@ import { OutOfBandDidCommService } from '../domain/OutOfBandDidCommService'
 
 export interface OutOfBandInvitationOptions {
   id?: string
-  label: string
+  label?: string
   goalCode?: string
   goal?: string
   accept?: string[]
@@ -124,7 +124,7 @@ export class OutOfBandInvitation extends AgentMessage {
   public readonly type = OutOfBandInvitation.type.messageTypeUri
   public static readonly type = parseMessageType('https://didcomm.org/out-of-band/1.1/invitation')
 
-  public readonly label!: string
+  public readonly label?: string
 
   @Expose({ name: 'goal_code' })
   public readonly goalCode?: string

diff --git a/packages/core/src/utils/parseInvitation.ts b/packages/core/src/utils/parseInvitation.ts
@@ -140,9 +140,6 @@ export const parseInvitationShortUrl = async (
 
     // transform into out of band invitation
     const invitation = new OutOfBandInvitation({
-      // The label is currently required by the OutOfBandInvitation class, but not according to the specification.
-      // FIXME: In 0.5.0 we will make this optional: https://github.com/hyperledger/aries-framework-javascript/issues/1524
-      label: '',
       services: [OutOfBandDidCommService.fromResolvedDidCommService(agentMessage.service.resolvedDidCommService)],
     })