fix(oob): expose parseInvitation publicly (#834)

Signed-off-by: Berend Sliedrecht <[email protected]>

Co-authored-by: Timo Glastra <[email protected]>

packages/core/src/index.ts

@@ -23,6 +23,7 @@ export type { Wallet } from './wallet/Wallet'
 export type { TransportSession } from './agent/TransportService'
 export { TransportService } from './agent/TransportService'
 
+import { parseInvitationUrl } from './utils/parseInvitation'
 import { uuid } from './utils/uuid'
 
 export * from './transport'
@@ -44,6 +45,7 @@ export * from './agent/Events'
 
 const utils = {
   uuid,
+  parseInvitationUrl,
 }
 
 export { utils }

packages/core/src/modules/oob/OutOfBandModule.ts

@@ -1,12 +1,11 @@
 import type { AgentMessage } from '../../agent/AgentMessage'
 import type { AgentMessageReceivedEvent } from '../../agent/Events'
 import type { Logger } from '../../logger'
-import type { ConnectionRecord, Routing } from '../../modules/connections'
+import type { ConnectionRecord, Routing, ConnectionInvitationMessage } from '../../modules/connections'
 import type { PlaintextMessage } from '../../types'
 import type { Key } from '../dids'
 import type { HandshakeReusedEvent } from './domain/OutOfBandEvents'
 
-import { parseUrl } from 'query-string'
 import { catchError, EmptyError, first, firstValueFrom, map, of, timeout } from 'rxjs'
 import { Lifecycle, scoped } from 'tsyringe'
 
@@ -18,15 +17,11 @@ import { MessageSender } from '../../agent/MessageSender'
 import { createOutboundMessage } from '../../agent/helpers'
 import { ServiceDecorator } from '../../decorators/service/ServiceDecorator'
 import { AriesFrameworkError } from '../../error'
-import {
-  DidExchangeState,
-  HandshakeProtocol,
-  ConnectionInvitationMessage,
-  ConnectionsModule,
-} from '../../modules/connections'
+import { DidExchangeState, HandshakeProtocol, ConnectionsModule } from '../../modules/connections'
 import { DidCommMessageRepository, DidCommMessageRole } from '../../storage'
 import { JsonEncoder, JsonTransformer } from '../../utils'
 import { parseMessageType, supportsIncomingMessageType } from '../../utils/messageType'
+import { parseInvitationUrl } from '../../utils/parseInvitation'
 import { DidKey } from '../dids'
 import { didKeyToVerkey } from '../dids/helpers'
 import { outOfBandServiceToNumAlgo2Did } from '../dids/methods/peer/peerDidNumAlgo2'
@@ -280,18 +275,8 @@ export class OutOfBandModule {
    *
    * @returns OutOfBandInvitation
    */
-  public async parseInvitation(invitationUrl: string) {
-    const parsedUrl = parseUrl(invitationUrl).query
-    if (parsedUrl['oob']) {
-      const outOfBandInvitation = await OutOfBandInvitation.fromUrl(invitationUrl)
-      return outOfBandInvitation
-    } else if (parsedUrl['c_i'] || parsedUrl['d_m']) {
-      const invitation = await ConnectionInvitationMessage.fromUrl(invitationUrl)
-      return convertToNewInvitation(invitation)
-    }
-    throw new AriesFrameworkError(
-      'InvitationUrl is invalid. It needs to contain one, and only one, of the following parameters: `oob`, `c_i` or `d_m`.'
-    )
+  public async parseInvitation(invitationUrl: string): Promise<OutOfBandInvitation> {
+    return await parseInvitationUrl(invitationUrl)
   }
 
   /**

packages/core/src/utils/parseInvitation.ts

@@ -0,0 +1,27 @@
+import { parseUrl } from 'query-string'
+
+import { AriesFrameworkError } from '../error'
+import { ConnectionInvitationMessage } from '../modules/connections'
+import { convertToNewInvitation } from '../modules/oob/helpers'
+import { OutOfBandInvitation } from '../modules/oob/messages'
+
+/**
+ * Parses URL containing encoded invitation and returns invitation message.
+ *
+ * @param invitationUrl URL containing encoded invitation
+ *
+ * @returns OutOfBandInvitation
+ */
+export const parseInvitationUrl = async (invitationUrl: string): Promise<OutOfBandInvitation> => {
+  const parsedUrl = parseUrl(invitationUrl).query
+  if (parsedUrl['oob']) {
+    const outOfBandInvitation = await OutOfBandInvitation.fromUrl(invitationUrl)
+    return outOfBandInvitation
+  } else if (parsedUrl['c_i'] || parsedUrl['d_m']) {
+    const invitation = await ConnectionInvitationMessage.fromUrl(invitationUrl)
+    return convertToNewInvitation(invitation)
+  }
+  throw new AriesFrameworkError(
+    'InvitationUrl is invalid. It needs to contain one, and only one, of the following parameters: `oob`, `c_i` or `d_m`.'
+  )
+}