better user-facing types

[joe-p]

Currently the types on the generated client methods are not very helpful because there are various layers of TypeScript magic going on. The types presented to the user should be very clear in terms of what the expected inputs (or outputs) of a function are.

The easiest way is to probably use even more TypeScript magic to expand the types at the highest level. Something like this PR for the SDK: algorand/js-algorand-sdk#528

Eventually it might be worthwhile to have the types just be defined as explicit, even if there is some repetition in the generated code.

[robdmoore]

I added a healthy dose of Expand when making changes recently. I tested it in vs code when doing it and the intellisense seemed a lot better. Maybe tehre is still room for improvement though?

e.g. https://github.com/algorandfoundation/algokit-client-generator-ts/blob/main/examples/helloworld/client.ts#L129 and https://github.com/algorandfoundation/algokit-client-generator-ts/blob/main/examples/helloworld/client.ts#L624

[joe-p]

I think the expand needs to wrap at the higher-level types otherwise it's not actually expanding them for the user.

[robdmoore]

From memory I found that when the intellisense came up for the args object itself it was clear and if I moved the expand to the method signature itself it was harder to read

[joe-p]

Just to illustrate what Rob is talking about:

I stil think having readable args at the method level is important though. Perhaps it'll just be easier to have the generator spit out explicit types rather than using these complex typescript type definitions.

[robdmoore]

Here's what I see...

[robdmoore]

Side-note: I started out using Expand directly, but the problem I found when using Expand was I saw some problems in trying to define variables that are the equivalent type of a function parameter, so I started using Expand in a defined type and found I still got good intellisense, but had less typing issues in defining variables for the parameters.