fix(credentials): typing if no modules provided (#1188)

Fixes #1187

Signed-off-by: Timo Glastra <[email protected]>

packages/bbs-signatures/tests/v2.ldproof.credentials.propose-offerBbs.test.ts

@@ -1,7 +1,7 @@
-import type { Agent } from '../../core/src/agent/Agent'
 import type { ConnectionRecord } from '../../core/src/modules/connections'
 import type { JsonCredential, JsonLdCredentialDetailFormat } from '../../core/src/modules/credentials/formats/jsonld'
 import type { Wallet } from '../../core/src/wallet'
+import type { CredentialTestsAgent } from '../../core/tests/helpers'
 
 import { InjectionSymbols } from '../../core/src/constants'
 import { KeyType } from '../../core/src/crypto'
@@ -18,8 +18,8 @@ import testLogger from '../../core/tests/logger'
 
 import { describeSkipNode17And18 } from './util'
 
-let faberAgent: Agent
-let aliceAgent: Agent
+let faberAgent: CredentialTestsAgent
+let aliceAgent: CredentialTestsAgent
 let aliceConnection: ConnectionRecord
 let aliceCredentialRecord: CredentialExchangeRecord
 let faberCredentialRecord: CredentialExchangeRecord

packages/core/src/agent/AgentModules.ts

@@ -1,4 +1,5 @@
 import type { Module, DependencyManager, ApiModule } from '../plugins'
+import type { IsAny } from '../types'
 import type { Constructor } from '../utils/mixins'
 import type { AgentConfig } from './AgentConfig'
 
@@ -101,7 +102,9 @@ export type AgentApi<Modules extends ModulesMap> = {
 export type CustomOrDefaultApi<
   CustomModuleType,
   DefaultModuleType extends ApiModule
-> = CustomModuleType extends ApiModule
+> = IsAny<CustomModuleType> extends true
+  ? InstanceType<DefaultModuleType['api']>
+  : CustomModuleType extends ApiModule
   ? InstanceType<CustomModuleType['api']>
   : CustomModuleType extends Module
   ? never

packages/core/src/modules/credentials/protocol/v2/__tests__/v2.ldproof.connectionless-credentials.test.ts

@@ -58,8 +58,8 @@ let wallet
 let signCredentialOptions: JsonLdCredentialDetailFormat
 
 describe('credentials', () => {
-  let faberAgent: Agent
-  let aliceAgent: Agent
+  let faberAgent: Agent<typeof faberAgentOptions['modules']>
+  let aliceAgent: Agent<typeof aliceAgentOptions['modules']>
   let faberReplay: ReplaySubject<CredentialStateChangedEvent>
   let aliceReplay: ReplaySubject<CredentialStateChangedEvent>
   const seed = 'testseed000000000000000000000001'

packages/core/src/modules/credentials/protocol/v2/__tests__/v2.ldproof.credentials-auto-accept.test.ts

@@ -1,4 +1,4 @@
-import type { Agent } from '../../../../../agent/Agent'
+import type { CredentialTestsAgent } from '../../../../../../tests/helpers'
 import type { Wallet } from '../../../../../wallet'
 import type { ConnectionRecord } from '../../../../connections'
 import type { JsonCredential, JsonLdCredentialDetailFormat } from '../../../formats/jsonld/JsonLdCredentialFormat'
@@ -26,8 +26,8 @@ const TEST_LD_DOCUMENT: JsonCredential = {
 }
 
 describe('credentials', () => {
-  let faberAgent: Agent
-  let aliceAgent: Agent
+  let faberAgent: CredentialTestsAgent
+  let aliceAgent: CredentialTestsAgent
   let faberConnection: ConnectionRecord
   let aliceConnection: ConnectionRecord
   let aliceCredentialRecord: CredentialExchangeRecord

packages/core/src/types.ts

@@ -193,3 +193,8 @@ export type FlatArray<Arr> = Arr extends ReadonlyArray<infer InnerArr> ? FlatArr
  * Get the awaited (resolved promise) type of Promise type.
  */
 export type Awaited<T> = T extends Promise<infer U> ? U : never
+
+/**
+ * Type util that returns `true` or `false` based on whether the input type `T` is of type `any`
+ */
+export type IsAny<T> = unknown extends T ? ([keyof T] extends [never] ? false : true) : false

packages/core/tests/helpers.ts

@@ -2,6 +2,7 @@
 import type { SubjectMessage } from '../../../tests/transport/SubjectInboundTransport'
 import type {
   AcceptCredentialOfferOptions,
+  AgentDependencies,
   BasicMessage,
   BasicMessageStateChangedEvent,
   ConnectionRecordProps,
@@ -13,10 +14,11 @@ import type {
   SchemaTemplate,
   Wallet,
 } from '../src'
-import type { AgentModulesInput } from '../src/agent/AgentModules'
+import type { AgentModulesInput, EmptyModuleMap } from '../src/agent/AgentModules'
 import type { IndyOfferCredentialFormat } from '../src/modules/credentials/formats/indy/IndyCredentialFormat'
 import type { ProofAttributeInfo, ProofPredicateInfo } from '../src/modules/proofs/formats/indy/models'
 import type { AutoAcceptProof } from '../src/modules/proofs/models/ProofAutoAcceptType'
+import type { Awaited } from '../src/types'
 import type { CredDef, Schema } from 'indy-sdk'
 import type { Observable } from 'rxjs'
 
@@ -83,11 +85,11 @@ const taaVersion = (process.env.TEST_AGENT_TAA_VERSION ?? '1') as `${number}.${n
 const taaAcceptanceMechanism = process.env.TEST_AGENT_TAA_ACCEPTANCE_MECHANISM ?? 'accept'
 export { agentDependencies }
 
-export function getAgentOptions<AgentModules extends AgentModulesInput>(
+export function getAgentOptions<AgentModules extends AgentModulesInput | EmptyModuleMap>(
   name: string,
   extraConfig: Partial<InitConfig> = {},
   modules?: AgentModules
-) {
+): { config: InitConfig; modules: AgentModules; dependencies: AgentDependencies } {
   const config: InitConfig = {
     label: `Agent: ${name}`,
     walletConfig: {
@@ -111,7 +113,8 @@ export function getAgentOptions<AgentModules extends AgentModulesInput>(
     logger: new TestLogger(LogLevel.off, name),
     ...extraConfig,
   }
-  return { config, modules, dependencies: agentDependencies } as const
+
+  return { config, modules: (modules ?? {}) as AgentModules, dependencies: agentDependencies } as const
 }
 
 export function getPostgresAgentOptions(name: string, extraConfig: Partial<InitConfig> = {}) {
@@ -675,6 +678,8 @@ export function mockProperty<T extends {}, K extends keyof T>(object: T, propert
   Object.defineProperty(object, property, { get: () => value })
 }
 
+// Helper type to get the type of the agents (with the custom modules) for the credential tests
+export type CredentialTestsAgent = Awaited<ReturnType<typeof setupCredentialTests>>['aliceAgent']
 export async function setupCredentialTests(
   faberName: string,
   aliceName: string,

packages/tenants/src/TenantsApi.ts

@@ -1,13 +1,13 @@
 import type { CreateTenantOptions, GetTenantAgentOptions, WithTenantAgentCallback } from './TenantsApiOptions'
-import type { EmptyModuleMap, ModulesMap } from '@aries-framework/core'
+import type { DefaultAgentModules, ModulesMap } from '@aries-framework/core'
 
 import { AgentContext, inject, InjectionSymbols, AgentContextProvider, injectable, Logger } from '@aries-framework/core'
 
 import { TenantAgent } from './TenantAgent'
 import { TenantRecordService } from './services'
 
 @injectable()
-export class TenantsApi<AgentModules extends ModulesMap = EmptyModuleMap> {
+export class TenantsApi<AgentModules extends ModulesMap = DefaultAgentModules> {
   private agentContext: AgentContext
   private tenantRecordService: TenantRecordService
   private agentContextProvider: AgentContextProvider