feat: expose findAllByQuery method in modules and services (#1044)

Signed-off-by: Jim Ezesinachi <[email protected]>

packages/core/src/index.ts

@@ -17,7 +17,7 @@ export * from './storage/BaseRecord'
 export { InMemoryMessageRepository } from './storage/InMemoryMessageRepository'
 export { Repository } from './storage/Repository'
 export * from './storage/RepositoryEvents'
-export { StorageService } from './storage/StorageService'
+export { StorageService, Query } from './storage/StorageService'
 export { getDirFromFilePath } from './utils/path'
 export { InjectionSymbols } from './constants'
 export type { Wallet } from './wallet/Wallet'

packages/core/src/modules/action-menu/services/ActionMenuService.ts

@@ -1,5 +1,6 @@
 import type { InboundMessageContext } from '../../../agent/models/InboundMessageContext'
 import type { Logger } from '../../../logger'
+import type { Query } from '../../../storage/StorageService'
 import type { ActionMenuStateChangedEvent } from '../ActionMenuEvents'
 import type { ActionMenuProblemReportMessage } from '../messages'
 import type {
@@ -346,6 +347,10 @@ export class ActionMenuService {
     })
   }
 
+  public async findAllByQuery(options: Query<ActionMenuRecord>) {
+    return await this.actionMenuRepository.findByQuery(options)
+  }
+
   private emitStateChangedEvent(actionMenuRecord: ActionMenuRecord, previousState: ActionMenuState | null) {
     const clonedRecord = JsonTransformer.clone(actionMenuRecord)
 

packages/core/src/modules/basic-messages/BasicMessagesModule.ts

@@ -1,5 +1,6 @@
 import type { DependencyManager } from '../../plugins'
-import type { BasicMessageTags } from './repository/BasicMessageRecord'
+import type { Query } from '../../storage/StorageService'
+import type { BasicMessageRecord } from './repository/BasicMessageRecord'
 
 import { Dispatcher } from '../../agent/Dispatcher'
 import { MessageSender } from '../../agent/MessageSender'
@@ -59,7 +60,7 @@ export class BasicMessagesModule {
    * @param query The query
    * @returns array containing all matching records
    */
-  public async findAllByQuery(query: Partial<BasicMessageTags>) {
+  public async findAllByQuery(query: Query<BasicMessageRecord>) {
     return this.basicMessageService.findAllByQuery(query)
   }
 

packages/core/src/modules/basic-messages/services/BasicMessageService.ts

@@ -1,7 +1,7 @@
 import type { InboundMessageContext } from '../../../agent/models/InboundMessageContext'
+import type { Query } from '../../../storage/StorageService'
 import type { ConnectionRecord } from '../../connections/repository/ConnectionRecord'
 import type { BasicMessageStateChangedEvent } from '../BasicMessageEvents'
-import type { BasicMessageTags } from '../repository'
 
 import { EventEmitter } from '../../../agent/EventEmitter'
 import { injectable } from '../../../plugins'
@@ -61,7 +61,7 @@ export class BasicMessageService {
     })
   }
 
-  public async findAllByQuery(query: Partial<BasicMessageTags>) {
+  public async findAllByQuery(query: Query<BasicMessageRecord>) {
     return this.basicMessageRepository.findByQuery(query)
   }
 

packages/core/src/modules/connections/ConnectionsModule.ts

@@ -1,4 +1,5 @@
 import type { DependencyManager } from '../../plugins'
+import type { Query } from '../../storage/StorageService'
 import type { Key } from '../dids'
 import type { OutOfBandRecord } from '../oob/repository'
 import type { ConnectionType } from './models'
@@ -198,6 +199,15 @@ export class ConnectionsModule {
     return this.connectionService.getAll()
   }
 
+  /**
+   * Retrieve all connections records by specified query params
+   *
+   * @returns List containing all connection records matching specified query paramaters
+   */
+  public findAllByQuery(query: Query<ConnectionRecord>) {
+    return this.connectionService.findAllByQuery(query)
+  }
+
   /**
    * Allows for the addition of connectionType to the record.
    *  Either updates or creates an array of string conection types

packages/core/src/modules/connections/__tests__/ConnectionService.test.ts

@@ -897,5 +897,15 @@ describe('ConnectionService', () => {
 
       expect(result).toEqual(expect.arrayContaining(expected))
     })
+
+    it('findAllByQuery should return value from connectionRepository.findByQuery', async () => {
+      const expected = [getMockConnection(), getMockConnection()]
+
+      mockFunction(connectionRepository.findByQuery).mockReturnValue(Promise.resolve(expected))
+      const result = await connectionService.findAllByQuery({ state: DidExchangeState.InvitationReceived })
+      expect(connectionRepository.findByQuery).toBeCalledWith({ state: DidExchangeState.InvitationReceived })
+
+      expect(result).toEqual(expect.arrayContaining(expected))
+    })
   })
 })

packages/core/src/modules/connections/services/ConnectionService.ts

@@ -1,6 +1,7 @@
 import type { AgentMessage } from '../../../agent/AgentMessage'
 import type { InboundMessageContext } from '../../../agent/models/InboundMessageContext'
 import type { Logger } from '../../../logger'
+import type { Query } from '../../../storage/StorageService'
 import type { AckMessage } from '../../common'
 import type { OutOfBandDidCommService } from '../../oob/domain/OutOfBandDidCommService'
 import type { OutOfBandRecord } from '../../oob/repository'
@@ -592,6 +593,10 @@ export class ConnectionService {
     return this.connectionRepository.findByQuery({ invitationDid })
   }
 
+  public async findAllByQuery(query: Query<ConnectionRecord>): Promise<ConnectionRecord[]> {
+    return this.connectionRepository.findByQuery(query)
+  }
+
   public async createConnection(options: ConnectionRecordProps): Promise<ConnectionRecord> {
     const connectionRecord = new ConnectionRecord(options)
     await this.connectionRepository.save(connectionRecord)

packages/core/src/modules/credentials/CredentialsModule.ts

@@ -1,6 +1,7 @@
 import type { AgentMessage } from '../../agent/AgentMessage'
 import type { Logger } from '../../logger'
 import type { DependencyManager } from '../../plugins'
+import type { Query } from '../../storage/StorageService'
 import type { DeleteCredentialOptions } from './CredentialServiceOptions'
 import type {
   AcceptCredentialOptions,
@@ -73,6 +74,7 @@ export interface CredentialsModule<CFs extends CredentialFormat[], CSs extends C
 
   // Record Methods
   getAll(): Promise<CredentialExchangeRecord[]>
+  findAllByQuery(query: Query<CredentialExchangeRecord>): Promise<CredentialExchangeRecord[]>
   getById(credentialRecordId: string): Promise<CredentialExchangeRecord>
   findById(credentialRecordId: string): Promise<CredentialExchangeRecord | null>
   deleteById(credentialRecordId: string, options?: DeleteCredentialOptions): Promise<void>
@@ -573,6 +575,15 @@ export class CredentialsModule<
     return this.credentialRepository.getAll()
   }
 
+  /**
+   * Retrieve all credential records by specified query params
+   *
+   * @returns List containing all credential records matching specified query paramaters
+   */
+  public findAllByQuery(query: Query<CredentialExchangeRecord>) {
+    return this.credentialRepository.findByQuery(query)
+  }
+
   /**
    * Find a credential record by id
    *

packages/core/src/modules/credentials/protocol/v1/__tests__/V1CredentialServiceCred.test.ts

@@ -811,6 +811,16 @@ describe('V1CredentialService', () => {
 
       expect(result).toEqual(expect.arrayContaining(expected))
     })
+
+    it('findAllByQuery should return value from credentialRepository.findByQuery', async () => {
+      const expected = [mockCredentialRecord(), mockCredentialRecord()]
+
+      mockFunction(credentialRepository.findByQuery).mockReturnValue(Promise.resolve(expected))
+      const result = await credentialService.findAllByQuery({ state: CredentialState.OfferSent })
+      expect(credentialRepository.findByQuery).toBeCalledWith({ state: CredentialState.OfferSent })
+
+      expect(result).toEqual(expect.arrayContaining(expected))
+    })
   })
 
   describe('deleteCredential', () => {

packages/core/src/modules/credentials/protocol/v2/__tests__/V2CredentialServiceCred.test.ts

@@ -755,6 +755,16 @@ describe('CredentialService', () => {
 
       expect(result).toEqual(expect.arrayContaining(expected))
     })
+
+    it('findAllByQuery should return value from credentialRepository.findByQuery', async () => {
+      const expected = [mockCredentialRecord(), mockCredentialRecord()]
+
+      mockFunction(credentialRepository.findByQuery).mockReturnValue(Promise.resolve(expected))
+      const result = await credentialService.findAllByQuery({ state: CredentialState.OfferSent })
+      expect(credentialRepository.findByQuery).toBeCalledWith({ state: CredentialState.OfferSent })
+
+      expect(result).toEqual(expect.arrayContaining(expected))
+    })
   })
 
   describe('deleteCredential', () => {

packages/core/src/modules/credentials/services/CredentialService.ts

@@ -5,6 +5,7 @@ import type { EventEmitter } from '../../../agent/EventEmitter'
 import type { InboundMessageContext } from '../../../agent/models/InboundMessageContext'
 import type { Logger } from '../../../logger'
 import type { DidCommMessageRepository } from '../../../storage'
+import type { Query } from '../../../storage/StorageService'
 import type { ProblemReportMessage } from '../../problem-reports'
 import type { CredentialStateChangedEvent } from '../CredentialEvents'
 import type {
@@ -185,6 +186,10 @@ export abstract class CredentialService<CFs extends CredentialFormat[] = Credent
     return this.credentialRepository.getAll()
   }
 
+  public async findAllByQuery(query: Query<CredentialExchangeRecord>): Promise<CredentialExchangeRecord[]> {
+    return this.credentialRepository.findByQuery(query)
+  }
+
   /**
    * Find a credential record by id
    *

packages/core/src/modules/generic-records/GenericRecordsModule.ts

@@ -1,6 +1,7 @@
 import type { Logger } from '../../logger'
 import type { DependencyManager } from '../../plugins'
-import type { GenericRecord, GenericRecordTags, SaveGenericRecordOption } from './repository/GenericRecord'
+import type { Query } from '../../storage/StorageService'
+import type { GenericRecord, SaveGenericRecordOption } from './repository/GenericRecord'
 
 import { AgentConfig } from '../../agent/AgentConfig'
 import { injectable, module } from '../../plugins'
@@ -74,7 +75,7 @@ export class GenericRecordsModule {
     return this.genericRecordsService.findById(id)
   }
 
-  public async findAllByQuery(query: Partial<GenericRecordTags>): Promise<GenericRecord[]> {
+  public async findAllByQuery(query: Query<GenericRecord>): Promise<GenericRecord[]> {
     return this.genericRecordsService.findAllByQuery(query)
   }
 

packages/core/src/modules/generic-records/service/GenericRecordService.ts

@@ -1,4 +1,5 @@
-import type { GenericRecordTags, SaveGenericRecordOption } from '../repository/GenericRecord'
+import type { Query } from '../../../storage/StorageService'
+import type { SaveGenericRecordOption } from '../repository/GenericRecord'
 
 import { AriesFrameworkError } from '../../../error'
 import { injectable } from '../../../plugins'
@@ -50,7 +51,7 @@ export class GenericRecordService {
     }
   }
 
-  public async findAllByQuery(query: Partial<GenericRecordTags>) {
+  public async findAllByQuery(query: Query<GenericRecord>) {
     return this.genericRecordsRepository.findByQuery(query)
   }
 

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

@@ -4,6 +4,7 @@ import type { Attachment } from '../../decorators/attachment/Attachment'
 import type { Logger } from '../../logger'
 import type { ConnectionRecord, Routing, ConnectionInvitationMessage } from '../../modules/connections'
 import type { DependencyManager } from '../../plugins'
+import type { Query } from '../../storage/StorageService'
 import type { PlaintextMessage } from '../../types'
 import type { Key } from '../dids'
 import type { HandshakeReusedEvent } from './domain/OutOfBandEvents'
@@ -533,6 +534,15 @@ export class OutOfBandModule {
     return this.outOfBandService.getAll()
   }
 
+  /**
+   * Retrieve all out of bands records by specified query param
+   *
+   * @returns List containing all out of band records matching specified query params
+   */
+  public findAllByQuery(query: Query<OutOfBandRecord>) {
+    return this.outOfBandService.findAllByQuery(query)
+  }
+
   /**
    * Retrieve a out of band record by id
    *

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

@@ -1,4 +1,5 @@
 import type { InboundMessageContext } from '../../agent/models/InboundMessageContext'
+import type { Query } from '../../storage/StorageService'
 import type { ConnectionRecord } from '../connections'
 import type { Key } from '../dids/domain/Key'
 import type { HandshakeReusedEvent, OutOfBandStateChangedEvent } from './domain/OutOfBandEvents'
@@ -167,6 +168,10 @@ export class OutOfBandService {
     return this.outOfBandRepository.getAll()
   }
 
+  public async findAllByQuery(query: Query<OutOfBandRecord>) {
+    return this.outOfBandRepository.findByQuery(query)
+  }
+
   public async deleteById(outOfBandId: string) {
     const outOfBandRecord = await this.getById(outOfBandId)
     return this.outOfBandRepository.delete(outOfBandRecord)

packages/core/src/modules/oob/__tests__/OutOfBandService.test.ts

@@ -495,5 +495,15 @@ describe('OutOfBandService', () => {
 
       expect(result).toEqual(expect.arrayContaining(expected))
     })
+
+    it('findAllByQuery should return value from outOfBandRepository.findByQuery', async () => {
+      const expected = [getMockOutOfBand(), getMockOutOfBand()]
+
+      mockFunction(outOfBandRepository.findByQuery).mockReturnValue(Promise.resolve(expected))
+      const result = await outOfBandService.findAllByQuery({ state: OutOfBandState.Initial })
+      expect(outOfBandRepository.findByQuery).toBeCalledWith({ state: OutOfBandState.Initial })
+
+      expect(result).toEqual(expect.arrayContaining(expected))
+    })
   })
 })

packages/core/src/modules/proofs/ProofsModule.ts

@@ -1,4 +1,5 @@
 import type { DependencyManager } from '../../plugins'
+import type { Query } from '../../storage/StorageService'
 import type { AutoAcceptProof } from './ProofAutoAcceptType'
 import type { PresentationPreview, RequestPresentationMessage } from './messages'
 import type { RequestedCredentials, RetrievedCredentials } from './models'
@@ -414,6 +415,15 @@ export class ProofsModule {
     return this.proofService.getAll()
   }
 
+  /**
+   * Retrieve all proof records by specified query params
+   *
+   * @returns List containing all proof records matching specified params
+   */
+  public findAllByQuery(query: Query<ProofRecord>): Promise<ProofRecord[]> {
+    return this.proofService.findAllByQuery(query)
+  }
+
   /**
    * Retrieve a proof record by id
    *

packages/core/src/modules/proofs/services/ProofService.ts

@@ -1,6 +1,7 @@
 import type { AgentMessage } from '../../../agent/AgentMessage'
 import type { InboundMessageContext } from '../../../agent/models/InboundMessageContext'
 import type { Logger } from '../../../logger'
+import type { Query } from '../../../storage/StorageService'
 import type { ConnectionRecord } from '../../connections'
 import type { AutoAcceptProof } from '../ProofAutoAcceptType'
 import type { ProofStateChangedEvent } from '../ProofEvents'
@@ -938,6 +939,15 @@ export class ProofService {
     return this.proofRepository.getAll()
   }
 
+  /**
+   * Retrieve all proof records
+   *
+   * @returns List containing all proof records
+   */
+  public async findAllByQuery(query: Query<ProofRecord>): Promise<ProofRecord[]> {
+    return this.proofRepository.findByQuery(query)
+  }
+
   /**
    * Retrieve a proof record by id
    *

packages/core/src/modules/question-answer/QuestionAnswerModule.ts

@@ -1,4 +1,6 @@
 import type { DependencyManager } from '../../plugins'
+import type { Query } from '../../storage/StorageService'
+import type { QuestionAnswerRecord } from './repository'
 
 import { Dispatcher } from '../../agent/Dispatcher'
 import { MessageSender } from '../../agent/MessageSender'
@@ -92,6 +94,15 @@ export class QuestionAnswerModule {
     return this.questionAnswerService.getAll()
   }
 
+  /**
+   * Get all QuestionAnswer records by specified query params
+   *
+   * @returns list containing all QuestionAnswer records matching specified query params
+   */
+  public findAllByQuery(query: Query<QuestionAnswerRecord>) {
+    return this.questionAnswerService.findAllByQuery(query)
+  }
+
   /**
    * Retrieve a question answer record by id
    *

packages/core/src/modules/question-answer/services/QuestionAnswerService.ts

@@ -1,8 +1,8 @@
 import type { InboundMessageContext } from '../../../agent/models/InboundMessageContext'
 import type { Logger } from '../../../logger'
+import type { Query } from '../../../storage/StorageService'
 import type { QuestionAnswerStateChangedEvent } from '../QuestionAnswerEvents'
 import type { ValidResponse } from '../models'
-import type { QuestionAnswerTags } from '../repository'
 
 import { AgentConfig } from '../../../agent/AgentConfig'
 import { EventEmitter } from '../../../agent/EventEmitter'
@@ -269,7 +269,7 @@ export class QuestionAnswerService {
     return this.questionAnswerRepository.getAll()
   }
 
-  public async findAllByQuery(query: Partial<QuestionAnswerTags>) {
+  public async findAllByQuery(query: Query<QuestionAnswerRecord>) {
     return this.questionAnswerRepository.findByQuery(query)
   }
 }