FDC3 2.0 questions

[kriswest]

Please feel free to post FDC3 2.0 implementation, usage or capability questions in this discussion!

[novavi]

In the @finos/fdc3@2.0.0-beta.4 npm package, the DesktopAgent interface (src/api/DesktopAgent.ts) lists 23 methods in total, consisting of 17 current methods and 6 deprecated methods. As expected, those current and deprecated methods match the ones listed in the FDC3 2.0 docs under DesktopAgent (https://fdc3.finos.org/docs/api/ref/DesktopAgent).

Looking at the function signatures in src/api/Methods.ts, I notice they use union types in the args in order to specify 4 of the functions, in order to handle both current and deprecated signatures (i.e. open, raiseIntent, raiseIntentForContext, addContextListener). With this in mind, I was expecting to see 19 functions specified in src/api/Methods.ts i.e. the 23 total minus 4 which are represented only once (rather than twice) using union types in the args.

However, only 17 functions are actually specified in src/api/Methods.ts, rather than the 19 I was expecting. This is because createPrivateChannel and findInstances have been omitted.

@kriswest Was this intentional?

[kriswest]

Thanks for your write-up on this @novavi. I believe you are correct in that we might be able to improve the developer experience of using Methods.ts with the approach you outline (add the additional signatures without a body and eliminate the union types - particularly as FDC3 2.0 implementations are not required to support the deprecated signatures).

Would you be up for submitting an issue (and/or PR) to have this resolved?

[novavi]

Hi @kriswest - no problem. Yes, I'm happy to submit an issue. And also happy to have a stab at a PR - though for the record I've spent my entire career in closed-source caves :) so I might need a little guidance around policies and procedures, if you're happy to provide.

[kriswest]

Hi @novavi contributions are much appreciated! You can find the contribution instructions at: https://github.com/finos/FDC3#contributing which links on to the contribution guide doc.

The main things to note are:

• raise an issue briefly describing the change needed and use-case
• raise a PR and link it to the issue (by saying "resolves # in its description)
• The EasyCLA tool will spin up and check if it can find a contributor license agreement (CLA) for you - it probably won't the first time, but will give you a link to sort that out. If your firm has a Corporate CLA it may be able to validate you by email address, otherwise you're firm's CLA manager will have to add you to it.
  • I believe @dominicgifford from your firm has submitted a PR before and has a CLA in place (as a proof-of-concept)

[kriswest]

@novavi just stumbled across this for the first time in a while - still think you can improve Methods.ts?

[novavi]

@kriswest yes, that's a good idea! This has been sitting here for ages now, as I shifted my attention to #896 after the discussion we had above and never returned to it.