Add optional peer dependencies to new shared components modules?

[TimoGlastra]

• indy-sdk or indy-sdk-react-native
• @hyperledger/indy-vdr-nodejs or @hyperledger/indy-vdr-react-native
• @hyperledger/anoncreds-nodejs or @hyperledger/anoncreds-react-native
• @hyperledger/aries-askar-nodejs or @hyperledger/aries-askar-react-native

Either add them as optional peer deps to the package.json or add documentation on that you need to install them

[Vickysomtee]

Working on this!

[TimoGlastra]

1. Don't add as peer dependency and write documentation that the user needs to install this package for their specific platform.

• e.g. if using indy-vdr, it would mean you either have to install @hyperledger/indy-vdr-nodejs or @hyperledger/indy-vdr-react-native

2. Add both the react native and nodejs packages to the package.json of the respective package, and then based on the platfrom you're currently in import either the nodejs, or the react native.

• e.g. if using @aries-framework/indy-vdr, the package.json will contain depenecy on @hyperledger/indy-vdr-nodejs and @hyperledger/indy-vdr-react-native

    if (isNodeJs()) {
      // eslint-disable-next-line import/no-extraneous-dependencies
      require('@hyperledger/indy-vdr-nodejs')
   } else if (isReactNative()) {
      require('@hyperledger/indy-vdr-react-native')
   } else {
      // throw error unsupported platform
   }

3. Require them to pass the native implementation explicitly to the module (and they will have to install the package themselves for the specific platform)

import { indyVdr } from '@hyperledger/indy-vdr-nodejs' 

const agent = new Agent({
  config: {},
  dependencies: agentDependencies,
  modules: {
    indyVdr: new IndyVdrModule({
      indyVdr,
   })
  }
})

[TimoGlastra]

For approach 3.:

Example with indy-sdk:

• https://github.com/hyperledger/aries-framework-javascript/blob/main/packages/indy-sdk/tests/setupIndySdkModule.ts
• https://github.com/hyperledger/aries-framework-javascript/blob/main/packages/indy-sdk/src/IndySdkModuleConfig.ts#L32

For e.g. indy-vdr you can use the IndyVdr type from the @hyperledger/indy-vdr-shared package as the type in the IndyVdrModuleConfig class (see indy-sdk example above)

[Vickysomtee]

@TimoGlastra can you share more context on why a new Agent is created for approach 3?