CosmWasm / ts-codegen

Convert your CosmWasm smart contracts into dev-friendly TypeScript classes so you can focus on shipping code.
https://cosmology.zone/products/ts-codegen
Apache License 2.0
116 stars 29 forks source link

[Proposal] Defining a way to discriminated unions in interfaces #108

Open j0nl1 opened 1 year ago

j0nl1 commented 1 year ago

Currently now when you have an interface or type that use an union, is really hard to access to the desired property. In the example below you could see how is not possible to access to a specific property from an union (at least you force the type). However defining generics in the root object and make programmers define the expected union is more much friendly programming experience.

image

The generation process could be something like:

  1. Check for Unions in the object, generate as many generic as unions in the root object and start from A to Z.
  2. Generate each type of an union separately.
  3. Do conditional type until check all types in the union.

Follow the same process with Unions that have nested Unions.

You could find a full example here: https://gist.github.com/j0nl1/22dde0ef0bfaf1c0bea870a0a39e039e

adairrr commented 1 year ago

@j0nl1 nice suggestion on separating the unions, that would be quite a nice improvement, though I'm not sure about this "flattened" type.

Have you tried using ts-pattern? It works quite well for these unions.

You also can extract the types individually as follows:

Extract<ExecuteMsg, {
    create_wallet: unknown;
  }>["create_wallet"]
j0nl1 commented 1 year ago

@adairrr thanks for the suggestion of ts-pattern. I think is really useful in case where you don't know what data is coming. In scenarios where you already know what is going to come, it would be really useful to have something like what I proposed.

I think is very annoying have to force the definition of an union type every time you want to interact with that interface.

Given the example below I would have to do something like this:

const response: Interface = method(); 
(response.expires as Extract<Interface, { expires: { never:  {} }  }>).never
// OR
(response.expires as { never: {} }).never

Instead of

const response: ProposalInterface< ExpirationNever> = method(); 
response.expires.never

assuming that method has a return type of ProposalInterface<ExpirationNever> I never would have to cast or to force a type. In the case above is not that annoying because ExpirationNever is a small interface but there are much bigger interfaces and having to define them is repetitive.