refactor(oob)!: merge oob invitation parsing (#1134)

openwallet-foundation · Dec 1, 2022 · 157a357 · 157a357
1 parent f294129
commit 157a357
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 18 deletions.
diff --git a/packages/core/src/agent/Agent.ts b/packages/core/src/agent/Agent.ts
@@ -211,7 +211,7 @@ export class Agent<AgentModules extends AgentModulesInput = ModulesMap> extends
   }
 
   protected async getMediationConnection(mediatorInvitationUrl: string) {
-    const outOfBandInvitation = this.oob.parseInvitation(mediatorInvitationUrl)
+    const outOfBandInvitation = await this.oob.parseInvitation(mediatorInvitationUrl)
     const outOfBandRecord = await this.oob.findByInvitationId(outOfBandInvitation.id)
     const [connection] = outOfBandRecord ? await this.connections.findAllByOutOfBandId(outOfBandRecord.id) : []
 

diff --git a/packages/core/src/modules/oob/OutOfBandApi.ts b/packages/core/src/modules/oob/OutOfBandApi.ts
@@ -23,7 +23,7 @@ import { inject, injectable } from '../../plugins'
 import { DidCommMessageRepository, DidCommMessageRole } from '../../storage'
 import { JsonEncoder, JsonTransformer } from '../../utils'
 import { parseMessageType, supportsIncomingMessageType } from '../../utils/messageType'
-import { parseInvitationUrl, parseInvitationShortUrl } from '../../utils/parseInvitation'
+import { parseInvitationShortUrl } from '../../utils/parseInvitation'
 import { ConnectionsApi, DidExchangeState, HandshakeProtocol } from '../connections'
 import { DidCommDocumentService } from '../didcomm'
 import { DidKey } from '../dids'
@@ -281,32 +281,22 @@ export class OutOfBandApi {
    * @returns out-of-band record and connection record if one has been created
    */
   public async receiveInvitationFromUrl(invitationUrl: string, config: ReceiveOutOfBandInvitationConfig = {}) {
-    const message = await this.parseInvitationShortUrl(invitationUrl)
+    const message = await this.parseInvitation(invitationUrl)
 
     return this.receiveInvitation(message, config)
   }
 
   /**
    * Parses URL containing encoded invitation and returns invitation message.
    *
-   * @param invitationUrl URL containing encoded invitation
-   *
-   * @returns OutOfBandInvitation
-   */
-  public parseInvitation(invitationUrl: string): OutOfBandInvitation {
-    return parseInvitationUrl(invitationUrl)
-  }
-
-  /**
-   * Parses URL containing encoded invitation and returns invitation message. Compatible with
-   * parsing shortened URLs
+   * Will fetch the url if the url does not contain a base64 encoded invitation.
    *
    * @param invitationUrl URL containing encoded invitation
    *
    * @returns OutOfBandInvitation
    */
-  public async parseInvitationShortUrl(invitation: string): Promise<OutOfBandInvitation> {
-    return await parseInvitationShortUrl(invitation, this.agentContext.config.agentDependencies)
+  public async parseInvitation(invitationUrl: string): Promise<OutOfBandInvitation> {
+    return parseInvitationShortUrl(invitationUrl, this.agentContext.config.agentDependencies)
   }
 
   /**

diff --git a/packages/core/src/utils/parseInvitation.ts b/packages/core/src/utils/parseInvitation.ts
@@ -53,7 +53,7 @@ export const parseInvitationUrl = (invitationUrl: string): OutOfBandInvitation =
   )
 }
 
-//This currently does not follow the RFC because of issues with fetch, currently uses a janky work around
+// This currently does not follow the RFC because of issues with fetch, currently uses a janky work around
 export const oobInvitationFromShortUrl = async (response: Response): Promise<OutOfBandInvitation> => {
   if (response) {
     if (response.headers.get('Content-Type')?.startsWith('application/json') && response.ok) {
@@ -90,7 +90,7 @@ export const oobInvitationFromShortUrl = async (response: Response): Promise<Out
  *
  * @param invitationUrl URL containing encoded invitation
  *
- * @param dependencies Agent dependicies containing fetch
+ * @param dependencies Agent dependencies containing fetch
  *
  * @returns OutOfBandInvitation
  */