feat(rest): upgrade to AFJ 0.2.0

[amanji]

TODO: Update PR description

[janrtvld]

Great work!

I think we can remove most of the schemas and use interfaces from AFJ. I think it would be nice if we switched to tsoa as that can generate an OpenAPI spec from the interfaces.

I can do the tsoa implementation if you want. If you need any other help just let me know :).

[amanji]

I read the docs briefly and it looks like it would be worth a try. Do you think it's easier to create a branch off of the 0.2.0 branch we can both work off of until everything is ready to be merged?

[janrtvld]

I think the easiest way is to convert the current controllers and tests to work with 0.2.0 and then look at switching to tsoa. We can do this on a separate branch and then merge it when everything works with tsoa.

[TimoGlastra]

I've done some tinkering last week with tsoa and it seems like it doesn't work well with the types as defined in AFJ. I've made some updates in openwallet-foundation/credo-ts#880.

TSOA doesn't always infer types for nested generics/mapped types. I've opened the following issues:

• Generic interfaces generate invalid schema name lukeautry/tsoa#1266
• Nested generic with mapped types do not work lukeautry/tsoa#1268
• Nested generic with mapped types produce inconsistent results based on order of interface declaration lukeautry/tsoa#1267

Not sure if there's going to be more problems, but if we decide to adopt TSOA, there's quite a few workarounds we have to apply (mainly redefining interfaces with static types instead of generics).

[janrtvld]

We have to define schemas for every method now (and the openAPI doesnt validate anything nested #17). TSOA works with interfaces so despite the workarounds, wouldn't it still be the better option?

[amanji]

An update. I have tests passing for all endpoints except for the basicMessage controller test suite and one test in the connection controller for accept-response. I have opted to skip these until I can determine why they are failing. For connection, I seem to have the flow wrong because the connection record that I am using to accept a connection response is in the wrong state when passing it to the corresponding AFJ method.

[amanji]

Before we proceed with adding more endpoints, I think it would be good to resolve whether to move forward with tsoa since this will require updates to the controllers.

[janrtvld]

I discussed it with @TimoGlastra and switching to TSOA seems the best option. Despite its shortcomings, it does provide a better openApi spec than we have now and we can use workarounds for now until they respond to the issues Timo created.

[amanji]

Please let me know where I can assist with the TSOA integration. I can help with converting the existing controllers over if we want to start there.

[janrtvld]

I have some time tomorrow to take a whack at it. I'll try and setup tsoa and convert the existing controllers. I'll also take a look at the failing tests.

Maybe you could start on the new controllers?

[amanji]

I renamed the branch, which has inadvertently closed this PR.

@janrtvld I have provided you write access to the petridishdev fork so feel free to make changes there and I can open up a new PR.I can start on the new controllers in the meantime.